Definitions
AccessRequest
Access Token request
| Name | Description | Schema |
|---|---|---|
| grantTyperequired | The grand type. | enum (password, refresh_token) |
| passwordoptional | The subject’s password. Length : 0 - 80Pattern : "(?=.\\d)(?=.)[A-Za-z\\d!@.#$%&*+_?&=\\-]{8,}$" | string |
| refreshTokenoptional | The refresh token. Length : 0 - 2048Pattern : "^\[a-zA-Z0-9\\-]+?\\.\[a-zA-Z0-9\\-]+?\\.(\[a-zA-Z0-9\\-\_]+)?$" | string |
| usernameoptional | The subject (username) that should be authorized. Length : 0 - 36Pattern : "^\[a-zA-Z0-9\\-]+$" | string |
AccessResponse
| Name | Description | Schema |
|---|---|---|
| accessToken optional | The access token. | string |
| expiresIn optional | Seconds until the Access token expires. | string |
| refreshToken optional | The refresh token. | string |
| responseInfo optional | ResponseInfo |
IntrospectForm
| Name | Description | Schema |
|---|---|---|
| token required | The token to introspect.\ Pattern : "^\[A-Za-z0-9-=]+\\.\[A-Za-z0-9-=]+\\.\[A-Za-z0-9-\_.+/=]+$" | string |
IntrospectResponse
| Name | Description | Schema |
|---|---|---|
| active required | Boolean indicator of whether or not the presented token is currently active. | boolean |
| ati optional | This value is a CaSe-SenSiTiVe unique identifier for the AccessToken linked to the refresh token. | string (uuid) |
| azp optional | Authorized party - the party to which the ID Token was issued. | string |
| exp required | Integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire. | integer (int64) |
| jti required | This value is a CaSe-SenSiTiVe unique identifier for the JWT. | string (uuid) |
| responseInfo optional | ResponseInfo | |
| sub required | The Subject/Client_Id that requested the token. | string |
ResponseInfo
Info object that can provide specific messages
| Name | Description | Schema |
|---|---|---|
| externalResponseCode optional | Additional response code from external systems. | string |
| message optional | Specific response message | string |
| responseCode required | string | |
| timeStamp required | Timestamp. Mandatory Example : "2021-12-21T10:23:19.279Z" | string |
Status
| Name | Schema |
|---|---|
| description optional | string |
| status optional | string |
Updated 12 months ago
Did this page help you?