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 |
| Suspend | POST | /consumer-organizations/{code}/actions/suspend | Stop the traffic of the organization and the organizations below it; reversible |
| Resume | POST | /consumer-organizations/{code}/actions/resume | Lift the suspension and re-enable the consumers the suspend disabled |
| Revoke credentials | POST | /consumer-organizations/{code}/actions/revoke-credentials | Permanently revoke the organization's consumers and every token issued before the call |
Permissions
| Operation | Required Permission |
|---|---|
| List, Get | IDENTITY + VIEW |
| Create, Update, Delete, Suspend, Resume, Revoke credentials | IDENTITY + MANAGE |
A project outside the scope of the caller answers 404 resourceNotFound. The admin project has no consumer organizations: a CRUD call on it answers 400 malformedRequest (params.reason = platformScopeNotSupported). The three actions are the exception: they are also accepted on the admin project's path for a System Administrator, Portal Business or Portal Manager, who pass for any organization. A caller who has only the project's Identity permission passes for an organization of that project that holds no portal application and no record filed under another project, the organizations below it included; any other organization answers that caller 403 permissionDenied.