Updating permission values and user role

Request

Updates the role and permissions of the user, as well as the team member who is attached to this user.

Security

BearerPartnerUser

Path

location_idnumberrequired

ID of a location.

Example:123

user_idnumberrequired

ID of a user.

Example:123

Acceptstringrequired

Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.

Default:"application/vnd.api.v2+json"

Example:application/vnd.api.v2+json

Content-Typestringrequired

Should be equal to application/json

Example:application/json

Bodyapplication/json

user_rolestring

Name of role

Enum:"worker""administrator""accountant""manager""owner""free_readonly""free_readonly_admin"

user_permissionsArray of objects(Model object "Permission value")

List of user permissions values

Example:

[
  {
    "slug": "timetable_access",
    "value": true
  }
]

team_member_idnumber

Team Member ID attached to the user

curl -i -X PUT \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/123/users/123/permissions \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_role": "worker",
    "user_permissions": [
      {
        "slug": "timetable_access",
        "value": true
      }
    ],
    "team_member_id": 0
  }'

Responses

OK

Bodyapplication/json

successboolean(Successful response status)

Response status.

Example:true

dataobject(Model object "Permissions and user role")

Data on the permissions and user role

Example:

{
  "is_editable": true,
  "staff_id": 12345,
  "user_role": "owner",
  "has_any_paid_permission": null,
  "user_permissions": [
    { … },
    { … },
    { … }
  ]
}

metaArray of any or object(Empty meta object)

Additional response data (empty object or empty array)

Example:

{}

Response

{
  "success": true,
  "data": {
    "is_editable": true,
    "staff_id": 12345,
    "user_role": "owner",
    "has_any_paid_permission": null,
    "user_permissions": [ … ]
  },
  "meta": {}
}