AWS API Changes

2019/11/25 - Amazon Cognito Identity Provider - 5 updated api methods

Changes Amazon Cognito Userpools now supports Sign in with Apple as an Identity Provider.

CreateIdentityProvider (updated)

Link ¶
Changes (request, response)
Request

{'ProviderType': {'SignInWithApple'}}

Response

{'IdentityProvider': {'ProviderType': {'SignInWithApple'}}}

Creates an identity provider for a user pool.

See also: AWS API Documentation

Request Syntax

client.create_identity_provider(
    UserPoolId='string',
    ProviderName='string',
    ProviderType='SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC',
    ProviderDetails={
        'string': 'string'
    },
    AttributeMapping={
        'string': 'string'
    },
    IdpIdentifiers=[
        'string',
    ]
)

type UserPoolId

string

param UserPoolId

[REQUIRED]

The user pool ID.

type ProviderName

string

param ProviderName

[REQUIRED]

The identity provider name.

type ProviderType

string

param ProviderType

[REQUIRED]

The identity provider type.

type ProviderDetails

dict

param ProviderDetails

[REQUIRED]

The identity provider details, such as MetadataURL and MetadataFile .

(string) --
- (string) --

type AttributeMapping

dict

param AttributeMapping

A mapping of identity provider attributes to standard and custom user pool attributes.

(string) --
- (string) --

type IdpIdentifiers

list

param IdpIdentifiers

A list of identity provider identifiers.

(string) --

rtype

dict

returns

Response Syntax

