/** This is spectacularly generated code by spectacular based on Qlik Cloud Services APIs */ import Auth from '../auth/auth.js'; import ListableResource from '../listable.js'; import type { Config } from '../types/types.js'; export declare enum IDPProtocol { OIDC = "OIDC", JwtAuth = "jwtAuth", QsefwLocalBearerToken = "qsefw-local-bearer-token" } export declare enum IDPProvider { Auth0 = "auth0", Okta = "okta", Qlik = "qlik", Generic = "generic", Salesforce = "salesforce", Keycloak = "keycloak", Adfs = "adfs", External = "external", AzureAD = "azureAD" } export type IDP = { [key: string]: any; }; export type IDPMeta = { /** A link to direct you to where you can upgrade your trial or manage your subscriptions. Only available if the default identity provider is used (no custom interactive identity providers are active). */ upgradeSubscriptionLink?: string; /** A link to direct you to where you can manage your Qlik account. Only available if the default identity provider is used (no custom interactive identity providers are active). */ userPortalLink?: string; [key: string]: any; }; export type IDPPatchSchema = { [key: string]: any; }; export type IDPPostSchema = { [key: string]: any; }; export type IDPsStatus = { /** The number of active interactive IdPs. */ active_interactive_idps_count?: number; /** A list of IdP metadata. */ idps_metadata?: { active?: boolean; interactive?: boolean; provider?: IDPProvider; }[]; [key: string]: any; }; export declare class IdentityProviders { auth: Auth; config: Config; constructor(config: Config | Auth); /** This endpoint retrieves identity providers' metadata. Returns identity providers' metadata */ getWellKnownMetadataJson(): Promise; /** This endpoint retrieves IdP metadata. Returns the active interactive IdP metadata */ getMeMeta(): Promise; /** This endpoint retrieves the status of IdP configurations. Requires TenantAdmin role. Returns the current status of IdP configurations */ getStatus(): Promise; /** This endpoint deletes an identity provider from the service. It returns a valid 204 when the IdP is deleted. Only a user with the role of TenantAdmin and tenant access can delete an associated IdP. Edge-auth service can also delete. Deletes the IdP with the specified ID @param id - The identity provider ID. */ delete(id: string): Promise; /** This endpoint is used to retrieve an identity provider from the service. It returns a valid 200 OK response when the IdP exists and the user (TenantAdmin) or service (edge-auth) is authorized to view the contents. Additionally, returns a header "QLIK-IDP-POPTS" (A unique string representing a hash of the current configuration being tested). It returns a 404 Not Found if the criteria is not met. Returns the IdP with the specified ID @param id - The identity provider ID. */ get(id: string): Promise; /** This endpoint patches an identity provider from the service. It returns a valid 204 when the IdP is patched. Only an edge-auth service request or a user with the role of TenantAdmin can patch an associated IdP. Partial failure is treated as complete failure and returns an error. Updates the IdP with the specified ID @param id - The identity provider ID. @param QLIK-IDP-POPTS-MATCH - A unique string representing a hash that should map to an IdP's hash representation of the current configuration being tested. @param data - Attributes that the user wants to patially update for an identity provider resource. */ patch(id: string, data: IDPPatchSchema, qlikIdpPoptsMatch?: string): Promise; /** This endpoint retrieves one or more identity providers from the service. The tenantID in the JWT will be used to fetch the identity provider. Retrieves one or more IdPs for a specified tenantId. @param active - If provided, filters the results by the active field. @param limit - The number of IdP entries to retrieve. @param next - The next page cursor. @param prev - The previous page cursor. */ getIdentityProviders(queryParams?: { active?: boolean; limit?: number; next?: string; prev?: string; }): Promise>; /** This endpoint creates an identity provider resource. It returns a 201 Created when creation is successful with a header "QLIK-IDP-POPTS" (A unique string representing a hash of the current configuration being tested), returns a 403 Forbidden for a non TenantAdmin user JWT or if the tenantID in the JWT does not match with any of the tenantIDs in the payload. An IdP can be created with Pending Options or options depending whether the IdP is interactive or not. Creates a new IdP @param data - Attributes that the user wants to set for a new identity provider resource. */ create(data: IDPPostSchema): Promise; }