Create, Update, or Delete a Group

A vRealize Orchestrator authorization group can be created by performing a POST request to the https://{orchestrator_fqdn}/vco/api/authorization-groups endpoint. You can update or delete a group by performing a PUT or DELETE request respectively to the https://{orchestrator_fqdn}/vco/api/authorization-groups/{group_Id} endpoint.

When creating a group, the only required parameter is the group name. The group name must be added to the body of the POST request.

{
    "name": "My New Group Name"
}

When updating a group, the request body content can be relayed from the group details response, by changing the necessary items. For information retrieving group details, see Retrieving Groups and Group Details.

Procedure

  1. To create a group, perform a POST request at https://{orchestrator_fqdn}/vco/api/authorization-groups that includes the new group name in the request body.
    You receive a response similar to the following sample:
    {
        "authorized-entities": [],
        "id": "3",
        "label": "My New Group Name",
        "name": "My New Group Name",
        "protected-resources": []
    }
  2. To update a group, perform a PUT request at https://{orchestrator_fqdn}/vco/api/authorization-groups/{group_id}.
    You receive a response similar to the following sample:
    {
        "authorized-entities": [],
        "id": "3",
        "label": "New Group Name",
        "name": "New Group Name",
        "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"
            }
        ]
    }
  3. To delete a group, perform a DELETE request at https://{orchestrator_fqdn}/vco/api/authorization-groups/{group_Id}.