Interface Client

interface Client {
    client_id?: string;
    tenant?: string;
    name?: string;
    description?: string;
    global?: boolean;
    client_secret?: string;
    app_type?: Management.ClientAppTypeEnum;
    logo_uri?: string;
    is_first_party?: boolean;
    oidc_conformant?: boolean;
    callbacks?: string[];
    allowed_origins?: string[];
    web_origins?: string[];
    client_aliases?: string[];
    allowed_clients?: string[];
    allowed_logout_urls?: string[];
    session_transfer?: ClientSessionTransferConfiguration;
    oidc_logout?: ClientOidcBackchannelLogoutSettings;
    grant_types?: string[];
    jwt_configuration?: ClientJwtConfiguration;
    signing_keys?: ClientSigningKeys;
    encryption_key?: ClientEncryptionKey;
    sso?: boolean;
    sso_disabled?: boolean;
    cross_origin_authentication?: boolean;
    cross_origin_loc?: string;
    custom_login_page_on?: boolean;
    custom_login_page?: string;
    custom_login_page_preview?: string;
    form_template?: string;
    addons?: ClientAddons;
    token_endpoint_auth_method?: Management.ClientTokenEndpointAuthMethodEnum;
    client_metadata?: ClientMetadata;
    mobile?: ClientMobile;
    initiate_login_uri?: string;
    refresh_token?: ClientRefreshTokenConfiguration;
    default_organization?: ClientDefaultOrganization;
    organization_usage?: Management.ClientOrganizationUsageEnum;
    organization_require_behavior?: Management.ClientOrganizationRequireBehaviorEnum;
    organization_discovery_methods?: Management.ClientOrganizationDiscoveryEnum[];
    client_authentication_methods?: ClientAuthenticationMethod;
    require_pushed_authorization_requests?: boolean;
    require_proof_of_possession?: boolean;
    signed_request_object?: ClientSignedRequestObjectWithCredentialId;
    compliance_level?: ClientComplianceLevelEnum;
    par_request_expiry?: number;
    token_quota?: TokenQuota;
    my_organization_configuration?: ClientMyOrganizationConfiguration;
    resource_server_identifier?: string;
    [key: string]: any;
}

Indexable

[key: string]: any
Accepts any additional properties

Index

Properties

client_id? tenant? name? description? global? client_secret? app_type? logo_uri? is_first_party? oidc_conformant? callbacks? allowed_origins? web_origins? client_aliases? allowed_clients? allowed_logout_urls? session_transfer? oidc_logout? grant_types? jwt_configuration? signing_keys? encryption_key? sso? sso_disabled? cross_origin_authentication? cross_origin_loc? custom_login_page_on? custom_login_page? custom_login_page_preview? form_template? addons? token_endpoint_auth_method? client_metadata? mobile? initiate_login_uri? refresh_token? default_organization? organization_usage? organization_require_behavior? organization_discovery_methods? client_authentication_methods? require_pushed_authorization_requests? require_proof_of_possession? signed_request_object? compliance_level? par_request_expiry? token_quota? my_organization_configuration? resource_server_identifier?

Properties

`Optional`client_id

client_id?: string

ID of this client.

`Optional`tenant

tenant?: string

Name of the tenant this client belongs to.

`Optional`name

name?: string

Name of this client (min length: 1 character, does not allow < or >).

`Optional`description

description?: string

Free text description of this client (max length: 140 characters).

`Optional`global

global?: boolean

Whether this is your global 'All Applications' client representing legacy tenant settings (true) or a regular client (false).

`Optional`client_secret

client_secret?: string

Client secret (which you must not make public).

`Optional`app_type

app_type?: Management.ClientAppTypeEnum

`Optional`logo_uri

logo_uri?: string

URL of the logo to display for this client. Recommended size is 150x150 pixels.

`Optional`is_first_party

is_first_party?: boolean

Whether this client a first party client (true) or not (false).

