cybozu.com 共通 API ドキュメント

ユーザーが所属する組織を更新する

目次

ユーザーが所属する組織を更新する

ユーザーが所属する組織を更新します。

CSV ファイルをインポートする API の詳細は、 ユーザーの所属組織をインポートする を参照してください。

URL

https://sample.cybozu.com/v1/userOrganizations.json

HTTP メソッド

PUT

必要なアクセス権

リクエスト

パラメーター
パラメーター名 型 必須 説明
userOrganizations 配列 必須 ユーザーが所属するグループ情報の一覧
userOrganizations[].code 文字列 必須 ログイン名
128 文字以下で指定します。
userOrganizations[].organizations 配列 必須 ユーザーが所属するグループの一覧
最大 100 件まで指定できます。
ユーザーが所属するグループを更新するときは、すでに指定している組織もすべて指定してください。
指定していないと、所属組織から削除されます。
ユーザーを未所属にする場合には、空配列を指定してください。
userOrganizations[].organizations[].orgCode 文字列 条件必須 組織コード
128 文字以下で指定します。
userOrganizations[].organizations[].titleCode を指定する場合は必須です。
userOrganizations[].organizations[].titleCode 文字列 省略可 役職コード
128 文字以下で指定します。
省略すると、役職なしに設定されます。
リクエストの例
ヘッダー
1
2
3
4

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は User API の共通仕様 を参照してください。

ボディ
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

{
  "userOrganizations": [
    {
      "code": "user1",
      "organizations": [
        {
          "orgCode": "J_Sales",
          "titleCode": "J_Manager"
        }
      ]
    },
    {
      "code": "user2",
      "organizations": [
        {
          "orgCode": "J_Sales",
          "titleCode": "J_Chief"
        },
        {
          "orgCode": "J_HR"
        }
      ]
    },
    {
      "code": "user3",
      "organizations": []
    }
  ]
}

レスポンス

1

{}

制限事項

  • API の実行と同時に、画面から登録／編集したり CSV ファイルをインポートしたりした場合には、書き込まれた順に処理されます。
  • この API では、更新処理のロックは行っていません。
    そのため、画面からの登録／編集、CSV ファイルのインポート、API での操作を並行して行うことを推奨していません。