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
ClientRequestName | 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": "ad5c7a20-fef5-4b7e-9954-b8c2d5aa5d07" }
application/xml, text/xml
Sample:
<ClientRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ID>0e7aab17-a751-4f34-b57f-03990f57b2c4</ID> <AccountID>77656df4-1a1d-4c18-9b0b-a258cc7dc456</AccountID> <Name>sample string 1</Name> <Secret>sample string 2</Secret> <UserID>ad5c7a20-fef5-4b7e-9954-b8c2d5aa5d07</UserID> </ClientRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseOfClientResponseName | 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": "5dc7c156-0882-4c98-b69f-bb02a9ab6e1a", "Name": "sample string 2", "Secret": "sample string 3", "UserID": "565d0235-aa5c-4e65-937c-d85da7cdefdf" } } }