Remove Account User

Beta

PUT/v1/identity/account-users/{id}/actions/remove

This endpoint is idempotent. Learn more

Removes a user from the account you are acting in.

Removal is a soft delete: removed users are excluded from listings unless requested via removed_scope, they free the seat they occupied, and they can be restored with the activate action or by adding them again. Removing an already-removed user is a no-op. The user's profile itself is untouched, so their access to any other account they belong to is unaffected.

Permission requiredValues:team:delete

In your own account, the role behind your API key or agent must grant this permission.

In a customer's accountValues:customers:delete

When the OpenMRP-Account header names one of your customers, the role must grant this permission instead.

In a supplier's accountValues:suppliers:delete

When the OpenMRP-Account header names one of your suppliers, the role must grant this permission instead.

idstring

ID of the account user to remove.

Responses

200

Successful response for Remove Account User

Remove Account User

import OpenMRP from '@openmrp/sdk';

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

const action = await client.identity.accountUsers.actions.remove('acus_e5zu8bde0z3h');

console.log(action);

import OpenMRP from '@openmrp/sdk';

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

const action = await client.identity.accountUsers.actions.remove('acus_e5zu8bde0z3h');

console.log(action);

200 example

{}

{}

Remove Account User

Authorization

Path Parameters

Responses