UpdateIdentityProvider
Updates identity provider information for a user pool.
Request Syntax
{ "AttributeMapping": { "
string
" : "string
" }, "IdpIdentifiers": [ "string
" ], "ProviderDetails": { "string
" : "string
" }, "ProviderName": "string
", "UserPoolId": "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.
- AttributeMapping
-
The identity provider attribute mapping to be changed.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 32.
Required: No
- IdpIdentifiers
-
A list of identity provider identifiers.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 40.
Pattern:
[\w\s+=.@-]+
Required: No
- ProviderDetails
-
The identity provider details to be updated, such as
MetadataURL
andMetadataFile
.Type: String to string map
Required: No
- ProviderName
-
The identity provider name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Required: Yes
- UserPoolId
-
The user pool ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+
Required: Yes
Response Syntax
{ "IdentityProvider": { "AttributeMapping": { "string" : "string" }, "CreationDate": number, "IdpIdentifiers": [ "string" ], "LastModifiedDate": number, "ProviderDetails": { "string" : "string" }, "ProviderName": "string", "ProviderType": "string", "UserPoolId": "string" } }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- IdentityProvider
-
The identity provider object.
Type: IdentityProviderType object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user is not authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service cannot find the requested resource.
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
- UnsupportedIdentityProviderException
-
This exception is thrown when the specified identifier is not supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: