| Info |
|---|
This document applies to COmanage Registry version 4.x and earlier. |
| Panel | |
|---|---|
|
Authentication
Authentication is via a proxy or delegated model, where the REST client is treated as an administrative user by the Registry. The client, where appropriate, indicates which target subject it wishes to act on behalf of.
...
Note: POST may work for edit due to default CakePHP functionality but is not supported.
Adding a New API User
| Info |
|---|
All API Users currently have full access to all Registry data across all COs. (CO-91) |
...
It may make sense to, by policy, only allow login identifiers in eppn format (with an @) and to only allow API User Names not in that format (without an @).
Object Formats
The REST API supports different formats for representing data object passed. Each format may convey the following special variables:
- Object Type: The type of object represented in the request, as defined for each data type.
- Object Version: The version of the object represented in the request, as defined for each data type.
URL
For methods such as GET that pass arguments as part of the URL, arguments are positional as defined for each data type.
JSON
This format is supported for requests and responses.
XML
This format is supported for requests and responses.
| Warning |
|---|
The XML format is deprecated as of Registry v3.1.0, and will be removed in Registry v4.0.0 (CO-1555). |
VOOT
This format is experimental. See VOOT API for more information.
Request and Response Formats
| 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. |
Timezones
All times processed (inbound and outbound) via the REST API are in UTC. For more information on timezones, see Understanding Registry Timezones.
API Reference
| API | Version | Available Since |
|---|---|---|
| 1.0 | v0.1 | |
| AttributeEnumeration | 1.0 | v2.0.0 |
| CO | 1.0 | v0.1 |
| COU | 1.0 | v0.2 |
| CoDepartment | 1.0 | v3.1.0 |
| CoEmailList | 1.0 | v3.1.0 |
| CoEnrollmentAttribute | 1.0 | v0.6 |
| CoExtendedAttribute | 1.0 | v0.2 |
| CoExtendedType | 1.0 | v0.6 |
| CoGroup | 1.0 | v0.1 |
| CoGroupMember | 1.0 | v0.1 |
| CoInvite | 1.0 | v0.1 |
| CoNavigationLink | 1.0 | v0.8.3 |
| CoNsfDemographics | 1.0 | v0.4 |
| CoOrgIdentityLink | 1.0 | v0.2 |
| CoPerson | 1.0 | v0.1 |
| CoPersonRole | 1.0 | v0.2 |
| CoPetition | 1.0 | |
| CoProvisioningTarget | 1.0 | |
| CoService | 1.0 | v3.1.0 |
| CoTAndCAgreement | 1.0 | v2.0.0 |
| CoTermsAndConditions | 1.0 | v2.0.0 |
| EmailAddress | 1.0 | v0.1 |
| HistoryRecord | 1.0 | v0.7 |
| Identifier | 1.0 | v0.1 |
| Name | 1.0 | v0.8.3 |
| NavigationLink | 1.0 | v0.8.3 |
| Organization | 1.0 | v0.1 |
| OrgIdentity | 1.0 | v0.2 |
| TelephoneNumber | 1.0 | v0.1 |
| Url | 1.0 | v3.1.0 |
Sample Clients
See REST API Examples.