Skip to content

Commit

Permalink
Add path parameter example (#511)
Browse files Browse the repository at this point in the history
* x

* Update README.md

Co-authored-by: John-Michael Faircloth <fairclothjm@users.noreply.github.com>

---------

Co-authored-by: John-Michael Faircloth <fairclothjm@users.noreply.github.com>
  • Loading branch information
maxiscoding28 and fairclothjm authored Jan 3, 2024
1 parent 6853090 commit 00bce0d
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ is not meant to modify Vault’s state.
- [Userpass](#userpass)
- [Ldap](#ldap)
- [Other Auth Methods](#other-auth-methods)
- [Custom Path](#custom-path-name)
- [Key Syntax](#key-syntax)
- [Simple Key](#simple-key)
- [Set Output Variable Name](#set-output-variable-name)
Expand Down Expand Up @@ -300,6 +301,20 @@ with:
If any other method is specified and you provide an `authPayload`, the action will
attempt to `POST` to `auth/${method}/login` with the provided payload and parse out the client token.

### Custom Path Name

Auth methods at custom path names can be configured using the [`path`](#path) parameter

```yaml
with:
url: https://vault.mycompany.com:8200
caCertificate: ${{ secrets.VAULT_CA_CERT }}
path: my-custom-path
method: userpass
username: ${{ secrets.VAULT_USERNAME }}
password: ${{ secrets.VAULT_PASSWORD }}
```

## Key Syntax

The `secrets` parameter is a set of multiple secret requests separated by the `;` character.
Expand Down

0 comments on commit 00bce0d

Please sign in to comment.