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',
    'configuration': {
        'cognitoUserPoolConfiguration': {
            'userPoolArn': 'string',
            'clientIds': [
                'string',
            ],
            'issuer': 'string',
            'groupConfiguration': {
                'groupEntityType': '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.

  • configuration (dict) –

    Contains configuration information about an identity source.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: cognitoUserPoolConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • cognitoUserPoolConfiguration (dict) –

      Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more application client IDs.

      Example: "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}

      • userPoolArn (string) –

        The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

        Example: "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"

      • clientIds (list) –

        The unique application client IDs that are associated with the specified Amazon Cognito user pool.

        Example: "clientIds": ["&ExampleCogClientId;"]

        • (string) –

      • issuer (string) –

        The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that contains the identities to be authorized.

        Example: "issuer": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"

      • groupConfiguration (dict) –

        The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

        • groupEntityType (string) –

          The name of the schema entity type that’s mapped to the user pool group. Defaults to AWS::CognitoGroup.

Exceptions

• VerifiedPermissions.Client.exceptions.ValidationException

• VerifiedPermissions.Client.exceptions.AccessDeniedException

• VerifiedPermissions.Client.exceptions.ResourceNotFoundException

• VerifiedPermissions.Client.exceptions.ThrottlingException

• VerifiedPermissions.Client.exceptions.InternalServerException