ESPRMAdminCognitoAppClient
Defined in: src/ESPRMAdminCognitoAppClient.ts:11
Shell class for admin Cognito app client operations. Methods are added via prototype augmentation in methods/ESPRMAdminCognitoAppClient/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminCognitoAppClient():
ESPRMAdminCognitoAppClient
Returns
Section titled “Returns”ESPRMAdminCognitoAppClient
Methods
Section titled “Methods”createCognitoAppClient()
Section titled “createCognitoAppClient()”createCognitoAppClient(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminCognitoAppClient/CreateCognitoAppClient.ts:27
Creates a new Cognito app client for user authentication.
Parameters
Section titled “Parameters”params
Section titled “params”The app client configuration including client_name.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response upon creation.
getCognitoAppClients()
Section titled “getCognitoAppClients()”getCognitoAppClients(
params?):Promise<GetCognitoAppClientsResponse>
Defined in: src/methods/ESPRMAdminCognitoAppClient/GetCognitoAppClients.ts:22
Retrieves the list of Cognito app clients configured for the deployment.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional filters for the app client query.
Returns
Section titled “Returns”Promise<GetCognitoAppClientsResponse>
The list of Cognito app clients.
updateCognitoAppClient()
Section titled “updateCognitoAppClient()”updateCognitoAppClient(
params,queryParams?):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminCognitoAppClient/UpdateCognitoAppClient.ts:31
Updates an existing Cognito app client configuration.
Parameters
Section titled “Parameters”params
Section titled “params”The updated app client settings including client_id.
queryParams?
Section titled “queryParams?”Optional query params for selecting target user pool.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response upon update.