Recent searches

in
Developer ReferenceAPI

Users

On this page

Get current user details

GET/api/v0/users
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/users \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "country": "string",
  "job_title": "string",
  "ssg_experience": "string",
  "last_sign_in_at": "2024-01-01T00:00:00Z",
  "current_sign_in_at": "2024-01-01T00:00:00Z"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Update current user information

PUT/api/v0/users
Request body:
first_namestringNullable#
surnamestringNullable#
ssg_experiencestringNullable#
job_titlestringNullable#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/users \
  -X PUT \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "string",
    "surname": "string",
    "ssg_experience": "string",
    "job_title": "string"
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "country": "string",
  "job_title": "string",
  "ssg_experience": "string",
  "last_sign_in_at": "2024-01-01T00:00:00Z",
  "current_sign_in_at": "2024-01-01T00:00:00Z"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Get user details

GET/api/v0/users/{user_identifier}
Path parameters:
user_identifierstringRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/users/{user_identifier} \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "first_name": "string",
  "surname": "string",
  "email": "string",
  "otp_required_for_login": true
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Redirect to avatar

GET/api/v0/users/{user_identifier}/avatar
Path parameters:
user_identifierstringRequired#
Query parameters:
sinteger#

Avatar size in pixels

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/users/{user_identifier}/avatar \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
302Redirect
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Get current user's access keys

GET/api/v0/users/access_keys
Filters:
created_at_gtstring#
created_at_gtestring#
created_at_ltstring#
created_at_ltestring#
idstring | integer | boolean | string (date-time)#
lockedstring | integer | boolean | string (date-time)#
namestring#
statusstring | integer | boolean | string (date-time)#
updated_at_gtstring#
updated_at_gtestring#
updated_at_ltstring#
updated_at_ltestring#
user_uuidstring#
uuidstring#
searchstring#
Sorting:
sort_attributestring#

Attribute to sort the results by

Defaults to: "created_at"

Allowed values: key_id name created_at updated_at

sort_directionstring#

Direction to sort the results

Defaults to: "DESC"

Allowed values: ASC DESC

Pagination:
pageinteger#

Page number to fetch (1-indexed)

itemsinteger#

Number of items per page

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/users/access_keys \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "id": 0,
    "name": "string",
    "key_id": "string",
    "login_session_id": 0,
    "revoked_at": "2024-01-01T00:00:00Z",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
]
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Create a new access key

POST/api/v0/users/access_keys
Request body:
namestring#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/users/access_keys \
  -X POST \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string"
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "access_key": {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "id": 0,
    "name": "string",
    "key_id": "string",
    "login_session_id": 0,
    "revoked_at": "2024-01-01T00:00:00Z",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  },
  "access_key_display": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Revoke an access key

DELETE/api/v0/users/access_keys/{uuid}
Path parameters:
uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/users/access_keys/{uuid} \
  -X DELETE \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
204No Content
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
404Not Found
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Redirect to avatar

GET/api/v0/users/avatar
Query parameters:
sinteger#

Avatar size in pixels

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/users/avatar \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
302Redirect
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

List the current user's pending organization invites

GET/api/v0/users/invites
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/users/invites \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "id": 0,
    "name": "string",
    "brand_color": "string",
    "brand_logo": "string",
    "white_label_logo": "string",
    "invited_at": "2024-01-01T00:00:00Z"
  }
]
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Accept pending organization invites

POST/api/v0/users/invites/accept
Query parameters:
organisation_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/users/invites/accept \
  -X POST \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
204No Content
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Decline pending organization invites

DELETE/api/v0/users/invites/decline
Query parameters:
organisation_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/users/invites/decline \
  -X DELETE \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
204No Content
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response
Open in a new tab