開発者向け機能：API機能：ユーザ操作：ユーザ取得（全て） – Shelter

全ユーザレコードを取得するAPIの機能仕様です。
APIを使用してユーザのレコードを取得する事ができます。

■事前準備
APIの操作を行う前にAPIキーの作成を実施してください。

■URL
下記のURLを使用します。
https://ks01.shelterdb.net/api/users/get

■リクエスト
HTTP POSTで下記の形式のjsonデータを送信してください。
Content-Type は'application/json'、文字コードはUTF-8を使用してください。

{
    "ApiVersion": 1.1,
    "ApiKey": "610saf33fg52D3Sas2f7g32...",
    "View": {
        "ApiGetMailAddresses": true
    }
}

※ ApiGetMailAddress はオプショナル(必須でない項目)です。省略時は false が指定されます。true を指定した場合、次の例のようにメールアドレスが配列で応答に含まれます。

■レスポンス
下記の形式のjsonデータが返却されます。
データのレイアウトはこちらを参照してください。（パスワードは取得できません。）

以下の項目はテナント管理者のAPIキーで実行した場合のみ出力されます。

出力項目	画面上の表示名
LastLoginTime	最終ログイン日時
PasswordExpirationTime	パスワード有効期限
PasswordChangeTime	パスワード変更日時
NumberOfLogins	ログイン回数
NumberOfDenial	ログイン失敗回数
TenantManager	テナント管理者
Disabled	無効
Lockout	ロック
LockoutCounter	ロックカウンター

(a) テナント管理者のAPIキーで実行した場合

{
    "StatusCode": 200,
    "Response": {
        "Offset": 0,
        "PageSize": 200,
        "TotalCount": 1,
        "Data": [
            {
                "TenantId": 12345,
                "UserId": 12345,
                "Ver": 1,
                "LoginId": "chiba",
                "GlobalId": "",
                "Name": "千葉 さとみ",
                "UserCode": "",
                "Birthday": "2016-03-27T00:00:00",
                "Gender": "",
                "Language": "ja",
                "TimeZone": "Tokyo Standard Time",
                "DeptCode": "",
                "DeptId": 0,
                "Theme": "",
                "Body": "",
                "LastLoginTime": "2023-08-17T12:00:00",
                "PasswordExpirationTime": "2023-08-31T12:00:00",
                "PasswordChangeTime": "2023-06-02T12:00:00",
                "NumberOfLogins": 100,
                "NumberOfDenial": 5,
                "TenantManager": false,
                "Disabled": false,
                "Lockout": false,
                "LockoutCounter": 0,
                "UserSettings": "{}",
                "SecondaryAuthenticationCode": "",
                "SecondaryAuthenticationCodeExpirationTime": "1899-12-30T00:00:00",
                "LdapSearchRoot": "",
                "SynchronizedTime": "1899-12-30T00:00:00",
                "Comments": "[]",
                "Creator": 2,
                "Updator": 1,
                "CreatedTime": "2023-04-01T12:00:00",
                "UpdatedTime": "2023-08-15T12:00:00",
                "MailAddresses": [
                    "webmaster@example.com",
                    "info@example.com"
                ],
                "ApiVersion": 1.1,
                "ClassHash": {
                },
                "NumHash": {
                },
                "DateHash": {
                },
                "DescriptionHash": {
                },
                "CheckHash": {
                },
                "AttachmentsHash": {
                }
            }
        ]
    }
}

(b) テナント管理者以外のAPIキーで実行した場合

{
    "StatusCode": 200,
    "Response": {
        "Offset": 0,
        "PageSize": 200,
        "TotalCount": 1,
        "Data": [
            {
                "TenantId": 12345,
                "UserId": 12345,
                "Ver": 1,
                "LoginId": "chiba",
                "GlobalId": "",
                "Name": "千葉 さとみ",
                "UserCode": "",
                "Birthday": "2016-03-27T00:00:00",
                "Gender": "",
                "Language": "ja",
                "TimeZone": "Tokyo Standard Time",
                "DeptCode": "",
                "DeptId": 0,
                "Theme": "",
                "Body": "",
                "UserSettings": "{}",
                "SecondaryAuthenticationCode": "",
                "SecondaryAuthenticationCodeExpirationTime": "1899-12-30T00:00:00",
                "LdapSearchRoot": "",
                "SynchronizedTime": "1899-12-30T00:00:00",
                "Comments": "[]",
                "Creator": 2,
                "Updator": 1,
                "CreatedTime": "2023-04-01T12:00:00",
                "UpdatedTime": "2023-08-15T12:00:00",
                "MailAddresses": [
                    "webmaster@example.com",
                    "info@example.com"
                ],
                "ApiVersion": 1.1,
                "ClassHash": {
                },
                "NumHash": {
                },
                "DateHash": {
                },
                "DescriptionHash": {
                },
                "CheckHash": {
                },
                "AttachmentsHash": {
                }
            }
        ]
    }
}