Introduction
The CloudIgnite API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Authentication
Authenticate your API requests by including your secret key in the Authorization header. All API requests must be made over HTTPS.
Your API keys carry many privileges; be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Authorization: Bearer YOUR_API_KEYUsers
The User object represents an end-user in your application. It is the core of the Authentication product.
Create a user
/v1/usersCreates a new user in your project. This is the programmatic equivalent of a user signing up.
Body Parameters
| Parameter | Type | Description |
|---|---|---|
email | string | The user's unique email address. |
full_name | string | (Optional) The user's full name. |
Returns
Returns a user object if the request was successful.
The User object
The User object contains all relevant information about a user.
| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier for the user. |
object | string | Value is "user". |
email | string | The user's email address. |
full_name | string | The user's full name. |
created_at | timestamp | Time at which the object was created. |