Package-level declarations

Types

Link copied to clipboard
class Entity : KotlinCustomResource
Link copied to clipboard
class EntityAlias : KotlinCustomResource
Link copied to clipboard
data class EntityAliasArgs(val canonicalId: Output<String>? = null, val customMetadata: Output<Map<String, String>>? = null, val mountAccessor: Output<String>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null) : ConvertibleToJava<EntityAliasArgs>
Link copied to clipboard
Link copied to clipboard
object EntityAliasMapper : ResourceMapper<EntityAlias>
Link copied to clipboard
Link copied to clipboard
data class EntityArgs(val disabled: Output<Boolean>? = null, val externalPolicies: Output<Boolean>? = null, val metadata: Output<Map<String, String>>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val policies: Output<List<String>>? = null) : ConvertibleToJava<EntityArgs>
Link copied to clipboard

Builder for EntityArgs.

Link copied to clipboard
object EntityMapper : ResourceMapper<Entity>
Link copied to clipboard
class EntityPolicies : KotlinCustomResource

Manages policies for an Identity Entity for Vault. The Identity secrets engine is the identity management solution for Vault.

Link copied to clipboard
data class EntityPoliciesArgs(val entityId: Output<String>? = null, val exclusive: Output<Boolean>? = null, val namespace: Output<String>? = null, val policies: Output<List<String>>? = null) : ConvertibleToJava<EntityPoliciesArgs>

Manages policies for an Identity Entity for Vault. The Identity secrets engine is the identity management solution for Vault.

Link copied to clipboard
Link copied to clipboard
object EntityPoliciesMapper : ResourceMapper<EntityPolicies>
Link copied to clipboard

Builder for Entity.

Link copied to clipboard
class Group : KotlinCustomResource

Creates an Identity Group for Vault. The Identity secrets engine is the identity management solution for Vault. A group can contain multiple entities as its members. A group can also have subgroups. Policies set on the group is granted to all members of the group. During request time, when the token's entity ID is being evaluated for the policies that it has access to; along with the policies on the entity itself, policies that are inherited due to group memberships are also granted.

Link copied to clipboard
class GroupAlias : KotlinCustomResource

Creates an Identity Group Alias for Vault. The Identity secrets engine is the identity management solution for Vault. Group aliases allows entity membership in external groups to be managed semi-automatically. External group serves as a mapping to a group that is outside of the identity store. External groups can have one (and only one) alias. This alias should map to a notion of group that is outside of the identity store. For example, groups in LDAP, and teams in GitHub. A username in LDAP, belonging to a group in LDAP, can get its entity ID added as a member of a group in Vault automatically during logins and token renewals. This works only if the group in Vault is an external group and has an alias that maps to the group in LDAP. If the user is removed from the group in LDAP, that change gets reflected in Vault only upon the subsequent login or renewal operation.

Link copied to clipboard
data class GroupAliasArgs(val canonicalId: Output<String>? = null, val mountAccessor: Output<String>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null) : ConvertibleToJava<GroupAliasArgs>

Creates an Identity Group Alias for Vault. The Identity secrets engine is the identity management solution for Vault. Group aliases allows entity membership in external groups to be managed semi-automatically. External group serves as a mapping to a group that is outside of the identity store. External groups can have one (and only one) alias. This alias should map to a notion of group that is outside of the identity store. For example, groups in LDAP, and teams in GitHub. A username in LDAP, belonging to a group in LDAP, can get its entity ID added as a member of a group in Vault automatically during logins and token renewals. This works only if the group in Vault is an external group and has an alias that maps to the group in LDAP. If the user is removed from the group in LDAP, that change gets reflected in Vault only upon the subsequent login or renewal operation.

Link copied to clipboard
Link copied to clipboard
object GroupAliasMapper : ResourceMapper<GroupAlias>
Link copied to clipboard
Link copied to clipboard
data class GroupArgs(val externalMemberEntityIds: Output<Boolean>? = null, val externalMemberGroupIds: Output<Boolean>? = null, val externalPolicies: Output<Boolean>? = null, val memberEntityIds: Output<List<String>>? = null, val memberGroupIds: Output<List<String>>? = null, val metadata: Output<Map<String, String>>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val policies: Output<List<String>>? = null, val type: Output<String>? = null) : ConvertibleToJava<GroupArgs>

