AuthApiService
Namespace http://api.hi5.com/auth (wsdl):
The following methods are available on this endpoint:
auth_decodetoken
Decode the value of an authtoken
Given a raw value of an authtoken return it in it's decoded XML format.
Input Parameters
| name | description |
|---|---|
| authtoken | Raw XML token, an opaque string. |
Return Value
AuthToken representation of authtoken
Faults
| name | description |
|---|---|
| PermissionDeniedException | if the token can't be decoded |
auth_plain
Authenticate a user by their email address/password.
This is the simplest way to obtain an authentication token. For full functionality you will probably want to use a more secure method of authentication in the future.
This method will return an authentication token when given valid credentials.
The Hi5AuthToken allows for access to authenticated API calls. You can supply this token by adding it to the query string as the Hi5AuthToken parameter or by setting a cookie named Hi5AuthToken.
The response to this method will also return a Set-Cookie header with a correctly configured Hi5AuthToken cookie.
The following form will allow you to set the authentication cookie:
Input Parameters
| name | description |
|---|---|
| api_key | you api key for your widget |
| username | The username. |
| password | The password. |
Return Value
The authentication token.
Faults
| name | description |
|---|---|
| PermissionDeniedException | If authentication failed. |
renew
Regenerates a new AuthToken based on the given api_key.
Input Parameters
| name | description |
|---|---|
| authToken | the original auth token with the original apikey |
| api_key | The new apikey you want to have the Authtoken for. |
Return Value
A new authentication token with the given api key
Faults
| name | description |
|---|---|
| PermissionDeniedException | If authentication failed. |