NimbleStudio / Client / list_studio_members

list_studio_members#

NimbleStudio.Client.list_studio_members(**kwargs)#

Get all users in a given studio membership.

Note

ListStudioMembers only returns admin members.

Request Syntax

response = client.list_studio_members(
    maxResults=123,
    nextToken='string',
    studioId='string'
)

Parameters:

maxResults (integer) – The max number of results to return in the response.
nextToken (string) – The token for the next set of results, or null if there are no more results.
studioId (string) –
[REQUIRED]

The studio ID.

Return type:

dict

Returns:

Response Syntax

{
    'members': [
        {
            'identityStoreId': 'string',
            'persona': 'ADMINISTRATOR',
            'principalId': 'string',
            'sid': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- members (list) –
  
  A list of admin members.
  - (dict) –
    
    A studio member is an association of a user from your studio identity source to elevated permissions that they are granted in the studio.
    
    When you add a user to your studio using the Nimble Studio console, they are given access to the studio’s IAM Identity Center application and are given access to log in to the Nimble Studio portal. These users have the permissions provided by the studio’s user IAM role and do not appear in the studio membership collection. Only studio admins appear in studio membership.
    
    When you add a user to studio membership with the ADMIN persona, upon logging in to the Nimble Studio portal, they are granted permissions specified by the Studio’s Admin IAM role.
    - identityStoreId (string) –
      
      The ID of the identity store.
    - persona (string) –
      
      The persona.
    - principalId (string) –
      
      The principal ID.
    - sid (string) –
      
      The Active Directory Security Identifier for this user, if available.
- nextToken (string) –
  
  The token for the next set of results, or null if there are no more results.

Exceptions

NimbleStudio.Client.exceptions.ResourceNotFoundException
NimbleStudio.Client.exceptions.ConflictException
NimbleStudio.Client.exceptions.ThrottlingException
NimbleStudio.Client.exceptions.ValidationException
NimbleStudio.Client.exceptions.AccessDeniedException
NimbleStudio.Client.exceptions.InternalServerErrorException
NimbleStudio.Client.exceptions.ServiceQuotaExceededException