permissions

Update a permission

Changed on

Replace the permission's name, users, user groups, doors, door groups, and schedule.

put/v1/access-control/permissions/{permission_id}

Request

  • Base URL
    https://developer.coram.ai
  • URL
    https://developer.coram.ai/v1/access-control/permissions/{permission_id}
  • Auth
    API key in header X-Auth-Token

Path parameters

permission_idinteger required

Request body

namestring required
user_idsinteger[] required

User IDs in your organization.

user_group_idsinteger[]

User group IDs in your organization. Omitted groups are removed on update.

door_idsinteger[] required

Active door IDs in your organization.

door_group_idsinteger[]

Door group IDs in your organization. Omitted groups are removed on update.

Example request

{
  "schedule": {
    "timeslots": [
      {
        "start_day_of_week": 1,
        "start_time": "09:00",
        "end_day_of_week": 1,
        "end_time": "17:00"
      }
    ],
    "time_start": null,
    "time_end": null,
    "rrule": null
  }
}

Response

Permission updated

idinteger required
namestring required
user_idsinteger[] required
user_group_idsinteger[] required
door_idsinteger[] required
door_group_idsinteger[] required

Example response

{
  "schedule": {
    "timeslots": [
      {
        "start_day_of_week": 1,
        "start_time": "09:00",
        "end_day_of_week": 1,
        "end_time": "17:00"
      }
    ],
    "time_start": null,
    "time_end": null,
    "rrule": null
  }
}

Changes