Jump to

• Request
• Response

v1.0

get

/ec-auth-svc/rest/v1.0/globalroles

Retrieves all global roles.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DisplayGlobalRoleDto
  Represents a global role with its ID, name, and related rights.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DisplayGlobalRoleDto"
    }
}

Nested Schema : DisplayGlobalRoleDto

Type: object

Represents a global role with its ID, name, and related rights.

Show Source

• id: string (uuid)
  Unique identifier for the global role.
• rights: array rights
  List of rights related to the global role.
• roleName: string
  The name of the role.

  Example: Approve Library Objects

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for the global role.",
            "format":"uuid"
        },
        "roleName":{
            "type":"string",
            "description":"The name of the role.",
            "example":"Approve Library Objects"
        },
        "rights":{
            "type":"array",
            "description":"List of rights related to the global role.",
            "example":[
                "READ",
                "WRITE"
            ],
            "items":{
                "type":"string",
                "description":"List of rights related to the global role.",
                "example":"[\"READ\",\"WRITE\"]"
            }
        }
    },
    "description":"Represents a global role with its ID, name, and related rights.",
    "example":{
        "id":"07968CA58DAF356CAF7BCD708ADCB159",
        "roleName":"Approve Library Objects",
        "rights":[
            "READ",
            "WRITE"
        ]
    }
}

Example:

{
    "id":"07968CA58DAF356CAF7BCD708ADCB159",
    "roleName":"Approve Library Objects",
    "rights":[
        "READ",
        "WRITE"
    ]
}

Nested Schema : rights

Type: array

List of rights related to the global role.

Show Source

• Array of: string
  List of rights related to the global role.

  Example: ["READ","WRITE"]

{
    "type":"array",
    "description":"List of rights related to the global role.",
    "example":[
        "READ",
        "WRITE"
    ],
    "items":{
        "type":"string",
        "description":"List of rights related to the global role.",
        "example":"[\"READ\",\"WRITE\"]"
    }
}

Example:

[
    "READ",
    "WRITE"
]

Examples

Select an example A list of global role objects

400 Response

Bad request

Body ()

Root Schema : AuthResponse

Type: object

Generic API response wrapper containing result, error data, response version and status.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result data of the API response; actual type depends on the API
• status: string (none)
  Indicates request success ("success") or failure ("failure").

  Example: success
• version: integer (int32)
  Version of the response schema.

  Example: 1

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Indicates request success (\"success\") or failure (\"failure\").",
            "format":"none",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Result data of the API response; actual type depends on the API",
            "example":null
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "description":"Version of the response schema.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Generic API response wrapper containing result, error data, response version and status."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result data of the API response; actual type depends on the API

Example:

oracle.doceng.json.BetterJsonNull@e668392

Nested Schema : details

Type: object

Back to Top