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

{
  "userOrganizations": [
    {
      "code": "kato-misaki",
      "organizations": [
        {
          "orgCode": "Sales01",
          "titleCode": "TeamLeader"
        }
      ]
    }
  ]
}

レスポンス

1

{}

サンプルコード

curl を使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

curl -X PUT 'https://sample.cybozu.com/v1/userOrganizations.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "userOrganizations": [
      {
        "code": "kato-misaki",
        "organizations": [
          {
            "orgCode": "Sales01",
            "titleCode": "TeamLeader"
          }
        ]
      }
    ]
  }'

制限事項

  • cybozu.com 共通管理における次の操作と、API の実行を並行して行うことは推奨しません。
    • 組織とユーザーの設定画面における、ユーザーに対する各操作
    • ファイルからの読み込み