Searching:
0 results found
BackUsers/Invite
Description
Invites a new User to the Axonize system. The following occurs –
- The potential User receives an email containing a link. The User’s Status property is changed to
- Clicking that link redirects the potential User to the Axonize system and enables him/her to create any password. The username is that User’s email address. The User’s Status property is changed to
See the following for request and response details ‒
See Also
Request ‒ Users/Invite
The request contains the same properties as the Users/Post request, except that they are wrapped in a user tag. For example, as shown below –
{“user”:{“username”:”demo”,”email”:”demoUser@axonize.com”,”role”:”admin”}}
Only the username, email and role properties are mandatory.
Example JSON Users/Invite Request
curl -X POST \
https://api.stg.axonize.com /odata/users/invite \
-H ‘Cache-Control: no-cache’ \
-H ‘Content-Type: application/json’ \
-H ‘Authorization: Token’ \
-H ‘appId: be517433-c4b8-4748-9258-1b1234567890’ \
-d ‘{“user”:{“username”:”demo”,”email”:”demoUser@axonize.com”,”role”:”admin”}}’
Response ‒ Users/Invite
The response contains the same properties as the Users/Post response, including the userId that is automatically generated by Axonize.
Example JSON Users/Invite Response
Status 200 – OK
{
“@odata.context”: “https://stg-axonizeapi-axonize.stg-ase-axonize.p.azurewebsites.net/odata/$metadata#UserEntity/$entity”,
“email”: ” demoUser@axonize.com”,
“username”: ” demo”,
“tenantId”: “5851631d4e41921234567890”,
“role”: “admin”,
“mobilePhone”: null,
“cultureInfo”: null,
“favouriteReports”: [],
“status”: “Pending”,
“failedLogins”: 0,
“isScrubbed”: false,
“tokenId”: null,
“id”: “5b680a1fe5cdcf1234567890”,
“appId”: “be517433-c4b8-4748-9258-1b1234567890”,
“createDate”: “2018-08-06T08:43:11.5837318Z”,
“createUser”: null,
“updateDate”: “0001-01-01T00:00:00Z”,
“updateUser”: null
}