Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Humanitec User Role API
version: 0.28.24
description: '# Introduction
The *Humanitec API* allows you to automate and integrate Humanitec into your developer and operational workflows.'
contact:
name: Humanitec Support
email: support@humanitec.com
x-logo:
url: humanitec-logo.png
altText: Humanitec logo
servers:
- url: https://api.humanitec.io/
tags:
- name: User Role
x-displayName: User Roles
description: Holds the mapping of role for a subject on a particular object.
paths:
/orgs/{orgId}/users/{userId}/perms:
get:
tags:
- User Role
summary: Get the permissions of a User or Group on the objects in an Organization
operationId: getSubjectPermsInOrg
parameters:
- $ref: '#/components/parameters/orgIdPathParam'
- $ref: '#/components/parameters/userIdPathParam'
responses:
'200':
description: 'The information about the User or the Group.
'
content:
application/json:
schema:
$ref: '#/components/schemas/SubjectPermissions'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
components:
schemas:
SubjectPermissions:
description: Maps of objects and permissions the subject holds on them.
type: object
properties:
objects:
type: object
additionalProperties:
$ref: '#/components/schemas/Permissions'
required:
- objects
additionalProperties: false
Permissions:
description: List of permissions.
properties:
permissions:
type: array
items:
type: string
additionalProperties: false
required:
- permissions
HumanitecErrorResponse:
description: HumanitecError represents a standard Humanitec Error
properties:
details:
additionalProperties: true
type: object
description: (Optional) Additional information is enclosed here.
error:
type: string
example: API-000
description: A short code to help with error identification.
message:
type: string
example: Could not validate token
description: A Human readable message about the error.
required:
- error
- message
type: object
example:
error: API-000
message: Could not validate token.
parameters:
orgIdPathParam:
name: orgId
in: path
description: The Organization ID
example: sample-org
required: true
schema:
type: string
pattern: ^[a-z0-9](?:-?[a-z0-9]+)+$
maxLength: 50
userIdPathParam:
name: userId
in: path
description: The User or Group Id.
required: true
example: 61048226-642c-438e-974f-ce5c013d94f8
schema:
pattern: ^[a-z0-9](?:-?[a-z0-9]+)+$
type: string
responses:
404NotFound:
description: Either the resource or a related resource could not be found. More detail can be found in the error body.
content:
application/json:
schema:
$ref: '#/components/schemas/HumanitecErrorResponse'
403Forbidden:
description: Server understands the request but refuses to authorize it.
content:
application/json:
schema:
$ref: '#/components/schemas/HumanitecErrorResponse'
externalDocs:
description: Find out more about how to use Humanitec in your every-day development work.
url: https://developer.humanitec.com/
x-tagGroups:
- name: Core
tags:
- Agents
- Application
- Artefact
- ArtefactVersion
- AuditLogs
- Logs
- Deployment
- EnvironmentType
- Environment
- Image
- PublicKeys
- Organization
- Registry
- RuntimeInfo
- SecretStore
- Value
- ValueSetVersion
- name: App Configuration
tags:
- Delta
- Set
- WorkloadProfile
- name: Resources
tags:
- ActiveResource
- DriverDefinition
- MatchingCriteria
- ResourceDefinition
- ResourceDefinitionVersion
- ResourceProvision
- AccountType
- ResourceAccount
- ResourceType
- ResourceClass
- name: Automation
tags:
- AutomationRule
- Event
- Pipelines
- PipelineRuns
- PipelineApprovals
- name: Users
tags:
- UserProfile
- UserRole
- Group
- TokenInfo