RAD サーバー グループ リソース
RAD サーバー管理用 API への移動
EMS データベースには、アプリケーションの登録済みユーザーのグループに関するデータが格納されています。登録されているグループ リソースを使って、この情報にアクセスすることができます。
EMS グループを使用して、EMS サーバーの特定の EMS リソースにアクセスする権限を（HTTP 要求に含まれている資格情報に応じて）EMS ユーザーのグループに与える（与えない）ことができます。
- メモ： TEMSClientAPI コンポーネントまたは TBackendGroups コンポーネントを使用すると、EMS グループの作成、更新、削除や既存の EMS グループへの EMS ユーザーの追加を行うことができます。
目次
グループ リソース エンドポイント
グループ リソースでは、次の EMS リソース エンドポイントを公開しています。
| エンドポイント メソッド名 | リソース サフィックス | HTTP 要求の種類 | 用途 |
|---|---|---|---|
|
GetGroups |
-- |
HTTP GET |
グループ リソースからすべてのデータを取得すること。 |
|
GetGroup |
|
HTTP GET |
グループからすべてのデータを取得すること。 |
|
GetGroupFields |
|
HTTP GET |
すべての EMS グループのフィールド名を取得すること。 |
|
AddGroup |
-- |
HTTP POST |
EMS データベースに新しいグループを追加すること。 |
|
UpdateGroup |
|
HTTP PUT |
EMS データベース内のグループを更新すること。 |
|
DeleteGroup |
|
HTTP DELETE |
EMS データベースからグループを削除すること。 |
GetGroups エンドポイント
EMS グループ データのリストを返します。
QueryGroups メソッド、TBackendGroups コンポーネント、TBackendQuery コンポーネントとグループ リソースを使用すると、EMS ユーザーのリストを取得できます。
正常終了した場合、EMS サーバーからの応答は全 EMS グループのリストと各グループについての詳細を示します。
- name
- _meta（creator、created date、updated date の各フィールド）
- users
- カスタム フィールド（省略可能）
応答の例
次は応答の例です。
[
{
"name": "testgroup",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000001",
"created": "2014-08-20T11:08:56.000Z"
},
"description": "Created by EMS setup.",
"users": [
"24EDA495-90FC-4BC4-9626-C87783357948"
]
},
{
"name": "admins",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000001",
"created": "2014-08-20T11:08:56.000Z",
"updated": "2014-08-20T11:09:56.000Z"
},
"users": [
"24EDA495-90FC-4BC4-9626-C87783357948",
"AB4900CC-CD7A-4890-B20D-9A3E65B450C7"
]
}
]
GetGroup エンドポイント
指定された EMS グループのデータを返します。
要求には、次のフィールドを指定する必要があります。
- name
RetrieveGroup メソッド、TBackendGroups コンポーネント、TBackendQuery コンポーネントとグループ名を使用すると、そのグループのデータを取得できます。
正常終了した場合、EMS サーバーからの応答は EMS グループとその詳細を示します。
- name
- _meta（creator、created、updated の各フィールド）
- users
- カスタム フィールド（省略可能）
応答の例
グループ名 "testgroup" の要求に対する応答の例を次に示します。 :
{
"name": "testgroup",
"_meta": {
"creator": "00000000-0000-0000-0000-000000000001",
"created": "2014-08-20T11:08:56.000Z"
},
"description": "Created by EMS setup.",
"users": [
"24EDA495-90FC-4BC4-9626-C87783357948"
]
}
GetFields エンドポイント
EMS データベースからすべての EMS グループのフィールド名を取得します。
RetrieveGroupsFields メソッドを使用すると、EMS グループのフィールドを取得できます。
正常終了した場合は、EMS グループのすべてのフィールド名を並べたリストが EMS サーバーからの応答になります。
- name
- _meta（creator、created、updated の各フィールド）
- users
応答の例
次は応答の例です。
[
{
"name":"groupname"
},
{
"name":"_meta",
"fields":[
{
"name":"creator"
},
{
"name":"created"
},
{
"name":"updated"
}
]
},
{
"name":"users"
},
{
"name":"description",
"custom":true
}
]
AddGroup エンドポイント
EMS データベースに新しいグループを追加します。
要求には、次のフィールドを指定する必要があります。
- name
TEMSClientAPI.CreateGroup メソッド、TBackendGroups コンポーネントの CreateGroup メソッドを使用すると、新しい EMS グループを追加できます。
UpdateGroup エンドポイント
EMS データベースに格納されている既存の EMS グループのデータを更新します。
要求には、少なくとも次のフィールドを指定する必要があります。
- name
TEMSClientAPI.UpdateGroup メソッド、TBackendGroups コンポーネントの UpdateGroup メソッドを使用すると、既存の EMS グループのデータを更新できます。
DeleteGroup エンドポイント
EMS データベースから既存の EMS グループを削除します。
要求には、次のフィールドを指定する必要があります。
- name
TEMSClientAPI.DeleteGroup メソッド、TBackendGroups コンポーネントの DeleteGroup メソッドを使用すると、既存の EMS グループを削除できます。
EMS グループのフィールド
EMS 要求および応答におけるグループ リソースには、次のフィールドの任意の組み合わせが含まれる可能性があります。
| 項目 | 例 | 説明 |
|---|---|---|
"name"
|
"admins"
|
EMS データベースでの一意な EMS グループ名。 |
"_meta"
|
{
"creator": "00000000-0000-0000-0000-000000000001",
"created": "2014-08-20T11:08:56.000Z",
"updated": "2014-08-20T11:09:56.000Z"
}
|
|
"users"
|
[
"24EDA495-90FC-4BC4-9626-C87783357948",
"AB4900CC-CD7A-4890-B20D-9A3E65B450C7"
]
|
その EMS グループに属する EMS ユーザーのリスト。 |
|
カスタム フィールド |
"myCustomField": "My Custom Field description"
|
格納されている EMS グループの追加情報。 |