すべてのプロダクト
Search

このプロダクト

    Qoder CN シリーズ:ListUsers — ユーザー一覧の取得

    ドキュメントセンター

    Qoder CN シリーズ:ListUsers — ユーザー一覧の取得

    最終更新日:Mar 27, 2026

    OpenAPI を使用してユーザーを一覧表示します。

    対応エディション

    Enterprise Dedicated Edition

    サービスエンドポイント

    サービスエンドポイントを取得し、API リクエスト構文内の {domain} をご利用の エンドポイント に置き換えます。

    認証

    製品

    リソース

    必要な権限

    organization management

    User

    読み取り専用

    リクエスト構文

    GET https://{domain}/oapi/v1/platform/users?filter={filter}&status={status}&deptId={deptId}&page={page}&perPage={perPage}

    リクエストの詳細

    アクティブユーザー

    curl -X 'GET' \
  'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/platform/users' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

    削除済みユーザー

    curl -X 'GET' \
  'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/platform/users?status=deleted' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

    リクエストヘッダー

    x-yunxiao-token string （必須）

    アクセストークンです。詳細については、「 アクセストークン 」をご参照ください。

    例：pt-0fh3****0fbG_35af****0484。

    リクエストパラメーター

    filter string （省略可）

    ユーザー名、ログイン名、メールアドレス、または電話番号に対するあいまい検索のキーワードです。

    status string （省略可）

    ユーザーのステータスでフィルター処理します。

    • enabled：アクティブユーザーを返します。

    • deleted：削除済みユーザーを返します。

    deptId string （省略可）

    部門 ID でユーザーをフィルター処理します。

    page integer （省略可）デフォルト値：1

    取得するページ番号です。

    perPage integer （省略可）デフォルト値：100

    1 ページあたりに返すエントリー数です。値は [1, 100] の範囲内である必要があります。

    レスポンスパラメーター

    アクティブユーザー

    [
    {
        "id": "c75d6f21-2af7-4d8e-b0fb-bac25128****",
        "username": "tmp_test2",
        "name": "Test User 2",
        "sysDeptIds": [
            "9e415b19-10bc-4bb6-a34f-2045a59a****"
        ],
        "lastOrganization": "3deba052-8501-4f30-a52d-3e9b1ca8****",
        "createdAt": "2025-06-10T06:45:29Z"
    },
    {
        "id": "85c7aa62-8da7-4f2d-8c99-4b90a253****",
        "username": "tmp_test1",
        "name": "Test User 1",
        "sysDeptIds": [
            "9e415b19-10bc-4bb6-a34f-2045a59a****"
        ],
        "createdAt": "2025-06-10T06:44:57Z"
    }
]

    削除済みユーザー

    [
    {
        "id": "3d4caf00-0004-4a07-9cb7-18c9559d****",
        "username": "doc-test4",
        "name": "Doc Test User 4",
        "nickName": "Nickname 4",
        "email": "doc-test4@example.com",
        "staffId": "1004",
        "sysDeptIds": [
            "ebeb5a64-c98c-478a-9d9d-513841da****"
        ],
        "createdAt": "2025-06-13T05:41:53Z",
        "deletedAt": "2025-06-13T06:36:43Z"
    }
]

    id string

    ユーザーの固有 ID です。

    username string

    ユーザーのログイン名です。

    name string

    ユーザーの表示名です。

    nickName string

    ユーザーのニックネームです。

    email string

    ユーザーのメールアドレスです。

    lastOrganization string

    ユーザーが最後にログインした組織の ID です。

    staffId string

    ユーザーの社員 ID です。

    sysDeptIds array[string]

    ユーザーが所属する部門の ID の配列です。

    createdAt string

    ユーザーが作成された時刻です。

    deletedAt string

    ユーザーが削除された時刻です。

    このパラメーターは、削除済みユーザーのみに返されます。

    レスポンスヘッダー

    パラメーター

    説明

    例

    x-next-page

    次のページ

    2

    x-page

    現在のページ

    1

    x-per-page

    1 ページあたりのエントリー数

    100

    x-prev-page

    前のページ

    0

    x-request-id

    リクエスト ID

    37294673-00CA-5B8B-914F-A8B35511E90A

    x-total

    エントリー総数

    10

    x-total-pages

    ページ総数

    1

    エラーコード

    詳細については、「エラーコード」をご参照ください。