Platform | User

Manages all operations related to users.

Overview

api/{tenantKey}/{orgKey}/identity/users

URL	api/{tenantKey}/{orgKey}/identity/users
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST Users
PUT:
DELETE:
- DELETE User by identifier
- DELETE User by key

All Resources

This service uses the following resources:

ApiUserResource
UserResource

GET Operations

GET Users

Returns the list of all the entity records available.

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:

api/{tenantKey}/{orgKey}/identity/users

GET /identity/users

GET Users (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

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:

api/{tenantKey}/{orgKey}/identity/users?page={page}&pageSize={pageSize}

GET /identity/users?page={page}&pageSize={pageSize}

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:

api/{tenantKey}/{orgKey}/identity/users/{id}

GET /identity/users/{id}

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:

api/{tenantKey}/{orgKey}/identity/users/{userKey}

GET /identity/users/{userKey}

GET Print User by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/users/{id}/print?template={template}

GET /identity/users/{id}/print?template={template}

GET Print User by key

Prints the specified entity record.

The following elements are required:

userKey

(string) User.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed 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:

api/{tenantKey}/{orgKey}/identity/users/{userKey}/print

GET /identity/users/{userKey}/print

GET Original Print UserOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/identity/users/{id}/printOriginal?template={template}

GET /identity/users/{id}/printOriginal?template={template}

GET Original Print User by key

Prints the specified entity record.

The following elements are required:

userKey

(string) User.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed 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:

api/{tenantKey}/{orgKey}/identity/users/{userKey}/printOriginal

GET /identity/users/{userKey}/printOriginal

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:

api/{tenantKey}/{orgKey}/identity/users/{id}/picture

GET /identity/users/{id}/picture

POST Operations

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:

api/{tenantKey}/{orgKey}/identity/users

POST /identity/users

PUT Operations

PUT Set DefaultRole User

Updates the value of attribute 'DefaultRole' 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:

api/{tenantKey}/{orgKey}/identity/users/{userKey}/defaultRole

PUT /identity/users/{userKey}/defaultRole

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:

api/{tenantKey}/{orgKey}/identity/users/{userKey}/email

PUT /identity/users/{userKey}/email

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:

api/{tenantKey}/{orgKey}/identity/users/{userKey}/groups

PUT /identity/users/{userKey}/groups

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:

api/{tenantKey}/{orgKey}/identity/users/{userKey}/isActive

PUT /identity/users/{userKey}/isActive

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:

api/{tenantKey}/{orgKey}/identity/users/{userKey}/lastLogin

PUT /identity/users/{userKey}/lastLogin

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:

api/{tenantKey}/{orgKey}/identity/users/{userKey}/name

PUT /identity/users/{userKey}/name

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:

api/{tenantKey}/{orgKey}/identity/users/{userKey}/picture

PUT /identity/users/{userKey}/picture

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:

api/{tenantKey}/{orgKey}/identity/users/{userKey}/roles

PUT /identity/users/{userKey}/roles

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:

api/{tenantKey}/{orgKey}/identity/users/{userKey}/userKey

PUT /identity/users/{userKey}/userKey

DELETE Operations

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:

api/{tenantKey}/{orgKey}/identity/users/{id}

DELETE /identity/users/{id}

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:

api/{tenantKey}/{orgKey}/identity/users/{userKey}

DELETE /identity/users/{userKey}

Resources

ApiUserResource

The following elements are required:

userKey	(string) User.
name	(string) The name of the user.

The following elements are optional:

lastLogin	(DateTimeOffset) The date and time of the last login.
defaultRole	(string) The user default role.
roles	(Role) Roles.
email	(string) Email.
picture	(string) Picture.
groups	(Group) Groups.

UserResource

The following elements are required:

userKey	(string) User.
name	(string) The name of the user.
culture	(string) Culture. (fk) Allowed value: the natural key of a record of type Culture. These records are accessibly through the Cultures service.

The following elements are optional:

lastLogin	(DateTimeOffset) The date and time of the last login.
defaultRole	(string) The user default role. (fk) Allowed value: the natural key of a record of type Role. These records are accessibly through the Roles service.
roles	(Role) Roles.
email	(string) Email.
picture	(string) Picture.
groups	(Group) Groups.