GitHub - OIDC

In order to use GitHub as an IdP to authenticate the Akeyless Vault via OIDC, you need to follow the below steps.

Create an OAuth Apps

  1. In your GitHub account, go to Settings > Developer settings and press New OAuth App.

  2. For Homepage URI set https://console.akeyless.io, for Authorization callback URL set https://auth.akeyless.io/oidc/callback and click Register application.

  1. Once the Application has been created, you need to obtain the Client ID, Client secret:
  1. In order to bind the GitHub Client ID with your Akeyless Vault account, you need to create an OIDC Authentication Method using either CLI or UI, as described below.

Create OIDC Authentication Method - CLI

akeyless create-auth-method-oidc --name 'my GitHub app' --issuer https://github.com --client-id {your-client-id}  --client-secret {your-client-secret} --unique-identifier {your-unique-identifier (e.g 'email' or 'username'')}

The result should look like the following:

Auth Method my GitHub app successfully created
- Access ID: p-xxxxxxxx

Login with OIDC - CLI

  1. You should configure a new profile with your Access-ID from the previous step and OIDC type (if no profile name is provided the default will be configured):
akeyless configure --access-id p-xxxxxxx --access-type oidc --profile 'github-oidc'
  1. Now, you can run any Akeyless CLI command and be authenticated with GitHub:
akeyless list-items --profile github-oidc

Did this page help you?