REST API for Oracle Enterprise Manager

Modify a role

put

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/roles/{roleId}

The API modifies granted roles, granted privileges and grantees of an existing role.

Request

Path Parameters

roleId(required): string

Id of a Role.

Supported Media Types

application/json

Root Schema : schema

Type: object

Input for replacing a Role

Show Source

grantees: array grantees

List of Users whom the role has been granted
name(required): string

Read Only: true

Name of the Role

Example: CLOUD_ADMIN_ROLE
privilegeGrants: array privilegeGrants

List of Privileges given to the Role
roleGrants: array roleGrants

List of Roles granted to the Role

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Role",
            "readOnly":true,
            "example":"CLOUD_ADMIN_ROLE"
        },
        "roleGrants":{
            "type":"array",
            "description":"List of Roles granted to the Role",
            "items":{
                "$ref":"#/components/schemas/RoleGrantSummary"
            }
        },
        "privilegeGrants":{
            "type":"array",
            "description":"List of Privileges given to the Role",
            "items":{
                "$ref":"#/components/schemas/PrivilegeGrantDetails"
            }
        },
        "grantees":{
            "type":"array",
            "description":"List of Users whom the role has been granted",
            "items":{
                "$ref":"#/components/schemas/GranteeSummary"
            }
        }
    },
    "description":"Input for replacing a Role",
    "allOf":[
        {
            "$ref":"#/components/schemas/RoleCommonDetails"
        }
    ]
}

Match All

Input for replacing a Role

Show Source

object RoleCommonDetails

It represents some information of a Role

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Role",
            "readOnly":true,
            "example":"CLOUD_ADMIN_ROLE"
        },
        "roleGrants":{
            "type":"array",
            "description":"List of Roles granted to the Role",
            "items":{
                "$ref":"#/components/schemas/RoleGrantSummary"
            }
        },
        "privilegeGrants":{
            "type":"array",
            "description":"List of Privileges given to the Role",
            "items":{
                "$ref":"#/components/schemas/PrivilegeGrantDetails"
            }
        },
        "grantees":{
            "type":"array",
            "description":"List of Users whom the role has been granted",
            "items":{
                "$ref":"#/components/schemas/GranteeSummary"
            }
        }
    },
    "description":"Input for replacing a Role",
    "allOf":[
        {
            "$ref":"#/components/schemas/RoleCommonDetails"
        }
    ]
}

Nested Schema : grantees

Type: array

List of Users whom the role has been granted

Show Source

Array of: object GranteeSummary

It represents User or Role to whom a Role is granted

{
    "type":"array",
    "description":"List of Users whom the role has been granted",
    "items":{
        "$ref":"#/components/schemas/GranteeSummary"
    }
}

Nested Schema : privilegeGrants

Type: array

List of Privileges given to the Role

Show Source

Array of: object PrivilegeGrantDetails

Privilege Grant details for createing/modifying a User or a Role

{
    "type":"array",
    "description":"List of Privileges given to the Role",
    "items":{
        "$ref":"#/components/schemas/PrivilegeGrantDetails"
    }
}

Nested Schema : roleGrants

Type: array

List of Roles granted to the Role

Show Source

Array of: object RoleGrantSummary

Info about Role granted to a User or to an another Role

{
    "type":"array",
    "description":"List of Roles granted to the Role",
    "items":{
        "$ref":"#/components/schemas/RoleGrantSummary"
    }
}

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

Type: object

It represents User or Role to whom a Role is granted

Show Source

id: string

Read Only: true

Unique identifier for a Grantee (User or Role)

Example: B0F9D83F6E313B03E0537013790ACA39
isWithAdmin: boolean

If a Grantee is a User, this flag says whether the Private Role has been granted as WITH_ADMIN

Example: true
links: object links

Read Only: true

The Grantee related links
name: string

Name of a Grantee

Example: TEST_SUPER_ADMIN
type: array type

Type of Grantee

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a Grantee (User or Role)",
            "readOnly":true,
            "example":"B0F9D83F6E313B03E0537013790ACA39"
        },
        "name":{
            "type":"string",
            "description":"Name of a Grantee",
            "example":"TEST_SUPER_ADMIN"
        },
        "type":{
            "type":"array",
            "description":"Type of Grantee",
            "example":"User",
            "items":{
                "$ref":"#/components/schemas/GranteeTypes"
            }
        },
        "isWithAdmin":{
            "type":"boolean",
            "description":"If a Grantee is a User, this flag says whether the Private Role has been granted as WITH_ADMIN",
            "example":true
        },
        "links":{
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"The Grantee related links",
            "readOnly":true
        }
    },
    "description":"It represents User or Role to whom a Role is granted"
}

