ListUsersByRegion

POST

https://api.cbf.tcn.com/api/v1alpha1/org/users/listusersbyregion

ListUsersByRegion returns a list of usersByRegion.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "region_id": "string",
    "agent": true,
    "archived_filter": "USER_ARCHIVED_STATE_FILTER_ALL"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/org/users/listusersbyregion' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "region_id": "string",
    "agent": true,
    "archived_filter": "USER_ARCHIVED_STATE_FILTER_ALL"
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "users": [
        {
            "user_id": "string",
            "org_id": "string",
            "first_name": "string",
            "last_name": "string",
            "username": "string",
            "login_disabled": true,
            "permission_group_ids": [
                "string"
            ],
            "labels": [
                {
                    "org_id": "string",
                    "name": "string",
                    "description": "string",
                    "color": "string",
                    "label_id": "string",
                    "deleted": true
                }
            ],
            "account_owner": true,
            "agent": true,
            "trust_ids": [
                "string"
            ],
            "mfa_info": {
                "duo": {
                    "duo_username": "string"
                }
            },
            "email_verified": true
        }
    ]
}

🟢200Success

Modified at 2025-09-26 15:44:58

ListUsersByOrgId

UpdateMyUser