OAuth Config Definition
An OAuthConfigDefinition
specifies the data required for the OAuth 2.0 login flow.
Name | Type | Required? | Description |
---|---|---|---|
tokenProperties | object | An object that describes the access and refresh token attributes when not given by the identity provider. | |
tokenProperties
.accessTokenExpirationLength | number | Access token expiration length in seconds. The minimum value is | |
tokenProperties
.refreshTokenExpirationLength | number | Refresh token expiration length in seconds. The minimum value is | |
tokenProperties
.tokenExpirationLengthTimeUnit | string | Token Expiration Unit of Time. This is required if | |
authorizationProcess | object | ✔ | An object that describes the authorization process. |
authorizationProcess
.loginRequest | ✔ | The login request made to the identity provider. | |
authorizationProcess
.redirectRequest | ✔ | The expected redirect request after the identity provider has attempted to authenticate the user. | |
authorizationProcess
.authorizeRequest | An request made to the identity provider to authorize the user after the identity has been established. | ||
authorizationProcess
.authorizeResponse | The expected response to an authorization request. | ||
refreshTokenProcess | object | ✔ | An object that describes the process for refreshing an authorization token. |
refreshTokenProcess
.refreshTokenRequest | ✔ | The request to refresh the authorization token. | |
refreshTokenProcess
.refreshTokenResponse | ✔ | The expected response to a refresh token request. |