Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HorizonIQ User Accounts API

Enpionts related to user accounts

HorizonIQ User Accounts API is one of 9 APIs that HorizonIQ publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User Accounts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 10 operations across 7 paths, and defines 11 schemas. It is described by OpenAPI 3.0.1, at version 2023-05-30T22:28:43Z.

Requests are made against a single base URL, https://api.compass.horizoniq.com/{basePath}.

10 operations 7 paths 11 schemas 1 DELETE3 GET5 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2023-05-30T22:28:43Z
Base URL
https://api.compass.horizoniq.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

HorizonIQ User Accounts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API token issued from the Compass portal (Profile API Tokens). Sent as Authorization: Bearer . See https://compass-horizoniq.readme.io/reference/authentication

Paths & Operations 10

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

User Accounts 10

Enpionts related to user accounts

DELETE
/users/{userUUID}
Delete User Account
deleteUsersByUserUUID 2 params → 200500
GET
/users/{userUUID}
Get User Account
getUsersByUserUUID 2 params → 200404
PATCH
/users/{userUUID}
Update User Account
updateUsersByUserUUID 2 params body → 200500
GET
/users/roles
Retrieve Available User Roles
getUsersRoles 5 params → 200
GET
/users
List User Accounts
getUsers 5 params → 200
POST
/users
Add User Account
createUsers 1 param body → 200500
PATCH
/users/{userUUID}/admin-disabled
Disable User Admin
updateUsersByUserUUIDAdminDisabled 2 params → 200500
PATCH
/users/{userUUID}/admin-enabled
Enable User Admin
updateUsersByUserUUIDAdminEnabled 2 params → 200500
PATCH
/users/{userUUID}/roles/{roleUUID}
Remove User Role
updateUsersByUserUUIDRolesByRoleUUID 3 params → 200500
PATCH
/users/{userUUID}/roles
Add User Role
updateUsersByUserUUIDRoles 2 params body → 200500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are UserGetModel (26 properties), UserUpdatePatchModel (8 properties), UserAddPostModel (8 properties), UserListModel (6 properties). Each schema is shown below with its type and property counts.

UserGetModel
object
26 properties
UserAddPostModel
object
8 properties 4 required
UserRoleGetModel
object
5 properties
ErrorModel
object
1 property
UserAddResponseModel
object
2 properties
UserRolePatchModel
object
1 property 1 required
UserListModel
object
6 properties
UserPermissionGetModel
object
4 properties
SuccessModel
object
1 property
UserUpdatePatchModel
object
8 properties
UserRoleListModel
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

horizoniq-user-accounts-api-openapi.yml Raw ↑

Other APIs HorizonIQ publishes across the network.

HorizonIQ Action Items API
HorizonIQ Billing API
HorizonIQ Devices API
HorizonIQ Images API
HorizonIQ Managed Firewalls API
HorizonIQ Servers API
HorizonIQ SSL Certificates API
HorizonIQ Support API