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

グループコードを更新する

目次

グループコードを更新する

固定リンクがコピーされました

グループコードを更新します。
一度に更新できるグループは、100件までです。

CSVファイルをインポートするAPIの詳細は、次のページを参照してください。
グループ情報をインポートする

URL

固定リンクがコピーされました

https://sample.cybozu.com/v1/groups/codes.json

HTTPメソッド

固定リンクがコピーされました

PUT

必要なアクセス権

固定リンクがコピーされました

cybozu.com共通管理者 (External link)

リクエスト

固定リンクがコピーされました

パラメーター
パラメーター名 型 必須 説明
codes 配列 必須 グループコードの一覧
codes[].currentCode 文字列 必須
 現在のグループコード
128文字以下で指定します。
空文字または空白文字のみは指定できません。
codes[].newCode 文字列 必須 更新後のグループコード
128文字以下で指定します。
空文字または空白文字のみは指定できません。
リクエストの例
ヘッダー
1
2
3
4

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

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

ボディ
1
2
3
4
5
6
7
8

{
  "codes": [
    {
      "currentCode": "recruit2023",
      "newCode": "Recruit2023"
    }
  ]
}

レスポンス

固定リンクがコピーされました

1

{}

サンプルコード

固定リンクがコピーされました

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

curl -X PUT 'https://sample.cybozu.com/v1/groups/codes.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
        "codes": [
          {
            "currentCode": "recruit2023",
            "newCode": "Recruit2023"
          }
        ]
      }'

制限事項

固定リンクがコピーされました

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