Enum github_auth::Scope

pub enum Scope {
    Repo,
    RepoStatus,
    RepoDeployment,
    PublicRepo,
    RepoInvite,
    AdminOrg,
    WriteOrg,
    ReadOrg,
    AdminPublicKey,
    WritePublicKey,
    ReadPublicKey,
    AdminRepoHook,
    WriteRepoHook,
    ReadRepoHook,
    AdminOrgHook,
    Gist,
    Notifications,
    User,
    ReadUser,
    UserEmail,
    UserFollow,
    DeleteRepo,
    WriteDiscussion,
    ReadDiscussion,
    AdminGpgKey,
    WriteGpgKey,
    ReadGpgKey,
}

GitHub OAuth scope definitions.

Further Reading

• Understanding scopes for Oauth apps

Variants

Repo

Grants read/write access to code, commit statuses, invitations, collaborators, adding team memberships, and deployment statuses for public and private repositories and organizations.

RepoStatus

Grants read/write access to public and private repository commit statuses. This scope is only necessary to grant other users or services access to private repository commit statuses without granting access to the code.

RepoDeployment

Grants access to deployment statuses for public and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, without granting access to the code.

PublicRepo

Grants read/write access to code, commit statuses, collaborators, and deployment statuses for public repositories and organizations. Also required for starring public repositories.

RepoInvite

Grants accept/decline abilities for invitations to collaborate on a repository. This scope is only necessary to grant other users or services access to invites without granting access to the code.

AdminOrg

Fully manage organization, teams, and memberships.

WriteOrg

Publicize and unpublicize organization membership.

ReadOrg

Read-only access to organization, teams, and membership.

AdminPublicKey

Fully manage public keys.

WritePublicKey

Create, list, and view details for public keys.

ReadPublicKey

List and view details for public keys.

AdminRepoHook

Grants read, write, ping, and delete access to hooks in public or private repositories.

WriteRepoHook

Grants read, write, and ping access to hooks in public or private repositories.

ReadRepoHook

Grants read and ping access to hooks in public or private repositories.

AdminOrgHook

Grants read, write, ping, and delete access to organization hooks. Note: OAuth tokens will only be able to perform these actions on organization hooks which were created by the OAuth App. Personal access tokens will only be able to perform these actions on organization hooks created by a user.

Gist

Grants write access to gists.

Notifications

Grants read access to a user's notifications. repo also provides this access.

User

Grants read/write access to profile info only. Note that this scope includes user:email and user:follow.

ReadUser

Grants access to read a user's profile data.

UserEmail

Grants read access to a user's email addresses.

UserFollow

Grants access to follow or unfollow other users.

DeleteRepo

Grants access to delete adminable repositories.

WriteDiscussion

Allows read and write access for team discussions.

ReadDiscussion

Allows read access for team discussions.

AdminGpgKey

Fully manage GPG keys.

WriteGpgKey

Create, list, and view details for GPG keys.

ReadGpgKey

List and view details for GPG keys.

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Scope

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Scope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Scope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.