How can we help?

Searching:

0 results found
backBack

Users/Post

POST /odata/Users/

To create a new Axonize user.

See the following for request and response details ‒

See Also

Request ‒ Users/Post

Property Type Description Mandatory
email String The email assigned to this user to be entered during login. The email is unique per Application. Y
username String Enter any user name to be used by Axonize. This property is used for display, not for logging in. Y
tenantId String The ID of the Axonize Tenant to which this user belongs. This identifier is automatically generated by Axonize and is returned in response to the Tenants/Post request.
password String The password provided by Axonize is mandatory for creating new users.

For security reasons, Axonize does not store the password on its servers. Instead, the password is stored in an external secure password system. This password is not returned in any GET requests.

 Y
role String Specifies the type of user as well as their associated permissions –

  • Admin ‒ Has full access to all Axonize functionality for all the Applications of all the Tenants to which this user is assigned.
  • Readonly ‒ Can only view Axonize data.
  • AppAdmin ‒ Can access almost all functionality for the Application to which he/she is assigned. For example, cannot create new devices.
  • TenantTechSupport ‒ Can access almost all functionality for the Tenant assigned to him/her, including creating new Devices and new Rules. This role is typically assigned to technical support at the customer.
 Y
mobilePhone String Alerts can trigger a phone call or can send an SMS. This is the cell phone number to contact when an alert is triggered.
cultureInfo String The language in which the Axonize portal is presented. These standard options include the language of the Application and are described at https://msdn.microsoft.com/en-us/library/system.globalization.cultureinfo(vs.71).aspx.
status String/Enum User status –

  • Pending ‒ User that has a pending invitation to Axonize. See the Users/Invite request. Only invited users can be pending.
  • Activated ‒ User that is authorized by Axonize.
  • Blocked ‒ User with repeated unsuccessful login attempts. The default number of attempts
    is 3.
isScrubbed Boolean An internal property used by Axonize for GDPR purposes.
failedLogins Integer Specifies the number of failed logins since the user last logged in successfully.
favouriteReports String Array Lists the report IDs that were defined as favorites of this user in the Axonize Portal, as described
in xxx.

Example JSON Users/Post Request

curl -X POST \

  https://api.stg.axonize.com/odata/users/ \

-H ‘Authorization: Token’ \

  -H ‘Content-Type: application/json’ \

  -H ‘appId: 801A048A-9F23-429F-BF0D-B6D35B22771E’ \

  -d ‘{

        “role”:”admin”,

        “email”:”axonize@axonize.com”,

        “username”:”axonize user”,

        “password”:”s0meP@ssw0rd”

 }

Response ‒ Users/Post

All the same properties in the request are returned in the response. In addition, the response that is returned also contains the following properties –

Property Type Description
userId String A unique User identifier (userId) that is automatically generated for this user by Axonize.
tokenId String The token ID of this user. For internal use by Axonize.
appId String A unique Application identifier that is automatically generated by Axonize. This is the identifier of the Application to which this user is assigned.

This identifier is automatically generated by Axonize when the Application/Post request is used.

The Token or the Client ID/Client Secret used as the authentication in the request header specifies the application(s) to which this user is allowed access.
createDate, createUser, updateDate,
updateUser		 See Common Response Properties.

Example JSON Users/Post Response

Status 201 – Created

{

    “@odata.context”: “https://stg-axonizeapi-axonize.stg-ase-axonize.p.azurewebsites.net/odata/$metadata#Users/$entity”,

    “email”: ” axonize@axonize.com”,

    “username”: “axonize user”,

    “tenantId”: “5851631d4e41925b98f01234”,

    “role”: “admin”,

    “mobilePhone”: “+”,

    “cultureInfo”: null,

    “status”: “Activated”,

    “id”: “592139084d27e710e80f35cb”,

    “userId”: “ABCD”,

        “tokenId”: “ABD123”,

        “appId”: “801A048A-9F23-429F-BF0D-B6D35B22771E”,

    “createDate”: “2017-05-21T06:51:52.771Z”,

    “createUser”: “5851631e4e41925b98f01234”,

    “updateDate”: “0001-01-01T00:00:00Z”,

    “updateUser”: null

}