Role Grants

List Role Grants

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Query parameters

sort_bystring[]OptionalDefault: []

limitinteger · max: 200OptionalDefault: 50

continuation_tokenanyOptional

statusstring · enum · nullableOptionalPossible values:

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenanyOptional

422

Validation Error

application/json

get/v1/{workspace_id}/role-grants

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/role-grants HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "role_id": "123e4567-e89b-12d3-a456-426614174000",
      "resource_type": "integration_endpoint",
      "resource_key": "text",
      "access": "read",
      "param_binding": "text",
      "status": "active",
      "changed_by": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2026-07-10T21:26:19.756Z"
    }
  ],
  "has_more": true,
  "continuation_token": null
}

Create Role Grant

post

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

role_idstring · uuidRequired

resource_typestring · enumRequiredPossible values:

resource_keystring · min: 1 · max: 512Required

accessstring · enumRequiredPossible values:

param_bindingstring · max: 256 · nullableOptional

Responses

201

Successful Response

application/json

idstring · uuidRequired

role_idstring · uuidRequired

resource_typestring · enumRequiredPossible values:

resource_keystringRequired

accessstring · enumRequiredPossible values:

param_bindingstring · nullableOptional

statusstring · enumRequiredPossible values:

changed_bystring · uuid · nullableOptional

created_atstring · date-timeRequired

409

An active grant for this (role, resource, access) already exists

422

Validation Error

application/json

post/v1/{workspace_id}/role-grants

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/role-grants HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "role_id": "123e4567-e89b-12d3-a456-426614174000",
  "resource_type": "integration_endpoint",
  "resource_key": "text",
  "access": "read",
  "param_binding": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "role_id": "123e4567-e89b-12d3-a456-426614174000",
  "resource_type": "integration_endpoint",
  "resource_key": "text",
  "access": "read",
  "param_binding": "text",
  "status": "active",
  "changed_by": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-07-10T21:26:19.756Z"
}

Get Role Grant

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

grant_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstring · uuidRequired

role_idstring · uuidRequired

resource_typestring · enumRequiredPossible values:

resource_keystringRequired

accessstring · enumRequiredPossible values:

param_bindingstring · nullableOptional

statusstring · enumRequiredPossible values:

changed_bystring · uuid · nullableOptional

created_atstring · date-timeRequired

404

Role grant not found

422

Validation Error

application/json

get/v1/{workspace_id}/role-grants/{grant_id}

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/role-grants/{grant_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "role_id": "123e4567-e89b-12d3-a456-426614174000",
  "resource_type": "integration_endpoint",
  "resource_key": "text",
  "access": "read",
  "param_binding": "text",
  "status": "active",
  "changed_by": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-07-10T21:26:19.756Z"
}

Delete Role Grant

delete

Supersede an active grant (immutable history) — never a physical delete.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

grant_idstring · uuidRequired

Responses

204

Successful Response

No content

404

Active role grant not found

422

Validation Error

application/json

delete/v1/{workspace_id}/role-grants/{grant_id}

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/role-grants/{grant_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content