POST api/cimcon/auth
Request Information
URI Parameters
None.
Body Parameters
CimconAuthenticationRequestModelName | Description | Type | Additional information |
---|---|---|---|
APIKey | string |
None. |
Request Formats
application/json, text/json, text/plain, text/html
Sample:
{ "apiKey": "sample string 1" }
application/xml, text/xml
Sample:
<CimconAuthenticationRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"> <APIKey>sample string 1</APIKey> </CimconAuthenticationRequestModel>
multipart/form-data
Sample:
<CimconAuthenticationRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><APIKey>sample string 1</APIKey></CimconAuthenticationRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CimconAuthResponseModelName | Description | Type | Additional information |
---|---|---|---|
token | string |
None. |
|
refreshToken | string |
None. |
|
scope | Object |
None. |
|
status | integer |
None. |
|
message | string |
None. |
|
errorCode | integer |
None. |
|
timestamp | integer |
None. |
|
subscriptionErrorCode | Object |
None. |
|
subscriptionEntry | Object |
None. |
|
subscriptionValue | Object |
None. |
Response Formats
application/json, text/json, text/plain, text/html
Sample:
{ "token": "sample string 1", "refreshToken": "sample string 2", "scope": {}, "status": 4, "message": "sample string 5", "errorCode": 6, "timestamp": 7, "subscriptionErrorCode": {}, "subscriptionEntry": {}, "subscriptionValue": {} }
application/xml, text/xml
Sample:
<CimconAuthResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"> <errorCode>6</errorCode> <message>sample string 5</message> <status>4</status> <subscriptionEntry /> <subscriptionErrorCode /> <subscriptionValue /> <timestamp>7</timestamp> <refreshToken>sample string 2</refreshToken> <scope /> <token>sample string 1</token> </CimconAuthResponseModel>
multipart/form-data
Sample:
<CimconAuthResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><errorCode>6</errorCode><message>sample string 5</message><status>4</status><subscriptionEntry /><subscriptionErrorCode /><subscriptionValue /><timestamp>7</timestamp><refreshToken>sample string 2</refreshToken><scope /><token>sample string 1</token></CimconAuthResponseModel>