Jump to

• Request
• Response

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

• 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 filtered

  Example:

  MANAGE_JOB

• nameContains: string
  Part of Privilege Name used to filter Privileges

  Example:

  MANAGE_JOB

• page: string
  System generated page token of a page.
• secureResourceType: string
  SecureResource Type of Privilege

  Allowed Values: [ "ALL", "SYSTEM", "<Any SecureResourceType like TARGET, JOB etc>" ]

  Example:

  JOB

• 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 Top

Response

Supported Media Types

• application/json

200 Response

List of Privileges returned successfully

Body ()

Root Schema : PrivilegeCollection

Type: object

This is the representation of list of Privileges.

Show Source

• count(required): integer
  The number of privileges

  Example: 20
• items(required): array items
  The privilege list
• links(required): links
  The result set navigation links

{
    "required":[
        "count",
        "items",
        "links"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of privileges",
            "example":20
        },
        "links":{
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "previous":{
                    "$ref":"#/components/schemas/Link"
                },
                "next":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"The result set navigation links"
        },
        "items":{
            "type":"array",
            "description":"The privilege list",
            "items":{
                "$ref":"#/components/schemas/PrivilegeSummary"
            }
        }
    },
    "description":"This is the representation of list of Privileges."
}

Nested Schema : items

Type: array

The privilege list

Show Source

• Array of: object PrivilegeSummary
  It represents a Privilege

{
    "type":"array",
    "description":"The privilege list",
    "items":{
        "$ref":"#/components/schemas/PrivilegeSummary"
    }
}

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)

{
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"The result set navigation links"
}

Nested Schema : PrivilegeSummary

Type: object

It represents a Privilege

Show Source

• applicableTypes: array applicableTypes
  SecureResource Type for which the privilege is applicable.
• description: string
  Description of Privilege

  Example: Ability to perform various operations except edit and delete on job
• displayName: string
  Display Name of Privilege

  Example: Manage
• includedPrivileges: array includedPrivileges
  Privileges which are already part of this privilege
• isDefault: boolean
  Default privilege when a SecureResource is picked up for a Non-Super Administrator

  Example: true
• isDefaultToSuperUser: boolean
  Default privilege when a SecureResource is picked up for a Super Administrator

  Example: false
• isGrantedToSuperUser: boolean
  Privilege is granted to Super User or not

  Example: false
• name: string
  Name of Privilege

  Example: MANAGE_JOB
• privilegeRequiredToGrant: string
  Privilege required to grant this privilege

  Example: GRANT_VIEW_JOB
• scope: string
  Scope of Privilege

  Example: Resource
• secureResourceType: string
  SecureResource Type of Privilege

  Example: JOB
• secureResourceTypeDescription: string
  Description of SecureResource type

  Example: Security class defines the access model behaviour for job
• secureResourceTypeDisplayName: string
  Display Name of SecureResource Type

  Example: Job System

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        },
        "description":{
            "type":"string",
            "description":"Description of Privilege",
            "example":"Ability to perform various operations except edit and delete on job"
        },
        "secureResourceType":{
            "type":"string",
            "description":"SecureResource Type of Privilege",
            "example":"JOB"
        },
        "includedPrivileges":{
            "type":"array",
            "description":"Privileges which are already part of this privilege",
            "items":{
                "type":"string",
                "example":"VIEW_JOB"
            }
        },
        "secureResourceTypeDescription":{
            "type":"string",
            "description":"Description of SecureResource type",
            "example":"Security class defines the access model behaviour for job"
        },
        "isGrantedToSuperUser":{
            "type":"boolean",
            "description":"Privilege is granted to Super User or not",
            "example":false
        },
        "secureResourceTypeDisplayName":{
            "type":"string",
            "description":"Display Name of SecureResource Type",
            "example":"Job System"
        },
        "scope":{
            "type":"string",
            "description":"Scope of Privilege",
            "example":"Resource"
        },
        "isDefault":{
            "type":"boolean",
            "description":"Default privilege when a SecureResource is picked up for a Non-Super Administrator",
            "example":true
        },
        "isDefaultToSuperUser":{
            "type":"boolean",
            "description":"Default privilege when a SecureResource is picked up for a Super Administrator",
            "example":false
        },
        "applicableTypes":{
            "type":"array",
            "description":"SecureResource Type for which the privilege is applicable.",
            "items":{
                "type":"string",
                "example":"oracle_database"
            }
        },
        "privilegeRequiredToGrant":{
            "type":"string",
            "description":"Privilege required to grant this privilege",
            "example":"GRANT_VIEW_JOB"
        }
    },
    "description":"It represents a Privilege"
}

Nested Schema : applicableTypes

Type: array

SecureResource Type for which the privilege is applicable.

Show Source

• Array of: string
  Example: oracle_database

{
    "type":"array",
    "description":"SecureResource Type for which the privilege is applicable.",
    "items":{
        "type":"string",
        "example":"oracle_database"
    }
}

Nested Schema : includedPrivileges

Type: array

Privileges which are already part of this privilege

Show Source

• Array of: string
  Example: VIEW_JOB

{
    "type":"array",
    "description":"Privileges which are already part of this privilege",
    "items":{
        "type":"string",
        "example":"VIEW_JOB"
    }
}

Nested Schema : Link

Type: object

Represents a link(could be self, previous or next)

Show Source

• href: string
  URL for Link

  Example: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

401 Response

Unauthorized

Body ()

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

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

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

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"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",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Match All

Show Source

• object ErrorResponse
  Error response

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"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",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

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.

{
    "type":"array",
    "description":"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",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

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

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"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 Privilege

  Example: Manage
• name: string
  Name of Privilege

  Example: MANAGE_JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        }
    },
    "description":"It represents a Privilege which is missing on a Resource to view or manage it."
}

500 Response

Internal Server Error

Body ()

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

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

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

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Default Response

Unexpected Error

Body ()

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

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top