The "listRoles" action lists all the roles that the account is authorized to see. Includes roleName and roleDescription.
Request examples
Minimal
{
"action": "listRoles",
"params":
{
"partialNames": [ "ro" ],
"includeAccountRoles": true
}
}
Response examples
Minimal
{
"authToken": "",
"result": {
"roles": [
{
"roleName": "role1"
}
]
},
"requestId": "",
"errorCode": 0,
"errorMessage": ""
}
Properties
Request properties ("params")
| Property | Description | Default | Type | Limits (inclusive) |
|---|---|---|---|---|
includeAccountRoles |
The "includeAccountRoles" property causes the response to include account roles when true. |
false |
Boolean |
|
partialNames |
The |
Optional with default of []
|
array of strings | 1 to 30 bytes |
Response properties ("result")
| Property | Description | Type | Limits (inclusive) |
|---|---|---|---|
roles |
The "roles" property lists all the roles that match the filters set in the request. |
array of objects | 0 or more objects containing a "roleName". |
|
roles .roleName |
The "roleName" property specifies the name of a role. |
string | 1 to 30 bytes |