Skip to main content

トークンエンドポイント

POST 

/token

認可コードフロー/トークン更新に対応しています。
client_idおよびclient_secretの使い方は連携用アプリの「クライアント認証方式」の設定に依存します。
認証方式はアプリ詳細画面よりご確認ください。

Request

Header Parameters

    Authorization BasicAuth

    クライアント認証方式が CLIENT_SECRET_BASIC の場合は必須になります。
    ClientID:ClientSecretをBasic認証で利用します。

Body

required

    grant_type stringrequired

    Possible values: [authorization_code, refresh_token]

    許可種別は下記のいずれかを指定してください

    • authorization_code : 認可コードフローでのトークン発行
    • refresh_token : トークン更新
    code string

    認可サーバーから受け取った認可コード
    ※認可コードフローでのトークン発行には必須

    redirect_uri uri

    redirect_uriパラメタが認可リクエストに含まれている場合、redirect_uriが必要です。

    refresh_token string

    OAuth Clientに発行されたリフレッシュトークン
    ※トークン更新には必須

    scope string

    アクセス要求のスコープ
    要求されたスコープはリソースオーナーによって付与されていない値を含んではなりません。
    もし指定されなかった場合は, リソースオーナーによって当初付与されたスコープと同じものとして扱われます。
    ※トークン更新のみ使用します

    code_verifier string

    Possible values: >= 43 characters and <= 128 characters

    code_verifier の値は、[A-Z] / [a-z] / [0-9] / "-" / "." / "_" / "~" からなるランダムな文字列であり、 最低43文字、最大128文字の長さが必要となります。

    client_id string

    クライアント認証方式がCLIENT_SECRET_POSTの場合は必須になります

    client_secret string

    クライアント認証方式がCLIENT_SECRET_POSTの場合は必須になります

Responses

トークンリクエストが正しい場合。
トークンの詳細はSchemaを参照してください。
下記のどちらも同じレスポンス形式になります。

  • 認可コードフローでのトークン発行

  • トークン更新

Response Headers

  • Content-Type

    string

    application/json;charset=UTF-8

  • Cache-Control

    string

    no-store

  • Pragma

    string

    no-cache

Schema

    access_token string

    API呼び出しに使用するアクセストークンです。TTLは現在1時間(3600秒)です。

    refresh_token string

    アクセストークンの更新に使用するリフレッシュトークンです。TTLは現在18ヶ月(46656000秒)で、アクセストークンを取得する度にリフレッシュトークンは破棄され再発行されます。

    scope string
    token_type string
    expires_in integer
Loading...