Jump to

• Request
• Response

List Users Across Organizations

get

/v1/uwaas/users

List users across organizations. Authorization determines whether cross-organization results are returned or restricted to the caller's scoped organization.

Request

Query Parameters

• orgId: string
  Optional external organization identifier from orgId. When provided, the service resolves it to organizations.organization_id before querying users.

  Example:

  org-founder-bank

• page: integer
  Minimum Value: 0

  Default Value: 0
• role: string
  Optional role name filter.

  Example:

  Organization Admin

• search: string
  Optional free-text search across user identifiers and display names.

  Example:

  Carol

• size: integer
  Minimum Value: 1

  Maximum Value: 200

  Default Value: 50
• status:
  Optional status filter.

  Example:

  ACTIVE

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Users retrieved successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object User
  User response returned by get and list endpoints.

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

Nested Schema : User

Type: object

User response returned by get and list endpoints.

Show Source

• createdBy(required): string
  Read Only: true

  Example: system
• displayName: string
  Example: John Smith
• organizationName(required): string
  Read Only: true

  Example: Acme Corp
• orgId(required): string
  Read Only: true

  External organization identifier from orgId.

  Example: org-founder-bank
• roleId(required): integer (int64)
  Minimum Value: 1

  Minimum Value: > false

  Maximum Value: 4

  Maximum Value: < false

  Role identifier. Mapping: 1 - WALLET_SUPER_ADMIN 2 - ORG_ADMIN 3 - ORG_USER 4 - TOKEN_ADMIN

  Example: 3
• roleName(required): string
  Read Only: true

  Example: Org User
• status(required): string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]

  User lifecycle status shown in User Management.

  Example: ACTIVE
• userId(required): string (uuid)
  Read Only: true

  External identity-provider identifier for the user.

  Example: 3da1c611-c698-42e3-86db-4c9ded652618

{
    "type":"object",
    "description":"User response returned by get and list endpoints.",
    "properties":{
        "userId":{
            "type":"string",
            "format":"uuid",
            "readOnly":true,
            "description":"External identity-provider identifier for the user.",
            "example":"3da1c611-c698-42e3-86db-4c9ded652618"
        },
        "displayName":{
            "type":"string",
            "example":"John Smith"
        },
        "orgId":{
            "type":"string",
            "readOnly":true,
            "description":"External organization identifier from orgId.",
            "example":"org-founder-bank"
        },
        "organizationName":{
            "type":"string",
            "readOnly":true,
            "example":"Acme Corp"
        },
        "roleName":{
            "type":"string",
            "readOnly":true,
            "example":"Org User"
        },
        "status":{
            "$ref":"#/components/schemas/UserStatus"
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "example":"system"
        },
        "roleId":{
            "$ref":"#/components/schemas/RoleId"
        }
    },
    "required":[
        "userId",
        "orgId",
        "organizationName",
        "roleName",
        "roleId",
        "status",
        "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"
    }
}

401 Response

Unauthorized.

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