API Reference

Update a user.

patch
http://localhost/api/v1/users/

Use id=self to reference the user associated to the current API token.

Optional permissions

  • modify users Required if you want to modify any user other than yourself

  • modify user-groups Required if you want to modify the groups associated to a user, unless you are a group admin

  • modify user-roles Required if you want to modify the roles associated to a user

  • read permissions Required to access the permissions associated with a user

  • read sources Required to access the sources associated with a user

Path Params
string
required

User ID - use self to identify the current user.

Query Params
boolean

If ?overwrite_groups=false and new groups are provided, the resulting set of groups will contain both the previous and the new groups. Otherwise, the list of groups will be overwritten by the new one (default: true).

boolean

If ?overwrite_roles=false and new roles are provided, the resulting set of roles will contain both the previous and the new roles. Otherwise, the list of roles will be overwritten by the new one (default: true).

Body Params
data
object
Responses

Updated 11 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 11 months ago