OAuthProvider Object

Contains information about an OAuth provider.

This object is used by the following operations:

The properties included in the OAuthProvider object are listed below.

Property Type Description
ResourceOwnerIdentitySystemName string The resource owner authentication domain; for example, ldap.
AuthorizationCodeGrantType AuthorizationCodeGrantType

Contains information about an OAuth provider's settings for the OAuth Authorization Code grant type.

Optional.

ClientCredentialsGrantType ClientCredentialsGrantType

Contains information about an OAuth provider's settings for the OAuth Client Credentials grant type.

Optional.

ImplicitGrantType ImplicitGrantType

Contains information about an OAuth provider's settings for the OAuth Implicit grant type.

Optional.

ResourceOwnerCredentialsGrantType ResourceOwnerCredentialsGrantType

Contains information about an OAuth provider's settings for the Resource Owner Credentials grant type.

Optional.

JWTBearerGrantType JWTBearerGrantType

Contains information about an OAuth provider's settings for the JWT Bearer grant type.

Optional.

AccessTokenType string Access token type: Bearer, JWT, or MAC.
ResourceHierarchy ResourceHierarchy

Contains information about the hierarchy of resources in an OAuth grant.

Optional.

GrantPropertiesMetadata GrantPropertyMetadata[ ]

Contains additional information associated with an OAuth GrantProperty.

One or more.

ProviderBrandDetails ProviderBrandDetails

Contains branding and other information for an OAuth Provider.

Optional.

AuthorizationEndpointParameters AuthorizationEndpointParameters

Contains information about the parameters for an OAuth provider's Authorization Endpoint.

Optional.

TokenEndpointParameters TokenEndpointParameters

Contains information about the parameters for an OAuth provider's Token Endpoint.

Optional.

WorkflowDefinitionKey string

The unique workflow definition key for the custom OAuth workflow, if applicable.

Optional.

OpenIdConnectSupported boolean Indicates whether the OAuth provider supports OpenID Connect. Default: false.
IdTokenSigningAlgorithm string

The ID token signing algorithm used by the OAuth provider, if applicable.

Optional.

IdTokenEncryptionKeyManagementAlgorithm string

The ID token encryption key management algorithm used by the OAuth provider, if applicable.

Optional.

IdTokenContentEncryptionAlgorithm string

The ID token content encryption algorithm used by the OAuth provider, if applicable.

Optional.

IdTokenExpirationTimeInSeconds long

The expiration time, in seconds, for ID tokens issued by this OAuth provider.

Optional.

JwkExpirationTimeInSeconds long

The expiration time, in seconds, for JWK tokens issued by this OAuth provider.

Optional.

ResourceOwnerUserInfoClaims Claim[ ] Information on one or more resource owner claims
GrantScopeSetting string

The grant scope setting for this OAuth provider. For valid values, see OAuth Grant Scope values.

Optional.

ClientCanOverrideAccessTokenType string Indicates whether the OAuth Provider setting allows the client to override the default access token type.
JWTAccessTokenConfiguration JWTAccessTokenConfiguration Contains information about the the OAuth Provider's configuration settings for JWT access token support, if applicable.
ReferencedAccessTokenConfiguration ReferencedAccessTokenConfiguration Contains information about the the OAuth Provider's configuration settings for Referenced Bearer access token support, if applicable.
TokenValidationConfig TokenValidationConfig Contains information about the OAuth Provider's general settings for token validation configuration, if applicable.
MACAccessTokenConfiguration MACAccessTokenConfiguration Contains information about the the OAuth Provider's configuration settings for MAC access token support, if applicable.
GrantProvisioningTimeoutInSeconds long The expiration time, im seconds, for grant provisioning.
ClientRestrictionsSetting string Optional client restrictions setting.

Back to top

Related Topics