`Optional`oidc_conformant

oidc_conformant?: boolean

Whether this client conforms to strict OIDC specifications (true) or uses legacy features (false).

`Optional`callbacks

callbacks?: string[]

Comma-separated list of URLs whitelisted for Auth0 to use as a callback to the client after authentication.

`Optional`allowed_origins

allowed_origins?: string[]

Comma-separated list of URLs allowed to make requests from JavaScript to Auth0 API (typically used with CORS). By default, all your callback URLs will be allowed. This field allows you to enter other origins if necessary. You can also use wildcards at the subdomain level (e.g., https://*.contoso.com). Query strings and hash information are not taken into account when validating these URLs.

`Optional`web_origins

web_origins?: string[]

Comma-separated list of allowed origins for use with Cross-Origin Authentication, Device Flow, and web message response mode.

`Optional`client_aliases

client_aliases?: string[]

List of audiences/realms for SAML protocol. Used by the wsfed addon.

`Optional`allowed_clients

allowed_clients?: string[]

List of allow clients and API ids that are allowed to make delegation requests. Empty means all all your clients are allowed.

`Optional`allowed_logout_urls

allowed_logout_urls?: string[]

Comma-separated list of URLs that are valid to redirect to after logout from Auth0. Wildcards are allowed for subdomains.

`Optional`session_transfer

session_transfer?: ClientSessionTransferConfiguration

`Optional`oidc_logout

oidc_logout?: ClientOidcBackchannelLogoutSettings

`Optional`grant_types

grant_types?: string[]

List of grant types supported for this application. Can include authorization_code, implicit, refresh_token, client_credentials, password, http://auth0.com/oauth/grant-type/password-realm, http://auth0.com/oauth/grant-type/mfa-oob, http://auth0.com/oauth/grant-type/mfa-otp, http://auth0.com/oauth/grant-type/mfa-recovery-code, urn:openid:params:grant-type:ciba, urn:ietf:params:oauth:grant-type:device_code, and urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token.

`Optional`sso

sso?: boolean

Applies only to SSO clients and determines whether Auth0 will handle Single Sign On (true) or whether the Identity Provider will (false).

`Optional`sso_disabled

sso_disabled?: boolean

Whether Single Sign On is disabled (true) or enabled (true). Defaults to true.

`Optional`cross_origin_authentication

cross_origin_authentication?: boolean

Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false).

`Optional`cross_origin_loc

cross_origin_loc?: string

URL of the location in your site where the cross origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page.

`Optional`custom_login_page_on

custom_login_page_on?: boolean

Whether a custom login page is to be used (true) or the default provided login page (false).

`Optional`custom_login_page

custom_login_page?: string

The content (HTML, CSS, JS) of the custom login page.

`Optional`custom_login_page_preview

custom_login_page_preview?: string

The content (HTML, CSS, JS) of the custom login page. (Used on Previews)

`Optional`form_template

form_template?: string

HTML form template to be used for WS-Federation.

`Optional`addons

addons?: ClientAddons

`Optional`token_endpoint_auth_method

token_endpoint_auth_method?: Management.ClientTokenEndpointAuthMethodEnum

`Optional`client_metadata

client_metadata?: ClientMetadata

`Optional`mobile

mobile?: ClientMobile

`Optional`initiate_login_uri

initiate_login_uri?: string

Initiate login uri, must be https

`Optional`refresh_token

refresh_token?: ClientRefreshTokenConfiguration

`Optional`default_organization

default_organization?: ClientDefaultOrganization

`Optional`organization_usage

organization_usage?: Management.ClientOrganizationUsageEnum

`Optional`organization_require_behavior

organization_require_behavior?: Management.ClientOrganizationRequireBehaviorEnum

`Optional`organization_discovery_methods

organization_discovery_methods?: Management.ClientOrganizationDiscoveryEnum[]

Defines the available methods for organization discovery during the pre_login_prompt. Users can discover their organization either by email, organization_name or both.

