AWSCognitoIdentityProviderIdentityProviderType

Objective-C

@interface AWSCognitoIdentityProviderIdentityProviderType

Swift

class AWSCognitoIdentityProviderIdentityProviderType

A container for information about an IdP.

  • A mapping of IdP attributes to standard and custom user pool attributes.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable attributeMapping;

    Swift

    var attributeMapping: [String : String]? { get set }

  • The date and time, in ISO 8601 format, when the item was created.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable creationDate;

    Swift

    var creationDate: Date? { get set }

  • A list of IdP identifiers.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable idpIdentifiers;

    Swift

    var idpIdentifiers: [String]? { get set }

  • The date and time, in ISO 8601 format, when the item was modified.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable lastModifiedDate;

    Swift

    var lastModifiedDate: Date? { get set }

  • The IdP details. The following list describes the provider detail keys for each 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

        You can submit a private_key when you add or update an IdP. Describe operations don’t return the private key.

      • authorize_scopes

    • For 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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable providerDetails;

    Swift

    var providerDetails: [String : String]? { get set }

  • The IdP name.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable providerName;

    Swift

    var providerName: String? { get set }

  • The IdP type.

    Declaration

    Objective-C

    @property (nonatomic) AWSCognitoIdentityProviderIdentityProviderTypeType providerType;

    Swift

    var providerType: AWSCognitoIdentityProviderIdentityProviderTypeType { get set }

  • The user pool ID.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable userPoolId;

    Swift

    var userPoolId: String? { get set }