...
| API | API Version | Available Since Registry | Notes |
|---|---|---|---|
| 1.0 | v0.1 | ||
| AdHocAttribute | 1.0 | v3.3.0 | XML format not supported |
| ApplicationPreference | 1.0 | v4.0.0 | Limited purpose API in support of Registry user interface |
| AttributeEnumeration | 1.0 | v2.0.0 | Removed in Registry v4.0.0 |
| Cluster | 1.0 | v3.3.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 | |
| IdentityDocument | 1.0 | v4.0.0 | XML format not supported |
| Name | 1.0 | v0.8.3 | |
| NavigationLink | 1.0 | v0.8.3 | |
| Organization | 1.0 | v4.0.0 | XML format not supported The original schema for Registry v0.1, never implemented, is here |
| OrgIdentity | 1.0 | v0.2 | |
| Password | 1.0 | v3.3.0 | Implemented by Password Authenticator Plugin, experimental |
| SshKey | 1.0 | v3.3.0 | Implemented by SSH Key Authenticator Plugin, experimental |
| TelephoneNumber | 1.0 | v0.1 | |
| Unix Cluster | 1.0 | v3.3.0 | Implemented by Unix Cluster Plugin, experimental |
| Unix Cluster Account | 1.0 | v3.3.0 | Implemented by Unix Cluster Plugin, experimental |
| Unix Cluster Group | 1.0 | v3.3.0 | Implemented by Unix Cluster Plugin, experimental |
| Url | 1.0 | v3.1.0 |
OpenAPI (Swagger)
An initial, incomplete, and still evolving OpenAPI 3.0.x YAML description of the API is available in the develop branch.
You may use the Swagger container image to render the OpenAPI YAML:
| Code Block |
|---|
git clone https://github.com/Internet2/comanage-registry.git
pushd comanage-registry
git checkout develop
pushd app/Config/Schema
docker pull swaggerapi/swagger-ui
docker run \
-d \
--name swagger-ui \
-p 80:8080 \
-e SWAGGER_JSON=/opt/restapiv1.yaml \
-v ./restapiv1.yaml:/opt/restapiv1.yaml \
swaggerapi/swagger-ui |
Then browse to http://localhost to see the rendered API.
Sample Clients
See REST API Examples.