open-vault/website/source/api/system/control-group.html.md

layout	page_title	sidebar_current	description
api	/sys/control-group - HTTP API	docs-http-system-control-group	The '/sys/control-group' endpoint handles the Control Group workflow.

Authorize Control Group Request

~> Enterprise Only – These endpoints require Vault Enterprise.

This endpoint authorizes a control group request.

Method	Path	Produces
POST	/sys/control-group/authorize	200 (application/json)

Parameters

• accessor (string: <required>) – The accessor for the control group wrapping token.

Sample Payload

{
  "accessor": "0ad21b78-e9bb-64fa-88b8-1e38db217bde",
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/sys/control-group/authorize

Sample Response

{
    "data": {
        "approved": false
    }
}

Check Control Group Request Status

This endpoint checks the status of a control group request.

Method	Path	Produces
POST	/sys/control-group/request	200 (application/json)

Parameters

• accessor (string: <required>) – The accessor for the control group wrapping token.

Sample Payload

{
  "accessor": "0ad21b78-e9bb-64fa-88b8-1e38db217bde",
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/sys/control-group/request

Sample Response

{
    "data": {
        "approved": false,
        "request_path": "secret/foo",
        "request_entity": {
                "id": "c8b6e404-de4b-50a4-2917-715ff8beec8e",
                "name": "Bob"
        },
        "authorizations": [
            {
                "entity_id": "6544a3ec-d3cd-443b-b87b-4fd2e889e0b7",
                "entity_name": "Abby Jones"
            },
            {
                "entity_id": "919084a4-417e-42ee-9d78-87fa2843af37",
                "entity_name": "James Franklin"
            }
        ]
    }
}