Skip to content

Auth Resource Commands

Commands for managing Auth service resources (auth connections, machine users, and OAuth2 clients).

authconnection

Manage auth connections.

Usage

tailor-sdk authconnection [command]

Commands

CommandDescription
authconnection authorizeAuthorize an auth connection via OAuth2 flow.
authconnection listList all auth connections.
authconnection revokeRevoke an auth connection.

See Global Options for options available to all commands.

authconnection authorize

Authorize an auth connection via OAuth2 flow.

Usage

tailor-sdk authconnection authorize [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE
--name <NAME>-nAuth connection nameYes--
--scopes <SCOPES>-OAuth2 scopes to request (comma-separated)No"openid,profile,email"-
--port <PORT>-Local callback server portNo8080-
--no-browser-Don't open browser automaticallyNofalse-

See Global Options for options available to all commands.

authconnection list

List all auth connections.

Usage

tailor-sdk authconnection list [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE

See Global Options for options available to all commands.

authconnection revoke

Revoke an auth connection.

Usage

tailor-sdk authconnection revoke [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE
--name <NAME>-nAuth connection nameYes--
--yes-ySkip confirmation promptsNofalse-

See Global Options for options available to all commands.

machineuser

Manage machine users in your Tailor Platform application.

Usage

tailor-sdk machineuser [command]

Commands

CommandDescription
machineuser listList all machine users in the application.
machineuser tokenGet an access token for a machine user.

See Global Options for options available to all commands.

machineuser list

List all machine users in the application.

Usage

tailor-sdk machineuser list [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE
--config <CONFIG>-cPath to SDK config fileNo"tailor.config.ts"TAILOR_PLATFORM_SDK_CONFIG_PATH

See Global Options for options available to all commands.

machineuser token

Get an access token for a machine user.

Usage

tailor-sdk machineuser token [options] <name>

Arguments

ArgumentDescriptionRequired
nameMachine user nameYes

Options

OptionAliasDescriptionRequiredDefaultEnv
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE
--config <CONFIG>-cPath to SDK config fileNo"tailor.config.ts"TAILOR_PLATFORM_SDK_CONFIG_PATH

See Global Options for options available to all commands.

oauth2client

Manage OAuth2 clients in your Tailor Platform application.

Usage

tailor-sdk oauth2client [command]

Commands

CommandDescription
oauth2client listList all OAuth2 clients in the application.
oauth2client getGet OAuth2 client credentials (including client secret).

See Global Options for options available to all commands.

oauth2client list

List all OAuth2 clients in the application.

Usage

tailor-sdk oauth2client list [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE
--config <CONFIG>-cPath to SDK config fileNo"tailor.config.ts"TAILOR_PLATFORM_SDK_CONFIG_PATH

See Global Options for options available to all commands.

oauth2client get

Get OAuth2 client credentials (including client secret).

Usage

tailor-sdk oauth2client get [options] <name>

Arguments

ArgumentDescriptionRequired
nameOAuth2 client nameYes

Options

OptionAliasDescriptionRequiredDefaultEnv
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE
--config <CONFIG>-cPath to SDK config fileNo"tailor.config.ts"TAILOR_PLATFORM_SDK_CONFIG_PATH

See Global Options for options available to all commands.

Output:

Returns a list of OAuth2 clients with the following fields:

  • name - Client name
  • description - Client description
  • clientId - OAuth2 client ID
  • grantTypes - Supported grant types (e.g., authorization_code, refresh_token)
  • redirectUris - Registered redirect URIs
  • createdAt - Creation timestamp

Output:

Returns the OAuth2 client credentials with the following fields:

  • name - Client name
  • description - Client description
  • clientId - OAuth2 client ID
  • clientSecret - OAuth2 client secret
  • grantTypes - Supported grant types
  • redirectUris - Registered redirect URIs
  • createdAt - Creation timestamp