Auth0 Node.js SDK - v5.0.0
    Preparing search index...

    Interface UpdateClientRequestContent

    {}
    interface UpdateClientRequestContent {
        name?: string;
        description?: string;
        client_secret?: string;
        logo_uri?: string;
        callbacks?: string[];
        oidc_logout?: ClientOidcBackchannelLogoutSettings;
        oidc_backchannel_logout?: ClientOidcBackchannelLogoutSettings;
        session_transfer?: ClientSessionTransferConfiguration;
        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;
        sso?: boolean;
        cross_origin_authentication?: boolean;
        cross_origin_loc?: string;
        sso_disabled?: boolean;
        custom_login_page_on?: boolean;
        token_endpoint_auth_method?: ClientTokenEndpointAuthMethodOrNullEnum;
        app_type?: Management.ClientAppTypeEnum;
        is_first_party?: boolean;
        oidc_conformant?: boolean;
        custom_login_page?: string;
        custom_login_page_preview?: string;
        token_quota?: UpdateTokenQuota;
        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?: ClientOrganizationUsagePatchEnum;
        organization_require_behavior?: ClientOrganizationRequireBehaviorPatchEnum;
        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;
        my_organization_configuration?: ClientMyOrganizationConfiguration;
    }
    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? 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? par_request_expiry? my_organization_configuration?

    Properties

    name?: string

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

    description?: string

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

    client_secret?: string

    The secret used to sign tokens for the client

    logo_uri?: string

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

    callbacks?: string[]

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

    oidc_logout?: ClientOidcBackchannelLogoutSettings
    oidc_backchannel_logout?: ClientOidcBackchannelLogoutSettings
    session_transfer?: ClientSessionTransferConfiguration
    allowed_origins?: string[]

    A set of URLs that represents valid origins for CORS

    web_origins?: string[]

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

    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.

    client_aliases?: string[]

    List of audiences for SAML protocol

    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

    allowed_logout_urls?: string[]

    URLs that are valid to redirect to after logout from Auth0.

    jwt_configuration?: ClientJwtConfiguration
    encryption_key?: ClientEncryptionKey
    sso?: boolean

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

    cross_origin_authentication?: boolean

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

    cross_origin_loc?: string

    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.

    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.

    token_endpoint_auth_method?: ClientTokenEndpointAuthMethodOrNullEnum
    app_type?: Management.ClientAppTypeEnum
    is_first_party?: boolean

    Whether this client a first party client or not

    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
    token_quota?: UpdateTokenQuota
    form_template?: string

    Form template for WS-Federation protocol

    addons?: ClientAddons
    client_metadata?: ClientMetadata
    mobile?: ClientMobile
    initiate_login_uri?: string

    Initiate login uri, must be https

    native_social_login?: NativeSocialLogin
    refresh_token?: ClientRefreshTokenConfiguration
    default_organization?: ClientDefaultOrganization
    organization_usage?: ClientOrganizationUsagePatchEnum
    organization_require_behavior?: ClientOrganizationRequireBehaviorPatchEnum
    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.

    client_authentication_methods?: ClientAuthenticationMethod
    require_pushed_authorization_requests?: boolean

    Makes the use of Pushed Authorization Requests mandatory for this client

    require_proof_of_possession?: boolean

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

    signed_request_object?: ClientSignedRequestObjectWithCredentialId
    compliance_level?: ClientComplianceLevelEnum
    par_request_expiry?: number

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

    my_organization_configuration?: ClientMyOrganizationConfiguration

    Settings

    Member Visibility

    On This Page

    Properties