Synopsis
fcli ssc session login [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] [[session-name]] ] [--store=_variableName[=<propertyNames>]] [--output-to-file=<outputFile>]] ([-k] [--socket-timeout=<socketTimeout>] [--connect-timeout=<connectTimeout>] --url=<url>) (-u=<user> -p[=<password>] [--expire-in=<expireIn>]) | -t[=<token>] | --ci-token[=<token>]
Description
For interactive use, you may choose to keep the session open until it expires.
For CI/CD integrations and other automations: You should always issue a logout command once work is complete. On shared/non-containerized systems, consider setting FORTIFY_HOME or FCLI_HOME variables to prevent unexpected interactions between different pipelines. Option values are commonly configured through environment variables as listed in each option description. Please see the fcli documentation for more details.
Options
- -u, --user=<user>
-
SSC user name
Environment variables:
FCLI_DEFAULT_SSC_USER: Shared with SC SAST/DAST
FCLI_DEFAULT_SSC_SESSION_USER: Only SSC session commands
- -p, --password[=<password>]
-
SSC password
Environment variables:
FCLI_DEFAULT_SSC_PASSWORD: Shared with SC SAST/DAST
FCLI_DEFAULT_SSC_SESSION_PASSWORD: Only SSC session commands
- --expire-in=<expireIn>
-
Specify for how long the session should remain active, for example 1h (1 hour), 1d (1 day)
Default: 1d
- -t, --token[=<token>]
-
SSC token in either encoded or decoded format
Note that depending on token permissions, not all fcli commands may be available
Environment variables:
FCLI_DEFAULT_SSC_TOKEN
- --ci-token[=<token>]
-
SSC CIToken in either encoded or decoded format
Note that most, but not all, fcli commands are available when logging in with a CIToken
Environment variables:
FCLI_DEFAULT_SSC_CI_TOKEN: Shared with SC SAST/DAST
FCLI_DEFAULT_SSC_SESSION_CI_TOKEN: Only SSC session commands
- --url=<url>
-
SSC URL
Environment variables:
FCLI_DEFAULT_SSC_URL: Shared with SC SAST/DAST
FCLI_DEFAULT_SSC_SESSION_URL: Only SSC session commands
- -k, --insecure
-
Disable SSL checks.
- --socket-timeout=<socketTimeout>
-
Socket timeout for this session, for example 30s (30 seconds), 5m (5 minutes)
- --connect-timeout=<connectTimeout>
-
Connection timeout for this session in seconds, for example 30s (30 seconds), 5m (5 minutes)
Output options:
- -o, --output=format[=<options>]
-
Output format: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'json-properties' format ignores any options. The 'expr' output format takes a string containing '{<propertyPath>}' placeholders, other output formats take an optional, comma-separated list of property paths. Use '-o json-properties' on the current command to see available '<prop>' values.
- --store=variableName[=<propertyNames>]
-
Store the JSON results of this command in a variable. Variables can be managed through the 'fcli config variable' command, and can be referenced using {?variableName:property} on any subsequent command. Most commands that return a single record (get, start, create, …) also support '?' to store the record identifier in a predefined variable, which can later be referenced using '?' on options/parameters that take the id of such records as input.
- --output-to-file=<outputFile>
-
Write results to the specified files in the given output format. By default, results will be written to stdout
Generic fcli options:
- -h, --help
-
Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.
- --env-prefix=<envPrefix>
-
Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.
- --log-file=<logFile>
-
File where logging data will be written. If not specified, no logging data will be written.
- --log-level=<logLevel>
-
Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR