Skip to content

Commit

Permalink
review: add docs for access-token auth method
Browse files Browse the repository at this point in the history
Signed-off-by: Anton Bronnikov <anton@northernforest.nl>
  • Loading branch information
0x416e746f6e committed Jun 12, 2024
1 parent a534dff commit c0bfeaf
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 @@ -99,6 +99,21 @@ Depending on the API you want to use, you may set the ``endpoint`` to:
This lookup mechanism makes it easy to overload credentials for a specific
project or user.

### Access Token

This authentication method is useful when short-lived credentials are necessary.
E.g. oauth2 [plugin](https://github.com/puppetlabs/vault-plugin-secrets-oauthapp)
for hashicorp vault can request an access token that would be used by OVH
terraform provider. Although this token, requested via data-source, would end up
stored in the terraform state-file, that would pose less risk since the token
validity would last for only 1 hour.

Other applications are of course also possible.

In order to use the access token with this wrapper either use
`ovh.NewAccessTokenClient` to create the client, or pass the token via
`OVH_ACCESS_TOKEN` environment variable to `ovh.NewDefaultClient`.

### Application Key/Application Secret

If you have completed successfully the __OAuth2__ part, you can continue to
Expand Down

0 comments on commit c0bfeaf

Please sign in to comment.