Type Alias ApiKey

type ApiKey = {
    created?: string;
    createdByUser: string;
    description: string;
    expiry: string;
    id: string;
    lastUpdated?: string;
    status: "active" | "expired" | "revoked";
    sub: string;
    subType: "user" | "externalClient";
    tenantId: string;
}
Index

Properties

created? createdByUser description expiry id lastUpdated? status sub subType tenantId

Properties

created?: string

When the API key was created.

createdByUser: string

The ID of the user who created the key.

description: string

A description for the API key.

expiry: string

When the API key will expire and no longer be a valid authentication token.

id: string

The unique ID for the resource.

lastUpdated?: string

When the API key was last updated.

status: "active" | "expired" | "revoked"

The status of the API key.

sub: string

The ID of the subject for the API key. For SCIM the format is SCIM\\{{IDP-ID}}, where {{IDP-ID}} is the ID of the IDP in Qlik. For users, use their user ID, e.g. 64ef645a3b7009d55dee5a2b.

subType: "user" | "externalClient"

Type of the subject. For SCIM, it should be externalClient.

tenantId: string

The tenant ID.

Settings

Member Visibility

On This Page

Properties