• Register

member.removeRole

Description

Assign revoke a role from a specific member.

There is a many to many relationship between roles and members.  This method is nessary for removing associations between members and roles.

Parameters

member

An member object, as described by the object.describe call.

role

An role object, as described by the object.describe call.

Response

A successful call to removeRole returns a result of null.

Examples

A Sample JSON-RPC Member Remove Role Request

{
    "method": "member.removeRole",
    "params": [
        {
            "username": "example_username"
        },
        {
            "id": 123
        }
    ],
    "id": 1
}

The JSON-RPC Response

{
    "result": null,
    "error": null,
    "id": 1
}

Permissions Required

The user who owns the key used to authenticate the member.update call must be a member of one of the following roles

  • Administrator
  • Program Manager
  • Community Manager

See authentication.

Errors

In addition to the standard json-rpc errors and authentication errors, member.update may also return these errors:

HTTP Status Code JSON-RPC Code Error Message Description
400 1100 This role cannot be assigned to a member Roles such as Member and Anonymous are assigned dynamically and cannot be assigned via this method.
400 1000 Invalid Object The combination of member and role are invalid or there is a pre-existing validation error with the member or role objects.
400 1002 Field "x" is required. The object could not be updated because a primary identifier was not passed to enable finding the member or role objects.
500 2002 This role could not be removed
 The role could not be removed from this member.  This is the error message of last resort for object updates and usually indicates a systems integration failure, invalid internal data, or a transient issue.  These errors are logged by Mashery.
400 5000 Object "type" with "key" of "value" could not be found The object could not be updated because it could not be found.

version 3 as of 13 years ago by Eric Delore

Docs Navigation