External Identity Bindings

List External Identity Bindings

get

Authorizations

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[]OptionalDeprecatedDefault: []

limitinteger · max: 200OptionalDefault: 50

continuation_tokenanyOptional

external_integration_idstring · uuid · nullableOptional

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenanyOptional

422

Validation Error

application/json

get/v1/{workspace_id}/external-identity-bindings

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

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "external_integration_id": "123e4567-e89b-12d3-a456-426614174000",
      "subject_type": "text",
      "entity_id": "123e4567-e89b-12d3-a456-426614174000",
      "display_name": "text",
      "status": "active",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "has_more": true,
  "continuation_token": null
}

Upsert External Identity Binding

put

Authorizations

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

external_integration_idstring · uuidRequired

external_subject_keystring · min: 1 · max: 512Required

entity_idstring · uuidRequired

sourcestring · max: 128 · nullableOptionalDeprecated

display_namestring · max: 512 · nullableOptional

Responses

200

Successful Response

application/json

idstring · uuidRequired

external_integration_idstring · uuidRequired

subject_typeconst: userRequired

entity_idstring · uuidRequired

sourcestring · nullableOptionalDeprecated

display_namestring · nullableOptional

statusstring · enumRequiredPossible values:

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

upsert_outcomestring · enumRequiredPossible values:

404

entity_id or active external integration not found in workspace

409

consumer subject already bound to another entity, or entity_id is a principal

422

Validation Error

application/json

502

Identity rejected the binding request

503

Identity service unavailable

put/v1/{workspace_id}/external-identity-bindings

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

{
  "external_integration_id": "123e4567-e89b-12d3-a456-426614174000",
  "external_subject_key": "text",
  "entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "display_name": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "external_integration_id": "123e4567-e89b-12d3-a456-426614174000",
  "subject_type": "text",
  "entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "display_name": "text",
  "status": "active",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "upsert_outcome": "created"
}

Get External Identity Binding

get

Authorizations

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

binding_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstring · uuidRequired

external_integration_idstring · uuidRequired

subject_typeconst: userRequired

entity_idstring · uuidRequired

sourcestring · nullableOptionalDeprecated

display_namestring · nullableOptional

statusstring · enumRequiredPossible values:

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

404

Binding not found

422

Validation Error

application/json

get/v1/{workspace_id}/external-identity-bindings/{binding_id}

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "external_integration_id": "123e4567-e89b-12d3-a456-426614174000",
  "subject_type": "text",
  "entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "display_name": "text",
  "status": "active",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Delete External Identity Binding

delete

Authorizations

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

binding_idstring · uuidRequired

Responses

204

Successful Response

No content

404

Binding not found

422

Validation Error

application/json

502

Identity rejected the clear request

503

Identity service unavailable

delete/v1/{workspace_id}/external-identity-bindings/{binding_id}

DELETE /v1/{workspace_id}/external-identity-bindings/{binding_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content