ジャンプ先

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

グループを更新する

put

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

グループの更新API

リクエスト

パス・パラメータ

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

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

• application/xml
• application/json

リクエスト本文 - application/xml ()

ルート・スキーマ : schema

型: object

グループ構造を更新するリクエスト・オブジェクト

ソースの表示

• addvalues: array addvalues
  グループに追加する値。型はlong、string、integerです。IP範囲の場合は、longにする必要があります。
• description: string
  更新するグループの説明。
• groupname: string
  システム内のグループの一意の名前。
• removevalues: array removevalues
  グループから削除される値。存在しない値は無視されます。

{
    "type":"object",
    "description":"Request object to update group structure",
    "properties":{
        "groupname":{
            "type":"string",
            "description":"Unique name of the group in the system."
        },
        "description":{
            "type":"string",
            "description":"Description of the group to be updated."
        },
        "addvalues":{
            "type":"array",
            "items":{
                "type":"object"
            },
            "description":"Values to be added to the group. It can be of type long, string, integer. For IP range it needs to be long."
        },
        "removevalues":{
            "type":"array",
            "items":{
                "type":"object"
            },
            "description":"Values to be removed from the group. Values which are not present will be ignored."
        }
    }
}

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

型: array

グループに追加する値。型はlong、string、integerです。IP範囲の場合は、longにする必要があります。

ソースの表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object"
    },
    "description":"Values to be added to the group. It can be of type long, string, integer. For IP range it needs to be long."
}

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

型: array

グループから削除される値。存在しない値は無視されます。

ソースの表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object"
    },
    "description":"Values to be removed from the group. Values which are not present will be ignored."
}

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

型: object

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

型: object

リクエスト本文 - application/json ()

ルート・スキーマ : schema

型: object

グループ構造を更新するリクエスト・オブジェクト

ソースの表示

• addvalues: array addvalues
  グループに追加する値。型はlong、string、integerです。IP範囲の場合は、longにする必要があります。
• description: string
  更新するグループの説明。
• groupname: string
  システム内のグループの一意の名前。
• removevalues: array removevalues
  グループから削除される値。存在しない値は無視されます。

{
    "type":"object",
    "description":"Request object to update group structure",
    "properties":{
        "groupname":{
            "type":"string",
            "description":"Unique name of the group in the system."
        },
        "description":{
            "type":"string",
            "description":"Description of the group to be updated."
        },
        "addvalues":{
            "type":"array",
            "items":{
                "type":"object"
            },
            "description":"Values to be added to the group. It can be of type long, string, integer. For IP range it needs to be long."
        },
        "removevalues":{
            "type":"array",
            "items":{
                "type":"object"
            },
            "description":"Values to be removed from the group. Values which are not present will be ignored."
        }
    }
}

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

型: array

グループに追加する値。型はlong、string、integerです。IP範囲の場合は、longにする必要があります。

ソースの表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object"
    },
    "description":"Values to be added to the group. It can be of type long, string, integer. For IP range it needs to be long."
}

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

型: array

グループから削除される値。存在しない値は無視されます。

ソースの表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object"
    },
    "description":"Values to be removed from the group. Values which are not present will be ignored."
}

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

型: object

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

型: object

先頭に戻る

レスポンス

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

• 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形式でグループを更新するcURLコマンド

curl --location --request PUT '<PolicyUrl>/oaa-policy/group/v1/111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
    "groupname": "FactorRuleGrp1",
    "description": "Group to set factors",
    "addvalues": [
        "ChallengeOMATOTP",
        "ChallengeYubicoOTP"
    ],
    "removevalues": [
        "ChallengeSMS"
    ]
}'

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

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

XML形式でグループを更新するcURLコマンド

curl --location --request PUT '<PolicyUrl>/oaa-policy/group/v1/111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '<?xml version="1.0" encoding="UTF-8" ?>
 <UpdateGroupRequest>
     <groupname>FactorRuleGrp1</groupname>
     <description>Group to set factors</description>
     <addvalues>ChallengeOMATOTP</addvalues>
     <addvalues>ChallengeYubicoOTP</addvalues>
     <removevalues>ChallengeSMS</removevalues>
 </UpdateGroupRequest>
'

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <GroupResponse>
     <status>200</status>
     <message>Group updated</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>ChallengeOMATOTP</values>
         <values>ChallengeYubicoOTP</values>
     </group>
 </GroupResponse>

先頭に戻る