Skip to main content
GET
/
v1
/
{entityCollection}
/
{entityId}
/
acl
/
candidates
Get ACL candidates
curl --request GET \
  --url https://wmc.wiremockapi.cloud/v1/{entityCollection}/{entityId}/acl/candidates \
  --header 'Authorization: <api-key>'
{
  "candidates": [
    {
      "name": "All in organisation",
      "links": {
        "self": {
          "href": "/v1/mock-apis/l36le/acl/organisation/mgk7g"
        }
      }
    },
    {
      "name": "Elite Team",
      "links": {
        "self": {
          "href": "/v1/mock-apis/l36le/acl/team/p9e4r"
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Your API key prefixed by 'Token '

Path Parameters

​
entityCollection
enum<string>
required

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

Available options:
mock-apis,
data-sources
​
entityId
string
required

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

Required string length: 5 - 10
Example:

"jjl8y"

Query Parameters

​
limit
integer
Required range: x >= 1
​
q
string

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

Response

200 - application/json

ACL candidates

​
candidates
object[]
required
⌘I