OAA Admin API

Get the group by groupid

get

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

Gets group details.

Request

Path Parameters

groupid(required): string

Unique global identifier of the group

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Group information

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

{
    "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"
        }
    }
}

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.

{
    "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."
        }
    }
}

Nested Schema : values

Type: array

Values of elements in the group. Values depend on type of group.

Show Source

Array of: object items

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

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

{
    "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"
        }
    }
}

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.

{
    "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."
        }
    }
}

Nested Schema : values

Type: array

Values of elements in the group. Values depend on type of group.

Show Source

Array of: object items

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

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 group details.

cURL Command to Retrieve Group by groupid in JSON Format

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

Sample Response in JSON Format

{
    "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"
        ]
    }
}

cURL Command to Retrieve Group by groupid in XML Format

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>)>'

Sample Response in XML Format

<?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>