Skip to main content

ICognitoIdentityProviderCreateIdentityProviderRequest

Interface in AWS.CognitoIdentityProvider

Interface for CreateIdentityProvider 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.

ProviderName

property ProviderName: string

Specify a name for the Identity Provider (IdP).

ProviderType

property ProviderType: string

Specify a type for the Identity Provider (IdP).

Valid values: SAML | Facebook | Google | LoginWithAmazon | SignInWithApple | OIDC.

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

NameDescription
AKeySpecify a attribute to map from.
AValueSpecify an attribute to map to.

AddIdpIdentifier

function AddIdpIdentifier(const AIdpIdentifier: string): Integer;

Add an Identity Provider (IdP) identifier to IdpIdentifiers.

Parameters

NameDescription
AIdpIdentifierSpecify 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

NameDescription
AKeySpecify a provider detail key.
AValueSpecify a provider detail value.