Login
Authenticates a supplied Credential.
Request
| URL | https://cap.crainwalnut.com/api/app/login |
|---|---|
| Method | POST |
Parameters
| Name | Data Type | Description |
|---|---|---|
| <body> | Credential |
Contains identifying data for a security principal |
Returns
| Data Type | Description |
|---|---|
Boolean |
true if the Credential was authenticated successfully; otherwise, false |
Examples
The following example calls the endpoint while supplying an invalid Credential. The API responses with false, indicating that authentication did not occur.
Remarks
The HTTP response from this endpoint will always contain a session cookie. In addition, the response will contain an authentication cookie upon successful authentication of the supplied Credential. These cookies should be included in subsequent requests to the API.