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

Humanitec Group API

GroupRequest holds the definition of a new group.

Humanitec Group API is one of 45 APIs that Humanitec publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.0.0, at version 0.28.24.

Requests are made against a single base URL, https://api.humanitec.io/.

3 operations 3 paths 6 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.28.24
Base URL
https://api.humanitec.io
Resource Areas
1

Paths & Operations 3

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

Group 3

GroupRequest holds the definition of a new group.

POST
/orgs/{orgId}/groups
Create a group in an organization
createGroup 1 param body → 200400403409
GET
/orgs/{orgId}/groups/{groupId}/users
List users in a group.
listGroupUsers 2 params → 200400404
GET
/orgs/{orgId}/users/{userId}/groups
Get the groups in an organization a user belongs to.
listUserGroupsInOrg 2 params → 200400403404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are GroupWithRole (5 properties), UserProfileResponse (5 properties), Group (4 properties), HumanitecErrorResponse (3 properties). Each schema is shown below with its type and property counts.

OrganizationRole
string
Roles that can be assumed by an entity on an organization.
UserProfileResponse
object
UserProfile holds the profile information of a user
5 properties 4 required
Group
object
Group holds the metadata of a new group.
4 properties 3 required
GroupRequest
object
GroupRequest holds the definition of a new group.
3 properties 3 required
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 required
GroupWithRole
object
GroupWithRole holds the metadata of a new group with its role in the organization.
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

humanitec-group-api-openapi.yml Raw ↑

Other APIs Humanitec publishes across the network.

Humanitec AccountType API
Humanitec ActiveResource API
Humanitec Agents API
Humanitec Application API
Humanitec Artefact API
Humanitec ArtefactVersion API
Humanitec AuditLogs API
Humanitec AutomationRule API
Humanitec Delta API
Humanitec Deployment API
Humanitec DriverDefinition API
Humanitec Environment API