Disable Account User

Beta

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

This endpoint is idempotent. Learn more

Disables (locks) an account user.

Disabled users cannot access the account and their active sessions are revoked, but the membership and its role assignment are kept so access can be restored with the activate action. Disabling frees the seat the user occupied. Admin users cannot be disabled, you cannot disable yourself, and removed users must be activated before they can be disabled. Disabling an already-disabled user is a no-op.

Permission requiredValues:team:update

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

In a customer's accountValues:customers:update

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

In a supplier's accountValues:suppliers:update

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

idstring

ID of the account user to disable.

Responses

200

Successful response for Disable Account User

Disable Account User

import OpenMRP from '@openmrp/sdk';

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

const response = await client.identity.accountUsers.actions.disable('acus_e5zu8bde0z3h');

console.log(response);

import OpenMRP from '@openmrp/sdk';

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

const response = await client.identity.accountUsers.actions.disable('acus_e5zu8bde0z3h');

console.log(response);

200 example

{}

{}

Disable Account User

Authorization

Path Parameters

Responses