Service Guides for ResourceIQ

Investigate use cases. Find sample scenarios. Learn how your applications can best use ResourceIQ.

Create Administrative Access Details

The create administrative access details endpoint allows you to capture administrative access details related to the administration of an online service, such as EBSCOhost.

To Create Administrative Access Details (example):

Gather the following information for the request:

  • The customer ID and the API Key.
  • Define the administrative access details payload. More information about the elements in the administrative access details payload can be found in the AdminAccessPayload definition.

Request

POST https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/adminaccess
Body Request Parameter

{
  "accessConfirmedStatus": "Not Started",
  "accessModel": "Rolling 2 years",
  "accessModelNotes": "Sample Access Model Notes",
  "accessRestrictionNotes": "Sample Access Restriction Notes",
  "adminAccessInterface": "Sample Name of Interface",
  "adminAccessInterfaceProvider": "Sample interface provider",
  "athensAuthenticationSupported": "Yes",
  "authenticationNotes": "Sample authentication notes.",
  "customerCanChoosePassword": "Yes",
  "dateIPRegistered": "2000-10-10T10:10:10.000Z",
  "extensionObject": {
    "objectDescription": "Sample Description",
    "objectType": "admin_access",
    "status": "active"
  },
  "hostID": "10160",
  "hostURL": "http://hostname.com",
  "ipAddressNotes": "Sample IP address notes.",
  "ipAddresses": "172.16.254.1",
  "ipAuthenticationSupported": "Yes",
  "otherStatusKeyValue": {
    "status1": "value1",
    "status2": "value2",
    "status3": "value3"
  },
  "otherStringKeyValue": {
    "string1": "value1",
    "string2": "value2",
    "string3": "value3"
  },
  "otherYesNoKeyValue": {
    "yesNo1": "yesNo1",
    "yesNo2": "yesNo2",
    "yesNo3": "yesNo3"
  },
  "passwordSharingAllowed": "Yes",
  "proxyAllowed": "No",
  "registrationID": "121234",
  "registrationInstructions": "Sample registration instructions.",
  "registrationStatus": "In Progress",
  "registrationURL": "http://hostname.com",
  "remoteAccessAllowed": "No",
  "shibbolethAuthenticationSupported": "No",
  "usernamePasswordAuthenticationSupported": "Yes"
}



Response

201 CREATED

{
  "adminAccessId": "79257642-5f9b-4316-82bc-778e3bc1e223",
  "errors": [],
  "successful": true
}

For more information on the POST create administrative access details resource, please refer to our interactive or service reference documentation.