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

Authorizations

X-AUTH-TOKEN
stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Request Body

application/json
required

The new SubClient resource

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

Response

201application/json

SubClient resource created

id
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>[]