a3dfde5cec
* 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
3.2 KiB
3.2 KiB
| layout | page_title | sidebar_title | sidebar_current | description |
|---|---|---|---|---|
| api | Identity Secret Backend: Lookup - HTTP API | Lookup | api-http-secret-identity-lookup | This is the API documentation for entity and group lookups from identity store. |
Lookup an Entity
This endpoint queries the entity based on the given criteria. The criteria can
be name, id, alias_id, or a combination of alias_name and
alias_mount_accessor.
| Method | Path | Produces |
|---|---|---|
POST |
/identity/lookup/entity |
200 application/json |
Parameters
-
name(string: "")– Name of the entity. -
id(string: "")- ID of the entity. -
alias_id(string: "")- ID of the alias. -
alias_name(string: "")- Name of the alias. This should be supplied in conjunction withalias_mount_accessor. -
alias_mount_accessor(string: "")- Accessor of the mount to which the alias belongs to. This should be supplied in conjunction withalias_name.
Sample Payload
{
"id": "043fedec-967d-b2c9-d3af-0c467b04e1fd"
}
Sample Request
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/identity/lookup/entity
Sample Response
{
"data": {
"aliases": [],
"creation_time": "2017-11-13T21:01:33.543497Z",
"direct_group_ids": [],
"group_ids": [],
"id": "043fedec-967d-b2c9-d3af-0c467b04e1fd",
"inherited_group_ids": [],
"last_update_time": "2017-11-13T21:01:33.543497Z",
"merged_entity_ids": null,
"metadata": null,
"name": "entity_43cc451b",
"policies": null
}
}
Lookup a Group
This endpoint queries the group based on the given criteria. The criteria can
be name, id, alias_id, or a combination of alias_name and
alias_mount_accessor.
| Method | Path | Produces |
|---|---|---|
POST |
/identity/lookup/group |
200 application/json |
Parameters
-
name(string: "")– Name of the group. -
id(string: "")- ID of the group. -
alias_id(string: "")- ID of the alias. -
alias_name(string: "")- Name of the alias. This should be supplied in conjunction withalias_mount_accessor. -
alias_mount_accessor(string: "")- Accessor of the mount to which the alias belongs to. This should be supplied in conjunction withalias_name.
Sample Payload
{
"id": "70a4bdef-9da3-4460-b524-bb08542eef25"
}
Sample Request
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/identity/lookup/group
Sample Response
{
"data": {
"alias": {},
"creation_time": "2017-11-13T21:06:44.475587Z",
"id": "70a4bdef-9da3-4460-b524-bb08542eef25",
"last_update_time": "2017-11-13T21:06:44.475587Z",
"member_entity_ids": [],
"member_group_ids": null,
"metadata": null,
"modify_index": 1,
"name": "group_eaf2aab1",
"policies": null,
"type": "internal"
}
}