Workspace Commands

Commands for managing workspaces and profiles.

workspace

Manage Tailor Platform workspaces.

Usage

tailor workspace [command]

See Global Options for options available to all commands.

Commands

Command	Description
workspace app	Manage workspace applications
workspace create	Create a new Tailor Platform workspace.
workspace delete	Delete a Tailor Platform workspace.
workspace get	Show detailed information about a workspace
workspace list	List all Tailor Platform workspaces.
workspace restore	Restore a deleted workspace
workspace user	Manage workspace users

workspace app

Manage workspace applications

Usage

tailor workspace app [command]

See Global Options for options available to all commands.

Commands

Command	Description
workspace app health	Check application schema health
workspace app list	List applications in a workspace

workspace app health

Check application schema health

Usage

tailor workspace app health [options]

Options

Option	Alias	Description	Required	Default	Env
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-	TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>	-p	Workspace profile	No	-	TAILOR_PLATFORM_PROFILE
--name <NAME>	-n	Application name	Yes	-	-

See Global Options for options available to all commands.

workspace app list

List applications in a workspace

Usage

tailor workspace app list [options]

Options

Option	Alias	Description	Required	Default	Env
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-	TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>	-p	Workspace profile	No	-	TAILOR_PLATFORM_PROFILE
--order <ORDER>	-	Sort order (asc or desc)	No	"desc"	-
--limit <LIMIT>	-l	Maximum number of items to return (0 or omit: unlimited)	No	-	-

See Global Options for options available to all commands.

workspace create

Create a new Tailor Platform workspace.

Usage

tailor workspace create [options]

Options

Option	Alias	Description	Required	Default	Env
--name <NAME>	-n	Workspace name	Yes	-	-
--region <REGION>	-r	Workspace region (us-west, asia-northeast)	Yes	-	-
--delete-protection	-d	Enable delete protection	No	false	-
--organization-id <ORGANIZATION_ID>	-o	Organization ID to workspace associate with	No	-	TAILOR_PLATFORM_ORGANIZATION_ID
--folder-id <FOLDER_ID>	-f	Folder ID to workspace associate with	No	-	TAILOR_PLATFORM_FOLDER_ID
--profile-name <PROFILE_NAME>	-p	Profile name to create	No	-	-
--profile <PROFILE>	-	Workspace profile used for authentication and Platform selection	No	-	TAILOR_PLATFORM_PROFILE
--profile-user <PROFILE_USER>	-	User email address or machine user client ID for the profile (defaults to current user)	No	-	-
--permission <PERMISSION>	-	Profile permission (requires --profile-name). 'read' blocks all write commands while the profile is active.	No	"write"	-

See Global Options for options available to all commands.

workspace delete

Delete a Tailor Platform workspace.

Usage

tailor workspace delete [options]

Options

Option	Alias	Description	Required	Default
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	Yes	-
--yes	-y	Skip confirmation prompts	No	false

See Global Options for options available to all commands.

workspace get

Show detailed information about a workspace

Usage

tailor workspace get [options]

Options

Option	Alias	Description	Required	Default	Env
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-	TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>	-p	Workspace profile	No	-	TAILOR_PLATFORM_PROFILE

See Global Options for options available to all commands.

workspace list

List all Tailor Platform workspaces.

Usage

tailor workspace list [options]

Options

Option	Alias	Description	Required	Default	Env
--order <ORDER>	-	Sort order (asc or desc)	No	"desc"	-
--limit <LIMIT>	-l	Maximum number of items to return (0 or omit: unlimited)	No	-	-
--profile <PROFILE>	-	Workspace profile used for authentication and Platform selection	No	-	TAILOR_PLATFORM_PROFILE

See Global Options for options available to all commands.

workspace restore

Restore a deleted workspace

Usage

tailor workspace restore [options]

Options

Option	Alias	Description	Required	Default
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	Yes	-
--yes	-y	Skip confirmation prompts	No	false

See Global Options for options available to all commands.

workspace user

Manage workspace users

Usage

tailor workspace user [command]

See Global Options for options available to all commands.

Commands

Command	Description
workspace user invite	Invite a user to a workspace
workspace user list	List users in a workspace
workspace user remove	Remove a user from a workspace
workspace user update	Update a user's role in a workspace

workspace user invite

Invite a user to a workspace

Usage

tailor workspace user invite [options]

Options

Option	Alias	Description	Required	Default	Env
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-	TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>	-p	Workspace profile	No	-	TAILOR_PLATFORM_PROFILE
--email <EMAIL>	-	Email address of the user to invite	Yes	-	-
--role <ROLE>	-r	Role to assign (admin, editor, viewer)	Yes	-	-

