Scopes

1 minutes reading time

Scopes define access to certain resources. Your app will ask users for access to those resources during the installation. Depending on the functionality of the app you're building, you'll need to configure different scopes in Developer Console. To check which scopes your app needs, refer to method descriptions.

General rules

  • ro means read only
  • rw means read/write
  • rc means read/create
  • all rw scopes contain ro privileges
  • all access scopes contain my privileges
  • all all scopes contain access privileges and my privileges

Scope types

Agent scopes

ScopeRoleDescription
agents--my:rwnormalWrite permission for my profile configuration
agents--my:ronormalRead permission for my profile configuration
agents--all:rwadministratorWrite permission for all agents profiles configuration
agents--all:roadministratorRead permission for all agents profiles configuration
access_rules:roadministratorRead permission for auto chat scopes configuration
access_rules:rwadministratorRead/write permission for auto chat scopes configuration

Accounts scopes

ScopeRoleDescription
accounts--all:rcnormalPermission for creating, but not managing, new accounts in LiveChat Accounts

Bot scopes

ScopeRoleDescription
agents-bot--my:roadministratorRead permission for bot agents configuration (only my bot agents)
agents-bot--my:rwadministratorRead/write permission for bot agents configuration (only my bot agents)
agents-bot--all:ronormalRead permission for bot agents configuration (all in license)
agents-bot--all:rwadministratorRead/write permission for bot agents configuration (all in license, delete only)

Group scopes

ScopeRoleDescription
groups--my:rwadministratorWrite/read permission for groups I'm a member of
groups--my:ronormalRead permission for groups I'm a member of
groups--all:rwadministratorWrite/read permission for all groups within a license
groups--all:ronormalRead permission for all groups within a license

Chat scopes

ScopeRoleDescription
chats--all:roadministratorRead permission for conversation and meta data of all license chats
chats--access:ronormalRead permission for conversation and meta data of chats with requester access
chats--my:ronormalRead permission for conversation and meta data of the chats with requester presence
chats.conversation--all:rwadministratorWrite permission for conversation data of all license chats and Read permission for conversation and meta data of all license chats (chats--all:ro)
chats.conversation--access:rwnormalWrite permission for conversation data of chats with requester access and Read permission for conversation and meta data of chats with requester access (chats--access:ro)
chats.conversation--my:rwnormalRead/write permission for conversation data of chats with requester presence and Read permission for conversation and meta data of the chats with requester presence (chats--my:ro)
chats--all:rwadministratorRead/write permission for conversation and meta data of all license chats
chats--access:rwnormalRead/write permission for conversation and meta data of chats with requester access
chats--my:rwnormalRead/write permission for conversation and meta data of chats with requester presence
  • chats conversation data applies to:
    • chat events
    • chat properties
    • thread properties
  • chats meta data applies to:
    • chat users

NOTICE: currently chats.conversation--all:rw allows joining chats too because you have to join the chat to be able to write to it

Customer scopes

ScopeRoleDescription
customers.ban:rwnormalPermission for banning customers
customers:ownadministratorPermission for managing customers identities
customers:ronormalRead permission for customers
customers:rwnormalRead/write permission for customers

Multicast scopes

ScopeRoleDescription
multicast:rwnormalPermission for multicast data to agents or customers

Properties scopes

ScopeRoleDescription
properties--my:roadministratorRead permission for chat/thread/events properties configuration (only in my namespace)
properties--my:rwadministratorRead/write permission for chat/thread/events properties configuration (only in my namespace)
properties--all:roadministratorRead permission for chat/thread/events properties configuration (all in license)

Webhook scopes

ScopeRoleDescription
webhooks--my:roadministratorRead permission for webhooks configuration (only my webhooks)
webhooks--my:rwadministratorRead/write permission for webhooks configuration (only my webhooks)
webhooks--all:roadministratorRead permission for webhooks configuration (all in license)
webhooks--all:rwadministratorRead/write permission for webhooks configuration (all in license, delete only)

Accessing chat

This chart shows every possible chats scenarios:

  • chats without my access and without my presence (chats -A -P)
  • chats with my access but without my presence (chats +A -P)
  • chats with my presence but without my access (chats -A +P)
  • chats with my access and with my presence (chats +A +P)

Scopes diagram

The table shows scopes dependency of accessing chat:

chats -A -Pchats +A -Pchats -A +Pchats +A +P
all
access-
my--

Accessing parts of chat

The table shows scopes dependency of accessing chat parts:

meta dataconversation data
chats-*:rwrwrw
chats.conversation-*:rwrorw
chats-*:rororo