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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Humanitec

Humanitec UserRole API

Holds the mapping of role for a subject on a particular object.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 16 operations across 8 paths, and defines 8 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/.

16 operations 8 paths 8 schemas 3 DELETE7 GET3 PATCH3 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
Contact
Humanitec Support
Resource Areas
1

Paths & Operations 16

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

UserRole 16

Holds the mapping of role for a subject on a particular object.

GET
/orgs/{orgId}/apps/{appId}/users
List Users or Groups with roles in an App
listUserRolesInApp 3 params → 200403404
POST
/orgs/{orgId}/apps/{appId}/users
Adds a User or a Group to an Application with a Role
createUserRoleInApp 2 params body → 200400403404
GET
/orgs/{orgId}/apps/{appId}/users/{userId}
Get the role of a User or a Group on an Application
getUserRoleInApp 3 params → 200400403404
DELETE
/orgs/{orgId}/apps/{appId}/users/{userId}
Remove the role of a User or a Group on an Application
deleteUserRoleInApp 3 params → 204400403404
PATCH
/orgs/{orgId}/apps/{appId}/users/{userId}
Update the role of a User or a Group on an Application
updateUserRoleInApp 3 params body → 200400403404
GET
/orgs/{orgId}/env-types/{envType}/users
List Users and Groups with roles in an Environment Type
listUserRolesInEnvType 3 params → 200403404
POST
/orgs/{orgId}/env-types/{envType}/users
Adds a User or a Group to an Environment Type with a Role
createUserRoleInEnvType 2 params body → 200400403404
GET
/orgs/{orgId}/env-types/{envType}/users/{userId}
Get the role of a User or a Group on an Environment Type
getUserRoleInEnvType 3 params → 200400403404
DELETE
/orgs/{orgId}/env-types/{envType}/users/{userId}
Remove the role of a User or a Group on an Environment Type
deleteUserRoleInEnvType 3 params → 204400403404
PATCH
/orgs/{orgId}/env-types/{envType}/users/{userId}
Update the role of a User or a Group on an Environment Type
updateUserRoleInEnvType 3 params body → 200400403404
POST
/orgs/{orgId}/invitations
Invites a user to an Organization with a specified role.
createInviteInOrg 1 param body → 200400404
GET
/orgs/{orgId}/users
List Users and Groups with roles in an Organization
listUserRolesInOrg 2 params → 200403404
GET
/orgs/{orgId}/users/{userId}
Get the role of a User or a Group on an Organization
getUserRoleInOrg 2 params → 200400403404
DELETE
/orgs/{orgId}/users/{userId}
Remove the role of a User or a Group on an Organization
deleteUserRoleInOrg 2 params → 204400403404
PATCH
/orgs/{orgId}/users/{userId}
Update the role of a User or a Group on an Organization
updateUserRoleInOrg 2 params body → 200400403404
GET
/orgs/{orgId}/users/{userId}/perms
Get the permissions of a User or Group on the objects in an Organization
getSubjectPermsInOrg 2 params → 200403404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are UserRoleResponse (8 properties), HumanitecErrorResponse (3 properties), UserInviteRequestRequest (2 properties), UserRoleRequest (2 properties). Each schema is shown below with its type and property counts.

UserRoleResponse
object
UserRole holds the mapping of role to user or group for a particular object.
8 properties 5 required
SubjectTypeEnum
string
Subjects that can assume roles on objects.
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 required
SubjectPermissions
object
Maps of objects and permissions the subject holds on them.
1 property 1 required
UserRoleRequest
object
Holds the mapping of role for a subject on a particular object.
2 properties 2 required
UserInviteRequestRequest
object
UserInviteRequest describes a new user invitation.
2 properties 2 required
Permissions
object
List of permissions.
1 property 1 required
RoleRequest
object
Role defines the role that will be used in request
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

humanitec-userrole-api-openapi.yml Raw ↑

Other APIs Humanitec publishes across the network.

Humanitec AccountType API
AE Profile APIs.io
Humanitec ActiveResource API
AE Profile APIs.io
Humanitec Agents API
AE Profile APIs.io
Humanitec Application API
AE Profile APIs.io
Humanitec Artefact API
AE Profile APIs.io
Humanitec ArtefactVersion API
AE Profile APIs.io
Humanitec AuditLogs API
AE Profile APIs.io
Humanitec AutomationRule API
AE Profile APIs.io
Humanitec Delta API
AE Profile APIs.io
Humanitec Deployment API
AE Profile APIs.io
Humanitec DriverDefinition API
AE Profile APIs.io
Humanitec Environment API
AE Profile APIs.io
#UserRole
← Back to H APIs
API Details
ID
humanitec:humanitec-userrole-api
Base URL
https://api.humanitec.io
Docs
https://developer.humanitec.com/platform-orchestrator/reference/api-references/
Provider
Humanitec
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network