OAuth Config Definition

An OAuthConfigDefinition specifies the data required for the OAuth 2.0 login flow.

NameTypeRequired?Description
tokenPropertiesobject

An object that describes the access and refresh token attributes when not given by the identity provider.

tokenProperties   .accessTokenExpirationLengthnumber

Access token expiration length in seconds. The minimum value is 1.

tokenProperties   .refreshTokenExpirationLengthnumber

Refresh token expiration length in seconds. The minimum value is 1.

tokenProperties   .tokenExpirationLengthTimeUnitstring

Token Expiration Unit of Time. This is required if accessTokenExpirationLength or refreshTokenExpirationLength is set.

authorizationProcessobject

An object that describes the authorization process.

authorizationProcess   .loginRequest

OAuth request definition object

The login request made to the identity provider.

authorizationProcess   .redirectRequest

OAuth request definition object

The expected redirect request after the identity provider has attempted to authenticate the user.

authorizationProcess   .authorizeRequest

OAuth request definition object

An request made to the identity provider to authorize the user after the identity has been established.

authorizationProcess   .authorizeResponse

OAuth response definition object

The expected response to an authorization request.

refreshTokenProcessobject

An object that describes the process for refreshing an authorization token.

refreshTokenProcess   .refreshTokenRequest

OAuth request definition object

The request to refresh the authorization token.

refreshTokenProcess   .refreshTokenResponse

OAuth response definition object

The expected response to a refresh token request.