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

ControlUp Users API

The Users API from ControlUp — 4 operation(s) for users.

ControlUp Users API is one of 61 APIs that ControlUp 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, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 53 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.controlup.com/daas-iq/v1, https://api.controlup.com/v1.

6 operations 4 paths 53 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.controlup.com/v1
Authentication
HTTP Bearer, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 3

ControlUp Users API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). An API key is passed in the cookie as user_dex_token (CookieAuth). It accepts HTTP bearer tokens (apiKey).

  • BearerAuth — API Key Authentication (Recommended) [Learn how to create an API key](https://api.controlup.io/reference/how-to-create-api-keys).
  • CookieAuth — Cookie Authentication (Browser use) ⚠️ The 'Authorize' button cannot set cookies due to browser security. To authenticate in browser: 1. Login via DEX authenti…

Paths & Operations 6

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

Users 6
GET
/users/user-info
Get current user information
→ 200401402403500503
GET
/organizations/{orgId}/users
List all users
OrgUsersPublicController_getAll 14 params → 200400401403404500
GET
/organizations/{orgId}/users/{id}
Retrieve a user
OrgUsersPublicController_getOneById 3 params → 200400401403404500
PATCH
/organizations/{orgId}/users/{id}
Update a user
OrgUsersPublicController_update 2 params body → 200400401403404500
DELETE
/organizations/{orgId}/users/{id}
Delete a user
OrgUsersPublicController_delete 2 params → 200400401403404500
POST
/organizations/{orgId}/users/{id}/revoke-api-keys
Revoke a user’s API keys
OrgUsersPublicController_revoke 2 params → 200400401403404500

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are UserInfoDto (13 properties), UserPublic (13 properties), ErrorResponse (7 properties), PaginatedResponseMetadata (5 properties). Each schema is shown below with its type and property counts.

UUID
string
Stringified UUIDv4. See [RFC 4112](https://tools.ietf.org/html/rfc4122)
ErrorType_ErrorMessage.Forbidden.HttpStatusCode.FORBIDDEN.ErrorCode.Forbidden_
object
4 properties 3 required
APIPaginatedResponse_UserPublic-Array_
LoginMethod
string
ErrorMessage.Forbidden
string
ErrorCode.Forbidden
number
ErrorType_BadRequestErrorMessages.HttpStatusCode.BAD_REQUEST.BadRequestErrorCodes_
object
4 properties 3 required
Partial_Omit_OrgUserSettings.roleIds__
object
Make all properties in T optional
4 properties
Pick_OrgUserSettings.Exclude_keyofOrgUserSettings.roleIds__
object
From T, pick a set of properties whose keys are in the union K
4 properties 3 required
HttpStatusCode.NOT_FOUND
number
GetUsersResponse
Region
string
UpdateUserStatusPublic
string
UserStatusPublic
string
ErrorResponseBody_ErrorType_ErrorMessage.Unauthorized.HttpStatusCode.UNAUTHORIZED.ErrorCode.Unauthorized__
object
2 properties 2 required
ErrorType_ErrorMessage.NotFound.HttpStatusCode.NOT_FOUND.ErrorCode.NotFound_
object
4 properties 3 required
PaginatedResponseMetadata
object
5 properties 5 required
MFAType
string
ErrorType_ErrorMessage.Unauthorized.HttpStatusCode.UNAUTHORIZED.ErrorCode.Unauthorized_
object
4 properties 3 required
ErrorResponse
object
Standard error body the API returns when a request fails validation or cannot be completed. Follows RFC 7807 Problem Details with additional errors and traceId…
7 properties 3 required
ErrorCode.Unauthorized
number
ErrorType_ErrorMessage.InternalServerError.HttpStatusCode.INTERNAL_SERVER_ERROR.ErrorCode.InternalServerError_
object
4 properties 3 required
Omit_OrgUserSettings.roleIds_
Construct a type with the properties of T except for those in type K.
UserAndSettings
BadRequestErrorMessages
string
UserPublic
object
13 properties 1 required
ErrorCode.InternalServerError
number
ErrorMessage.Unauthorized
string
UpdateOrgUserSettings
HttpStatusCode.BAD_REQUEST
number
ErrorResponseBody_ErrorType_ErrorMessage.Forbidden.HttpStatusCode.FORBIDDEN.ErrorCode.Forbidden__
object
2 properties 2 required
APIResponse_UserPublic-Array_
object
1 property 1 required
ErrorMessage.InternalServerError
string
DeletedActionResponse
object
1 property 1 required
HttpStatusCode.FORBIDDEN
number
RolePublicIncluded
object
4 properties 4 required
HttpStatusCode.INTERNAL_SERVER_ERROR
number
Partial_Omit_OrgUserSettings.status__
object
Make all properties in T optional
4 properties
HttpStatusCode.UNAUTHORIZED
number
ErrorResponseBody_ErrorType_ErrorMessage.NotFound.HttpStatusCode.NOT_FOUND.ErrorCode.NotFound__
object
2 properties 2 required
ErrorResponseBody_ErrorType_ErrorMessage.InternalServerError.HttpStatusCode.INTERNAL_SERVER_ERROR.ErrorCode.InternalServerError__
object
2 properties 2 required
NonEmptyString
string
GetUserResponse
APIResponse_UserAndSettings_
object
1 property 1 required
ErrorMessage.NotFound
string
BadRequestErrorCodes
number
ErrorResponseBody_ErrorType_BadRequestErrorMessages.HttpStatusCode.BAD_REQUEST.BadRequestErrorCodes__
object
2 properties 2 required
UpdateUserResponse
UserInfoDto
object
Data Transfer Object for user information from authenticated user claims.
13 properties 2 required
APIResponse_DeletedActionResponse_
object
1 property 1 required
ErrorResponseMetadata
object
4 properties 4 required
ErrorCode.NotFound
number
UserIncludes
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

controlup-users-api-openapi.yml Raw ↑

Other APIs ControlUp publishes across the network.

ControlUp MCP Server
ControlUp Alerts API
ControlUp Alerts - Devices API
ControlUp Applications API
ControlUp Audit Log API
ControlUp Cloud providers API
ControlUp Dal API
ControlUp Data API
ControlUp Devices API
ControlUp Dynamic Query API API
ControlUp Events API
ControlUp Features API
Where this information came from

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