{
    'IdentityProvider': {
        'UserPoolId': 'string',
        'ProviderName': 'string',
        'ProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC',
        'ProviderDetails': {
            'string': 'string'
        },
        'AttributeMapping': {
            'string': 'string'
        },
        'IdpIdentifiers': [
            'string',
        ],
        'LastModifiedDate': datetime(2015, 1, 1),
        'CreationDate': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- IdentityProvider (dict) --
  
  The newly created identity provider object.
  - UserPoolId (string) --
    
    The user pool ID.
  - ProviderName (string) --
    
    The identity provider name.
  - ProviderType (string) --
    
    The identity provider type.
  - ProviderDetails (dict) --
    
    The identity provider details, such as MetadataURL and MetadataFile .
    - (string) --
      - (string) --
  - AttributeMapping (dict) --
    
    A mapping of identity provider attributes to standard and custom user pool attributes.
    - (string) --
      - (string) --
  - IdpIdentifiers (list) --
    
    A list of identity provider identifiers.
    - (string) --
  - LastModifiedDate (datetime) --
    
    The date the identity provider was last modified.
  - CreationDate (datetime) --
    
    The date the identity provider was created.

DescribeIdentityProvider (updated)

Link ¶
Changes (response)

{'IdentityProvider': {'ProviderType': {'SignInWithApple'}}}

Gets information about a specific identity provider.

See also: AWS API Documentation

Request Syntax

client.describe_identity_provider(
    UserPoolId='string',
    ProviderName='string'
)

type UserPoolId

string

param UserPoolId

[REQUIRED]

The user pool ID.

type ProviderName

string

param ProviderName

[REQUIRED]

The identity provider name.

rtype

dict

returns

Response Syntax

{
    'IdentityProvider': {
        'UserPoolId': 'string',
        'ProviderName': 'string',
        'ProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC',
        'ProviderDetails': {
            'string': 'string'
        },
        'AttributeMapping': {
            'string': 'string'
        },
        'IdpIdentifiers': [
            'string',
        ],
        'LastModifiedDate': datetime(2015, 1, 1),
        'CreationDate': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- IdentityProvider (dict) --
  
  The identity provider that was deleted.
  - UserPoolId (string) --
    
    The user pool ID.
  - ProviderName (string) --
    
    The identity provider name.
  - ProviderType (string) --
    
    The identity provider type.
  - ProviderDetails (dict) --
    
    The identity provider details, such as MetadataURL and MetadataFile .
    - (string) --
      - (string) --
  - AttributeMapping (dict) --
    
    A mapping of identity provider attributes to standard and custom user pool attributes.
    - (string) --
      - (string) --
  - IdpIdentifiers (list) --
    
    A list of identity provider identifiers.
    - (string) --
  - LastModifiedDate (datetime) --
    
    The date the identity provider was last modified.
  - CreationDate (datetime) --
    
    The date the identity provider was created.

GetIdentityProviderByIdentifier (updated)

Link ¶
Changes (response)

{'IdentityProvider': {'ProviderType': {'SignInWithApple'}}}

Gets the specified identity provider.

See also: AWS API Documentation

Request Syntax

client.get_identity_provider_by_identifier(
    UserPoolId='string',
    IdpIdentifier='string'
)

type UserPoolId

string

param UserPoolId

[REQUIRED]

The user pool ID.

type IdpIdentifier

string

param IdpIdentifier

[REQUIRED]

The identity provider ID.

rtype

dict

returns

Response Syntax

{
    'IdentityProvider': {
        'UserPoolId': 'string',
        'ProviderName': 'string',
        'ProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC',
        'ProviderDetails': {
            'string': 'string'
        },
        'AttributeMapping': {
            'string': 'string'
        },
        'IdpIdentifiers': [
            'string',
        ],
        'LastModifiedDate': datetime(2015, 1, 1),
        'CreationDate': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- IdentityProvider (dict) --
  
  The identity provider object.
  - UserPoolId (string) --
    
    The user pool ID.
  - ProviderName (string) --
    
    The identity provider name.
  - ProviderType (string) --
    
    The identity provider type.
  - ProviderDetails (dict) --
    
    The identity provider details, such as MetadataURL and MetadataFile .
    - (string) --
      - (string) --
  - AttributeMapping (dict) --
    
    A mapping of identity provider attributes to standard and custom user pool attributes.
    - (string) --
      - (string) --
  - IdpIdentifiers (list) --
    
    A list of identity provider identifiers.
    - (string) --
  - LastModifiedDate (datetime) --
    
    The date the identity provider was last modified.
  - CreationDate (datetime) --
    
    The date the identity provider was created.

ListIdentityProviders (updated)

Link ¶
Changes (response)

{'Providers': {'ProviderType': {'SignInWithApple'}}}

Lists information about all identity providers for a user pool.

See also: AWS API Documentation

Request Syntax

client.list_identity_providers(
    UserPoolId='string',
    MaxResults=123,
    NextToken='string'
)

type UserPoolId

string

param UserPoolId

[REQUIRED]

The user pool ID.

type MaxResults

integer

param MaxResults

The maximum number of identity providers to return.

type NextToken

string

param NextToken

A pagination token.

rtype

dict

returns

Response Syntax

{
    'Providers': [
        {
            'ProviderName': 'string',
            'ProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC',
            'LastModifiedDate': datetime(2015, 1, 1),
            'CreationDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Providers (list) --
  
  A list of identity provider objects.
  - (dict) --
    
    A container for identity provider details.
    - ProviderName (string) --
      
      The identity provider name.
    - ProviderType (string) --
      
      The identity provider type.
    - LastModifiedDate (datetime) --
      
      The date the provider was last modified.
    - CreationDate (datetime) --
      
      The date the provider was added to the user pool.
- NextToken (string) --
  
  A pagination token.

UpdateIdentityProvider (updated)

Link ¶
Changes (response)

{'IdentityProvider': {'ProviderType': {'SignInWithApple'}}}

Updates identity provider information for a user pool.

See also: AWS API Documentation

Request Syntax

client.update_identity_provider(
    UserPoolId='string',
    ProviderName='string',
    ProviderDetails={
        'string': 'string'
    },
    AttributeMapping={
        'string': 'string'
    },
    IdpIdentifiers=[
        'string',
    ]
)

type UserPoolId

string

param UserPoolId

[REQUIRED]

The user pool ID.

type ProviderName

string

param ProviderName

[REQUIRED]

The identity provider name.

type ProviderDetails

dict

param ProviderDetails

The identity provider details to be updated, such as MetadataURL and MetadataFile .

(string) --
- (string) --

type AttributeMapping

dict

param AttributeMapping

The identity provider attribute mapping to be changed.

(string) --
- (string) --

type IdpIdentifiers

list

param IdpIdentifiers

A list of identity provider identifiers.

(string) --

rtype

dict

returns

Response Syntax

{
    'IdentityProvider': {
        'UserPoolId': 'string',
        'ProviderName': 'string',
        'ProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC',
        'ProviderDetails': {
            'string': 'string'
        },
        'AttributeMapping': {
            'string': 'string'
        },
        'IdpIdentifiers': [
            'string',
        ],
        'LastModifiedDate': datetime(2015, 1, 1),
        'CreationDate': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- IdentityProvider (dict) --
  
  The identity provider object.
  - UserPoolId (string) --
    
    The user pool ID.
  - ProviderName (string) --
    
    The identity provider name.
  - ProviderType (string) --
    
    The identity provider type.
  - ProviderDetails (dict) --
    
    The identity provider details, such as MetadataURL and MetadataFile .
    - (string) --
      - (string) --
  - AttributeMapping (dict) --
    
    A mapping of identity provider attributes to standard and custom user pool attributes.
    - (string) --
      - (string) --
  - IdpIdentifiers (list) --
    
    A list of identity provider identifiers.
    - (string) --
  - LastModifiedDate (datetime) --
    
    The date the identity provider was last modified.
  - CreationDate (datetime) --
    
    The date the identity provider was created.