List privileges

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/privileges

The API returns list of privileges ordered by name (ascending) by default.

Request

Query Parameters
  • 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
  • Exact Name of Privilege to be filtered
    Example:
    MANAGE_JOB
  • Part of Privilege Name used to filter Privileges
    Example:
    MANAGE_JOB
  • System generated page token of a page.
  • SecureResource Type of Privilege
    Allowed Values: [ "ALL", "SYSTEM", "<Any SecureResourceType like TARGET, JOB etc>" ]
    Example:
    JOB
  • 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 Top

Response

Supported Media Types

200 Response

List of Privileges returned successfully
Body ()
Root Schema : PrivilegeCollection
Type: object
This is the representation of list of Privileges.
Show Source
Nested Schema : items
Type: array
The privilege list
Show Source
Nested Schema : PrivilegeSummary
Type: object
It represents a Privilege
Show Source
Nested Schema : applicableTypes
Type: array
SecureResource Type for which the privilege is applicable.
Show Source
Nested Schema : includedPrivileges
Type: array
Privileges which are already part of this privilege
Show Source

401 Response

Unauthorized
Body ()
Root Schema : ErrorResponse
Type: object
Response sent back in the case of an error.
Show Source

403 Response

Forbidden
Body ()
Root Schema : MissingPrivErrorResponse
Type: object
Response sent back as an Error in case required privileges are missing
Show Source
Match All
Response sent back as an Error in case required privileges are missing
Show Source
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
Nested Schema : ErrorResponse
Type: object
Response sent back in the case of an error.
Show Source
Nested Schema : MissingPrivilegeSummary
Type: object
It represents a Privilege which is missing on a Resource to view or manage it.
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : ErrorResponse
Type: object
Response sent back in the case of an error.
Show Source

503 Response

Service Unavailable
Body ()
Root Schema : ErrorResponse
Type: object
Response sent back in the case of an error.
Show Source

Default Response

Unexpected Error
Body ()
Root Schema : ErrorResponse
Type: object
Response sent back in the case of an error.
Show Source
Back to Top