Team

On this page, you will find descriptions of the API methods intended for working with technicians from the Team section.

Technician Management¶

Invite Technician¶

You can invite a new technician to your team using the team/member/invite method.

Request:

HTTPcURL

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

{
  "email": <string>,
  "name": <string>,
  "surname": <string>,
  "worker": <boolean>
}

curl -X POST "https://api.getscreen.me/v1/team/member/invite" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "email": <string>,
    "name": <string>,
    "surname": <string>,
    "worker": <boolean>
  }'

Parameter	Type	Description
`email`	`string`	Email address to send the invitation to.
`name`	`string`	First name.
`surname`	`string`	Last name.
`worker`	`boolean`	Whether to create a worker account (limited account).

Response:

Example Response

Response Data

{
    "status": 0
}

Name	Type	Description
`status`	`number`	Result status. Possible values: `0` — Invitation sent successfully `1` — Invalid request data `2` — Server error `5` — The email address is already in use `7` — The user is already a technician in another team

Technician and Invitation List¶

You can retrieve a list of all team member accounts, including both active technician accounts and pending invitations, using the team/member/list method.

Request:

HTTPcURL

GET /v1/team/member/list
  ?search=<string>
  &disabled=<boolean>
  &invited=<boolean>
  &worker=<boolean>
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

curl -G "https://api.getscreen.me/v1/team/member/list" \
  --data-urlencode "search=<string>" \
  --data-urlencode "disabled=<boolean>" \
  --data-urlencode "invited=<boolean>" \
  --data-urlencode "worker=<boolean>" \
  -H "X-Api-Key: YOUR_API_KEY"

Parameter	Type	Description
`search`	`string`	Case-insensitive filter by the technician's first name, last name, or email address.
`disabled`	`boolean`	Optional account status filter: `true` — return only disabled accounts `false` — return only active accounts If omitted, accounts are returned regardless of their status.
`invited`	`boolean`	Optional invitation status filter: `true` — return only pending invitations `false` — return only accepted invitations (activated accounts) If omitted, accounts are returned regardless of their invitation status.
`worker`	`boolean`	Optional account type filter: `true` — return only worker accounts (limited accounts) `false` — return only technician accounts (full-featured accounts) If omitted, accounts are returned regardless of their type.

Response:

Example Response

Response Data

{
    "data": [ {
        "id": 1002,
        "email": "[email protected]",
        "name": "John",
        "surname": "Miller",
        "create_time": 1753695396,
        "mfa": "off",
        "language": "en",
        "owner": false,
        "not_paid": false,
        "worker": false,
        "disabled": false,
        "ldap_user": false,
        "departments": [ {
            "id": 247,
            "name": "Developers"
        } ]
    } ]
}

Name	Type	Description
`id`	`number`	Internal technician account ID.
`email`	`string`	Email address.
`name`	`string`	First name.
`surname`	`string`	Last name.
`create_time`	`number`	Account creation date and time in Unix timestamp format.
`timezone`	`number`	Time zone ID. See the full list of supported time zones below.
`dateformat`	`number`	Preferred date format: `0` — `DD.MM.YYYY` `1` — `YYYY.MM.DD` `2` — `MM/DD/YYYY`
`mfa`	`string`	Two-factor authentication method: `off` — Two-factor authentication is disabled `email` — Email `telegram` — Telegram `google` — Authenticator app (Google Authenticator or compatible apps)
`language`	`string`	Two-letter interface language code (ISO 639-1).
`country`	`string`	Two-letter country code (ISO 3166-1 alpha-2).
`owner`	`boolean`	Team owner flag: `true` — Primary team owner account `false` — Regular technician account
`worker`	`boolean`	Worker account flag: `true` — Worker account (limited account) `false` — Technician account (full-featured account)
`disabled`	`boolean`	Indicates whether the technician account is disabled.
`ldap_user`	`boolean`	Indicates whether the account was imported from LDAP. Learn more in the Integration with Active Directory guide.
`not_paid`	`boolean`	Indicates that the account exceeds the number of licensed technician accounts.
`departments`	`object`	Departments the technician belongs to. This array may be empty.
`departments[].id`	`number`	Internal department ID.
`departments[].name`	`string`	Department name.

Update Technician or Invitation¶

You can update a technician account or a pending invitation using the team/member/update method.

Request:

HTTPcURL

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

{
  "email": <string>,
  "name": <string>,
  "surname": <string>,
  "language": <string>,
  "timezone": <number>,
  "country": <string>,
  "dateformat": <number>,
  "disabled": <boolean>
}

