List roles
get
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/roles
The API returns list of roles with a given criteria. It returns the first page of results ordered by name (ascending) by default.
Request
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 name of the role to be filtered. It is case insensitive filtering.Example:
ManageCloudRole
-
nameContains: string
Part of Role Name used to filter RolesExample:
CloudRole
-
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 ASC.Example:
name:DESC
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Roles returned successfully
Root Schema : RoleCollection
Type:
object
This is the representation of list of Roles.
Show Source
-
count(required): integer
The number of Roles in this pageExample:
20
-
items(required): array
items
The list of roles
-
links(required): object
links
The result set navigation links
Nested Schema : items
Type:
array
The list of roles
Show Source
-
Array of:
object RoleSummary
It represents a Role
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 : RoleSummary
Type:
object
It represents a Role
Match All
Show Source
-
object
allOf
RoleDetails
It represents a Role
Nested Schema : RoleDetails
Type:
object
It represents a Role
Show Source
-
id: string
Read Only:
true
Unique identifier for a RoleExample:B0F9D83F6E313B03E0537013790ACA39
-
isPrivate: boolean
Role is a private role or notExample:
false
-
links: object
links
Read Only:
true
the Role related links -
name: string
Name of a RoleExample:
EM_ALL_ADMINISTRATOR
-
owner: string
Read Only:
true
User who owns the RoleExample:SYSMAN
-
type: array
type
Type of Role
Match All
Show Source
-
object
RoleCommonDetails
It represents some information of a Role
Nested Schema : RoleCommonDetails
Type:
object
It represents some information of a Role
Show Source
-
description: string
Description about the RoleExample:
Role has privileges to perform Enterprise Manager administrative operations
-
isWithAdmin: boolean
Private Role has WITH_ADMIN or not. This attribute exists only for Private Roles.Example:
true
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