Granular Permissions Guide

To set up the OAuth client for sourcing conversations via the Genesys Cloud API, follow the steps outlined below. Ensure you have an Authenticx-specific role with the necessary permissions assigned to the appropriate divisions containing the queues you need to source.

OAuth Configuration

1. From the main menu, navigate to IT And Integrations > OAuth
2. Create an OAuth client in Genesys Cloud with the Client Credentials grant type for conversation sourcing.
3. Be sure to save the Client ID and Client Secret. Copy these immediately and store them securely - Genesys will not show you the Client Secret again after you navigate away.

Genesys API Endpoints and Role Permissions Required

To create or edit a role, from the main menu navigate to User Management > Roles and Permissions.

1. Conversations API

• Get /api/v2/Conversations

  • Required Permission:
    • Conversation > Communication > View

• Post /api/v2/Analytics/Conversations/Details

  • Required Permissions:
    • Analytics > Conversation Detail > View
    • Analytics > Agent Conversation Detail > View

2. Recording API

• Get /api/v2/conversations/{conversationId}/recordings

• Post /api/v2/recording/batchrequests

• Get /api/v2/recording/batchrequests/{jobId}

  • Required Permissions:
    • Recording > Annotation > View
    • Recording > Recording > View
    • Recording > Recording > ViewSensitiveData
    • Recording > Recording Segment > View
    • Recording > Screen Recording > View

3. Web Messenger API (If Applicable)

• Get /api/v2/conversations/messages/{conversationId}

• Get /api/v2/conversations/messages/{conversationId}/messages/{messageId}

  • Required Permissions:
    • Conversation > Webmessaging > View
    • Conversation > Message > View

4. Users API

• Get /api/v2/users/{userId}

  • Required Permissions:
    • None

5. Routing API

• Get /api/v2/routing/queues

  • Required Permissions:
    • Routing > Queue > View

Role Division Assignment

• Ensure the Authenticx-specific role is granted permissions to the division(s) containing the queues that need to be sourced from Genesys Cloud.
• Ensure that the Authenticx-specific role has been assigned to your user account; you can only assign roles to a client that your user account has also been granted.
• Note: The OAuth client's division scope is determined by the role assigned to it. There is no separate division assignment step during client creation.