curl -X POST "https://api.getscreen.me/v1/team/member/update" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "email": <string>,
    "name": <string>,
    "surname": <string>,
    "language": <string>,
    "timezone": <number>,
    "country": <string>,
    "dateformat": <number>,
    "disabled": <boolean>
  }'

Parameter	Type	Description
`email`	`string`	Email address of the technician account or pending invitation.
`name`	`string`	First name.
`surname`	`string`	Last name.
`language`	`string`	Two-letter interface language code (ISO 639-1).
`timezone`	`number`	Time zone ID. See the full list of supported time zones below.
`country`	`string`	Two-letter country code (ISO 3166-1 alpha-2).
`dateformat`	`number`	Preferred date format: `0` — `DD.MM.YYYY` `1` — `YYYY.MM.DD` `2` — `MM/DD/YYYY`
`disabled`	`boolean`	Whether the technician account is disabled.

Response:

Example Response

Response Data

{
    "status": 0
}

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

Delete Technician or Invitation¶

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

Request:

HTTPcURL

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

{
  "email": <string>
}

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

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

Response:

Example Response

Response Data

{
    "status": 0
}

Name	Type	Description
`status`	`number`	Result status. Possible values: `0` — Technician account or invitation deleted successfully `1` — Invalid request data `8` — Insufficient permissions

Access Control¶

Permissions List¶

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

Request:

HTTPcURL

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

curl -G "https://api.getscreen.me/v1/team/member/role/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,
            "name": "group_admin",
            "type": "group",
            "default": true,
            "group_id": 1001
        }, {
            "id": 2002,
            "name": "agent_admin",
            "type": "agent",
            "default": true,
            "agent_id": 1002
        }, {
            "id": 2003,
            "name": "permanent_access",
            "type": "team",
            "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[].name`	`string`	Role name.
`roles[].type`	`string`	Role scope: `agent`, `group` — Access to devices in Permanent Access `quick_support` — Access to Quick Support sessions `team` — Access to Team settings
`roles[].default`	`boolean`	Indicates whether the role is a system role: `true` — System role `false` — Custom role
`roles[].agent_id`	`number`	Internal ID of the device to which the permission applies. Present only when `type` is `agent`.
`roles[].group_id`	`number`	Internal ID of the device group to which the permission applies. Present only when `type` is `group`.

Add Permission¶

You can assign a permission for Permanent Access devices, Quick Support sessions, or other Team features using the team/member/role/add method.

Request:

HTTPcURL

POST /v1/team/member/role/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/role/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

Delete Permission¶

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

Request:

HTTPcURL

POST /v1/team/member/role/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/role/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

Role Management¶

Role List¶

Retrieve a list of all roles available for configuring access permissions using the /team/role/list endpoint.

Request:

HTTPcURL

GET /v1/team/role/list
  ?search=<string>
  &type=<string>
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

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

Parameter	Type	Description
`search`	`string`	Case-insensitive filter by role name.
`type`	`string`	Role type. See the available values in the reference below.

Response:

Example Response

Response Data

{
    "data": [ {
        "id": 1001,
        "name": "Auditor",
        "type": "agent",
        "permission": [
            "agent_connect",
            "agent_control"
        ],
        "default": false
    } ]
}

Name	Type	Description
`id`	`number`	Internal system identifier of the role.
`name`	`string`	Role name.
`type`	`string`	Role type. See the available values in the reference below.
`permission[]`	`array`	List of permissions. See the available values in the reference below.
`default`	`boolean`	Indicates whether this is a system role.

Create Role¶

Create a custom role using the /team/role/create endpoint.

Request:

HTTPcURL

POST /v1/team/role/create
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

{
  "name": <string>,
  "description": <string>,
  "type": <string>,
  "permission": [ <string>, ... ]
}

curl -X POST "https://api.getscreen.me/v1/team/role/create" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "name": <string>,
    "description": <string>,
    "type": <string>,
    "permission": [ <string>, ... ]
  }'

Parameter	Type	Description
`name`	`string`	Name of the new role.
`description`	`string`	Role description.
`type`	`string`	Role type. See the available values in the reference below.
`permission`	`array`	List of permissions. See the available values in the reference below.

Response:

Example Response

Response Data

{
    "status": 0
}

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

Edit Role¶

Update an existing custom role using the /team/role/edit endpoint.

Request:

HTTPcURL

POST /v1/team/role/edit
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

{
  "id": <number>,
  "name": <string>,
  "description": <string>,
  "permission": [ <string>, ... ]
}

curl -X POST "https://api.getscreen.me/v1/team/role/edit" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>,
    "name": <string>,
    "description": <string>,
    "permission": [ <string>, ... ]
  }'

Parameter	Type	Description
`id`	`number`	Identifier of the role to update.
`name`	`string`	New role name.
`description`	`string`	Role description.
`permission`	`array`	List of permissions. See the available values in the reference below.

