Interface IdentityProvidersAPI

interface IdentityProvidersAPI {
    clearCache: () => void;
    createIdp: (
        body: IDPPostSchema,
        options?: ApiCallOptions,
    ) => Promise<CreateIdpHttpResponse>;
    deleteIdp: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteIdpHttpResponse>;
    getIdp: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<GetIdpHttpResponse>;
    getIdps: (
        query: {
            active?: boolean;
            limit?: number;
            next?: string;
            prev?: string;
        },
        options?: ApiCallOptions,
    ) => Promise<GetIdpsHttpResponse>;
    getIdpStatuses: (
        options?: ApiCallOptions,
    ) => Promise<GetIdpStatusesHttpResponse>;
    getIdpWellKnownMetaData: (
        options?: ApiCallOptions,
    ) => Promise<GetIdpWellKnownMetaDataHttpResponse>;
    getMyIdpMeta: (
        options?: ApiCallOptions,
    ) => Promise<GetMyIdpMetaHttpResponse>;
    patchIdp: (
        id: string,
        body: IDPPatchSchema,
        options?: ApiCallOptions,
    ) => Promise<PatchIdpHttpResponse>;
}
Index

Properties

clearCache createIdp deleteIdp getIdp getIdps getIdpStatuses getIdpWellKnownMetaData getMyIdpMeta patchIdp

Properties

clearCache: () => void

Clears the cache for identity-providers api requests.

Type declaration

    • (): void

    • Clears the cache for identity-providers api requests.

      Returns void

createIdp: (
    body: IDPPostSchema,
    options?: ApiCallOptions,
) => Promise<CreateIdpHttpResponse>

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.

Type declaration

    • (body: IDPPostSchema, options?: ApiCallOptions): Promise<CreateIdpHttpResponse>

    • 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.

      Parameters

      Returns Promise<CreateIdpHttpResponse>

      CreateIdpHttpError

Param: body

an object with the body content

CreateIdpHttpError

deleteIdp: (
    id: string,
    options?: ApiCallOptions,
) => Promise<DeleteIdpHttpResponse>

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

Type declaration

The identity provider ID.

DeleteIdpHttpError

getIdp: (id: string, options?: ApiCallOptions) => Promise<GetIdpHttpResponse>

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

Type declaration

The identity provider ID.

GetIdpHttpError

getIdps: (
    query: {
        active?: boolean;
        limit?: number;
        next?: string;
        prev?: string;
    },
    options?: ApiCallOptions,
) => Promise<GetIdpsHttpResponse>

This endpoint retrieves any IdPs registered on the tenant.

Type declaration

    • (
          query: {
              active?: boolean;
              limit?: number;
              next?: string;
              prev?: string;
          },
          options?: ApiCallOptions,
      ): Promise<GetIdpsHttpResponse>

    • This endpoint retrieves any IdPs registered on the tenant.

      Parameters

      • query: { active?: boolean; limit?: number; next?: string; prev?: string }

        an object with query parameters

        • Optionalactive?: boolean

          If provided, filters the results by the active field.

        • Optionallimit?: number

          The number of IdP entries to retrieve.

        • Optionalnext?: string

          The next page cursor.

        • Optionalprev?: string

          The previous page cursor.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetIdpsHttpResponse>

      GetIdpsHttpError

an object with query parameters

GetIdpsHttpError

getIdpStatuses: (
    options?: ApiCallOptions,
) => Promise<GetIdpStatusesHttpResponse>

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

Type declaration

GetIdpStatusesHttpError

getIdpWellKnownMetaData: (
    options?: ApiCallOptions,
) => Promise<GetIdpWellKnownMetaDataHttpResponse>

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

Type declaration

GetIdpWellKnownMetaDataHttpError

getMyIdpMeta: (options?: ApiCallOptions) => Promise<GetMyIdpMetaHttpResponse>

Retrieves default IdP metadata when no interactive IdP is enabled.

Type declaration

GetMyIdpMetaHttpError

patchIdp: (
    id: string,
    body: IDPPatchSchema,
    options?: ApiCallOptions,
) => Promise<PatchIdpHttpResponse>

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.

Type declaration

The identity provider ID.

Param: body

an object with the body content

PatchIdpHttpError

Settings

Member Visibility

On This Page

Properties