ICognitoIdentityProviderUpdateIdentityProviderRequest
Interface in AWS.CognitoIdentityProvider
Interface for UpdateIdentityProvider requests.
Ancestors
Properties
AttributeMapping
property AttributeMapping: TDictionary<string, string>
Specify a mapping of Identity Provider (IdP) attributes to standard and custom user pool attributes.
IdpIdentifiers
property IdpIdentifiers: TList<string>
Specify a list of Identity Provider (IdP) identifiers.
ProviderDetails
property ProviderDetails: TDictionary<string, string>
Specify the Identity Provider (IdP) details.
The required details depends on the Identity Provider (IdP) type. - For Google and Login with Amazon: - client_id - client_secret - authorize_scopes - For Facebook: - client_id - client_secret - authorize_scopes - api_version - For Sign in with Apple: - client_id - team_id - key_id - private_key - authorize_scopes - For OpenID Connect (OIDC) providers: - client_id - client_secret - attributes_request_method - oidc_issuer - authorize_scopes - The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL. - authorize_url - token_url - attributes_url - jwks_uri - Amazon Cognito sets the value of the following keys automatically. They are read-only. - attributes_url_add_attributes - For SAML providers: - MetadataFile or MetadataURL - IDPSignout optional
ProviderName
property ProviderName: string
Specify the name of the Identity Provider (IdP).
UserPoolId
property UserPoolId: string
Specify the ID of the user pool.
Methods
AddAttributeMapping
procedure AddAttributeMapping(const AKey, AValue: string);
Add a key-value pair to AttributeMapping.
Parameters
| Name | Description |
|---|---|
AKey | Specify a attribute to map from. |
AValue | Specify an attribute to map to. |
AddIdpIdentifier
function AddIdpIdentifier(const AIdpIdentifier: string): Integer;
Add an Identity Provider (IdP) identifier to IdpIdentifiers.
Parameters
| Name | Description |
|---|---|
AIdpIdentifier | Specify an Identity Provider (IdP) identifier. |
Returns
Returns the index of the added identifier.
AddProviderDetail
procedure AddProviderDetail(const AKey, AValue: string);
Add a key-value pair to ProviderDetails.
Parameters
| Name | Description |
|---|---|
AKey | Specify a provider detail key. |
AValue | Specify a provider detail value. |