ConfigAccessControl

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

Field	Type	Required	Notes
`entity`	string • nullable	Server-set	Set by the server. Read-only on writes.
`accessControlId`	string	Optional
`area`	string	Required
`role`	`AppRole`	Required
`userGroup`	array<string>	Optional
`isSystem`	boolean	Optional
`tenantId`	string	Server-set	Set by the server. Read-only on writes.
`id`	string	Server-set	Set by the server. Read-only on writes.
`created`	string (date-time)	Server-set	Set by the server. Read-only on writes.
`createdBy`	string	Server-set	Set by the server. Read-only on writes.
`updated`	string (date-time)	Server-set	Set by the server. Read-only on writes.
`updatedBy`	string	Server-set	Set by the server. Read-only on writes.
`deleted`	boolean	Server-set	Set 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.

ConfigUserGroup

DataRole

Reference

Core

Items

Process

Fields

Constraints & Rules

People & Access

Time & Finance

Knowledge

Mail & Tickets

Operational

Settings

Sample JSON

Fields

Used by

Request body

Response body

CLI

​Sample JSON

​Fields

​Used by

​Request body

​Response body

​CLI

Sample JSON

Fields

Used by

Request body

Response body

CLI