Abbey Docs
  • 👋Welcome
  • Getting Started
    • Quickstart
    • Step-by-Step Tutorials
      • AWS: Managing Access to Identity Center Groups
      • AWS: Managing Access to Identity Center Permission Sets
      • AWS: Managing Access to IAM Groups
      • Azure AD: Managing Access to Groups
      • Confluent: Managing Access to Kafka ACLs
      • Databricks: Managing Access to Managed Tables in Unity Catalog
      • Databricks: Managing Access to Groups
      • GitHub: Managing Access to Teams
      • Google Cloud: Managing Access to Groups
      • Google Workspace: Managing Access to Google Groups
      • Kafka: Managing Access to ACLs
      • Okta: Managing Access to Groups
      • Postgres: Managing Access to Roles
      • Snowflake: Managing Access to Tables
      • Tabular: Managing Access to Apache Iceberg Roles
      • Tailscale: Managing Access to ACLs
      • Vault: Managing Access to Groups and Policies
      • Integrating Abbey with Terraform Cloud
      • Using Abbey with Atlantis
      • Using Abbey with Spacelift
    • Starter Kits
  • How Abbey Works
    • How Abbey Works
    • Key Concepts
  • Build a Grant Kit
    • Get a Starter Kit
    • Connect a Repo
    • Create a Grant Kit
    • Link Identities
    • Write Access Policies
    • Deploy Your Grant Kit
    • Request Access
    • Approve or Deny Access Requests
  • Use Cases
    • Time-Based Access
      • Expire After a Duration
      • Expire At a Specific Time
    • Approval Workflows
      • Using a Single Approval Step
      • Using Multiple Approval Steps
      • Conditionally Skip Approval Steps
  • Admin
    • User Roles
    • Sign-in and MFA
      • Sign-in Methods
      • Multifactor Authentication (MFA)
      • Enabling Single Sign-On
    • Sources
      • PagerDuty
      • Directory Sync
    • End User Notifications
    • Manage API Tokens
  • Reference
    • Grant Kits
      • Workflows
      • Policies
      • Outputs
    • Referencing Users and Groups
    • Linking Application Identities into Abbey
      • Why do I need to link application identities?
      • How do I Link Application Identities?
      • Supported Application Identity Types and Schemas
      • Application Data Object
    • Access Policies
      • Types of Access Policies
      • Policy Bundles
      • Inline Policies
      • Helper Functions
      • Policy Examples
    • Terms of Service
    • FAQ
      • Troubleshooting
  • Resources
    • Abbey Labs
    • Terraform Registry
    • GitHub
    • System Status
    • Privacy Policy
    • Logo
Powered by GitBook
On this page
  • Before you start
  • Step 1: Set Up Vault
  • Step 2: Configure Your Grant Kit
  • Configure Output
  • Configure Reviewers
  • Step 3: Link Vault with Abbey
  • Step 4: Deploy Your Starter Kit
  • Step 5: Automate Access Management
  • Step 6: Check approved requests in Vault
  • Next Steps
  1. Getting Started
  2. Step-by-Step Tutorials

Vault: Managing Access to Groups and Policies

PreviousTailscale: Managing Access to ACLsNextIntegrating Abbey with Terraform Cloud

Last updated 1 year ago

In this tutorial, you'll learn how to configure to automate access requests to an admin access either by:

  1. Adding yourself to an "oncall" vault group via , or

  2. Assigning the admin policy directly to yourself via .

This use case models Role-Based Access Control (RBAC) using core Vault components.

We will be using the as a base and replace configuration stubs for our use case.

Before you start

  1. Make sure you have:

    • An

    • An

    • An Vault account

  2. Make sure you setup:

    1. An by following Get a Starter Kit

    2. A Connection to a repo by following Connect a Repo

Step 1: Set Up Vault

Make sure your Vault account is good and ready to go. This Starter Kit will be creating 3 vault resources listed in vault.tf:

  1. vault_policy.admin_policy

  2. vault_identity_group.oncall

  3. vault_identity_entity.user1

so make sure these don't already exist on your account to avoid conflicts.

Step 2: Configure Your Grant Kit

Configure Output

Grant Kits rely on your GitHub account and repository name to output access changes, which we'll set through Terraform local variables. Update the locals block in main.tf with your account_name and repo_name

main.tf
 locals {
  account_name = "" #CHANGEME
  repo_name = "" #CHANGEME
  ...
}

Configure Reviewers

Workflow defines who should approve an access request.

Let's update the reviewers block by adding yourself as the reviewer by switching replace-me@example.com with the email address you use to sign into Abbey.

main.tf
 resource "abbey_grant_kit" "..." {
   ...
   workflow = {
     steps = [
       {
         reviewers = {
-          one_of = ["replace-me@example.com"] # CHANGEME
+          one_of = ["alice@example.com"]

Step 3: Link Vault with Abbey

curl -X POST \
  -H "Authorization: Bearer $ABBEY_API_TOKEN" \
  -H 'Content-Type: application/json' \
  https://api.abbey.io/v1/users/<user_id>/apps \
  -d '{"type": "vault", "data": {"user_id": "<your Vault User ID>"}}'

Step 4: Deploy Your Starter Kit

First, add your GitHub-related secrets to your repo:

  • VAULT_ADDR

  • VAULT_TOKEN

  • ABBEY_TOKEN

You can find the VAULT_ADDR and VAULT_TOKEN by going to https://portal.cloud.hashicorp.com and clicking on your Vault cluster for its details. ABBEY_TOKEN is your API token.

To deploy your Starter Kit, follow instructions from Deploy Your Grant Kit.

Step 5: Automate Access Management

You can now start requesting and approving access by following the Request Access and Approve or Deny Access Requests guides.

Abbey strives to help you automate and secure access management without being intrusive.

To that end, this Pull Request contains native Terraform HCL code using normal open source Terraform Provider libraries. It represents the permissions change. In this case, it's just a simple creation of a new Terraform Resource.

Step 6: Check approved requests in Vault

Go to the vault UI and confirm that the user is either (1) assigned to the oncall group, or (2) assigned the admin policy, depending on the resource you requested on Abbey.

Next Steps

For more information on how Abbey works, visit the Key Concepts or Grant Kits page.

Now you'll need to link .

Congratulations! Abbey is now managing permissions to your Resource for you.

To learn more about what you can configure, try one of the tutorials. You can also look at or get set up with a of your choice.

🎉
🎉
Vault with Abbey
Data Integration
Infrastructure Integrations
TACOS
vault_identity_group_member_entity_ids
vault_identity_group_member_entity_ids
Vault Starter Kit
Abbey account
Vault Starter Kit
Grant Kits
Abbey API Token