CRecordUserDbRemoveRolesFromUser

Revoke rights from a user.

This message belongs to the Session Manager API.
The Session Manager is part of the NY_Session2PlugIn plugin.

{
  "id": "bcca4b32-dcad-429f-8c29-822f81c0c1ce",
  "name": "USER_DB_REMOVE_ROLES_FROM_USER",
  "description": "Remove some roles from a user.",
  "slots": [
    {
      "key": "1",
      "name": "USER_ID",
      "direction": "REQUEST",
      "mandatory": "true",
      "type": "STRING",
      "description": "The user id."
    },
    {
      "key": "2",
      "name": "ROLES",
      "direction": "REQUEST",
      "mandatory": "true",
      "type": "STRING_ARRAY",
      "description": "The roles."
    }
  ]
}

Usage

Sending the request

You need the microservice ID of the session manager:

public static final IId SESSION_MICROSERVICE_ID = CIdFactory.fromObject("ccf168c1-f18b-4229-85f9-24461a19ee6a");

The own SessionToken is needed to verify the authorization for the change. You need the permission NY_RemoveRoleFromUser. In addition, the user ID and the list of roles are required.

private void revokeRolesFromUser(final byte[] aToken,
                                 @NotNull final String aUserId,
                                 @NotNull final String[] aRoles) throws CException
{
    final CEnvelope env = CEnvelope.forMicroService(SESSION_MICROSERVICE_ID);
    env.setSessionToken(aToken);

    final CRecord record = CRecordUserDbRemoveRolesFromUser.create();
    CRecordUserDbRemoveRolesFromUser.setUserId(record,
                                               aUserId);
    CRecordUserDbRemoveRolesFromUser.setRoles(record,
                                              aRoles);

    sendRequest(env,
                record);
}

Dealing with the response

To catch the response of the request, we need a message handler. We add it in the constructor of the message handler registry.

// constructor:
addMessageHandler(CRecordUserDbRemoveRolesFromUser.ID,
                  this::asyncRevokeRolesFromUser);

private boolean asyncRevokeRolesFromUser(@NotNull final CEnvelope aEnvelope,
                                         @NotNull final CRecord aRecord)
{
    if (aEnvelope.isAnswer())
    {
        final int resultCode = aEnvelope.getResultCode();
        if (resultCode == CResultCode.SUCCESS)
        {
            // ...
        }
        return true;
    }
    return false;
}