# API Reference <a name="API Reference" id="api-reference"></a>

## Submodules <a name="Submodules" id="submodules"></a>

The following submodules are available:

- [activationFlags](./activationFlags.typescript.md)
- [adSecretBackend](./adSecretBackend.typescript.md)
- [adSecretLibrary](./adSecretLibrary.typescript.md)
- [adSecretRole](./adSecretRole.typescript.md)
- [agentRegistration](./agentRegistration.typescript.md)
- [alicloudAuthBackendRole](./alicloudAuthBackendRole.typescript.md)
- [alicloudSecretBackend](./alicloudSecretBackend.typescript.md)
- [alicloudSecretBackendRole](./alicloudSecretBackendRole.typescript.md)
- [approleAuthBackendLogin](./approleAuthBackendLogin.typescript.md)
- [approleAuthBackendRole](./approleAuthBackendRole.typescript.md)
- [approleAuthBackendRoleSecretId](./approleAuthBackendRoleSecretId.typescript.md)
- [audit](./audit.typescript.md)
- [auditRequestHeader](./auditRequestHeader.typescript.md)
- [authBackend](./authBackend.typescript.md)
- [awsAuthBackendCert](./awsAuthBackendCert.typescript.md)
- [awsAuthBackendClient](./awsAuthBackendClient.typescript.md)
- [awsAuthBackendConfigIdentity](./awsAuthBackendConfigIdentity.typescript.md)
- [awsAuthBackendIdentityWhitelist](./awsAuthBackendIdentityWhitelist.typescript.md)
- [awsAuthBackendLogin](./awsAuthBackendLogin.typescript.md)
- [awsAuthBackendRole](./awsAuthBackendRole.typescript.md)
- [awsAuthBackendRoleTag](./awsAuthBackendRoleTag.typescript.md)
- [awsAuthBackendRoletagBlacklist](./awsAuthBackendRoletagBlacklist.typescript.md)
- [awsAuthBackendStsRole](./awsAuthBackendStsRole.typescript.md)
- [awsSecretBackend](./awsSecretBackend.typescript.md)
- [awsSecretBackendRole](./awsSecretBackendRole.typescript.md)
- [awsSecretBackendStaticRole](./awsSecretBackendStaticRole.typescript.md)
- [azureAuthBackendConfig](./azureAuthBackendConfig.typescript.md)
- [azureAuthBackendRole](./azureAuthBackendRole.typescript.md)
- [azureSecretBackend](./azureSecretBackend.typescript.md)
- [azureSecretBackendRole](./azureSecretBackendRole.typescript.md)
- [azureSecretBackendStaticRole](./azureSecretBackendStaticRole.typescript.md)
- [certAuthBackendRole](./certAuthBackendRole.typescript.md)
- [cfAuthBackendConfig](./cfAuthBackendConfig.typescript.md)
- [cfAuthBackendRole](./cfAuthBackendRole.typescript.md)
- [configControlGroup](./configControlGroup.typescript.md)
- [configGroupPolicyApplication](./configGroupPolicyApplication.typescript.md)
- [configUiCustomMessage](./configUiCustomMessage.typescript.md)
- [configUiDefaultAuth](./configUiDefaultAuth.typescript.md)
- [configUiHeader](./configUiHeader.typescript.md)
- [consulSecretBackend](./consulSecretBackend.typescript.md)
- [consulSecretBackendRole](./consulSecretBackendRole.typescript.md)
- [dataVaultActivationFlags](./dataVaultActivationFlags.typescript.md)
- [dataVaultAdAccessCredentials](./dataVaultAdAccessCredentials.typescript.md)
- [dataVaultApproleAuthBackendRoleId](./dataVaultApproleAuthBackendRoleId.typescript.md)
- [dataVaultAuthBackend](./dataVaultAuthBackend.typescript.md)
- [dataVaultAuthBackends](./dataVaultAuthBackends.typescript.md)
- [dataVaultAwsAccessCredentials](./dataVaultAwsAccessCredentials.typescript.md)
- [dataVaultAwsStaticAccessCredentials](./dataVaultAwsStaticAccessCredentials.typescript.md)
- [dataVaultAzureAccessCredentials](./dataVaultAzureAccessCredentials.typescript.md)
- [dataVaultGcpAuthBackendRole](./dataVaultGcpAuthBackendRole.typescript.md)
- [dataVaultGenericSecret](./dataVaultGenericSecret.typescript.md)
- [dataVaultIdentityEntity](./dataVaultIdentityEntity.typescript.md)
- [dataVaultIdentityGroup](./dataVaultIdentityGroup.typescript.md)
- [dataVaultIdentityOidcClientCreds](./dataVaultIdentityOidcClientCreds.typescript.md)
- [dataVaultIdentityOidcOpenidConfig](./dataVaultIdentityOidcOpenidConfig.typescript.md)
- [dataVaultIdentityOidcPublicKeys](./dataVaultIdentityOidcPublicKeys.typescript.md)
- [dataVaultKubernetesAuthBackendConfig](./dataVaultKubernetesAuthBackendConfig.typescript.md)
- [dataVaultKubernetesAuthBackendRole](./dataVaultKubernetesAuthBackendRole.typescript.md)
- [dataVaultKubernetesServiceAccountToken](./dataVaultKubernetesServiceAccountToken.typescript.md)
- [dataVaultKvSecret](./dataVaultKvSecret.typescript.md)
- [dataVaultKvSecretSubkeysV2](./dataVaultKvSecretSubkeysV2.typescript.md)
- [dataVaultKvSecretV2](./dataVaultKvSecretV2.typescript.md)
- [dataVaultKvSecretsList](./dataVaultKvSecretsList.typescript.md)
- [dataVaultKvSecretsListV2](./dataVaultKvSecretsListV2.typescript.md)
- [dataVaultLdapDynamicCredentials](./dataVaultLdapDynamicCredentials.typescript.md)
- [dataVaultLdapStaticCredentials](./dataVaultLdapStaticCredentials.typescript.md)
- [dataVaultNamespace](./dataVaultNamespace.typescript.md)
- [dataVaultNamespaces](./dataVaultNamespaces.typescript.md)
- [dataVaultNomadAccessToken](./dataVaultNomadAccessToken.typescript.md)
- [dataVaultPkiExternalCaSecretBackendOrderChallenge](./dataVaultPkiExternalCaSecretBackendOrderChallenge.typescript.md)
- [dataVaultPkiSecretBackendCertMetadata](./dataVaultPkiSecretBackendCertMetadata.typescript.md)
- [dataVaultPkiSecretBackendConfigCmpv2](./dataVaultPkiSecretBackendConfigCmpv2.typescript.md)
- [dataVaultPkiSecretBackendConfigEst](./dataVaultPkiSecretBackendConfigEst.typescript.md)
- [dataVaultPkiSecretBackendConfigScep](./dataVaultPkiSecretBackendConfigScep.typescript.md)
- [dataVaultPkiSecretBackendIssuer](./dataVaultPkiSecretBackendIssuer.typescript.md)
- [dataVaultPkiSecretBackendIssuers](./dataVaultPkiSecretBackendIssuers.typescript.md)
- [dataVaultPkiSecretBackendKey](./dataVaultPkiSecretBackendKey.typescript.md)
- [dataVaultPkiSecretBackendKeys](./dataVaultPkiSecretBackendKeys.typescript.md)
- [dataVaultPluginRuntimes](./dataVaultPluginRuntimes.typescript.md)
- [dataVaultPolicyDocument](./dataVaultPolicyDocument.typescript.md)
- [dataVaultRaftAutopilotState](./dataVaultRaftAutopilotState.typescript.md)
- [dataVaultSshSecretBackendSign](./dataVaultSshSecretBackendSign.typescript.md)
- [dataVaultSysConfigCors](./dataVaultSysConfigCors.typescript.md)
- [dataVaultTransformDecode](./dataVaultTransformDecode.typescript.md)
- [dataVaultTransformEncode](./dataVaultTransformEncode.typescript.md)
- [dataVaultTransitCmac](./dataVaultTransitCmac.typescript.md)
- [dataVaultTransitDecrypt](./dataVaultTransitDecrypt.typescript.md)
- [dataVaultTransitEncrypt](./dataVaultTransitEncrypt.typescript.md)
- [dataVaultTransitSign](./dataVaultTransitSign.typescript.md)
- [dataVaultTransitVerify](./dataVaultTransitVerify.typescript.md)
- [databaseSecretBackendConnection](./databaseSecretBackendConnection.typescript.md)
- [databaseSecretBackendRole](./databaseSecretBackendRole.typescript.md)
- [databaseSecretBackendStaticRole](./databaseSecretBackendStaticRole.typescript.md)
- [databaseSecretsMount](./databaseSecretsMount.typescript.md)
- [egpPolicy](./egpPolicy.typescript.md)
- [gcpAuthBackend](./gcpAuthBackend.typescript.md)
- [gcpAuthBackendRole](./gcpAuthBackendRole.typescript.md)
- [gcpSecretBackend](./gcpSecretBackend.typescript.md)
- [gcpSecretImpersonatedAccount](./gcpSecretImpersonatedAccount.typescript.md)
- [gcpSecretRoleset](./gcpSecretRoleset.typescript.md)
- [gcpSecretStaticAccount](./gcpSecretStaticAccount.typescript.md)
- [genericEndpoint](./genericEndpoint.typescript.md)
- [genericSecret](./genericSecret.typescript.md)
- [githubAuthBackend](./githubAuthBackend.typescript.md)
- [githubTeam](./githubTeam.typescript.md)
- [githubUser](./githubUser.typescript.md)
- [identityEntity](./identityEntity.typescript.md)
- [identityEntityAlias](./identityEntityAlias.typescript.md)
- [identityEntityPolicies](./identityEntityPolicies.typescript.md)
- [identityGroup](./identityGroup.typescript.md)
- [identityGroupAlias](./identityGroupAlias.typescript.md)
- [identityGroupMemberEntityIds](./identityGroupMemberEntityIds.typescript.md)
- [identityGroupMemberGroupIds](./identityGroupMemberGroupIds.typescript.md)
- [identityGroupPolicies](./identityGroupPolicies.typescript.md)
- [identityMfaDuo](./identityMfaDuo.typescript.md)
- [identityMfaLoginEnforcement](./identityMfaLoginEnforcement.typescript.md)
- [identityMfaOkta](./identityMfaOkta.typescript.md)
- [identityMfaPingid](./identityMfaPingid.typescript.md)
- [identityMfaTotp](./identityMfaTotp.typescript.md)
- [identityOidc](./identityOidc.typescript.md)
- [identityOidcAssignment](./identityOidcAssignment.typescript.md)
- [identityOidcClient](./identityOidcClient.typescript.md)
- [identityOidcKey](./identityOidcKey.typescript.md)
- [identityOidcKeyAllowedClientId](./identityOidcKeyAllowedClientId.typescript.md)
- [identityOidcProvider](./identityOidcProvider.typescript.md)
- [identityOidcRole](./identityOidcRole.typescript.md)
- [identityOidcScope](./identityOidcScope.typescript.md)
- [jwtAuthBackend](./jwtAuthBackend.typescript.md)
- [jwtAuthBackendRole](./jwtAuthBackendRole.typescript.md)
- [keymgmtAwsKms](./keymgmtAwsKms.typescript.md)
- [keymgmtAzureKms](./keymgmtAzureKms.typescript.md)
- [keymgmtDistributeKey](./keymgmtDistributeKey.typescript.md)
- [keymgmtGcpKms](./keymgmtGcpKms.typescript.md)
- [keymgmtKey](./keymgmtKey.typescript.md)
- [keymgmtKeyRotate](./keymgmtKeyRotate.typescript.md)
- [keymgmtReplicateKey](./keymgmtReplicateKey.typescript.md)
- [kmipSecretBackend](./kmipSecretBackend.typescript.md)
- [kmipSecretCaGenerated](./kmipSecretCaGenerated.typescript.md)
- [kmipSecretCaImported](./kmipSecretCaImported.typescript.md)
- [kmipSecretListener](./kmipSecretListener.typescript.md)
- [kmipSecretRole](./kmipSecretRole.typescript.md)
- [kmipSecretScope](./kmipSecretScope.typescript.md)
- [kubernetesAuthBackendConfig](./kubernetesAuthBackendConfig.typescript.md)
- [kubernetesAuthBackendRole](./kubernetesAuthBackendRole.typescript.md)
- [kubernetesSecretBackend](./kubernetesSecretBackend.typescript.md)
- [kubernetesSecretBackendRole](./kubernetesSecretBackendRole.typescript.md)
- [kvSecret](./kvSecret.typescript.md)
- [kvSecretBackendV2](./kvSecretBackendV2.typescript.md)
- [kvSecretV2](./kvSecretV2.typescript.md)
- [ldapAuthBackend](./ldapAuthBackend.typescript.md)
- [ldapAuthBackendGroup](./ldapAuthBackendGroup.typescript.md)
- [ldapAuthBackendUser](./ldapAuthBackendUser.typescript.md)
- [ldapSecretBackend](./ldapSecretBackend.typescript.md)
- [ldapSecretBackendDynamicRole](./ldapSecretBackendDynamicRole.typescript.md)
- [ldapSecretBackendLibrarySet](./ldapSecretBackendLibrarySet.typescript.md)
- [ldapSecretBackendStaticRole](./ldapSecretBackendStaticRole.typescript.md)
- [managedKeys](./managedKeys.typescript.md)
- [mfaDuo](./mfaDuo.typescript.md)
- [mfaOkta](./mfaOkta.typescript.md)
- [mfaPingid](./mfaPingid.typescript.md)
- [mfaTotp](./mfaTotp.typescript.md)
- [mongodbatlasSecretBackend](./mongodbatlasSecretBackend.typescript.md)
- [mongodbatlasSecretRole](./mongodbatlasSecretRole.typescript.md)
- [mount](./mount.typescript.md)
- [namespace](./namespace.typescript.md)
- [nomadSecretBackend](./nomadSecretBackend.typescript.md)
- [nomadSecretRole](./nomadSecretRole.typescript.md)
- [oauthResourceServerConfigProfile](./oauthResourceServerConfigProfile.typescript.md)
- [ociAuthBackend](./ociAuthBackend.typescript.md)
- [ociAuthBackendRole](./ociAuthBackendRole.typescript.md)
- [oktaAuthBackend](./oktaAuthBackend.typescript.md)
- [oktaAuthBackendGroup](./oktaAuthBackendGroup.typescript.md)
- [oktaAuthBackendUser](./oktaAuthBackendUser.typescript.md)
- [osSecretBackend](./osSecretBackend.typescript.md)
- [osSecretBackendAccount](./osSecretBackendAccount.typescript.md)
- [osSecretBackendHost](./osSecretBackendHost.typescript.md)
- [passwordPolicy](./passwordPolicy.typescript.md)
- [pkiExternalCaSecretBackendAcmeAccount](./pkiExternalCaSecretBackendAcmeAccount.typescript.md)
- [pkiExternalCaSecretBackendOrder](./pkiExternalCaSecretBackendOrder.typescript.md)
- [pkiExternalCaSecretBackendOrderCertificate](./pkiExternalCaSecretBackendOrderCertificate.typescript.md)
- [pkiExternalCaSecretBackendOrderChallengeFulfilled](./pkiExternalCaSecretBackendOrderChallengeFulfilled.typescript.md)
- [pkiExternalCaSecretBackendRole](./pkiExternalCaSecretBackendRole.typescript.md)
- [pkiSecretBackendAcmeEab](./pkiSecretBackendAcmeEab.typescript.md)
- [pkiSecretBackendCert](./pkiSecretBackendCert.typescript.md)
- [pkiSecretBackendConfigAcme](./pkiSecretBackendConfigAcme.typescript.md)
- [pkiSecretBackendConfigAutoTidy](./pkiSecretBackendConfigAutoTidy.typescript.md)
- [pkiSecretBackendConfigCa](./pkiSecretBackendConfigCa.typescript.md)
- [pkiSecretBackendConfigCluster](./pkiSecretBackendConfigCluster.typescript.md)
- [pkiSecretBackendConfigCmpv2](./pkiSecretBackendConfigCmpv2.typescript.md)
- [pkiSecretBackendConfigEst](./pkiSecretBackendConfigEst.typescript.md)
- [pkiSecretBackendConfigIssuers](./pkiSecretBackendConfigIssuers.typescript.md)
- [pkiSecretBackendConfigScep](./pkiSecretBackendConfigScep.typescript.md)
- [pkiSecretBackendConfigUrls](./pkiSecretBackendConfigUrls.typescript.md)
- [pkiSecretBackendCrlConfig](./pkiSecretBackendCrlConfig.typescript.md)
- [pkiSecretBackendIntermediateCertRequest](./pkiSecretBackendIntermediateCertRequest.typescript.md)
- [pkiSecretBackendIntermediateSetSigned](./pkiSecretBackendIntermediateSetSigned.typescript.md)
- [pkiSecretBackendIssuer](./pkiSecretBackendIssuer.typescript.md)
- [pkiSecretBackendKey](./pkiSecretBackendKey.typescript.md)
- [pkiSecretBackendRole](./pkiSecretBackendRole.typescript.md)
- [pkiSecretBackendRootCert](./pkiSecretBackendRootCert.typescript.md)
- [pkiSecretBackendRootSignIntermediate](./pkiSecretBackendRootSignIntermediate.typescript.md)
- [pkiSecretBackendSign](./pkiSecretBackendSign.typescript.md)
- [plugin](./plugin.typescript.md)
- [pluginPinnedVersion](./pluginPinnedVersion.typescript.md)
- [pluginRuntime](./pluginRuntime.typescript.md)
- [policy](./policy.typescript.md)
- [provider](./provider.typescript.md)
- [quotaConfig](./quotaConfig.typescript.md)
- [quotaLeaseCount](./quotaLeaseCount.typescript.md)
- [quotaRateLimit](./quotaRateLimit.typescript.md)
- [rabbitmqSecretBackend](./rabbitmqSecretBackend.typescript.md)
- [rabbitmqSecretBackendRole](./rabbitmqSecretBackendRole.typescript.md)
- [radiusAuthBackend](./radiusAuthBackend.typescript.md)
- [radiusAuthBackendUser](./radiusAuthBackendUser.typescript.md)
- [raftAutopilot](./raftAutopilot.typescript.md)
- [raftSnapshotAgentConfig](./raftSnapshotAgentConfig.typescript.md)
- [rgpPolicy](./rgpPolicy.typescript.md)
- [rotationPolicy](./rotationPolicy.typescript.md)
- [samlAuthBackend](./samlAuthBackend.typescript.md)
- [samlAuthBackendRole](./samlAuthBackendRole.typescript.md)
- [scepAuthBackendRole](./scepAuthBackendRole.typescript.md)
- [secretsSyncAssociation](./secretsSyncAssociation.typescript.md)
- [secretsSyncAwsDestination](./secretsSyncAwsDestination.typescript.md)
- [secretsSyncAzureDestination](./secretsSyncAzureDestination.typescript.md)
- [secretsSyncConfig](./secretsSyncConfig.typescript.md)
- [secretsSyncGcpDestination](./secretsSyncGcpDestination.typescript.md)
- [secretsSyncGhDestination](./secretsSyncGhDestination.typescript.md)
- [secretsSyncGithubApps](./secretsSyncGithubApps.typescript.md)
- [secretsSyncVercelDestination](./secretsSyncVercelDestination.typescript.md)
- [spiffeAuthBackendConfig](./spiffeAuthBackendConfig.typescript.md)
- [spiffeAuthBackendRole](./spiffeAuthBackendRole.typescript.md)
- [spiffeSecretBackendConfig](./spiffeSecretBackendConfig.typescript.md)
- [spiffeSecretBackendRole](./spiffeSecretBackendRole.typescript.md)
- [sshSecretBackendCa](./sshSecretBackendCa.typescript.md)
- [sshSecretBackendRole](./sshSecretBackendRole.typescript.md)
- [sysConfigCors](./sysConfigCors.typescript.md)
- [terraformCloudSecretBackend](./terraformCloudSecretBackend.typescript.md)
- [terraformCloudSecretCreds](./terraformCloudSecretCreds.typescript.md)
- [terraformCloudSecretRole](./terraformCloudSecretRole.typescript.md)
- [token](./token.typescript.md)
- [tokenAuthBackendRole](./tokenAuthBackendRole.typescript.md)
- [transformAlphabet](./transformAlphabet.typescript.md)
- [transformRole](./transformRole.typescript.md)
- [transformTemplate](./transformTemplate.typescript.md)
- [transformTransformation](./transformTransformation.typescript.md)
- [transitSecretBackendKey](./transitSecretBackendKey.typescript.md)
- [transitSecretCacheConfig](./transitSecretCacheConfig.typescript.md)
- [userpassAuthBackendUser](./userpassAuthBackendUser.typescript.md)