c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the girl's guide to c8y 🎀

okay so real talk, this is the manual page for c8y, bestie. yes, that c8y. we're getting into the microservices serviceusers create situation and honestly? it's giving "small command, big family tree of flags." buckle up 🦋

✨ NAME ✨

c8y-microservices-serviceusers-create — new application service user, periodt 💅

🌸 SYNOPSIS 🌸

c8y microservices serviceusers create [flags]

like, that's the whole vibe. command first, flags after, no cap ✨

🦋 DESCRIPTION 🦋

New application service user 🫶

that's it. that's the whole description. sometimes a command just tells you what it is and doesn't overexplain, and honestly? respect 😌

💖 OPTIONS 💖

these are hers. the ones that belong to create specifically 👑

  • -d, --data=[] — static data that gets applied to the body. accepts json, or that cute shorthand json like --data 'value1=1,my.nested.value=100' 🌸
  • -h, --help[=false] — help for create. the "wait what does this do again" button 🎀
  • --name="" — name of application 👑
  • --roles=[] — the roles that should be assigned to the service user. give her the right permissions, iykyk 🔥
  • --tenants=[] — tenant to subscribe to. if you leave it blank, then the application will not generate the service user. like, blank tenants = no service user, that's the deal 🙈

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these aren't even hers, they're from the parents, but she carries them everywhere like emotional baggage 💀 all 55 of them, not one skipped:

  • --abortOnErrors=10 — abort the batch when you hit the specified number of errors. ten strikes and the batch is out ✋
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. sometimes the pipe is just quiet, okay 😭
  • --cache[=false] — enable cached responses ⭐
  • --cacheBodyPaths=[] — the cache should limit hashing to selected paths in the json body. empty means all values 💜
  • --cacheTTL="60s" — cache time-to-live 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, for when you want it to say your words 💅
  • --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. she will not stop talking 🔥
  • --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. all the vibes, none of the commitment 🙈
  • --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 the 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. squish it flat, bestie 🦋
  • -f, --force[=false] — don't 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. yes she's being reckless but she's living 🚨
  • -l, --logMessage="" — add a custom message to the activity log 📝
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!) ⚠️ like, genuinely, 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. tragic but valid 🖤
  • --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. three tries, then we accept fate 😭
  • --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 🍓

okay so here's the moment you've been waiting for, the actual demo:

$ c8y microservices serviceusers create --name my-user
Create new application service user

look at her go. iconic behavior honestly 👑

🧚 SEE ALSO 🧚

and that's the whole page bestie!! no notes, she ate 💅

sign-off time: this gem is dated Jan 1980 (yes, she's vintage, she's an old soul 🎀) and it's the c8y(1) manual, so go forth and create those service users fr fr 🌈✨🫶

📦 where this page comes from