Client User (/user/client/)
- esnata (Unlicensed)
You can test API methods on the interactive API browser page and without writing code
Some of the resources described on the page may not be available by default due to the type of application (see Creating and authorizing applications).
This resource is intended for creating, deleting, and managing and refining client-level user parameters. The client-level user has access to the settings and resources of a specific client, and depending on the type of access (access type)Â has full access (full) or read-only access (read_only) without the right to make any changes in the settings.
Description of data structures
Name | Type | Mandatory | Description |
|---|---|---|---|
client_id | integer | yes | ID of the client for which the user is being created |
access | string | none | The type of access to resources. Can be 'full' or 'read_only' (no rights for changes) |
comment | string | none | Comment (note) |
string | yes | user's e-mail address | |
email_notify | boolean | none | If the parameter takes the value 'True’, then the data for access to the system for the new user will be sent to the email address: ·    if the email_for_notify parameter is set – send it to the email from email_for_notify; ·    if the email_for_notify parameter is not set – to the current user (who creates) |
email_for_notify | string | none | The field required for the email_notify parameter is the e-mail address where the data will be sent when creating a new user |
extra_params | string | none | Field for additional parameters, can be adapted for any purpose |
login | string | yes | User Login |
name | string | yes | User Name |
password | string | yes | User Password |
status | string | none | User status. Can be: 'active' or 'blocked' |
timezone | string | none | User's time zone |