import { BaseClient, ClientConfig, Response } from "@commerce-apps/core"; import type { CommonParameters } from "@commerce-apps/core"; import type { OperationOptions } from "retry"; import type { RequestInit } from "node-fetch"; import type { CompositeParameters, CustomRequestBody, QueryParameters, RequireParametersUnlessAllAreOptional } from "../../types"; import type { Client, ClientListResponse, ClientRequest, IdentityProvider, IdentityProviderResponse, IdpListResponse, PasswordActionTemplate, Tenant, TenantDto } from '../models/index'; export type DeletePwdActionTemplateActionTypeEnum = 'PWDLESS_LOGIN' | 'PWD_RESET_ACTION' | 'PWD_RESET_CROSS_DEVICE_ACTION'; export type DeletePwdActionTemplateTemplateTypeEnum = 'EMAIL' | 'SMS'; export type RetrievePwdActionTemplateActionTypeEnum = 'PWDLESS_LOGIN' | 'PWD_RESET_ACTION' | 'PWD_RESET_CROSS_DEVICE_ACTION'; export type RetrievePwdActionTemplateTemplateTypeEnum = 'EMAIL' | 'SMS'; /** * [Auth Admin](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=auth-admin:Summary) * ================================== * * *[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/auth-admin/auth-admin-oas-v1-public.yaml) # API Overview The SLAS Admin API is a companion to the main [Shopper Login and API Access Service](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary) (SLAS), which enables secure access to Commerce Cloud’s Shopper APIs. The SLAS Admin API is only used for administration tasks, not for requesting access to the Shopper APIs. **Important:** Before using this API, follow the instructions in [Authorization for Shopper APIs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html) from the Get Started guides. The guide provides a complete set of instructions for setting up a SLAS client. For more information, see the [SLAS guides](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas.html). ## Tenant Id In context of SLAS administration a tenant identifier is used instead of the organization identifier. A B2C Commerce instance is considered a “tenant” when it's associated with a supporting system, such as the Shopper Login and API Access Service (SLAS). A tenant ID begins with a four-character realm ID, followed by an underscore (`_`) and an instance ID. These are example tenant IDs for various types of instances: | Instance Type | Realm ID | Instance ID | Tenant ID | | ----------------- | -------- | ----------- | --------- | | Staging | bcgl | stg | bcgl_stg | | On-demand sandbox | zzte | 053 | zzte_053 | | POD sandbox | zzrf | s01 | zzrf_s01 |*
* * For instructions on how to retrieve access token for admin APIs: https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-admin-apis.html

* Example with admin auth * * ```typescript * import { SlasAdmin, ClientConfig } from "commerce-sdk"; * // or * const { SlasAdmin, ClientConfig } = require("commerce-sdk"); * * const clientConfig: ClientConfig = { * parameters: { * clientId: "XXXXXX", * organizationId: "XXXX", * shortCode: "XXX", * siteId: "XX" * } * }; * * token = { access_token: 'INSERT_ACCESS_TOKEN_HERE' }; * * clientConfig.headers['authorization'] = `Bearer ${token.access_token}`; * const authAdminClient = new SlasAdmin(clientConfig); * ``` * * * API Version: 1.4.4
* Last Updated:
*
* */ export declare class SlasAdmin extends BaseClient { constructor(config: ClientConfig); /** * Delete a client by client ID. * * If you would like to get a raw Response object use the other deleteClient function. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.clientId - * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * * @returns A promise of type void. */ deleteClient(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ clientId: string; tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>): Promise; /** * Delete a client by client ID. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.clientId - * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param rawResponse - Set to true to return entire Response object instead of DTO. * * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise. */ deleteClient(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ clientId: string; tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>, rawResponse?: T): Promise; /** * Delete an identity provider by name. * * If you would like to get a raw Response object use the other deleteIdentityProvider function. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.name - * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * * @returns A promise of type void. */ deleteIdentityProvider(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ name: string; tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>): Promise; /** * Delete an identity provider by name. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.name - * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param rawResponse - Set to true to return entire Response object instead of DTO. * * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise. */ deleteIdentityProvider(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ name: string; tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>, rawResponse?: T): Promise; /** * Delete a password action template. * * If you would like to get a raw Response object use the other deletePwdActionTemplate function. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.clientId - * @param options.parameters.tenantId - * @param options.parameters.channelId - * @param options.parameters.actionType - * @param options.parameters.templateType - * @param options.parameters.locale - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * * @returns A promise of type void. */ deletePwdActionTemplate(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ clientId: string; tenantId: string; channelId: string; actionType: DeletePwdActionTemplateActionTypeEnum; templateType: DeletePwdActionTemplateTemplateTypeEnum; locale: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>): Promise; /** * Delete a password action template. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.clientId - * @param options.parameters.tenantId - * @param options.parameters.channelId - * @param options.parameters.actionType - * @param options.parameters.templateType - * @param options.parameters.locale - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param rawResponse - Set to true to return entire Response object instead of DTO. * * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise. */ deletePwdActionTemplate(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ clientId: string; tenantId: string; channelId: string; actionType: DeletePwdActionTemplateActionTypeEnum; templateType: DeletePwdActionTemplateTemplateTypeEnum; locale: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>, rawResponse?: T): Promise; /** * Delete all shopper records associated with a shopper's customer ID. The email ID is used if it's passed as a query parameter. This conforms to the GDPR regulations. * * If you would like to get a raw Response object use the other deleteShopper function. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.customerId - * @param options.parameters.tenantId - * @param options.parameters.emailAddress - The shoppers email address. * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * * @returns A promise of type void. */ deleteShopper(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ customerId: string; tenantId: string; emailAddress?: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>): Promise; /** * Delete all shopper records associated with a shopper's customer ID. The email ID is used if it's passed as a query parameter. This conforms to the GDPR regulations. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.customerId - * @param options.parameters.tenantId - * @param options.parameters.emailAddress - The shoppers email address. * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param rawResponse - Set to true to return entire Response object instead of DTO. * * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise. */ deleteShopper(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ customerId: string; tenantId: string; emailAddress?: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>, rawResponse?: T): Promise; /** * It is strongly advised to refrain from using the “sfcc-shopper-context.rw” scope with a PUBLIC Client because it offers fewer protections and could potentially enable malicious actors to access Shopper Context enabled promotions. It is highly recommended to use “sfcc-shopper-context.rw” scope with a private client. * * If you would like to get a raw Response object use the other registerClient function. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.clientId - * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param options.body - The data to send as the request body. * * @returns A promise of type Client. */ registerClient(options: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ clientId: string; tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; body: ClientRequest & CustomRequestBody; }>): Promise; /** * It is strongly advised to refrain from using the “sfcc-shopper-context.rw” scope with a PUBLIC Client because it offers fewer protections and could potentially enable malicious actors to access Shopper Context enabled promotions. It is highly recommended to use “sfcc-shopper-context.rw” scope with a private client. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.clientId - * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param options.body - The data to send as the request body. * @param rawResponse - Set to true to return entire Response object instead of DTO. * * @returns A promise of type Response if rawResponse is true, a promise of type Client otherwise. */ registerClient(options: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ clientId: string; tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; body: ClientRequest & CustomRequestBody; }>, rawResponse?: T): Promise; /** * Create or update an identity provider by name. * * If you would like to get a raw Response object use the other registerIdentityProvider function. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.name - * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param options.body - The data to send as the request body. * * @returns A promise of type IdentityProviderResponse. */ registerIdentityProvider(options: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ name: string; tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; body: IdentityProvider & CustomRequestBody; }>): Promise; /** * Create or update an identity provider by name. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.name - * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param options.body - The data to send as the request body. * @param rawResponse - Set to true to return entire Response object instead of DTO. * * @returns A promise of type Response if rawResponse is true, a promise of type IdentityProviderResponse otherwise. */ registerIdentityProvider(options: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ name: string; tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; body: IdentityProvider & CustomRequestBody; }>, rawResponse?: T): Promise; /** * Create or update a password action template by client ID. * * If you would like to get a raw Response object use the other registerPwdActionTemplate function. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.clientId - * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param options.body - The data to send as the request body. * * @returns A promise of type PasswordActionTemplate. */ registerPwdActionTemplate(options: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ clientId: string; tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; body: PasswordActionTemplate & CustomRequestBody; }>): Promise; /** * Create or update a password action template by client ID. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.clientId - * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param options.body - The data to send as the request body. * @param rawResponse - Set to true to return entire Response object instead of DTO. * * @returns A promise of type Response if rawResponse is true, a promise of type PasswordActionTemplate otherwise. */ registerPwdActionTemplate(options: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ clientId: string; tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; body: PasswordActionTemplate & CustomRequestBody; }>, rawResponse?: T): Promise; /** * This API is used to create or update a tenant. The tenant ID is the unique identifier for the tenant and is used in all subsequent API calls. The tenant ID must be unique across all tenants in the system. * * If you would like to get a raw Response object use the other registerTenant function. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param options.body - The data to send as the request body. * * @returns A promise of type Tenant. */ registerTenant(options: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; body: TenantDto & CustomRequestBody; }>): Promise; /** * This API is used to create or update a tenant. The tenant ID is the unique identifier for the tenant and is used in all subsequent API calls. The tenant ID must be unique across all tenants in the system. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param options.body - The data to send as the request body. * @param rawResponse - Set to true to return entire Response object instead of DTO. * * @returns A promise of type Response if rawResponse is true, a promise of type Tenant otherwise. */ registerTenant(options: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; body: TenantDto & CustomRequestBody; }>, rawResponse?: T): Promise; /** * Retrieve a client by client ID. The client ID is the unique identifier for the client and is used in all subsequent API calls. The client ID must be unique across all tenants in the system. * * If you would like to get a raw Response object use the other retrieveClient function. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.clientId - * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * * @returns A promise of type Client. */ retrieveClient(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ clientId: string; tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>): Promise; /** * Retrieve a client by client ID. The client ID is the unique identifier for the client and is used in all subsequent API calls. The client ID must be unique across all tenants in the system. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.clientId - * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param rawResponse - Set to true to return entire Response object instead of DTO. * * @returns A promise of type Response if rawResponse is true, a promise of type Client otherwise. */ retrieveClient(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ clientId: string; tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>, rawResponse?: T): Promise; /** * Retrieve a list of SLAS clients associated with the tenant_id. * * If you would like to get a raw Response object use the other retrieveClients function. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * * @returns A promise of type ClientListResponse. */ retrieveClients(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>): Promise; /** * Retrieve a list of SLAS clients associated with the tenant_id. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param rawResponse - Set to true to return entire Response object instead of DTO. * * @returns A promise of type Response if rawResponse is true, a promise of type ClientListResponse otherwise. */ retrieveClients(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>, rawResponse?: T): Promise; /** * Retrieve a specific identity provider by name. * * If you would like to get a raw Response object use the other retrieveIdentityProvider function. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.name - * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * * @returns A promise of type IdentityProvider. */ retrieveIdentityProvider(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ name: string; tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>): Promise; /** * Retrieve a specific identity provider by name. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.name - * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param rawResponse - Set to true to return entire Response object instead of DTO. * * @returns A promise of type Response if rawResponse is true, a promise of type IdentityProvider otherwise. */ retrieveIdentityProvider(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ name: string; tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>, rawResponse?: T): Promise; /** * Retrieve a list of SLAS identity providers associated with the tenant_id. * * If you would like to get a raw Response object use the other retrieveIdentityProviders function. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * * @returns A promise of type IdpListResponse. */ retrieveIdentityProviders(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>): Promise; /** * Retrieve a list of SLAS identity providers associated with the tenant_id. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param rawResponse - Set to true to return entire Response object instead of DTO. * * @returns A promise of type Response if rawResponse is true, a promise of type IdpListResponse otherwise. */ retrieveIdentityProviders(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>, rawResponse?: T): Promise; /** * Retrieve a password action template by client ID. * * If you would like to get a raw Response object use the other retrievePwdActionTemplate function. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.clientId - * @param options.parameters.tenantId - * @param options.parameters.channelId - * @param options.parameters.actionType - * @param options.parameters.templateType - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * * @returns A promise of type PasswordActionTemplate. */ retrievePwdActionTemplate(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ clientId: string; tenantId: string; channelId: string; actionType: RetrievePwdActionTemplateActionTypeEnum; templateType: RetrievePwdActionTemplateTemplateTypeEnum; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>): Promise; /** * Retrieve a password action template by client ID. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.clientId - * @param options.parameters.tenantId - * @param options.parameters.channelId - * @param options.parameters.actionType - * @param options.parameters.templateType - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param rawResponse - Set to true to return entire Response object instead of DTO. * * @returns A promise of type Response if rawResponse is true, a promise of type PasswordActionTemplate otherwise. */ retrievePwdActionTemplate(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ clientId: string; tenantId: string; channelId: string; actionType: RetrievePwdActionTemplateActionTypeEnum; templateType: RetrievePwdActionTemplateTemplateTypeEnum; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>, rawResponse?: T): Promise; /** * Retrieve a tenant by tenant ID. * * If you would like to get a raw Response object use the other retrieveTenant function. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * * @returns A promise of type Tenant. */ retrieveTenant(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>): Promise; /** * Retrieve a tenant by tenant ID. * * @param options - An object containing the options for this method. * @param options.parameters - An object containing the parameters for this method. * @param options.parameters.tenantId - * @param options.retrySettings - Retry options for the `node-retry` package * @param options.fetchOptions - Fetch options for the `make-fetch-happen` package * @param options.headers - An object literal of key value pairs of the headers to be sent with this request. * @param rawResponse - Set to true to return entire Response object instead of DTO. * * @returns A promise of type Response if rawResponse is true, a promise of type Tenant otherwise. */ retrieveTenant(options?: RequireParametersUnlessAllAreOptional<{ parameters?: CompositeParameters<{ tenantId: string; } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions; fetchOptions?: RequestInit; headers?: { [key: string]: string; }; }>, rawResponse?: T): Promise; }