Creates a group.
post
/oaa-policy/group/v1
Group Definition API
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root 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
Root 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
Response
Supported Media Types
- application/xml
- application/json
201 Response
Group is created
Root Schema : GroupResponse
Type:
object
Group response object
Show Source
-
group: object
schema
Defines a new group structure
-
groupid: string
Unique key of the group.
-
message: string
Message related to the status of the request
-
status: string
Status of the request
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 : GroupResponse
Type:
object
Group response object
Show Source
-
group: object
schema
Defines a new group structure
-
groupid: string
Unique key of the group.
-
message: string
Message related to the status of the request
-
status: string
Status of the request
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 creating a group.
cURL Command to Create a Group in JSON Format
curl --location --request POST '<PolicyUrl>/oaa-policy/group/v1' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \ --data '{ "agentid": "dede64d3-1d6a-42e9-89e1-714e88f8967c", "grouptype": "Actions", "groupname": "FactorRuleGrp1", "description": "Group to set factors", "values": [ "ChallengeEmail", "ChallengeSMS" ] }'
Sample Response in JSON Format
{ "status": "201", "message": "Group created successfully", "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" ] } }
cURL Command to Create a Group in XML Format
curl --location --request POST '<PolicyUrl>/oaa-policy/group/v1' \ --header 'Content-Type: application/xml' \ --header 'Accept: application/xml' \ --header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \ --data '<?xml version="1.0" encoding="UTF-8" ?> <GroupRequest> <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> </GroupRequest> '
Sample Response in XML Format
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <GroupResponse> <status>201</status> <message>Group created successfully</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>