Jump to

• Request
• Response

v1.0

get

/ec-auth-svc/rest/v1.0/authroles/{roleid}/rights

Retrieves all right categories and their respective rights associated with the given role ID. Each returned category includes a list of rights and whether each right is selected for that role.

Request

Path Parameters

• roleid(required): string(uuid)
  The unique identifier for the role.

  Example:

  F7C8EEC7F6DE49A5B1E3023D0A2E221C

Query Parameters

• localize: boolean
  Default Value: false

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 DisplayCategoryDto
  DTO representing a category grouping of rights for a role.

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

Nested Schema : DisplayCategoryDto

Type: object

DTO representing a category grouping of rights for a role.

Show Source

• category(required): string
  The name of the category grouping rights

  Example: Data Entry
• rights: object rights
  DTO representing a right (permission) and whether it is selected for a user or role.

{
    "required":[
        "category"
    ],
    "type":"object",
    "properties":{
        "category":{
            "type":"string",
            "description":"The name of the category grouping rights",
            "example":"Data Entry"
        },
        "rights":{
            "required":[
                "displayName",
                "selected"
            ],
            "type":"object",
            "properties":{
                "displayName":{
                    "type":"string",
                    "description":"Display name of the right",
                    "example":"Edit Forms"
                },
                "selected":{
                    "type":"boolean",
                    "description":"Indicates if the right is selected (assigned) for this user/role",
                    "example":true
                }
            },
            "description":"DTO representing a right (permission) and whether it is selected for a user or role.",
            "example":{
                "displayName":"Edit Forms",
                "selected":true
            }
        }
    },
    "description":"DTO representing a category grouping of rights for a role.",
    "example":{
        "category":"Data Entry",
        "rights":[
            {
                "rightId":"A37EA9D55B0B43A1A36657A4094662A3",
                "rightName":"Edit Forms",
                "rightType":"WRITE",
                "granted":true
            }
        ]
    }
}

Example:

{
    "category":"Data Entry",
    "rights":[
        {
            "rightId":"A37EA9D55B0B43A1A36657A4094662A3",
            "rightName":"Edit Forms",
            "rightType":"WRITE",
            "granted":true
        }
    ]
}

Nested Schema : rights

Type: object

DTO representing a right (permission) and whether it is selected for a user or role.

Show Source

• displayName(required): string
  Display name of the right

  Example: Edit Forms
• selected(required): boolean
  Indicates if the right is selected (assigned) for this user/role

  Example: true

{
    "required":[
        "displayName",
        "selected"
    ],
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"Display name of the right",
            "example":"Edit Forms"
        },
        "selected":{
            "type":"boolean",
            "description":"Indicates if the right is selected (assigned) for this user/role",
            "example":true
        }
    },
    "description":"DTO representing a right (permission) and whether it is selected for a user or role.",
    "example":{
        "displayName":"Edit Forms",
        "selected":true
    }
}

Example:

{
    "displayName":"Edit Forms",
    "selected":true
}

Examples

Select an example List of right categories and rights for a role

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
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

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

Example:

oracle.doceng.json.BetterJsonNull@65719c12

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top