KS role

Created by Daniil Stasiuk, Modified on Fri, 27 May, 2022 at 1:03 PM by Daniil Stasiuk

Call Get {{url}}/v1.1/sites/{site_id}/roles

You can get the list of all role IDs

Accept:

{
    "items": [
        {
            "id": "76f7e578-80fb-11e8-a892-000d3a221c5b",
            "customer_reference": "Site Super User",
            "code": "site_super_user",
            "parent_id": "7d53b0b3-3ef7-11e8-9f1c-0050568d6e36",
            "is_hierarchical": true
        },
        {
            "id": "7d53b0b3-3ef7-11e8-9f1c-0050568d6e36",
            "customer_reference": "Site Admin",
            "code": "site_admin",
            "parent_id": null,
            "is_hierarchical": true
        },
        {
            "id": "8f6081a3-80fb-11e8-a892-000d3a221c5b",
            "customer_reference": "Site User",
            "code": "site_user",
            "parent_id": "76f7e578-80fb-11e8-a892-000d3a221c5b",
            "is_hierarchical": true
        },
        {
            "id": "9df437bb-80fb-11e8-a892-000d3a221c5b",
            "customer_reference": "Site Mobile User",
            "code": "site_mobile_user",
            "parent_id": null,
            "is_hierarchical": false
        }
    ],
    "next_page_link": null,
    "count": null
}

Production:

{
    "items": [
        {
            "id": "7d5ded97-8c2f-11e8-a31a-00505692f7ce",
            "customer_reference": "Site Admin",
            "code": "site_admin",
            "parent_id": null,
            "is_hierarchical": true
        },
        {
            "id": "7d9378cf-8c2f-11e8-a31a-00505692f7ce",
            "customer_reference": "Site Super User",
            "code": "site_super_user",
            "parent_id": "7d5ded97-8c2f-11e8-a31a-00505692f7ce",
            "is_hierarchical": true
        },
        {
            "id": "7e40b5e1-8c2f-11e8-a31a-00505692f7ce",
            "customer_reference": "Site User",
            "code": "site_user",
            "parent_id": "7d9378cf-8c2f-11e8-a31a-00505692f7ce",
            "is_hierarchical": true
        },
        {
            "id": "7e4c5b4a-8c2f-11e8-a31a-00505692f7ce",
            "customer_reference": "Site Mobile User",
            "code": "site_mobile_user",
            "parent_id": null,
            "is_hierarchical": false
        }
    ],
    "next_page_link": null,
    "count": null
}

If the user should have remote access to the locks, while creating/inviting the user, the role for Site Mobile User should be supplied, below is the example in the request body:

{
  "first_name": "tttest2",
  "last_name": "string",
  "email": "test2@gmail.com",
  "role_ids": ["8f6081a3-80fb-11e8-a892-000d3a221c5b","9df437bb-80fb-11e8-a892-000d3a221c5b"],
  "toggle_easy_office_mode": true,
  "toggle_manual_office_mode": true,
  "tag_offline_access": true,
}