How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

H2O.ai Permissions API

The Permissions API from H2O.ai — 24 operation(s) for permissions.

H2O.ai Permissions API is one of 26 APIs that H2O.ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 34 operations across 24 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version v1.0.0.

Requests are made against a single base URL, https://h2ogpte.genai.h2o.ai/api/v1.

34 operations 24 paths 13 schemas 10 DELETE13 GET6 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1.0.0
Base URL
https://h2ogpte.genai.h2o.ai/api/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

H2O.ai Permissions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Using an API key generated by H2OGPTe

Paths & Operations 34

Across 24 paths, the API surfaces 34 operations — 10 DELETE, 13 GET, 6 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Permissions 34
POST
/collections/{collection_id}/permissions/is_granted
Checks if collection permission is granted for a given user.
is_collection_permission_granted 1 param body → 200400401404default
PUT
/documents/{document_id}/users/{user_id}
Associates a user with a document they have permission on.
add_user_document_permission 2 params → 204400401403404default
GET
/users
Returns a list of all registered users for the system.
list_users 2 params → 200400401default
GET
/users/{user_id}
Finds user for a given unique identifier.
get_user 1 param → 200400401404default
GET
/users/{user_id}/permissions
Lists permissions of a given user.
get_user_permissions 1 param → 200400401default
DELETE
/users/current
Request deletion of the current user.
request_current_user_deletion → 200401default
POST
/users/current/confirm-delete
Confirm deletion of the current user.
confirm_current_user_deletion 1 param body → 204400401default
GET
/users/current/permissions
Lists permissions of the user calling the endpoint.
get_current_user_permissions → 200400401default
GET
/users/{user_id}/roles
Finds roles associated with a given user.
get_user_roles 1 param → 200400401default
DELETE
/users/{user_id}/roles
Resets user roles.
reset_user_roles 1 param body → 204400401404default
GET
/users/current/roles
Finds roles associated with the user calling the endpoint.
get_current_user_roles → 200400401default
PUT
/users/{user_id}/roles/{role_names}
Assigns roles to a given user.
assign_roles_to_user 2 params → 204400401404default
DELETE
/users/{user_id}/roles/{role_names}
Removes roles from a given user.
remove_roles_from_user 2 params → 204400401default
GET
/groups
Returns a list of all groups existing on the H2OGPTe instance.
list_groups → 200400401default
POST
/groups
Creates a user group.
create_group body → 201400401default
DELETE
/groups
Deletes groups for given group names.
delete_groups_by_names 1 param → 204400401409default
DELETE
/groups/{group_ids}
Deletes groups for given unique identifiers.
delete_groups 1 param → 204400401409default
GET
/groups/{group_id}/roles
Finds roles associated with a given group.
get_group_roles 1 param → 200400401default
DELETE
/groups/{group_id}/roles
Resets group roles.
reset_group_roles 1 param body → 204400401404default
PUT
/groups/{group_id}/roles/{role_names}
Assigns roles to a given group.
assign_roles_to_group 2 params → 204400401404default
DELETE
/groups/{group_id}/roles/{role_names}
Removes roles from a given group.
remove_roles_from_group 2 params → 204400401default
GET
/group/{group_id}/permissions
Lists permissions of a given group.
get_group_permissions 1 param → 200400401default
POST
/roles
Creates a role.
create_role body → 201400401default
GET
/roles
Returns all roles for in the H2OGPTe instance.
list_roles → 200400401default
DELETE
/roles
Deletes roles for given role names.
delete_roles_by_names 1 param → 204400401409default
GET
/roles/{role_id}
Finds role for a given unique identifier.
get_role 1 param → 200400401404default
DELETE
/roles/{role_ids}
Deletes roles for given unique identifiers.
delete_roles 1 param → 204400401409default
GET
/roles/{role_id}/permissions
Lists permissions of a given role.
get_role_permissions 1 param → 200400401default
POST
/roles/{role_id}/permissions
Sets a new set of permissions for a given role.
set_role_permissions 1 param body → 204400401404default
PUT
/roles/{role_id}/permissions/{permission_name}
Assigns permission to a given role.
assign_permission_to_role 2 params → 204400401404409default
DELETE
/roles/{role_id}/permissions/{permission_name}
Removes permission from a given role.
remove_permission_from_role 2 params → 204400401404409default
PUT
/roles/{role_id}/priority
Sets priority for a given role.
set_role_priority 1 param body → 200400401404500default
GET
/permissions
Returns system permissions.
list_permissions 2 params → 200400401default
POST
/permissions/is_granted
Checks if permission is granted for a given user.
is_permission_granted body → 200400401default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are UserPermission (5 properties), RoleInfo (4 properties), GroupInfo (3 properties), UserInfo (3 properties). Each schema is shown below with its type and property counts.

GroupCreateRequest
object
2 properties 2 required
RolesResetRequest
object
1 property 1 required
PermissionResetRequest
object
1 property 1 required
PermissionCheckRequest
object
1 property 1 required
RoleInfo
object
4 properties 2 required
EndpointError
object
2 properties 2 required
UserPermission
object
5 properties 2 required
ConfirmUserDeletionRequest
object
1 property 1 required
GroupInfo
object
3 properties 2 required
RoleCreateRequest
object
2 properties 2 required
UserInfo
object
3 properties 3 required
SetRolePriorityRequest
object
1 property 1 required
UserDeletionRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

h2o-ai-permissions-api-openapi.yml Raw ↑

Other APIs H2O.ai publishes across the network.

h2oGPTe MCP Server
H2O.ai Admin Sessions API
H2O.ai Agents API
H2O.ai AI Assistants API
H2O.ai API Keys API
H2O.ai Chat API
H2O.ai Collections API
H2O.ai Configurations API
H2O.ai Document Ingestion API
H2O.ai Documents API
H2O.ai Extractors API
H2O.ai Forums API
Where this information came from

This is an independent, third-party profile of H2O.ai Permissions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.