Service Management Integrations Webservice

Initiate Envoy OAuth

Initiate the Envoy OAuth Process

post/api/integrations/serviceManagement/initiateEnvoyOAuth

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/integrations/serviceManagement/initiateEnvoyOAuth
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

paramstring nullable

Additional OAuth parameter

requestUrlstring nullable

OAuth request URL

rhombusOrgUserUuidstring nullable

Rhombus organization user UUID

Example request

{
  "param": "state_param",
  "requestUrl": "https://oauth.provider.com/auth"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
redirectUrlstring nullable

OAuth redirect URL for authentication

warningMsgstring nullable

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.