8.2.3. ユーザー

Security Management REST API は Business Central のユーザーを管理するための以下のエンドポイントをサポートします。Security Management REST API のベース URL は http://SERVER:PORT/business-central/rest/ です。ユーザーロール admin では、すべての要求で HTTP Basic 認証またはトークンベースの認証が必要です。

[GET] /users

Business Central のすべてのユーザを返します。

サーバーの応答例 (JSON)

[
    "newUser",
    "user1",
    "user2",
]

[GET] /users/{userName}/groups

指定のユーザーに割り当てられている全グループを返します。

表8.3 要求パラメーター

Name詳細タイプ要件

userName

割り当てられたグループを取得するユーザーの名前

String

必須

サーバーの応答例 (JSON)

[
  	{
		"group1"
	},
	{
		"group2"
	}
]

[GET] /users/{userName}/roles

指定のユーザーに割り当てられている全ロールを返します。

表8.4 要求パラメーター

Name詳細タイプ要件

userName

割り当てられたロールを取得するユーザーの名前

String

必須

サーバーの応答例 (JSON)

[
  {
    "name": "process-admin"
  },
  {
    "name": "manager"
  },
  {
    "name": "admin"
  }
]

[POST] /users

ロールとグループを指定して、指定のユーザーを作成します。

要求ボディーの例 (JSON)

{
  "name": "newUser",
  "roles": [
    "admin",
    "developer"
  ],
  "groups": [
    "group1",
    "group2"
  ]
}

サーバーの応答例 (JSON)

{
  "status": "OK",
  "message": "User newUser is created successfully."
}

[Post] /users/{userName}/changePassword

指定のユーザーのパスワードを変更します。

表8.5 要求パラメーター

Name詳細タイプ要件

userName

パスワードを変更するユーザーの名前

String

必須

要求のコマンド例

curl -u 'baAdmin:password@1' -H "Accept: application/json" -H "Content-Type: application/json" -X POST "http://localhost:8080/business-central/rest/users/newUser/changePassword" -d newpassword

サーバーの応答例 (JSON)

{
  "status": "OK",
  "message": "Password for newUser has been updated successfully."
}

[DELETE] /users/{userName}

Business Central から指定のユーザーを削除します。

表8.6 要求パラメーター

Name詳細タイプ要件

userName

削除するユーザーの名前

String

必須

サーバーの応答例 (JSON)

{
  "status": "OK",
  "message": "User newUser is deleted successfully."
}

[POST] /users/{userName}/groups

指定のユーザーに割り当てられている既存のグループを、新規グループで上書きします。

表8.7 要求パラメーター

Name詳細タイプ要件

userName

グループを更新するユーザーの名前

String

必須

要求ボディーの例 (JSON)

[
  "newGroup"
]

サーバーの応答例 (JSON)

{
  "status": "OK",
  "message": "Groups [newGroup] are assigned successfully to user wbadmin"
}

[POST] /users/{userName}/roles

指定のユーザーに割り当てられている既存のロールを、新規ロールで上書きします。

表8.8 要求パラメーター

Name詳細タイプ要件

userName

ロールを更新するユーザーの名前

String

必須

要求ボディーの例 (JSON)

[
  "admin"
]

サーバーの応答例 (JSON)

{
  "status": "OK",
  "message": "Roles [admin] are assigned successfully to user wbadmin"
}