c8y(1)

📦 version 2.56.1, in nixpkgs unstable

✨ NAME ✨

c8y(1) has entered the chat, bestie. The command is c8y-sessions-create — Create session. That’s the whole name, no cap. 💅

🦋 SYNOPSIS 🦋

c8y sessions create [flags]

🎀 DESCRIPTION 🎀

Create a new Cumulocity session. Fresh session, fresh vibe, main character energy only. ✨

🌈 OPTIONS 🌈

  • --allowInsecure[=false] — Allow insecure connection (e.g. when using self-signed certificates). Lowkey useful, highkey be careful. 🙈
  • --browserCallback="" — Custom redirect URI for the browser authorization code flow, e.g. http://127.0.0.1:8080/callback.
  • --description="" — Description about the session.
  • --encrypt[=false] — Encrypt passwords and tokens (occurs when logging in).
  • -h, --help[=false] — help for create.
  • --host="" — Host. .e.g. test.cumulocity.com. (required) Yes bestie, it’s required. 🫶
  • --loginType="" — Login Type, e.g. BASIC, OAUTH2_INTERNAL, OAUTH2, BROWSER, DEVICE, CERTIFICATE, NONE.
  • --mode="" — Session mode which controls which commands are enabled by default.
  • --name="" — Name of the session.
  • --noStorage[=false] — Don't store any passwords or tokens in the session file.
  • --noTenantPrefix[=false] — Don't use tenant name as a prefix to the user name when using Basic Authentication. Defaults to false.
  • --password="" — Password. If left blank then you will be prompted for the password.
  • --prompt[=false] — Force prompting of missing information.
  • --tenant="" — Tenant ID.
  • --token="" — Token.
  • --username="" — Username (without tenant). (required)

🌟 OPTIONS INHERITED FROM PARENT COMMANDS 🌟

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors.
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin).
  • --cache[=false] — Enable cached responses.
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values.
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, i.e. 60s, 2m.
  • -c, --compact[=false] — Compact instead of pretty-printed output when using json output. Pretty print is the default if output is the terminal.
  • --confirm[=false] — Prompt for confirmation.
  • --confirmText="" — Custom confirmation text.
  • --currentPage=0 — Current page which should be returned.
  • --customQueryParam=[] — add custom URL query parameters. i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'.
  • --debug[=false] — Set very verbose log messages.
  • --delay="0ms" — delay after each request, i.e. 5ms, 1.2s.
  • --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s.
  • --dry[=false] — Dry run. Don't send any data to the server.
  • --dryFormat="markdown" — Dry run output format. i.e. json, dump, markdown or curl.
  • --examples[=false] — Show examples for the current command.
  • --filter=[] — Apply a client side filter to response before returning it to the user.
  • --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation.
  • -f, --force[=false] — Do not prompt for confirmation. Ignored when using --confirm.
  • -H, --header=[] — custom headers. i.e. --header "Accept: value, AnotherHeader: myvalue".
  • --includeAll[=false] — Include all results by iterating through each page.
  • -k, --insecure[=false] — Allow insecure server connections when using SSL.
  • -l, --logMessage="" — Add custom message to the activity log.
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!).
  • --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect.
  • --noCache[=false] — Force disabling of cached responses (overwrites cache setting).
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console.
  • --noLog[=false] — Disables the activity log for the current command.
  • --noProgress[=false] — Disable progress bars.
  • --noProxy[=false] — Ignore the proxy settings.
  • -n, --nullInput[=false] — Don't read the input (stdin). Useful if using in shell for/while loops.
  • -o, --output="table" — Output format i.e. table, json, csv, csvheader.
  • --outputFile="" — Save JSON output to file (after select/view).
  • --outputFileRaw="" — Save raw response to file (before select/view).
  • --outputTemplate="" — jsonnet template to apply to the output.
  • -p, --pageSize=5 — Maximum results per page.
  • --progress[=false] — Show progress bar. This will also disable any other verbose output.
  • --proxy="" — Proxy setting, i.e. http://10.0.0.1:8080.
  • -r, --raw[=false] — Show raw response. This mode will force output=json and view=off.
  • --retries=3 — Max number of attempts when a failed http call is encountered.
  • --select=[] — Comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'.
  • --session="" — Session configuration.
  • --sessionMode="" — Override default session mode for a single command which would normally be disabled.
  • -P, --sessionPassword="" — Override session password.
  • -U, --sessionUsername="" — Override session username. i.e. peter or t1234/peter (with tenant).
  • --silentExit[=false] — Silent status codes do not affect the exit code.
  • --silentStatusCodes="" — Status codes which will not print out an error message.
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m.
  • --totalPages=0 — Total number of pages to get.
  • -v, --verbose[=false] — Verbose logging.
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off.
  • --withError[=false] — Errors will be printed on stdout instead of stderr.
  • --withTotalElements[=false] — Request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13).
  • -t, --withTotalPages[=false] — Request Cumulocity to include the total pages in the response statistics under .statistics.totalPages.
  • --workers=1 — Number of workers.

🧪 EXAMPLE 🧪

Bestie, here are the examples, and they are giving documentation but make it fashion. 💅

Example 1: Create a DEV new session. Prompt for username and password

$ c8y sessions create --mode dev --host "https://mytenant.eu-latest.cumulocity.com"

Create a new QA (QUAL) session prompting for password

$ c8y sessions create \
    --mode qual \
     --host "https://mytenant.eu-latest.cumulocity.com"
     --username "myUser@me.com"

Create a new production session where only only GET commands are enabled (with no password storage)

$ c8y sessions create --mode prod --host "https://mytenant.eu-latest.cumulocity.com" --noStorage

Create a session which points to a local api endpoint (most like an Cumulocity Edge instance)

$ c8y sessions create --mode prod --host "https://localhost:443" --insecure

Create a session which uses SSO / OAUTH2 using Authorization Flow (via a local web browser)

$ c8y sessions create --mode dev --host example.cumulocity.com --loginType BROWSER
Note: Requires the "Redirect to the user interface application" to be enabled in Cumulocity

Create a session which uses SSO / OAUTH2 using Authorization Flow (via a local web browser) and define an explicit redirect/callback URI which is whitelisted in the SSO providers configuration

c8y sessions create --mode dev --host example.cumulocity.com --loginType BROWSER --browserCallback localhost:8008/mycallback
Note: Requires the "Redirect to the user interface application" to be enabled in Cumulocity

Create a session with SSO / OAUTH2 Device Flow (RFC 8628)

$ c8y sessions create --mode dev --host example.cumulocity.com --loginType DEVICE

👑 SEE ALSO 👑

c8y-sessions(1)

Signed off from the c8y(1) manual, dated Jan 1980 — bye bestie, slay responsibly 💖🌸

📦 where this page comes from