Page last modified 00:11, 19 Mar 2009 by MaxM
Table of contents
- 1. Overview
- 1.1.1.1. Uri Parameters
- 1.1.1.2. Query Parameters
- 1.1.1.3. Return Codes
- 2. Message Format
- 3. Implementation Notes
- 4. Code Samples
Overview
public. Authenticate a user given http header Credentials or an auth token. Response status 200 implies valid credentials and contains a new auth token.
Uri Parameters
None
Query Parameters
| Name | Type | Description |
| authprovider | int? | Identifier for the external service to use for authentication. |
Return Codes
| Name | Value | Description |
| BadRequest | 400 | Invalid input parameter or request body |
| Conflict | 409 | Username conflicts with an existing username |
| Forbidden | 403 | Login access is required |
| Ok | 200 | The request completed successfully |
| Unauthorized | 401 | Authentication failed |
Message Format
Output:
Content-type=text/plain
Implementation Notes
If the login credentials are valid, this feature returns an authentication token in the response text and an 'authtoken' cookie. This cookie can be used with subsequent requests to execute using the login credentials.
Code Samples
The following code example authenticates the the "admin" user using the local authentication service:
Plug p = Plug.New("http://deki-hayes/@api/deki");
DreamMessage msg = p.At("users", "authenticate").WithCredentials("admin", "password").Get();
String cookieText = msg.Cookies[0].ToString();
Sample authtoken cookie contents:
$Version=1; authtoken=1_633245325345625000_12276545af9bf1f3c24c382c7211760a; $Path=/; $Domain=deki-hayes
- Tag page
- What links here
Images 0
You must login to post a comment.