Page last modified 12:42, 24 Jun 2009 by coreyg
MindTouch Community Portal > MindTouch Community Portal > Reference > MindTouch API > POST:users/authenticate
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
- 4.1. C# Samples
- 4.2. Curl Samples
- 4.3. PHP Samples
- 4.4. Other Code Samples
Overview
public. Authenticate a user given http header Credentials or an auth token. When using external authentication, this will automatically create an account and synchronize groups. 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.
This feature is identical to GET:users/authenticate, except that it automatically creates new users when using external authentication.
Code Samples
C# Samples
Curl Samples
PHP Samples
Other Code Samples
- Was this page helpful?
- Tag page
- What links here
| Images 0 | ||
|---|---|---|
| No images to display in the gallery. |
You must login to post a comment.
Copyright © 2011 MindTouch, Inc. Powered by