Table of Contents

Class ConnectionOptionsGitHub

Namespace
Auth0.ManagementApi
Assembly
Auth0.ManagementApi.dll

Options for the 'github' connection

[Serializable]
public record ConnectionOptionsGitHub : IJsonOnDeserialized, IJsonOnSerializing, IEquatable<ConnectionOptionsGitHub>
Inheritance
ConnectionOptionsGitHub
Implements
Inherited Members
Extension Methods

Properties

AdditionalProperties 

[JsonIgnore]
public AdditionalProperties AdditionalProperties { get; set; }

Property Value

AdditionalProperties

AdminOrg

Requests the GitHub admin:org scope so Auth0 can fully manage organizations, teams, and memberships on behalf of the user.

[JsonPropertyName("admin_org")]
public bool? AdminOrg { get; set; }

Property Value

bool?

AdminPublicKey

Requests the admin:public_key scope to allow creating, updating, and deleting the user's SSH public keys.

[JsonPropertyName("admin_public_key")]
public bool? AdminPublicKey { get; set; }

Property Value

bool?

AdminRepoHook

Requests the admin:repo_hook scope so Auth0 can read, write, ping, and delete repository webhooks.

[JsonPropertyName("admin_repo_hook")]
public bool? AdminRepoHook { get; set; }

Property Value

bool?

ClientId 

[JsonPropertyName("client_id")]
public string? ClientId { get; set; }

Property Value

string

ClientSecret 

[JsonPropertyName("client_secret")]
public string? ClientSecret { get; set; }

Property Value

string

DeleteRepo

Requests the delete_repo scope so the user can remove repositories they administer while signing in through Auth0.

[JsonPropertyName("delete_repo")]
public bool? DeleteRepo { get; set; }

Property Value

bool?

Email

Requests the user:email scope so Auth0 pulls addresses from GitHub's /user/emails endpoint and populates the profile.

[JsonPropertyName("email")]
public bool? Email { get; set; }

Property Value

bool?

Follow

Requests the user:follow scope to allow following or unfollowing GitHub users for the signed-in account.

[JsonPropertyName("follow")]
public bool? Follow { get; set; }

Property Value

bool?

FreeformScopes 

[JsonPropertyName("freeform_scopes")]
public IEnumerable<string>? FreeformScopes { get; set; }

Property Value

IEnumerable<string>

Gist

Requests the gist scope so the application can create or update gists on behalf of the user.

[JsonPropertyName("gist")]
public bool? Gist { get; set; }

Property Value

bool?

NonPersistentAttrs 

[JsonPropertyName("non_persistent_attrs")]
public IEnumerable<string>? NonPersistentAttrs { get; set; }

Property Value

IEnumerable<string>

Notifications

Requests the notifications scope to read GitHub inbox notifications; repo also implicitly grants this access.

[JsonPropertyName("notifications")]
public bool? Notifications { get; set; }

Property Value

bool?

Profile

Controls the GitHub read:user call that returns the user's basic profile (name, avatar, profile URL) and is on by default for successful logins.

[JsonPropertyName("profile")]
public bool? Profile { get; set; }

Property Value

bool?

PublicRepo

Requests the public_repo scope for read and write operations on public repositories, deployments, and statuses.

[JsonPropertyName("public_repo")]
public bool? PublicRepo { get; set; }

Property Value

bool?

ReadOrg

Requests the read:org scope so Auth0 can view organizations, teams, and membership lists without making changes.

[JsonPropertyName("read_org")]
public bool? ReadOrg { get; set; }

Property Value

bool?

ReadPublicKey

Requests the read:public_key scope so Auth0 can list and inspect the user's SSH public keys.

[JsonPropertyName("read_public_key")]
public bool? ReadPublicKey { get; set; }

Property Value

bool?

ReadRepoHook

Requests the read:repo_hook scope to read and ping repository webhooks.

[JsonPropertyName("read_repo_hook")]
public bool? ReadRepoHook { get; set; }

Property Value

bool?

ReadUser

Requests the read:user scope to load extended profile information, implicitly covering user:email and user:follow.

[JsonPropertyName("read_user")]
public bool? ReadUser { get; set; }

Property Value

bool?

Repo

Requests the repo scope for read and write access to both public and private repositories, deployments, and statuses.

[JsonPropertyName("repo")]
public bool? Repo { get; set; }

Property Value

bool?

RepoDeployment

Requests the repo_deployment scope in order to read and write deployment statuses for repositories.

[JsonPropertyName("repo_deployment")]
public bool? RepoDeployment { get; set; }

Property Value

bool?

RepoStatus

Requests the repo:status scope to manage commit statuses on public and private repositories.

[JsonPropertyName("repo_status")]
public bool? RepoStatus { get; set; }

Property Value

bool?

Scope 

[JsonPropertyName("scope")]
public IEnumerable<string>? Scope { get; set; }

Property Value

IEnumerable<string>

SetUserRootAttributes 

[JsonPropertyName("set_user_root_attributes")]
public ConnectionSetUserRootAttributesEnum? SetUserRootAttributes { get; set; }

Property Value

ConnectionSetUserRootAttributesEnum?

UpstreamParams 

[JsonPropertyName("upstream_params")]
public Optional<Dictionary<string, ConnectionUpstreamAdditionalProperties?>?> UpstreamParams { get; set; }

Property Value

Optional<Dictionary<string, ConnectionUpstreamAdditionalProperties>>

WriteOrg

Requests the write:org scope so Auth0 can change whether organization memberships are publicized.

[JsonPropertyName("write_org")]
public bool? WriteOrg { get; set; }

Property Value

bool?

WritePublicKey

Requests the write:public_key scope to create or update SSH public keys for the user.

[JsonPropertyName("write_public_key")]
public bool? WritePublicKey { get; set; }

Property Value

bool?

WriteRepoHook

Requests the write:repo_hook scope so Auth0 can read, create, update, and ping repository webhooks.

[JsonPropertyName("write_repo_hook")]
public bool? WriteRepoHook { get; set; }

Property Value

bool?

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.