メンバーリスト照会

    メンバーリストを照会します。
    Developer Consoleの組織連携 > メンバーリスト照会 API の使用On に設定されている場合にのみ使用できます。
    リストの照会はページ単位で行い、1 ページごとに 100 名のメンバーが含まれます。 指定したページにメンバーが含まれない場合には空のリストを返します。

    API の種類

    サーバー API

    Request URL

    • サービス: https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users
    • テスト: https://sandbox-apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users

    HTTP Method

    GET

    Path Parameters

    パラメーター タイプ 上限 必須 説明
    domainId Integer Y ドメイン ID

    Request Parameters

    パラメーター タイプ 上限 必須 説明
    page Integer Y ページ

    Request Example

    GET https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/users?page=1
    

    Response

    パラメーター タイプ 説明
    externalKey String メンバーの External Key
    email String メールアドレス
    ベーシック・プレミアムプランで利用している場合には、 メールアドレスと同じ。
    ライトプランをグループ名で利用している場合には、組織 ID@ グループ名で記述。
    name String メンバー名
    authority String メンバー権限
    • MASTER: 最高管理者
    • MANEGER: 副管理者などその他の管理者
    • USER: メンバー
    organizations[] List メンバーが所属するドメイン(会社)のリスト(原職、兼職含む)
    organizations[].domainId Integer ドメイン ID
    organizations[].levelName String 職級
    organizations[].orgUnits[] List 各ドメインで所属している組織
    organizations[].orgUnits[].domainId Integer 組織の ドメイン ID
    organizations[].orgUnits[].name String 組織
    organizations[].orgUnits[].represent Boolean 代表組織かどうか。
    organizations[].orgUnits[].positionName String 役職
    organizations[].orgUnits[].display Boolean 組織の公開可否

    Response Example

    [
        {
            "externalKey": "TEST001",
            "email": "admin@test.com",
            "name": "ADMIN",
            "organizations": [
                {
                    "domainId": 1,
                    "orgUnits": [],
                    "levelName": "LVL"
                }
            ]
        },
        {
            "externalKey": "ABC",
            "email": "abc@test.com",
            "name": "ABC",
            "organizations": [
                {
                    "domainId": 1,
                    "orgUnits": [
                        {
                            "domainId": 1,
                            "name": "ORG1",
                            "represent": true,
                            "positionName": "Position1",
                            "display": true
                        },
                        {
                            "domainId": 1,
                            "name": "ORG2",
                            "represent": false,
                            "positionName": "Position2",
                            "display": true
                        }
                    ],
                    "levelName": "Level"
                }
            ]
        }
    ]
    

    Error Code

    呼び出しに失敗するとエラーコードとエラーメッセージを返します。
    エラーコードは組織連携REST APIエラーコードを参照してください。