ESPRMAdminIdentityProvider
Defined in: src/ESPRMAdminIdentityProvider.ts:11
Shell class for admin identity provider operations. Methods are added via prototype augmentation in methods/ESPRMAdminIdentityProvider/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminIdentityProvider():
ESPRMAdminIdentityProvider
Returns
Section titled “Returns”ESPRMAdminIdentityProvider
Methods
Section titled “Methods”createIdentityProvider()
Section titled “createIdentityProvider()”createIdentityProvider(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminIdentityProvider/CreateIdentityProvider.ts:27
Creates a new identity provider for federated authentication.
Parameters
Section titled “Parameters”params
Section titled “params”The identity provider configuration including provider_type.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response upon creation.
deleteIdentityProvider()
Section titled “deleteIdentityProvider()”deleteIdentityProvider(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminIdentityProvider/DeleteIdentityProvider.ts:27
Deletes an identity provider by provider type.
Parameters
Section titled “Parameters”params
Section titled “params”Must include the provider_type to delete.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response upon deletion.
getIdentityProviders()
Section titled “getIdentityProviders()”getIdentityProviders(
params?):Promise<GetIdentityProvidersResponse>
Defined in: src/methods/ESPRMAdminIdentityProvider/GetIdentityProviders.ts:22
Retrieves the list of configured identity providers.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional filters for the identity provider query.
Returns
Section titled “Returns”Promise<GetIdentityProvidersResponse>
The list of identity providers.
updateIdentityProvider()
Section titled “updateIdentityProvider()”updateIdentityProvider(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminIdentityProvider/UpdateIdentityProvider.ts:27
Updates an existing identity provider configuration.
Parameters
Section titled “Parameters”params
Section titled “params”The updated provider settings including provider_type.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response upon update.