Amazon Cognito Identity Provider
With the Amazon Cognito user pools API, you can configure user pools and authenticate users. To authenticate users from third-party identity providers (IdPs)…
Identity & security#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
With the Amazon Cognito user pools API, you can configure user pools and authenticate users. To
authenticate users from third-party identity providers (IdPs) in this API, you can
link IdP users to native user profiles . Learn more
about the authentication and authorization of federated users at Adding user pool sign-in through a third party and in the User pool federation endpoints and managed login reference .
This API reference provides detailed information about API operations and object types
in Amazon Cognito.
Along with resource management operations, the Amazon Cognito user pools API includes classes
of operations and authorization models for client-side and server-side authentication of
users. You can interact with operations in the Amazon Cognito user pools API as any of the
following subjects.
An administrator who wants to configure user pools, app clients, users,
groups, or other user pool functions.
A server-side app, like a web application, that wants to use its Amazon Web Services
privileges to manage, authenticate, or authorize a user.
A client-side app, like a mobile app, that wants to make unauthenticated
requests to manage, authenticate, or authorize a user.
For more information, see Understanding API, OIDC, and managed login pages
authentication in the Amazon Cognito Developer Guide .
With your Amazon Web Services SDK, you can build the logic to support operational flows in every use
case for this API. You can also make direct REST API requests to Amazon Cognito user pools service endpoints . The following links can get you started
with the CognitoIdentityProvider client in supported Amazon Web Services SDKs.
To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services . For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services
SDKs .
Endpoints 141
- POSTAdd custom attributes
/#X-Amz-Target=AWSCognitoIdentityProviderService.AddCustomAttributesAdds additional user attributes to the user pool schema. Custom attributes can be mutable or immutable and have a custom: or dev: prefix. For more… - POSTAdd user pool client secret
/#X-Amz-Target=AWSCognitoIdentityProviderService.AddUserPoolClientSecretCreates a new client secret for an existing confidential user pool app client. Supports up to 2 active secrets per app client for zero-downtime credential… - POSTAdmin add user to group
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminAddUserToGroupAdds a user to a group. A user who is in a group can present a preferred-role claim to an identity pool, and populates a cognito:groups claim to their access… - POSTAdmin confirm sign up
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminConfirmSignUpConfirms user sign-up as an administrator. This request sets a user account active in a user pool that requires confirmation of new user accounts before they… - POSTAdmin create user
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminCreateUserCreates a new user in the specified user pool. If MessageAction isn't set, the default is to send a welcome message via email or phone (SMS). This message is… - POSTAdmin delete software token
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminDeleteSoftwareTokenDeletes a user's registered time-based one-time password (TOTP) multi-factor authentication (MFA) factor, also known as a software token. After this… - POSTAdmin delete user
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminDeleteUserDeletes a user profile in your user pool. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this… - POSTAdmin delete user attributes
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminDeleteUserAttributesDeletes attribute values from a user. This operation doesn't affect tokens for existing user sessions. The next ID token that the user receives will no longer… - POSTAdmin disable provider for user
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminDisableProviderForUserPrevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the user that you want to deactivate is a Amazon… - POSTAdmin disable user
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminDisableUserDeactivates a user profile and revokes all access tokens for the user. A deactivated user can't sign in, but still appears in the responses to ListUsers API… - POSTAdmin enable user
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminEnableUserActivates sign-in for a user profile that previously had sign-in access disabled. Amazon Cognito evaluates Identity and Access Management (IAM) policies in… - POSTAdmin forget device
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminForgetDeviceForgets, or deletes, a remembered device from a user's profile. After you forget the device, the user can no longer complete device authentication with that… - POSTAdmin get device
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminGetDeviceGiven the device key, returns details for a user's device. For more information, see Working with devices . Amazon Cognito evaluates Identity and Access… - POSTAdmin get user
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminGetUserGiven a username, returns details about a user profile in a user pool. You can specify alias attributes in the Username request parameter. This operation… - POSTAdmin get user auth factors
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminGetUserAuthFactorsLists the authentication options for a user in a user pool. Returns the following: The user's multi-factor authentication (MFA) preferences. The user's… - POSTAdmin initiate auth
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminInitiateAuthStarts sign-in for applications with a server-side component, for example a traditional web application. This operation specifies the authentication flow that… - POSTAdmin link provider for user
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminLinkProviderForUserLinks an existing user account in a user pool, or DestinationUser , to an identity from an external IdP, or SourceUser , based on a specified attribute name… - POSTAdmin list devices
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminListDevicesLists a user's registered devices. Remembered devices are used in authentication services where you offer a "Remember me" option for users who you want to… - POSTAdmin list groups for user
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminListGroupsForUserLists the groups that a user belongs to. User pool groups are identifiers that you can reference from the contents of ID and access tokens, and set preferred… - POSTAdmin list user auth events
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminListUserAuthEventsRequests a history of user activity and any risks detected as part of Amazon Cognito threat protection. For more information, see Viewing user event history .… - POSTAdmin list user sessions
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminListUserSessionsLists the active sessions for a specified user as an administrator. The response includes both token sessions and SSO sessions. Only active sessions are… - POSTAdmin remove user from group
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminRemoveUserFromGroupGiven a username and a group name, removes them from the group. User pool groups are identifiers that you can reference from the contents of ID and access… - POSTAdmin reset user password
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminResetUserPasswordBegins the password reset process. Sets the requested user’s account into a RESET_REQUIRED status, and sends them a password-reset code. Your user pool also… - POSTAdmin respond to auth challenge
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminRespondToAuthChallengeSome API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom… - POSTAdmin revoke user session
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminRevokeUserSessionRevokes a specific user session as an administrator. Amazon Cognito revokes all refresh and access tokens that are associated with the session and deletes the… - POSTAdmin set user mFA preference
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminSetUserMFAPreferenceSets the user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set… - POSTAdmin set user password
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminSetUserPasswordSets the specified user's password in a user pool. This operation administratively sets a temporary or permanent password for a user. With this operation, you… - POSTAdmin set user settings
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminSetUserSettingsThis action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token… - POSTAdmin update auth event feedback
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminUpdateAuthEventFeedbackProvides the feedback for an authentication event generated by threat protection features. Your response indicates that you think that the event either was… - POSTAdmin update device status
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminUpdateDeviceStatusUpdates the status of a user's device so that it is marked as remembered or not remembered for the purpose of device authentication. Device authentication is… - POSTAdmin update user attributes
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminUpdateUserAttributesUpdates the specified user's attributes. To delete an attribute from your user, submit the attribute in your API request with a blank value. For custom… - POSTAdmin user global sign out
/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminUserGlobalSignOutInvalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation with your administrative credentials when your… - POSTAssociate software token
/#X-Amz-Target=AWSCognitoIdentityProviderService.AssociateSoftwareTokenBegins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and… - POSTChange password
/#X-Amz-Target=AWSCognitoIdentityProviderService.ChangePasswordChanges the password for the currently signed-in user. Authorize this action with a signed-in user's access token. It must include the scope… - POSTComplete web authn registration
/#X-Amz-Target=AWSCognitoIdentityProviderService.CompleteWebAuthnRegistrationCompletes registration of a passkey authenticator for the currently signed-in user. Authorize this action with a signed-in user's access token. It must… - POSTConfirm device
/#X-Amz-Target=AWSCognitoIdentityProviderService.ConfirmDeviceConfirms a device that a user wants to remember. A remembered device is a "Remember me on this device" option for user pools that perform authentication with… - POSTConfirm forgot password
/#X-Amz-Target=AWSCognitoIdentityProviderService.ConfirmForgotPasswordThis public API operation accepts a confirmation code that Amazon Cognito sent to a user and accepts a new password for that user. Amazon Cognito doesn't… - POSTConfirm sign up
/#X-Amz-Target=AWSCognitoIdentityProviderService.ConfirmSignUpConfirms the account of a new user. This public API operation submits a code that Amazon Cognito sent to your user when they signed up in your user pool.… - POSTCreate group
/#X-Amz-Target=AWSCognitoIdentityProviderService.CreateGroupCreates a new group in the specified user pool. For more information about user pool groups, see Adding groups to a user pool . Amazon Cognito evaluates… - POSTCreate identity provider
/#X-Amz-Target=AWSCognitoIdentityProviderService.CreateIdentityProviderAdds a configuration and trust relationship between a third-party identity provider (IdP) and a user pool. Amazon Cognito accepts sign-in with third-party… - POSTCreate managed login branding
/#X-Amz-Target=AWSCognitoIdentityProviderService.CreateManagedLoginBrandingCreates a new set of branding settings for a user pool style and associates it with an app client. This operation is the programmatic option for the creation… - POSTCreate resource server
/#X-Amz-Target=AWSCognitoIdentityProviderService.CreateResourceServerCreates a new OAuth2.0 resource server and defines custom scopes within it. Resource servers are associated with custom scopes and machine-to-machine (M2M)… - POSTCreate terms
/#X-Amz-Target=AWSCognitoIdentityProviderService.CreateTermsCreates terms documents for the requested app client. When Terms and conditions and Privacy policy documents are configured, the app client displays links to… - POSTCreate user import job
/#X-Amz-Target=AWSCognitoIdentityProviderService.CreateUserImportJobCreates a user import job. You can import users into user pools from a comma-separated values (CSV) file without adding Amazon Cognito MAU costs to your… - POSTCreate user pool
/#X-Amz-Target=AWSCognitoIdentityProviderService.CreateUserPoolCreates a new Amazon Cognito user pool. This operation sets basic and advanced configuration options. If you don't provide a value for an attribute, Amazon… - POSTCreate user pool client
/#X-Amz-Target=AWSCognitoIdentityProviderService.CreateUserPoolClientCreates an app client in a user pool. This operation sets basic and advanced configuration options. Unlike app clients created in the console, Amazon Cognito… - POSTCreate user pool domain
/#X-Amz-Target=AWSCognitoIdentityProviderService.CreateUserPoolDomainA user pool domain hosts managed login, an authorization server and web server for authentication in your application. This operation creates a new user pool… - POSTCreate user pool replica
/#X-Amz-Target=AWSCognitoIdentityProviderService.CreateUserPoolReplicaCreates a replica of an existing user pool in a specified Amazon Web Services Region. The replica enables multi-region replication for high availability and… - POSTDelete group
/#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteGroupDeletes a group from the specified user pool. When you delete a group, that group no longer contributes to users' cognito:preferred_group or cognito:groups… - POSTDelete identity provider
/#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteIdentityProviderDeletes a user pool identity provider (IdP). After you delete an IdP, users can no longer sign in to your user pool through that IdP. For more information… - POSTDelete managed login branding
/#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteManagedLoginBrandingDeletes a managed login branding style. When you delete a style, you delete the branding association for an app client. When an app client doesn't have a… - POSTDelete resource server
/#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteResourceServerDeletes a resource server. After you delete a resource server, users can no longer generate access tokens with scopes that are associate with that resource… - POSTDelete terms
/#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteTermsDeletes the terms documents with the requested ID from your app client. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for… - POSTDelete user
/#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUserDeletes the profile of the currently signed-in user. A deleted user profile can no longer be used to sign in and can't be restored. Authorize this action with… - POSTDelete user attributes
/#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUserAttributesDeletes attributes from the currently signed-in user. For example, your application can submit a request to this operation when a user wants to remove their… - POSTDelete user pool
/#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUserPoolDeletes a user pool. After you delete a user pool, users can no longer sign in to any associated applications. When you delete a user pool, it's no longer… - POSTDelete user pool client
/#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUserPoolClientDeletes a user pool app client. After you delete an app client, users can no longer sign in to the associated application. - POSTDelete user pool client secret
/#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUserPoolClientSecretDeletes a specific client secret from a user pool app client. You cannot delete the last remaining secret for an app client. - POSTDelete user pool domain
/#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUserPoolDomainGiven a user pool ID and domain identifier, deletes a user pool domain. After you delete a user pool domain, your managed login pages and authorization server… - POSTDelete user pool replica
/#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUserPoolReplicaDeletes a secondary replica user pool. You can only delete replicas that are in the INACTIVE status. This operation must be called from the primary Region.… - POSTDelete web authn credential
/#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteWebAuthnCredentialDeletes a registered passkey, or WebAuthn, authenticator for the currently signed-in user. Authorize this action with a signed-in user's access token. It must… - POSTDescribe identity provider
/#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeIdentityProviderGiven a user pool ID and identity provider (IdP) name, returns details about the IdP. - POSTDescribe managed login branding
/#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeManagedLoginBrandingGiven the ID of a managed login branding style, returns detailed information about the style. - POSTDescribe managed login branding by client
/#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeManagedLoginBrandingByClientGiven the ID of a user pool app client, returns detailed information about the style assigned to the app client. - POSTDescribe resource server
/#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeResourceServerDescribes a resource server. For more information about resource servers, see Access control with resource servers . - POSTDescribe risk configuration
/#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeRiskConfigurationGiven an app client or user pool ID where threat protection is configured, describes the risk configuration. This operation returns details about adaptive… - POSTDescribe terms
/#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeTermsReturns details for the requested terms documents ID. For more information, see Terms documents . Amazon Cognito evaluates Identity and Access Management… - POSTDescribe terms by client
/#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeTermsByClientReturns details for the terms documents that are associated with an app client, identified by the app client ID, user pool ID, and terms name. For more… - POSTDescribe user import job
/#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeUserImportJobDescribes a user import job. For more information about user CSV import, see Importing users from a CSV file . - POSTDescribe user pool
/#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeUserPoolGiven a user pool ID, returns configuration information. This operation is useful when you want to inspect an existing user pool and programmatically… - POSTDescribe user pool client
/#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeUserPoolClientGiven an app client ID, returns configuration information. This operation is useful when you want to inspect an existing app client and programmatically… - POSTDescribe user pool domain
/#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeUserPoolDomainGiven a user pool domain name, returns information about the domain configuration. This operation doesn't return results when you query a prefix domain in a… - POSTForget device
/#X-Amz-Target=AWSCognitoIdentityProviderService.ForgetDeviceGiven a device key, deletes a remembered device as the currently signed-in user. For more information about device authentication, see Working with user… - POSTForgot password
/#X-Amz-Target=AWSCognitoIdentityProviderService.ForgotPasswordSends a password-reset confirmation code to the email address or phone number of the requested username. The message delivery method is determined by the… - POSTGet cSV header
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetCSVHeaderGiven a user pool ID, generates a comma-separated value (CSV) list populated with available user attributes in the user pool. This list is the header for the… - POSTGet client token
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetClientTokenIssues an access token for machine-to-machine (M2M) authorization. Your app client provides its client ID and secret, and receives an access token that… - POSTGet derived token
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetDerivedTokenExchanges an existing token for a new token that is scoped and audience-bound for a specific downstream service, following the OAuth 2.0 Token Exchange grant… - POSTGet device
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetDeviceGiven a device key, returns information about a remembered device for the current user. For more information about device authentication, see Working with… - POSTGet group
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetGroupGiven a user pool ID and a group name, returns information about the user group. For more information about user pool groups, see Adding groups to a user pool… - POSTGet identity provider by identifier
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetIdentityProviderByIdentifierGiven the identifier of an identity provider (IdP), for example examplecorp , returns information about the user pool configuration for that IdP. For more… - POSTGet log delivery configuration
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetLogDeliveryConfigurationGiven a user pool ID, returns the logging configuration. User pools can export message-delivery error and threat-protection activity logs to external Amazon… - POSTGet provisioned limit
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetProvisionedLimitReturns the current provisioned limit for a specific API category. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this… - POSTGet signing certificate
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetSigningCertificateGiven a user pool ID, returns the signing certificate for SAML 2.0 federation. Issued certificates are valid for 10 years from the date of issue. Amazon… - POSTGet tokens from refresh token
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetTokensFromRefreshTokenGiven a refresh token, issues new ID, access, and optionally refresh tokens for the user who owns the submitted token. This operation issues a new refresh… - POSTGet uI customization
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetUICustomizationGiven a user pool ID or app client, returns information about classic hosted UI branding that you applied, if any. Returns user-pool level branding… - POSTGet user
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetUserGets user attributes and and MFA settings for the currently signed-in user. Authorize this action with a signed-in user's access token. It must include the… - POSTGet user attribute verification code
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetUserAttributeVerificationCodeGiven an attribute name, sends a user attribute verification code for the specified attribute name to the currently signed-in user. Authorize this action with… - POSTGet user auth factors
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetUserAuthFactorsLists the authentication options for the currently signed-in user. Returns the following: The user's multi-factor authentication (MFA) preferences. The user's… - POSTGet user pool client session configuration
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetUserPoolClientSessionConfigurationRetrieves the session configuration for a user pool app client. If you have never called SetUserPoolClientSessionConfiguration for the app client, this… - POSTGet user pool mfa config
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetUserPoolMfaConfigGiven a user pool ID, returns configuration for sign-in with WebAuthn authenticators and for multi-factor authentication (MFA). This operation describes the… - POSTGet user pool session configuration
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetUserPoolSessionConfigurationRetrieves the session tracking configuration for a user pool, including whether session tracking is enabled and the pool-wide maximum number of active token… - POSTGlobal sign out
/#X-Amz-Target=AWSCognitoIdentityProviderService.GlobalSignOutInvalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation when your user signs out of your app. This… - POSTInitiate auth
/#X-Amz-Target=AWSCognitoIdentityProviderService.InitiateAuthDeclares an authentication flow and initiates sign-in for a user in the Amazon Cognito user directory. Amazon Cognito might respond with an additional… - POSTList devices
/#X-Amz-Target=AWSCognitoIdentityProviderService.ListDevicesLists the devices that Amazon Cognito has registered to the currently signed-in user. For more information about device authentication, see Working with user… - POSTList groups
/#X-Amz-Target=AWSCognitoIdentityProviderService.ListGroupsGiven a user pool ID, returns user pool groups and their details. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this… - POSTList identity providers
/#X-Amz-Target=AWSCognitoIdentityProviderService.ListIdentityProvidersGiven a user pool ID, returns information about configured identity providers (IdPs). For more information about IdPs, see Third-party IdP sign-in . Amazon… - POSTList resource servers
/#X-Amz-Target=AWSCognitoIdentityProviderService.ListResourceServersGiven a user pool ID, returns all resource servers and their details. For more information about resource servers, see Access control with resource servers .… - POSTList tags for resource
/#X-Amz-Target=AWSCognitoIdentityProviderService.ListTagsForResourceLists the tags that are assigned to an Amazon Cognito user pool. For more information, see Tagging resources . - POSTList terms
/#X-Amz-Target=AWSCognitoIdentityProviderService.ListTermsReturns details about all terms documents for the requested user pool. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for… - POSTList user import jobs
/#X-Amz-Target=AWSCognitoIdentityProviderService.ListUserImportJobsGiven a user pool ID, returns user import jobs and their details. Import jobs are retained in user pool configuration so that you can stage, stop, start,… - POSTList user pool client secrets
/#X-Amz-Target=AWSCognitoIdentityProviderService.ListUserPoolClientSecretsLists all client secrets associated with a user pool app client. Returns metadata about the secrets. The response does not include pagination tokens as there… - POSTList user pool clients
/#X-Amz-Target=AWSCognitoIdentityProviderService.ListUserPoolClientsGiven a user pool ID, lists app clients. App clients are sets of rules for the access that you want a user pool to grant to one application. For more… - POSTList user pool replicas
/#X-Amz-Target=AWSCognitoIdentityProviderService.ListUserPoolReplicasLists all replicas for a user pool, including both primary and secondary replicas. We recommend using pagination to ensure that the operation returns quickly… - POSTList user pools
/#X-Amz-Target=AWSCognitoIdentityProviderService.ListUserPoolsLists user pools and their details in the current Amazon Web Services account. Amazon Cognito evaluates Identity and Access Management (IAM) policies in… - POSTList user sessions
/#X-Amz-Target=AWSCognitoIdentityProviderService.ListUserSessionsLists the active sessions for the currently signed-in user. Amazon Cognito authorizes this operation with the user's access token and returns all of the… - POSTList users
/#X-Amz-Target=AWSCognitoIdentityProviderService.ListUsersGiven a user pool ID, returns a list of users and their basic details in a user pool. This operation is eventually consistent. You might experience a delay… - POSTList users in group
/#X-Amz-Target=AWSCognitoIdentityProviderService.ListUsersInGroupGiven a user pool ID and a group name, returns a list of users in the group. For more information about user pool groups, see Adding groups to a user pool .… - POSTList web authn credentials
/#X-Amz-Target=AWSCognitoIdentityProviderService.ListWebAuthnCredentialsGenerates a list of the currently signed-in user's registered passkey, or WebAuthn, credentials. Authorize this action with a signed-in user's access token.… - POSTResend confirmation code
/#X-Amz-Target=AWSCognitoIdentityProviderService.ResendConfirmationCodeResends the code that confirms a new account for a user who has signed up in your user pool. Amazon Cognito sends confirmation codes to the user attribute in… - POSTRespond to auth challenge
/#X-Amz-Target=AWSCognitoIdentityProviderService.RespondToAuthChallengeSome API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom… - POSTRevoke token
/#X-Amz-Target=AWSCognitoIdentityProviderService.RevokeTokenRevokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a token is revoked, you can't use the revoked token… - POSTRevoke user session
/#X-Amz-Target=AWSCognitoIdentityProviderService.RevokeUserSessionRevokes a specific session for the currently signed-in user. Amazon Cognito authorizes this operation with the user's access token, revokes all refresh and… - POSTSet log delivery configuration
/#X-Amz-Target=AWSCognitoIdentityProviderService.SetLogDeliveryConfigurationSets up or modifies the logging configuration of a user pool. User pools can export user notification logs and, when threat protection is active,… - POSTSet risk configuration
/#X-Amz-Target=AWSCognitoIdentityProviderService.SetRiskConfigurationConfigures threat protection for a user pool or app client. Sets configuration for the following. Responses to risks with adaptive authentication Responses to… - POSTSet uI customization
/#X-Amz-Target=AWSCognitoIdentityProviderService.SetUICustomizationConfigures UI branding settings for domains with the hosted UI (classic) branding version. Your user pool must have a domain. Configure a domain with . Set… - POSTSet user mFA preference
/#X-Amz-Target=AWSCognitoIdentityProviderService.SetUserMFAPreferenceSet the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred. Only one factor can be… - POSTSet user pool client session configuration
/#X-Amz-Target=AWSCognitoIdentityProviderService.SetUserPoolClientSessionConfigurationSets the session configuration for a user pool app client. The configurable client-level setting is the maximum validity period for silent reuse of an SSO… - POSTSet user pool mfa config
/#X-Amz-Target=AWSCognitoIdentityProviderService.SetUserPoolMfaConfigSets user pool multi-factor authentication (MFA) and passkey configuration. For more information about user pool MFA, see Adding MFA . For more information… - POSTSet user pool session configuration
/#X-Amz-Target=AWSCognitoIdentityProviderService.SetUserPoolSessionConfigurationEnables or disables session tracking for a user pool, and sets the pool-wide maximum number of active token sessions that each user can have. This operation… - POSTSet user settings
/#X-Amz-Target=AWSCognitoIdentityProviderService.SetUserSettingsThis action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token… - POSTSign up
/#X-Amz-Target=AWSCognitoIdentityProviderService.SignUpRegisters a user with an app client and requests a user name, password, and user attributes in the user pool. Amazon Cognito doesn't evaluate Identity and… - POSTStart user import job
/#X-Amz-Target=AWSCognitoIdentityProviderService.StartUserImportJobInstructs your user pool to start importing users from a CSV file that contains their usernames and attributes. For more information about importing users… - POSTStart web authn registration
/#X-Amz-Target=AWSCognitoIdentityProviderService.StartWebAuthnRegistrationRequests credential creation options from your user pool for the currently signed-in user. Returns information about the user pool, the user profile, and… - POSTStop user import job
/#X-Amz-Target=AWSCognitoIdentityProviderService.StopUserImportJobInstructs your user pool to stop a running job that's importing users from a CSV file that contains their usernames and attributes. For more information about… - POSTTag resource
/#X-Amz-Target=AWSCognitoIdentityProviderService.TagResourceAssigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by… - POSTUntag resource
/#X-Amz-Target=AWSCognitoIdentityProviderService.UntagResourceGiven tag IDs that you previously assigned to a user pool, removes them. - POSTUpdate auth event feedback
/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateAuthEventFeedbackProvides the feedback for an authentication event generated by threat protection features. The user's response indicates that you think that the event either… - POSTUpdate device status
/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateDeviceStatusUpdates the status of a the currently signed-in user's device so that it is marked as remembered or not remembered for the purpose of device authentication.… - POSTUpdate group
/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateGroupGiven the name of a user pool group, updates any of the properties for precedence, IAM role, or description. For more information about user pool groups, see… - POSTUpdate identity provider
/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateIdentityProviderModifies the configuration and trust relationship between a third-party identity provider (IdP) and a user pool. Amazon Cognito accepts sign-in with… - POSTUpdate managed login branding
/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateManagedLoginBrandingConfigures the branding settings for a user pool style. This operation is the programmatic option for the configuration of a style in the branding editor.… - POSTUpdate provisioned limit
/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateProvisionedLimitSets the provisioned limit for a specific API category. The value must be between the default limit and your account-level maximum limit in Service Quotas.… - POSTUpdate resource server
/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateResourceServerUpdates the name and scopes of a resource server. All other fields are read-only. For more information about resource servers, see Access control with… - POSTUpdate terms
/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateTermsModifies existing terms documents for the requested app client. When Terms and conditions and Privacy policy documents are configured, the app client displays… - POSTUpdate user attributes
/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateUserAttributesUpdates the currently signed-in user's attributes. To delete an attribute from the user, submit the attribute in your API request with a blank value. For… - POSTUpdate user pool
/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateUserPoolUpdates the configuration of a user pool. To avoid setting parameters to Amazon Cognito defaults, construct this API request to pass the existing… - POSTUpdate user pool client
/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateUserPoolClientGiven a user pool app client ID, updates the configuration. To avoid setting parameters to Amazon Cognito defaults, construct this API request to pass the… - POSTUpdate user pool domain
/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateUserPoolDomainA user pool domain hosts managed login, an authorization server and web server for authentication in your application. This operation updates the branding… - POSTUpdate user pool replica
/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateUserPoolReplicaUpdates replica-specific settings for a user pool replica. You can modify the status to activate or deactivate the replica. This request can be made in both… - POSTVerify software token
/#X-Amz-Target=AWSCognitoIdentityProviderService.VerifySoftwareTokenRegisters the current user's time-based one-time password (TOTP) authenticator with a code generated in their authenticator app from a private key that's… - POSTVerify user attribute
/#X-Amz-Target=AWSCognitoIdentityProviderService.VerifyUserAttributeSubmits a verification code for a signed-in user who has added or changed a value of an auto-verified attribute. When successful, the user's attribute becomes…
API details
- Base URL
https://cognito-idp.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 141 operations on 141 pathsPOST 141
- Description format
- AWS Smithy model, API version
2016-04-18 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Cognito Identity Provider in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Cognito Identity Provider collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Add custom attributes” (POST /#X-Amz-Target=AWSCognitoIdentityProviderService.AddCustomAttributes), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Cognito Identity Provider?
With the Amazon Cognito user pools API, you can configure user pools and authenticate users. To authenticate users from third-party identity providers (IdPs)… It is listed under Identity & security and has 141 endpoints.
Who publishes the Amazon Cognito Identity Provider?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Cognito Identity Provider?
Requests go to https://cognito-idp.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Cognito Identity Provider?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Cognito Identity Provider have?
141 operations on 141 paths (141 POST).
Is forking the Amazon Cognito Identity Provider free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.