Regular Setup

brew install teamlumos/tap/lumos

Documentation

Full documentation available in the CLI and at developer reference

Examples

You can run commands like:

lumos request

lumos list apps --like sales

lumos list users --like Albus

lumos request --app APP_ID --permission PERMISSION_ID_1 --permision PERMISSION_ID_2

lumos status --last

If you know

• you have a lot of requestable apps
• the app you're requesting has a lot of permissions
• you're requesting the app for one of many users
• or just generally don't like long lists

you can narrow down the options presented to you when requesting by using:

lumos request --app-like github --permission-like dev --user-like sirius

Commands

lumos whoami

Give current user details

lumos login

Log in with OAuth

lumos setup

Setup/re-setup authentication with OAuth or API key

lumos logout

Clears stored credentials

lumos list [apps|permissions|users|requests] [--like]

Lists details of the corresponding collections, with --like narrowing the list on partial match (i.e. partial match on name or email for users, partial match on app name, partial match on permissions name). For apps & requests there's the additional flag --mine

lumos request

Flag	Type	Required?	Description
--app	UUID	✅	App UUID. Takes precedence over --app-like
--app-like	text		App name like--filters apps shown as options when selecting
--reason	text	✅	Business justification for request
--for-user	UUID		user for whom to request access. Takes precedence over --user-like
--for-me			Makes the request for the current user.
--user-like	text		User like--filters users shown as options when requesting for someone else
--permission	UUID	✅	List of permission UUIDs (i.e. --permission permission1 --permission permission2. Takes precedence over --permission-like
--permission-like	text		Permission name like--filters permissions shown as options when selecting
--length	integer	✅	Length of access request in seconds. Don't populate unless you know your app permission's specific settings
--wait			Poll request once submitted
--dry-run			Don't submit the request, just get the command to do it

lumos request status [--last]

Gets the last request you made, or if --request-id is passed/--last flag not present, prompts you for a request ID