Set User's Roles - Fluid Topics - 3.6

Use Fluid Topics Web API

Product
Fluid Topics
FT_Version
3.6
Category
Technical Notes
language
English

This web service changes the roles a user belongs to.

It is only able to set manual roles, the ones coming from authentication are computed and erased each time users authenticate.

This web service is only available to users with the ADMIN role.

Method

Endpoint

PUT

/api/users/$USER_ID/roles

Where:

  • $USER_ID is the user identifier.

Input Body Example

The request must set the Content-Type: application/json header.

{
"manualRoles": ["ADMIN"]
}

Where:

Output Example

{
"id": "a43eb18a-3f48-4732-9389-61b540ce9d0d",
"manualRoles": ["ADMIN"],
"authenticationRoles": [],
"defaultRoles": []
}

Where:

  • manualRole is used to set role(s) to the specified user.
  • authenticationRoles is used to set the role(s) to the specified user according to their authentication parameters.
  • defaultRoles is used to set role(s) that will be applied by default to all logged in users of a complete tenant.