ジャンプ先

• リクエスト
• レスポンス
• 例

グループIDでグループを取得する

get

/oaa-policy/group/v1/{groupid}

グループの詳細を取得します。

リクエスト

パス・パラメータ

• groupid(required): string
  グループの一意のグローバル識別子

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/xml
• application/json

200レスポンス

グループ情報

本文()

ルート・スキーマ: GroupResponse

型: object

グループのレスポンス・オブジェクト

ソースの表示

• group: object schema
  新しいグループ構造を定義します
• groupid: string
  グループの一意キー。
• message: string
  リクエストのステータスに関連するメッセージ
• status: string
  リクエストのステータス

{
    "type":"object",
    "description":"Group response object",
    "required":[
        "key",
        "name",
        "agentgid"
    ],
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request"
        },
        "message":{
            "type":"string",
            "description":"Message related to the status of the request"
        },
        "groupid":{
            "type":"string",
            "description":"Unique key of the group."
        },
        "group":{
            "$ref":"#/components/schemas/Group"
        }
    }
}

ネストされたスキーマ: schema

型: object

新しいグループ構造を定義します

ソースの表示

• agentid: string
  グループを所有するエージェントの識別子。
• description: string
  グループの説明。
• groupid(required): string
  グループの一意の識別子。
• groupname(required): string
  システム内のグループの一意の名前。
• grouptype(required): string
  グループのタイプ。ユーザーID、汎用文字列、アクション、IP範囲、IPのいずれかです
• values: array values
  グループ内の要素の値。値はグループのタイプによって異なります。

{
    "type":"object",
    "description":"Defines a new group structure",
    "required":[
        "groupid",
        "groupname",
        "grouptype"
    ],
    "properties":{
        "groupid":{
            "type":"string",
            "description":"Unique identifier of group."
        },
        "agentid":{
            "type":"string",
            "description":"Identifier of the agent which owns the group."
        },
        "grouptype":{
            "type":"string",
            "description":"Type of the group. Can be one of the User ID, Generic Strings, Actions, IP Ranges and IPs"
        },
        "groupname":{
            "type":"string",
            "description":"Unique name of the group in the system."
        },
        "description":{
            "type":"string",
            "description":"Description of the group."
        },
        "values":{
            "type":"array",
            "items":{
                "type":"object"
            },
            "description":"Values of elements in the group. Values depend on type of group."
        }
    }
}

ネストされたスキーマ: values

型: array

グループ内の要素の値。値はグループのタイプによって異なります。

ソースの表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object"
    },
    "description":"Values of elements in the group. Values depend on type of group."
}

ネストされたスキーマ: items

型: object

401レスポンス

未認可

405レスポンス

無効な入力

本文()

ルート・スキーマ: GroupResponse

型: object

グループのレスポンス・オブジェクト

ソースの表示

• group: object schema
  新しいグループ構造を定義します
• groupid: string
  グループの一意キー。
• message: string
  リクエストのステータスに関連するメッセージ
• status: string
  リクエストのステータス

{
    "type":"object",
    "description":"Group response object",
    "required":[
        "key",
        "name",
        "agentgid"
    ],
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request"
        },
        "message":{
            "type":"string",
            "description":"Message related to the status of the request"
        },
        "groupid":{
            "type":"string",
            "description":"Unique key of the group."
        },
        "group":{
            "$ref":"#/components/schemas/Group"
        }
    }
}

ネストされたスキーマ: schema

型: object

新しいグループ構造を定義します

ソースの表示

• agentid: string
  グループを所有するエージェントの識別子。
• description: string
  グループの説明。
• groupid(required): string
  グループの一意の識別子。
• groupname(required): string
  システム内のグループの一意の名前。
• grouptype(required): string
  グループのタイプ。ユーザーID、汎用文字列、アクション、IP範囲、IPのいずれかです
• values: array values
  グループ内の要素の値。値はグループのタイプによって異なります。

{
    "type":"object",
    "description":"Defines a new group structure",
    "required":[
        "groupid",
        "groupname",
        "grouptype"
    ],
    "properties":{
        "groupid":{
            "type":"string",
            "description":"Unique identifier of group."
        },
        "agentid":{
            "type":"string",
            "description":"Identifier of the agent which owns the group."
        },
        "grouptype":{
            "type":"string",
            "description":"Type of the group. Can be one of the User ID, Generic Strings, Actions, IP Ranges and IPs"
        },
        "groupname":{
            "type":"string",
            "description":"Unique name of the group in the system."
        },
        "description":{
            "type":"string",
            "description":"Description of the group."
        },
        "values":{
            "type":"array",
            "items":{
                "type":"object"
            },
            "description":"Values of elements in the group. Values depend on type of group."
        }
    }
}

ネストされたスキーマ: values

型: array

グループ内の要素の値。値はグループのタイプによって異なります。

ソースの表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object"
    },
    "description":"Values of elements in the group. Values depend on type of group."
}

ネストされたスキーマ: items

型: object

500レスポンス

内部サーバー・エラー

503レスポンス

サービス使用不可

先頭に戻る

例

次の例は、グループの詳細を取得するサンプルのリクエストとレスポンスを示します。

JSON形式でグループID別にグループを取得するcURLコマンド

curl --location --request GET '<PolicyUrl>/oaa-policy/group/v1/111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

JSON形式のサンプル・レスポンス

{
    "status": "200",
    "message": "Group information",
    "groupid": "111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718",
    "group": {
        "groupid": "111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718",
        "agentid": "dede64d3-1d6a-42e9-89e1-714e88f8967c",
        "grouptype": "Actions",
        "groupname": "FactorRuleGrp1",
        "description": "Group to set factors",
        "values": [
            "ChallengeEmail",
            "ChallengeSMS"
        ]
    }
}

XML形式でグループID別にグループを取得するcURLコマンド

curl --location --request GET '<PolicyUrl>/oaa-policy/group/v1/111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718' \
--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"?>
 <GroupResponse>
     <status>200</status>
     <message>Group information</message>
     <groupid>111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718</groupid>
     <group>
         <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>
     </group>
 </GroupResponse>

先頭に戻る