OAuth Scopes for eGain APIs
The tables below documents the OAuth scopes that gives permission to access specific eGain Product API capabilities.
User Manager APIs
| Permissions | Description | |
|---|---|---|
| Delegated | Application | |
| https://api.egain.cloud/auth/core.usermgr.read | https://api.egain.cloud/auth/app.core.usermgr.read | View users, user groups, roles and permissions |
| https://api.egain.cloud/auth/core.usermgr.manage | https://api.egain.cloud/auth/app.core.usermgr.manage | Manages users, user groups, roles and permissions |
Case Manager APIs
| Permissions | Description | |
|---|---|---|
| Delegated | Application | |
| https://api.egain.cloud/auth/core.casemgr.read | https://api.egain.cloud/auth/app.core.casemgr.read | View cases and activities in the system |
| https://api.egain.cloud/auth/core.casemgr.manage | https://api.egain.cloud/auth/app.core.casemgr.manage | Manages cases and activities in the system |
Work Assignment APIs
| Permissions | Description | |
|---|---|---|
| Delegated | Application | |
| https://api.egain.cloud/auth/core.workassignmentmgr.read | https://api.egain.cloud/auth/app.core.workassignmentmgr.read | View queue and queue Attributes |
| https://api.egain.cloud/auth/core.workassignmentmgr.manage | https://api.egain.cloud/auth/app.core.workassignmentmgr.manage | Manages Queue Availability, Queue Load and Queues (Depth, Priority, and other properties) |
Customer Manager APIs
| Permissions | Description | |
|---|---|---|
| Delegated | Application | |
| https://api.egain.cloud/auth/core.customermgr.read | https://api.egain.cloud/auth/app.core.customermgr.read | View customers and customer context |
| https://api.egain.cloud/auth/core.customermgr.manage | https://api.egain.cloud/auth/app.core.customermgr.maange | Manage customers and customer context |
Information Manager APIs
| Permissions | Description | |
|---|---|---|
| Delegated | Application | |
| https://api.egain.cloud/auth/core.infomgr.read | https://api.egain.cloud/auth/app.core.infomgr.read | View application details |
Micro Services Manager APIs
| Permissions | Description | |
|---|---|---|
| Delegated | Application | |
| https://api.egain.cloud/auth/core.microservicesmgr.shorturls.manage | Use URL Shortening service | |
| https://api.egain.cloud/auth/core.microservicesmgr.zipcode.read | View ZIP Code | |
| https://api.egain.cloud/auth/core.microservicesmgr.lookup.read | Use Phone number look up service | |
| https://api.egain.cloud/auth/core.microservicesmgr.sentiment.read | Use Sentimental Analyzer service |
Secure Messaging APIs
| Permissions | Description | |
|---|---|---|
| Delegated | Application | |
| https://api.egain.cloud/auth/conversation.securemessagingmgr.read | Get issue types for a message center (Context) |
Messaging Router APIs
| Permissions | Description | |
|---|---|---|
| Delegated | Application | |
| https://api.egain.cloud/auth/conversation.messagerouter.read | https://api.egain.cloud/auth/app.conversation.messagerouter.read | View the routing the messages to participants |
Conversation Manager APIs
| Permissions | Description | |
|---|---|---|
| Delegated | Application | |
| https://api.egain.cloud/auth/conversation.conversationmgr.read | View accounts, channels, clientapps, orchestrations and participants | |
| https://api.egain.cloud/auth/conversation.conversationmgr.manage | Manage accounts, channels, clientapps, orchestrations and participants | |
| https://api.egain.cloud/auth/conversation.conversationmgr.interaction.read | View conversation, messages and assets | |
| https://api.egain.cloud/auth/conversation.conversationmgr.interaction.manage | Manage conversations, messages and assets |
Notifcation Manager APIs
| Permissions | Description | |
|---|---|---|
| Delegated | Application | |
| https://api.egain.cloud/auth/conversation.notificationmgr.read | View accounts and templates | |
| https://api.egain.cloud/auth/conversation.notificationmgr.manage | Manage accounts and templates | |
| https://api.egain.cloud/auth/conversation.notificationmgr.interaction.read | View messages, delivery receipts and assets | |
| https://api.egain.cloud/auth/conversation.notificationmgr.interaction.manage | Manage messages, delivery receipts and assets |
Knowledge Portal Manager APIs
| Permissions | Description | |
|---|---|---|
| Delegated | Application | |
| https://api.egain.cloud/auth/knowledge.portalmgr.read | https://api.egain.cloud/auth/app.knowledge.portalmgr.read | View Knowledge Access Objects. |
| https://api.egain.cloud/auth/knowledge.portalmgr.manage | https://api.egain.cloud/auth/app.knowledge.portalmgr.manage | Manages suggestions, guided help search and profile for portal |