Administration

Identity, roles, invitations, permissions, and organization administration endpoints.

Restore the deployment default for an editable AI route

DELETE/api/admin/ai/routes/{workload}

Path Parameters

workload*string

Value in

"ASSISTANT_CHAT"
"PROMPT_EXECUTION"
"KEYWORD_PLANNING"
"GRAPH_EXTRACTION"
"QUERY_EMBEDDING"
"DOCUMENT_EMBEDDING"

Response Body

curl -X DELETE "https://example.com/api/admin/ai/routes/ASSISTANT_CHAT"

Empty

Set an editable organization AI route

PUT/api/admin/ai/routes/{workload}

Path Parameters

workload*string

Value in

"ASSISTANT_CHAT"
"PROMPT_EXECUTION"
"KEYWORD_PLANNING"
"GRAPH_EXTRACTION"
"QUERY_EMBEDDING"
"DOCUMENT_EMBEDDING"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

gatewayProfileId?string

Formatuuid

modelId?string

Response Body

`/`

curl -X PUT "https://example.com/api/admin/ai/routes/ASSISTANT_CHAT" \  -H "Content-Type: application/json" \  -d '{}'

{  "workload": "ASSISTANT_CHAT",  "gatewayKey": "string",  "gatewayProfileId": "f06cd0be-874c-4219-9121-dfbe44e1179a",  "modelId": "string",  "source": "string",  "editable": true,  "version": 0}

Disable an unused organization AI gateway

DELETE/api/admin/ai/gateways/{profileId}

Path Parameters

profileId*string

Formatuuid

Response Body

curl -X DELETE "https://example.com/api/admin/ai/gateways/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Update an organization AI gateway

PUT/api/admin/ai/gateways/{profileId}

Path Parameters

profileId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

displayName?string

baseUrl?string

requestTimeoutSeconds?integer

Formatint32

credential?string

Response Body

`/`

curl -X PUT "https://example.com/api/admin/ai/gateways/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "gatewayKey": "string",  "displayName": "string",  "preset": "OPENAI",  "category": "DIRECT_PROVIDER",  "protocol": "OPENAI_COMPATIBLE",  "baseUrl": "string",  "requestTimeoutSeconds": 0,  "enabled": true,  "version": 0,  "credentialSet": true,  "credentialSetByUserId": "f3dfa348-e45a-431d-85d5-e0140ba2b395",  "credentialSetAt": "2019-08-24T14:15:22Z"}

Set or rotate an organization AI gateway credential

PUT/api/admin/ai/gateways/{profileId}/credential

Path Parameters

profileId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

credential?string

Response Body

curl -X PUT "https://example.com/api/admin/ai/gateways/497f6eca-6276-4993-bfeb-53cbbbba6f08/credential" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Assign a user to a role

POST/api/admin/roles/{role}/members

Path Parameters

role*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

userId?string

Formatuuid

Response Body

curl -X POST "https://example.com/api/admin/roles/string/members" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List Knowledge Spaces and the grants stored against them

GET/api/admin/knowledge-spaces

Response Body

`/`

curl -X GET "https://example.com/api/admin/knowledge-spaces"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "key": "string",    "name": "string",    "departmentId": "a3452d1e-b055-4677-aa66-858ddc0a1f59",    "active": true,    "grants": [      {        "relation": "string",        "subject": "string"      }    ],    "grantsComplete": true,    "policyVersion": "string"  }]

Create a Knowledge Space

POST/api/admin/knowledge-spaces

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

departmentId?string

Formatuuid

Response Body

`/`

curl -X POST "https://example.com/api/admin/knowledge-spaces" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "key": "string",  "name": "string",  "departmentId": "a3452d1e-b055-4677-aa66-858ddc0a1f59",  "active": true,  "grants": [    {      "relation": "string",      "subject": "string"    }  ],  "grantsComplete": true,  "policyVersion": "string"}

Grant a subject access to a Knowledge Space

POST/api/admin/knowledge-spaces/{knowledgeSpaceId}/grants

Path Parameters

knowledgeSpaceId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

relation?string

kind?string

Value in

"ORGANIZATION"
"DEPARTMENT"
"DEPARTMENT_MANAGERS"
"ROLE"
"USER"

subjectId?string

Formatuuid

role?string

Response Body

curl -X POST "https://example.com/api/admin/knowledge-spaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/grants" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Revoke a subject's access to a Knowledge Space

DELETE/api/admin/knowledge-spaces/{knowledgeSpaceId}/grants

Path Parameters

knowledgeSpaceId*string

Formatuuid

Query Parameters

relation*string

kind*string

Value in

"ORGANIZATION"
"DEPARTMENT"
"DEPARTMENT_MANAGERS"
"ROLE"
"USER"

