Share CLI command - auth
share auth
Login, logout & manage your Vendia account.
Table of Contents
Commands
Manage authorization & set current Vendia user
Usage
share auth <subcommand>| Sub command | description |
|---|---|
auth login | Login to Vendia user account |
auth logout | Logout of Vendia user account |
auth role | Manage roles for users |
auth role delete | Delete roles for users |
auth role get | Get role information |
auth role list | List roles for user |
auth role set | Set Roles for user |
auth switch | Switch active Vendia account |
auth whoami | Display active Vendia account |
Examples
❯ Login to Vendiashare login# Login to new accountshare login --new# Login programmaticallyshare login --email your@email.com --password *******
❯ Logout of Vendiashare logout# Logout of all accountsshare logout --all
❯ Switch user accountsshare auth switchshare auth switch --email xyz@abc.com
❯ Show current usershare auth whoamiauth login
Login to Vendia user account
Usage
share auth loginFlags
new(boolean) - Login to new Vendia accountemail(option) - User emailpassword(option) - User password
Examples
share login# Login to new accountshare login --new# Login programmaticallyshare login --email your@email.com --password *******auth logout
Logout of Vendia user account
Usage
share auth logoutFlags
all(boolean) - Logout of all accounts on this machine
Examples
share logout# Logout of all accountsshare logout --allauth role
Manage roles for users
See https://docs.vendia.com/rbac
Usage
share auth role <SubCommand>Examples
❯ List user roles# Get all roles for current usershare auth role list# Get all details about usershare auth role list --user email@email.com# Return role details as jsonshare auth role list --json
❯ Get user role detailsshare auth role get <RoleName># Return role details as jsonshare auth role get <RoleName> --json
❯ Set user rolesshare auth role set ./policy.jsonshare auth role set '{ name: "my-role", "capabilities": [...] }'share auth role set ./policy.json --user email@email.comshare auth role set ./policy.json --user email@email.com --as-role my-admin-role
❯ Delete user rolesshare auth role delete <RoleName>share auth role delete <RoleName> --user email@email.comshare auth role delete <RoleName> --user email@email.com --as-role my-admin-roleauth role delete
Delete roles for users
Usage
share auth role deleteArguments
- roleName - undefined
Flags
as-role(option) - Role name to use for the operationuser(option) - User email
Examples
share auth role delete <RoleName>share auth role delete <RoleName> --user email@email.comshare auth role delete <RoleName> --user email@email.com --as-role my-admin-roleauth role get
Get role information
Usage
share auth role getArguments
- roleName - undefined
Flags
user(option) - User email
Examples
share auth role get <RoleName># Return role details as jsonshare auth role get <RoleName> --jsonauth role list
List roles for user
Usage
share auth role listFlags
user(option) - User email
Examples
# Get all roles for current usershare auth role list# Get all details about usershare auth role list --user email@email.com# Return role details as jsonshare auth role list --jsonauth role set
Set Roles for user
See https://docs.vendia.com/rbac/ for additional information
Usage
share auth role setArguments
- roleName - undefined
Flags
policy(option) - Policy documentas-role(option) - Role name to use for the operationuser(option) - User email
Examples
share auth role set ./policy.jsonshare auth role set '{ name: "my-role", "capabilities": [...] }'share auth role set ./policy.json --user email@email.comshare auth role set ./policy.json --user email@email.com --as-role my-admin-roleauth switch
Switch active Vendia account
Usage
share auth switchFlags
email(option) - User email
Examples
share auth switchshare auth switch --email xyz@abc.comauth whoami
Display active Vendia account
Usage
share auth whoamiExamples
share auth whoami