POST | /api/services/{ServiceGuid}/authenticate | Authenticate against the CCCAPI API |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ServiceGuid | path | Guid | Yes | The service the user belongs to. |
Token | body | String | Yes | MsgAPI session token |
RememberMe | body | Boolean | No | If true, will keep the session active for 7 days from the moment the user is signed inAllowable Values
|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SessionId | form | string | No | |
UserName | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/services/{ServiceGuid}/authenticate HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"serviceGuid": "00000000000000000000000000000000",
"token": "String",
"rememberMe": false
}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length { "sessionId": "String", "userName": "String", "responseStatus": { "errorCode": "String", "message": "String", "stackTrace": "String", "errors": [ { "errorCode": "String", "fieldName": "String", "message": "String", "meta": { "String": "String" } } ], "meta": { "String": "String" } } }