Content

Users / Update

Update a users role, groups and status on tenant

Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/users/{id}

Method: PUT

Authorisation: Minimum role: ADMIN

Name	Type	Source
id	Int32
input	DTO_tenant_user_update	Body

Request body example

Response status: 200 (OK)

Response type: DTO_user

Other response statuses: 400 (BadRequest), 403 (Forbidden)

Response body example

Name	Type	Description
groups	DTO_reference[]	Groups
role	ENUM tenant_user_role	Role
status	ENUM tenant_user_status	Status

Name	Type	ReadOnly	Description
tenant_user	DTO_tenant_user		Tenant user
created_by	DTO_reference_user	ReadOnly	Created by
last_updated_by	DTO_reference_user	ReadOnly	Last updated by
language	DTO_translation_language	ReadOnly	Language
id	Int32	ReadOnly	Id
email	String		Email
given_name	String		Given name
family_name	String		Family name
full_name	String	ReadOnly	Name
profile_pic	String	ReadOnly	Profile pic
created	DateTime	ReadOnly	Created
last_updated	DateTime	ReadOnly	Last updated
display_absolute_time	Boolean	ReadOnly	Display absolute time

Name	Type	ReadOnly	Description
id	Int32		The id of the reference
label	Object	ReadOnly	Name/Label from referenced object.

Name	Type	ReadOnly	Description
groups	DTO_reference_is_admin[]		Groups
id	Int32	ReadOnly	Id
tenant_id	Int32		Tenant id
user_id	Int32		User id
role	ENUM tenant_user_role		Role
status	ENUM tenant_user_status		Status
last_seen	DateTime		Last seen

Name	Type	ReadOnly	Description
is_admin	Boolean	ReadOnly	Is admin
id	Int32		Id
label	Object	ReadOnly	Label

Name	Type	ReadOnly	Description
profile_pic	String	ReadOnly	Profile pic
email	String	ReadOnly	Email
id	Int32		Id
label	Object	ReadOnly	Label

Name	Type	ReadOnly	Description
id	Int32	ReadOnly	Leave empty on input
name	String		Name
code	String		Code
icon	String	ReadOnly	Icon
icon_sqare	String	ReadOnly	Icon sqare

GET Users / Get one

POST Users / Activate deactivate