@itentialopensource/adapter-aws_cognito_identity_provider/CALLS.md

This adapter integrates with system described as: Amazon Cognito Identity Provider.

## Using this Adapter

The `adapter.js` file contains the calls the adapter makes available to the rest of the Itential Platform. The API detailed for these calls should be available through JSDOC. The following is a brief summary of the calls.

### Generic Adapter Calls

These are adapter methods that Itential Platform or you might use. There are some other methods not shown here that might be used for internal adapter functionality.

<table border="1" class="bordered-table">
  <tr>
    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
  </tr>
  <tr>
    <td style="padding:15px">connect()</td>
    <td style="padding:15px">This call is run when the Adapter is first loaded by the Itential Platform. It validates the properties have been provided correctly.</td>
    <td style="padding:15px">No</td>
  </tr>
  <tr>
    <td style="padding:15px">healthCheck(callback)</td>
    <td style="padding:15px">This call ensures that the adapter can communicate with Aws_cognito_identity_provider. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
    <td style="padding:15px">No</td>
  </tr>
  <tr>
    <td style="padding:15px">refreshProperties(properties)</td>
    <td style="padding:15px">This call provides the adapter the ability to accept property changes without having to restart the adapter.</td>
    <td style="padding:15px">No</td>
  </tr>
  <tr>
    <td style="padding:15px">encryptProperty(property, technique, callback)</td>
    <td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Aws_cognito_identity_provider.</td>
    <td style="padding:15px">No</td>
  </tr>
  <tr>
    <td style="padding:15px">iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback)</td>
    <td style="padding:15px">This call provides the ability to update the adapter configuration from Itential Platform - includes actions, schema, mockdata and other configurations.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">iapSuspendAdapter(mode, callback)</td>
    <td style="padding:15px">This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">iapUnsuspendAdapter(callback)</td>
    <td style="padding:15px">This call provides the ability to resume a suspended adapter. Any requests in queue will be processed before new requests.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">iapGetAdapterQueue(callback)</td>
    <td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
    <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">iapTroubleshootAdapter(props, adapter, callback)</td>
    <td style="padding:15px">This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td>
    <td style="padding:15px">This call will return the results of a healthcheck.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">iapRunAdapterConnectivity(callback)</td>
    <td style="padding:15px">This call will return the results of a connectivity check.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">iapRunAdapterBasicGet(maxCalls, callback)</td>
    <td style="padding:15px">This call will return the results of running basic get API calls. By default 5 get calls without parameters will be run. You can ask for more or less by setting maxCalls.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">iapMoveAdapterEntitiesToDB(callback)</td>
    <td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or Itential Platform Database.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">iapDeactivateTasks(tasks, callback)</td>
    <td style="padding:15px">This call provides the ability to remove tasks from the adapter.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">iapActivateTasks(tasks, callback)</td>
    <td style="padding:15px">This call provides the ability to add deactivated tasks back into the adapter.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)</td>
    <td style="padding:15px">This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
    <td style="padding:15px">This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
    <td style="padding:15px">This call is the same as the genericAdapterRequest only it does not add a base_path or version to the call.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">iapRunAdapterLint(callback)</td>
    <td style="padding:15px">Runs lint on the adapter and provides the information back.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">iapRunAdapterTests(callback)</td>
    <td style="padding:15px">Runs baseunit and unit tests on the adapter and provides the information back.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">iapGetAdapterInventory(callback)</td>
    <td style="padding:15px">This call provides some inventory related information about the adapter.</td>
    <td style="padding:15px">Yes</td>
  </tr>
</table>
<br>

### Adapter Cache Calls

These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.

<table border="1" class="bordered-table">
  <tr>
    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
  </tr>
  <tr>
    <td style="padding:15px">iapPopulateEntityCache(entityTypes, callback)</td>
    <td style="padding:15px">This call populates the adapter cache.</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">iapRetrieveEntitiesCache(entityType, options, callback)</td>
    <td style="padding:15px">This call retrieves the specific items from the adapter cache.</td>
    <td style="padding:15px">Yes</td>
  </tr>
</table>
<br>

### Adapter Broker Calls

These are adapter methods that are used to integrate to Itential Platform Brokers. This adapter currently supports the following broker calls.

