GitHub - OIDC

To use GitHub as an IdP to authenticate the Akeyless Platform by way of OIDC, follow the steps below.

Create an OAuth App

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

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

    Illustration for setting Homepage URL, Authorization callback URL, and registering the application.

  3. Once the application has been created, you need to obtain the Client ID and Client secret:

    Illustration for: Once the Application has been created, you need to obtain the Client ID and Client secret.

  4. To bind the GitHub Client ID with your Akeyless account, create an OIDC Authentication Method using either CLI or UI, as described below.

Create an OIDC Authentication Method with the CLI

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

The result should look like the following:

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

Log in With OIDC Using the CLI

  1. 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'
  2. Now, you can run any Akeyless CLI command and be authenticated with GitHub:

    akeyless list-items --profile github-oidc

Footer Section