list_users_by_permission_group

FinSpaceData.Client.list_users_by_permission_group(**kwargs)

Lists details of all the users in a specific permission group.

See also: AWS API Documentation

Request Syntax

response = client.list_users_by_permission_group(
    permissionGroupId='string',
    nextToken='string',
    maxResults=123
)

Parameters

• permissionGroupId (string) --

  [REQUIRED]

  The unique identifier for the permission group.

• nextToken (string) -- A token that indicates where a results page should begin.
• maxResults (integer) --

  [REQUIRED]

  The maximum number of results per page.

Return type

dict

Returns

Response Syntax

{
    'users': [
        {
            'userId': 'string',
            'status': 'CREATING'|'ENABLED'|'DISABLED',
            'firstName': 'string',
            'lastName': 'string',
            'emailAddress': 'string',
            'type': 'SUPER_USER'|'APP_USER',
            'apiAccess': 'ENABLED'|'DISABLED',
            'apiAccessPrincipalArn': 'string',
            'membershipStatus': 'ADDITION_IN_PROGRESS'|'ADDITION_SUCCESS'|'REMOVAL_IN_PROGRESS'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • users (list) --

    Lists details of all users in a specific permission group.

    • (dict) --

      The structure of a user account associated with a permission group.

      • userId (string) --

        The unique identifier for the user.

      • status (string) --

        The current status of the user account.

        • CREATING – The user account creation is in progress.
        • ENABLED – The user account is created and is currently active.
        • DISABLED – The user account is currently inactive.

      • firstName (string) --

        The first name of the user.

      • lastName (string) --

        The last name of the user.

      • emailAddress (string) --

        The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.

      • type (string) --

        Indicates the type of user.

        • SUPER_USER – A user with permission to all the functionality and data in FinSpace.
        • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

      • apiAccess (string) --

        Indicates whether the user can access FinSpace API operations.

        • ENABLED – The user has permissions to use the API operations.
        • DISABLED – The user does not have permissions to use any API operations.

      • apiAccessPrincipalArn (string) --

        The IAM ARN identifier that is attached to FinSpace API calls.

      • membershipStatus (string) --

        Indicates the status of the user account within a permission group.

        • ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
        • ADDITION_SUCCESS – The user account is successfully added to the permission group.
        • REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

  • nextToken (string) --

    A token that indicates where a results page should begin.

Exceptions

• FinSpaceData.Client.exceptions.InternalServerException
• FinSpaceData.Client.exceptions.ValidationException
• FinSpaceData.Client.exceptions.ThrottlingException
• FinSpaceData.Client.exceptions.AccessDeniedException
• FinSpaceData.Client.exceptions.ResourceNotFoundException