POST api/v1/admin/clients

This method adds a new client. Returned is the client name, ID and secret. The client secret will not be available again, so it is very important that this information is saved and stored in a safe place.

Request Information

URI Parameters

None.

Body Parameters

New client to be added

ClientRequest
NameDescriptionTypeAdditional information
UserID

User ID

globally unique identifier

Required

Name

Client name. Max 18 chars

string

Required

Secret

Client secret. Max 50 chars

string

Required

Request Formats

application/json, text/json

Sample:
{
  "UserID": "c003ff05-1d46-4769-89ae-ddc6a877da99",
  "Name": "sample string 2",
  "Secret": "sample string 3"
}

application/xml, text/xml

Sample:
<ClientRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UserID>c003ff05-1d46-4769-89ae-ddc6a877da99</UserID>
  <Name>sample string 2</Name>
  <Secret>sample string 3</Secret>
</ClientRequest>

Response Information

Resource Description

ResponseOfClientResponse
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfClientResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "ID": "e1799823-17c6-46b3-96b7-2ddcc9e891d0",
      "UserID": "058db2d0-20c8-4c41-940a-2b4c0b43c4e2",
      "Name": "sample string 3",
      "Secret": "sample string 4"
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfClientResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <UserID>058db2d0-20c8-4c41-940a-2b4c0b43c4e2</UserID>
      <Name>sample string 3</Name>
      <Secret>sample string 4</Secret>
      <ID>e1799823-17c6-46b3-96b7-2ddcc9e891d0</ID>
    </Detail>
  </ResponseData>
</ResponseOfClientResponse>