• management
• Management
• CreateClientRequestContent

Interface CreateClientRequestContent

Example

{ * name: "name" * }Copy

interface CreateClientRequestContent {
name: string;
description?: string;
logo_uri?: string;
callbacks?: string[];
oidc_logout?: ClientOidcBackchannelLogoutSettings;
oidc_backchannel_logout?: ClientOidcBackchannelLogoutSettings;
session_transfer?: ClientSessionTransferConfiguration | null;
allowed_origins?: string[];
web_origins?: string[];
client_aliases?: string[];
allowed_clients?: string[];
allowed_logout_urls?: string[];
grant_types?: string[];
token_endpoint_auth_method?: Management.ClientTokenEndpointAuthMethodEnum;
is_token_endpoint_ip_header_trusted?: boolean;
app_type?: Management.ClientAppTypeEnum;
is_first_party?: boolean;
oidc_conformant?: boolean;
jwt_configuration?: ClientJwtConfiguration;
encryption_key?: ClientEncryptionKey | null;
sso?: boolean;
cross_origin_authentication?: boolean;
cross_origin_loc?: string;
sso_disabled?: boolean;
custom_login_page_on?: boolean;
custom_login_page?: string;
custom_login_page_preview?: string;
form_template?: string;
addons?: ClientAddons;
client_metadata?: ClientMetadata;
mobile?: ClientMobile;
initiate_login_uri?: string;
native_social_login?: NativeSocialLogin;
refresh_token?: ClientRefreshTokenConfiguration | null;
default_organization?: ClientDefaultOrganization | null;
organization_usage?: Management.ClientOrganizationUsageEnum;
organization_require_behavior?: Management.ClientOrganizationRequireBehaviorEnum;
organization_discovery_methods?: Management.ClientOrganizationDiscoveryEnum[];
client_authentication_methods?: ClientCreateAuthenticationMethod;
require_pushed_authorization_requests?: boolean;
require_proof_of_possession?: boolean;
signed_request_object?: ClientSignedRequestObjectWithPublicKey;
compliance_level?: Management.ClientComplianceLevelEnum | null;
skip_non_verifiable_callback_uri_confirmation_prompt?: boolean;
token_exchange?: ClientTokenExchangeConfiguration;
par_request_expiry?: number | null;
token_quota?: CreateTokenQuota;
resource_server_identifier?: string;
third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum;
redirection_policy?: Management.ClientRedirectionPolicyEnum;
express_configuration?: ExpressConfiguration;
my_organization_configuration?: ClientMyOrganizationPostConfiguration;
async_approval_notification_channels?: ClientAsyncApprovalNotificationsChannelsApiPostConfiguration;
}

Index

Properties

namedescription?logo_uri?callbacks?oidc_logout?oidc_backchannel_logout?session_transfer?allowed_origins?web_origins?client_aliases?allowed_clients?allowed_logout_urls?grant_types?token_endpoint_auth_method?is_token_endpoint_ip_header_trusted?app_type?is_first_party?oidc_conformant?jwt_configuration?encryption_key?sso?cross_origin_authentication?cross_origin_loc?sso_disabled?custom_login_page_on?custom_login_page?custom_login_page_preview?form_template?addons?client_metadata?mobile?initiate_login_uri?native_social_login?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?skip_non_verifiable_callback_uri_confirmation_prompt?token_exchange?par_request_expiry?token_quota?resource_server_identifier?third_party_security_mode?redirection_policy?express_configuration?my_organization_configuration?async_approval_notification_channels?

Properties

name

name: string

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

Optionaldescription

description?: string

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

Optionallogo_uri

logo_uri?: string

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

Optionalcallbacks

callbacks?: string[]

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

Optionaloidc_logout

oidc_logout?: ClientOidcBackchannelLogoutSettings

Optionaloidc_backchannel_logout

oidc_backchannel_logout?: ClientOidcBackchannelLogoutSettings

Configuration for OIDC backchannel logout (deprecated, in favor of oidc_logout)

Optionalsession_transfer

session_transfer?: ClientSessionTransferConfiguration | null

Optionalallowed_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.

Optionalweb_origins

web_origins?: string[]

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

Optionalclient_aliases

client_aliases?: string[]

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

Optionalallowed_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.

Optionalallowed_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.

Optionalgrant_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.

Optionaltoken_endpoint_auth_method

token_endpoint_auth_method?: Management.ClientTokenEndpointAuthMethodEnum

