• management
• Management
• UpdateClientRequestContent

Interface UpdateClientRequestContent

Example

{}Copy

interface UpdateClientRequestContent {
name?: string;
description?: string;
client_secret?: string;
logo_uri?: string;
callbacks?: string[];
oidc_logout?: ClientOidcBackchannelLogoutSettings;
oidc_backchannel_logout?: ClientOidcBackchannelLogoutSettings;
session_transfer?: ClientSessionTransferConfiguration | null;
allowed_origins?: string[];
web_origins?: string[];
grant_types?: string[];
client_aliases?: string[];
allowed_clients?: string[];
allowed_logout_urls?: string[];
jwt_configuration?: ClientJwtConfiguration;
encryption_key?: ClientEncryptionKey | null;
sso?: boolean;
cross_origin_authentication?: boolean;
cross_origin_loc?: string | null;
sso_disabled?: boolean;
custom_login_page_on?: boolean;
token_endpoint_auth_method?:
| Management.ClientTokenEndpointAuthMethodOrNullEnum
| null;
is_token_endpoint_ip_header_trusted?: boolean;
app_type?: Management.ClientAppTypeEnum;
is_first_party?: boolean;
oidc_conformant?: boolean;
custom_login_page?: string;
custom_login_page_preview?: string;
token_quota?: UpdateTokenQuota
| null;
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.ClientOrganizationUsagePatchEnum | null;
organization_require_behavior?:
| Management.ClientOrganizationRequireBehaviorPatchEnum
| null;
organization_discovery_methods?: | Management.ClientOrganizationDiscoveryEnum[]
| null;
client_authentication_methods?: ClientAuthenticationMethod
| null;
require_pushed_authorization_requests?: boolean;
require_proof_of_possession?: boolean;
signed_request_object?: ClientSignedRequestObjectWithCredentialId;
compliance_level?: Management.ClientComplianceLevelEnum | null;
skip_non_verifiable_callback_uri_confirmation_prompt?: boolean | null;
token_exchange?: ClientTokenExchangeConfigurationOrNull | null;
par_request_expiry?: number | null;
express_configuration?: ExpressConfigurationOrNull | null;
my_organization_configuration?:
| ClientMyOrganizationPatchConfiguration
| null;
async_approval_notification_channels?: ClientAsyncApprovalNotificationsChannelsApiPatchConfiguration;
third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum;
redirection_policy?: Management.ClientRedirectionPolicyEnum;
}

Index

Properties

name?description?client_secret?logo_uri?callbacks?oidc_logout?oidc_backchannel_logout?session_transfer?allowed_origins?web_origins?grant_types?client_aliases?allowed_clients?allowed_logout_urls?jwt_configuration?encryption_key?sso?cross_origin_authentication?cross_origin_loc?sso_disabled?custom_login_page_on?token_endpoint_auth_method?is_token_endpoint_ip_header_trusted?app_type?is_first_party?oidc_conformant?custom_login_page?custom_login_page_preview?token_quota?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?express_configuration?my_organization_configuration?async_approval_notification_channels?third_party_security_mode?redirection_policy?

Properties

Optionalname

name?: string

The name of the client. Must contain at least one character. Does not allow '<' or '>'.

Optionaldescription

description?: string

Free text description of the purpose of the Client. (Max character length: 140)

Optionalclient_secret

client_secret?: string

The secret used to sign tokens for the client

Optionallogo_uri

logo_uri?: string

The URL of the client logo (recommended size: 150x150)

Optionalcallbacks

callbacks?: string[]

A set of URLs that are valid to call back from Auth0 when authenticating users

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[]

A set of URLs that represents valid origins for CORS

Optionalweb_origins

web_origins?: string[]

A set of URLs that represents valid web origins for use with web message response mode

Optionalgrant_types

grant_types?: string[]

A set of grant types that the client is authorized to use. 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.

Optionalclient_aliases

client_aliases?: string[]

List of audiences for SAML protocol

Optionalallowed_clients

allowed_clients?: string[]

Ids of clients that will be allowed to perform delegation requests. Clients that will be allowed to make delegation request. By default, all your clients will be allowed. This field allows you to specify specific clients

Optionalallowed_logout_urls

allowed_logout_urls?: string[]

URLs that are valid to redirect to after logout from Auth0

Optionaljwt_configuration

jwt_configuration?: ClientJwtConfiguration

An object that holds settings related to how JWTs are created

Optionalencryption_key

encryption_key?: ClientEncryptionKey | null

The client's encryption key

Optionalsso

sso?: boolean

true to use Auth0 instead of the IdP to do Single Sign On, false otherwise (default: false)

Optionalcross_origin_authentication

cross_origin_authentication?: boolean

true if this client can be used to make cross-origin authentication requests, false otherwise if cross origin is disabled

Optionalcross_origin_loc

cross_origin_loc?: string | null

URL for 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.

Optionaltoken_endpoint_auth_method

token_endpoint_auth_method?:
| Management.ClientTokenEndpointAuthMethodOrNullEnum
| null

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 will conform to strict OIDC specifications

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

Optionaltoken_quota

token_quota?: UpdateTokenQuota | null

Optionalform_template

form_template?: string

Form template for WS-Federation protocol

Optionaladdons

addons?: ClientAddons

Optionalclient_metadata

client_metadata?: ClientMetadata

Optionalmobile

mobile?: ClientMobile

Configuration related to native mobile apps

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.ClientOrganizationUsagePatchEnum | null

Optionalorganization_require_behavior

organization_require_behavior?:
| Management.ClientOrganizationRequireBehaviorPatchEnum
| null

Optionalorganization_discovery_methods

organization_discovery_methods?:
| Management.ClientOrganizationDiscoveryEnum[]
| null

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?: ClientAuthenticationMethod | null

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?: ClientSignedRequestObjectWithCredentialId

Optionalcompliance_level

compliance_level?: Management.ClientComplianceLevelEnum | null

Optionalskip_non_verifiable_callback_uri_confirmation_prompt

skip_non_verifiable_callback_uri_confirmation_prompt?: boolean | null

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?: ClientTokenExchangeConfigurationOrNull | null

Optionalpar_request_expiry

par_request_expiry?: number | null

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

Optionalexpress_configuration

express_configuration?: ExpressConfigurationOrNull | null

Optionalmy_organization_configuration

my_organization_configuration?: ClientMyOrganizationPatchConfiguration | null

Optionalasync_approval_notification_channels

async_approval_notification_channels?: ClientAsyncApprovalNotificationsChannelsApiPatchConfiguration

Optionalthird_party_security_mode

third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum

Optionalredirection_policy

redirection_policy?: Management.ClientRedirectionPolicyEnum

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties namedescriptionclient_secretlogo_uricallbacksoidc_logoutoidc_backchannel_logoutsession_transferallowed_originsweb_originsgrant_typesclient_aliasesallowed_clientsallowed_logout_urlsjwt_configurationencryption_keyssocross_origin_authenticationcross_origin_locsso_disabledcustom_login_page_ontoken_endpoint_auth_methodis_token_endpoint_ip_header_trustedapp_typeis_first_partyoidc_conformantcustom_login_pagecustom_login_page_previewtoken_quotaform_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_expiryexpress_configurationmy_organization_configurationasync_approval_notification_channelsthird_party_security_moderedirection_policy