Sending an activation email

Important

The platform enforces the following rules for the /users/{user_id}/send-activation-email endpoint:

  • Only API clients can access this endpoint.

  • An activation email can be sent only to user accounts located in sub-tenants.

To send an activiation email

  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. Send a POST request to the /users/{user_id}/send-activation-email endpoint:

    >>> response = requests.post(f'{base_url}/users/{user_id}/send-activation-email', headers={'Content-Type': 'application/json', **auth})
    

    The /users/{user_id}/send-activation-email requires empty JSON body.

  4. Check the status code of the response:

    >>> response.status_code
    204
    

    Status code 204 means that an email message with the activation link has been sent.

    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.