Optionalis_token_endpoint_ip_header_trusted

is_token_endpoint_ip_header_trusted?: boolean

If true, trust that the IP specified in the auth0-forwarded-for header is the end-user's IP for brute-force-protection on token endpoint.

Optionalapp_type

app_type?: Management.ClientAppTypeEnum

Optionalis_first_party

is_first_party?: boolean

Whether this client a first party client or not

Optionaloidc_conformant

oidc_conformant?: boolean

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

Optionaljwt_configuration

jwt_configuration?: ClientJwtConfiguration

Optionalencryption_key

encryption_key?: ClientEncryptionKey | null

Optionalsso

sso?: boolean

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

Optionalcross_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).

Optionalcross_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.

Optionalsso_disabled

sso_disabled?: boolean

true to disable Single Sign On, false otherwise (default: false)

Optionalcustom_login_page_on

custom_login_page_on?: boolean

true if the custom login page is to be used, false otherwise. Defaults to true

Optionalcustom_login_page

custom_login_page?: string

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

Optionalcustom_login_page_preview

custom_login_page_preview?: string

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

Optionalform_template

form_template?: string

HTML form template to be used for WS-Federation.

Optionaladdons

addons?: ClientAddons

Optionalclient_metadata

client_metadata?: ClientMetadata

Optionalmobile

mobile?: ClientMobile

Optionalinitiate_login_uri

initiate_login_uri?: string

Initiate login uri, must be https

Optionalnative_social_login

native_social_login?: NativeSocialLogin

Optionalrefresh_token

refresh_token?: ClientRefreshTokenConfiguration | null

Optionaldefault_organization

default_organization?: ClientDefaultOrganization | null

Optionalorganization_usage

organization_usage?: Management.ClientOrganizationUsageEnum

Optionalorganization_require_behavior

organization_require_behavior?: Management.ClientOrganizationRequireBehaviorEnum

Optionalorganization_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.

Optionalclient_authentication_methods

client_authentication_methods?: ClientCreateAuthenticationMethod

Optionalrequire_pushed_authorization_requests

require_pushed_authorization_requests?: boolean

Makes the use of Pushed Authorization Requests mandatory for this client

Optionalrequire_proof_of_possession

require_proof_of_possession?: boolean

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

Optionalsigned_request_object

signed_request_object?: ClientSignedRequestObjectWithPublicKey

Optionalcompliance_level

compliance_level?: Management.ClientComplianceLevelEnum | null

Optionalskip_non_verifiable_callback_uri_confirmation_prompt

skip_non_verifiable_callback_uri_confirmation_prompt?: boolean

Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as myapp://, or localhost). If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps. See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information.

Optionaltoken_exchange

token_exchange?: ClientTokenExchangeConfiguration

Optionalpar_request_expiry

par_request_expiry?: number | null

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

Optionaltoken_quota

token_quota?: CreateTokenQuota

Optionalresource_server_identifier

resource_server_identifier?: string

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

Optionalthird_party_security_mode

third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum

Optionalredirection_policy

redirection_policy?: Management.ClientRedirectionPolicyEnum

Optionalexpress_configuration

express_configuration?: ExpressConfiguration

Optionalmy_organization_configuration

my_organization_configuration?: ClientMyOrganizationPostConfiguration

Optionalasync_approval_notification_channels

async_approval_notification_channels?: ClientAsyncApprovalNotificationsChannelsApiPostConfiguration

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties namedescriptionlogo_uricallbacksoidc_logoutoidc_backchannel_logoutsession_transferallowed_originsweb_originsclient_aliasesallowed_clientsallowed_logout_urlsgrant_typestoken_endpoint_auth_methodis_token_endpoint_ip_header_trustedapp_typeis_first_partyoidc_conformantjwt_configurationencryption_keyssocross_origin_authenticationcross_origin_locsso_disabledcustom_login_page_oncustom_login_pagecustom_login_page_previewform_templateaddonsclient_metadatamobileinitiate_login_urinative_social_loginrefresh_tokendefault_organizationorganization_usageorganization_require_behaviororganization_discovery_methodsclient_authentication_methodsrequire_pushed_authorization_requestsrequire_proof_of_possessionsigned_request_objectcompliance_levelskip_non_verifiable_callback_uri_confirmation_prompttoken_exchangepar_request_expirytoken_quotaresource_server_identifierthird_party_security_moderedirection_policyexpress_configurationmy_organization_configurationasync_approval_notification_channels