curl --request POST \ --url 'https://app.output.rocks/api/sub-clients' \ --header 'X-AUTH-TOKEN: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "externalId": "id123", "description": "Any description", "tokenIdentifiers": [ "default", "special" ], "standardValuesList": { "key1": "value1", "key2": "line1\nline2" } }'

{ "id": 12345, "externalId": "id123", "description": "Any description", "tokens": [ { "id": 12345, "identifier": "default", "description": "Any description", "token": "Any description" } ], "standardValues": [ { "id": 12345, "identifier": "key1", "value": "line1\nline2", "active": true, "activeFrom": "2024-01-01" } ] }

SubClient

Creates a new SubClient (to be with enabled sub-clients module)

This API can be used on instances with enabled sub-clients module only. API generates a new SubClient. Optionally a set of ApiTokens and StandardValues can be generated. <b>NOTE:</b> System will check for existing SubClients with provided externalId. In case of existing SubClient with same externalId, API will return the existing.

POST/api/sub-clients

Creates a new SubClient (to be with enabled sub-clients module)

curl --request POST \
  --url 'https://app.output.rocks/api/sub-clients' \
  --header 'X-AUTH-TOKEN: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "externalId": "id123",
  "description": "Any description",
  "tokenIdentifiers": [
    "default",
    "special"
  ],
  "standardValuesList": {
    "key1": "value1",
    "key2": "line1\nline2"
  }
}'

201

application/json

{
  "id": 12345,
  "externalId": "id123",
  "description": "Any description",
  "tokens": [
    {
      "id": 12345,
      "identifier": "default",
      "description": "Any description",
      "token": "Any description"
    }
  ],
  "standardValues": [
    {
      "id": 12345,
      "identifier": "key1",
      "value": "line1\nline2",
      "active": true,
      "activeFrom": "2024-01-01"
    }
  ]
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Request Body

application/json

required

The new SubClient resource

{
  "externalId": "id123",
  "description": "Any description",
  "tokenIdentifiers": [
    "default",
    "special"
  ],
  "standardValuesList": {
    "key1": "value1",
    "key2": "line1\nline2"
  }
}

Response

201application/json

SubClient resource created

integer

Identifier generated by Output.Rocks.

Example: 12345

externalId

string

Optional identifier, used in connected system. External ID has to be unique.

Example: "id123"

description

string

SubClient description

Example: "Any description"

tokens

object[]

standardValues

object[]