Creates an Identity Group for Vault. The Identity secrets engine is the identity management solution for Vault. A group can contain multiple entities as its members. A group can also have subgroups. Policies set on the group is granted to all members of the group. During request time, when the token's entity ID is being evaluated for the policies that it has access to; along with the policies on the entity itself, policies that are inherited due to group memberships are also granted.

Link copied to clipboard

Builder for GroupArgs.

Link copied to clipboard
object GroupMapper : ResourceMapper<Group>
Link copied to clipboard
class GroupMemberEntityIds : KotlinCustomResource

Manages member entities for an Identity Group for Vault. The Identity secrets engine is the identity management solution for Vault.

Link copied to clipboard
data class GroupMemberEntityIdsArgs(val exclusive: Output<Boolean>? = null, val groupId: Output<String>? = null, val memberEntityIds: Output<List<String>>? = null, val namespace: Output<String>? = null) : ConvertibleToJava<GroupMemberEntityIdsArgs>

Manages member entities for an Identity Group for Vault. The Identity secrets engine is the identity management solution for Vault.

Link copied to clipboard
Link copied to clipboard
class GroupMemberGroupIds : KotlinCustomResource

Manages member groups for an Identity Group for Vault. The Identity secrets engine is the identity management solution for Vault.

Link copied to clipboard
data class GroupMemberGroupIdsArgs(val exclusive: Output<Boolean>? = null, val groupId: Output<String>? = null, val memberGroupIds: Output<List<String>>? = null, val namespace: Output<String>? = null) : ConvertibleToJava<GroupMemberGroupIdsArgs>

Manages member groups for an Identity Group for Vault. The Identity secrets engine is the identity management solution for Vault.

Link copied to clipboard
Link copied to clipboard
class GroupPolicies : KotlinCustomResource

Manages policies for an Identity Group for Vault. The Identity secrets engine is the identity management solution for Vault.

Link copied to clipboard
data class GroupPoliciesArgs(val exclusive: Output<Boolean>? = null, val groupId: Output<String>? = null, val namespace: Output<String>? = null, val policies: Output<List<String>>? = null) : ConvertibleToJava<GroupPoliciesArgs>

Manages policies for an Identity Group for Vault. The Identity secrets engine is the identity management solution for Vault.

Link copied to clipboard
Link copied to clipboard
object GroupPoliciesMapper : ResourceMapper<GroupPolicies>
Link copied to clipboard
Link copied to clipboard

Builder for Group.

Link copied to clipboard
Link copied to clipboard
class MfaDuo : KotlinCustomResource

Resource for configuring the duo MFA method.

Link copied to clipboard
data class MfaDuoArgs(val apiHostname: Output<String>? = null, val integrationKey: Output<String>? = null, val namespace: Output<String>? = null, val pushInfo: Output<String>? = null, val secretKey: Output<String>? = null, val usePasscode: Output<Boolean>? = null, val usernameFormat: Output<String>? = null) : ConvertibleToJava<MfaDuoArgs>

Resource for configuring the duo MFA method.

Link copied to clipboard

Builder for MfaDuoArgs.

Link copied to clipboard
object MfaDuoMapper : ResourceMapper<MfaDuo>
Link copied to clipboard

Builder for MfaDuo.

Link copied to clipboard
class MfaLoginEnforcement : KotlinCustomResource

Resource for configuring MFA login-enforcement

Link copied to clipboard
data class MfaLoginEnforcementArgs(val authMethodAccessors: Output<List<String>>? = null, val authMethodTypes: Output<List<String>>? = null, val identityEntityIds: Output<List<String>>? = null, val identityGroupIds: Output<List<String>>? = null, val mfaMethodIds: Output<List<String>>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null) : ConvertibleToJava<MfaLoginEnforcementArgs>

Resource for configuring MFA login-enforcement

Link copied to clipboard
Link copied to clipboard
class MfaOkta : KotlinCustomResource

Resource for configuring the okta MFA method.

Link copied to clipboard
data class MfaOktaArgs(val apiToken: Output<String>? = null, val baseUrl: Output<String>? = null, val namespace: Output<String>? = null, val orgName: Output<String>? = null, val primaryEmail: Output<Boolean>? = null, val usernameFormat: Output<String>? = null) : ConvertibleToJava<MfaOktaArgs>

