Jump to

• Request
• Response

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 Roles

  Example:

  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 Top

Response

Supported Media Types

• application/json

200 Response

Roles returned successfully

Body ()

Root Schema : RoleCollection

Type: object

This is the representation of list of Roles.

Show Source

• count(required): integer
  The number of Roles in this page

  Example: 20
• items(required): array items
  The list of roles
• links(required): object links
  The result set navigation links

{
    "required":[
        "count",
        "items",
        "links"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of Roles 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"
        },
        "items":{
            "type":"array",
            "description":"The list of roles",
            "items":{
                "$ref":"#/components/schemas/RoleSummary"
            }
        }
    },
    "description":"This is the representation of list of Roles."
}

Nested Schema : items

Type: array

The list of roles

Show Source

• Array of: object RoleSummary
  It represents a Role

{
    "type":"array",
    "description":"The list of roles",
    "items":{
        "$ref":"#/components/schemas/RoleSummary"
    }
}

Nested Schema : links

Type: object

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"
}

Nested Schema : RoleSummary

Type: object

It represents a Role

Match All

It represents a Role

Show Source

• object allOf RoleDetails
  It represents a Role

{
    "type":"object",
    "description":"It represents a Role",
    "allOf":[
        {
            "$ref":"#/components/schemas/RoleDetails"
        }
    ]
}

Nested Schema : RoleDetails

Type: object

It represents a Role

Show Source

• id: string
  Read Only: true

  Unique identifier for a Role

  Example: B0F9D83F6E313B03E0537013790ACA39
• isPrivate: boolean
  Role is a private role or not

  Example: false
• links: object links
  Read Only: true

  the Role related links
• name: string
  Name of a Role

  Example: EM_ALL_ADMINISTRATOR
• owner: string
  Read Only: true

  User who owns the Role

  Example: SYSMAN
• type: array type
  Type of Role

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a Role",
            "readOnly":true,
            "example":"B0F9D83F6E313B03E0537013790ACA39"
        },
        "name":{
            "type":"string",
            "description":"Name of a Role",
            "example":"EM_ALL_ADMINISTRATOR"
        },
        "type":{
            "type":"array",
            "description":"Type of Role",
            "example":"EM Role",
            "items":{
                "$ref":"#/components/schemas/RoleType"
            }
        },
        "isPrivate":{
            "type":"boolean",
            "description":"Role is a private role or not",
            "example":false
        },
        "owner":{
            "type":"string",
            "description":"User who owns the Role",
            "readOnly":true,
            "example":"SYSMAN"
        },
        "links":{
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "roleGrants":{
                    "$ref":"#/components/schemas/Link"
                },
                "privilegeGrants":{
                    "$ref":"#/components/schemas/Link"
                },
                "grantees":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"the Role related links",
            "readOnly":true
        }
    },
    "description":"It represents a Role",
    "allOf":[
        {
            "$ref":"#/components/schemas/RoleCommonDetails"
        }
    ]
}

Match All

It represents a Role

Show Source

• object RoleCommonDetails
  It represents some information of a Role

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a Role",
            "readOnly":true,
            "example":"B0F9D83F6E313B03E0537013790ACA39"
        },
        "name":{
            "type":"string",
            "description":"Name of a Role",
            "example":"EM_ALL_ADMINISTRATOR"
        },
        "type":{
            "type":"array",
            "description":"Type of Role",
            "example":"EM Role",
            "items":{
                "$ref":"#/components/schemas/RoleType"
            }
        },
        "isPrivate":{
            "type":"boolean",
            "description":"Role is a private role or not",
            "example":false
        },
        "owner":{
            "type":"string",
            "description":"User who owns the Role",
            "readOnly":true,
            "example":"SYSMAN"
        },
        "links":{
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "roleGrants":{
                    "$ref":"#/components/schemas/Link"
                },
                "privilegeGrants":{
                    "$ref":"#/components/schemas/Link"
                },
                "grantees":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"the Role related links",
            "readOnly":true
        }
    },
    "description":"It represents a Role",
    "allOf":[
        {
            "$ref":"#/components/schemas/RoleCommonDetails"
        }
    ]
}

Nested Schema : RoleCommonDetails

Type: object

It represents some information of a Role

Show Source

• description: string
  Description about the Role

  Example: 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

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"Description about the Role",
            "example":"Role has privileges to perform Enterprise Manager administrative operations"
        },
        "isWithAdmin":{
            "type":"boolean",
            "description":"Private Role has WITH_ADMIN or not. This attribute exists only for Private Roles.",
            "example":true
        }
    },
    "description":"It represents some information of a Role"
}

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"
        }
    }
}

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

Response sent back as an Error in case required privileges are missing

Show Source

• object ErrorResponse
  Response sent back in the case of an error.

{
    "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

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"
        }
    }
}

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."
}

404 Response

Not Found

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"
        }
    }
}

503 Response

Service Unavailable

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"
        }
    }
}

Default Response

Unexpected 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