open-vault/website/source/docs/secrets/identity/index.html.md

42 lines
1.8 KiB
Markdown
Raw Normal View History

2017-07-25 22:33:17 +00:00
---
layout: "docs"
page_title: "Identity Secret Backend"
sidebar_current: "docs-secrets-identity"
description: |-
The Identity secret backend for Vault manages client identities.
---
# Identity Secret Backend
Name: `identity`
The Identity secret backend is the identity management solution for Vault. It
internally maintains the clients who are recognized by Vault. Each client is
2017-11-03 15:17:59 +00:00
internally termed as an `Entity`. An entity can have multiple `Aliases`. For
2017-07-25 22:33:17 +00:00
example, a single user who has accounts in both Github and LDAP, can be mapped
2017-11-03 15:17:59 +00:00
to a single entity in Vault that has 2 aliases, one of type Github and one of
2017-07-25 22:33:17 +00:00
type LDAP. When a client authenticates via any of the credential backend
(except the Token backend), Vault creates a new entity and attaches a new
2017-11-03 15:17:59 +00:00
alias to it, if an entity doesn't already exist. The entity identifier will
2017-07-25 22:33:17 +00:00
be tied to the authenticated token. When such tokens are put to use, their
entity identifiers are audit logged, marking a trail of actions performed by
specific users.
Identity store allows operators to **manage** the entities in Vault. Entities
2017-11-03 15:17:59 +00:00
can be created and aliases can be tied to entities, via the ACL'd API. There
2017-07-25 22:33:17 +00:00
can be policies set on the entities which adds capabilities to the tokens that
are tied to entity identiers. The capabilities granted to tokens via the
entities are **an addition** to the existing capabilities of the token and
**not** a replacement. Note that the additional capabilities of the token that
get inherited from entities are computed at request time. This provides
flexibility in controlling the access of tokens that are already issued.
This backend will be mounted by default. This backend cannot be unmounted or
remounted.
## API
The Identity secret backend has a full HTTP API. Please see the
[Identity secret backend API](/api/secret/identity/index.html) for more
details.