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

Weaviate authz API

The authz API from Weaviate — 16 operation(s) for authz.

Weaviate authz API is one of 22 APIs that Weaviate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 18 operations across 16 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 1.38.0-dev.

Requests are made against a single base URL, http://localhost:8080.

18 operations 16 paths 7 schemas 1 DELETE9 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.38.0-dev
Server
http://localhost:8080
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Weaviate authz API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key authentication
  • BearerAuth — OIDC/JWT bearer authentication

Paths & Operations 18

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

authz 18
GET
/authz/roles
Weaviate Get All Roles
getRoles → 200400401403500
POST
/authz/roles
Weaviate Create New Role
createRole body → 201400401403409422500
POST
/authz/roles/{id}/add-permissions
Weaviate Add Permissions To A Role
addPermissions 1 param body → 200400401403404422500
POST
/authz/roles/{id}/remove-permissions
Weaviate Remove Permissions From A Role
removePermissions 1 param body → 200400401403404422500
GET
/authz/roles/{id}
Weaviate Get A Role
getRole 1 param → 200400401403404500
DELETE
/authz/roles/{id}
Weaviate Delete A Role
deleteRole 1 param → 204400401403500
POST
/authz/roles/{id}/has-permission
Weaviate Check Whether A Role Possesses A Permission
hasPermission 1 param body → 200400401403422500
GET
/authz/roles/{id}/users
Weaviate Get Users Assigned To A Role
getUsersForRoleDeprecated 1 param → 200400401403404500
GET
/authz/roles/{id}/user-assignments
Weaviate Get Users Assigned To A Role
getUsersForRole 1 param → 200400401403404500
GET
/authz/roles/{id}/group-assignments
Weaviate Get Groups That Have A Specific Role Assigned
getGroupsForRole 1 param → 200400401403404500
GET
/authz/users/{id}/roles
Weaviate Get Roles Assigned To A User
getRolesForUserDeprecated 1 param → 200400401403404422500
GET
/authz/users/{id}/roles/{userType}
Weaviate Get Roles Assigned To A User
getRolesForUser 3 params → 200400401403404422500
POST
/authz/users/{id}/assign
Weaviate Assign A Role To A User
assignRoleToUser 1 param body → 200400401403404500
POST
/authz/users/{id}/revoke
Weaviate Revoke A Role From A User
revokeRoleFromUser 1 param body → 200400401403404500
POST
/authz/groups/{id}/assign
Weaviate Assign A Role To A Group
assignRoleToGroup 1 param body → 200400401403404500
POST
/authz/groups/{id}/revoke
Weaviate Revoke A Role From A Group
revokeRoleFromGroup 1 param body → 200400401403404500
GET
/authz/groups/{id}/roles/{groupType}
Weaviate Get Roles Assigned To A Specific Group
getRolesForGroup 3 params → 200400401403404422500
GET
/authz/groups/{groupType}
Weaviate List All Groups Of A Specific Type
getGroups 1 param → 200400401403422500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Permission (12 properties), Role (2 properties), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

UserTypeInput
string
The type of the user. db users are managed by Weaviate, oidc users are managed by an external OIDC provider.
RolesListResponse
array
List of roles.
Role
object
2 properties 2 required
Permission
object
Permissions attached to a role.
12 properties 1 required
GroupType
string
If the group contains OIDC or database users.
ErrorResponse
object
An error response returned by Weaviate endpoints.
1 property
UserTypeOutput
string
The type of the user. dbuser users are created through the users API, dbenvuser users are created through environment variables, and oidc users are managed by…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weaviate-authz-api-openapi.yml Raw ↑

Other APIs Weaviate publishes across the network.

Weaviate backups API
Weaviate batch API
Weaviate classifications API
Weaviate cluster API
Weaviate discovery API
Weaviate distributedTasks API
Weaviate export API
Weaviate graphql API
Weaviate mcp API
Weaviate meta API
Weaviate namespaces API
Weaviate nodes API