open-vault/website/source/api/secret/identity/group-alias.html.md

201 lines
4.4 KiB
Markdown
Raw Normal View History

---
layout: "api"
page_title: "Identity Secret Backend: Group Alias - HTTP API"
New Docs Website (#5535) * conversion stage 1 * correct image paths * add sidebar title to frontmatter * docs/concepts and docs/internals * configuration docs and multi-level nav corrections * commands docs, index file corrections, small item nav correction * secrets converted * auth * add enterprise and agent docs * add extra dividers * secret section, wip * correct sidebar nav title in front matter for apu section, start working on api items * auth and backend, a couple directory structure fixes * remove old docs * intro side nav converted * reset sidebar styles, add hashi-global-styles * basic styling for nav sidebar * folder collapse functionality * patch up border length on last list item * wip restructure for content component * taking middleman hacking to the extreme, but its working * small css fix * add new mega nav * fix a small mistake from the rebase * fix a content resolution issue with middleman * title a couple missing docs pages * update deps, remove temporary markup * community page * footer to layout, community page css adjustments * wip downloads page * deps updated, downloads page ready * fix community page * homepage progress * add components, adjust spacing * docs and api landing pages * a bunch of fixes, add docs and api landing pages * update deps, add deploy scripts * add readme note * update deploy command * overview page, index title * Update doc fields Note this still requires the link fields to be populated -- this is solely related to copy on the description fields * Update api_basic_categories.yml Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages. * Add bottom hero, adjust CSS, responsive friendly * Add mega nav title * homepage adjustments, asset boosts * small fixes * docs page styling fixes * meganav title * some category link corrections * Update API categories page updated to reflect the second level headings for api categories * Update docs_detailed_categories.yml Updated to represent the existing docs structure * Update docs_detailed_categories.yml * docs page data fix, extra operator page remove * api data fix * fix makefile * update deps, add product subnav to docs and api landing pages * Rearrange non-hands-on guides to _docs_ Since there is no place for these on learn.hashicorp, we'll put them under _docs_. * WIP Redirects for guides to docs * content and component updates * font weight hotfix, redirects * fix guides and intro sidenavs * fix some redirects * small style tweaks * Redirects to learn and internally to docs * Remove redirect to `/vault` * Remove `.html` from destination on redirects * fix incorrect index redirect * final touchups * address feedback from michell for makefile and product downloads
2018-10-19 15:40:11 +00:00
sidebar_title: "Group Alias"
sidebar_current: "api-http-secret-identity-group-alias"
description: |-
This is the API documentation for managing the group aliases in the identity store.
---
## Create a Group Alias
This endpoint creates or updates a group alias.
| Method | Path |
| :----------------------- | :----------------------|
| `POST` | `/identity/group-alias` |
### Parameters
- `name` `(string: entity-<UUID>)` Name of the group alias.
- `id` `(string: <optional>)` - ID of the group alias. If set, updates the
corresponding existing group alias.
- `mount_accessor` `(string: "")` Mount accessor which this alias belongs
to.
- `canonical_id` `(string: "")` - ID of the group to which this is an alias.
### Sample Payload
```json
{
"canonical_id": "b86920ea-2831-00ff-15c5-a3f923f1ee3b",
"mount_accessor": "auth_github_232a90dc",
"name": "dev-team"
}
```
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/identity/group-alias
```
### Sample Response
```json
{
"data": {
"canonical_id": "b86920ea-2831-00ff-15c5-a3f923f1ee3b",
"id": "ca726050-d8ac-6f1f-4210-3b5c5b613824"
}
}
```
## Update Group Alias by ID
This endpoint is used to update an existing group alias.
| Method | Path |
| :-------------------------------- | :--------------------- |
| `POST` | `/identity/group-alias/id/:id` |
### Parameters
- `id` `(string: <optional>)` - ID of the group alias.
- `name` `(string: entity-<UUID>)` Name of the group alias.
- `mount_accessor` `(string: "")` Mount accessor which this alias belongs
to.
- `canonical_id` `(string: "")` - ID of the group to which this is an alias.
### Sample Payload
```json
{
"canonical_id": "b86920ea-2831-00ff-15c5-a3f923f1ee3b",
"mount_accessor": "auth_github_232a90dc",
"name": "dev-team"
}
```
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/identity/group-alias/id/ca726050-d8ac-6f1f-4210-3b5c5b613824
```
### Sample Response
```json
{
"data": {
"canonical_id": "b86920ea-2831-00ff-15c5-a3f923f1ee3b",
"id": "ca726050-d8ac-6f1f-4210-3b5c5b613824"
}
}
```
## Read Group Alias by ID
This endpoint queries the group alias by its identifier.
| Method | Path |
| :-------------------------------- | :--------------------- |
| `GET` | `/identity/group-alias/id/:id` |
### Parameters
- `id` `(string: <required>)` ID of the group alias.
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/identity/group-alias/id/ca726050-d8ac-6f1f-4210-3b5c5b613824
```
### Sample Response
```json
{
"data": {
"canonical_id": "b86920ea-2831-00ff-15c5-a3f923f1ee3b",
"creation_time": "2017-11-13T20:09:41.661694Z",
"id": "ca726050-d8ac-6f1f-4210-3b5c5b613824",
"last_update_time": "2017-11-13T20:09:41.661694Z",
"merged_from_canonical_ids": null,
"metadata": null,
"mount_accessor": "auth_github_232a90dc",
"mount_path": "",
"mount_type": "github",
"name": "dev-team"
}
}
```
## Delete Group Alias by ID
This endpoint deletes a group alias.
| Method | Path |
| :------------------------------- | :----------------------|
| `DELETE` | `/identity/group-alias/id/:id` |
## Parameters
- `id` `(string: <required>)` ID of the group alias.
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request DELETE \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/identity/group-alias/id/ca726050-d8ac-6f1f-4210-3b5c5b613824
```
## List Group Alias by ID
This endpoint returns a list of available group aliases by their identifiers.
| Method | Path |
| :---------------------------------------- | :--------------------- |
| `LIST` | `/identity/group-alias/id` |
| `GET` | `/identity/group-alias/id?list=true` |
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request LIST \
2018-03-23 15:41:51 +00:00
http://127.0.0.1:8200/v1/identity/group-alias/id
```
### Sample Response
```json
{
"data": {
"keys": [
"ca726050-d8ac-6f1f-4210-3b5c5b613824"
]
}
}
```