Searching:0 results found
To create a new Axonize user.
See the following for request and response details ‒
|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.
|role||String||Specifies the type of user as well as their associated permissions –
|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 –
|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
Example JSON Users/Post Request
curl -X POST \
-H ‘Authorization: Token’ \
-H ‘Content-Type: application/json’ \
-H ‘appId: 801A048A-9F23-429F-BF0D-B6D35B22771E’ \
All the same properties in the request are returned in the response. In addition, the response that is returned also contains the following properties –
|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,
|See Common Response Properties.|
Example JSON Users/Post Response
Status 201 – Created
“email”: ” email@example.com”,
“username”: “axonize user”,