Jump to

• Request
• Response

[Deprecated]: Get the list of roles

get

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

Deprecated: This endpoint returns a list of user roles for the system. Use /v2.0/authroles instead. The v2 endpoint returns additional properties and improved role categorization in its response model.

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 DisplayRoleDto

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

Nested Schema : DisplayRoleDto

Type: object

Show Source

• id(required): string (uuid)
• objectVersionNumber(required): number
• roleCategory(required): string
• roleCategoryLabel(required): string
• roleName(required): string
• roleNameLabel(required): string
• roleSubCategory: string
• roleSubCategoryLabel(required): string
• roleType(required): string
• unblinded: string

{
    "required":[
        "id",
        "objectVersionNumber",
        "roleCategory",
        "roleCategoryLabel",
        "roleName",
        "roleNameLabel",
        "roleSubCategoryLabel",
        "roleType"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "roleName":{
            "type":"string"
        },
        "roleType":{
            "type":"string"
        },
        "roleCategory":{
            "type":"string"
        },
        "roleSubCategory":{
            "type":"string"
        },
        "unblinded":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "roleNameLabel":{
            "type":"string"
        },
        "roleCategoryLabel":{
            "type":"string"
        },
        "roleSubCategoryLabel":{
            "type":"string"
        }
    }
}

Examples

Select an example List of roles

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
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

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

Example:

oracle.doceng.json.BetterJsonNull@76f8fc0a

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Back to Top