OAuth Webservice

Submit OAuth application

Application for client_id and client_secret

post/api/oauth/submitApplication

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/oauth/submitApplication
  • 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

clientIdstring RUUID nullable

base 64 (url-safe) uuid string

contactEmailstring nullable

Contact email for the OAuth application

descriptionstring nullable

Description of the OAuth application

namestring nullable

Name of the OAuth application

redirectUristring nullable

OAuth redirect URI

tokenEndpointAuthMethodstring nullable

OAuth token endpoint auth method. 'none' registers a PUBLIC (PKCE-only) client with no secret; omit or 'client_secret_basic'/'client_secret_post' for a confidential client.

Example request

{
  "clientId": "AAAAAAAAAAAAAAAAAAAAAA",
  "contactEmail": "admin@myapp.com",
  "description": "Integration app for accessing Rhombus API",
  "name": "My Integration App",
  "redirectUri": "https://myapp.com/oauth/callback",
  "tokenEndpointAuthMethod": "none"
}

Response

OK

clientIdstring RUUID nullable

base 64 (url-safe) uuid string

clientSecretstring nullable

OAuth client secret

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
warningMsgstring nullable

Example response

{
  "clientId": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

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