Gets groups for the agent.
get
/oaa-policy/group/v1
Retrieves all groups for an agent.
Request
Query Parameters
-
agentid(required): string
Id of the agent.
-
grouptype: string
Comma separated group types that can be used to filter groups.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
201 Response
All Group information
Root Schema : AllGroupResponse
Type:
object
All groups response object
Show Source
-
groups: array
groups
List of groups
-
message: string
Message related to the status of the request
-
status: string
Status of the request
Nested Schema : groups
Type:
array
List of groups
Show Source
-
Array of:
object schema
Defines a new group structure
Nested Schema : schema
Type:
object
Defines a new group structure
Show Source
-
agentid: string
Identifier of the agent which owns the group.
-
description: string
Description of the group.
-
groupid(required): string
Unique identifier of group.
-
groupname(required): string
Unique name of the group in the system.
-
grouptype(required): string
Type of the group. Can be one of the User ID, Generic Strings, Actions, IP Ranges and IPs
-
values: array
values
Values of elements in the group. Values depend on type of group.
Nested Schema : values
Type:
array
Values of elements in the group. Values depend on type of group.
Show Source
Nested Schema : items
Type:
object
401 Response
Unauthorized
405 Response
Invalid input
Root Schema : AllGroupResponse
Type:
object
All groups response object
Show Source
-
groups: array
groups
List of groups
-
message: string
Message related to the status of the request
-
status: string
Status of the request
Nested Schema : groups
Type:
array
List of groups
Show Source
-
Array of:
object schema
Defines a new group structure
Nested Schema : schema
Type:
object
Defines a new group structure
Show Source
-
agentid: string
Identifier of the agent which owns the group.
-
description: string
Description of the group.
-
groupid(required): string
Unique identifier of group.
-
groupname(required): string
Unique name of the group in the system.
-
grouptype(required): string
Type of the group. Can be one of the User ID, Generic Strings, Actions, IP Ranges and IPs
-
values: array
values
Values of elements in the group. Values depend on type of group.
Nested Schema : values
Type:
array
Values of elements in the group. Values depend on type of group.
Show Source
Nested Schema : items
Type:
object
500 Response
Internal server error
503 Response
Service Unavailable
Examples
The following example shows a sample request and response for retrieving all groups for an agent.
cURL Command to Get Groups for an Agent in JSON Format
curl --location --request GET '<PolicyUrl>/oaa-policy/group/v1?agentid=dede64d3-1d6a-42e9-89e1-714e88f8967c' \ --header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'
Sample Response in JSON Format
{ "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" ] } ] }
cURL Command to Get Groups for an Agent in XML Format
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>)>'
Sample Response in XML Format
<?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>