Jump to

• Request
• Response

Get the list of permissions

get

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

Retrieves a list of all roles with a list of their assigned rights. Useful for understanding the mapping between each available role and the set of permissions (rights) they possess.

Request

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 DisplayRoleRightsDto
  DTO representing a role and all rights assigned to that role.

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

Nested Schema : DisplayRoleRightsDto

Type: object

DTO representing a role and all rights assigned to that role.

Show Source

• rights: object rights
  DTO describing the properties of a user right assigned to a role.
• roleCategory(required): string
  Category of the role

  Example: User
• roleId(required): string (uuid)
  Unique identifier for the role
• roleName(required): string
  The display name of the role

  Example: Data Reviewer

{
    "required":[
        "roleCategory",
        "roleId",
        "roleName"
    ],
    "type":"object",
    "properties":{
        "roleId":{
            "type":"string",
            "description":"Unique identifier for the role",
            "format":"uuid"
        },
        "roleName":{
            "type":"string",
            "description":"The display name of the role",
            "example":"Data Reviewer"
        },
        "roleCategory":{
            "type":"string",
            "description":"Category of the role",
            "example":"User"
        },
        "rights":{
            "required":[
                "displayName"
            ],
            "type":"object",
            "properties":{
                "displayName":{
                    "type":"string",
                    "description":"The display name of the right",
                    "example":"Can view data"
                }
            },
            "description":"DTO describing the properties of a user right assigned to a role.",
            "example":{
                "displayName":"Can view data"
            }
        }
    },
    "description":"DTO representing a role and all rights assigned to that role.",
    "example":{
        "roleId":"2BC29B36F5D64B1B95F4BDBBCEA420BE",
        "roleName":"Data Reviewer",
        "roleCategory":"User",
        "rights":[
            {
                "rightId":"3DE7AA90C7244F13AAA8002164D88E79",
                "rightName":"View Data",
                "rightType":"READ",
                "granted":true
            }
        ]
    }
}

Example:

{
    "roleId":"2BC29B36F5D64B1B95F4BDBBCEA420BE",
    "roleName":"Data Reviewer",
    "roleCategory":"User",
    "rights":[
        {
            "rightId":"3DE7AA90C7244F13AAA8002164D88E79",
            "rightName":"View Data",
            "rightType":"READ",
            "granted":true
        }
    ]
}

Nested Schema : rights

Type: object

DTO describing the properties of a user right assigned to a role.

Show Source

• displayName(required): string
  The display name of the right

  Example: Can view data

{
    "required":[
        "displayName"
    ],
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"The display name of the right",
            "example":"Can view data"
        }
    },
    "description":"DTO describing the properties of a user right assigned to a role.",
    "example":{
        "displayName":"Can view data"
    }
}

Example:

{
    "displayName":"Can view data"
}

Examples

Select an example List of roles with rights

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@1466a41f

Nested Schema : details

Type: object

Back to Top