IdentityStore / Client / describe_user

describe_user#

IdentityStore.Client.describe_user(**kwargs)#

Retrieves the user metadata and attributes from the UserId in an identity store.

Note

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

Request Syntax

response = client.describe_user(
    IdentityStoreId='string',
    UserId='string'
)

Parameters:

IdentityStoreId (string) –
[REQUIRED]

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.
UserId (string) –
[REQUIRED]

The identifier for a user in the identity store.

Return type:

dict

Returns:

Response Syntax

{
    'UserName': 'string',
    'UserId': 'string',
    'ExternalIds': [
        {
            'Issuer': 'string',
            'Id': 'string'
        },
    ],
    'Name': {
        'Formatted': 'string',
        'FamilyName': 'string',
        'GivenName': 'string',
        'MiddleName': 'string',
        'HonorificPrefix': 'string',
        'HonorificSuffix': 'string'
    },
    'DisplayName': 'string',
    'NickName': 'string',
    'ProfileUrl': 'string',
    'Emails': [
        {
            'Value': 'string',
            'Type': 'string',
            'Primary': True|False
        },
    ],
    'Addresses': [
        {
            'StreetAddress': 'string',
            'Locality': 'string',
            'Region': 'string',
            'PostalCode': 'string',
            'Country': 'string',
            'Formatted': 'string',
            'Type': 'string',
            'Primary': True|False
        },
    ],
    'PhoneNumbers': [
        {
            'Value': 'string',
            'Type': 'string',
            'Primary': True|False
        },
    ],
    'UserType': 'string',
    'Title': 'string',
    'PreferredLanguage': 'string',
    'Locale': 'string',
    'Timezone': 'string',
    'IdentityStoreId': 'string'
}

Response Structure

(dict) –
- UserName (string) –
  
  A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
- UserId (string) –
  
  The identifier for a user in the identity store.
- ExternalIds (list) –
  
  A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
  - (dict) –
    
    The identifier issued to this resource by an external identity provider.
    - Issuer (string) –
      
      The issuer for an external identifier.
    - Id (string) –
      
      The identifier issued to this resource by an external identity provider.
- Name (dict) –
  
  The name of the user.
  - Formatted (string) –
    
    A string containing a formatted version of the name for display.
  - FamilyName (string) –
    
    The family name of the user.
  - GivenName (string) –
    
    The given name of the user.
  - MiddleName (string) –
    
    The middle name of the user.
  - HonorificPrefix (string) –
    
    The honorific prefix of the user. For example, “Dr.”
  - HonorificSuffix (string) –
    
    The honorific suffix of the user. For example, “M.D.”
- DisplayName (string) –
  
  The display name of the user.
- NickName (string) –
  
  An alternative descriptive name for the user.
- ProfileUrl (string) –
  
  A URL link for the user’s profile.
- Emails (list) –
  
  The email address of the user.
  - (dict) –
    
    The email address associated with the user.
    - Value (string) –
      
      A string containing an email address. For example, “johndoe@amazon.com.”
    - Type (string) –
      
      A string representing the type of address. For example, “Work.”
    - Primary (boolean) –
      
      A Boolean value representing whether this is the primary email address for the associated resource.
- Addresses (list) –
  
  The physical address of the user.
  - (dict) –
    
    The address associated with the specified user.
    - StreetAddress (string) –
      
      The street of the address.
    - Locality (string) –
      
      A string of the address locality.
    - Region (string) –
      
      The region of the address.
    - PostalCode (string) –
      
      The postal code of the address.
    - Country (string) –
      
      The country of the address.
    - Formatted (string) –
      
      A string containing a formatted version of the address for display.
    - Type (string) –
      
      A string representing the type of address. For example, “Home.”
    - Primary (boolean) –
      
      A Boolean value representing whether this is the primary address for the associated resource.
- PhoneNumbers (list) –
  
  A list of PhoneNumber objects associated with a user.
  - (dict) –
    
    The phone number associated with the user.
    - Value (string) –
      
      A string containing a phone number. For example, “8675309” or “+1 (800) 123-4567”.
    - Type (string) –
      
      A string representing the type of a phone number. For example, “Mobile.”
    - Primary (boolean) –
      
      A Boolean value representing whether this is the primary phone number for the associated resource.
- UserType (string) –
  
  A string indicating the type of user.
- Title (string) –
  
  A string containing the title of the user.
- PreferredLanguage (string) –
  
  The preferred language of the user.
- Locale (string) –
  
  A string containing the geographical region or location of the user.
- Timezone (string) –
  
  The time zone for a user.
- IdentityStoreId (string) –
  
  The globally unique identifier for the identity store.

describe_user#

Note

Request Syntax

Response Syntax

Response Structure

Exceptions