VerifiedPermissions / Client / get_identity_source

get_identity_source#

VerifiedPermissions.Client.get_identity_source(**kwargs)#

Retrieves the details about the specified identity source.

See also: AWS API Documentation

Request Syntax

response = client.get_identity_source(
    policyStoreId='string',
    identitySourceId='string'
)
Parameters:
  • policyStoreId (string) –

    [REQUIRED]

    Specifies the ID of the policy store that contains the identity source you want information about.

  • identitySourceId (string) –

    [REQUIRED]

    Specifies the ID of the identity source you want information about.

Return type:

dict

Returns:

Response Syntax

{
    'createdDate': datetime(2015, 1, 1),
    'details': {
        'clientIds': [
            'string',
        ],
        'userPoolArn': 'string',
        'discoveryUrl': 'string',
        'openIdIssuer': 'COGNITO'
    },
    'identitySourceId': 'string',
    'lastUpdatedDate': datetime(2015, 1, 1),
    'policyStoreId': 'string',
    'principalEntityType': 'string'
}

Response Structure

  • (dict) –

    • createdDate (datetime) –

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

    • details (dict) –

      A structure that describes the configuration of the identity source.

      • clientIds (list) –

        The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.

        • (string) –

      • userPoolArn (string) –

        The Amazon Resource Name (ARN) of the Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.

      • discoveryUrl (string) –

        The well-known URL that points to this user pool’s OIDC discovery endpoint. This is a URL string in the following format. This URL replaces the placeholders for both the Amazon Web Services Region and the user pool identifier with those appropriate for this user pool.

        https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration

      • openIdIssuer (string) –

        A string that identifies the type of OIDC service represented by this identity source.

        At this time, the only valid value is cognito.

    • identitySourceId (string) –

      The ID of the 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 identity source.

    • principalEntityType (string) –

      The data type of principals generated for identities authenticated by this identity source.

Exceptions