subjectId?string

Formatuuid

role?string

Response Body

curl -X DELETE "https://example.com/api/admin/knowledge-spaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/grants?relation=string&kind=ORGANIZATION"

Empty

List invited addresses and their status

GET/api/admin/invitations

Response Body

`/`

curl -X GET "https://example.com/api/admin/invitations"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "email": "string",    "role": "EMPLOYEE",    "departmentId": "a3452d1e-b055-4677-aa66-858ddc0a1f59",    "status": "string",    "invitedAt": "2019-08-24T14:15:22Z",    "acceptedAt": "2019-08-24T14:15:22Z",    "acceptedAppUserId": "3c7653f8-bfce-4105-b20c-256d5fef91a3"  }]

POST/api/admin/invitations

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email?string

role?string

Value in

"EMPLOYEE"
"TEAM_LEAD"
"MANAGER"
"DIRECTOR"
"EXECUTIVE"
"ADMIN"

departmentId?string

Formatuuid

Response Body

`/`

curl -X POST "https://example.com/api/admin/invitations" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "email": "string",  "role": "EMPLOYEE",  "departmentId": "a3452d1e-b055-4677-aa66-858ddc0a1f59",  "status": "string",  "invitedAt": "2019-08-24T14:15:22Z",  "acceptedAt": "2019-08-24T14:15:22Z",  "acceptedAppUserId": "3c7653f8-bfce-4105-b20c-256d5fef91a3"}

List organization AI gateway profiles

GET/api/admin/ai/gateways

Response Body

`/`

curl -X GET "https://example.com/api/admin/ai/gateways"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "gatewayKey": "string",    "displayName": "string",    "preset": "OPENAI",    "category": "DIRECT_PROVIDER",    "protocol": "OPENAI_COMPATIBLE",    "baseUrl": "string",    "requestTimeoutSeconds": 0,    "enabled": true,    "version": 0,    "credentialSet": true,    "credentialSetByUserId": "f3dfa348-e45a-431d-85d5-e0140ba2b395",    "credentialSetAt": "2019-08-24T14:15:22Z"  }]

Connect an organization AI gateway

POST/api/admin/ai/gateways

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

gatewayKey?string

displayName?string

preset?string

Value in

"OPENAI"
"ANTHROPIC"
"NINE_ROUTER"
"OPENROUTER"
"LITELLM"
"OLLAMA"
"OPENAI_COMPATIBLE"

category?string

Value in

"DIRECT_PROVIDER"
"GATEWAY_ROUTER"
"SELF_HOSTED_CUSTOM"

protocol?string

Value in

"OPENAI_COMPATIBLE"
"ANTHROPIC_MESSAGES"

baseUrl?string

requestTimeoutSeconds?integer

Formatint32

credential?string

Response Body

`/`

curl -X POST "https://example.com/api/admin/ai/gateways" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "gatewayKey": "string",  "displayName": "string",  "preset": "OPENAI",  "category": "DIRECT_PROVIDER",  "protocol": "OPENAI_COMPATIBLE",  "baseUrl": "string",  "requestTimeoutSeconds": 0,  "enabled": true,  "version": 0,  "credentialSet": true,  "credentialSetByUserId": "f3dfa348-e45a-431d-85d5-e0140ba2b395",  "credentialSetAt": "2019-08-24T14:15:22Z"}

Test a stored organization AI gateway

POST/api/admin/ai/gateways/{profileId}/test

Path Parameters

profileId*string

Formatuuid

Response Body

`/`

curl -X POST "https://example.com/api/admin/ai/gateways/497f6eca-6276-4993-bfeb-53cbbbba6f08/test"

{  "authenticated": true,  "models": [    {      "id": "string",      "displayName": "string"    }  ],  "errorCode": "string"}

Test an AI gateway credential without storing it

POST/api/admin/ai/gateways/test

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

preset?string

Value in

"OPENAI"
"ANTHROPIC"
"NINE_ROUTER"
"OPENROUTER"
"LITELLM"
"OLLAMA"
"OPENAI_COMPATIBLE"

protocol?string

Value in

"OPENAI_COMPATIBLE"
"ANTHROPIC_MESSAGES"

baseUrl?string

requestTimeoutSeconds?integer

Formatint32

credential?string

Response Body

`/`

curl -X POST "https://example.com/api/admin/ai/gateways/test" \  -H "Content-Type: application/json" \  -d '{}'

{  "authenticated": true,  "models": [    {      "id": "string",      "displayName": "string"    }  ],  "errorCode": "string"}

Answer whether a user holds a permission on one resource, and by which derivation

POST/api/admin/access/explain

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

userId?string

Formatuuid

permission?string

resourceType?string

