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.
The REST client is authenticated via a simple user/password pair transmitted over HTTPS as part of a basic auth transaction. More sophisticated authentication mechanisms, such as delegated SAML assertions, may be supported in the future.
Note: POST may work for edit due to default CakePHP functionality but is not supported.
TODO: add instructions for adding a new REST client.
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.
VOOT
This format is experimental. See VOOT API for more information.
Request and Response Formats
API Reference
- Address
- CO
- COU
- CoExtendedAttribute
- CoExtendedType
- CoGroup
- CoGroupMember
- CoInvite
- CoNavigationLink
- CoNsfDemographics
- CoOrgIdentityLink
- CoPerson
- CoPersonRole
- CoPetition
- CoProvisioningTarget
- CoTAndCAgreement
- CoTermsAndConditions
- EmailAddress
- HistoryRecord
- Identifier
- NavigationLink
- Organization
- OrgIdentity
- TelephoneNumber
See REST API Examples.