`Optional`client_authentication_methods

client_authentication_methods?: ClientAuthenticationMethod

`Optional`require_pushed_authorization_requests

require_pushed_authorization_requests?: boolean

Makes the use of Pushed Authorization Requests mandatory for this client

`Optional`require_proof_of_possession

require_proof_of_possession?: boolean

Makes the use of Proof-of-Possession mandatory for this client

`Optional`signed_request_object

signed_request_object?: ClientSignedRequestObjectWithCredentialId

`Optional`compliance_level

compliance_level?: ClientComplianceLevelEnum

`Optional`par_request_expiry

par_request_expiry?: number

Specifies how long, in seconds, a Pushed Authorization Request URI remains valid

`Optional`token_quota

token_quota?: TokenQuota

`Optional`my_organization_configuration

my_organization_configuration?: ClientMyOrganizationConfiguration

`Optional`resource_server_identifier

resource_server_identifier?: string

The identifier of the resource server that this client is linked to.

Interface Client

Indexable

Index

Properties

Properties

Optionalclient_id

Optionaltenant

Optionalname

Optionaldescription

Optionalglobal

Optionalclient_secret

Optionalapp_type

Optionallogo_uri

Optionalis_first_party

Optionaloidc_conformant

Optionalcallbacks

Optionalallowed_origins

Optionalweb_origins

Optionalclient_aliases

Optionalallowed_clients

Optionalallowed_logout_urls

Optionalsession_transfer

Optionaloidc_logout

Optionalgrant_types

Optionaljwt_configuration

Optionalsigning_keys

Optionalencryption_key

Optionalsso

Optionalsso_disabled

Optionalcross_origin_authentication

Optionalcross_origin_loc

Optionalcustom_login_page_on

Optionalcustom_login_page

Optionalcustom_login_page_preview

Optionalform_template

Optionaladdons

Optionaltoken_endpoint_auth_method

Optionalclient_metadata

Optionalmobile

Optionalinitiate_login_uri

Optionalrefresh_token

Optionaldefault_organization

Optionalorganization_usage

Optionalorganization_require_behavior

Optionalorganization_discovery_methods

Optionalclient_authentication_methods

Optionalrequire_pushed_authorization_requests

Optionalrequire_proof_of_possession

Optionalsigned_request_object

Optionalcompliance_level

Optionalpar_request_expiry

Optionaltoken_quota

Optionalmy_organization_configuration

Optionalresource_server_identifier

Settings

On This Page

`Optional`client_id

`Optional`tenant

`Optional`name

`Optional`description

`Optional`global

`Optional`client_secret

`Optional`app_type

`Optional`logo_uri

`Optional`is_first_party

`Optional`oidc_conformant

`Optional`callbacks

`Optional`allowed_origins

`Optional`web_origins

`Optional`client_aliases

`Optional`allowed_clients

`Optional`allowed_logout_urls

`Optional`session_transfer

`Optional`oidc_logout

`Optional`grant_types

`Optional`jwt_configuration

`Optional`signing_keys

`Optional`encryption_key

`Optional`sso

`Optional`sso_disabled

`Optional`cross_origin_authentication

`Optional`cross_origin_loc

`Optional`custom_login_page_on

`Optional`custom_login_page

`Optional`custom_login_page_preview

`Optional`form_template

`Optional`addons

`Optional`token_endpoint_auth_method

`Optional`client_metadata

`Optional`mobile

`Optional`initiate_login_uri

`Optional`refresh_token

`Optional`default_organization

`Optional`organization_usage

`Optional`organization_require_behavior

`Optional`organization_discovery_methods

`Optional`client_authentication_methods

`Optional`require_pushed_authorization_requests

`Optional`require_proof_of_possession

`Optional`signed_request_object

`Optional`compliance_level

`Optional`par_request_expiry

`Optional`token_quota

`Optional`my_organization_configuration

`Optional`resource_server_identifier