c8y(1)

📦 version 2.56.1, in nixpkgs unstable

💖 NAME 💖

c8y-users-listUserMembership — get user membership collection

okay bestie, welcome to the c8y(1) manual page — yes, the whole manual — and this specific little icon is all about grabbing the user membership collection. It's giving "which groups is this user in?" energy, and we're gonna get into it. no cap 💅

🌸 SYNOPSIS 🌸

c8y users listUserMembership [flags]

🦋 DESCRIPTION 🦋

You're getting the tea on every single group that a user is a member of. Literally: get information about all groups that a user is a member of. Periodt — that's the whole vibe. ✨

✨ OPTIONS ✨

  • -h, --help[=false] — help for listUserMembership. Pop this when you need the assist, bestie.
  • --id=[] — User (required) (accepts pipeline). This one is required, so do not skip it — and yes, it accepts pipeline input. main character energy 🔥
  • --tenant="" — Tenant. That's the tenant vibe right there. 🎀

🫶 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

  • --abortOnErrors=10 — Abort batch when reaching specified number of errors. It's the "okay we're done here" threshold. 💀
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). No input? No drama. 🫶
  • --cache[=false] — Enable cached responses. Reusing the vibe, lowkey. ✨
  • --cacheBodyPaths=[] — Cache should limit hashing of selected paths in the json body. Empty indicates all values. iykyk.
  • --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. cute and tidy 🎀
  • --confirm[=false] — Prompt for confirmation. It's giving "are you sure, bestie?" energy.
  • --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. debug mode says "I will tell you everything."
  • --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. Important: no data goes out, bestie.
  • --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. read that again — 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. all the pages, all the tea 🌈
  • -k, --insecure[=false] — Allow insecure server connections when using SSL. It's literally in the name, bestie. 🙈
  • -l, --logMessage="" — Add custom message to the activity log.
  • --maxJobs=0 — Maximum number of jobs. 0 = unlimited (use with caution!). Use with caution is not a drill. 💀
  • --noAccept[=false] — Ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. Heads up: only PUT and POST requests will 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. raw mode said what it said.
  • --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. talk to me, bestie.
  • --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 🌈

$ c8y users listUserMembership --id "myuser"
Get a list of groups that a user belongs to

🎀 SEE ALSO 🎀

  • c8y-users(1) — the parent command's page, go sip that tea next. 🍓

xoxo, the c8y(1) manual page, Jan 1980 edition 💅✨

📦 where this page comes from