Jump to

• Request
• Response

Modify a user

put

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/users/{userId}

The API modifies an existing user details like emails, department, location, contact, granted roles, granted privileges, etc.

Request

Path Parameters

• userId(required): string
  Id of a User.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Input for modifying an existing User

Show Source

• expirePasswordNow: boolean
  Flag to say whether User password should expire now, so that new password will be requested when the User login next time

  Example: true
• name(required): string
  Read Only: true

  Name of the User

  Example: CLOUD_ADMIN
• password: string (password)
  Password for the User

  Example: userNewPasscode56@
• privilegeGrants: array privilegeGrants
  List of Privileges to be given to the User
• roleGrants: array roleGrants
  List of Roles to be granted to the User

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the User",
            "readOnly":true,
            "example":"CLOUD_ADMIN"
        },
        "password":{
            "type":"string",
            "description":"Password for the User",
            "format":"password",
            "example":"userNewPasscode56@"
        },
        "expirePasswordNow":{
            "type":"boolean",
            "description":"Flag to say whether User password should expire now, so that new password will be requested when the User login next time",
            "example":true
        },
        "roleGrants":{
            "type":"array",
            "description":"List of Roles to be granted to the User",
            "items":{
                "$ref":"#/components/schemas/RoleGrantSummary"
            }
        },
        "privilegeGrants":{
            "type":"array",
            "description":"List of Privileges to be given to the User",
            "items":{
                "$ref":"#/components/schemas/PrivilegeGrantDetails"
            }
        }
    },
    "description":"Input for modifying an existing User",
    "allOf":[
        {
            "$ref":"#/components/schemas/UserCommonDetails"
        }
    ]
}

Match All

Show Source

• object UserCommonDetails
  It represents some information of a User

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the User",
            "readOnly":true,
            "example":"CLOUD_ADMIN"
        },
        "password":{
            "type":"string",
            "description":"Password for the User",
            "format":"password",
            "example":"userNewPasscode56@"
        },
        "expirePasswordNow":{
            "type":"boolean",
            "description":"Flag to say whether User password should expire now, so that new password will be requested when the User login next time",
            "example":true
        },
        "roleGrants":{
            "type":"array",
            "description":"List of Roles to be granted to the User",
            "items":{
                "$ref":"#/components/schemas/RoleGrantSummary"
            }
        },
        "privilegeGrants":{
            "type":"array",
            "description":"List of Privileges to be given to the User",
            "items":{
                "$ref":"#/components/schemas/PrivilegeGrantDetails"
            }
        }
    },
    "description":"Input for modifying an existing User",
    "allOf":[
        {
            "$ref":"#/components/schemas/UserCommonDetails"
        }
    ]
}

Nested Schema : privilegeGrants

Type: array

List of Privileges to be given to the User

Show Source

• Array of: object PrivilegeGrantDetails
  Privilege Grant details for createing/modifying a User or a Role

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

Nested Schema : roleGrants

Type: array

List of Roles to be granted to the User

Show Source

• Array of: object RoleGrantSummary
  Info about Role granted to a User or to an another Role

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

Nested Schema : UserCommonDetails

Type: object

It represents some information of a User

Show Source

• authenticationType: array authenticationType
  Authentication Type of the User
• contact: string
  Minimum Length: 0

  Maximum Length: 128

  Contact Number of a User

  Example: 21212221212
• costCenter: string
  Minimum Length: 0

  Maximum Length: 1024

  Cost Center of a User

  Example: TestCostCenter
• department: string
  Minimum Length: 0

  Maximum Length: 1024

  Department of a User

  Example: HumanResource
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Description about a User

  Example: This user is a Test User
• emails: string
  Minimum Length: 0

  Maximum Length: 128

  Email ids of a User with comma as a separator. Each email can have max length of 128 letters.

  Example: [e-mail],[e-mail]
• isPasswordChangeAllowed: boolean
  Flag to say whether User is allowed to change his/her own password

  Example: true
• lineOfBusiness: string
  Minimum Length: 0

  Maximum Length: 1024

  Line-Of-Business of a User

  Example: TestBusiness
• location: string
  Minimum Length: 0

  Maximum Length: 1024

  Location of a User

  Example: Bangalore
• passwordProfile: string
  Name of Password Profile

  Example: MGMT_ADMIN_USER_PROFILE

