Integrations Webservice

Submit API Token Application

Request an api token for organization

post/api/integrations/submitApiTokenApplication

Request

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

authType'API_TOKEN' | 'CERT'

Authentication type for the API token

csrstring nullable

Certificate Signing Request (CSR) for token authentication

displayNamestring nullable

Display name for the API token

permissionGroupUuidstring RUUID nullable required

base 64 (url-safe) uuid string

Example request

{
  "csr": "-----BEGIN CERTIFICATE REQUEST-----...",
  "displayName": "Production API Token",
  "permissionGroupUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

apiKeystring RUUID nullable

base 64 (url-safe) uuid string

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

Example response

{
  "apiKey": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

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