Nested Schema : links

Type: object

Read Only: true

The Grantee related links

Show Source

self: object Link

A link referencing a REST API.

{
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"The Grantee related links",
    "readOnly":true
}

Nested Schema : type

Type: array

Type of Grantee

Show Source

Array of: string

Allowed Values: [ "User", "Role" ]

This is the representation of types of Grantees.

{
    "type":"array",
    "description":"Type of Grantee",
    "example":"User",
    "items":{
        "$ref":"#/components/schemas/GranteeTypes"
    }
}

Example:

User

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

Nested Schema : PrivilegeGrantDetails

Type: object

Privilege Grant details for createing/modifying a User or a Role

Show Source

name: string

Name of a Privilege

Example: VIEW_TARGET
secureResources: array secureResources

List of SecureResources on which the Privilege is applicable

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of a Privilege",
            "example":"VIEW_TARGET"
        },
        "secureResources":{
            "type":"array",
            "description":"List of SecureResources on which the Privilege is applicable",
            "items":{
                "$ref":"#/components/schemas/SecureResourceDetails"
            }
        }
    },
    "description":"Privilege Grant details for createing/modifying a User or a Role"
}

Nested Schema : secureResources

Type: array

List of SecureResources on which the Privilege is applicable

Show Source

Array of: object SecureResourceDetails

It represents Secure Resource details for creating/modifying a User or a Role.

{
    "type":"array",
    "description":"List of SecureResources on which the Privilege is applicable",
    "items":{
        "$ref":"#/components/schemas/SecureResourceDetails"
    }
}

Nested Schema : SecureResourceDetails

Type: object

It represents Secure Resource details for creating/modifying a User or a Role.

Show Source

id: string

Id of the Resource

Example: DE5CD14CE9D0C0EBEFFFDDEBAA83DA33
propagationPolicy: array propagationPolicy

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of the Resource",
            "example":"DE5CD14CE9D0C0EBEFFFDDEBAA83DA33"
        },
        "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"
            }
        }
    },
    "description":"It represents Secure Resource details for creating/modifying a User or a Role."
}

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

Type: object

Info about Role granted to a User or to an another Role

Show Source

description: string

Read Only: true

Description about the Role

Example: This Role is an Test Role
id: string

Read Only: true

Unique identifier for a Role Grant

Example: B0F9D83F6E313B03E0537013790ACA39
isPrivate: boolean

Read Only: true

Flag says whether grant Role is a private role or not.

Example: true
isWithAdmin: boolean

Read Only: true

Flag says whether Private Role is granted as WITH_ADMIN, This is shown if the Role is a private role

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

Owner / Creator of the Role

Example: SYSMAN
type: string

Read Only: true

Type of Role like EM Role, Oracle Defined Role, External Role

Example: Oracle Defined Role

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a Role Grant",
            "readOnly":true,
            "example":"B0F9D83F6E313B03E0537013790ACA39"
        },
        "name":{
            "type":"string",
            "description":"Name of a Role",
            "example":"EM_ALL_ADMINISTRATOR"
        },
        "type":{
            "type":"string",
            "description":"Type of Role like EM Role, Oracle Defined Role, External Role",
            "readOnly":true,
            "example":"Oracle Defined Role"
        },
        "description":{
            "type":"string",
            "description":"Description about the Role",
            "readOnly":true,
            "example":"This Role is an Test Role"
        },
        "isPrivate":{
            "type":"boolean",
            "description":"Flag says whether grant Role is a private role or not.",
            "readOnly":true,
            "example":true
        },
        "isWithAdmin":{
            "type":"boolean",
            "description":"Flag says whether Private Role is granted as WITH_ADMIN, This is shown if the Role is a private role",
            "readOnly":true,
            "example":true
        },
        "owner":{
            "type":"string",
            "description":"Owner / Creator of the Role",
            "readOnly":true,
            "example":"SYSMAN"
        },
        "links":{
            "type":"object",
            "properties":{
                "roleLink":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"The Role related links",
            "readOnly":true
        }
    },
    "description":"Info about Role granted to a User or to an another Role"
}

Nested Schema : links

Type: object

Read Only: true

The Role related links

Show Source

roleLink: object Link

A link referencing a REST API.

