Manage User

The endpoint to update user active status

To activate a user: https://{server.com}/api/v2/tenants/client-uuid/users/USR0000000029/ACTIVATE

To Terminate a user: https://{server.com}/api/v2/tenants/client-uuid/users/USR0000000029/TERMINATE

To deactivate a user: https://{server.com}/api/v2/tenants/client-uuid/users/USR0000000029/DEACTIVATE

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • userIdstringrequired

    Unique Identifier (UUID) for OpsRamp user

  • actionstringrequired

    System defned actions on the client by the tenant

    Enum:
    ACTIVATEDEACTIVATETERMINATE

Request Body

application/json

  • deactivateReasonstring

    Reason for deactivation.

  • terminateReasonstring

    Reason for termination.

  • maskTypestringrequired

    maskType can be either PARTIAL or FULL

Loading Examples...

Responses

200OK