Interface CreateClientRequestContent

Example

{
 *         name: "name"
 *     }

interface CreateClientRequestContent {
    name: string;
    description?: string;
    logo_uri?: string;
    callbacks?: string[];
    oidc_logout?: ClientOidcBackchannelLogoutSettings;
    oidc_backchannel_logout?: ClientOidcBackchannelLogoutSettings;
    session_transfer?: ClientSessionTransferConfiguration;
    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;
    app_type?: Management.ClientAppTypeEnum;
    is_first_party?: boolean;
    oidc_conformant?: boolean;
    jwt_configuration?: ClientJwtConfiguration;
    encryption_key?: ClientEncryptionKey;
    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;
    default_organization?: ClientDefaultOrganization;
    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?: ClientComplianceLevelEnum;
    par_request_expiry?: number;
    token_quota?: CreateTokenQuota;
    resource_server_identifier?: string;
    my_organization_configuration?: ClientMyOrganizationConfiguration;
}

Index

Properties

name description? 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? 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? par_request_expiry? token_quota? resource_server_identifier? my_organization_configuration?

Properties

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`logo_uri

logo_uri?: string

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

`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`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`token_endpoint_auth_method

token_endpoint_auth_method?: Management.ClientTokenEndpointAuthMethodEnum

`Optional`app_type

app_type?: Management.ClientAppTypeEnum

`Optional`is_first_party

is_first_party?: boolean

Whether this client a first party client or not

`Optional`oidc_conformant

oidc_conformant?: boolean

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

`Optional`jwt_configuration

jwt_configuration?: ClientJwtConfiguration

`Optional`encryption_key

encryption_key?: ClientEncryptionKey

`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`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`sso_disabled

sso_disabled?: boolean

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

`Optional`custom_login_page_on

custom_login_page_on?: boolean

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

`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`client_metadata

client_metadata?: ClientMetadata

`Optional`mobile

mobile?: ClientMobile

`Optional`initiate_login_uri

initiate_login_uri?: string

Initiate login uri, must be https

`Optional`native_social_login

native_social_login?: NativeSocialLogin

`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?: ClientCreateAuthenticationMethod

`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?: ClientSignedRequestObjectWithPublicKey

`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?: CreateTokenQuota

`Optional`resource_server_identifier

resource_server_identifier?: string

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

`Optional`my_organization_configuration

my_organization_configuration?: ClientMyOrganizationConfiguration

Interface CreateClientRequestContent

Example

Index

Properties

Properties

name

Optionaldescription

Optionallogo_uri

Optionalcallbacks

Optionaloidc_logout

Optionaloidc_backchannel_logout

Optionalsession_transfer

Optionalallowed_origins

Optionalweb_origins

Optionalclient_aliases

Optionalallowed_clients

Optionalallowed_logout_urls

Optionalgrant_types

Optionaltoken_endpoint_auth_method

Optionalapp_type

Optionalis_first_party

Optionaloidc_conformant

Optionaljwt_configuration

Optionalencryption_key

Optionalsso

Optionalcross_origin_authentication

Optionalcross_origin_loc

Optionalsso_disabled

Optionalcustom_login_page_on

Optionalcustom_login_page

Optionalcustom_login_page_preview

Optionalform_template

Optionaladdons

Optionalclient_metadata

Optionalmobile

Optionalinitiate_login_uri

Optionalnative_social_login

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

Optionalresource_server_identifier

Optionalmy_organization_configuration

Settings

On This Page

`Optional`description

`Optional`logo_uri

`Optional`callbacks

`Optional`oidc_logout

`Optional`oidc_backchannel_logout

`Optional`session_transfer

`Optional`allowed_origins

`Optional`web_origins

`Optional`client_aliases

`Optional`allowed_clients

`Optional`allowed_logout_urls

`Optional`grant_types

`Optional`token_endpoint_auth_method

`Optional`app_type

`Optional`is_first_party

`Optional`oidc_conformant

`Optional`jwt_configuration

`Optional`encryption_key

`Optional`sso

`Optional`cross_origin_authentication

`Optional`cross_origin_loc

`Optional`sso_disabled

`Optional`custom_login_page_on

`Optional`custom_login_page

`Optional`custom_login_page_preview

`Optional`form_template

`Optional`addons

`Optional`client_metadata

`Optional`mobile

`Optional`initiate_login_uri

`Optional`native_social_login

`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`resource_server_identifier

`Optional`my_organization_configuration