Roles and Permissions

These APIs create roles, assign them to users, and show what a user is allowed to do.

How a role is given to a user

Features and roles belong to an application. A role includes only active features. A user can use those features after the role is assigned.

Endpoints

Endpoint	What it does
POST /fieldservicegateway/usermanagement/v3/authorization/create-role	Creates a role and sets its features.
POST /fieldservicegateway/usermanagement/v3/authorization/manage-user-role	Gives a user a role, or takes a role away.
DELETE /fieldservicegateway/usermanagement/v3/authorization/app-roles/deactivate-role	Turns a role off.
GET /fieldservicegateway/usermanagement/v3/authorization/users/:userId/app-roles	Returns one user's roles and features.
GET /fieldservicegateway/usermanagement/v3/authorization/applications/:applicationId/roles	Lists the roles defined for an application.
GET and POST /fieldservicegateway/usermanagement/v3/authorization/features	Lists, adds, or removes features in the catalog.
POST /fieldservicegateway/usermanagement/v3/authorization/app-roles/features/search	Returns the features granted to one role.
POST /fieldservicegateway/usermanagement/v3/authorization/users/user-roles/search	Returns roles for up to 10 users.
POST /fieldservicegateway/usermanagement/v3/authorization/users/by-role-scope/search	Returns users who hold a role at a provider or location.