resourceId?string

Formatuuid

Response Body

`/`

curl -X POST "https://example.com/api/admin/access/explain" \  -H "Content-Type: application/json" \  -d '{}'

{  "state": "ALLOWED",  "reasonCode": "string",  "path": [    {      "object": "string",      "relation": "string",      "kind": "string"    }  ],  "blockedBy": [    {      "branch": "string",      "kind": "string",      "detail": "string"    }  ],  "provenance": {    "authority": "string",    "origin": "string",    "generation": 0,    "capturedAt": "2019-08-24T14:15:22Z",    "expired": true  },  "policyVersion": "string",  "evaluatedAt": "2019-08-24T14:15:22Z"}

Change a user's role or activation

PATCH/api/admin/users/{userId}

Path Parameters

userId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

role?string

Value in

"EMPLOYEE"
"TEAM_LEAD"
"MANAGER"
"DIRECTOR"
"EXECUTIVE"
"ADMIN"

active?boolean

Response Body

`/`

curl -X PATCH "https://example.com/api/admin/users/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "email": "string",  "role": "EMPLOYEE",  "departmentId": "a3452d1e-b055-4677-aa66-858ddc0a1f59",  "active": true,  "signInLinked": true,  "mappedPrincipalCount": 0}

GET/api/admin/users

Response Body

`/`

curl -X GET "https://example.com/api/admin/users"

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "email": "string",    "role": "EMPLOYEE",    "departmentId": "a3452d1e-b055-4677-aa66-858ddc0a1f59",    "active": true,    "signInLinked": true,    "mappedPrincipalCount": 0  }]

Resolve a user's organization permissions as the engine currently answers them

GET/api/admin/users/{userId}/permissions

Path Parameters

userId*string

Formatuuid

Response Body

`/`

curl -X GET "https://example.com/api/admin/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/permissions"

{  "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",  "permissions": {    "property1": "ALLOWED",    "property2": "ALLOWED"  },  "evaluatedAt": "2019-08-24T14:15:22Z"}

List roles and who is assigned to them

GET/api/admin/roles

Response Body

`/`

curl -X GET "https://example.com/api/admin/roles"

{  "roles": [    {      "role": "string",      "assignees": [        "string"      ]    }  ],  "complete": true,  "policyVersion": "string"}

List the subject shapes each Knowledge Space relation accepts

GET/api/admin/knowledge-spaces/grant-options

Response Body

`/`

curl -X GET "https://example.com/api/admin/knowledge-spaces/grant-options"

[  {    "relation": "string",    "kinds": [      "ORGANIZATION"    ]  }]

List effective organization AI routes

GET/api/admin/ai/routes

Response Body

`/`

curl -X GET "https://example.com/api/admin/ai/routes"

[  {    "workload": "ASSISTANT_CHAT",    "gatewayKey": "string",    "gatewayProfileId": "f06cd0be-874c-4219-9121-dfbe44e1179a",    "modelId": "string",    "source": "string",    "editable": true,    "version": 0  }]

List provider presets implemented by this deployment

GET/api/admin/ai/providers

Response Body

`/`

curl -X GET "https://example.com/api/admin/ai/providers"

[  {    "preset": "OPENAI",    "displayName": "string",    "vendorName": "string",    "category": "DIRECT_PROVIDER",    "protocol": "OPENAI_COMPATIBLE",    "defaultBaseUrl": "string",    "baseUrlEditable": true  }]

Read immutable deployment-managed embedding settings

GET/api/admin/ai/index-settings

Response Body

`/`

curl -X GET "https://example.com/api/admin/ai/index-settings"

{  "embeddingProvider": "string",  "embeddingModel": "string",  "dimensions": 0,  "distanceMetric": "string",  "managementMode": "string",  "editable": true,  "lifecycleNote": "string"}

Remove a user from a role

DELETE/api/admin/roles/{role}/members/{userId}

Path Parameters

role*string

userId*string

Formatuuid

Response Body

curl -X DELETE "https://example.com/api/admin/roles/string/members/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Withdraw an invitation that has not been used

DELETE/api/admin/invitations/{invitationId}

Path Parameters

invitationId*string

Formatuuid

Response Body

curl -X DELETE "https://example.com/api/admin/invitations/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Administration

204

200*/*

204

200*/*

204

204

200*/*

201*/*

204

204

200*/*

201*/*

200*/*

201*/*

200*/*

200*/*

200*/*

200*/*

200*/*

200*/*

200*/*

200*/*

200*/*

200*/*

200*/*

204

204

`/`

`/`

`/`

`/`

`/`

`/`

`/`

`/`

`/`

`/`

`/`

`/`

`/`

`/`

`/`

`/`

`/`

`/`

`/`