How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CloudQuery users API

The users API from CloudQuery — 11 operation(s) for users.

CloudQuery users API is one of 26 APIs that CloudQuery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 17 operations across 11 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.cloudquery.io.

17 operations 11 paths 13 schemas 4 DELETE4 GET2 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.cloudquery.io
Authentication
HTTP Bearer, HTTP Basic, HTTP Cookie
License
Terms of Service
Resource Areas
1

Authentication & Security 3

CloudQuery users API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). It uses HTTP cookie authentication (cookieAuth). By default, every request must be authenticated.

Paths & Operations 17

Across 11 paths, the API surfaces 17 operations — 4 DELETE, 4 GET, 2 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

users 17
GET
/users
List all users
PlatformListUsers 4 params → 200400401403404500
POST
/users
Add new user
PlatformAddUser body → 200400401403404405422500
GET
/users/{user_id}
Get user details
PlatformGetUser 1 param → 200400401403404422500
PATCH
/users/{user_id}
Update user
PlatformUpdateUser 1 param body → 200400401403404422500
DELETE
/users/{user_id}
Delete user
PlatformDeleteUser 1 param → 204400401403404422500
DELETE
/users/{user_id}/totp
Disable/Reset MFA for a specific user
PlatformDeleteUserTOTP 1 param → 204400401403404405500
GET
/user
Get the current authenticated user from the OAuth token
PlatformGetCurrentUser → 200401403500
PATCH
/user
Update attributes for the current authenticated user from the OAuth token
PlatformUpdateCurrentUser body → 200400401403405500
POST
/user/authenticate
Authenticate a user with password
PlatformAuthenticateUser body → 200400401403404405422429
GET
/user/authenticated-status
Return the authentication state of the current request along with the MFA and SAML configuration the frontend needs to render the login UI. Missing or invalid credentials still produce a 200 response…
PlatformCheckUserAuthStatus → 200500
POST
/user/change-password
Change user password
PlatformChangeUserPassword body → 204400401403404405422500
POST
/user/totp/verify
Verify a one time password for MFA
PlatformUserTOTPVerify 1 param body → 204400401403404405422429
POST
/user/totp
Set up MFA for the current user
PlatformUserTOTPSetup → 200400401403404405422500
DELETE
/user/totp
Disable MFA for the current user
PlatformUserTOTPDelete → 204400401403404405500
POST
/user/login
Start a session using ID token
PlatformLoginUser body → 204400401403404405500
DELETE
/user/login
Logout a session
PlatformLogoutUser → 204400401403404405500
POST
/user/magic-login
Exchange a one-shot magic-link token (minted by CloudQuery cloud) for a platform ID token. The handler validates the token by calling cloud's consume endpoint and, on success, looks up the local user…
PlatformMagicLoginUser body → 200400404405429500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are PlatformUser (12 properties), PlatformRBACPermission (9 properties), PlatformRole (8 properties), PlatformListMetadata (4 properties). Each schema is shown below with its type and property counts.

PlatformRBACPermission
object
9 properties 9 required
PlatformCreatedBy
object
3 properties 3 required
PlatformRBACPermissionID
string
The unique ID for the data permission.
PlatformRole
object
Role
8 properties 8 required
PlatformRoleID
string
The unique ID for the role.
PlatformListMetadata
object
4 properties 1 required
PlatformUser
object
User
12 properties 6 required
PlatformUserID
string
ID of the User
PlatformUserName
string
The unique name for the user.
PlatformFieldError
PlatformBasicError
object
Basic Error
2 properties 2 required
PlatformRoleType
string
PlatformUserProvider
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudquery-users-api-openapi.yml Raw ↑

Other APIs CloudQuery publishes across the network.

CloudQuery Platform API
CloudQuery admin API
CloudQuery alerts API
CloudQuery api-keys API
CloudQuery apps API
CloudQuery audit-logs API
CloudQuery chat API
CloudQuery custom-columns API
CloudQuery filters API
CloudQuery healthcheck API
CloudQuery insights API
CloudQuery notifications API
Where this information came from

This is an independent, third-party profile of CloudQuery users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.