アカウント一覧の取得

組織に所属するすべてのアカウント（管理対象ではないアカウントを含む）の一覧を取得します。

メソッド

GET

URL

/Users

/Users?filter=userName+eq+"MAIL_ADDRESS"

例）/Users?filter=userName+eq+%22example%40nulab.com%22

クエリパラメーター

名前	型	説明
filter	文字列	属性名の後ろに属性演算子と値が続く形 例）userName+eq+%22example%40nulab.com%22
startIndex	数値	取得する結果リストの最初のアカウントのインデックス ※未指定の場合は1とみなします
count	数値	取得する結果リストの最大数 ※未指定の場合は100とみなします

サポートしている属性名

名前	型	使用例
userName	文字列	メールアドレス

サポートしているSCIMフィルター

フィルタータイプ	説明
eq	等しい

レスポンス例

ステータスライン / レスポンスヘッダ

HTTP/1.1	200 OK
Content-Type:application/scim+json;charset=UTF-8

レスポンスボディ

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 2,
    "itemsPerPage": 2,
    "startIndex": 1,
    "Resources": [
        {
            "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:User"
            ],
            "id": "4kJpD7FC2C3ALSmp7ozAp2LZu2ZTaTCP4QZUnNu43XX3tUdhg",
            "meta": {
                "resourceType": "User",
                "created": "2023-11-10T08:19:17Z",
                "lastModified": "2024-01-13T01:04:37Z",
                "location": "https://api.apps.nulab.com/spaces/aeDWiLzQw/scim/v2/Users/4kJpD7FC2C3ALSmp7ozAp2LZu2ZTaTCP4QZUnNu43XX3tUdhg"
            },
            "userName": "example@nulab.com",
            "displayName": "AHorowitz",
            "preferredLanguage": "en",
            "locale": "en",
            "active": true,
            "roles": [
                {
                    "value": "ADMIN",
                    "primary": true
                }
            ]
        },
        {
            "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:User"
            ],
            "id": "6BV58gRox664F5QKPC9oUWHB23BtJqWVoSmTCzzjpCiKcoCYu",
            "externalId": "BradMarshalls",
            "meta": {
                "resourceType": "User",
                "created": "2024-02-13T05:03:49Z",
                "lastModified": "2024-02-27T08:01:23Z",
                "location": "https://api.apps.nulab.com/spaces/aeDWiLzQw/scim/v2/Users/6BV58gRox664F5QKPC9oUWHB23BtJqWVoSmTCzzjpCiKcoCYu"
            },
            "userName": "example2@nulab.com",
            "displayName": "BradMarshalls",
            "preferredLanguage": "en",
            "locale": "en",
            "timezone": "Asia/Tokyo",
            "active": true,
            "roles": [
                {
                    "value": "USER",
                    "primary": true
                }
            ]
        }
    ],
    "id": null,
    "externalId": null,
    "meta": null
}

レスポンス説明

名前	型	内容
id	文字列	アカウントのID ※アカウントを一意に識別する文字列
externalId	文字列	IdPで付与されるアカウントを識別するための外部ID
userName	文字列	メールアドレス ※アカウントを一意に識別するもの
displayName	文字列	ユーザー名
preferredLanguage	文字列	言語（locale と同じ値）
locale	文字列	言語（preferredLanguage と同じ値）
timezone	文字列	タイムゾーン
active	真偽値	アカウントのアクティブ/停止中 true: アクティブ false: 停止中
roles.[0].value	文字列	ADMIN: 管理者 USER: 一般ユーザー GUEST: ゲスト