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 admin API

The admin API from CloudQuery — 7 operation(s) for admin.

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

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

This API exposes 13 operations across 7 paths, and defines 18 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.

13 operations 7 paths 18 schemas 2 DELETE4 GET4 PATCH1 POST2 PUT

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 admin 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 13

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

admin 13
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
GET
/auth/saml
Get SAML integration information
PlatformGetSAML → 200400500
PATCH
/auth/saml
Update SAML integration information
PlatformUpdateSAML body → 200400404422500
PUT
/auth/saml/rollover
Create new SAML rollover certificate
PlatformCreateSAMLRolloverCertificate → 200400404409422500
DELETE
/auth/saml/rollover
Delete current SAML rollover certificate
PlatformDeleteSAMLRolloverCertificate body → 204400404422500
PUT
/auth/saml/rollover/promote
Promote SAML rollover certificate
PlatformPromoteSAMLRolloverCertificate body → 200400404422500
GET
/settings
Show current platform settings
PlatformGetSettings → 200401403404422500
PATCH
/settings
Update platform settings
PlatformUpdateSettings body → 200401403404422500
GET
/settings/data
Show current platform data settings
PlatformGetDataSettings → 200401403404422500
PATCH
/settings/data
Update platform data settings
PlatformUpdateDataSettings body → 200401403404422500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are PlatformSAMLConfig (17 properties), PlatformUser (12 properties), PlatformRBACPermission (9 properties), PlatformRole (8 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.
PlatformDataSettings
object
Platform data settings definition
1 property 1 required
PlatformRole
object
Role
8 properties 8 required
PlatformSAMLConfig
object
17 properties 6 required
PlatformRoleID
string
The unique ID for the role.
PlatformSettingsUpdate
object
Platform settings partial update
2 properties
PlatformUser
object
User
12 properties 6 required
PlatformUserID
string
ID of the User
PlatformUserName
string
The unique name for the user.
PlatformFieldError
PlatformSAMLConfigUpdate
object
8 properties
PlatformBasicError
object
Basic Error
2 properties 2 required
PlatformSettings
object
Platform settings definition
2 properties 2 required
PlatformDataSettingsUpdate
object
Platform data settings partial update
1 property
PlatformRoleType
string
PlatformUserProvider
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudquery-admin-api-openapi.yml Raw ↑

Other APIs CloudQuery publishes across the network.

CloudQuery Platform 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
CloudQuery onboardings API
Where this information came from

This is an independent, third-party profile of CloudQuery admin 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.