Jump to

• Request
• Response

List Roles

get

/v1/uwaas/roles

List roles using page and size pagination.

Request

Query Parameters

• page: integer
  Minimum Value: 0

  Zero-based page index.

  Default Value: 0

  Example:

  0

• size: integer
  Minimum Value: 1

  Maximum Value: 200

  Maximum number of roles to return. Values above 200 are capped by the service.

  Default Value: 50

  Example:

  50

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Roles retrieved successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object RoleResponse

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

Nested Schema : RoleResponse

Type: object

Show Source

• createdAt(required): string (date-time)
  Read Only: true
• createdBy(required): string
  Read Only: true

  Example: system
• description: string
  Example: Full access to organization administration features.
• id(required): integer (int64)
  Read Only: true

  Example: 1
• roleCode(required): string
  Example: ORG_ADMIN
• roleName(required): string
  Example: Organization Admin
• status(required): string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]

  Role lifecycle status.

  Example: ACTIVE
• updatedAt(required): string (date-time)
  Read Only: true
• updatedBy: string
  Read Only: true

  Example: placeholder

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "readOnly":true,
            "example":1
        },
        "roleCode":{
            "type":"string",
            "example":"ORG_ADMIN"
        },
        "roleName":{
            "type":"string",
            "example":"Organization Admin"
        },
        "description":{
            "type":"string",
            "nullable":true,
            "example":"Full access to organization administration features."
        },
        "status":{
            "$ref":"#/components/schemas/RoleStatus"
        },
        "createdAt":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "updatedAt":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "example":"system"
        },
        "updatedBy":{
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "example":"placeholder"
        }
    },
    "required":[
        "id",
        "roleCode",
        "roleName",
        "status",
        "createdAt",
        "updatedAt",
        "createdBy"
    ]
}

400 Response

Bad request.

Body ()

Root Schema : Error

Type: object

Show Source

• details(required): array details
• error(required): string
  Example: Wallet Not Found
• errorCode(required): string
  Example: WALLET_NOT_FOUND
• message(required): string
  Example: Wallet with id 123 was not found.
• path(required): string
  Example: /v1/uwaas/wallets/123
• status(required): integer
  Example: 404
• timestamp(required): string (date-time)
  Example: 2026-07-16T14:23:11.123Z

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "example":"2026-07-16T14:23:11.123Z"
        },
        "status":{
            "type":"integer",
            "example":404
        },
        "error":{
            "type":"string",
            "example":"Wallet Not Found"
        },
        "path":{
            "type":"string",
            "example":"/v1/uwaas/wallets/123"
        },
        "errorCode":{
            "type":"string",
            "example":"WALLET_NOT_FOUND"
        },
        "message":{
            "type":"string",
            "example":"Wallet with id 123 was not found."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "timestamp",
        "status",
        "error",
        "path",
        "errorCode",
        "message",
        "details"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

500 Response

Internal server error.

Body ()

Root Schema : Error

Type: object

Show Source

• details(required): array details
• error(required): string
  Example: Wallet Not Found
• errorCode(required): string
  Example: WALLET_NOT_FOUND
• message(required): string
  Example: Wallet with id 123 was not found.
• path(required): string
  Example: /v1/uwaas/wallets/123
• status(required): integer
  Example: 404
• timestamp(required): string (date-time)
  Example: 2026-07-16T14:23:11.123Z

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "example":"2026-07-16T14:23:11.123Z"
        },
        "status":{
            "type":"integer",
            "example":404
        },
        "error":{
            "type":"string",
            "example":"Wallet Not Found"
        },
        "path":{
            "type":"string",
            "example":"/v1/uwaas/wallets/123"
        },
        "errorCode":{
            "type":"string",
            "example":"WALLET_NOT_FOUND"
        },
        "message":{
            "type":"string",
            "example":"Wallet with id 123 was not found."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "timestamp",
        "status",
        "error",
        "path",
        "errorCode",
        "message",
        "details"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top