...
Note: POST may work for edit due to default CakePHP functionality but is not supported.
Adding a New API User (Registry v3.3.0 and later)
As of Registry v3.3.0, there are three types of API Users:
- Platform API Users: API Users created within the COmanage CO are given full access to the API, across all COs.
- Privileged CO API Users: API Users created within any other CO may be designated as Privileged, in which case they will have full access to the API within their CO.
- Unprivileged CO API Users: API Users not designated as Privileged will not have any access to the API by default, but may be granted specific access where supported, for example within a specific plugin.
API Users can be managed by a CO Administrator via CO >> Configuration >> API Users. Platform API Users are created the same way, via the COmanage CO.
API Users must have usernames prefixed with the name of the CO, followed by a dot. For example: MyCO.apiuser
Self-selected passwords are no longer supported for API Users. Instead, after the API User is created an API Key may be randomly generated. The API Key will be displayed once after generation, but is then hashed for internal storage and is unrecoverable. A new API Key can be generated if needed.
Adding a New API User (Earlier Versions)
| Info |
|---|
Prior to Registry v3.3.0, all API Users |
| Info |
All API Users currently have full access to all Registry data across all COs. (CO-91) |
Platform Administrators may add and manage API Users via Platform >> API Users.
...
| Warning |
|---|
The XML format is deprecated as of Registry v3.1.0, and will be removed in Registry v4v5.0.0 (CO-1555). |
VOOT
This format is experimental. See VOOT API for more information.
...
| Info | ||
|---|---|---|
| ||
In addition to the attributes defined in the Response formats for each Model, Models enabled for Changelog Behavior will return Changelog metadata as well ( Note that a request for a deleted, changelog enabled object will return a record (ie: a 200 response, not a 404 response). Examine the |
| Info | ||
|---|---|---|
| ||
If Attribute Enumerations are defined for an attribute, permitted values for that attribute are constrained to the enumerated values. Permitted values may be determined and set via the AttributeEnumeration API. |
...