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

廃止予定

PUT

/authorizations/clients/{client_id}/{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."

リクエストパラメータ

パスパラメータ

リクエストボディパラメータapplication/json

例

レスポンス

🟢200OK

application/json

if returning an existing token

Headers

ボディapplication/json

🟢201Created

🟠422Parameter Error

リクエストExample

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://service1.exmaple.com/authorizations/clients/abcde12345fghij67890/' \
--header 'Content-Type: application/json' \
--data '{
    "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f",
    "scopes": [
        "public_repo"
    ],
    "note": "optional note",
    "note_url": "http://optional/note/url"
}'

レスポンスExample

200 - response-if-returning-an-existing-token

{
    "id": 1,
    "url": "https://api.github.com/authorizations/1",
    "scopes": [
        "public_repo"
    ],
    "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a",
    "token_last_eight": "Ae178B4a",
    "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8",
    "app": {
        "url": "http://my-github-app.com",
        "name": "my github app",
        "client_id": "abcde12345fghij67890"
    },
    "note": "optional note",
    "note_url": "http://optional/note/url",
    "updated_at": "2011-09-06T20:39:23Z",
    "created_at": "2011-09-06T17:26:27Z",
    "expires_at": "2011-10-06T17:26:27Z",
    "fingerprint": "jklmnop12345678"
}

更新日時 2025-06-12 06:47:19

Get-or-create an authorization for a specific app

Get a single authorization