プラグインの基本設定を取得する

Garoon API ドキュメント

プラグインが有効かどうかや、プラグインの適用対象を取得します。

https://sample.cybozu.com/g/api/v1/system/plugin/admin/settings/プラグイン ID

パラメーター名	説明
プラグイン ID	基本設定を取得するプラグインのプラグイン ID

GET

次のいずれかの権限が必要です。

なし

https://sample.cybozu.com/g/api/v1/system/plugin/admin/settings/1

1
2
3


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

プロパティ名	型	説明
isActive	真偽値	プラグインの利用が有効かどうか `true`：有効 `false`：無効
appliedTo[].id	文字列	適用対象の ID `appliedTo[].type` ごとに内容が異なります。「USER」の場合：ユーザーの ID 「ORGANIZATION」の場合：組織の ID 「ROLE」の場合：次の値のいずれかグループ ID なし（`Everyone` または `LoginUser` のとき）
appliedTo[].code	オブジェクト	適用対象のコード `appliedTo[].type` ごとに内容が異なります。「USER」の場合：ログイン名パッケージ版 Garoon の場合、ログイン名を公開する設定が必要です。詳細はユーザー情報の項目を変更するを参照してください。「ORGANIZATION」の場合：組織コード「ROLE」の場合：次の値のいずれか `Everyone` `LoginUser` グループコード
appliedTo[].name	文字列	適用対象の名前 `appliedTo[].type` ごとに内容が異なります。「USER」の場合：ユーザーの表示名「ORGANIZATION」の場合：組織名「ROLE」の場合：次の値のいずれか `Everyone` `LoginUser` グループ名
appliedTo[].type	文字列	適用対象のタイプ `USER`：ユーザー `ORGANIZATION`：組織 `ROLE`：グループ（ロール）

1
2


curl -X GET 'https://sample.cybozu.com/g/api/v1/system/plugin/admin/settings/1' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='

1

await garoon.api('/api/v1/system/plugin/admin/settings/1', 'GET', {});