SubClient

Fetches all SubClients (to be with enabled sub-clients module)

This API can be used on instances with enabled sub-clients module only. API fetches all SubClients

GET/api/sub-clients

Fetches all SubClients (to be with enabled sub-clients module)

curl --request GET \
  --url 'https://app.output.rocks/api/sub-clients' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

[
  {
    "id": 12345,
    "externalId": "id123",
    "description": "Any description",
    "tokenIdentifiers": [
      "default",
      "special"
    ],
    "standardValuesList": {
      "key1": "value1",
      "key2": "line1\nline2"
    },
    "tokens": [
      "https://example.com/"
    ],
    "standardValues": [
      "https://example.com/"
    ]
  }
]

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

externalId

string

The external ID of the sub-client

Response

200application/json

SubClient collection

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"

tokenIdentifiers

string[]

Optional list of ApiToken identifiers, to be created on SubClient

Example: ["default","special"]

standardValuesList

object

Optional list of standard values as array [key => value], to be created for SubClient

Example: {"key1":"value1","key2":"line1\nline2"}

tokens

string<iri-reference>[]

standardValues

string<iri-reference>[]