MonoCloud Management SDK
    Preparing search index...

    Interface CreateApplicationRequest

    Create Application Request: Creates an OpenID Connect or OAuth 2.0 client configuration.

    CreateApplicationRequest

    interface CreateApplicationRequest {
        absolute_refresh_token_lifetime?: number;
        access_token_lifetime?: number;
        access_token_type?: AccessTokenTypes;
        allow_access_tokens_via_browser?: boolean;
        allow_any_pushed_authorization_redirect_uri?: boolean;
        allow_offline_access?: boolean;
        allow_plain_text_pkce?: boolean;
        allowed_cors_origins?: string[];
        allowed_grant_types: GrantTypes[];
        allowed_identity_scopes?: string[];
        always_include_user_claims_in_id_token?: boolean;
        always_require_consent_for_offline_access?: boolean;
        always_send_client_claims?: boolean;
        app_type?: ApplicationTypes;
        authenticator_restrictions?: Authenticators[];
        authorization_code_lifetime?: number;
        authorization_request_lifetime?: number;
        auto_generate_secret?: boolean;
        back_channel_logout_session_required?: boolean;
        back_channel_logout_uri?: string | null;
        bind_tokens_to_session?: boolean;
        claims?: Record<string, any>;
        client_claims_prefix?: string | null;
        client_name: string;
        client_uri?: string | null;
        consent_lifetime?: number;
        description?: string | null;
        device_code_length?: number;
        device_code_lifetime?: number;
        emit_offline_access_scope_in_access_token?: boolean;
        enable_consent?: boolean;
        enabled?: boolean;
        front_channel_logout_session_required?: boolean;
        front_channel_logout_uri?: string | null;
        identity_token_lifetime?: number;
        include_jwt_id?: boolean;
        logo_uri?: string | null;
        post_logout_redirect_uris?: string[];
        redirect_uris?: string[];
        refresh_token_expiration?: RefreshTokenExpirationTypes;
        refresh_token_usage?: RefreshTokenUsageTypes;
        remember_consent?: RememberConsentTypes;
        require_client_secret?: boolean;
        require_consent?: boolean;
        require_pkce?: boolean;
        require_pushed_authorization_requests?: boolean;
        require_request_object?: boolean;
        show_consent_scope_selection?: boolean;
        sliding_refresh_token_lifetime?: number;
        tech_type?: TechTypes;
        update_access_token_claims_on_refresh?: boolean;
        user_sso_lifetime?: number;
    }
    Index

    Properties

    absolute_refresh_token_lifetime?: number

    Specifies the maximum lifetime of a refresh token (in seconds), regardless of how often it is used.

    ScaleX subscription required to configure refresh token lifetimes longer than a month.

    CreateApplicationRequest

    access_token_lifetime?: number

    Specifies how long an access token remains valid (in seconds).

    CreateApplicationRequest

    access_token_type?: AccessTokenTypes

    Specifies whether access tokens are issued as self-contained JWTs or as opaque references stored server-side.

    CreateApplicationRequest

    allow_access_tokens_via_browser?: boolean

    Controls whether access tokens may be transmitted via the browser for this client.

    Enable only when absolutely necessary. Returning access tokens to the browser increases the risk of leakage through logs, plugins, redirects, or malicious scripts. Recommended to keep disabled and prefer the Authorization Code + PKCE flow.

    CreateApplicationRequest

    allow_any_pushed_authorization_redirect_uri?: boolean

    Allows the client to use any redirect URI when using Pushed Authorization Requests (PAR), instead of being limited to the configured redirect URI list.

    Secure+ subscription required to use Pushed Authorization Requests (PAR).

    CreateApplicationRequest

    allow_offline_access?: boolean

    Allows the client to obtain refresh tokens using the offline_access scope.

    Use only for trusted applications that can securely store long-lived tokens.

    CreateApplicationRequest

    allow_plain_text_pkce?: boolean

    Allows Proof Key for Code Exchange (PKCE) verification using the plain (unhashed) method.

    Use only for legacy compatibility — strongly discouraged for production.

    CreateApplicationRequest

    allowed_cors_origins?: string[]

    Configures the set of trusted origins permitted to perform cross-origin requests for this client.

    CreateApplicationRequest

    allowed_grant_types: GrantTypes[]

    Defines which OAuth / OIDC grant types this client is permitted to use.

    Only valid and secure grant combinations are supported.

    CreateApplicationRequest

    allowed_identity_scopes?: string[]

    Defines the approved identity scopes that this client is authorized to request.

    CreateApplicationRequest

    always_include_user_claims_in_id_token?: boolean

    Always embeds user claims in the ID token instead of requiring calls to the UserInfo endpoint.

    Enabling this increases the ID token size and may expose more user data to applications than necessary.

    CreateApplicationRequest

    always_require_consent_for_offline_access?: boolean

    Always prompts users for consent when requesting offline (refresh token) access.

    This setting applies even if the user previously chose to remember their consent. Secure+ subscription required to use consents.

    CreateApplicationRequest

    always_send_client_claims?: boolean

    Controls whether client claims are always emitted in access tokens, or only when using the client credentials flow.

    CreateApplicationRequest

    app_type?: ApplicationTypes

    Preferred application type for the client.

    CreateApplicationRequest

    authenticator_restrictions?: Authenticators[]

    Defines the authenticators users may use to sign in with this client. Leave empty to inherit the global authenticator policy.

    Pro plan subscription required to enable authenticator restrictions.

    CreateApplicationRequest

    authorization_code_lifetime?: number

    Specifies how long an authorization code remains valid (in seconds).

    CreateApplicationRequest

    authorization_request_lifetime?: number

    Lifetime of the authorization request (in seconds). Controls how long the request data is considered valid during the authorization flow.

    CreateApplicationRequest

    auto_generate_secret?: boolean

    Automatically generates a secure application secret when the application is created.

    CreateApplicationRequest

    back_channel_logout_session_required?: boolean

    Indicates whether the user’s session identifier should be included when invoking the back-channel logout URI.

    Secure+ subscription required to use back-channel logout.

    CreateApplicationRequest

    back_channel_logout_uri?: string | null

    Server-side (back-channel) endpoint that MonoCloud calls to notify the application of a user logout.

    Secure+ subscription required to use back-channel logout.

    CreateApplicationRequest

    bind_tokens_to_session?: boolean

    Binds issued tokens to the user's session. When enabled, all tokens and grants are automatically revoked when the user signs out or the session expires.

    ScaleX subscription required to use session binding.

    CreateApplicationRequest

    claims?: Record<string, any>

    Defines custom claims issued to this client and embedded into access tokens for downstream APIs and resources.

    CreateApplicationRequest

    client_claims_prefix?: string | null

    Configures a prefix for client claims, helping avoid naming collisions across tokens and downstream APIs.

    CreateApplicationRequest

    client_name: string

    Human-readable name for the client application, displayed to users on the login and consent screens.

    CreateApplicationRequest

    client_uri?: string | null

    Public URL that provides additional information about the client application.

    CreateApplicationRequest

    consent_lifetime?: number

    Specifies the validity period for stored user consent (in seconds). Set to 0 to allow consent to remain valid indefinitely.

    Secure+ subscription required to use consents.

    CreateApplicationRequest

    description?: string | null

    Description that explains the purpose of the client application.

    CreateApplicationRequest

    device_code_length?: number

    Specifies the length of the user verification code generated for the device flow.

    CreateApplicationRequest

    device_code_lifetime?: number

    Specifies the lifetime of the device authorization code (in seconds).

    CreateApplicationRequest

    emit_offline_access_scope_in_access_token?: boolean

    Includes the offline_access scope in issued access tokens when requested by the client.

    CreateApplicationRequest

    enable_consent?: boolean

    Indicates whether the consents are enabled for the client.

    Secure+ subscription required to use consents.

    CreateApplicationRequest

    enabled?: boolean

    Indicates whether the client is enabled.

    CreateApplicationRequest

    front_channel_logout_session_required?: boolean

    Indicates whether the user’s session identifier should be included when invoking the front-channel logout URI.

    Pro plan subscription required to use front-channel logout.

    CreateApplicationRequest

    front_channel_logout_uri?: string | null

    Browser-based (front-channel) endpoint on the client that receives user logout notifications from MonoCloud.

    Pro plan subscription required to use front-channel logout.

    CreateApplicationRequest

    identity_token_lifetime?: number

    Specifies how long an ID token remains valid (in seconds).

    CreateApplicationRequest

    include_jwt_id?: boolean

    Determines whether issued access tokens include a unique token identifier (jti).

    Recommended for auditing, correlation, and replay-detection.

    CreateApplicationRequest

    logo_uri?: string | null

    URL of the client application logo, displayed on the consent screen to help users identify the application.

    CreateApplicationRequest

    Optionalpost_logout_redirect_uris

    post_logout_redirect_uris?: string[]

    List of approved URIs users can be redirected to after a successful logout.

    Only exact, fully-qualified matches are allowed.

    CreateApplicationRequest

    redirect_uris?: string[]

    List of approved redirect URIs where authorization codes or tokens may be sent.

    Only exact, fully-qualified matches are allowed.

    CreateApplicationRequest

    refresh_token_expiration?: RefreshTokenExpirationTypes

    Controls whether refresh tokens expire at a fixed time or are extended with continued use.

    CreateApplicationRequest

    refresh_token_usage?: RefreshTokenUsageTypes

    Controls whether refresh tokens are single-use (rotated) or reusable.

    CreateApplicationRequest

    remember_consent?: RememberConsentTypes

    Controls how consent decisions are remembered for future sign-ins.

    CreateApplicationRequest

    require_client_secret?: boolean

    Requires confidential clients to present a client secret when requesting tokens.

    Only disable for public clients (e.g., SPA / mobile).

    CreateApplicationRequest

    require_consent?: boolean

    Controls whether users are prompted to review and approve requested permissions.

    Secure+ subscription required to use consents.

    CreateApplicationRequest

    require_pkce?: boolean

    Requires Proof Key for Code Exchange (PKCE) for authorization code flows.

    Strongly recommended for public clients such as SPAs and mobile applications.

    CreateApplicationRequest

    require_pushed_authorization_requests?: boolean

    Requires clients to use Pushed Authorization Requests (PAR) instead of sending parameters directly to the authorization endpoint.

    Secure+ subscription required to use Pushed Authorization Requests (PAR).

    CreateApplicationRequest

    require_request_object?: boolean

    Requires authorization requests to be sent as signed JWT request objects (JAR).

    Secure+ subscription required to use JWT request objects (JAR).

    CreateApplicationRequest

    show_consent_scope_selection?: boolean

    Allows end users to choose which requested scopes to grant on the consent screen.

    Secure+ subscription required to use consents.

    CreateApplicationRequest

    sliding_refresh_token_lifetime?: number

    Defines the sliding expiration window for refresh tokens (in seconds). Token expiry is extended on each valid refresh, subject to the absolute refresh token lifetime.

    CreateApplicationRequest

    tech_type?: TechTypes

    Preferred technology stack for the client.

    CreateApplicationRequest

    update_access_token_claims_on_refresh?: boolean

    Controls whether access token claims are recalculated and reissued when refreshing a token.

    CreateApplicationRequest

    user_sso_lifetime?: number

    Maximum allowed SSO duration (in seconds). After this window, users must sign in again to confirm identity. Set to 0 to disable the limit.

    CreateApplicationRequest