c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💅 c8y(1) — the c8y manual, but make it make sense

okay so bestie, you're looking at the manual page for c8y, and honestly? this specific page is about one little command that goes and grabs a user's role references. we're gonna go through it together, every single flag, no skipping, no cap. 🫶

✨ NAME ✨

c8y-userroles-getRoleReferenceCollectionFromUser — literally get role references from a user. that's the whole vibe. 🎀

🦋 SYNOPSIS 🦋

c8y userroles getRoleReferenceCollectionFromUser [flags]

🌸 DESCRIPTION 🌸

Get a collection of user role references from a user. that's it, that's the assignment, and it ate. 👑

💖 OPTIONS 💖

  • -h, --help[=false] — help for getRoleReferenceCollectionFromUser. your little "what does this do again" button.
  • --tenant="" — Tenant.
  • --user=[] — User (required) (accepts pipeline). like, you literally cannot run this without it, and it's happy to take piped input too.

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these are the ones you got from your parent command, like inherited trauma but useful 💀

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors.
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). no drama about an empty pipe.
  • --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. main character logging energy.
  • --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. go get every single one, bestie.
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. ⚠️ insecure is right there in the name, so yk.
  • -l, --logMessage="" — Add custom message to the activity log.
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). not me telling you to be careful but also telling you to be careful 😭
  • --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. monochrome era, lowkey sad.
  • --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 ⭐

okay so here's the moment, the demo, the tutorial level:

$ c8y userroles getRoleReferenceCollectionFromUser --user "peterpi@example.com"
Get a list of role references for a user

see? peter gets his role references. slay for peter. 💅

🧚 SEE ALSO 🧚

bestie reminder: --user is required, and --insecure is literally named insecure, and --maxJobs=0 means unlimited "use with caution!" — those are the receipts, don't come for me. 🔥

and that's the whole page, gorgeous. this one's from the c8y manual, dated Jan 1980 (yes, really, that's the date on it — vintage, iconic, a little unhinged 🎀), and that's the sign-off. go forth and get those role references. 💜

📦 where this page comes from