{
    "type":"object",
    "properties":{
        "roleLink":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"The Role related links",
    "readOnly":true
}

Response

Supported Media Types

application/json

200 Response

Role modified successfully

Root Schema : Role

Type: object

It represents a Role

Show Source

grantees: array grantees

List of Users whom the role has been granted
privilegeGrants: array privilegeGrants

List of Privileges given to the Role
roleGrants: array roleGrants

List of Roles granted to the Role

{
    "type":"object",
    "properties":{
        "roleGrants":{
            "type":"array",
            "description":"List of Roles granted to the Role",
            "items":{
                "$ref":"#/components/schemas/RoleGrantSummary"
            }
        },
        "privilegeGrants":{
            "type":"array",
            "description":"List of Privileges given to the Role",
            "items":{
                "$ref":"#/components/schemas/PrivilegeGrantSummary"
            }
        },
        "grantees":{
            "type":"array",
            "description":"List of Users whom the role has been granted",
            "items":{
                "$ref":"#/components/schemas/GranteeSummary"
            }
        }
    },
    "description":"It represents a Role",
    "allOf":[
        {
            "$ref":"#/components/schemas/RoleDetails"
        }
    ]
}

Match All

It represents a Role

Show Source

object allOf RoleDetails

It represents a Role

{
    "type":"object",
    "properties":{
        "roleGrants":{
            "type":"array",
            "description":"List of Roles granted to the Role",
            "items":{
                "$ref":"#/components/schemas/RoleGrantSummary"
            }
        },
        "privilegeGrants":{
            "type":"array",
            "description":"List of Privileges given to the Role",
            "items":{
                "$ref":"#/components/schemas/PrivilegeGrantSummary"
            }
        },
        "grantees":{
            "type":"array",
            "description":"List of Users whom the role has been granted",
            "items":{
                "$ref":"#/components/schemas/GranteeSummary"
            }
        }
    },
    "description":"It represents a Role",
    "allOf":[
        {
            "$ref":"#/components/schemas/RoleDetails"
        }
    ]
}

Nested Schema : grantees

Type: array

List of Users whom the role has been granted

Show Source

Array of: object GranteeSummary

It represents User or Role to whom a Role is granted

{
    "type":"array",
    "description":"List of Users whom the role has been granted",
    "items":{
        "$ref":"#/components/schemas/GranteeSummary"
    }
}

Nested Schema : privilegeGrants

Type: array

List of Privileges given to the Role

Show Source

Array of: object PrivilegeGrantSummary

Privilege Grant to a User or to a Role

{
    "type":"array",
    "description":"List of Privileges given to the Role",
    "items":{
        "$ref":"#/components/schemas/PrivilegeGrantSummary"
    }
}

Nested Schema : roleGrants

Type: array

List of Roles granted to the Role

Show Source

Array of: object RoleGrantSummary

Info about Role granted to a User or to an another Role

{
    "type":"array",
    "description":"List of Roles granted to the Role",
    "items":{
        "$ref":"#/components/schemas/RoleGrantSummary"
    }
}

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

Type: object

It represents User or Role to whom a Role is granted

Show Source

id: string

Read Only: true

Unique identifier for a Grantee (User or Role)

Example: B0F9D83F6E313B03E0537013790ACA39
isWithAdmin: boolean

If a Grantee is a User, this flag says whether the Private Role has been granted as WITH_ADMIN

Example: true
links: object links

Read Only: true

The Grantee related links
name: string

Name of a Grantee

Example: TEST_SUPER_ADMIN
type: array type

Type of Grantee

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a Grantee (User or Role)",
            "readOnly":true,
            "example":"B0F9D83F6E313B03E0537013790ACA39"
        },
        "name":{
            "type":"string",
            "description":"Name of a Grantee",
            "example":"TEST_SUPER_ADMIN"
        },
        "type":{
            "type":"array",
            "description":"Type of Grantee",
            "example":"User",
            "items":{
                "$ref":"#/components/schemas/GranteeTypes"
            }
        },
        "isWithAdmin":{
            "type":"boolean",
            "description":"If a Grantee is a User, this flag says whether the Private Role has been granted as WITH_ADMIN",
            "example":true
        },
        "links":{
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"The Grantee related links",
            "readOnly":true
        }
    },
    "description":"It represents User or Role to whom a Role is granted"
}

Nested Schema : links

Type: object

Read Only: true

The Grantee related links

Show Source

self: object Link

A link referencing a REST API.

{
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"The Grantee related links",
    "readOnly":true
}

Nested Schema : type

Type: array

Type of Grantee

Show Source

Array of: string

Allowed Values: [ "User", "Role" ]

This is the representation of types of Grantees.

