ユーザを作成するためのAPI仕様です。
APIを使用して新規にレコードを作成する事ができます。
■事前準備
APIの操作を行う前にAPIキーの作成を実施してください。
また、この機能はテナント管理者でないと行えないため、ユーザ管理からテナント管理者の設定を行ってください。
■制限事項
「ROBOT ID」をご利用の場合、ユーザの作成は「ROBOT ID」側で行ってください。
■リクエスト
下記のリクエスト形式で、jsonデータを送信します。
<設定項目>
設定項目 | 値 |
---|---|
HTTPメソッド | POST |
Content-Type | application/json |
文字コード | UTF-8 |
URL | https://ks01.shelterdb.net/api/users/create |
Body | 以下のjsonデータを参考のこと |
<jsonデータ>
{
"ApiVersion": 1.1,
"ApiKey": "XXXXXXXXXX...",
"LoginId" : "[登録するユーザーのログインIdを入力]",
"Name" : "[登録するユーザーの名前]",
"Password" : "[パスワード]",
"MailAddresses": [
"webmaster@example.com",
"info@example.com"
]
}
※ユーザ作成と同時にメールアドレスを設定する場合はMailAddressesにリスト形式で記述します(任意)。
1つのユーザに対して単一または複数のメールアドレスを設定することが可能です。
■レスポンス
下記の形式のjsonデータが返却されます。
{
"Id": 12345,
"StatusCode": 200,
"Message": "\"登録するユーザーの名前\" を作成しました。"
}