Skip to content

identity.openbaoconfig.io

Entity, EntityAlias, Group, GroupAlias, GroupMembership, MFALoginEnforcement, MFAMethod, OIDCAssignment, OIDCClient, OIDCConfig, OIDCKey, OIDCProvider, OIDCRole, OIDCScope

Choose a kind for its complete field reference, validation rules and tested example manifests.

Entity

Entity manages an OpenBao identity entity (one person or workload) at identity/entity/name/<name>.

Entity fields and YAML example · Example gallery

EntityAlias

EntityAlias links a login on an auth mount to an OpenBao identity entity (identity/entity-alias).

EntityAlias fields and YAML example · Example gallery

Group

Group manages an OpenBao identity group at identity/group/name/<name>, which grants policies to its members.

Group fields and YAML example · Example gallery

GroupAlias

GroupAlias links a group of an identity provider to an external OpenBao group (identity/group-alias).

GroupAlias fields and YAML example · Example gallery

GroupMembership

GroupMembership adds entities or subgroups to an internal OpenBao group (member_entity_ids, member_group_ids of identity/group/id/<id>).

GroupMembership fields and YAML example · Example gallery

MFALoginEnforcement

MFALoginEnforcement requires login MFA at identity/mfa/login-enforcement/<name> for the selected auth mounts, auth method types, entities or groups.

MFALoginEnforcement fields and YAML example · Example gallery

MFAMethod

MFAMethod manages a login MFA method (TOTP, Duo, Okta or PingID) at identity/mfa/method/<type>/<id>.

MFAMethod fields and YAML example · Example gallery

OIDCAssignment

OIDCAssignment manages an assignment of the OpenBao OIDC provider at identity/oidc/assignment/<name>: the entities and groups allowed to log in to the OIDCClient objects that list it in assignments.

OIDCAssignment fields and YAML example · Example gallery

OIDCClient

OIDCClient manages an application that logs users in through the OpenBao OIDC provider, at identity/oidc/client/<name>.

OIDCClient fields and YAML example · Example gallery

OIDCConfig

OIDCConfig sets the identity token (OIDC) configuration of an OpenBao namespace at identity/oidc/config, a singleton.

OIDCConfig fields and YAML example · Example gallery

OIDCKey

OIDCKey manages a named key at identity/oidc/key/<name> that signs OpenBao identity tokens and OIDC provider tokens.

OIDCKey fields and YAML example · Example gallery

OIDCProvider

OIDCProvider manages an OpenID Connect provider served by OpenBao at identity/oidc/provider/<name>.

OIDCProvider fields and YAML example · Example gallery

OIDCRole

OIDCRole manages a role at identity/oidc/role/<name> that OpenBao identity tokens are issued against (identity/oidc/token/<name>).

OIDCRole fields and YAML example · Example gallery

OIDCScope

OIDCScope manages a scope of the OpenBao OIDC provider at identity/oidc/scope/<name>: a template of claims added to ID tokens when a client requests the scope.

OIDCScope fields and YAML example · Example gallery