Back to Node Auth0

Interface ClientSessionTransferConfiguration

docs/interfaces/management.Management.ClientSessionTransferConfiguration.html

5.9.14.4 KB
Original Source

Interface ClientSessionTransferConfiguration

Native to Web SSO Configuration

interface ClientSessionTransferConfiguration {
can_create_session_transfer_token?: boolean;
enforce_cascade_revocation?: boolean;
allowed_authentication_methods?:
| Management.ClientSessionTransferAllowedAuthenticationMethodsEnum[]
| null;
enforce_device_binding?: Management.ClientSessionTransferDeviceBindingEnum;
allow_refresh_token?: boolean;
enforce_online_refresh_tokens?: boolean;
delegation?: ClientSessionTransferDelegationConfiguration
| null;
}

Index

Properties

can_create_session_transfer_token?enforce_cascade_revocation?allowed_authentication_methods?enforce_device_binding?allow_refresh_token?enforce_online_refresh_tokens?delegation?

Properties

Optionalcan_create_session_transfer_token

can_create_session_transfer_token?: boolean

Indicates whether an app can issue a Session Transfer Token through Token Exchange. If set to 'false', the app will not be able to issue a Session Transfer Token. Usually configured in the native application. Default value is false.

Optionalenforce_cascade_revocation

enforce_cascade_revocation?: boolean

Indicates whether revoking the parent Refresh Token that initiated a Native to Web flow and was used to issue a Session Transfer Token should trigger a cascade revocation affecting its dependent child entities. Usually configured in the native application. Default value is true, applicable only in Native to Web SSO context.

Optionalallowed_authentication_methods

allowed_authentication_methods?:
| Management.ClientSessionTransferAllowedAuthenticationMethodsEnum[]
| null

Indicates whether an app can create a session from a Session Transfer Token received via indicated methods. Can include cookie and/or query. Usually configured in the web application. Default value is an empty array [].

Optionalenforce_device_binding

enforce_device_binding?: Management.ClientSessionTransferDeviceBindingEnum

Optionalallow_refresh_token

allow_refresh_token?: boolean

Indicates whether Refresh Tokens are allowed to be issued when authenticating with a Session Transfer Token. Usually configured in the web application. Default value is false.

Optionalenforce_online_refresh_tokens

enforce_online_refresh_tokens?: boolean

Indicates whether Refresh Tokens created during a Native to Web session are tied to that session's lifetime. This determines if such refresh tokens should be automatically revoked when their corresponding sessions are. Usually configured in the web application. Default value is true, applicable only in Native to Web SSO context.

Optionaldelegation

delegation?: ClientSessionTransferDelegationConfiguration | null

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Properties can_create_session_transfer_tokenenforce_cascade_revocationallowed_authentication_methodsenforce_device_bindingallow_refresh_tokenenforce_online_refresh_tokensdelegation