Token

To obtain an Access Token, an ID Token, and optionally a Refresh Token, the RP (Client).

To obtain an Access Token, an ID Token, and optionally a Refresh Token, the RP (Client).

post/restv1/token

Response

OK

access_tokenstring required

The access token issued by the authorization server.

token_typestring required

The access token type provides the client with the information required to successfully utilize the access token to make a protected resource request (along with type-specific attributes).

expires_ininteger

The lifetime in seconds of the access token. For example, the value "3600" denotes that the access token will expire in one hour from the time the response was generated.

refresh_tokenstring

The refresh token, which can be used to obtain new access tokens using the same authorization grant

scopestring[]
id_tokenstring
issued_token_typestring

Identifier for the type of the issued token. Present in token exchange responses. For example urn:ietf:params:oauth:token-type:id-jag or urn:ietf:params:oauth:token-type:txn-token.

Example response

{
  "scope": [
    "openid",
    "oxd"
  ],
  "issued_token_type": "urn:ietf:params:oauth:token-type:id-jag"
}

Changes

Changed in 3 of the 51 revisions of this API.18

    • added the new optional request property actor_token

      new-optional-request-property

    • added the new optional request property actor_token_type

      new-optional-request-property

    • added the new optional request property audience

      new-optional-request-property

    • added the new optional request property requested_token_type

      new-optional-request-property

    • added the new optional request property subject_token

      new-optional-request-property

    • added the new optional request property subject_token_type

      new-optional-request-property

    • added the optional property issued_token_type to the response with the 200 status

      response-optional-property-added

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog