Credentials Integration Point

The Credentials Integration Point is used to register a client and their credentials (username or password). This is required when Oracle Health Insurance applications call RESTful services secured by Basic Authentication. The Integration Point summarizes registered clients.

Operations

GET

The GET operation returns an overview of the Oracle Health Insurance-defined or customer-defined REST Client use cases.

This operation is available at the following location:

http://<host>:<port>/<context-root>/credentials

The overview shows the credential key, the authentication feature, and identifies whether there is a credential registered for the use case.

The following example shows credentials for data replication in Oracle Health Insurance Authorizations:

{
  "credentialStatuses": [
    {
      "credentialKey": "DataReplicationPersonEntities",
      "credentialRegistered": true,
      "customerDefined": false,
      "authenticationFeature": "BasicAuthentication",
      "links": [
        {
          "href": "https://host:port/api/credentials/DataReplicationPersonEntities",
          "rel": "self"
        }
      ]
    },
    {
      "credentialKey": "DataReplicationPersonEvents",
      "credentialRegistered": true,
      "customerDefined": false,
      "authenticationFeature": "BasicAuthentication",
      "links": [
        {
          "href": "https://host:port/api/credentials/DataReplicationPersonEvents",
          "rel": "self"
        }
      ]
    }
  ]
}

PUT

The PUT operation registers a credential for a client (credential key) in the OPSS credential store. It updates an existing credential or creates one.

This operation is available at the following location:

http://<host>:<port>/<context-root>/credentials/{credential_key}

It accepts a credential in the following JSON format:

{
  "username": "a_username",
  "password": "a_secret_password"
}

DELETE

This operation deletes the credential with the given credential key. The operation returns an HTTP 404 (Not Found) response if it does not find a credential for the specified credential key. It returns an HTTP 204 (No Content) response if the operation succeeds.

This operation is available at the following location:

http://<host>:<port>/<context-root>/credentials/{credential_key}