External Role Assignments

List External Role Assignments

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

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenanyOptional

422

Validation Error

application/json

get/v1/{workspace_id}/external-role-assignments

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "source": "text",
      "external_subject_key": "text",
      "external_subject_id": "text",
      "entity_id": "123e4567-e89b-12d3-a456-426614174000",
      "display_name": "text",
      "roles": [
        "text"
      ],
      "roles_verified": true,
      "status": "active",
      "provisioned_via": "roster_sync",
      "last_verified_at": "2026-07-10T21:26:19.599Z",
      "created_at": "2026-07-10T21:26:19.599Z",
      "updated_at": "2026-07-10T21:26:19.599Z"
    }
  ],
  "has_more": true,
  "continuation_token": null
}

Upsert External Role Assignment

put

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

sourcestring · min: 1 · max: 128Required

external_subject_keystring · min: 1 · max: 512Required

external_subject_idstring · max: 512 · nullableOptional

entity_idstring · uuidRequired

display_namestring · max: 512 · nullableOptional

rolesstring[] · max: 64Optional

roles_verifiedbooleanOptionalDefault: false

provisioned_viastring · enumRequiredPossible values:

Responses

200

Successful Response

application/json

idstring · uuidRequired

sourcestringRequired

external_subject_keystringRequired

external_subject_idstring · nullableOptional

entity_idstring · uuidRequired

display_namestring · nullableOptional

rolesstring[]Required

roles_verifiedbooleanRequired

statusstring · enumRequiredPossible values:

provisioned_viastring · enumRequiredPossible values:

last_verified_atstring · date-time · nullableOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

422

Validation Error

application/json

put/v1/{workspace_id}/external-role-assignments

HTTPcURLJavaScriptPython

PUT /v1/{workspace_id}/external-role-assignments HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "source": "text",
  "external_subject_key": "text",
  "external_subject_id": "text",
  "entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "display_name": "text",
  "roles": [
    "text"
  ],
  "roles_verified": false,
  "provisioned_via": "roster_sync"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "source": "text",
  "external_subject_key": "text",
  "external_subject_id": "text",
  "entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "display_name": "text",
  "roles": [
    "text"
  ],
  "roles_verified": true,
  "status": "active",
  "provisioned_via": "roster_sync",
  "last_verified_at": "2026-07-10T21:26:19.599Z",
  "created_at": "2026-07-10T21:26:19.599Z",
  "updated_at": "2026-07-10T21:26:19.599Z"
}

Get External Role Assignment

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

assignment_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstring · uuidRequired

sourcestringRequired

external_subject_keystringRequired

external_subject_idstring · nullableOptional

entity_idstring · uuidRequired

display_namestring · nullableOptional

rolesstring[]Required

roles_verifiedbooleanRequired

statusstring · enumRequiredPossible values:

provisioned_viastring · enumRequiredPossible values:

last_verified_atstring · date-time · nullableOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

404

Assignment not found

422

Validation Error

application/json

get/v1/{workspace_id}/external-role-assignments/{assignment_id}

HTTPcURLJavaScriptPython

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "source": "text",
  "external_subject_key": "text",
  "external_subject_id": "text",
  "entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "display_name": "text",
  "roles": [
    "text"
  ],
  "roles_verified": true,
  "status": "active",
  "provisioned_via": "roster_sync",
  "last_verified_at": "2026-07-10T21:26:19.599Z",
  "created_at": "2026-07-10T21:26:19.599Z",
  "updated_at": "2026-07-10T21:26:19.599Z"
}

Delete External Role Assignment

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

assignment_idstring · uuidRequired

Responses

204

Successful Response

No content

404

Assignment not found

422

Validation Error

application/json

delete/v1/{workspace_id}/external-role-assignments/{assignment_id}

HTTPcURLJavaScriptPython

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

No content