JWTを生成する

post/oauth2/token

Use this call:

To get a user JWT.
To refresh the JWT when it expires. Works only if scope=offline is passed in the registration or authentication call.
To get a server JWT. The user participation isn’t needed.
To exchange user JWT for a new one with different scope.

Usage of this call depends on the value of the grant_type parameter.

Request

Request Body schema: application/x-www-form-urlencoded

grant_type required	string The type of getting the JWT. Can be: `authorization_code` to exchange the code received in the authentication call to the JWT. The value of the `code` parameter must be specified. `refresh_token` to get the refreshed JWT when the previous value is expired. The value of the `refresh_token` parameter must be specified. `client_credentials` to get the server JWT. The values of the `client_id` and `client_secret` parameters must be specified. `urn:ietf:params:oauth:grant-type:token_exchange` to exchange existing user JWT with different scope.
client_id required	string あなたのアプリケーションID。このパラメータの値は、`grant_type`パラメータの値に依存します。 `authorization_code`である場合、 OAuth 2.0クライアントを作成し、そのクライアントIDを使用します。 `client_credentials`である場合、 OAuth 2.0クライアントを作成し、クライアントIDを取得するには、カスタマーサクセスマネージャーに連絡してください。 `client_secret`と`client_id`のパラメータは、同じクライアントから使用する必要があることに注意してください。
refresh_token	string `grant_type`パラメータに`authorization_code`または`refresh_token`値を持つ、このコールの最後リクエストに対する応答で受け取ったパラメータの値。grant_type=refresh_token`の場合は、必須です。
client_secret	string あなたの秘密鍵。このパラメータの値は、`grant_type`パラメータの値に依存します。 `authorization_code`である場合、 OAuth 2.0クライアントを作成し、その秘密鍵を使用します。OAuth 2.0クライアントを機密認証タイプで作成した場合は、必須です。 `client_credentials`である場合、 OAuth 2.0クライアントを作成し、その秘密鍵を取得するには、カスタマーサクセスマネージャーに連絡してください。このクライアントタイプの場合、必須**です。 `client_secret`と`client_id`のパラメータは、同じクライアントから使用する必要があることに注意してください。
redirect_uri	string
code	string JWTに交換される認証コード。grant_type=authorization_codeの場合は、必須です。
code_verifier	string PKCEリクエストのコード検証は、アプリケーションが元々認証リクエストの前に生成したものです。
audience	string トークン申請可能ドメインのリスト
scope	string A list of space-delimited, case-sensitive strings, as defined in Section 3.3 of [RFC6749], that allow the client to specify the desired scope of the requested security token in the context of the service or resource where the token will be used. The values and associated semantics of scope are service specific and expected to be described in the relevant service documentation
subject_token	string A security token that represents the identity of the party on behalf of whom the request is being made. Typically, the subject of this token will be the subject of the security token issued in response to the request.
subject_token_type	string A security token that represents the identity of the party on behalf of whom the request is being made. Typically, the subject of this token will be the subject of the security token issued in response to the request. Value: "access_token"
actor_token	string A security token that represents the identity of the acting party. Typically, this will be the party that is authorized to use the requested security token and act on behalf of the subject.
actor_token_type	string An identifier, as described in Section 3, that indicates the type of the security token in the actor_token parameter. This is REQUIRED when the actor_token parameter is present in the request but MUST NOT be included otherwise. Value: "server_token"

Responses

200

400

無効なリクエスト

404

見つかりません

418

私はティーポット

422

処理不可能なエンティティー

429

リクエストの回数が多すぎます

Request samples

application/x-www-form-urlencoded

refresh_token=string&grant_type=string&client_secret=string&client_id=string&redirect_uri=string&code=string&code_verifier=string&audience=string&scope=string&subject_token=string&subject_token_type=access_token&actor_token=string&actor_token_type=server_token

Response samples

application/json

{"access_token": "2YotnFZFEjr1zCsicMWpAA",
"expires_in": 3600,
"refresh_token": "tGzv3JOkF0XG5Qx2TlKWIA",
"scope": "email user_profile",
"token_type": "bearer"
}