OAuth AccessTokenRequest Object
Contains information about a request for an OAuth Access Token. This is used when requesting an access token at the Token Endpoint in OAuth 2.0. It contains all the mandatory and optional request parameters that can be used in the access token request in every possible scenario compliant with the OAuth 2.0 scenario. Properties are required or optional depending on the specific OAuth 2.0 scenario.
The properties included in the AccessTokenRequest object are listed below.
Property | Type | Description |
---|---|---|
grant_type | string | The grant type. |
client_id | string | Unique identifier of the client application. |
client_secret | string | The client secret value; this value identifies the client with the provider. |
refresh_token | string | The Refresh Token. Refresh tokens may be issued to the client by the authorization server and are used to obtain a new access token when the current access token becomes invalid or expires. A refresh token is a string representing the authorization granted to the client by the resource owner. The string is usually opaque to the client. The token denotes an identifier used to retrieve the authorization information. Unlike access tokens, refresh tokens are intended for use only with authorization servers and are never sent to resource servers. |
scope | string |
OAuth 2.0: standard scope parameter. One or more scopes configured in the OAuth provider. Space separator for multiple scopes. The scope of the access request. |
code | string |
The authorization code. It is the authorization code that was previously received by the client application after user authentication.. |
redirect_uri | string |
OAuth 2.0: standard redirect_uri parameter. The redirect URI configured by the app. For more information, see OAuth Parameters. It is the redirect URI where the client received the authorization code. |
username | string | The resource owner's username. |
password | string | The resource owner's password. |
ResourceOwnerUserInfo | ResourceOwnerUserInfo | Contains UserInfo information about an OAuth resource owner. |
azp | string | A claim showing the value of the authorized party. |
assertion | string | JWT Bearer Assertion grant type only: The JWT Bearer Assertion. |
GrantID | string | The unique ID for the OAuth grant. |