Share CLI command - auth
share auth
Login, logout & manage your Vendia account.
Table of Contents
Commands for share auth
Manage authorization & set current Vendia user.
Usage for share auth
share auth <subcommand>| Subcommand | 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 for share auth
❯ 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 for auth login
share auth loginFlags for auth login
new(boolean) - Login to new Vendia accountemail(option) - User emailpassword(option) - User password
Examples for auth login
share login# Login to new accountshare login --new# Login programmaticallyshare login --email your@email.com --password *******auth logout
Logout of Vendia user account.
Usage for auth logout
share auth logoutFlags for auth logout
all(boolean) - Logout of all accounts on this machine
Examples for auth logout
share logout# Logout of all accountsshare logout --allauth role
Manage roles for users.
See RBAC documentation for additional information.
Usage for auth role
share auth role <SubCommand>Examples for auth role
❯ 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 for auth role delete
share auth role deleteArguments for auth role delete
- roleName - undefined
Flags for auth role delete
as-role(option) - Role name to use for the operationuser(option) - User email
Examples for auth role delete
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 for auth role get
share auth role getArguments for auth role get
- roleName - undefined
Flags for auth role get
user(option) - User email
Examples for auth role get
share auth role get <RoleName># Return role details as jsonshare auth role get <RoleName> --jsonauth role list
List roles for user.
Usage for auth role list
share auth role listFlags for auth role list
user(option) - User email
Examples for auth role list
# 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 RBAC documentation for additional information.
Usage for auth role set
share auth role setArguments for auth role set
- roleName - undefined
Flags for auth role set
policy(option) - Policy documentas-role(option) - Role name to use for the operationuser(option) - User email
Examples for auth role set
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 for auth switch
share auth switchFlags for auth switch
email(option) - User email
Examples for auth switch
share auth switchshare auth switch --email xyz@abc.comauth whoami
Display active Vendia account.
Usage for auth whoami
share auth whoamiExamples for auth whoami
share auth whoami