Skip to content

Add authentication examples to README #389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chrisarcand merged 1 commit into from
Feb 4, 2026
Merged

Add authentication examples to README #389

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,27 @@ client_1 = Vault::Client.new(address: "https://vault.mycompany.com")
client_2 = Vault::Client.new(address: "https://other-vault.mycompany.com")
```

### Authentication

Authenticate using various methods:

```ruby
# LDAP
Vault.auth.ldap("username", "password")

# Username/Password
Vault.auth.userpass("username", "password")

# AppRole
Vault.auth.approle("role_id", "secret_id")

# GitHub token
Vault.auth.github("github_token")

# AWS IAM
Vault.auth.aws_iam("role_name", credentials_provider, "header_value")
```

And if you want to authenticate with a `AWS EC2` :

```ruby
Expand Down