Type Alias ApiKeysConfig

type ApiKeysConfig = {
    api_keys_enabled?: boolean;
    max_api_key_expiry?: string;
    max_keys_per_user?: number;
    scim_externalClient_expiry?: string;
}
Index

Properties

api_keys_enabled? max_api_key_expiry? max_keys_per_user? scim_externalClient_expiry?

Properties

api_keys_enabled?: boolean

Enables or disables user API key functionality for the specified tenant.

max_api_key_expiry?: string

The maximum lifetime, in ISO8601 duration format, for which an API key can be issued for the specified tenant, e.g. P7D for 7 days.

max_keys_per_user?: number

The maximum number of active API keys that any user can create for the specified tenant.

scim_externalClient_expiry?: string

The expiry of the scim externalClient token in ISO8601 duration format, e.g. P365D for 365 days. Used during the creation of an externalClient API key for configuring a SCIM compatible Identity Provider.

Settings

Member Visibility

On This Page

Properties