Type Alias OAuthClientBase

Base schema for OAuth client requests and responses

type OAuthClientBase = {
    allowedAuthMethods?: ("client_secret" | "private_key_jwt")[];
    allowedGrantTypes?: (
        "client_credentials"
        | "urn:qlik:oauth:user-impersonation"
    )[];
    allowedScopes?: string[];
    appType: "web" | "native" | "spa" | "anonymous-embed";
    clientName: string;
    clientSecrets?: { createdAt?: string; createdBy?: string; hint: string }[];
    clientUri?: string;
    connectionConfig?: { consentMethod?: "required" | "trusted" };
    createdAt: string;
    createdByType?: string;
    deletedAt?: string;
    description?: string;
    disableTag?: string;
    logoUri?: string;
    publicKeys?: JWK[];
    publishedAt?: string;
    updatedAt?: string;
}
Index
allowedAuthMethods? allowedGrantTypes? allowedScopes? appType clientName clientSecrets? clientUri? connectionConfig? createdAt createdByType? deletedAt? description? disableTag? logoUri? publicKeys? publishedAt? updatedAt?
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'

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

clientSecrets?: { createdAt?: string; createdBy?: string; hint: string }[]

Hints of any client application secrets

Type Declaration

  • OptionalcreatedAt?: string

    The timestamp for when the client-secret record was created.

  • OptionalcreatedBy?: string

    The identifier for the user that created the client-secret record.

  • hint: string

    Hint of a client application secret

clientUri?: string

URI for homepage of client

connectionConfig?: { consentMethod?: "required" | "trusted" }

Optional settings for configuring the client connection.

Type Declaration

  • OptionalconsentMethod?: "required" | "trusted"

    Specifies the consent method for the connection.

createdAt: string

The timestamp for when the oauth-clients record was created.

createdByType?: string

The type of caller that created this client. Possible values are user, service, and dcr for Dynamic Client Registration.

deletedAt?: string

The timestamp for when the oauth-clients record was deleted.

description?: string

Client description

disableTag?: string

Is set if client disabled

logoUri?: string

URI for logo of client

publicKeys?: JWK[]

List of public keys for JWT authentication

publishedAt?: string

The timestamp which is set, if the client is published.

updatedAt?: string

The timestamp for when the oauth-clients record was updated.

Settings
Member Visibility

On This Page
Properties