Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AuthenticationProvider

Settings for the Authentication Provider.

Properties

Optional authorizationEndpointUrl

authorizationEndpointUrl: undefined | string

The IDPs URL for the page that users authenticate with by entering the user name and password.

clientId

clientId: string

The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application ID.

Optional definedTags

definedTags: undefined | object

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type, or scope. Example: {@code {"bar-key": "value"}}

grantType

The grant type for the Authentication Provider.

id

id: string

Unique immutable identifier that was assigned when the Authentication Provider was created.

identityProvider

Which type of Identity Provider (IDP) you are using.

isVisible

isVisible: boolean

Whether this Authentication Provider is visible in the ODA UI.

lifecycleState

lifecycleState: LifecycleState

The Authentication Provider's current state.

name

name: string

A name to identify the Authentication Provider.

Optional redirectUrl

redirectUrl: undefined | string

The OAuth Redirect URL.

Optional refreshTokenRetentionPeriodInDays

refreshTokenRetentionPeriodInDays: undefined | number

The number of days to keep the refresh token in the Digital Assistant cache. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional revokeTokenEndpointUrl

revokeTokenEndpointUrl: undefined | string

If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then you need the IDP's revoke refresh token URL. If you provide this URL, then you can use the System.OAuth2ResetTokens component to revoke the user's tokens for this service.

scopes

scopes: string

A space-separated list of the scopes that must be included when Digital Assistant requests an access token from the provider. Include all the scopes that are required to access the resources. If refresh tokens are enabled, include the scope that\u2019s necessary to get the refresh token (typically offline_access).

Optional shortAuthorizationCodeRequestUrl

shortAuthorizationCodeRequestUrl: undefined | string

A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows you to send query parameters). You might need this because the generated authorization-code-request URL could be too long for SMS and older smart phones.

Optional subjectClaim

subjectClaim: undefined | string

The access-token profile claim to use to identify the user.

timeCreated

timeCreated: Date

When the resource was created. A date-time string as described in RFC 3339, section 14.29.

timeUpdated

timeUpdated: Date

When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.

tokenEndpointUrl

tokenEndpointUrl: string

The IDPs URL for requesting access tokens.

Functions

getDeserializedJsonObj

getJsonObj