Create an OAuth Client

MiraBridge Phone requires an OAuth client to authenticate securely with the Genesys Cloud API.

Step 1: Go to OAuth Settings

  1. In Genesys Cloud, go to Admin > Integrations > OAuth
  2. Click + Add Client

Step 2: Fill in Client Details

  • Client Name:
    Example: MiraBridge Phone

  • Grant Types:
    ✅ Token Implicit Grant (Browser)

  • Redirect URIs:
    Include the following URIs, replacing {REGION} with your Genesys Cloud region domain:

https://phone.mirabridge.cloud
https://apps.{REGION}/crm/index.html
https://apps.{REGION}/crm/authWindow.html

Example for Frankfurt (mypurecloud.de):

https://phone.mirabridge.cloud
https://apps.mypurecloud.de/crm/index.html
https://apps.mypurecloud.de/crm/authWindow.html
  • Scopes:
    • conversations:readonly

Step 3: Save and Copy Client ID

Click Save, then copy the Client ID.
You’ll need this value when constructing your MiraBridge widget URL.

🔗 For more details, see the official guide:
Create an OAuth Client

Verification and Testing

Test OAuth Configuration

To verify your OAuth client is configured correctly:

  1. Construct a test URL with your Client ID: 
    https://phone.mirabridge.cloud/api/v1/deployment/main/init?region=mypurecloud.de&clientId=YOUR_CLIENT_ID&enableDebug=true
  2. Open the URL in a browser and verify:
    • The page loads without errors
    • Authentication redirects work properly
    • No OAuth-related errors appear in the browser console

Common OAuth Issues

Problem: “Invalid redirect URI” error

  • Solution: Verify redirect URIs exactly match the format shown above
  • Check: Ensure no extra spaces or characters in the URI list

Problem: “Invalid client” error

  • Solution: Confirm the Client ID is copied correctly
  • Check: Verify the client is saved and active in Genesys Cloud

Problem: Authentication loop or timeout

  • Solution: Check that popup blockers are disabled
  • Verify: Confirm the correct Genesys Cloud region is specified

Security Considerations

OAuth Best Practices

  • Principle of Least Privilege: Only assign necessary scopes
  • Regular Review: Periodically audit OAuth clients and their usage
  • Monitoring: Monitor OAuth client usage through Genesys Cloud logs
  • Documentation: Keep records of OAuth client purposes and configurations

Required Scopes

Currently, MiraBridge Phone requires:

  • conversations:readonly - For accessing conversation data

Note: Additional scopes may be required in future versions. Check with MiraBridge support for the latest requirements.

Next Steps

Once your OAuth client is configured:

  1. Proceed to Widget URL Construction
  2. Test the configuration with debug logging enabled
  3. Continue with Widget Integration

Need help? See our Troubleshooting Guide for common OAuth issues and solutions.

Copyright © 2025 Miratech Inc.