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

Wegalvanize Users API

A user represents a member of HighBond. Users can belong to multiple instances.Learn more about adding and managing users.

Wegalvanize Users API is one of 69 APIs that Wegalvanize publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 5 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.0.2, at version 1.1.0.

Requests are made against a single base URL, {protocol}://{server}/v1.

5 operations 2 paths 9 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.1.0
Base URL
https://apis-us.highbond.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Wegalvanize Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (oauth2) (bearerToken). By default, every request must be authenticated.

  • bearerToken — HighBond offers the industry-standard OAuth 2.0 flow for connecting to the HighBond platform. OAuth 2.0 provides a safe and secure way to access data, while pr…

Paths & Operations 5

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

Users 5

A user represents a member of HighBond. Users can belong to multiple instances. Learn more about adding and managing users .

GET
/orgs/{org_id}/users
List users in an instance
getUsers 6 params → 200400401404
POST
/orgs/{org_id}/users
Create a new user
createUser 1 param body → 201400401404422429
GET
/orgs/{org_id}/users/{uid}
Get user information
getUser 2 params → 200400401404
PATCH
/orgs/{org_id}/users/{uid}
Update user information
updateUser 2 params body → 200400401404422429
DELETE
/orgs/{org_id}/users/{uid}
Remove user from organization
deleteUser 2 params → 200400401403404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Error (5 properties), MultipleUsersResponse (3 properties), CreateUserRequest (1 property), Errors (1 property). Each schema is shown below with its type and property counts.

UpdateUserResponse
object
The data associated with the resource.
1 property 1 required
UpdateUserRequest
object
The parameters required to update a user.
1 property 1 required
Error
object
5 properties 1 required
DeleteUserResponse
object
The data associated with the resource.
1 property 1 required
Errors
object
1 property
CreateUserRequest
object
The parameters required to create a new user.
1 property 1 required
GetUserResponse
object
The data associated with the resource.
1 property 1 required
MultipleUsersResponse
object
The data associated with the resource.
3 properties 1 required
CreateUserResponse
object
The data associated with the resource.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wegalvanize-users-api-openapi.yml Raw ↑

Other APIs Wegalvanize publishes across the network.

Wegalvanize Actions API
Wegalvanize Activities API
Wegalvanize Analyses API
Wegalvanize Attachments API
Wegalvanize Collaborators API
Wegalvanize Collections API
Wegalvanize Compliance Maps API
Wegalvanize Control performance schedules API
Wegalvanize Control test plans API
Wegalvanize Control tests API
Wegalvanize Controls API
Wegalvanize Custom attributes API