Type Alias ApiKeysAPI

type ApiKeysAPI = {
    clearCache: typeof clearCache;
    createApiKey: typeof createApiKey;
    deleteApiKey: typeof deleteApiKey;
    getApiKey: typeof getApiKey;
    getApiKeys: typeof getApiKeys;
    getApiKeysConfig: typeof getApiKeysConfig;
    patchApiKey: typeof patchApiKey;
    patchApiKeysConfig: typeof patchApiKeysConfig;
}
Index

Properties

clearCache createApiKey deleteApiKey getApiKey getApiKeys getApiKeysConfig patchApiKey patchApiKeysConfig

Properties

clearCache: typeof clearCache

Clears the cache for api-keys api requests.

createApiKey: typeof createApiKey

Creates an API key, either for a user, or for configuring SCIM for a compatible Identity Provider. Sending sub and subType is required only for creating SCIM keys.

Param: body

an object with the body content

CreateApiKeyHttpError

deleteApiKey: typeof deleteApiKey

Deletes or revokes an API key for a given API key ID. When the owner of the API key sends the request, the key will be deleted and removed from the tenant. When a user assigned the TenantAdmin role sends the request, the key will be disabled and marked as revoked.

The ID of the API key to be retrieved.

DeleteApiKeyHttpError

getApiKey: typeof getApiKey

Returns the API key for a given API key ID.

The ID of the API key to be retrieved.

GetApiKeyHttpError

getApiKeys: typeof getApiKeys

Lists API keys for the tenant. To list API keys owned by other users, requesting user must be assigned the TenantAdmin role.

an object with query parameters

GetApiKeysHttpError

getApiKeysConfig: typeof getApiKeysConfig

Retrieves the API key configuration for a tenant.

The tenant ID from which you wish to retrieve the API key configuration.

GetApiKeysConfigHttpError

patchApiKey: typeof patchApiKey

Updates an API key description for a given API key ID.

The ID of the API key resource to be updated.

Param: body

an object with the body content

PatchApiKeyHttpError

patchApiKeysConfig: typeof patchApiKeysConfig

Updates the API keys configuration for a given tenant ID.

The tenant ID of the API keys configuration to be retrieved.

Param: body

an object with the body content

PatchApiKeysConfigHttpError

Settings

Member Visibility

On This Page

Properties