Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-2685172326.0 KB
Role Bindings

Create a role binding

Grant a role to a principal at an organization or project scope.

post/admin/role-bindings

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Request body

principal_typestring required

The kind of principal that receives permissions from a role binding. Possible values: user, service_account, api_key, invite.

principal_idstring required

Principal ID. Format depends on principal_type.

resource_typestring required

The kind of resource scope a role binding applies to. Possible values: organization, project.

resource_idstring

Project UUID. Required when resource_type is project; omit for organization scope.

rolestring required

A role assigned to a principal at a resource scope.

Example request

{
  "principal_type": "service_account",
  "principal_id": "e2e92523-85dc-4142-b8c2-e681be8b78df",
  "resource_type": "project",
  "resource_id": "a2f7dddb-1597-4eff-9f71-535fde243f58",
  "role": "ProjectOwner"
}

Response

Role binding created.

idstring uuid required

The unique ID of the role binding.

principal_typestring required

The kind of principal that receives permissions from a role binding. Possible values: user, service_account, api_key, invite.

principal_idstring required

The principal's ID. A UUID for all principal types (user, service_account, api_key, invite).

resource_typestring required

The kind of resource scope a role binding applies to. Possible values: organization, project.

resource_idstring required

The organization or project that the binding is scoped to.

rolestring required

A role assigned to a principal at a resource scope.

created_atstring date-time required

When the role binding was created.

Example response

{
  "created_at": "2026-04-10T15:23:00.000Z",
  "id": "9a8e3528-b9c0-4358-84ce-84c28e91b566",
  "principal_id": "f8a3b2c1-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
  "principal_type": "service_account",
  "resource_id": "a2f7dddb-1597-4eff-9f71-535fde243f58",
  "resource_type": "project",
  "role": "DataPlaneEditor"
}