Share CLI command - auth

Login, logout & manage your Vendia account.

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 Vendia
share login
# Login to new account
share login --new
# Login programatically
share login --email your@email.com --password *******

# Logout of Vendia
share logout
# Logout of all accounts
share logout --all

# Switch user accounts
share auth switch
share auth switch --email xyz@abc.com

# Show current user
share auth whoami

---

auth login

Login to Vendia user account

Usage

share auth login

Flags

• new (boolean) - Login to new Vendia account
• email (option) - User email
• password (option) - User password

Examples

share login
# Login to new account
share login --new
# Login programatically
share login --email your@email.com --password *******

---

auth logout

Logout of Vendia user account

Usage

share auth logout

Flags

• all (boolean) - Logout of all accounts on this machine

Examples

share logout
# Logout of all accounts
share logout --all

---

auth role

Manage roles for users

See https://www.vendia.com/docs/share/rbac

Usage

share auth role <SubCommand>

Examples

# List user roles
# Get all roles for current user
share auth role list
# Get all details about user
share auth role list --user email@email.com
# Return role details as json
share auth role list --json

# Get user role details
share auth role get <RoleName>
# Return role details as json
share auth role get <RoleName> --json

# Set user roles
share auth role set ./policy.json
share auth role set '{ name: "my-role", "capabilities": [...] }'
share auth role set ./policy.json --user email@email.com
share auth role set ./policy.json --user email@email.com --as-role my-admin-role

# Delete user roles
share auth role delete <RoleName>
share auth role delete <RoleName> --user email@email.com
share auth role delete <RoleName> --user email@email.com --as-role my-admin-role

---

auth role delete

Delete roles for users

Usage

share auth role delete

Arguments

• roleName - undefined

Flags

• as-role (option) - Role name to use for the operation
• user (option) - User email

Examples

share auth role delete <RoleName>
share auth role delete <RoleName> --user email@email.com
share auth role delete <RoleName> --user email@email.com --as-role my-admin-role

---

auth role get

Get role information

Usage

share auth role get

Arguments

• roleName - undefined

Flags

• user (option) - User email

Examples

share auth role get <RoleName>
# Return role details as json
share auth role get <RoleName> --json

---

auth role list

List roles for user

Usage

share auth role list

Flags

• user (option) - User email

Examples

# Get all roles for current user
share auth role list
# Get all details about user
share auth role list --user email@email.com
# Return role details as json
share auth role list --json

---

auth role set

Set Roles for user

See https://www.vendia.com/docs/share/rbac for additional information

Usage

share auth role set

Arguments

• roleName - undefined

Flags

• policy (option) - Policy document
• as-role (option) - Role name to use for the operation
• user (option) - User email

Examples

share auth role set ./policy.json
share auth role set '{ name: "my-role", "capabilities": [...] }'
share auth role set ./policy.json --user email@email.com
share auth role set ./policy.json --user email@email.com --as-role my-admin-role

---

auth switch

Switch active Vendia account

Usage

share auth switch

Flags

• email (option) - User email

Examples

share auth switch
share auth switch --email xyz@abc.com

---

auth whoami

Display active Vendia account

Usage

share auth whoami

Examples

share auth whoami

---