List privileges granted to a user
get
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/users/{userId}/privilegeGrants
The API returns list of privileges given to the user ordered by name (ascending) by default.
Request
Path Parameters
-
userId(required): string
Id of a User.
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 Privilege to be filteredExample:
MANAGE_TARGET_COMPLIANCE
-
nameContains: string
Part of Privilege Name used to filter Privilege GrantsExample:
MANAGE
-
page: string
System generated page token of a page.
-
secureResourceType: string
Security Class of the PrivilegeExample:
JOB
-
sort: string
The order of the result set with direction. Allowed sort field is name. Allowed directions are DESC and ASCExample:
name:DESC
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Privilege Grants of the User returned successfully
Root Schema : PrivilegeGrantCollection
Type:
object
This is the representation of List of Privileges given to a User or to another Role.
Show Source
-
count(required): integer
The number of Privilege Grants in this pageExample:
20
-
items(required): array
items
List of Privilege Grants
-
links(required): object
links
The result set navigation links
Nested Schema : items
Type:
array
List of Privilege Grants
Show Source
-
Array of:
object PrivilegeGrantSummary
Privilege Grant to a User or to 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 : PrivilegeGrantSummary
Type:
object
Privilege Grant to a User or to a Role
Show Source
-
description: string
Read Only:
true
Description about the PrivilegeExample:Ability to view Jobs
-
displayName: string
Read Only:
true
Display name of the PrivilegeExample:View Report
-
links: object
links
links related to the privilege grant
-
name: string
Name of a PrivilegeExample:
VIEW_TARGET
-
scope: array
scope
Read Only:
true
Scope of the Privilege -
secureResourceType: string
Read Only:
true
SecureResource Type of the PrivilegeExample:JOB
Nested Schema : links
Type:
object
links related to the privilege grant
Show Source
-
privilege: object
Link
Represents a link(could be self, previous or next)
-
secureResources: object
Link
Represents a link(could be self, previous or next)
Nested Schema : scope
Type:
array
Read Only:
true
Scope of the Privilege
Show Source
-
Array of:
string
Allowed Values:
[ "INSTANCE", "CLASS", "SYSTEM", "SET" ]
This is the representation of scopes of privileges.
Example:
INSTANCE
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