Response:

Example Response

Response Data

{
    "status": 0
}

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

Remove Role¶

Delete an existing custom role using the /team/role/remove endpoint.

Request:

HTTPcURL

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

{
  "id": <number>
}

curl -X POST "https://api.getscreen.me/v1/team/role/remove" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>
  }'

Parameter	Type	Description
`id`	`number`	Identifier of the custom role to delete.

Response:

Example Response

Response Data

{
    "status": 0
}

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

Available Value Lists¶

Timezones¶

The time zone in a technician account profile is stored as a numeric identifier. The table below lists all supported values.

Timezone ID	Region	Offset
`0`	Africa/Abidjan	+00:00
`1`	Africa/Accra	+00:00
`2`	Africa/Addis Ababa	+03:00
`3`	Africa/Algiers	+01:00
`4`	Africa/Asmara	+03:00
`5`	Africa/Bamako	+00:00
`6`	Africa/Bangui	+01:00
`7`	Africa/Banjul	+00:00
`8`	Africa/Bissau	+00:00
`9`	Africa/Blantyre	+02:00
`10`	Africa/Brazzaville	+01:00
`11`	Africa/Bujumbura	+02:00
`12`	Africa/Cairo	+02:00
`13`	Africa/Casablanca	+01:00
`14`	Africa/Ceuta	+01:00
`15`	Africa/Conakry	+00:00
`16`	Africa/Dakar	+00:00
`17`	Africa/Dar es Salaam	+03:00
`18`	Africa/Djibouti	+03:00
`19`	Africa/Douala	+01:00
`20`	Africa/El Aaiun	+00:00
`21`	Africa/Freetown	+00:00
`22`	Africa/Gaborone	+02:00
`23`	Africa/Harare	+02:00
`24`	Africa/Johannesburg	+02:00
`25`	Africa/Juba	+03:00
`26`	Africa/Kampala	+03:00
`27`	Africa/Khartoum	+02:00
`28`	Africa/Kigali	+02:00
`29`	Africa/Kinshasa	+01:00
`30`	Africa/Lagos	+01:00
`31`	Africa/Libreville	+01:00
`32`	Africa/Lome	+00:00
`33`	Africa/Luanda	+01:00
`34`	Africa/Lubumbashi	+02:00
`35`	Africa/Lusaka	+02:00
`36`	Africa/Malabo	+01:00
`37`	Africa/Maputo	+02:00
`38`	Africa/Maseru	+02:00
`39`	Africa/Mbabane	+02:00
`40`	Africa/Mogadishu	+03:00
`41`	Africa/Monrovia	+00:00
`42`	Africa/Nairobi	+03:00
`43`	Africa/Ndjamena	+01:00
`44`	Africa/Niamey	+01:00
`45`	Africa/Nouakchott	+00:00
`46`	Africa/Ouagadougou	+00:00
`47`	Africa/Porto-Novo	+01:00
`48`	Africa/Sao Tome	+01:00
`49`	Africa/Timbuktu	+00:00
`50`	Africa/Tripoli	+02:00
`51`	Africa/Tunis	+01:00
`52`	Africa/Windhoek	+02:00
`53`	America/Adak	-10:00
`54`	America/Anchorage	-09:00
`55`	America/Anguilla	-04:00
`56`	America/Antigua	-04:00
`57`	America/Araguaina	-03:00
`58`	America/Argentina/Buenos Aires	-03:00
`59`	America/Argentina/Catamarca	-03:00
`60`	America/Argentina/ComodRivadavia	-03:00
`61`	America/Argentina/Cordoba	-03:00
`62`	America/Argentina/Jujuy	-03:00
`63`	America/Argentina/La Rioja	-03:00
`64`	America/Argentina/Mendoza	-03:00
`65`	America/Argentina/Rio Gallegos	-03:00
`66`	America/Argentina/Salta	-03:00
`67`	America/Argentina/San Juan	-03:00
`68`	America/Argentina/San Luis	-03:00
`69`	America/Argentina/Tucuman	-03:00
`70`	America/Argentina/Ushuaia	-03:00
`71`	America/Aruba	-04:00
`72`	America/Asuncion	-04:00
`73`	America/Atikokan	-05:00
`74`	America/Atka	-10:00
`75`	America/Bahia	-03:00
`76`	America/Bahia Banderas	-06:00
`77`	America/Barbados	-04:00
`78`	America/Belem	-03:00
`79`	America/Belize	-06:00
`80`	America/Blanc-Sablon	-04:00
`81`	America/Boa Vista	-04:00
`82`	America/Bogota	-05:00
`83`	America/Boise	-07:00
`84`	America/Buenos Aires	-03:00
`85`	America/Cambridge Bay	-07:00
`86`	America/Campo Grande	-04:00
`87`	America/Cancun	-05:00
`88`	America/Caracas	-04:00
`89`	America/Catamarca	-03:00
`90`	America/Cayenne	-03:00
`91`	America/Cayman	-05:00
`92`	America/Chicago	-06:00
`93`	America/Chihuahua	-07:00
`94`	America/Coral Harbour	-05:00
`95`	America/Cordoba	-03:00
`96`	America/Costa Rica	-06:00
`97`	America/Creston	-07:00
`98`	America/Cuiaba	-04:00
`99`	America/Curacao	-04:00
`100`	America/Danmarkshavn	+00:00
`101`	America/Dawson	-08:00
`102`	America/Dawson Creek	-07:00
`103`	America/Denver	-07:00
`104`	America/Detroit	-05:00
`105`	America/Dominica	-04:00
`106`	America/Edmonton	-07:00
`107`	America/Eirunepe	-05:00
`108`	America/El Salvador	-06:00
`109`	America/Ensenada	-08:00
`110`	America/Fort Nelson	-07:00
`111`	America/Fort Wayne	-05:00
`112`	America/Fortaleza	-03:00
`113`	America/Glace Bay	-04:00
`114`	America/Godthab	-03:00
`115`	America/Goose Bay	-04:00
`116`	America/Grand Turk	-05:00
`117`	America/Grenada	-04:00
`118`	America/Guadeloupe	-04:00
`119`	America/Guatemala	-06:00
`120`	America/Guayaquil	-05:00
`121`	America/Guyana	-04:00
`122`	America/Halifax	-04:00
`123`	America/Havana	-05:00
`124`	America/Hermosillo	-07:00
`125`	America/Indiana/Indianapolis	-05:00
`126`	America/Indiana/Knox	-06:00
`127`	America/Indiana/Marengo	-05:00
`128`	America/Indiana/Petersburg	-05:00
`129`	America/Indiana/Tell City	-06:00
`130`	America/Indiana/Vevay	-05:00
`131`	America/Indiana/Vincennes	-05:00
`132`	America/Indiana/Winamac	-05:00
`133`	America/Indianapolis	-05:00
`134`	America/Inuvik	-07:00
`135`	America/Iqaluit	-05:00
`136`	America/Jamaica	-05:00
`137`	America/Jujuy	-03:00
`138`	America/Juneau	-09:00
`139`	America/Kentucky/Louisville	-05:00
`140`	America/Kentucky/Monticello	-05:00
`141`	America/Knox IN	-06:00
`142`	America/Kralendijk	-04:00
`143`	America/La Paz	-04:00
`144`	America/Lima	-05:00
`145`	America/Los Angeles	-08:00
`146`	America/Louisville	-05:00
`147`	America/Lower Princes	-04:00
`148`	America/Maceio	-03:00
`149`	America/Managua	-06:00
`150`	America/Manaus	-04:00
`151`	America/Marigot	-04:00
`152`	America/Martinique	-04:00
`153`	America/Matamoros	-06:00
`154`	America/Mazatlan	-07:00
`155`	America/Mendoza	-03:00
`156`	America/Menominee	-06:00
`157`	America/Merida	-06:00
`158`	America/Metlakatla	-09:00
`159`	America/Mexico City	-06:00
`160`	America/Miquelon	-03:00
`161`	America/Moncton	-04:00
`162`	America/Monterrey	-06:00
`163`	America/Montevideo	-03:00
`164`	America/Montreal	-05:00
`165`	America/Montserrat	-04:00
`166`	America/Nassau	-05:00
`167`	America/New York	-05:00
`168`	America/Nipigon	-05:00
`169`	America/Nome	-09:00
`170`	America/Noronha	-02:00
`171`	America/North Dakota/Beulah	-06:00
`172`	America/North Dakota/Center	-06:00
`173`	America/North Dakota/New Salem	-06:00
`174`	America/Ojinaga	-07:00
`175`	America/Panama	-05:00
`176`	America/Pangnirtung	-05:00
`177`	America/Paramaribo	-03:00
`178`	America/Phoenix	-07:00
`179`	America/Port-au-Prince	-05:00
`180`	America/Port of Spain	-04:00
`181`	America/Porto Acre	-05:00
`182`	America/Porto Velho	-04:00
`183`	America/Puerto Rico	-04:00
`184`	America/Punta Arenas	-03:00
`185`	America/Rainy River	-06:00
`186`	America/Rankin Inlet	-06:00
`187`	America/Recife	-03:00
`188`	America/Regina	-06:00
`189`	America/Resolute	-06:00
`190`	America/Rio Branco	-05:00
`191`	America/Rosario	-03:00
`192`	America/Santa Isabel	-08:00
`193`	America/Santarem	-03:00
`194`	America/Santiago	-04:00
`195`	America/Santo Domingo	-04:00
`196`	America/Sao Paulo	-03:00
`197`	America/Scoresbysund	-01:00
`198`	America/Shiprock	-07:00
`199`	America/Sitka	-09:00
`200`	America/St Barthelemy	-04:00
`201`	America/St Johns	-03:30
`202`	America/St Kitts	-04:00
`203`	America/St Lucia	-04:00
`204`	America/St Thomas	-04:00
`205`	America/St Vincent	-04:00
`206`	America/Swift Current	-06:00
`207`	America/Tegucigalpa	-06:00
`208`	America/Thule	-04:00
`209`	America/Thunder Bay	-05:00
`210`	America/Tijuana	-08:00
`211`	America/Toronto	-05:00
`212`	America/Tortola	-04:00
`213`	America/Vancouver	-08:00
`214`	America/Virgin	-04:00
`215`	America/Whitehorse	-08:00
`216`	America/Winnipeg	-06:00
`217`	America/Yakutat	-09:00
`218`	America/Yellowknife	-07:00
`219`	Antarctica/Casey	+11:00
`220`	Antarctica/Davis	+07:00
`221`	Antarctica/DumontDUrville	+10:00
`222`	Antarctica/Macquarie	+11:00
`223`	Antarctica/Mawson	+05:00
`224`	Antarctica/McMurdo	+12:00
`225`	Antarctica/Palmer	-03:00
`226`	Antarctica/Rothera	-03:00
`227`	Antarctica/South Pole	+12:00
`228`	Antarctica/Syowa	+03:00
`229`	Antarctica/Troll	+00:00
`230`	Antarctica/Vostok	+06:00
`231`	Arctic/Longyearbyen	+01:00
`232`	Asia/Aden	+03:00
`233`	Asia/Almaty	+06:00
`234`	Asia/Amman	+02:00
`235`	Asia/Anadyr	+12:00
`236`	Asia/Aqtau	+05:00
`237`	Asia/Aqtobe	+05:00
`238`	Asia/Ashgabat	+05:00
`239`	Asia/Ashkhabad	+05:00
`240`	Asia/Atyrau	+05:00
`241`	Asia/Baghdad	+03:00
`242`	Asia/Bahrain	+03:00
`243`	Asia/Baku	+04:00
`244`	Asia/Bangkok	+07:00
`245`	Asia/Barnaul	+07:00
`246`	Asia/Beirut	+02:00
`247`	Asia/Bishkek	+06:00
`248`	Asia/Brunei	+08:00
`249`	Asia/Calcutta	+05:30
`250`	Asia/Chita	+09:00
`251`	Asia/Choibalsan	+08:00
`252`	Asia/Chongqing	+08:00
`253`	Asia/Chungking	+08:00
`254`	Asia/Colombo	+05:30
`255`	Asia/Dacca	+06:00
`256`	Asia/Damascus	+02:00
`257`	Asia/Dhaka	+06:00
`258`	Asia/Dili	+09:00
`259`	Asia/Dubai	+04:00
`260`	Asia/Dushanbe	+05:00
`261`	Asia/Famagusta	+02:00
`262`	Asia/Gaza	+02:00
`263`	Asia/Harbin	+08:00
`264`	Asia/Hebron	+02:00
`265`	Asia/Ho Chi Minh	+07:00
`266`	Asia/Hong Kong	+08:00
`267`	Asia/Hovd	+07:00
`268`	Asia/Irkutsk	+08:00
`269`	Asia/Istanbul	+03:00
`270`	Asia/Jakarta	+07:00
`271`	Asia/Jayapura	+09:00
`272`	Asia/Jerusalem	+02:00
`273`	Asia/Kabul	+04:30
`274`	Asia/Kamchatka	+12:00
`275`	Asia/Karachi	+05:00
`276`	Asia/Kashgar	+06:00
`277`	Asia/Kathmandu	+05:45
`278`	Asia/Katmandu	+05:45
`279`	Asia/Khandyga	+09:00
`280`	Asia/Kolkata	+05:30
`281`	Asia/Krasnoyarsk	+07:00
`282`	Asia/Kuala Lumpur	+08:00
`283`	Asia/Kuching	+08:00
`284`	Asia/Kuwait	+03:00
`285`	Asia/Macao	+08:00
`286`	Asia/Macau	+08:00
`287`	Asia/Magadan	+11:00
`288`	Asia/Makassar	+08:00
`289`	Asia/Manila	+08:00
`290`	Asia/Muscat	+04:00
`291`	Asia/Nicosia	+02:00
`292`	Asia/Novokuznetsk	+07:00
`293`	Asia/Novosibirsk	+07:00
`294`	Asia/Omsk	+06:00
`295`	Asia/Oral	+05:00
`296`	Asia/Phnom Penh	+07:00
`297`	Asia/Pontianak	+07:00
`298`	Asia/Pyongyang	+09:00
`299`	Asia/Qatar	+03:00
`300`	Asia/Qyzylorda	+05:00
`301`	Asia/Rangoon	+06:30
`302`	Asia/Riyadh	+03:00
`303`	Asia/Saigon	+07:00
`304`	Asia/Sakhalin	+11:00
`305`	Asia/Samarkand	+05:00
`306`	Asia/Seoul	+09:00
`307`	Asia/Shanghai	+08:00
`308`	Asia/Singapore	+08:00
`309`	Asia/Srednekolymsk	+11:00
`310`	Asia/Taipei	+08:00
`311`	Asia/Tashkent	+05:00
`312`	Asia/Tbilisi	+04:00
`313`	Asia/Tehran	+03:30
`314`	Asia/Tel Aviv	+02:00
`315`	Asia/Thimbu	+06:00
`316`	Asia/Thimphu	+06:00
`317`	Asia/Tokyo	+09:00
`318`	Asia/Tomsk	+07:00
`319`	Asia/Ujung Pandang	+08:00
`320`	Asia/Ulaanbaatar	+08:00
`321`	Asia/Ulan Bator	+08:00
`322`	Asia/Urumqi	+06:00
`323`	Asia/Ust-Nera	+10:00
`324`	Asia/Vientiane	+07:00
`325`	Asia/Vladivostok	+10:00
`326`	Asia/Yakutsk	+09:00
`327`	Asia/Yangon	+06:30
`328`	Asia/Yekaterinburg	+05:00
`329`	Asia/Yerevan	+04:00
`330`	Atlantic/Azores	-01:00
`331`	Atlantic/Bermuda	-04:00
`332`	Atlantic/Canary	+00:00
`333`	Atlantic/Cape Verde	-01:00
`334`	Atlantic/Faeroe	+00:00
`335`	Atlantic/Faroe	+00:00
`336`	Atlantic/Jan Mayen	+01:00
`337`	Atlantic/Madeira	+00:00
`338`	Atlantic/Reykjavik	+00:00
`339`	Atlantic/South Georgia	-02:00
`340`	Atlantic/St Helena	+00:00
`341`	Atlantic/Stanley	-03:00
`342`	Australia/Adelaide	+09:30
`343`	Australia/Brisbane	+10:00
`344`	Australia/Broken Hill	+09:30
`345`	Australia/Canberra	+10:00
`346`	Australia/Currie	+10:00
`347`	Australia/Darwin	+09:30
`348`	Australia/Eucla	+08:45
`349`	Australia/Hobart	+10:00
`350`	Australia/Lindeman	+10:00
`351`	Australia/Lord Howe	+10:30
`352`	Australia/Melbourne	+10:00
`353`	Australia/Perth	+08:00
`354`	Australia/Sydney	+10:00
`355`	Australia/Yancowinna	+09:30
`356`	Etc/GMT	+00:00
`357`	Etc/GMT+0	+00:00
`358`	Etc/GMT+1	-01:00
`359`	Etc/GMT+10	-10:00
`360`	Etc/GMT+11	-11:00
`361`	Etc/GMT+12	-12:00
`362`	Etc/GMT+2	-02:00
`363`	Etc/GMT+3	-03:00
`364`	Etc/GMT+4	-04:00
`365`	Etc/GMT+5	-05:00
`366`	Etc/GMT+6	-06:00
`367`	Etc/GMT+7	-07:00
`368`	Etc/GMT+8	-08:00
`369`	Etc/GMT+9	-09:00
`370`	Etc/GMT-0	+00:00
`371`	Etc/GMT-1	+01:00
`372`	Etc/GMT-10	+10:00
`373`	Etc/GMT-11	+11:00
`374`	Etc/GMT-12	+12:00
`375`	Etc/GMT-13	+13:00
`376`	Etc/GMT-14	+14:00
`377`	Etc/GMT-2	+02:00
`378`	Etc/GMT-3	+03:00
`379`	Etc/GMT-4	+04:00
`380`	Etc/GMT-5	+05:00
`381`	Etc/GMT-6	+06:00
`382`	Etc/GMT-7	+07:00
`383`	Etc/GMT-8	+08:00
`384`	Etc/GMT-9	+09:00
`385`	Etc/GMT0	+00:00
`386`	Etc/UTC	+00:00
`387`	Europe/Amsterdam	+01:00
`388`	Europe/Andorra	+01:00
`389`	Europe/Astrakhan	+04:00
`390`	Europe/Athens	+02:00
`391`	Europe/Belfast	+00:00
`392`	Europe/Belgrade	+01:00
`393`	Europe/Berlin	+01:00
`394`	Europe/Bratislava	+01:00
`395`	Europe/Brussels	+01:00
`396`	Europe/Bucharest	+02:00
`397`	Europe/Budapest	+01:00
`398`	Europe/Busingen	+01:00
`399`	Europe/Chisinau	+02:00
`400`	Europe/Copenhagen	+01:00
`401`	Europe/Dublin	+00:00
`402`	Europe/Gibraltar	+01:00
`403`	Europe/Guernsey	+00:00
`404`	Europe/Helsinki	+02:00
`405`	Europe/Isle of Man	+00:00
`406`	Europe/Istanbul	+03:00
`407`	Europe/Jersey	+00:00
`408`	Europe/Kaliningrad	+02:00
`409`	Europe/Kiev	+02:00
`410`	Europe/Kirov	+03:00
`411`	Europe/Lisbon	+00:00
`412`	Europe/Ljubljana	+01:00
`413`	Europe/London	+00:00
`414`	Europe/Luxembourg	+01:00
`415`	Europe/Madrid	+01:00
`416`	Europe/Malta	+01:00
`417`	Europe/Mariehamn	+02:00
`418`	Europe/Minsk	+03:00
`419`	Europe/Monaco	+01:00
`420`	Europe/Moscow	+03:00
`421`	Europe/Oslo	+01:00
`422`	Europe/Paris	+01:00
`423`	Europe/Podgorica	+01:00
`424`	Europe/Prague	+01:00
`425`	Europe/Riga	+02:00
`426`	Europe/Rome	+01:00
`427`	Europe/Samara	+04:00
`428`	Europe/San Marino	+01:00
`429`	Europe/Sarajevo	+01:00
`430`	Europe/Saratov	+04:00
`431`	Europe/Simferopol	+03:00
`432`	Europe/Skopje	+01:00
`433`	Europe/Sofia	+02:00
`434`	Europe/Stockholm	+01:00
`435`	Europe/Tallinn	+02:00
`436`	Europe/Tirane	+01:00
`437`	Europe/Tiraspol	+02:00
`438`	Europe/Ulyanovsk	+04:00
`439`	Europe/Uzhgorod	+02:00
`440`	Europe/Vaduz	+01:00
`441`	Europe/Vatican	+01:00
`442`	Europe/Vienna	+01:00
`443`	Europe/Vilnius	+02:00
`444`	Europe/Volgograd	+04:00
`445`	Europe/Warsaw	+01:00
`446`	Europe/Zagreb	+01:00
`447`	Europe/Zaporozhye	+02:00
`448`	Europe/Zurich	+01:00
`449`	GMT	+00:00
`450`	Indian/Antananarivo	+03:00
`451`	Indian/Chagos	+06:00
`452`	Indian/Christmas	+07:00
`453`	Indian/Cocos	+06:30
`454`	Indian/Comoro	+03:00
`455`	Indian/Kerguelen	+05:00
`456`	Indian/Mahe	+04:00
`457`	Indian/Maldives	+05:00
`458`	Indian/Mauritius	+04:00
`459`	Indian/Mayotte	+03:00
`460`	Indian/Reunion	+04:00
`461`	Pacific/Apia	+13:00
`462`	Pacific/Auckland	+12:00
`463`	Pacific/Bougainville	+11:00
`464`	Pacific/Chatham	+12:45
`465`	Pacific/Chuuk	+10:00
`466`	Pacific/Easter	-06:00
`467`	Pacific/Efate	+11:00
`468`	Pacific/Enderbury	+13:00
`469`	Pacific/Fakaofo	+13:00
`470`	Pacific/Fiji	+12:00
`471`	Pacific/Funafuti	+12:00
`472`	Pacific/Galapagos	-06:00
`473`	Pacific/Gambier	-09:00
`474`	Pacific/Guadalcanal	+11:00
`475`	Pacific/Guam	+10:00
`476`	Pacific/Honolulu	-10:00
`477`	Pacific/Johnston	-10:00
`478`	Pacific/Kiritimati	+14:00
`479`	Pacific/Kosrae	+11:00
`480`	Pacific/Kwajalein	+12:00
`481`	Pacific/Majuro	+12:00
`482`	Pacific/Marquesas	-09:30
`483`	Pacific/Midway	-11:00
`484`	Pacific/Nauru	+12:00
`485`	Pacific/Niue	-11:00
`486`	Pacific/Norfolk	+11:00
`487`	Pacific/Noumea	+11:00
`488`	Pacific/Pago Pago	-11:00
`489`	Pacific/Palau	+09:00
`490`	Pacific/Pitcairn	-08:00
`491`	Pacific/Pohnpei	+11:00
`492`	Pacific/Ponape	+11:00
`493`	Pacific/Port Moresby	+10:00
`494`	Pacific/Rarotonga	-10:00
`495`	Pacific/Saipan	+10:00
`496`	Pacific/Samoa	-11:00
`497`	Pacific/Tahiti	-10:00
`498`	Pacific/Tarawa	+12:00
`499`	Pacific/Tongatapu	+13:00
`500`	Pacific/Truk	+10:00
`501`	Pacific/Wake	+12:00
`502`	Pacific/Wallis	+12:00
`503`	Pacific/Yap	+10:00
`504`	UTC	+00:00

