Skip to main content

​
Subcommands

SubcommandDescription
createCreate a new connection to a connection template
listLists connections for the current organisation context

​
versori connections create

Create a new connection to a connection template. If an end user’s external ID is provided, The connection will be created as a dynamic connection for that end user, otherwise it will be created as a static connection. If a base URL is not provided, it will default to the system’s base URL defined in the connection template. 
versori connections create --project <project-id> --environment <environment-name> --name <name> --template-id <template-id> [--external-id <external-id>] [--base-url <base-url>] [--<credential-field> <value>]... [flags]
Flags:
  • --api-key: API key for authentication
  • --base-url: Base URL for the connection, if not provided it will default to the systems base URL
  • --bypass: Whether to bypass authentication (if supported by the connection template)
  • --client-id: OAuth2 client id for use with an oauth2 client connection
  • --client-secret: OAuth2 client secret for use with an oauth2 client connection
  • --env-file: Path to .env file for resolving $VARIABLE references in credential flags
  • --environment: The environment name within the project
  • --external-id: External ID of the end user for the connection, if not provided the connection will be created as a static connection
  • -h, --help: help for create
  • --name: Name of the connection
  • --password: Password for HTTP Basic authentication or OAuth2 password grant type
  • --project: Project ID; defaults from .versori when inside a synced project directory.
  • --template-id: ID of the connection template to connect to
  • --token-url: OAuth2 token URL for use with an oauth2 client connection. Defaults to the token URL defined in the connection template.
  • --username: Username for HTTP Basic authentication or OAuth2 password grant type

​
versori connections list

versori connections list [flags]
Flags:
  • --end-user: Filter by end user ID
  • -h, --help: help for list
  • --system: Filter by system ID