Retrieving Groups and Group Details

Retrieving all current authorization groups and specific group details can be achieving by performing a GET request to the https://{orchestrator_fqdn}/vco/api/authorization-groups endpoint.

The response follows the same pattern as in the Catalog API. Filtering can be done by using [Apply Filters]().

Procedure

  1. To retrieve all current authorization groups, perform a GET request at https://{orchestrator_fqdn}/vco/api/authorization-groups.
    You receive a response similar to the following sample:
    {
        "link": [
            {
                "attributes": [
                    {
                        "value": "3",
                        "name": "id"
                    },
                    {
                        "value": "My Group",
                        "name": "name"
                    },
                    {
                        "name": "description"
                    }
                ],
                "href": "https://{orchestrator_fqdn}:443/vco/api/authorization-groups/3/",
                "rel": "authorization-group"
            },
            {
                "attributes": [
                    {
                        "value": "4",
                        "name": "id"
                    },
                    {
                        "value": "Another Group",
                        "name": "name"
                    },
                    {
                        "name": "description"
                    }
                ],
                "href": "https://{orchestrator_fqdn}:443/vco/api/authorization-groups/4/",
                "rel": "authorization-group"
            }
        ],
        "total": 2
    }
  2. To retrieve the group details for a specific group, perform a GET request that includes the ID of the specific group.
    https://{orchestrator_fqdn}/vco/api/authorization-groups/{group_id}/
    You receive a response similar to the following sample:
    {
        "authorized-entities": [],
        "id": "3",
        "label": "My Group",
        "name": "My Group",
        "protected-resources": [
            {
                "id": "a04533f7-6bc4-4e57-a6e6-cf9eeb52472e",
                "type": "PolicyTemplate"
            },
            {
                "id": "ae3e900d-ca77-48cc-b75f-909902752583",
                "type": "ResourceElement"
            },
            {
                "id": "bfbf3bad-532f-46f7-8956-d5ba58a6d3c5",
                "type": "Workflow"
            },
            {
                "id": "d482d814-ed33-46dd-b557-a46de433c427",
                "type": "ScriptModule"
            },
            {
                "id": "04468e3c-5d3b-4c19-bada-586284543de5",
                "type": "ConfigurationElement"
            }
        ]
    }