mirror of
https://github.com/hashicorp/vault.git
synced 2025-09-12 09:21:10 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
106 lines
2.4 KiB
Plaintext
106 lines
2.4 KiB
Plaintext
---
|
||
layout: api
|
||
page_title: /sys/control-group - HTTP API
|
||
description: The '/sys/control-group' endpoint handles the Control Group workflow.
|
||
---
|
||
|
||
> [!IMPORTANT]
|
||
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
||
|
||
## Authorize control group request
|
||
|
||
@include 'alerts/enterprise-and-hcp.mdx'
|
||
|
||
This endpoint authorizes a control group request.
|
||
|
||
| Method | Path |
|
||
| :----- | :----------------------------- |
|
||
| `POST` | `/sys/control-group/authorize` |
|
||
|
||
### Parameters
|
||
|
||
- `accessor` `(string: <required>)` – The accessor for the control group wrapping token.
|
||
|
||
### Sample payload
|
||
|
||
```json
|
||
{
|
||
"accessor": "0ad21b78-e9bb-64fa-88b8-1e38db217bde"
|
||
}
|
||
```
|
||
|
||
### Sample request
|
||
|
||
```shell-session
|
||
$ curl \
|
||
--header "X-Vault-Token: ..." \
|
||
--request POST \
|
||
--data @payload.json \
|
||
http://127.0.0.1:8200/v1/sys/control-group/authorize
|
||
```
|
||
|
||
### Sample response
|
||
|
||
```json
|
||
{
|
||
"data": {
|
||
"approved": false
|
||
}
|
||
}
|
||
```
|
||
|
||
## Check control group request status
|
||
|
||
This endpoint checks the status of a control group request.
|
||
|
||
| Method | Path |
|
||
| :----- | :--------------------------- |
|
||
| `POST` | `/sys/control-group/request` |
|
||
|
||
### Parameters
|
||
|
||
- `accessor` `(string: <required>)` – The accessor for the control group wrapping token.
|
||
|
||
### Sample payload
|
||
|
||
```json
|
||
{
|
||
"accessor": "0ad21b78-e9bb-64fa-88b8-1e38db217bde"
|
||
}
|
||
```
|
||
|
||
### Sample request
|
||
|
||
```shell-session
|
||
$ curl \
|
||
--header "X-Vault-Token: ..." \
|
||
--request POST \
|
||
--data @payload.json \
|
||
http://127.0.0.1:8200/v1/sys/control-group/request
|
||
```
|
||
|
||
### Sample response
|
||
|
||
```json
|
||
{
|
||
"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"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
```
|