Struct octorust::oauth_authorizations::OauthAuthorizations

pub struct OauthAuthorizations { /* fields omitted */ }

Implementations

impl OauthAuthorizations

pub async fn list_grants(
    &self,
    per_page: i64,
    page: i64,
    client_id: &str
) -> Result<Vec<ApplicationGrant>>

List your grants.

This function performs a GET to the /applications/grants endpoint.

Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return ["repo", "user"].

FROM: https://docs.github.com/rest/reference/oauth-authorizations#list-your-grants

Parameters:

• per_page: i64 – Results per page (max 100).
• page: i64 – Page number of the results to fetch.
• client_id: &str – The client ID of your GitHub app.

pub async fn list_all_grants(
    &self,
    client_id: &str
) -> Result<Vec<ApplicationGrant>>

List your grants.

This function performs a GET to the /applications/grants endpoint.

As opposed to list_grants, this function returns all the pages of the request at once.

Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return ["repo", "user"].

FROM: https://docs.github.com/rest/reference/oauth-authorizations#list-your-grants

pub async fn get_grant(&self, grant_id: i64) -> Result<ApplicationGrant>

Get a single grant.

This function performs a GET to the /applications/grants/{grant_id} endpoint.

Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

FROM: https://docs.github.com/rest/reference/oauth-authorizations#get-a-single-grant

Parameters:

• grant_id: i64 – grant_id parameter.

pub async fn delete_grant(&self, grant_id: i64) -> Result<()>

Delete a grant.

This function performs a DELETE to the /applications/grants/{grant_id} endpoint.

Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

Deleting an OAuth application’s grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.

FROM: https://docs.github.com/rest/reference/oauth-authorizations#delete-a-grant

Parameters:

• grant_id: i64 – grant_id parameter.

pub async fn list_authorizations(
    &self,
    per_page: i64,
    page: i64,
    client_id: &str
) -> Result<Vec<Authorization>>

List your authorizations.

This function performs a GET to the /authorizations endpoint.

Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

FROM: https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations

Parameters:

• per_page: i64 – Results per page (max 100).
• page: i64 – Page number of the results to fetch.
• client_id: &str – The client ID of your GitHub app.

pub async fn list_all_authorizations(
    &self,
    client_id: &str
) -> Result<Vec<Authorization>>

List your authorizations.

This function performs a GET to the /authorizations endpoint.

As opposed to list_authorizations, this function returns all the pages of the request at once.

Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

FROM: https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations

pub async fn create_authorization(
    &self,
    body: &OauthAuthorizationsCreateAuthorizationRequest
) -> Result<Authorization>

Create a new authorization.

This function performs a POST to the /authorizations endpoint.

Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

Warning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the blog post.

Creates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see “Working with two-factor authentication.”

To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app’s client ID and secret, found on your OAuth application’s settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.

You can also create tokens on GitHub from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.

Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in the GitHub Help documentation.

FROM: https://docs.github.com/rest/reference/oauth-authorizations#create-a-new-authorization

pub async fn get_or_create_authorization_for_app(
    &self,
    client_id: &str,
    body: &OauthAuthorizationsGetCreateAuthorizationAppRequest
) -> Result<Authorization>

Get-or-create an authorization for a specific app.

This function performs a PUT to the /authorizations/clients/{client_id} endpoint.

Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

Warning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the blog post.

Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn’t already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user’s existing authorization for the application if one is present. Otherwise, it creates and returns a new one.

If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see “Working with two-factor authentication.”

Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

FROM: https://docs.github.com/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app

Parameters:

• client_id: &str – The client ID of your GitHub app.

pub async fn get_or_create_authorization_for_app_and_fingerprint(
    &self,
    client_id: &str,
    fingerprint: &str,
    body: &OauthAuthorizationsGetCreateAuthorizationAppFingerprintRequest
) -> Result<Authorization>

Get-or-create an authorization for a specific app and fingerprint.

This function performs a PUT to the /authorizations/clients/{client_id}/{fingerprint} endpoint.

Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

Warning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the blog post.

This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user’s existing authorization for the application if one is present. Otherwise, it creates and returns a new one.

If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see “Working with two-factor authentication.”

FROM: https://docs.github.com/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint

Parameters:

• client_id: &str – The client ID of your GitHub app.
• fingerprint: &str

pub async fn get_authorization(
    &self,
    authorization_id: i64
) -> Result<Authorization>

Get a single authorization.

This function performs a GET to the /authorizations/{authorization_id} endpoint.

Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

FROM: https://docs.github.com/rest/reference/oauth-authorizations#get-a-single-authorization

Parameters:

• authorization_id: i64 – authorization_id parameter.

pub async fn delete_authorization(&self, authorization_id: i64) -> Result<()>

Delete an authorization.

This function performs a DELETE to the /authorizations/{authorization_id} endpoint.

Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

FROM: https://docs.github.com/rest/reference/oauth-authorizations#delete-an-authorization

Parameters:

• authorization_id: i64 – authorization_id parameter.

pub async fn update_authorization(
    &self,
    authorization_id: i64,
    body: &OauthAuthorizationsUpdateAuthorizationRequest
) -> Result<Authorization>

Update an existing authorization.

This function performs a PATCH to the /authorizations/{authorization_id} endpoint.

Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see “Working with two-factor authentication.”

You can only send one of these scope keys at a time.

FROM: https://docs.github.com/rest/reference/oauth-authorizations#update-an-existing-authorization

Parameters:

• authorization_id: i64 – authorization_id parameter.