POST /user-management/remote/users/{userId}/
This resource is used to partially edit a remote user.
Use this resource if you want to edit the welcome page for example.
The welcome page is the only property that can be modified.
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
There are multiple possible values according the resource:
If this parameter is not present during the request, and error 415 Unsupported Media Type will be thrown.
This is the user's ID.
The Content-Length entity-header field indicates the size of the entity-body.
Object Name: User
Property Name | Type | Description | Method |
---|---|---|---|
Id | Integer | This property is the remote user's ID. | GET |
Username | String | This property is the user's name | GET POST |
WelcomePage | String | This property is the user's welcome page. | GET POST |
Roles | Array<String> | This is the remote user's roles. | GET |
URL Example: https://0.0.0.0/api/rest/v1/user-management/remote/users/1
{
"welcomePage": "/my/welcome/page/updated"
}
URL Example: https://0.0.0.0/api/rest/v1/user-management/remote/users/1
<?xml version="1.0" encoding="utf-8"?>
<User>
<WelcomePage>/my/welcome/page/updated</WelcomePage>
</User>