Delete Role

Beta

DELETE/v1/identity/roles/{id}

This endpoint is idempotent. Learn more

Deletes a role along with the permissions granted through it.

Only roles owned by your account can be deleted; the system-owned roles shared across all accounts cannot. A role that is still assigned to at least one user is rejected, so move those users to another role first.

Permissions requiredValues:roles:delete

The role behind your API key or agent must grant every one of these permissions.

idstring

Role ID.

Responses

200

Successful response for Delete Role

Delete Role

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const role = await client.identity.roles.delete('rl_3xknmfqflhvb');

console.log(role);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const role = await client.identity.roles.delete('rl_3xknmfqflhvb');

console.log(role);

200 example

{}

{}

Delete Role

Authorization

Path Parameters

Responses