Skip to main content
POST
/
api
/
integrations
/
submitApiTokenApplication
Submit API Token Application
curl --request POST \
  --url https://api2.rhombussystems.com/api/integrations/submitApiTokenApplication \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "permissionGroupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "authType": "API_TOKEN",
  "csr": "-----BEGIN CERTIFICATE REQUEST-----...",
  "displayName": "Production API Token"
}
'
{
  "apiKey": "AAAAAAAAAAAAAAAAAAAAAA",
  "cert": "<string>",
  "error": true,
  "errorMsg": "<string>",
  "validCSR": true,
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for submitting an API token application.

permissionGroupUuid
string<RUUID> | null
required

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

authType
enum<string>

Authentication type for the API token

Available options:
API_TOKEN,
CERT
csr
string | null

Certificate Signing Request (CSR) for token authentication

Example:

"-----BEGIN CERTIFICATE REQUEST-----..."

displayName
string | null

Display name for the API token

Example:

"Production API Token"

Response

200 - application/json

OK

apiKey
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

cert
string | null
error
boolean | null
errorMsg
string | null
validCSR
boolean | null
warningMsg
string | null