Access Control¶

On this page, you will find descriptions of API methods for managing device access permissions for technician accounts and departments from the Team section.

Technician Access Control¶

Access Permissions for Technician¶

You can retrieve the list of permissions assigned to a technician account or a pending invitation using the team/member/access/list method.

Request:

HTTPcURL

GET /v1/team/member/access/list
  ?email=<string>
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

curl -G "https://api.getscreen.me/v1/team/member/access/list" \
  --data-urlencode "email=<string>" \
  -H "X-Api-Key: YOUR_API_KEY"

Parameter	Type	Description
`email`	`string`	Email address of the technician account or pending invitation.

Response:

Example Response

Response Data

{
    "data": {
        "id": 1002,
        "email": "[email protected]",
        "roles": [ {
            "id": 2001,
            "group_id": 1001
        }, {
            "id": 2002,
            "agent_id": 1002
        }, {
            "id": 2003,
            "default": true
        } ]
    },
    "status": 0
}

Name	Type	Description
`id`	`number`	Internal ID of the technician account or pending invitation.
`email`	`string`	Email address.
`roles`	`array`	List of assigned permissions.
`roles[].id`	`number`	Internal role ID.
`roles[].agent_id`	`number`	Internal ID of the device to which the permission applies. Present only when role assigment is `agent`.
`roles[].group_id`	`number`	Internal ID of the device group to which the permission applies. Present only when role assigment is `group`.

Add Access Permission for Technician¶

You can grant a technician account or invitation access to a permanent access device, quick support section, or another team feature using the team/member/access/add method.

Request:

HTTPcURL

POST /v1/team/member/access/add
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

{
  "email": <string>,
  "role_id": <number>,
  "agent_id": <number>,
  "group_id": <number>
}

curl -X POST "https://api.getscreen.me/v1/team/member/access/add" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "email": <string>,
    "role_id": <number>,
    "agent_id": <number>,
    "group_id": <number>
  }'

Parameter	Type	Description
`email`	`string`	Email address of the technician account or pending invitation.
`role_id`	`number`	Internal ID of the role to assign.
`agent_id`	`number`	Internal device ID. Required when assigning a role with the `agent` scope.
`group_id`	`number`	Internal device group ID. Required when assigning a role with the `group` scope.

Response:

Example Response

Response Data

{
    "status": 0
}

Name	Type	Description
`status`	`number`	Result status. Possible values: `0` — Permission assigned successfully `1` — Invalid request data `6` — Insufficient permissions

Remove Access Permissions from Technician¶

You can remove a permission from a technician account or a pending invitation using the team/member/access/remove method.

Request:

HTTPcURL

POST /v1/team/member/access/remove
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

{
  "email": <string>,
  "role_id": <number>,
  "agent_id": <number>,
  "group_id": <number>
}

curl -X POST "https://api.getscreen.me/v1/team/member/access/remove" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "email": <string>,
    "role_id": <number>,
    "agent_id": <number>,
    "group_id": <number>
  }'

Parameter	Type	Description
`email`	`string`	Email address of the technician account or pending invitation.
`role_id`	`number`	Internal ID of the role to remove.
`agent_id`	`number`	Internal device ID. Required when removing a role with the `agent` scope.
`group_id`	`number`	Internal device group ID. Required when removing a role with the `group` scope.

Response:

Example Response

Response Data

{
    "status": 0
}

Name	Type	Description
`status`	`number`	Result status. Possible values: `0` — Permission removed successfully `1` — Invalid request data `6` — Insufficient permissions

Department Access Control¶

Access Permissions for Department¶

You can retrieve the list of permissions assigned to a department using the team/department/access/list method.

Request:

HTTPcURL

GET /v1/team/department/access/list
  ?id=<number>
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

curl -G "https://api.getscreen.me/v1/team/department/access/list" \
  --data-urlencode "id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY"

Parameter	Type	Description
`id`	`number`	Internal department ID.

Response:

Example Response

Response Data

{
    "data": {
        "id": 1002,
        "roles": [ {
            "id": 2001,
            "group_id": 1001
        }, {
            "id": 2002,
            "agent_id": 1002
        }, {
            "id": 2003
        } ]
    },
    "status": 0
}

Name	Type	Description
`id`	`number`	Internal department ID.
`roles`	`array`	List of assigned permissions.
`roles[].id`	`number`	Internal role ID.
`roles[].agent_id`	`number`	Internal ID of the device to which the permission applies. Present only when role assigment is `agent`.
`roles[].group_id`	`number`	Internal ID of the device group to which the permission applies. Present only role assigment is `group`.

Add Access Permission for Department¶

You can grant a department access to a permanent access device, quick support section, or another team feature using the team/department/access/add method.

Request:

HTTPcURL

POST /v1/team/department/access/add
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

{
  "department_id": <number>,
  "role_id": <number>,
  "agent_id": <number>,
  "group_id": <number>
}

curl -X POST "https://api.getscreen.me/v1/team/department/access/add" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "department_id": <number>,
    "role_id": <number>,
    "agent_id": <number>,
    "group_id": <number>
  }'

Parameter	Type	Description
`department_id`	`number`	Internal department ID.
`role_id`	`number`	Internal ID of the role to assign.
`agent_id`	`number`	Internal device ID. Required when assigning a role with the `agent` scope.
`group_id`	`number`	Internal device group ID. Required when assigning a role with the `group` scope.

Response:

Example Response

Response Data

{
    "status": 0
}

Name	Type	Description
`status`	`number`	Result status. Possible values: `0` — Permission assigned successfully. `1` — Invalid request data. `2` — Internal server error. `6` — Department not found. `8` — Insufficient permissions.

Remove Access Permissions from Department¶

You can remove a permission from a department using the team/department/access/remove method.

Request:

HTTPcURL

POST /v1/team/department/access/remove
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

{
  "department_id": <number>,
  "role_id": <number>,
  "agent_id": <number>,
  "group_id": <number>
}

curl -X POST "https://api.getscreen.me/v1/team/department/access/remove" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "department_id": <number>,
    "role_id": <number>,
    "agent_id": <number>,
    "group_id": <number>
  }'

Parameter	Type	Description
`department_id`	`number`	Internal department ID.
`role_id`	`number`	Internal ID of the role to remove.
`agent_id`	`number`	Internal device ID. Required when removing a role with the `agent` scope.
`group_id`	`number`	Internal device group ID. Required when removing a role with the `group` scope.

Response:

Example Response

Response Data

{
    "status": 0
}

Name	Type	Description
`status`	`number`	Result status. Possible values: `0` — Permission removed successfully `1` — Invalid request data `6` — Insufficient permissions