Type Alias ApiKeyBody

type ApiKeyBody = {
    description: string;
    expiry?: string;
    sub?: string;
    subType?: "user" | "externalClient";
}
Index

Properties

description expiry? sub? subType?

Properties

description: string

Text that describes the API key.

expiry?: string

The expiry of the API key, in ISO8601 duration format. For example, P7D sets expiry after 7 days. If not provided, defaults to the maximum API key or SCIM key expiry configured in the tenant.

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. When creating an API key for a user, this is their user ID, e.g. 64ef645a3b7009d55dee5a2b, and will default to the requesting user if not provided. User must be assigned the Developer role.

subType?: "user" | "externalClient"

Type of the subject. For SCIM, it should be externalClient. If not specified, defaults to user.

Settings

Member Visibility

On This Page

Properties