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

A collaborator is a representation of user roles, which are associated with projects and frameworks, that you can manipulate. Collaborators are accessible both in project and framework resources.The collaborator section has endpoints for both individuals and groups.> **Note:**> * Only users that have an assigned `effective_role` are returned in the response.> * The `updated_at` field represents the date that the collaborator or collaborator group was last directly updated. Changes to the `effective_role` may occur as a result of assigning the user or group a `group_role`, but doing so won't update the `updated_at` field.Learn more about roles and permissions.

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

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

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

10 operations 4 paths 10 schemas 2 DELETE4 GET2 PATCH2 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 Collaborators 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 10

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

Collaborators 10

A collaborator is a representation of user roles, which are associated with projects and frameworks, that you can manipulate. Collaborators are accessible both in project and fram…

GET
/orgs/{org_id}/{parent_resource_type}/{parent_resource_id}/collaborators
Get collaborators
getCollaborators 5 params → 200400401403404415
POST
/orgs/{org_id}/{parent_resource_type}/{parent_resource_id}/collaborators
Create a collaborator
createCollaborator 5 params body → 201400401403404415422
GET
/orgs/{org_id}/collaborators/{encoded_uid}
Get a collaborator
getCollaborator 4 params → 200401403404
PATCH
/orgs/{org_id}/collaborators/{encoded_uid}
Update a collaborator
updateCollaborator 4 params body → 200400401403404415422
DELETE
/orgs/{org_id}/collaborators/{encoded_uid}
Delete a collaborator
deleteCollaborator 2 params → 202401403404422
GET
/orgs/{org_id}/{parent_resource_type}/{parent_resource_id}/collaborator_groups
Get collaborator groups
getCollaboratorGroups 5 params → 200400401403404415
POST
/orgs/{org_id}/{parent_resource_type}/{parent_resource_id}/collaborator_groups
Create a collaborator group
createCollaboratorGroup 5 params body → 201400401403404415422
GET
/orgs/{org_id}/collaborator_groups/{encoded_uid}
Get a collaborator group
getCollaboratorGroup 4 params → 200401403404
PATCH
/orgs/{org_id}/collaborator_groups/{encoded_uid}
Update a collaborator group
updateCollaboratorGroup 4 params body → 200400401403404415422
DELETE
/orgs/{org_id}/collaborator_groups/{encoded_uid}
Delete a collaborator group
deleteCollaboratorGroup 2 params → 202401403404422

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Error (5 properties), CreateCollaboratorRequest (1 property), UpdateCollaboratorGroupRequest (1 property), UpdateCollaboratorRequest (1 property). Each schema is shown below with its type and property counts.

GetCollaboratorGroupsResponse
object
The data associated with the resource.
1 property 2 required
Error
object
5 properties 1 required
CreateCollaboratorGroupRequest
object
The data associated with the resource.
1 property 1 required
GetCollaboratorsResponse
object
The data associated with the resource.
1 property 2 required
Errors
object
1 property
GetCollaboratorResponse
object
The data associated with the resource.
1 property 1 required
UpdateCollaboratorRequest
object
The data associated with the resource.
1 property 1 required
UpdateCollaboratorGroupRequest
object
The data associated with the resource.
1 property 1 required
CreateCollaboratorRequest
object
The data associated with the resource.
1 property 1 required
GetCollaboratorGroupResponse
object
The data associated with the resource.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wegalvanize-collaborators-api-openapi.yml Raw ↑

Other APIs Wegalvanize publishes across the network.

Wegalvanize Actions API
Wegalvanize Activities API
Wegalvanize Analyses API
Wegalvanize Attachments 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
Wegalvanize Entities API