alterRole

 

The "alterRole" action alters the metadata about an existing role. It cannot change the "roleName" because it is a unique identifier.

 

Request examples

Minimal

{
  "action": "alterRole",
  "params": {
    "roleName": "role1",
    "roleDescription": "The altered description.",
    "metadata": {
      "userDefinedField": "metadata"
    }
  },
  "authToken": "",
  "requestId": ""
}
 
 

 

Response examples

Minimal

{
  "authToken": "",
  "requestId": "",
  "errorCode": 0,
  "errorMessage": ""
}
 
 

 

Properties

Request properties ("params")

Property Description Default Type Limits (inclusive)

metadata

The "metadata" property contains user-defined properties that add keywords and tags about the role. The server indexes this field with a full-text index so you can search for any word or phrase to find code packages. Optional with default of {} object 0 or more key/value pairs

roleDescription

The "roleDescription" property defines the new role and provides notes for its use.  Optional with default of "" string 1 to 64 bytes

roleName

The "roleName" property specifies the name of an existing role.  Required - No default value string 1 to 30 bytes