エージェントのグループを取得する。
get
/oaa-policy/group/v1
エージェントのすべてのグループを取得します。
リクエスト
問合せパラメータ
- agentid(required): string
エージェントのID。
- grouptype: string
グループのフィルタに使用できるカンマ区切りのグループ・タイプ。
この操作にはリクエスト本文はありません。
先頭に戻るレスポンス
サポートされるメディア・タイプ
- application/xml
- application/json
201レスポンス
すべてのグループ情報
ルート・スキーマ: AllGroupResponse
型:
object
すべてのグループ・レスポンス・オブジェクト
ソースの表示
-
groups: array groups
グループのリスト
-
message: string
リクエストのステータスに関連するメッセージ
-
status: string
リクエストのステータス
ネストされたスキーマ: schema
型:
object
新しいグループ構造を定義します
ソースの表示
-
agentid: string
グループを所有するエージェントの識別子。
-
description: string
グループの説明。
-
groupid(required): string
グループの一意の識別子。
-
groupname(required): string
システム内のグループの一意の名前。
-
grouptype(required): string
グループのタイプ。ユーザーID、汎用文字列、アクション、IP範囲、IPのいずれかです
-
values: array values
グループ内の要素の値。値はグループのタイプによって異なります。
ネストされたスキーマ: items
型:
object
401レスポンス
未認可
405レスポンス
無効な入力
ルート・スキーマ: AllGroupResponse
型:
object
すべてのグループ・レスポンス・オブジェクト
ソースの表示
-
groups: array groups
グループのリスト
-
message: string
リクエストのステータスに関連するメッセージ
-
status: string
リクエストのステータス
ネストされたスキーマ: schema
型:
object
新しいグループ構造を定義します
ソースの表示
-
agentid: string
グループを所有するエージェントの識別子。
-
description: string
グループの説明。
-
groupid(required): string
グループの一意の識別子。
-
groupname(required): string
システム内のグループの一意の名前。
-
grouptype(required): string
グループのタイプ。ユーザーID、汎用文字列、アクション、IP範囲、IPのいずれかです
-
values: array values
グループ内の要素の値。値はグループのタイプによって異なります。
ネストされたスキーマ: items
型:
object
500レスポンス
内部サーバー・エラー
503レスポンス
サービス使用不可
例
次の例は、エージェントのすべてのグループを取得するサンプルのリクエストとレスポンスを示しています。
JSON形式でエージェントのグループを取得するcURLコマンド
curl --location --request GET '<PolicyUrl>/oaa-policy/group/v1?agentid=dede64d3-1d6a-42e9-89e1-714e88f8967c' \ --header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'
JSON形式のサンプル・レスポンス
{ "status": "200", "message": "Groups information", "groups": [ { "groupid": "112_90ba74290eae2b025f4d3edfffc52a89a5b00bfeeb7b9b3b492cf84b4f828390", "agentid": "dede64d3-1d6a-42e9-89e1-714e88f8967c", "grouptype": "User ID", "groupname": "ManagersGroup", "description": "Group for Managers", "values": [ "manager1", "manager2", "manager3" ] }, { "groupid": "114_7ee5f98740225f1379e86f21d2b0c6b592a236b57e0579e9617bfe4cf0edee5d", "agentid": "dede64d3-1d6a-42e9-89e1-714e88f8967c", "grouptype": "Generic Strings", "groupname": "Group for Generic Strings", "description": "Group description for Generic Strings", "values": [ "some string", "some other string" ] }, { "groupid": "127_ddd32e7186d66b2cb96cc4608ded0bb7d6ae4a48b1fc1894c69e715cf262e7ad", "agentid": "dede64d3-1d6a-42e9-89e1-714e88f8967c", "grouptype": "IP Ranges", "groupname": "Secure IP Range", "description": "Group for Secure IP Range", "values": [ { "name": "Secure IP List", "description": "Secure IP Range list", "from": "198.51.100.1", "to": "198.51.100.25" } ] }, { "groupid": "111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718", "agentid": "dede64d3-1d6a-42e9-89e1-714e88f8967c", "grouptype": "Actions", "groupname": "FactorRuleGrp1", "description": "Group to set factors", "values": [ "ChallengeEmail", "ChallengeSMS" ] }, { "groupid": "113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b", "agentid": "dede64d3-1d6a-42e9-89e1-714e88f8967c", "grouptype": "IPs", "groupname": "SecureIP", "description": "Group for Secure IP addresses", "values": [ "198.51.100.1", "198.51.100.2", "198.51.100.3" ] } ] }
XML形式でエージェントのグループを取得するcURLコマンド
curl --location --request GET '<PolicyUrl>/oaa-policy/group/v1?agentid=dede64d3-1d6a-42e9-89e1-714e88f8967c' \ --header 'Content-Type: application/xml' \ --header 'Accept: application/xml' \ --header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'
XML形式のサンプル・レスポンス
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <AllGroupResponse> <status>200</status> <message>Groups information</message> <groups> <groupid>112_90ba74290eae2b025f4d3edfffc52a89a5b00bfeeb7b9b3b492cf84b4f828390</groupid> <agentid>dede64d3-1d6a-42e9-89e1-714e88f8967c</agentid> <grouptype>User ID</grouptype> <groupname>ManagersGroup</groupname> <description>Group for Managers</description> <values>manager1</values> <values>manager2</values> <values>manager3</values> </groups> <groups> <groupid>114_7ee5f98740225f1379e86f21d2b0c6b592a236b57e0579e9617bfe4cf0edee5d</groupid> <agentid>dede64d3-1d6a-42e9-89e1-714e88f8967c</agentid> <grouptype>Generic Strings</grouptype> <groupname>Group for Generic Strings</groupname> <description>Group description for Generic Strings</description> <values>some string</values> <values>some other string</values> </groups> <groups> <groupid>127_ddd32e7186d66b2cb96cc4608ded0bb7d6ae4a48b1fc1894c69e715cf262e7ad</groupid> <agentid>dede64d3-1d6a-42e9-89e1-714e88f8967c</agentid> <grouptype>IP Ranges</grouptype> <groupname>Secure IP Range</groupname> <description>Group for Secure IP Range</description> <values> <name>Secure IP List</name> <description>Secure IP Range list</description> <from>198.51.100.1</from> <to>198.51.100.25</to> </values> </groups> <groups> <groupid>111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718</groupid> <agentid>dede64d3-1d6a-42e9-89e1-714e88f8967c</agentid> <grouptype>Actions</grouptype> <groupname>FactorRuleGrp1</groupname> <description>Group to set factors</description> <values>ChallengeEmail</values> <values>ChallengeSMS</values> </groups> <groups> <groupid>113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b</groupid> <agentid>dede64d3-1d6a-42e9-89e1-714e88f8967c</agentid> <grouptype>IPs</grouptype> <groupname>SecureIP</groupname> <description>Group for Secure IP addresses</description> <values>198.51.100.1</values> <values>198.51.100.2</values> <values>198.51.100.3</values> </groups> </AllGroupResponse>