Scopes
Introduction
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 onlyrw
means read/writerc
means read/create- all
rw
scopes contain ro
privileges - all
access
scopes contain my
privileges - all
all
scopes contain access
privileges and my
privileges
Accounts scope types
Account scopes
Scope | Product | Role | Role Type | Description |
---|
accounts--my:ro | Accounts | member | primary | Read permission for my account |
accounts--my:rw | Accounts | member | primary | Read and modify permission for my account |
accounts--all:ro | Accounts | member | primary | Read permission for all accounts in an organization |
accounts--all:rw | Accounts | administrator | primary | Read and modify permission for all accounts |
accounts--all:rc | Accounts | member | primary | Create and read accounts (modification is denied) |
Role scopes
Scope | Product | Role | Role Type | Description |
---|
accounts.roles--all:ro | Accounts | member | primary | Read all accounts roles |
Session scopes
Scope | Product | Role | Role Type | Description |
---|
sessions--my:ro | Accounts | member | primary | Read my sessions |
sessions--my:rw | Accounts | member | primary | Read and modify my sessions |
Organization scopes
Scope | Product | Role | Role Type | Description |
---|
organization--my:rw | Accounts | owner | primary | Read and modify organization settings |
LiveChat scope types
Agent scopes
Scope | Product | Role | Role Type | Description |
---|
agents--my:rw | LiveChat | normal | secondary | Write permission for my profile configuration |
agents--my:ro | LiveChat | normal | secondary | Read permission for my profile configuration |
agents--all:rw | LiveChat | administrator | secondary | Write permission for all agents profiles configuration |
agents--all:ro | LiveChat | normal | secondary | Read permission for all agents profiles configuration |
accounts.roles.lc--all:rw | LiveChat | administrator | secondary | Read and modify all account roles within the LiveChat product |
Access rules scopes
Scope | Product | Role | Role Type | Description |
---|
access_rules:ro | LiveChat | administrator | secondary | Read permission for auto chat scopes configuration |
access_rules:rw | LiveChat | administrator | secondary | Read/write permission for auto chat scopes configuration |
Bot scopes
Scope | Product | Role | Role Type | Description |
---|
agents-bot--my:ro | LiveChat | administrator | secondary | Read permission for bot agents configuration (only my bot agents) |
agents-bot--my:rw | LiveChat | administrator | secondary | Read/write permission for bot agents configuration (only my bot agents) |
agents-bot--all:ro | LiveChat | normal | secondary | Read permission for bot agents configuration (all in license) |
agents-bot--all:rw | LiveChat | administrator | secondary | Read/write permission for bot agents configuration (all in license, delete only) |
Group scopes
Scope | Product | Role | Role Type | Description |
---|
groups--my:rw | LiveChat | administrator | secondary | Write/read permission for groups I'm a member of |
groups--my:ro | LiveChat | normal | secondary | Read permission for groups I'm a member of |
groups--all:rw | LiveChat | administrator | secondary | Write/read permission for all groups within a license |
groups--all:ro | LiveChat | normal | secondary | Read permission for all groups within a license |
Chat scopes
Scope | Product | Role | Role Type | Description |
---|
chats--all:ro | LiveChat | administrator | secondary | Read permission for conversation and meta data of all license chats |
chats--access:ro | LiveChat | normal | secondary | Read permission for conversation and meta data of chats with requester access |
chats--all:rw | LiveChat | administrator | secondary | Read/write permission for conversation and meta data of all license chats |
chats--access:rw | LiveChat | normal | secondary | Read/write permission for conversation and meta data of chats with requester access |
- Chats conversation data applies to:
- chat events
- chat properties
- thread properties
- Chats meta data applies to:
Customer scopes
Scope | Product | Role | Role Type | Description |
---|
customers.ban:rw | LiveChat | normal | secondary | Permission for banning customers |
customers:own | LiveChat | administrator | secondary | Permission for owning and managing customer identities. It allows for acquiring a customer token (for both existing and new customers) and using it to call the Customer Chat API as a customer. |
customers:ro | LiveChat | normal | secondary | Read permission for customers |
customers:rw | LiveChat | normal | secondary | Read/write permission for existing customers. It also allows for creating new customers via the Agent Chat API. |
Multicast scopes
Scope | Product | Role | Role Type | Description |
---|
multicast:rw | LiveChat | normal | secondary | Permission for multicast data to agents or customers |
Properties scopes
Scope | Product | Role | Role Type | Description |
---|
properties.license.value--my:rw | Livechat | administrator | secondary | Read/write permission for managing license properties (only my namespace) |
properties.license.value--all:rw | Livechat | administrator | secondary | Read/write permission for managing license properties (in all namespaces but with access only to their public properties) |
properties.group.value--my:rw | Livechat | administrator | secondary | Read/write permission for managing groups properties (only my namespace) |
properties.group.value--all:rw | Livechat | administrator | secondary | Read/write permission for managing groups properties (in all namespaces but with access only to their public properties) |
properties.configuration:rw | LiveChat | administrator | secondary | Read/write permission for license/group/chat/thread/event properties configuration (for all integrations owned by my license) |
Tag scopes
Scope | Product | Role | Role Type | Description |
---|
tags--all:rw | LiveChat | administrator | secondary | Read/write permission for tags configuration (all in license) |
tags--all:ro | LiveChat | not assigned to any role | secondary | Read permission for tags configuration (all in license) |
tags--groups:rw | LiveChat | not assigned to any role | secondary | Read/write permission for tags configuration (in my groups) |
tags--groups:ro | LiveChat | normal | secondary | Read permission for tags configuration (in my groups) |
Webhook scopes
Scope | Product | Role | Role Type | Description |
---|
webhooks--my:ro | LiveChat | administrator | secondary | Read permission for webhooks configuration (only my webhooks) |
webhooks--my:rw | LiveChat | administrator | secondary | Read/write permission for webhooks configuration (only my webhooks) |
webhooks--all:ro | LiveChat | administrator | secondary | Read permission for webhooks configuration (all in license) |
webhooks--all:rw | LiveChat | administrator | secondary | Read/write permission for webhooks configuration (all in license, delete only) |
webhooks.state:ro | LiveChat | administrator | secondary | Read permission for the webhook state (only my webhooks) |
webhooks.state:rw | LiveChat | administrator | secondary | Read/write permission for enabling/disabling webhooks (only my webhooks) |
webhooks.configuration:rw | LiveChat | administrator | secondary | Read/write permission for adding and updating the webhook configuration |
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
)
The table shows scopes dependency of accessing chat:
| chats -A -P | chats +A -P | chats -A +P | chats +A +P |
---|
all | ✓ | ✓ | ✓ | ✓ |
access | - | ✓ | ✓ | ✓ |
my | - | - | ✓ | ✓ |
Accessing parts of chat
The table shows scopes dependency of accessing chat parts:
| meta data | conversation data |
---|
chats-*:rw | rw | rw |
chats.conversation-*:rw | ro | rw |
chats-*:ro | ro | ro |