{
    "type":"object",
    "properties":{
        "authenticationType":{
            "type":"array",
            "description":"Authentication Type of the User",
            "example":"Repository",
            "items":{
                "$ref":"#/components/schemas/AuthenticationType"
            }
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Description about a User",
            "example":"This user is a Test User"
        },
        "emails":{
            "maxLength":128,
            "minLength":0,
            "type":"string",
            "description":"Email ids of a User with comma as a separator. Each email can have max length of 128 letters.",
            "example":"[e-mail],[e-mail]"
        },
        "costCenter":{
            "maxLength":1024,
            "minLength":0,
            "type":"string",
            "description":"Cost Center of a User",
            "example":"TestCostCenter"
        },
        "department":{
            "maxLength":1024,
            "minLength":0,
            "type":"string",
            "description":"Department of a User",
            "example":"HumanResource"
        },
        "lineOfBusiness":{
            "maxLength":1024,
            "minLength":0,
            "type":"string",
            "description":"Line-Of-Business of a User",
            "example":"TestBusiness"
        },
        "location":{
            "maxLength":1024,
            "minLength":0,
            "type":"string",
            "description":"Location of a User",
            "example":"Bangalore"
        },
        "contact":{
            "maxLength":128,
            "minLength":0,
            "type":"string",
            "description":"Contact Number of a User",
            "example":"21212221212"
        },
        "isPasswordChangeAllowed":{
            "type":"boolean",
            "description":"Flag to say whether User is allowed to change his/her own password",
            "example":true
        },
        "passwordProfile":{
            "type":"string",
            "description":"Name of Password Profile",
            "example":"MGMT_ADMIN_USER_PROFILE"
        }
    },
    "description":"It represents some information of a User"
}

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
}

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

Type: array

Authentication Type of the User

Show Source

• Array of: string
  Allowed Values: [ "Repository", "SSO", "Enterprise" ]

  This is the representation of Authentication type of User.

{
    "type":"array",
    "description":"Authentication Type of the User",
    "example":"Repository",
    "items":{
        "$ref":"#/components/schemas/AuthenticationType"
    }
}

Example:

Repository

Back to Top

Response

Supported Media Types

• application/json

200 Response

User details modifed successfully

Body ()

Root Schema : User

Type: object

This is the representation of a User.

Show Source

• privilegeGrants: array privilegeGrants
  List of Privileges to be given to the User
• roleGrants: array roleGrants
  List of Roles to be granted to the User

{
    "type":"object",
    "properties":{
        "roleGrants":{
            "type":"array",
            "description":"List of Roles to be granted to the User",
            "items":{
                "$ref":"#/components/schemas/RoleGrantSummary"
            }
        },
        "privilegeGrants":{
            "type":"array",
            "description":"List of Privileges to be given to the User",
            "items":{
                "$ref":"#/components/schemas/PrivilegeGrantSummary"
            }
        }
    },
    "description":"This is the representation of a User.",
    "allOf":[
        {
            "$ref":"#/components/schemas/UserDetails"
        }
    ]
}

Match All

Show Source

• object allOf UserDetails
  This is the representation of a User.

{
    "type":"object",
    "properties":{
        "roleGrants":{
            "type":"array",
            "description":"List of Roles to be granted to the User",
            "items":{
                "$ref":"#/components/schemas/RoleGrantSummary"
            }
        },
        "privilegeGrants":{
            "type":"array",
            "description":"List of Privileges to be given to the User",
            "items":{
                "$ref":"#/components/schemas/PrivilegeGrantSummary"
            }
        }
    },
    "description":"This is the representation of a User.",
    "allOf":[
        {
            "$ref":"#/components/schemas/UserDetails"
        }
    ]
}

Nested Schema : privilegeGrants

Type: array

List of Privileges to be given to the User

Show Source

• Array of: object PrivilegeGrantSummary
  Privilege Grant to a User or to a Role

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

Nested Schema : roleGrants

Type: array

List of Roles to be granted to the User

Show Source

• Array of: object RoleGrantSummary
  Info about Role granted to a User or to an another Role

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

Nested Schema : UserDetails

Type: object

This is the representation of a User.

Show Source

• category: string
  User category like Administrator / Super Administrator / Repository Owner

  Example: Super Administrator
• externalId: string
  External User Name of the User as mentioned in Identity Provider (like LDAP)

  Example: CLOUD_MANAGER
• id: string
  Unique identifier for a User

  Example: B0FBBE587FD201E2E0537013790A7D03
• isLocked: boolean
  Flag that says whether the User is locked or not

  Example: false
• lifecycleStatus: string
  User is Active status or BeingDeleted status

  Example: Active
• links: object links
  the User related links
• name: string
  Name for a User

  Example: CLOUD_MANAGER

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a User",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "name":{
            "type":"string",
            "description":"Name for a User",
            "example":"CLOUD_MANAGER"
        },
        "category":{
            "type":"string",
            "description":"User category like Administrator / Super Administrator / Repository Owner",
            "example":"Super Administrator"
        },
        "externalId":{
            "type":"string",
            "description":"External User Name of the User as mentioned in Identity Provider (like LDAP)",
            "example":"CLOUD_MANAGER"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"User is Active status or BeingDeleted status",
            "example":"Active"
        },
        "isLocked":{
            "type":"boolean",
            "description":"Flag that says whether the User is locked or not",
            "example":false
        },
        "links":{
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "roleGrants":{
                    "$ref":"#/components/schemas/Link"
                },
                "privilegeGrants":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"the User related links"
        }
    },
    "description":"This is the representation of a User.",
    "allOf":[
        {
            "$ref":"#/components/schemas/UserCommonDetails"
        }
    ]
}

Match All

Show Source

