Zabbix Documentation 2.4

3.04.05.0 (current)| In development:5.2 (devel)| Unsupported:1.82.02.22.43.23.44.24.4Guidelines

User Tools

Site Tools


manual:api:reference:user:create

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

manual:api:reference:user:create [2020/02/13 15:13]
manual:api:reference:user:create [2019/01/28 14:49] (current)
sasha <code js> => <code java>
Line 1: Line 1:
 +===== user.create =====
  
 +==== Description ====
 +
 +''​object user.create(object/​array **users**)''​
 +
 +This method allows to create new users.
 +
 +==== Parameters ====
 +
 +''​(object/​array)''​ Users to create.
 +
 +Additionally to the [[object#​user|standard user properties]],​ the method accepts the following parameters.
 +
 +^ Parameter ^ Type ^ Description ^
 +| **passwd** \\ //​(required)//​ | string | User's password. |
 +| **usrgrps** \\ (required) | array | User groups to add the user to. \\ \\ The user groups must have the ''​usrgrpid''​ property defined. |
 +| user_medias | array | Media to create for the user. \\ \\ The media ''​userid''​ property must not be defined. |
 +==== Return values ====
 +
 +''​(object)''​ Returns an object containing the IDs of the created users under the ''​userids''​ property. The order of the returned IDs matches the order of the passed users.
 +
 +==== Examples ====
 +
 +=== Creating a user ===
 +
 +Create a new user, add him to a user group and create a new media for him.
 +
 +Request:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​user.create",​
 +    "​params":​ {
 +        "​alias":​ "​John",​
 +        "​passwd":​ "​Doe123",​
 +        "​usrgrps":​ [
 +            {
 +                "​usrgrpid":​ "​7"​
 +            }
 +        ],
 +        "​user_medias":​ [
 +            {
 +                "​mediatypeid":​ "​1",​
 +                "​sendto":​ "​[email protected]",​
 +                "​active":​ 0,
 +                "​severity":​ 63,
 +                "​period":​ "​1-7,​00:​00-24:​00"​
 +            }
 +        ]
 +    },
 +    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Response:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ {
 +        "​userids":​ [
 +            "​12"​
 +        ]
 +    },
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +==== See also ====
 +
 +  * [[manual:​api:​reference:​usermedia:​object#​media|Media]]
 +  * [[manual:​api:​reference:​usergroup:​object#​user_group|User group]]
 +
 +
 +==== Source ====
 +
 +CUser::​create() in //​frontends/​php/​include/​classes/​api/​services/​CUser.php//​.