Version: 8.0.x

Create Role

Create role#

To create a new role record you will need to make a TLS request to the OpenHIM API for the below method and endpoint and supply the JSON object for the role record.

Method: POST
Endpoint: {openhim_url}:8080/roles
Payload: JSON object of the role record

With a json body containing the role name and channels and clients to apply to. At least one channel or client has to be specified. Channels and clients can be specified either by their _id or name for a channel and clientID for a client.


Note: In the examples below, we are using the token authentication type to authenticate requests

Before we can send our request to the OpenHIM API we need to ensure that we construct our valid HTTP headers to successfully authenticate with the OpenHIM API.

Copy the below code at the bottom of your nodejs script that handles the authentication of the OpenHIM headers as described in the authentication section.

Replace the openhimOptions values with the correct implementation details and supply the SampleData payload to submit

// append below code to the "openhim-api.js" script containing the authentication methods.
// This is described within the authentication section
(async () => {
const openhimOptions = {
apiURL: 'https://localhost:8080',
apiEndpoint: '/roles',
username: '',
password: 'openhim-password',
rejectUnauthorized: false
const SampleData = 'SampleData'
const headers = await genAuthHeaders(openhimOptions)
const options = {
method: 'POST',
url: `${openhimOptions.apiURL}${openhimOptions.apiEndpoint}`,
rejectUnauthorized: openhimOptions.rejectUnauthorized,
headers: headers,
body: SampleData,
json: true
request(options, (error, response, body) => {
if (error) throw new Error(error)
statusCode: response.statusCode,

Execute the below command in your terminal to run the nodejs script

node openhim-api.js

The response status code will be 201 if successful.