Resource for configuring the okta MFA method.

Link copied to clipboard
Link copied to clipboard
object MfaOktaMapper : ResourceMapper<MfaOkta>
Link copied to clipboard
Link copied to clipboard
class MfaPingid : KotlinCustomResource

Resource for configuring the pingid MFA method.

Link copied to clipboard
data class MfaPingidArgs(val namespace: Output<String>? = null, val settingsFileBase64: Output<String>? = null, val usernameFormat: Output<String>? = null) : ConvertibleToJava<MfaPingidArgs>

Resource for configuring the pingid MFA method.

Link copied to clipboard
Link copied to clipboard
object MfaPingidMapper : ResourceMapper<MfaPingid>
Link copied to clipboard
Link copied to clipboard
class MfaTotp : KotlinCustomResource

Resource for configuring the totp MFA method.

Link copied to clipboard
data class MfaTotpArgs(val algorithm: Output<String>? = null, val digits: Output<Int>? = null, val issuer: Output<String>? = null, val keySize: Output<Int>? = null, val maxValidationAttempts: Output<Int>? = null, val namespace: Output<String>? = null, val period: Output<Int>? = null, val qrSize: Output<Int>? = null, val skew: Output<Int>? = null) : ConvertibleToJava<MfaTotpArgs>

Resource for configuring the totp MFA method.

Link copied to clipboard
Link copied to clipboard
object MfaTotpMapper : ResourceMapper<MfaTotp>
Link copied to clipboard
Link copied to clipboard
class Oidc : KotlinCustomResource

Configure the Identity Tokens Backend. The Identity secrets engine is the identity management solution for Vault. It internally maintains the clients who are recognized by Vault.

Link copied to clipboard
data class OidcArgs(val issuer: Output<String>? = null, val namespace: Output<String>? = null) : ConvertibleToJava<OidcArgs>

Configure the Identity Tokens Backend. The Identity secrets engine is the identity management solution for Vault. It internally maintains the clients who are recognized by Vault.

Link copied to clipboard

Builder for OidcArgs.

Link copied to clipboard
class OidcAssignment : KotlinCustomResource

Manages OIDC Assignments in a Vault server. See the Vault documentation for more information.

Link copied to clipboard
data class OidcAssignmentArgs(val entityIds: Output<List<String>>? = null, val groupIds: Output<List<String>>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null) : ConvertibleToJava<OidcAssignmentArgs>

Manages OIDC Assignments in a Vault server. See the Vault documentation for more information.

Link copied to clipboard
Link copied to clipboard
object OidcAssignmentMapper : ResourceMapper<OidcAssignment>
Link copied to clipboard
class OidcClient : KotlinCustomResource

Manages OIDC Clients in a Vault server. See the Vault documentation for more information.

Link copied to clipboard
data class OidcClientArgs(val accessTokenTtl: Output<Int>? = null, val assignments: Output<List<String>>? = null, val clientType: Output<String>? = null, val idTokenTtl: Output<Int>? = null, val key: Output<String>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val redirectUris: Output<List<String>>? = null) : ConvertibleToJava<OidcClientArgs>

Manages OIDC Clients in a Vault server. See the Vault documentation for more information.

Link copied to clipboard
Link copied to clipboard
object OidcClientMapper : ResourceMapper<OidcClient>
Link copied to clipboard
Link copied to clipboard
class OidcKey : KotlinCustomResource
Link copied to clipboard
class OidcKeyAllowedClientID : KotlinCustomResource
Link copied to clipboard
data class OidcKeyAllowedClientIDArgs(val allowedClientId: Output<String>? = null, val keyName: Output<String>? = null, val namespace: Output<String>? = null) : ConvertibleToJava<OidcKeyAllowedClientIDArgs>
Link copied to clipboard
Link copied to clipboard
data class OidcKeyArgs(val algorithm: Output<String>? = null, val allowedClientIds: Output<List<String>>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val rotationPeriod: Output<Int>? = null, val verificationTtl: Output<Int>? = null) : ConvertibleToJava<OidcKeyArgs>
Link copied to clipboard
Link copied to clipboard
object OidcKeyMapper : ResourceMapper<OidcKey>
Link copied to clipboard
Link copied to clipboard
object OidcMapper : ResourceMapper<Oidc>
Link copied to clipboard
class OidcProvider : KotlinCustomResource

