Changing a user account contact info

To change user account contact info

1. Authenticate to the cloud platform via the Python shell.

   The following variables should be available now:

   >>> base_url  # the base URL of the API
   '<the data center URL>/api/2'
   >>> auth  # the 'Authorization' header value with the access token
   {'Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6ImMwMD...'}
   >>> tenant_id  # the UUID of the tenant to which the token provides access
   'ede9f834-70b3-476c-83d9-736f9f8c7dae'
   

2. Assign the user_id variable the UUID of a user account created via the API or a user account found via search:

   >>> user_id = created_user_id
   >>> user_id
   '1c234e69-5469-424a-a6d1-ff5658b387a6'
   

3. Fetch the revision number of the user account as described in Fetching user account information. The following variable should be available now:

   >>> version
   1
   

4. Define a variable named user_data, and then assign the user account contact information to update to this variable:

   >>> user_data = {
   ...      "contact": {
   ...          "address1": "John Doe Str.",
   ...          "firstname": "Foo",
   ...          "lastname": "Bar"
   ...      },
   ...      "version": version
   ... }
   

   Name	Value type	Required	Description
   contact	contact object	No	The contact information of an account.
   version	number	Yes	Revision number.

5. Convert the user_data object to a JSON text:

   >>> user_data = json.dumps(user_data, indent=4)
   

6. Send a PUT request with the JSON text to the /users/{user_id} endpoint:

   >>> response = requests.put(
   ...     f'{base_url}/users/{user_id}',
   ...     headers={'Content-Type': 'application/json', **auth},
   ...     data=user_data,
   ... )
   

7. Check the status code of the response:

   >>> response.status_code
   200
   

   Status code 200 means that the contact data has been successfully changed.

   Note

   A different status code means that an error has occurred. For details of the error, see HTTP status response codes and API error codes.

   Also, the response body contains the user account information, formatted as a JSON text. When converted to an object, it will look like this:

   >>> pprint.pprint(response.json())
   {'activated': True,
    'business_types': [],
    'contact': {'address1': 'John Doe Str.',
                'address2': '',
                'city': '',
                'country': '',
                'email': 'johndoe@mysite.com',
                'firstname': 'Foo',
                'lastname': 'Bar',
                'phone': '',
                'state': '',
                'zipcode': ''},
    'created_at': '2019-07-25T07:11:02.807354+00:00',
    'enabled': True,
    'id': '1c234e69-5469-424a-a6d1-ff5658b387a6',
    'idp_id': '11111111-1111-1111-1111-111111111111',
    'language': 'en',
    'login': 'JohnDoe',
    'mfa_status': 'disabled',
    'notifications': ['quota', 'reports', 'backup_daily_report'],
    'personal_tenant_id': None,
    'tenant_id': 'ede9f834-70b3-476c-83d9-736f9f8c7dae',
    'terms_accepted': False,
    'version': 2}
   

Note

The revision number increments with each update, so update the version variable where necessary.