ユーザ作成

概要¶

APIを使用して新規にユーザを作成することができます。

事前準備¶

APIの操作を行う前にAPIキーの作成を実施してください。
また、この機能はテナント管理者でないと行えないため、ユーザ管理からテナント管理者の設定を行ってください。

リクエスト¶

下記のリクエスト形式で、jsonデータを送信します。

(※1){サーバ名}の部分は、適宜、環境に合わせて編集してください。
　　pleasanter.netの場合は以下の形式になります。
　　https://pleasanter.net/fs/api/users/create

設定値¶

設定値はスクリプトの$p.apiUsersCreateでも指定できます。

リクエスト¶

JSON¶

{
    "ApiVersion": 1.1,
    "ApiKey": "017dRapJ3f5f1Dgsdj95...",
    "LoginId": "[登録するユーザーのログインIdを入力]",
    "Name": "[登録するユーザーの名前]",
    "Password": "[パスワード]",
    "MailAddresses": [
        "webmaster@example.com",
        "info@example.com"
    ],
    "ClassHash": {
        "ClassA": "test-class-column"
    },
    "NumHash": {
        "NumA": 100
    },
    "DateHash": {
        "DateA": "2026-08-19"
    },
    "DescriptionHash": {
        "DescriptionA": "補足説明"
    },
    "CheckHash": {
        "CheckA": true
    }
}

※ユーザ作成と同時にメールアドレスを設定する場合はMailAddressesにリスト形式で記述します（任意）。１つのユーザに対して単一または複数のメールアドレスを設定することが可能です。

レスポンス¶

下記の形式のjsonデータが返却されます。

JSON¶

{
    "Id": 12345,
    "StatusCode": 200,
    "Message": "\"登録するユーザーの名前\" を作成しました。"
}

対応バージョン¶

エラー時の確認事項¶

・API使用時の注意点やエラーが発生する場合の確認事項
・FAQ:変更後の設定ファイルやAPIリクエスト(JSON形式)が正しく認識されない場合の確認事項

仕様変更について¶

※ 2018年11月よりAPIの仕様が一部変更となりました。
- URLの形式が '/pleasanter/api_items/xxxx' から '/pleasanter/api/items/xxxx' に変更されました。
- Content-Type の指定が'application/x-www-form-urlencoded' から 'application/json'に変更されました。