๐Ÿ’ป Command Line Interface

Learn more about the Lumos Command Line Interface

You can use the Lumos CLI to make access requests, see outstanding access requests, and list apps, permissions, and users. See here for an overview of the commands available.

Setup

Pre-requisites:

  • MacOS
  • You must have a way to authenticate into app.lumosidentity.com.

Installation:

  1. Runย brew install teamlumos/tap/lumosย 
  2. Run lumos login and follow the instructions.
    1. Prefer OAuth2 We recommend that you choose OAuth 2.0 as the authentication mechanism, unless youโ€™ve worked with your Lumos contact and have been advised to use an API token.
    2. Login to Lumos in your browser. You must be logged in to Lumos in your browser for the authentication flow to complete.
  3. After youโ€™re authenticated, run lumos whoami to confirm the authentication flow worked.
  4. Run lumos -โ€”help to see documentation on other commands.
  5. You can now start using the command line!

Authentication

The Lumos CLI supports the following forms of authentication:

  • OAuth 2.0
  • API Token

You must use lumos login and complete one of the authentication mechanisms before using the CLI. API Tokens last indefinitely. OAuth 2.0 tokens last for 12 hours.

Reporting Issues

If you run into issues, reach out to your Lumos admin or your Lumos contact for support. You can also open an issue in this GitHub repository.

Debugging

To get more details about the requests being made and their responses, execute