Scyld Cloud Auth Documentation

Usage

General Call Pattern

Scyld Cloud Auth API calls are issued using HTTP GET or POST. HTTP GET is accepted only for calls that read, or fetch data only, while POST is required whenever a call manipulates (submits, changes, destroys) data. An HTTP response code of 400 will be returned if the request was made with an incorrect request method. See requirements for specific API methods.

All request GET/POST parameters should be UTF-8 and URL-encoded.

All requests can include a version indicator as the first segment of the URL, if a particular version is needed. If the version segment is not present, the current version is assumed. The version segment begins with a lowercase ‘v’as shown below.

In general, the API interface will remain backwards-compatible; if and when changes are introduced, we will continue to support the older version until its no longer reasonable and/or feasible to do so. The version segment should be formatted as follows::

/v1.1/user/list - Request explicit API version (1.1) of this method.
/user/list - Request without explicit version; assumes current API version.

All responses are in JSON format. See http://www.json.org for details about JSON and references to client libraries.

All responses returned with a HTTP 200 status code are returned with the following parameters:

• success - Boolean. Success indicator.
• message - String. General informational message.
• version - String. API version handling this request.

Responses where the success variable is true usually include a payload contained in the data parameter:

• data - Format varies, depending on specific method. The data payload.

All responses where the success variable is false include an error message:

• error - String. Informational message about the error condition this request encountered.

HTTP Status Codes

Every response returned to the client in an HTTP request includes status information: a three-digit status code and a phrase informing the client of API success or error conditions.

The following is a list of status codes used by Scyld Cloud Auth:

200 OK

Success! The method request did what you expected it to do.

400 Bad Request

This is generally caused by malformed input parameters or request method.

401 Not Authorized

Not authorized.

403 Forbidden

User is authenticated but access to the resource or operation requested is denied.

404 Not Found

Refers to either an an incorrect path to the API method or an object identifier that does not exist.

500 Internal Server Error

An internal failure at Scyld Cloud Auth and your request was unable to be processed. Possibly caused by a service or network outage; either try again later or contact support.