<table border="1" class="bordered-table">
  <tr>
    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
  </tr>
  <tr>
    <td style="padding:15px">hasEntities(entityType, entityList, callback)</td>
    <td style="padding:15px">This call is utilized by the Itential Platform Device Broker to determine if the adapter has a specific entity and item of the entity.</td>
    <td style="padding:15px">No</td>
  </tr>
  <tr>
    <td style="padding:15px">getDevice(deviceName, callback)</td>
    <td style="padding:15px">This call returns the details of the requested device.</td>
    <td style="padding:15px">No</td>
  </tr>
  <tr>
    <td style="padding:15px">getDevicesFiltered(options, callback)</td>
    <td style="padding:15px">This call returns the list of devices that match the criteria provided in the options filter.</td>
    <td style="padding:15px">No</td>
  </tr>
  <tr>
    <td style="padding:15px">isAlive(deviceName, callback)</td>
    <td style="padding:15px">This call returns whether the device status is active</td>
    <td style="padding:15px">No</td>
  </tr>
  <tr>
    <td style="padding:15px">getConfig(deviceName, format, callback)</td>
    <td style="padding:15px">This call returns the configuration for the selected device.</td>
    <td style="padding:15px">No</td>
  </tr>
  <tr>
    <td style="padding:15px">iapGetDeviceCount(callback)</td>
    <td style="padding:15px">This call returns the count of devices.</td>
    <td style="padding:15px">No</td>
  </tr>
</table>
<br>


### Specific Adapter Calls

Specific adapter calls are built based on the API of the Aws_cognito_identity_provider. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls.

