:doc:`FinSpaceData <../../finspace-data>` / Client / disable_user

************
disable_user
************



.. py:method:: FinSpaceData.Client.disable_user(**kwargs)

  

  Denies access to the FinSpace web application and API for the specified user.

  

  .. danger::

        This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisableUser>`_  


  **Request Syntax**
  ::

    response = client.disable_user(
        userId='string',
        clientToken='string'
    )
    
  :type userId: string
  :param userId: **[REQUIRED]** 

    The unique identifier for the user that you want to deactivate.

    

  
  :type clientToken: string
  :param clientToken: 

    A token that ensures idempotency. This token expires in 10 minutes.

    This field is autopopulated if not provided.

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'userId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **userId** *(string) --* 

        The unique identifier for the deactivated user.

        
  
  **Exceptions**
  
  *   :py:class:`FinSpaceData.Client.exceptions.InternalServerException`

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

  
  *   :py:class:`FinSpaceData.Client.exceptions.ThrottlingException`

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

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

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

  