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

Name	Description	Type	Additional information
Name	Client name. Max 18 chars	string	Required
Secret	Client secret. Max 50 chars	string	Required
UserID	User ID	globally unique identifier	Required

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Secret": "sample string 2",
  "UserID": "a9f57cf8-faba-4ee4-a8bd-2af025fbeb26"
}

application/xml, text/xml

Sample:

<ClientRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>7db8a6ab-e19c-4f5e-a364-61d2857f1dfe</ID>
  <AccountID>d630b090-c0ee-4581-a6c0-c0c75982aa3f</AccountID>
  <Name>sample string 1</Name>
  <Secret>sample string 2</Secret>
  <UserID>a9f57cf8-faba-4ee4-a8bd-2af025fbeb26</UserID>
</ClientRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfClientResponse

Name	Description	Type	Additional 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": "3c2f4833-0b14-46b3-b142-746f18434f56",
      "Name": "sample string 2",
      "Secret": "sample string 3",
      "UserID": "73715133-3305-4687-9387-49efa09f1bc7"
    }
  }
}