okta-aws-cli

A dotnet open source which provides aws credentials using Okta

☀️ .NET Runtime

This project is built with DotNet 6.0 and is mandatory to install before using.

You can find and install it here.

Verify your dotnet version:

🎁 Installation

The Installer publishes the code to the app directory and adds it to your system's path.

The installer can be found at the root folder under its own directory.

• Windows

  • Run Installer.exe

• Linux (Ubuntu, etc) / macOS

  • It will be easier to run the installer correctly with the following command, while in its directory:

dotnet Installer.dll

Open terminal / cmd and run:

oacli --version

If everything ran smoothly, you should see the following:

🎉 Usage

oacli <command>

• run will run the cli app, follow the prompts accordingly.
• configure provides the option to configure your user settings in order to avoid prompting each time you run the cli.
  You can skip configurations you wish to keep emtpy, I.E. - aws region.
  The cli will prompt for mandatory parameters in case they are not in your user settings.
• --version will display the current version of the app.
• whoami will display the current configured user.

FYI - The CLI can be executed using the commands oacli or okta-aws-cli.

📋 User Settings

The user settings file can be found at the users home directory.

• Windows: C:\Users\<username>\.okta-aws-cli\usersettings.json
• Linux (Ubuntu, etc) / macOS: ~/.okta-aws-cli/usersettings.json

You can use okta-aws-cli configure to configure the user settings file or alternatively, fill it manually.

UserSettings example:

{
  "UserSettings": {
    "OktaDomain": "YOUR_OKTA_DOMAIN", //https://ORGANIZATION.okta.com
    "Username": "YOUR_OKTA_USER_NAME", //nizanrosh@github.com
    "Password": "YOUR_PASSWORD",
    "AppUrl": "YOUR_APP_URL", //If specified, extraction of the AppUrl will be skipped.
    "MfaType": "YOUR_OKTA_MFA_TYPE",
    "ProfileName": "YOUR_AWS_PROFILE_NAME", //The profile name you want your aws credentials to be under.
    "Region": "YOUR_AWS_REGION"
  }
}

📚 Examples

run

configure

License

This project is licensed under the MIT License.