Consumer Organizations API
Overview
This API replaces the Credential Organizations API, which is deprecated. It uses the same write logic. Organizations are addressed by code, under /apiops/projects/{projectName}/consumer-organizations, and are not a sub-path of /consumers.
Endpoints
| Operation | Method | Endpoint | Description |
|---|---|---|---|
| List | GET | /consumer-organizations | List the organizations |
| Get | GET | /consumer-organizations/{code} | Read one organization |
| Create | POST | /consumer-organizations | Create an organization |
| Update | PUT | /consumer-organizations/{code} | Update an organization |
| Delete | DELETE | /consumer-organizations/{code} | Delete an organization |
Permissions
| Operation | Required Permission |
|---|---|
| List, Get | IDENTITY + VIEW |
| Create, Update, Delete | IDENTITY + MANAGE |
A project outside the scope of the caller answers 404 resourceNotFound. The admin project has no consumer organizations: a call on it answers 400 malformedRequest (params.reason = platformScopeNotSupported).