List grantees of a role
get
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/roles/{roleId}/grantees
The API returns list of grantees (whom this role has been granted) ordered by name (ascending) by default.
Request
Path Parameters
-
roleId(required): string
Id of a Role.
Query Parameters
-
limit: integer
Minimum Value:
1
Maximum Value:2000
For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. The api will return no more than the number specified as limit, but might not return that exact number.Default Value:20
-
name: string
Exact Grantee Name to be filteredExample:
EM_ADMIN_OPERATOR
-
nameContains: string
Part of Grantee Name used to filter GranteesExample:
ADMIN
-
page: string
System generated page token of a page.
-
sort: string
The order of the result set with direction. Allowed sort field is name. Allowed directions are DESC and ASCExample:
name:DESC
-
type: string
Type of GranteeExample:
User
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Grantees of the Role returned successfully
Root Schema : GranteeCollection
Type:
object
This is the representation of list of Grantees ordered by name in ASC order by default.
Show Source
-
count(required): integer
The number of Grantees in this pageExample:
20
-
items(required): array
items
The grantee list
-
links(required):
links
The result set navigation links
Nested Schema : items
Type:
array
The grantee list
Show Source
-
Array of:
object GranteeSummary
It represents User or Role to whom a Role is granted
Nested Schema : links
Type:
object
The result set navigation links
Show Source
-
next: object
Link
Represents a link(could be self, previous or next)
-
previous: object
Link
Represents a link(could be self, previous or next)
-
self: object
Link
Represents a link(could be self, previous or next)
Nested Schema : GranteeSummary
Type:
object
It represents User or Role to whom a Role is granted
Show Source
-
id: string
Read Only:
true
Unique identifier for a Grantee (User or Role)Example:B0F9D83F6E313B03E0537013790ACA39
-
isWithAdmin: boolean
If a Grantee is a User, this flag says whether the Private Role has been granted as WITH_ADMINExample:
true
-
links: object
links
Read Only:
true
The Grantee related links -
name: string
Name of a GranteeExample:
TEST_SUPER_ADMIN
-
type: array
type
Type of Grantee
Nested Schema : links
Type:
object
Read Only:
true
The Grantee related links
Show Source
-
self: object
Link
Represents a link(could be self, previous or next)
Nested Schema : type
Type:
array
Type of Grantee
Show Source
-
Array of:
string
Allowed Values:
[ "User", "Role" ]
This is the representation of types of Grantees.
Example:
User
Nested Schema : Link
Type:
object
Represents a link(could be self, previous or next)
Show Source
-
href: string
URL for LinkExample:
/em/api/<resources>?page=b2Zmc2V0OjA&limit=0
400 Response
Bad Request
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
401 Response
Unauthorized
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
403 Response
Forbidden
Root Schema : MissingPrivErrorResponse
Type:
object
Response sent back as an Error in case required privileges are missing
Show Source
-
missingPrivileges: array
missingPrivileges
Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object
Match All
Show Source
-
object
ErrorResponse
Error response
Nested Schema : missingPrivileges
Type:
array
Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object
Show Source
-
Array of:
object MissingPrivilegeSummary
It represents a Privilege which is missing on a Resource to view or manage it.
Nested Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
Nested Schema : MissingPrivilegeSummary
Type:
object
It represents a Privilege which is missing on a Resource to view or manage it.
Show Source
-
displayName: string
Display Name of PrivilegeExample:
Manage
-
name: string
Name of PrivilegeExample:
MANAGE_JOB
404 Response
Not Found
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
500 Response
Internal Server Error
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
503 Response
Service Unavailable
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
Default Response
Unexpected Error
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string