カテゴリー内の他の記事

プラグインの基本設定の取得(GET)

Index

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

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

HTTP メソッド

GET

URI

クラウド版

https://(サブドメイン名).cybozu.com/g/api/v1/system/plugin/admin/settings/{pluginId}

使用可能なガルーンのバージョン

  • クラウド版 Garoon

必要なアクセス権

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

リクエストの例 

GET /g/api/v1/system/plugin/admin/settings/1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
  • Content-Typeヘッダは不要です。

リクエストパラメータ

パラメータ名 指定する値 必須 説明
pluginId 数値

必須

プラグイン ID

レスポンスの例

処理が成功すると、指定したプラグイン ID のプラグインの設定状況が JSON 形式で返されます。 

レスポンスのプロパティ

プロパティ名 説明
isActive 真偽値 プラグインの利用が有効かどうか
appliedTo[].id 文字列

適用対象の ID

appliedTo[].type プロパティの値によって異なります。

  • 「USER」 の場合:ユーザーの ID
  • 「ORGANIZATION」 の場合:組織の ID
  • 「ROLE」の場合:次の値のいずれか
    • グループ ID
    • なし(Everyone または LoginUser のとき)
appliedTo[].code オブジェクト

適用対象のコード

appliedTo[].type プロパティの値によって異なります。

  • 「USER」 の場合:ログイン名
  • 「ORGANIZATION」 の場合:組織コード
  • 「ROLE」の場合:次の値のいずれか
    • Everyone
    • LoginUser
    • グループコード
appliedTo[].name 文字列 

適用対象の名前

appliedTo[].type プロパティの値によって異なります。

  • 「USER」 の場合:ユーザーの表示名
  • 「ORGANIZATION」 の場合:組織名
  • 「ROLE」の場合:次の値のいずれか
    • Everyone
    • LoginUser
    • グループ名
appliedTo[].type 文字列 

適用対象のタイプ

  • USER:ユーザー
  • ORGANIZATION:組織
  • ROLE:グループ(ロール)

JavaScript サンプル

Garoon REST API

XMLHttpRequest

制限事項

共通仕様の制限事項 をご確認ください。

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

サインインしてコメントを残してください。