6.107. グループ

ユーザーのグループのコレクションを管理します。

表6.319 メソッドの概要

名前概要

add

ディレクトリーサービスからグループを追加します。

list

システム内のすべてのグループを一覧表示します。

6.107.1. add POST

ディレクトリーサービスからグループを追加します。ドメイン名は、認証プロバイダーの名前であることに注意してください。

たとえば、internal-authz 認証プロバイダーから Developers グループを追加するには、以下のような要求を送信します。

POST /ovirt-engine/api/groups

リクエスト本文は以下のようになります。

<group>
  <name>Developers</name>
  <domain>
    <name>internal-authz</name>
  </domain>
</group>

表6.320 パラメーターの概要

名前タイプ方向概要

group

グループ

In/Out

追加するグループ。

6.107.2. list GET

システム内のすべてのグループを一覧表示します。

使用方法

GET /ovirt-engine/api/groups

グループの一覧を返します。

<groups>
  <group href="/ovirt-engine/api/groups/123" id="123">
    <name>mygroup</name>
    <link href="/ovirt-engine/api/groups/123/roles" rel="roles"/>
    <link href="/ovirt-engine/api/groups/123/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/groups/123/tags" rel="tags"/>
    <domain_entry_id>476652557A382F67696B6D2B32762B37796E46476D513D3D</domain_entry_id>
    <namespace>DC=example,DC=com</namespace>
    <domain href="/ovirt-engine/api/domains/ABCDEF" id="ABCDEF">
      <name>myextension-authz</name>
    </domain>
  </group>
  ...
</groups>

返されたグループリストの順序は保証されません。

表6.321 パラメーターの概要

名前タイプ方向概要

case_sensitive

Boolean

In

search パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。

follow

文字列

In

たどる 必要のある内部リンクを指定します。

groups

Group[]

Out

グループの一覧。

max

Integer

In

返すグループの最大数を設定します。

search

文字列

In

返されるグループを制限するために使用されるクエリー文字列。

6.107.2.1. case_sensitive

search パラメーターを使用して実行する検索を、大文字と小文字を区別して実行する必要があるかどうかを示します。デフォルト値は true です。つまり、大文字と小文字の区別が考慮されます。ケースを無視する場合は、false に設定します。

6.107.2.2. follow

たどる 必要のある内部リンクを指定します。これらのリンクで参照されるオブジェクトは、現在の要求の一部としてフェッチされます。詳細は、こちら を参照してください。

6.107.2.3. max

返すグループの最大数を設定します。指定のない場合は、すべてのグループが返されます。