Jump to

• Request
• Response

Create a new role

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/roles

The API creates a new role.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Input for creating a Role

Show Source

• grantees: array grantees
  List of Users whom the role has been granted
• isPrivate: boolean
  Role is a private role or not

  Example: false
• name(required): string
  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
• type: array type
  Type of Role. Default is "EM Role".

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Role",
            "example":"CLOUD_ADMIN_ROLE"
        },
        "type":{
            "type":"array",
            "description":"Type of Role. Default is \"EM Role\".",
            "example":"EM Role",
            "items":{
                "$ref":"#/components/schemas/RoleType"
            }
        },
        "isPrivate":{
            "type":"boolean",
            "description":"Role is a private role or not",
            "example":false
        },
        "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 creating a Role",
    "allOf":[
        {
            "$ref":"#/components/schemas/RoleCommonDetails"
        }
    ]
}

Match All

Show Source

• object RoleCommonDetails
  It represents some information of a Role

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Role",
            "example":"CLOUD_ADMIN_ROLE"
        },
        "type":{
            "type":"array",
            "description":"Type of Role. Default is \"EM Role\".",
            "example":"EM Role",
            "items":{
                "$ref":"#/components/schemas/RoleType"
            }
        },
        "isPrivate":{
            "type":"boolean",
            "description":"Role is a private role or not",
            "example":false
        },
        "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 creating 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 : type

Type: array

Type of Role. Default is "EM Role".

Show Source

• Array of: string
  Allowed Values: [ "EM Role", "External Role", "Oracle Defined Role" ]

  This is the representation of types of Roles.

{
    "type":"array",
    "description":"Type of Role. Default is \"EM Role\".",
    "example":"EM Role",
    "items":{
        "$ref":"#/components/schemas/RoleType"
    }
}

Example:

EM Role

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
  Represents a link(could be self, previous or next)

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

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

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
  Represents a link(could be self, previous or next)

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

Back to Top

Response

Supported Media Types

• application/json

201 Response

Role created successfully

Headers

• Location:
  URL to get the Role got created.

Body ()

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

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

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
  Represents a link(could be self, previous or next)

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

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

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
  Represents a link(could be self, previous or next)
• secureResources: object Link
  Represents a link(could be self, previous or next)

{
    "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
  Represents a link(could be self, previous or next)

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

400 Response

Bad Request

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

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

409 Response

Duplicate Resource

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

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