Changing the information of a user account¶

Note

The body must include the attributes id and modified to identify the corresponding entry.

Note

The ID of the entry in the path of the request must match the value of the attribute id in the body.

Note

The body may only contain the mentioned attributes. All other possible attributes of the object UserVO are ignored.

Sends a PUT request to the endpoint /users/{id}.

Description¶

The Change-User request allows the user to change the information of a user account of the organisation.

Requirements¶

Values of the request: User-ID {id}d}

Objects: UserVO

Request¶

To change the information of a user account, the User-ID {id} needs to be added to the path of the request.

For a detailed specification of which information is required to change the information of a user account, the object UserVO with the following attributes needs to be defined in the body:

Attributes	Description	Values
`email`	The email address of the user account.	`string`
`login`	The user name for logging in to the Myra App. This should match the value for email.	`string`
`id`	The ID of the entry.	`integer`
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`

The following attributes are optional:

Attributes	Description	Values
`firstname`	The first name of the user.	`string`
`lastname`	The name of the user.
`roles`	An array with permission roles of a user account.	`ADMINISTRATOR` `USER`
`rootGroupRoles`	An array with information about group permissions for a user account.	`ADMINISTRATOR` `USER`
`isIndirectCustomer`	Shows if the user account is a user account of a partner or a direct customer of Myra.	`true` `false`

The system returns the object UserVO with the changed information.

Example¶

Example request body:

{
  "email": "string",
  "login": "string",
  "firstname": "string",
  "lastname": "string",
  "roles": "ADMINISTRATOR",
  "rootGroupRoles": "ADMINISTRATOR",
  "isIndirectCustomer": true
}

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The updated `UserVO`.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.