Platform | User
Manages all operations related to users.
Overview
URL | api/{tenantKey}/{orgKey}/identity/users |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
GET Users (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
opts | (ODataQueryOptions) OData query option. |
Response:
When successful, the response body contains the list of records available. See UserResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET User by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body contains the entity record. See UserResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET User by key
Returns the entity record that matches the specified key.
The following elements are required:
userKey | (string) User. |
Response:
When successful, the response body contains the entity record. See UserResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET User Picture.
Returns the value of attribute 'Picture' of the specified entity record.
The following elements are required:
id | (string) The record identifier. |
fileName | (string) The file name. |
Response:
When successful, the response is a stream with the image file. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
POST Users
Creates a new entity record.
The following elements are required:
userResource | (ApiUserResource) The request body should contain the entity record that should be created. See ApiUserResource. |
Response:
When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiUserResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Add Groups by keys
Adds the specified 'Groups' to the 'User' (by specifying its keys).
The following elements are required:
userKey | (string) User. |
value | (Array of string) A list of record keys to be added. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Add Groups by identifiers
Adds the specified 'Groups' to the 'User' (by specifying its identifiers).
The following elements are required:
userKey | (string) User. |
value | (Array of string) A list of record identifiers to be added. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Remove Groups by keys
Removes the specified 'Groups' to the 'User' (by specifying its keys).
The following elements are required:
userKey | (string) User. |
value | (Array of string) A list of record keys to be removed. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Remove Groups by identifiers
Removes the specified 'Groups' to the 'User' (by specifying its identifiers).
The following elements are required:
userKey | (string) User. |
value | (Array of string) A list of record identifiers to be removed. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Add Roles by keys
Adds the specified 'Roles' to the 'User' (by specifying its keys).
The following elements are required:
userKey | (string) User. |
value | (Array of string) A list of record keys to be added. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Add Roles by identifiers
Adds the specified 'Roles' to the 'User' (by specifying its identifiers).
The following elements are required:
userKey | (string) User. |
value | (Array of string) A list of record identifiers to be added. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Remove Roles by keys
Removes the specified 'Roles' to the 'User' (by specifying its keys).
The following elements are required:
userKey | (string) User. |
value | (Array of string) A list of record keys to be removed. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Remove Roles by identifiers
Removes the specified 'Roles' to the 'User' (by specifying its identifiers).
The following elements are required:
userKey | (string) User. |
value | (Array of string) A list of record identifiers to be removed. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Send Invitation
Custom operation 'SendInvitation'.
The following elements are required:
user | (InvitedUser) User. |
Response:
When successful, the response body contains a string. |
Resource URL:
PUT Set Email User
Updates the value of attribute 'Email' in the specified entity record.
The following elements are required:
userKey | (string) User. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Groups User
Updates the value of attribute 'Groups' in the specified entity record.
The following elements are required:
userKey | (string) User. |
value | (Group) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive User
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
userKey | (string) User. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set IsTechnician User
Updates the value of attribute 'IsTechnician' in the specified entity record.
The following elements are required:
userKey | (string) User. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set LastLogin User
Updates the value of attribute 'LastLogin' in the specified entity record.
The following elements are required:
userKey | (string) User. |
value | (DateTimeOffset) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Name User
Updates the value of attribute 'Name' in the specified entity record.
The following elements are required:
userKey | (string) User. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Picture User
Updates the value of attribute 'Picture' in the specified entity record.
The following elements are required:
userKey | (string) User. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Roles User
Updates the value of attribute 'Roles' in the specified entity record.
The following elements are required:
userKey | (string) User. |
value | (Role) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Status User
Updates the value of attribute 'Status' in the specified entity record.
The following elements are required:
userKey | (string) User. |
value | (enum Status) The request body should contain the new value for the attribute. See Status. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set UserKey User
Updates the value of attribute 'UserKey' in the specified entity record.
The following elements are required:
userKey | (string) User. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
DELETE User by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE User by key
Deletes the entity record that matches the specified key.
The following elements are required:
userKey | (string) User. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiUserResource
The following elements are required:
userKey | (string) User. |
name | (string) The name of the user. |
isTechnician | (bool) If the user is technician. |
The following elements are optional:
lastLogin | (DateTimeOffset) The date and time of the last login. |
roles | (Role) Roles. |
(string) Email. | |
picture | (string) Picture. |
groups | (Group) Groups. |
status | (enum Status) The user state.
See Status. |
UserResource
The following elements are required:
userKey | (string) User. |
name | (string) The name of the user. |
culture | (string) Culture. |
isTechnician | (bool) If the user is technician. |
The following elements are optional:
lastLogin | (DateTimeOffset) The date and time of the last login. |
roles | (Role) Roles. |
(string) Email. | |
picture | (string) Picture. |
groups | (Group) Groups. |
status | (enum Status) The user state.
See Status. |