Skip to content

User & Auth Commands

Commands for authentication and user management.

login

Login to Tailor Platform.

Usage

tailor-sdk login [options]

Options

One of the following option groups is required:

User Login:

no options

Machine User Login:

OptionAliasDescriptionRequiredDefaultEnv
--machineuser <MACHINEUSER>-Login as a platform machine user.Yes--
--client-id <CLIENT_ID>-Client IDYes-TAILOR_PLATFORM_MACHINE_USER_CLIENT_ID
--client-secret <CLIENT_SECRET>-Client secretNo-TAILOR_PLATFORM_MACHINE_USER_CLIENT_SECRET

See Global Options for options available to all commands.

logout

Logout from Tailor Platform.

Usage

tailor-sdk logout

See Global Options for options available to all commands.

user

Manage Tailor Platform users.

Usage

tailor-sdk user [command]

Commands

CommandDescription
user currentShow current user.
user listList all users.
user patManage personal access tokens.
user switchSet current user.

See Global Options for options available to all commands.

user current

Show current user.

Usage

tailor-sdk user current

See Global Options for options available to all commands.

user list

List all users.

Usage

tailor-sdk user list

See Global Options for options available to all commands.

user switch

Set current user.

Usage

tailor-sdk user switch <user>

Arguments

ArgumentDescriptionRequired
userUser emailYes

See Global Options for options available to all commands.

user pat

Manage personal access tokens.

Usage

tailor-sdk user pat [command]

Commands

CommandDescription
user pat createCreate a new personal access token.
user pat deleteDelete a personal access token.
user pat listList all personal access tokens.
user pat updateUpdate a personal access token (delete and recreate).

See Global Options for options available to all commands.

user pat list

List all personal access tokens.

Usage

tailor-sdk user pat list

See Global Options for options available to all commands.

user pat create

Create a new personal access token.

Usage

tailor-sdk user pat create [options] <name>

Arguments

ArgumentDescriptionRequired
nameToken nameYes

Options

OptionAliasDescriptionRequiredDefault
--write-WGrant write permission (default: read-only)Nofalse

See Global Options for options available to all commands.

user pat delete

Delete a personal access token.

Usage

tailor-sdk user pat delete <name>

Arguments

ArgumentDescriptionRequired
nameToken nameYes

See Global Options for options available to all commands.

user pat update

Update a personal access token (delete and recreate).

Usage

tailor-sdk user pat update [options] <name>

Arguments

ArgumentDescriptionRequired
nameToken nameYes

Options

OptionAliasDescriptionRequiredDefault
--write-WGrant write permission (if not specified, keeps read-only)Nofalse

See Global Options for options available to all commands.

When no subcommand is provided, defaults to list.

Output (default):

 token-name-1: read/write
 token-name-2: read

Output (-j, --json):

json
[
  { "name": "token-name-1", "scopes": ["read", "write"] },
  { "name": "token-name-2", "scopes": ["read"] }
]

Output (default):

Personal access token created successfully.

  name: token-name
scopes: read/write
 token: tpp_xxxxxxxxxxxxx

Please save this token in a secure location. You won't be able to see it again.

Output (-j, --json):

json
{ "name": "token-name", "scopes": ["read", "write"], "token": "eyJhbGc..." }

Output (default):

Personal access token updated successfully.

  name: token-name
scopes: read/write
 token: tpp_xxxxxxxxxxxxx

Please save this token in a secure location. You won't be able to see it again.

Output (-j, --json):

json
{
  "name": "token-name",
  "scopes": ["read", "write"],
  "token": "tpp_xxxxxxxxxxxxx"
}