Skip to main content
POST
/
api
/
integrations
/
serviceManagement
/
initiateEnvoyOAuth
Initiate Envoy OAuth
curl --request POST \
  --url https://api2.rhombussystems.com/api/integrations/serviceManagement/initiateEnvoyOAuth \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "param": "state_param",
  "requestUrl": "https://oauth.provider.com/auth",
  "rhombusOrgUserUuid": "<string>"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "redirectUrl": "https://oauth.provider.com/auth?client_id=123&redirect_uri=callback",
  "warningMsg": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:api-token
required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

Request object for initiating OAuth authentication flow.

param
string | null

Additional OAuth parameter

Example:

"state_param"

requestUrl
string | null

OAuth request URL

Example:

"https://oauth.provider.com/auth"

rhombusOrgUserUuid
string | null

Rhombus organization user UUID

Response

200 - application/json

OK

Response object containing OAuth redirect URL.

error
boolean | null
errorMsg
string | null
redirectUrl
string | null

OAuth redirect URL for authentication

Example:

"https://oauth.provider.com/auth?client_id=123&redirect_uri=callback"

warningMsg
string | null
Last modified on May 7, 2026