Garoon API ドキュメント

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

目次

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

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

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

URL

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

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

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

HTTP メソッド

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

GET

利用できるバージョン

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

  • クラウド版 Garoon

必要なアクセス権

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

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

  • Garoon のシステム管理者権限
  • 予定のアプリケーション管理者権限

リクエスト

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

パラメーター

なし

リクエストの例
URL

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 の場合、ログイン名を公開する設定が必要です。
    詳細は ユーザー情報の項目を変更する (External link) を参照してください。
  • 「ORGANIZATION」 の場合：組織コード
  • 「ROLE」の場合：次の値のいずれか
    • Everyone
    • LoginUser
    • グループコード
appliedTo[].name 文字列 適用対象の名前
appliedTo[].type ごとに内容が異なります。
  • 「USER」 の場合：ユーザーの表示名
  • 「ORGANIZATION」 の場合：組織名
  • 「ROLE」の場合：次の値のいずれか
    • Everyone
    • LoginUser
    • グループ名
appliedTo[].type 文字列 適用対象のタイプ
  • USER：ユーザー
  • ORGANIZATION：組織
  • ROLE：グループ（ロール）

サンプルコード

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

curl を使ったリクエスト
1
2

curl -X GET 'https://sample.cybozu.com/g/api/v1/system/plugin/admin/settings/1' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST API リクエストを送信する API を使ったリクエスト
1

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