Role Assignment¶

Roles are grouped into three categories based on their purpose. The available permissions depend on the role type.

Name	Identifier	Purpose
Devices and Groups	`agent` or `group`	Manage devices in Permanent Access.
Invitations	`quick_support`	Manage invitations in Quick Support.
Administration	`team`	Administer the Team account and its settings.

Role Permissions¶

Permissions define the functions allowed for a specific role. They depend on the chosen purpose.

Devices and GroupsInvitationsAdministration

Name	ID	Description
Actions		Available connection modes to the device
Screen View	`agent_connect`	Allows connecting to the device’s screen in view-only mode
Screen Control	`agent_control`	Allows controlling the device’s screen using the mouse and keyboard
File Manager	`agent_file_transfer`	Allows access to the device’s file system
Terminal Mode	`agent_terminal_mode`	Allows terminal-mode access to the device
Wake Up	`agent_wake_on_lan`	Allows waking the device via Wake-on-LAN
Reboot	`agent_reboot`	Allows rebooting the remote device
Lock/Unlock	`agent_lock_screen`	Allows locking the remote OS account
Session options		Features available during a remote session
No Confirmation	`agent_no_confirm`	Allows connecting without requesting confirmation from the remote user Works only when connecting to devices for which connection approval requirements are configured through group settings.
Calls	`agent_audio_calls`	Allows making calls
Black Screen and Input Lock	`agent_lock_input`	Allows blocking the screen and input devices
Chat	`agent_chat`	Allows sending text messages
Sync Clipboard	`agent_clipboard`	Allows syncing the clipboard
Other options		Other system functions applicable to devices
Screen Preview	`agent_preview`	Allows screen video preview in the device list
Connection History	`agent_sessions`	Allows access to connection history
Software Inventory	`agent_program_list`	Allows access to installed software information
Modify Notifications	`agent_notification`	Allows managing notifications
Video Recording Delete	`agent_remove_video`	Allows deleting video recordings
Device Modify	`agent_change_settings`	Allows editing device properties
Device Delete	`agent_logout`	Allows deleting devices

