Type Alias IdentityProvidersAPI

type IdentityProvidersAPI = {
    clearCache: typeof clearCache;
    createIdp: typeof createIdp;
    deleteIdp: typeof deleteIdp;
    getIdp: typeof getIdp;
    getIdps: typeof getIdps;
    getIdpStatuses: typeof getIdpStatuses;
    getIdpWellKnownMetaData: typeof getIdpWellKnownMetaData;
    getMyIdpMeta: typeof getMyIdpMeta;
    patchIdp: typeof patchIdp;
}
Index

Properties

clearCache: typeof clearCache

Clears the cache for identity-providers api requests.

createIdp: typeof createIdp

Creates a new IdP on a tenant. Requesting user must be assigned the TenantAdmin role. For non-interactive IdPs (e.g. JWT), IdP must be created by sending options payload. For interactive IdPs (e.g. SAML or OIDC), send pendingOptions payload to require the interactive verification step; or send options payload with skipVerify set to true to skip validation step and make IdP immediately available.

an object with the body content

CreateIdpHttpError

deleteIdp: typeof deleteIdp

Deletes an identity provider. Requesting user must be assigned the TenantAdmin role.

The identity provider ID.

DeleteIdpHttpError

getIdp: typeof getIdp

Retrieves a specific IdP. Requesting user must be assigned the TenantAdmin role.

The identity provider ID.

GetIdpHttpError

getIdps: typeof getIdps

This endpoint retrieves any IdPs registered on the tenant.

an object with query parameters

GetIdpsHttpError

getIdpStatuses: typeof getIdpStatuses

Retrieves the status of all IdP configurations. Requires TenantAdmin role.

GetIdpStatusesHttpError

getIdpWellKnownMetaData: typeof getIdpWellKnownMetaData

Returns IdP configuration metadata supported on the tenant. Clients can use this information to programmatically configure their interactions with Qlik Cloud.

GetIdpWellKnownMetaDataHttpError

getMyIdpMeta: typeof getMyIdpMeta

Retrieves default IdP metadata when no interactive IdP is enabled.

GetMyIdpMetaHttpError

patchIdp: typeof patchIdp

Updates the configuration of an IdP. Requesting user must be assigned the TenantAdmin role. Partial failure is treated as complete failure and returns an error.

The identity provider ID.

an object with the body content

PatchIdpHttpError