{
    "type":"array",
    "description":"Type of Grantee",
    "example":"User",
    "items":{
        "$ref":"#/components/schemas/GranteeTypes"
    }
}

Example:

User

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

Nested Schema : PrivilegeGrantSummary

Type: object

Privilege Grant to a User or to a Role

Show Source

description: string

Read Only: true

Description about the Privilege

Example: Ability to view Jobs
displayName: string

Read Only: true

Display name of the Privilege

Example: View Report
links: object links

links related to the privilege grant
name: string

Name of a Privilege

Example: VIEW_TARGET
scope: array scope

Read Only: true

Scope of the Privilege
secureResourceType: string

Read Only: true

SecureResource Type of the Privilege

Example: JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of a Privilege",
            "example":"VIEW_TARGET"
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the Privilege",
            "readOnly":true,
            "example":"View Report"
        },
        "description":{
            "type":"string",
            "description":"Description about the Privilege",
            "readOnly":true,
            "example":"Ability to view Jobs"
        },
        "secureResourceType":{
            "type":"string",
            "description":"SecureResource Type of the Privilege",
            "readOnly":true,
            "example":"JOB"
        },
        "scope":{
            "type":"array",
            "description":"Scope of the Privilege",
            "readOnly":true,
            "example":"INSTANCE",
            "items":{
                "$ref":"#/components/schemas/PrivilegeScopes"
            }
        },
        "links":{
            "type":"object",
            "properties":{
                "privilege":{
                    "$ref":"#/components/schemas/Link"
                },
                "secureResources":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"links related to the privilege grant"
        }
    },
    "description":"Privilege Grant to a User or to a Role"
}

Nested Schema : links

Type: object

links related to the privilege grant

Show Source

privilege: object Link

A link referencing a REST API.
secureResources: object Link

A link referencing a REST API.

{
    "type":"object",
    "properties":{
        "privilege":{
            "$ref":"#/components/schemas/Link"
        },
        "secureResources":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"links related to the privilege grant"
}

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.

{
    "type":"array",
    "description":"Scope of the Privilege",
    "readOnly":true,
    "example":"INSTANCE",
    "items":{
        "$ref":"#/components/schemas/PrivilegeScopes"
    }
}

Example:

INSTANCE

Nested Schema : RoleGrantSummary

Type: object

Info about Role granted to a User or to an another Role

Show Source

description: string

Read Only: true

Description about the Role

Example: This Role is an Test Role
id: string

Read Only: true

Unique identifier for a Role Grant

Example: B0F9D83F6E313B03E0537013790ACA39
isPrivate: boolean

Read Only: true

Flag says whether grant Role is a private role or not.

Example: true
isWithAdmin: boolean

Read Only: true

Flag says whether Private Role is granted as WITH_ADMIN, This is shown if the Role is a private role

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

Owner / Creator of the Role

Example: SYSMAN
type: string

Read Only: true

Type of Role like EM Role, Oracle Defined Role, External Role

Example: Oracle Defined Role

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a Role Grant",
            "readOnly":true,
            "example":"B0F9D83F6E313B03E0537013790ACA39"
        },
        "name":{
            "type":"string",
            "description":"Name of a Role",
            "example":"EM_ALL_ADMINISTRATOR"
        },
        "type":{
            "type":"string",
            "description":"Type of Role like EM Role, Oracle Defined Role, External Role",
            "readOnly":true,
            "example":"Oracle Defined Role"
        },
        "description":{
            "type":"string",
            "description":"Description about the Role",
            "readOnly":true,
            "example":"This Role is an Test Role"
        },
        "isPrivate":{
            "type":"boolean",
            "description":"Flag says whether grant Role is a private role or not.",
            "readOnly":true,
            "example":true
        },
        "isWithAdmin":{
            "type":"boolean",
            "description":"Flag says whether Private Role is granted as WITH_ADMIN, This is shown if the Role is a private role",
            "readOnly":true,
            "example":true
        },
        "owner":{
            "type":"string",
            "description":"Owner / Creator of the Role",
            "readOnly":true,
            "example":"SYSMAN"
        },
        "links":{
            "type":"object",
            "properties":{
                "roleLink":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"The Role related links",
            "readOnly":true
        }
    },
    "description":"Info about Role granted to a User or to an another Role"
}

Nested Schema : links

Type: object

Read Only: true

The Role related links

Show Source

roleLink: object Link

A link referencing a REST API.

{
    "type":"object",
    "properties":{
        "roleLink":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"The Role related links",
    "readOnly":true
}

400 Response

Bad Request

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

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

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

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

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

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

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