v1

latestOpenAPI 3.1.0Apache 2.02026-07-2610193196.3 KB
Access control

Get ACL candidates

Get candidate users and teams that can be added to this entity's ACL

get/v1/{entityCollection}/{entityId}/acl/candidates

Path parameters

entityCollection'mock-apis' | 'data-sources' required

Specifies the plural of the entity type for which ACL candidates should be retrieved.

entityIdstring required
Example:jjl8y

The ID of the entity (mock API, data source etc.)

Query parameters

limitinteger
qstring

A filter for the retrieved items. Only items whose name contains the filter value will be retrieved. The filter is case insensitive.

Response

ACL candidates

Example response

{
  "candidates": [
    {
      "name": "All in organisation",
      "links": {
        "self": {
          "href": "/v1/mock-apis/l36le/acl/organisation/mgk7g"
        }
      }
    }
  ]
}