API entry-point

The API entry point is the base URL for all operations is:

https://admin.openathens.net/api/v1/OpenAthensDomainName/

The entry point resource allows a client to query the API for links to key resources available to the authenticated account.

Obtaining the entry point resource

Prerequisites

To query the entry point, a client application must

authenticate to the API as described in Authenticating to the API.

Procedure

Perform an authenticated POST request to the entry-point URL.

This returns an application/vnd.eduserv.iam.entryPoint-v1+json object. This contains information about the account that was used to authenticate to the API as well as links to key resources for the domain.

Example

CODE

Request:
POST /api/v1/example.org/ HTTP/1.1
Authorization: OAApiKey <api-key>
Response (success):
HTTP/1.1 200 OK
Content-Type: application/vnd.eduserv.iam.entryPoint-v1+json
 
{
    "account": {
       "href": "/api/v1/example.org/account/12345",
       "name": "expzzz"
    },
    "domain": {
       "id": "100",
       "name": "2",
       "displayName": "Example Domain"
    },
     "links" : [
                 {
                  "href" : "/example.org/account/query",
                  "rel" : "account:query",
                  "type" : "application/vnd.eduserv.iam.account-v1+json",
                  "method" : "get"
                 },
                 {
                   "href" : "/example.org/schema/account/personal",
                   "rel" : "down",
                   "type" : "application/vnd.eduserv.iam.admin.attributeSchema-v1+json",
                   "method" : "get"
                 },
                 {
                   "href" : "/example.org/schema/organisation",
                   "rel" : "down",
                   "type" : "application/vnd.eduserv.iam.admin.attributeSchema-v1+json",
                   "method" : "get"
                 }
 
            ... detail omitted
      ]
}

application/vnd.eduserv.iam.entryPoint-v1+json object

Object field	Description
account	Information about the account that was used to authenticate to the API (regardless of what authentication method was used).
domain	Information about the domain to which the entry point applies.