Type Alias OAuthClientCreateRequest

Request schema for OAuth client creation

type OAuthClientCreateRequest = {
    allowedAuthMethods?: ("client_secret" | "private_key_jwt")[];
    allowedGrantTypes?: (
        "client_credentials"
        | "urn:qlik:oauth:user-impersonation"
    )[];
    allowedOrigins?: string[];
    allowedScopes?: string[];
    appType: "web" | "native" | "spa" | "anonymous-embed";
    clientName: string;
    clientUri?: string;
    connectionConfig?: { consentMethod?: "trusted" };
    description?: string;
    logoUri?: string;
    publicKeys?: JWK[];
    redirectUris?: string[];
}
Index

Properties

allowedAuthMethods? allowedGrantTypes? allowedOrigins? allowedScopes? appType clientName clientUri? connectionConfig? description? logoUri? publicKeys? redirectUris?

Properties

allowedAuthMethods?: ("client_secret" | "private_key_jwt")[]

List of allowed authentication methods for the client

allowedGrantTypes?: ("client_credentials" | "urn:qlik:oauth:user-impersonation")[]

Allowed grant types, only for use with appType: 'web'

allowedOrigins?: string[]

List of allowed origins for this client, only available with SPA application type

allowedScopes?: string[]

List of allowed scopes for this client. For a full list of scopes see qlik.dev/authenticate/oauth/scopes/.

appType: "web" | "native" | "spa" | "anonymous-embed"

Application type

clientName: string

Client application name

clientUri?: string

URI for homepage of client

connectionConfig?: { consentMethod?: "trusted" }

Optional settings for configuring the client connection.

Type Declaration

  • OptionalconsentMethod?: "trusted"

    Specifies the consent method for the connection. The only allowed value is "trusted."

description?: string

Client description

logoUri?: string

URI for logo of client

publicKeys?: JWK[]

List of public keys for JWT authentication (required when using private_key_jwt)

redirectUris?: string[]

List of allowed redirect URIs for login

Settings

Member Visibility

On This Page

Properties