Jump to

• Request
• Response

List secure resources of a role for a privilege

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/roles/{roleId}/privilegeGrants/{privilegeName}/secureResources

The API returns list of secure resources of a privilege granted to a role ordered by name (ascending) by default.

Request

Path Parameters

• privilegeName(required): string
  Name of Granted Privilege

  Example:

  FULL_JOB

• 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 Name of Secure Resource to be filtered

  Example:

  REFRESH_DOMAIN_230

• nameContains: string
  Part of Secure Resource Name used to filter Secure Resources

  Example:

  REFRESH

• 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

• type: string
  Sub-type of Secure Resource

  Example:

  NORMAL_JOB

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Secure Resources of the Privilege returned successfully

Body ()

Root Schema : SecureResourceCollection

Type: object

This is the representation of List of SecureResources.

Show Source

• count(required): integer
  the number of Resources in this page

  Example: 20
• items(required): array items
  the SecureResource list
• links(required): object links
  Read Only: true

  the result set navigation links

{
    "required":[
        "count",
        "items",
        "links"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"the number of Resources in this page",
            "example":"20"
        },
        "links":{
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "previous":{
                    "$ref":"#/components/schemas/Link"
                },
                "next":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"the result set navigation links",
            "readOnly":true
        },
        "items":{
            "type":"array",
            "description":"the SecureResource list",
            "items":{
                "$ref":"#/components/schemas/SecureResourceSummary"
            }
        }
    },
    "description":"This is the representation of List of SecureResources."
}

Nested Schema : items

Type: array

the SecureResource list

Show Source

• Array of: object SecureResourceSummary
  It represents a SecureResource like Target Instance, Job Instance etc.

{
    "type":"array",
    "description":"the SecureResource list",
    "items":{
        "$ref":"#/components/schemas/SecureResourceSummary"
    }
}

Nested Schema : links

Type: object

Read Only: true

the result set navigation links

Show Source

• next: object Link
  A link referencing a REST API.
• previous: object Link
  A link referencing a REST API.
• self: object Link
  A link referencing a REST API.

{
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"the result set navigation links",
    "readOnly":true
}

Nested Schema : SecureResourceSummary

Type: object

It represents a SecureResource like Target Instance, Job Instance etc.

Show Source

• id: string
  Id of the Resource

  Example: DE5CD14CE9D0C0EBEFFFDDEBAA83DA33
• name: string
  Read Only: true

  Name of the Resource

  Example: /EMGC_EMGC_DOMAIN/EMGC_DOMAIN
• owner: string
  Read Only: true

  Owner of the Resource

  Example: SYSMAN
• propagationPolicy: array propagationPolicy
  Scope where the privilege is applicable to. This is applicable only for Secure Resource Type called TARGET.
• type: string
  Read Only: true

  Internal name of Resource Set Type of the Resource

  Example: weblogic_domain_name
• typeDisplayName: string
  Read Only: true

  Display name of Resource Set Type of the Resource

  Example: Oracle WebLogic Domain

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of the Resource",
            "example":"DE5CD14CE9D0C0EBEFFFDDEBAA83DA33"
        },
        "name":{
            "type":"string",
            "description":"Name of the Resource",
            "readOnly":true,
            "example":"/EMGC_EMGC_DOMAIN/EMGC_DOMAIN"
        },
        "type":{
            "type":"string",
            "description":"Internal name of Resource Set Type of the Resource",
            "readOnly":true,
            "example":"weblogic_domain_name"
        },
        "typeDisplayName":{
            "type":"string",
            "description":"Display name of Resource Set Type of the Resource",
            "readOnly":true,
            "example":"Oracle WebLogic Domain"
        },
        "propagationPolicy":{
            "type":"array",
            "description":"Scope where the privilege is applicable to. This is applicable only for Secure Resource Type called TARGET.",
            "example":"MEMBERS",
            "items":{
                "$ref":"#/components/schemas/PropagationPolicy"
            }
        },
        "owner":{
            "type":"string",
            "description":"Owner of the Resource",
            "readOnly":true,
            "example":"SYSMAN"
        }
    },
    "description":"It represents a SecureResource like Target Instance, Job Instance etc."
}

Nested Schema : propagationPolicy

Type: array

Scope where the privilege is applicable to. This is applicable only for Secure Resource Type called TARGET.

Show Source

• Array of: string
  Allowed Values: [ "ALL", "SELF", "MEMBERS" ]

  This gives type where a privilege is applicable to which part of composite resource. - ALL means the privilege is given for composite resource and its members. - SELF means the privilege is given only for composite resource. - MEMBERS means the privilege is given only for members of composite resource.

{
    "type":"array",
    "description":"Scope where the privilege is applicable to. This is applicable only for Secure Resource Type called TARGET.",
    "example":"MEMBERS",
    "items":{
        "$ref":"#/components/schemas/PropagationPolicy"
    }
}

Example:

MEMBERS

Nested Schema : Link

Type: object

A link referencing a REST API.

Show Source

• href: string
  Link URL

{
    "x-em-sdk-level":"emSDK",
    "description":"A link referencing a REST API.",
    "type":"object",
    "properties":{
        "href":{
            "description":"Link URL",
            "type":"string"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

Back to Top