グループを更新する
put
/oaa-policy/group/v1/{groupid}
グループの更新API
リクエスト
パス・パラメータ
- groupid(required): string
グループの一意のグローバル識別子
サポートされるメディア・タイプ
- application/xml
- application/json
ルート・スキーマ : schema
型:
object
グループ構造を更新するリクエスト・オブジェクト
ソースの表示
-
addvalues: array addvalues
グループに追加する値。型はlong、string、integerです。IP範囲の場合は、longにする必要があります。
-
description: string
更新するグループの説明。
-
groupname: string
システム内のグループの一意の名前。
-
removevalues: array removevalues
グループから削除される値。存在しない値は無視されます。
ネストされたスキーマ: items
型:
object
ネストされたスキーマ: items
型:
object
ルート・スキーマ : schema
型:
object
グループ構造を更新するリクエスト・オブジェクト
ソースの表示
-
addvalues: array addvalues
グループに追加する値。型はlong、string、integerです。IP範囲の場合は、longにする必要があります。
-
description: string
更新するグループの説明。
-
groupname: string
システム内のグループの一意の名前。
-
removevalues: array removevalues
グループから削除される値。存在しない値は無視されます。
ネストされたスキーマ: items
型:
object
ネストされたスキーマ: items
型:
object
レスポンス
サポートされるメディア・タイプ
- application/xml
- application/json
200レスポンス
グループが更新されました
ルート・スキーマ: GroupResponse
型:
object
グループのレスポンス・オブジェクト
ソースの表示
-
group: object schema
新しいグループ構造を定義します
-
groupid: string
グループの一意キー。
-
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レスポンス
無効な入力
ルート・スキーマ: GroupResponse
型:
object
グループのレスポンス・オブジェクト
ソースの表示
-
group: object schema
新しいグループ構造を定義します
-
groupid: string
グループの一意キー。
-
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 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>