2.8. Create-users

Creates users.

Function name

create-users

Parameters
  • data (Required). It is an array of fields. For example, in case the data format is XML, you should post something like this:

    <data>
        <item>
            <first_name>Joe</first_name>
            <last_name>Cole</last_name>
            <login>joe.cole</login>
            <password>kaboom1</password>
            <email>joe.cole@celoxis.com</email>
            <role_ids>1738,1912</role_ids>
        </item>
        <item>
            <first_name>Mary</first_name>
            <last_name>Jane</last_name>
            <login>mary.jane</login>
            <password>krypton2</password>
            <email>mary.jabe@celoxis.com</email>
            <role_ids>1738</role_ids>
        </item>
    </data>

    In case of JSON, you should submit an array of objects with the same properties.

    Here are the details of the fields:

    • first_name (Required). String. Either the first, last name or both must be present.

    • last_name (Required).

    • login (Optional). String. Login name of the user. If login is present, the user will be counted towards your license count.

    • password (Optional). String. Password of the user.

    • email (Optional). String. Email of the user. For users with login, email is mandatory.

    • role_ids (Optional). String. A comma separated string of role ids.

Return values

Nothing