:doc:`CodeCatalyst <../../codecatalyst>` / Client / get_user_details

****************
get_user_details
****************



.. py:method:: CodeCatalyst.Client.get_user_details(**kwargs)

  

  Returns information about a user.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/GetUserDetails>`_  


  **Request Syntax**
  ::

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

    The system-generated unique ID of the user.

    

  
  :type userName: string
  :param userName: 

    The name of the user as displayed in Amazon CodeCatalyst.

    

  
  
  :rtype: 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**
  
  *   :py:class:`CodeCatalyst.Client.exceptions.ThrottlingException`

  
  *   :py:class:`CodeCatalyst.Client.exceptions.ConflictException`

  
  *   :py:class:`CodeCatalyst.Client.exceptions.ValidationException`

  
  *   :py:class:`CodeCatalyst.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`CodeCatalyst.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CodeCatalyst.Client.exceptions.AccessDeniedException`

  