Name	ID	Description
Access to Invitations		Which invitations are accessible
Own Invitations	`quick_support_admin`	Allows access only to one’s own invitations
All Invitations	`quick_support_technical`	Allows access to all team invitations
Actions		Available connection modes
Screen View	`agent_connect`	Allows connecting in screen view mode
Screen Control	`agent_control`	Allows controlling the screen using mouse and keyboard
File Manager	`agent_file_transfer`	Allows access to the file system
Terminal Mode	`agent_terminal_mode`	Allows terminal-mode connection
Session options		Features available during a connection
Calls	`agent_audio_calls`	Allows making calls
Chat	`agent_chat`	Allows sending text messages
Reboot	`agent_reboot`	Allows rebooting the device
Installation Request	`agent_app_install_request`	Allows sending a request to install the agent application application
Sync Clipboard	`agent_clipboard`	Allows syncing the clipboard
Other options		Other functions
Screen Preview	`agent_preview`	Allows screen video preview in the list
Video Recording Delete	`agent_remove_video`	Allows deleting session recordings

Name	ID	Description
Administrator functions		Administration features
Audit Log	`team_security_log_admin`	Allows access to team-wide audit logs
Technicians and Team Settings	`team_user_admin`	Allows managing technicians and team settings
Branding Settings	`team_brand_admin`	Allows access to branding settings
Billing Settings	`team_billing_admin`	Allows managing billing
API Settings	`team_api_key`	Allows managing API keys.
Other		Other features
Permanent Access	`team_permanent_access`	Grants access to the Permanent Access section. Normally this section appears if the user has rights to at least one device or group, but in some cases it may not be visible. This permission explicitly enables access to this section, for example to add a new device.