• object UserCommonDetails
  It represents some information of a User

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a User",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "name":{
            "type":"string",
            "description":"Name for a User",
            "example":"CLOUD_MANAGER"
        },
        "category":{
            "type":"string",
            "description":"User category like Administrator / Super Administrator / Repository Owner",
            "example":"Super Administrator"
        },
        "externalId":{
            "type":"string",
            "description":"External User Name of the User as mentioned in Identity Provider (like LDAP)",
            "example":"CLOUD_MANAGER"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"User is Active status or BeingDeleted status",
            "example":"Active"
        },
        "isLocked":{
            "type":"boolean",
            "description":"Flag that says whether the User is locked or not",
            "example":false
        },
        "links":{
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "roleGrants":{
                    "$ref":"#/components/schemas/Link"
                },
                "privilegeGrants":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"the User related links"
        }
    },
    "description":"This is the representation of a User.",
    "allOf":[
        {
            "$ref":"#/components/schemas/UserCommonDetails"
        }
    ]
}

Nested Schema : UserCommonDetails

Type: object

It represents some information of a User

Show Source

• authenticationType: array authenticationType
  Authentication Type of the User
• contact: string
  Minimum Length: 0

  Maximum Length: 128

  Contact Number of a User

  Example: 21212221212
• costCenter: string
  Minimum Length: 0

  Maximum Length: 1024

  Cost Center of a User

  Example: TestCostCenter
• department: string
  Minimum Length: 0

  Maximum Length: 1024

  Department of a User

  Example: HumanResource
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Description about a User

  Example: This user is a Test User
• emails: string
  Minimum Length: 0

  Maximum Length: 128

  Email ids of a User with comma as a separator. Each email can have max length of 128 letters.

  Example: [e-mail],[e-mail]
• isPasswordChangeAllowed: boolean
  Flag to say whether User is allowed to change his/her own password

  Example: true
• lineOfBusiness: string
  Minimum Length: 0

  Maximum Length: 1024

  Line-Of-Business of a User

  Example: TestBusiness
• location: string
  Minimum Length: 0

  Maximum Length: 1024

  Location of a User

  Example: Bangalore
• passwordProfile: string
  Name of Password Profile

  Example: MGMT_ADMIN_USER_PROFILE

{
    "type":"object",
    "properties":{
        "authenticationType":{
            "type":"array",
            "description":"Authentication Type of the User",
            "example":"Repository",
            "items":{
                "$ref":"#/components/schemas/AuthenticationType"
            }
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Description about a User",
            "example":"This user is a Test User"
        },
        "emails":{
            "maxLength":128,
            "minLength":0,
            "type":"string",
            "description":"Email ids of a User with comma as a separator. Each email can have max length of 128 letters.",
            "example":"[e-mail],[e-mail]"
        },
        "costCenter":{
            "maxLength":1024,
            "minLength":0,
            "type":"string",
            "description":"Cost Center of a User",
            "example":"TestCostCenter"
        },
        "department":{
            "maxLength":1024,
            "minLength":0,
            "type":"string",
            "description":"Department of a User",
            "example":"HumanResource"
        },
        "lineOfBusiness":{
            "maxLength":1024,
            "minLength":0,
            "type":"string",
            "description":"Line-Of-Business of a User",
            "example":"TestBusiness"
        },
        "location":{
            "maxLength":1024,
            "minLength":0,
            "type":"string",
            "description":"Location of a User",
            "example":"Bangalore"
        },
        "contact":{
            "maxLength":128,
            "minLength":0,
            "type":"string",
            "description":"Contact Number of a User",
            "example":"21212221212"
        },
        "isPasswordChangeAllowed":{
            "type":"boolean",
            "description":"Flag to say whether User is allowed to change his/her own password",
            "example":true
        },
        "passwordProfile":{
            "type":"string",
            "description":"Name of Password Profile",
            "example":"MGMT_ADMIN_USER_PROFILE"
        }
    },
    "description":"It represents some information of a User"
}

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

Nested Schema : authenticationType

Type: array

Authentication Type of the User

Show Source

• Array of: string
  Allowed Values: [ "Repository", "SSO", "Enterprise" ]

  This is the representation of Authentication type of User.

{
    "type":"array",
    "description":"Authentication Type of the User",
    "example":"Repository",
    "items":{
        "$ref":"#/components/schemas/AuthenticationType"
    }
}

Example:

Repository

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

403 Response

Forbidden

Body ()

Root Schema : MissingPrivErrorResponse

Type: object

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

Show Source

• missingPrivileges: array missingPrivileges
  Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Match All

Show Source

• object ErrorResponse
  Error response

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Nested Schema : missingPrivileges

Type: array

Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

Show Source

• Array of: object MissingPrivilegeSummary
  It represents a Privilege which is missing on a Resource to view or manage it.

{
    "type":"array",
    "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

Nested Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

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

Nested Schema : MissingPrivilegeSummary

Type: object

It represents a Privilege which is missing on a Resource to view or manage it.

Show Source

• displayName: string
  Display Name of Privilege

  Example: Manage
• name: string
  Name of Privilege

  Example: MANAGE_JOB

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

404 Response

Not Found

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