VerifiedPermissions / Client / update_identity_source

update_identity_source

VerifiedPermissions.Client.update_identity_source(**kwargs)

Updates the specified identity source to use a new identity provider (IdP) source, or to change the mapping of identities from the IdP to a different principal entity type.

See also: AWS API Documentation

Request Syntax

response = client.update_identity_source(
    policyStoreId='string',
    identitySourceId='string',
    updateConfiguration={
        'cognitoUserPoolConfiguration': {
            'userPoolArn': 'string',
            'clientIds': [
                'string',
            ]
        }
    },
    principalEntityType='string'
)

Parameters:

• policyStoreId (string) –

  [REQUIRED]

  Specifies the ID of the policy store that contains the identity source that you want to update.

• identitySourceId (string) –

  [REQUIRED]

  Specifies the ID of the identity source that you want to update.

• updateConfiguration (dict) –

  [REQUIRED]

  Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.

  Note

  At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.

  You must specify a userPoolArn, and optionally, a ClientId.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: cognitoUserPoolConfiguration.

  • cognitoUserPoolConfiguration (dict) –

    Contains configuration details of a Amazon Cognito user pool.

    • userPoolArn (string) – [REQUIRED]

      The Amazon Resource Name (ARN) of the Amazon Cognito user pool associated with this identity source.

    • clientIds (list) –

      The client ID of an app client that is configured for the specified Amazon Cognito user pool.

      • (string) –

• principalEntityType (string) – Specifies the data type of principals generated for identities authenticated by the identity source.

Return type:

dict

Returns:

Response Syntax

{
    'createdDate': datetime(2015, 1, 1),
    'identitySourceId': 'string',
    'lastUpdatedDate': datetime(2015, 1, 1),
    'policyStoreId': 'string'
}

Response Structure

• (dict) –

  • createdDate (datetime) –

    The date and time that the updated identity source was originally created.

  • identitySourceId (string) –

    The ID of the updated identity source.

  • lastUpdatedDate (datetime) –

    The date and time that the identity source was most recently updated.

  • policyStoreId (string) –

    The ID of the policy store that contains the updated identity source.

Exceptions

• VerifiedPermissions.Client.exceptions.ValidationException

• VerifiedPermissions.Client.exceptions.ConflictException

• VerifiedPermissions.Client.exceptions.AccessDeniedException

• VerifiedPermissions.Client.exceptions.ResourceNotFoundException

• VerifiedPermissions.Client.exceptions.ThrottlingException

• VerifiedPermissions.Client.exceptions.InternalServerException