CodeCatalyst / Client / get_user_details

get_user_details#

CodeCatalyst.Client.get_user_details(**kwargs)#

Returns information about a user.

Request Syntax

response = client.get_user_details(
    id='string',
    userName='string'
)

Parameters:

id (string) – The system-generated unique ID of the user.
userName (string) – The name of the user as displayed in Amazon CodeCatalyst.

Return type:

dict

Returns:

Response Syntax

{
    'userId': 'string',
    'userName': 'string',
    'displayName': 'string',
    'primaryEmail': {
        'email': 'string',
        'verified': True|False
    },
    'version': 'string'
}

Response Structure

(dict) –
- userId (string) –
  
  The system-generated unique ID of the user.
- userName (string) –
  
  The name of the user as displayed in Amazon CodeCatalyst.
- displayName (string) –
  
  The friendly name displayed for the user in Amazon CodeCatalyst.
- primaryEmail (dict) –
  
  The email address provided by the user when they signed up.
  - email (string) –
    
    The email address.
  - verified (boolean) –
    
    Whether the email address has been verified.
- version (string) –

Exceptions

CodeCatalyst.Client.exceptions.ThrottlingException
CodeCatalyst.Client.exceptions.ConflictException
CodeCatalyst.Client.exceptions.ValidationException
CodeCatalyst.Client.exceptions.ServiceQuotaExceededException
CodeCatalyst.Client.exceptions.ResourceNotFoundException
CodeCatalyst.Client.exceptions.AccessDeniedException