Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ekso.dev/llms.txt

Use this file to discover all available pages before exploring further.

Sample shape for ConfigAccessControl.

​
Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response. 
{
  "accessControlId": "<access-control_id>",
  "area": "example",
  "role": "<app-role>",
  "userGroup": [
    "example"
  ],
  "isSystem": false
}

​
Fields

FieldTypeRequiredNotes
entitystring • nullableServer-setSet by the server. Read-only on writes.
accessControlIdstringOptional
areastringRequired
roleAppRoleRequired
userGrouparray<string>Optional
isSystembooleanOptional
tenantIdstringServer-setSet by the server. Read-only on writes.
idstringServer-setSet by the server. Read-only on writes.
createdstring (date-time)Server-setSet by the server. Read-only on writes.
createdBystringServer-setSet by the server. Read-only on writes.
updatedstring (date-time)Server-setSet by the server. Read-only on writes.
updatedBystringServer-setSet by the server. Read-only on writes.
deletedbooleanServer-setSet by the server. Read-only on writes.

​
Used by

​
Request body

  • POST /api/access-control
  • PUT /api/access-control

​
Response body

  • GET /api/access-control/{id}
  • GET /api/access-control

​
CLI

ekso access-control — see the command branches page for available verbs. Body for create / update verbs typically passed via --data @file.json matching the sample JSON above.