ProviderDescription
The details of a user pool identity provider (IdP), including name and type.
This data type is a response parameter of ListIdentityProviders.
Contents
- CreationDate
-
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Date
object.Type: Timestamp
Required: No
- LastModifiedDate
-
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Date
object.Type: Timestamp
Required: No
- ProviderName
-
The name of the IdP, for example
MySAMLProvider
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\p{Z}]+
Required: No
- ProviderType
-
The type of the provider, for example
SAML
. Amazon Cognito supports SAML 2.0, OIDC, and social IdPs. User pools list supported social IdPs by name in this response parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.Type: String
Valid Values:
SAML | Facebook | Google | LoginWithAmazon | SignInWithApple | OIDC
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: