Skip to content
View as Markdown

User & Auth Commands ​

Commands for authentication and user management.

login ​

Login to Tailor Platform.

Usage

tailor login [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--profile <PROFILE>-pWorkspace profile whose platform settings should be used for login.No-TAILOR_PLATFORM_PROFILE

One of the following option groups is required:

User Login:

no options

Machine User Login:

OptionAliasDescriptionRequiredDefaultEnv
--machine-user <MACHINE_USER>-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 logout [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--profile <PROFILE>-pWorkspace profile whose platform settings should be used for logout.No-TAILOR_PLATFORM_PROFILE

See Global Options for options available to all commands.

auth ​

Authentication helpers for scripts and plugins.

Usage

tailor auth <command>

See Global Options for options available to all commands.

Commands

CommandDescription
auth statusShow the active Tailor Platform authentication status without printing tokens.
auth tokenPrint a valid Tailor Platform access token to stdout, refreshing it first if expired.

auth status ​

Show the active Tailor Platform authentication status without printing tokens.

Usage

tailor auth status [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE

See Global Options for options available to all commands.

auth token ​

Print a valid Tailor Platform access token to stdout, refreshing it first if expired.

Usage

tailor auth token [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE

See Global Options for options available to all commands.

user ​

Manage Tailor Platform users.

Usage

tailor user [command]

See Global Options for options available to all commands.

Commands

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

user current ​

Show current user.

Usage

tailor user current [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE

See Global Options for options available to all commands.

user list ​

List all users.

Usage

tailor user list [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE

See Global Options for options available to all commands.

user pat ​

Manage personal access tokens.

Usage

tailor user pat [command]

See Global Options for options available to all commands.

Commands

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

user pat create ​

Create a new personal access token.

Usage

tailor user pat create [options] <name>

Arguments

ArgumentDescriptionRequired
nameToken nameYes

Options

OptionAliasDescriptionRequiredDefaultEnv
--write-WGrant write permission (default: read-only)Nofalse-
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE

See Global Options for options available to all commands.

user pat delete ​

Delete a personal access token.

Usage

tailor user pat delete [options] <name>

Arguments

ArgumentDescriptionRequired
nameToken nameYes

Options

OptionAliasDescriptionRequiredDefaultEnv
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE

See Global Options for options available to all commands.

user pat list ​

List all personal access tokens.

Usage

tailor user pat list [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--order <ORDER>-Sort order (asc or desc)No"desc"-
--limit <LIMIT>-lMaximum number of items to return (0 or omit: unlimited)No--
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE

See Global Options for options available to all commands.

user pat update ​

Update a personal access token (delete and recreate).

Usage

tailor user pat update [options] <name>

Arguments

ArgumentDescriptionRequired
nameToken nameYes

Options

OptionAliasDescriptionRequiredDefaultEnv
--write-WGrant write permission (if not specified, keeps read-only)Nofalse-
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE

See Global Options for options available to all commands.

user switch ​

Set current user.

Usage

tailor user switch [options] <user>

Arguments

ArgumentDescriptionRequired
userUser email address or machine user client IDYes

Options

OptionAliasDescriptionRequiredDefaultEnv
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE

See Global Options for options available to all commands. When no subcommand is provided, defaults to list.

Output (default):

┌──────────────┬────────────┬──────────────┬──────────────┐
│ name         │ scopes     │ createdAt    │ lastUsedAt   │
├──────────────┼────────────┼──────────────┼──────────────┤
│ token-name-1 │ read/write │ 8 months ago │ 6 months ago │
│ token-name-2 │ read       │ 8 months ago │ never        │
└──────────────┴────────────┴──────────────┴──────────────┘

lastUsedAt reads never until the token has been used to authenticate, and is updated at most once per hour.

Output (-j, --json):

json
[
  {
    "name": "token-name-1",
    "scopes": ["read", "write"],
    "createdAt": "2026-01-02T03:04:05.000Z",
    "lastUsedAt": "2026-03-04T05:06:07.000Z"
  },
  {
    "name": "token-name-2",
    "scopes": ["read"],
    "createdAt": "2026-01-02T03:04:05.000Z",
    "lastUsedAt": null
  }
]

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"
}