List Consumer Access

Endpoint

GET /apiops/projects/{projectName}/consumers/{consumerKey}/access

Authentication

Requires a Personal API Access Token.

Authorization: Bearer YOUR_TOKEN

Request

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
consumerKey	string	Yes	Consumer key, assigned by the installation. Returned as consumerKey by every consumer response

Response

200 OK with an array of access rows:

[
  {
    "name": "MyAPI",
    "type": "API_PROXY",
    "environments": [
      { "environmentName": "production", "enabled": true },
      { "environmentName": "test", "enabled": false }
    ],
    "disallowedEndpoints": [
      { "name": "/orders", "httpMethod": "DELETE" }
    ]
  },
  {
    "name": "MyGroup",
    "type": "API_PROXY_GROUP",
    "expireTime": "2027-12-31T23:59:59.000Z",
    "environments": [
      { "environmentName": "production", "enabled": true }
    ],
    "disallowedApiProxies": ["BillingAPI"]
  }
]

Field	Type	Description
name	string	Name of the API proxy or API proxy group
type	string	API_PROXY or API_PROXY_GROUP
expireTime	timestamp	Expiry of the grant, when set
environments	array	Environments of the project and whether the row may be called there. Each item has environmentName and enabled
disallowedEndpoints	array	API_PROXY rows only. Endpoints the consumer may not call. Each item has name (REST path or SOAP operation) and httpMethod
disallowedApiProxies	array of string	API_PROXY_GROUP rows only. Names of the API proxies of the group that the consumer may not call

To change one row, use Update Consumer Access to an API Proxy or Update Consumer Access to an API Proxy Group.

Permissions

• User must have IDENTITY + VIEW permission in the project
• A project outside the scope of the caller answers 404 resourceNotFound, never 403
• The admin project has no consumers: a call on it answers 400 malformedRequest (params.reason = platformScopeNotSupported)