<table border="1" class="bordered-table">
  <tr>
    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
  </tr>
  <tr>
    <td style="padding:15px">addCustomAttributes(body, iapMetadata, callback)</td>
    <td style="padding:15px">Adds additional user attributes to the user pool schema.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminAddUserToGroup(body, iapMetadata, callback)</td>
    <td style="padding:15px">Adds the specified user to the specified group.   Calling this action requires developer credential</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminConfirmSignUp(body, iapMetadata, callback)</td>
    <td style="padding:15px">Confirms user registration as an admin without using a confirmation code. Works on any user.   Call</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminCreateUser(body, iapMetadata, callback)</td>
    <td style="padding:15px">Creates a new user in the specified user pool.   If  MessageAction  isn't set, the default is to se</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminDeleteUser(body, iapMetadata, callback)</td>
    <td style="padding:15px">Deletes a user as an administrator. Works on any user.   Calling this action requires developer cre</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminDeleteUserAttributes(body, iapMetadata, callback)</td>
    <td style="padding:15px">Deletes the user attributes in a user pool as an administrator. Works on any user.   Calling this a</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminDisableProviderForUser(body, iapMetadata, callback)</td>
    <td style="padding:15px">Prevents the user from signing in with the specified external (SAML or social) identity provider (I</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminDisableUser(body, iapMetadata, callback)</td>
    <td style="padding:15px">Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in, bu</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminEnableUser(body, iapMetadata, callback)</td>
    <td style="padding:15px">Enables the specified user as an administrator. Works on any user.   Calling this action requires d</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminForgetDevice(body, iapMetadata, callback)</td>
    <td style="padding:15px">Forgets the device, as an administrator.   Calling this action requires developer credentials.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminGetDevice(body, iapMetadata, callback)</td>
    <td style="padding:15px">Gets the device, as an administrator.   Calling this action requires developer credentials.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminGetUser(body, iapMetadata, callback)</td>
    <td style="padding:15px">Gets the specified user by user name in a user pool as an administrator. Works on any user.   Calli</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminInitiateAuth(body, iapMetadata, callback)</td>
    <td style="padding:15px">Initiates the authentication flow, as an administrator.     This action might generate an SMS text</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminLinkProviderForUser(body, iapMetadata, callback)</td>
    <td style="padding:15px">Links an existing user account in a user pool ( DestinationUser ) to an identity from an external I</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminListDevices(body, iapMetadata, callback)</td>
    <td style="padding:15px">Lists devices, as an administrator.   Calling this action requires developer credentials.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminListGroupsForUser(limit, nextToken, body, iapMetadata, callback)</td>
    <td style="padding:15px">Lists the groups that the user belongs to.   Calling this action requires developer credentials.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminListUserAuthEvents(maxResults, nextToken, body, iapMetadata, callback)</td>
    <td style="padding:15px">A history of user activity and any risks detected as part of Amazon Cognito advanced security.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminRemoveUserFromGroup(body, iapMetadata, callback)</td>
    <td style="padding:15px">Removes the specified user from the specified group.   Calling this action requires developer crede</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminResetUserPassword(body, iapMetadata, callback)</td>
    <td style="padding:15px">Resets the specified user's password in a user pool as an administrator. Works on any user.   When</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminRespondToAuthChallenge(body, iapMetadata, callback)</td>
    <td style="padding:15px">Responds to an authentication challenge, as an administrator.     This action might generate an SMS</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminSetUserMFAPreference(body, iapMetadata, callback)</td>
    <td style="padding:15px">The user's multi-factor authentication (MFA) preference, including which MFA options are activated,</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminSetUserPassword(body, iapMetadata, callback)</td>
    <td style="padding:15px">Sets the specified user's password in a user pool as an administrator. Works on any user.    The pa</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminSetUserSettings(body, iapMetadata, callback)</td>
    <td style="padding:15px">This action is no longer supported.  You can use it to configure only SMS MFA. You can't use it to</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminUpdateAuthEventFeedback(body, iapMetadata, callback)</td>
    <td style="padding:15px">Provides feedback for an authentication event indicating if it was from a valid user. This feedback</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminUpdateDeviceStatus(body, iapMetadata, callback)</td>
    <td style="padding:15px">Updates the device status as an administrator.   Calling this action requires developer credentials.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminUpdateUserAttributes(body, iapMetadata, callback)</td>
    <td style="padding:15px">Updates the specified user's attributes, including developer attributes, as an administrator. Works</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">adminUserGlobalSignOut(body, iapMetadata, callback)</td>
    <td style="padding:15px">Signs out a user from all devices. You must sign  AdminUserGlobalSignOut  requests with Amazon Web</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">associateSoftwareToken(body, iapMetadata, callback)</td>
    <td style="padding:15px">Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, w</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">changePassword(body, iapMetadata, callback)</td>
    <td style="padding:15px">Changes the password for a specified user in a user pool.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">confirmDevice(body, iapMetadata, callback)</td>
    <td style="padding:15px">Confirms tracking of the device. This API call is the call that begins device tracking.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">confirmForgotPassword(body, iapMetadata, callback)</td>
    <td style="padding:15px">Allows a user to enter a confirmation code to reset a forgotten password.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">confirmSignUp(body, iapMetadata, callback)</td>
    <td style="padding:15px">Confirms registration of a new user.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">createGroup(body, iapMetadata, callback)</td>
    <td style="padding:15px">Creates a new group in the specified user pool.   Calling this action requires developer credential</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">createIdentityProvider(body, iapMetadata, callback)</td>
    <td style="padding:15px">Creates an IdP for a user pool.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">createResourceServer(body, iapMetadata, callback)</td>
    <td style="padding:15px">Creates a new OAuth2.0 resource server and defines custom scopes within it.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">createUserImportJob(body, iapMetadata, callback)</td>
    <td style="padding:15px">Creates the user import job.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">createUserPool(body, iapMetadata, callback)</td>
    <td style="padding:15px">Creates a new Amazon Cognito user pool and sets the password policy for the pool.     This action m</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">createUserPoolClient(body, iapMetadata, callback)</td>
    <td style="padding:15px">Creates the user pool client.   When you create a new user pool client, token revocation is automat</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">createUserPoolDomain(body, iapMetadata, callback)</td>
    <td style="padding:15px">Creates a new domain for a user pool.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">deleteGroup(body, iapMetadata, callback)</td>
    <td style="padding:15px">Deletes a group.   Calling this action requires developer credentials.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">deleteIdentityProvider(body, iapMetadata, callback)</td>
    <td style="padding:15px">Deletes an IdP for a user pool.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">deleteResourceServer(body, iapMetadata, callback)</td>
    <td style="padding:15px">Deletes a resource server.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">deleteUser(body, iapMetadata, callback)</td>
    <td style="padding:15px">Allows a user to delete himself or herself.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">deleteUserAttributes(body, iapMetadata, callback)</td>
    <td style="padding:15px">Deletes the attributes for a user.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">deleteUserPool(body, iapMetadata, callback)</td>
    <td style="padding:15px">Deletes the specified Amazon Cognito user pool.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">deleteUserPoolClient(body, iapMetadata, callback)</td>
    <td style="padding:15px">Allows the developer to delete the user pool client.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">deleteUserPoolDomain(body, iapMetadata, callback)</td>
    <td style="padding:15px">Deletes a domain for a user pool.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">describeIdentityProvider(body, iapMetadata, callback)</td>
    <td style="padding:15px">Gets information about a specific IdP.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">describeResourceServer(body, iapMetadata, callback)</td>
    <td style="padding:15px">Describes a resource server.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">describeRiskConfiguration(body, iapMetadata, callback)</td>
    <td style="padding:15px">Describes the risk configuration.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">describeUserImportJob(body, iapMetadata, callback)</td>
    <td style="padding:15px">Describes the user import job.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">describeUserPool(body, iapMetadata, callback)</td>
    <td style="padding:15px">Returns the configuration information and metadata of the specified user pool.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">describeUserPoolClient(body, iapMetadata, callback)</td>
    <td style="padding:15px">Client method for returning the configuration information and metadata of the specified user pool a</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">describeUserPoolDomain(body, iapMetadata, callback)</td>
    <td style="padding:15px">Gets information about a domain.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">forgetDevice(body, iapMetadata, callback)</td>
    <td style="padding:15px">Forgets the specified device.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">forgotPassword(body, iapMetadata, callback)</td>
    <td style="padding:15px">Calling this API causes a message to be sent to the end user with a confirmation code that is requi</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">getCSVHeader(body, iapMetadata, callback)</td>
    <td style="padding:15px">Gets the header information for the comma-separated value (CSV) file to be used as input for the us</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">getCognitoDevice(body, iapMetadata, callback)</td>
    <td style="padding:15px">Gets the device.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">getGroup(body, iapMetadata, callback)</td>
    <td style="padding:15px">Gets a group.   Calling this action requires developer credentials.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">getIdentityProviderByIdentifier(body, iapMetadata, callback)</td>
    <td style="padding:15px">Gets the specified IdP.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">getSigningCertificate(body, iapMetadata, callback)</td>
    <td style="padding:15px">This method takes a user pool ID, and returns the signing certificate. The issued certificate is va</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">getUICustomization(body, iapMetadata, callback)</td>
    <td style="padding:15px">Gets the user interface (UI) Customization information for a particular app client's app UI, if any</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">getUser(body, iapMetadata, callback)</td>
    <td style="padding:15px">Gets the user attributes and metadata for a user.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">getUserAttributeVerificationCode(body, iapMetadata, callback)</td>
    <td style="padding:15px">Generates a user attribute verification code for the specified attribute name. Sends a message to a</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">getUserPoolMfaConfig(body, iapMetadata, callback)</td>
    <td style="padding:15px">Gets the user pool multi-factor authentication (MFA) configuration.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">globalSignOut(body, iapMetadata, callback)</td>
    <td style="padding:15px">Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito has is</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">initiateAuth(body, iapMetadata, callback)</td>
    <td style="padding:15px">Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user with a</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">listDevices(body, iapMetadata, callback)</td>
    <td style="padding:15px">Lists the sign-in devices that Amazon Cognito has registered to the current user.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">listGroups(limit, nextToken, body, iapMetadata, callback)</td>
    <td style="padding:15px">Lists the groups associated with a user pool.   Calling this action requires developer credentials.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">listIdentityProviders(maxResults, nextToken, body, iapMetadata, callback)</td>
    <td style="padding:15px">Lists information about all IdPs for a user pool.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">listResourceServers(maxResults, nextToken, body, iapMetadata, callback)</td>
    <td style="padding:15px">Lists the resource servers for a user pool.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">listTagsForResource(body, iapMetadata, callback)</td>
    <td style="padding:15px">Lists the tags that are assigned to an Amazon Cognito user pool.   A tag is a label that you can ap</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">listUserImportJobs(body, iapMetadata, callback)</td>
    <td style="padding:15px">Lists the user import jobs.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">listUserPoolClients(maxResults, nextToken, body, iapMetadata, callback)</td>
    <td style="padding:15px">Lists the clients that have been created for the specified user pool.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">listUserPools(maxResults, nextToken, body, iapMetadata, callback)</td>
    <td style="padding:15px">Lists the user pools associated with an Amazon Web Services account.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">listUsers(limit, paginationToken, body, iapMetadata, callback)</td>
    <td style="padding:15px">Lists the users in the Amazon Cognito user pool.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">listUsersInGroup(limit, nextToken, body, iapMetadata, callback)</td>
    <td style="padding:15px">Lists the users in the specified group.   Calling this action requires developer credentials.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">resendConfirmationCode(body, iapMetadata, callback)</td>
    <td style="padding:15px">Resends the confirmation (for confirmation of registration) to a specific user in the user pool.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">respondToAuthChallenge(body, iapMetadata, callback)</td>
    <td style="padding:15px">Responds to the authentication challenge.     This action might generate an SMS text message. Start</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">revokeToken(body, iapMetadata, callback)</td>
    <td style="padding:15px">Revokes all of the access tokens generated by, and at the same time as, the specified refresh token</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">setRiskConfiguration(body, iapMetadata, callback)</td>
    <td style="padding:15px">Configures actions on detected risks. To delete the risk configuration for  UserPoolId  or  ClientI</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">setUICustomization(body, iapMetadata, callback)</td>
    <td style="padding:15px">Sets the user interface (UI) customization information for a user pool's built-in app UI.   You can</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">setUserMFAPreference(body, iapMetadata, callback)</td>
    <td style="padding:15px">Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">setUserPoolMfaConfig(body, iapMetadata, callback)</td>
    <td style="padding:15px">Sets the user pool multi-factor authentication (MFA) configuration.     This action might generate</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">setUserSettings(body, iapMetadata, callback)</td>
    <td style="padding:15px">This action is no longer supported.  You can use it to configure only SMS MFA. You can't use it to</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">signUp(body, iapMetadata, callback)</td>
    <td style="padding:15px">Registers the user in the specified user pool and creates a user name, password, and user attribute</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">startUserImportJob(body, iapMetadata, callback)</td>
    <td style="padding:15px">Starts the user import.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">stopUserImportJob(body, iapMetadata, callback)</td>
    <td style="padding:15px">Stops the user import job.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">tagResource(body, iapMetadata, callback)</td>
    <td style="padding:15px">Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categori</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">untagResource(body, iapMetadata, callback)</td>
    <td style="padding:15px">Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">updateAuthEventFeedback(body, iapMetadata, callback)</td>
    <td style="padding:15px">Provides the feedback for an authentication event, whether it was from a valid user or not. This fe</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">updateDeviceStatus(body, iapMetadata, callback)</td>
    <td style="padding:15px">Updates the device status.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">updateGroup(body, iapMetadata, callback)</td>
    <td style="padding:15px">Updates the specified group with the specified attributes.   Calling this action requires developer</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">updateIdentityProvider(body, iapMetadata, callback)</td>
    <td style="padding:15px">Updates IdP information for a user pool.</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">updateResourceServer(body, iapMetadata, callback)</td>
    <td style="padding:15px">Updates the name and scopes of resource server. All other fields are read-only.     If you don't pr</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">updateUserAttributes(body, iapMetadata, callback)</td>
    <td style="padding:15px">Allows a user to update a specific attribute (one at a time).     This action might generate an SMS</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">updateUserPool(body, iapMetadata, callback)</td>
    <td style="padding:15px">Updates the specified user pool with the specified attributes. You can get a list of the current us</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">updateUserPoolClient(body, iapMetadata, callback)</td>
    <td style="padding:15px">Updates the specified user pool app client with the specified attributes. You can get a list of the</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">updateUserPoolDomain(body, iapMetadata, callback)</td>
    <td style="padding:15px">Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.   You</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">verifySoftwareToken(body, iapMetadata, callback)</td>
    <td style="padding:15px">Use this API to register a user's entered time-based one-time password (TOTP) code and mark the use</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
  <tr>
    <td style="padding:15px">verifyUserAttribute(body, iapMetadata, callback)</td>
    <td style="padding:15px">Verifies the specified user attributes in the user pool.    If your user pool requires verification</td>
    <td style="padding:15px">{base_path}/{version}/?{query}</td>
    <td style="padding:15px">Yes</td>
  </tr>
</table>
<br>