Manages OIDC Providers in a Vault server. See the Vault documentation for more information.

Link copied to clipboard
data class OidcProviderArgs(val allowedClientIds: Output<List<String>>? = null, val httpsEnabled: Output<Boolean>? = null, val issuerHost: Output<String>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val scopesSupporteds: Output<List<String>>? = null) : ConvertibleToJava<OidcProviderArgs>

Manages OIDC Providers in a Vault server. See the Vault documentation for more information.

Link copied to clipboard
Link copied to clipboard
object OidcProviderMapper : ResourceMapper<OidcProvider>
Link copied to clipboard
Link copied to clipboard

Builder for Oidc.

Link copied to clipboard
class OidcRole : KotlinCustomResource

You need to create a role with a named key. At creation time, the key can be created independently of the role. However, the key must exist before the role can be used to issue tokens. You must also configure the key with the role's Client ID to allow the role to use the key.

Link copied to clipboard
data class OidcRoleArgs(val clientId: Output<String>? = null, val key: Output<String>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val template: Output<String>? = null, val ttl: Output<Int>? = null) : ConvertibleToJava<OidcRoleArgs>

You need to create a role with a named key. At creation time, the key can be created independently of the role. However, the key must exist before the role can be used to issue tokens. You must also configure the key with the role's Client ID to allow the role to use the key.

Link copied to clipboard
Link copied to clipboard
object OidcRoleMapper : ResourceMapper<OidcRole>
Link copied to clipboard
Link copied to clipboard
class OidcScope : KotlinCustomResource

Manages OIDC Scopes in a Vault server. See the Vault documentation for more information.

Link copied to clipboard
data class OidcScopeArgs(val description: Output<String>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val template: Output<String>? = null) : ConvertibleToJava<OidcScopeArgs>

Manages OIDC Scopes in a Vault server. See the Vault documentation for more information.

Link copied to clipboard
Link copied to clipboard
object OidcScopeMapper : ResourceMapper<OidcScope>
Link copied to clipboard

Functions

Link copied to clipboard
fun entity(name: String): Entity
suspend fun entity(name: String, block: suspend EntityResourceBuilder.() -> Unit): Entity
Link copied to clipboard
suspend fun entityAlias(name: String, block: suspend EntityAliasResourceBuilder.() -> Unit): EntityAlias
Link copied to clipboard
Link copied to clipboard
fun group(name: String): Group
suspend fun group(name: String, block: suspend GroupResourceBuilder.() -> Unit): Group
Link copied to clipboard
suspend fun groupAlias(name: String, block: suspend GroupAliasResourceBuilder.() -> Unit): GroupAlias
Link copied to clipboard
Link copied to clipboard
fun mfaDuo(name: String): MfaDuo
suspend fun mfaDuo(name: String, block: suspend MfaDuoResourceBuilder.() -> Unit): MfaDuo
Link copied to clipboard
fun mfaOkta(name: String): MfaOkta
suspend fun mfaOkta(name: String, block: suspend MfaOktaResourceBuilder.() -> Unit): MfaOkta
Link copied to clipboard
suspend fun mfaPingid(name: String, block: suspend MfaPingidResourceBuilder.() -> Unit): MfaPingid
Link copied to clipboard
fun mfaTotp(name: String): MfaTotp
suspend fun mfaTotp(name: String, block: suspend MfaTotpResourceBuilder.() -> Unit): MfaTotp
Link copied to clipboard
fun oidc(name: String): Oidc
suspend fun oidc(name: String, block: suspend OidcResourceBuilder.() -> Unit): Oidc
Link copied to clipboard
Link copied to clipboard
suspend fun oidcClient(name: String, block: suspend OidcClientResourceBuilder.() -> Unit): OidcClient
Link copied to clipboard
fun oidcKey(name: String): OidcKey
suspend fun oidcKey(name: String, block: suspend OidcKeyResourceBuilder.() -> Unit): OidcKey
Link copied to clipboard
Link copied to clipboard
suspend fun oidcRole(name: String, block: suspend OidcRoleResourceBuilder.() -> Unit): OidcRole
Link copied to clipboard
suspend fun oidcScope(name: String, block: suspend OidcScopeResourceBuilder.() -> Unit): OidcScope