UnlinkDeveloperIdentity
Unlinks a DeveloperUserIdentifier
from an existing identity. Unlinked
developer users will be considered new identities next time they are seen. If, for a given
Cognito identity, you remove all federated identities as well as the developer user
identifier, the Cognito identity becomes inaccessible.
You must use AWS developer credentials to call this operation.
Request Syntax
{
"DeveloperProviderName": "string
",
"DeveloperUserIdentifier": "string
",
"IdentityId": "string
",
"IdentityPoolId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- DeveloperProviderName
-
The "domain" by which Cognito will refer to your users.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w._-]+
Required: Yes
- DeveloperUserIdentifier
-
A unique ID used by your backend authentication process to identify a user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
- IdentityId
-
A unique identifier in the format REGION:GUID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+:[0-9a-f-]+
Required: Yes
- IdentityPoolId
-
An identity pool ID in the format REGION:GUID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+:[0-9a-f-]+
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
Thrown when the service encounters an error during processing the request.
HTTP Status Code: 500
- InvalidParameterException
-
Thrown for missing or bad input parameter(s).
HTTP Status Code: 400
- NotAuthorizedException
-
Thrown when a user is not authorized to access the requested resource.
HTTP Status Code: 400
- ResourceConflictException
-
Thrown when a user tries to use a login which is already linked to another account.
HTTP Status Code: 400
- ResourceNotFoundException
-
Thrown when the requested resource (for example, a dataset or record) does not exist.
HTTP Status Code: 400
- TooManyRequestsException
-
Thrown when a request is throttled.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: