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

Deprecation Notice: GitHub Enterprise Server 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 Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server 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."

curl --location --request PUT 'https://api.github.com/authorizations/clients//' \ --header 'Content-Type: application/json' \ --data-raw '{ "client_secret": "string", "note": "Update all gems", "note_url": "string", "scopes": [ "public_repo", "user" ] }'

{ "app": { "client_id": "string", "name": "string", "url": "http://example.com" }, "created_at": "2019-08-24T14:15:22Z", "fingerprint": "string", "hashed_token": "string", "id": 0, "installation": { "account": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" }, "has_multiple_single_files": true, "permissions": { "contents": "read", "deployments": "write", "issues": "read", "single_file": "read" }, "repositories_url": "https://api.github.com/users/octocat/repos", "repository_selection": "all", "single_file_name": "config.yaml", "single_file_paths": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "note": "string", "note_url": "http://example.com", "scopes": [ "string" ], "token": "string", "token_last_eight": "string", "updated_at": "2019-08-24T14:15:22Z", "url": "http://example.com", "user": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "gravatar_id": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "type": "User", "url": "https://api.github.com/users/octocat" } }

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

client_id

string

必需

The client ID of your GitHub app.

fingerprint

string

必需

Body 参数application/json

client_secret

string

必需

The OAuth app client secret for which to create the token.

<= 40 字符

note

string

可选

A note to remind you what the OAuth token is for.

示例值:

Update all gems

note_url

string

可选

A URL to remind you what app the OAuth token is for.

scopes

array[string] | null

可选

A list of scopes that this authorization is in.

示例值:

["public_repo","user"]

示例

返回响应

🟢200if returning an existing token

application/json

Body

The authorization for an OAuth app, GitHub App, or a Personal Access Token.

app

object

必需

client_id

string

必需

name

string

必需

url

string <uri>

必需

created_at

string <date-time>

必需

fingerprint

string | null

必需

hashed_token

string | null

必需

integer

必需

installation

null | allOf {1}

可选

object (Scoped Installation)

可选

note

string | null

必需

note_url

string <uri> | null

必需

scopes

array[string] | null

必需

A list of scopes that this authorization is in.

token

string

必需

token_last_eight

string | null

必需

updated_at

string <date-time>

必需

url

string <uri>

必需

user

null

可选

Simple User

🟢201Response if returning a new token

🟠422422