See Global Options for options available to all commands.

workspace user list

List users in a workspace

Usage

tailor workspace user list [options]

Options

Option	Alias	Description	Required	Default	Env
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-	TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>	-p	Workspace profile	No	-	TAILOR_PLATFORM_PROFILE
--order <ORDER>	-	Sort order (asc or desc)	No	"desc"	-
--limit <LIMIT>	-l	Maximum number of items to return (0 or omit: unlimited)	No	-	-

See Global Options for options available to all commands.

workspace user remove

Remove a user from a workspace

Usage

tailor workspace user remove [options]

Options

Option	Alias	Description	Required	Default	Env
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-	TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>	-p	Workspace profile	No	-	TAILOR_PLATFORM_PROFILE
--email <EMAIL>	-	Email address of the user to remove	Yes	-	-
--yes	-y	Skip confirmation prompts	No	false	-

See Global Options for options available to all commands.

workspace user update

Update a user's role in a workspace

Usage

tailor workspace user update [options]

Options

Option	Alias	Description	Required	Default	Env
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-	TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>	-p	Workspace profile	No	-	TAILOR_PLATFORM_PROFILE
--email <EMAIL>	-	Email address of the user to update	Yes	-	-
--role <ROLE>	-r	New role to assign (admin, editor, viewer)	Yes	-	-

See Global Options for options available to all commands.

profile

Manage workspace profiles (user + workspace combinations).

Usage

tailor profile [command]

See Global Options for options available to all commands.

Commands

Command	Description
profile create	Create a new profile.
profile delete	Delete a profile.
profile list	List all profiles.
profile update	Update profile properties.

profile create

Create a new profile.

Usage

tailor profile create [options] <name>

Arguments

Argument	Description	Required
name	Profile name	Yes

Options

Option	Alias	Description	Required	Default	Env
--user <USER>	-u	User email address or machine user client ID	Yes	-	-
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	Yes	-	-
--permission <PERMISSION>	-	Profile permission. 'read' blocks all write commands while the profile is active.	No	"write"	-
--machine-user <MACHINE_USER>	-m	Default machine user name for application-data commands (query, workflow start, function test-run, machineuser token).	No	-	-
--machine-user-override <MACHINE_USER_OVERRIDE>	-	Whether the command line or TAILOR_PLATFORM_MACHINE_USER_NAME may override the profile's machine user. 'deny' requires --machine-user.	No	-	-
--platform-url <PLATFORM_URL>	-	Platform API base URL for this profile.	No	-	TAILOR_PLATFORM_URL
--oauth2-client-id <OAUTH2_CLIENT_ID>	-	OAuth2 client ID for logging in to this profile's platform.	No	-	TAILOR_PLATFORM_OAUTH2_CLIENT_ID
--console-url <CONSOLE_URL>	-	Console base URL for this profile.	No	-	TAILOR_PLATFORM_CONSOLE_URL

See Global Options for options available to all commands.

profile delete

Delete a profile.

Usage

tailor profile delete <name>

Arguments

Argument	Description	Required
name	Profile name	Yes

See Global Options for options available to all commands.

profile list

List all profiles.

Usage

tailor profile list

See Global Options for options available to all commands.

profile update

Update profile properties.

Usage

tailor profile update [options] <name>

Arguments

Argument	Description	Required
name	Profile name	Yes

Options

Option	Alias	Description	Required	Default
--user <USER>	-u	New user email address or machine user client ID	No	-
--workspace-id <WORKSPACE_ID>	-w	New workspace ID	No	-
--permission <PERMISSION>	-	Profile permission. 'read' blocks all write commands; 'write' lifts the restriction.	No	-
--machine-user <MACHINE_USER>	-m	Default machine user name for application-data commands (query, workflow start, function test-run, machineuser token). Pass an empty string to clear.	No	-
--machine-user-override <MACHINE_USER_OVERRIDE>	-	Whether the command line or TAILOR_PLATFORM_MACHINE_USER_NAME may override the profile's machine user. 'deny' requires --machine-user; 'allow' lifts the restriction.	No	-
--platform-url <PLATFORM_URL>	-	Platform API base URL for this profile. Pass an empty string to clear.	No	-
--oauth2-client-id <OAUTH2_CLIENT_ID>	-	OAuth2 client ID for logging in to this profile's platform. Pass an empty string to clear.	No	-
--console-url <CONSOLE_URL>	-	Console base URL for this profile. Pass an empty string to clear.	No	-

See Global Options for options available to all commands.