c8y(1)

hey bestie 💖 welcome to c8y(1) — the manual page for c8y-users, aka the Cumulocity users command. it’s giving ✨ command-line main character energy ✨ and we’re gonna go through every flag together, no cap. 🫶

🌸 NAME 🌸

c8y-users — Cumulocity users 💅

🦋 SYNOPSIS 🦋

c8y users [flags]

✨ DESCRIPTION ✨

okay so bestie, this is literally the REST endpoint to interact with Cumulocity users. that’s the tea ☕ — it’s the users endpoint, and it’s here to do users things. periodt. 💖

💅 OPTIONS 💅

• -h, --help[=false] — help for users. yes bestie, this one just gives you the help glow-up for users 😌✨

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these are the inherited flags, bestie — the parent commands pass them down like hand-me-downs but make them iconic 💫. every single one is here:

• --abortOnErrors=10 — bail on the whole batch once you hit the specified number of errors (default is 10) 🛑
• --allowEmptyPipe[=false] — don’t throw a fit when the piped input (stdin) is empty — let it be empty, bestie 🫧
• --cache[=false] — turn on cached responses so things feel speedier ✨
• --cacheBodyPaths=[] — limit cache hashing to selected paths inside the json body; an empty value means all values get hashed 🧚
• --cacheTTL="60s" — set the cache time-to-live (TTL) as a duration — like 60s or 2m, bestie ⏳
• -c, --compact[=false] — compact the output instead of pretty-printing it when you’re using json output; pretty print is the default when output is the terminal. lowkey neat 📦
• --confirm[=false] — ask for confirmation before doing the thing 🙋‍♀️
• --confirmText="" — set your own custom confirmation text ✍️
• --currentPage=0 — pick which page should be returned — current page starts at 0 📄
• --customQueryParam=[] — add your own custom URL query parameters, like --customQueryParam 'withCustomOption=true,myOtherOption=myvalue' 🔗
• --debug[=false] — crank the log messages up to very verbose mode — debug girlie behavior 🔍
• --delay="0ms" — wait this long after each request — like 5ms or 1.2s ⏱️
• --delayBefore="0ms" — wait this long before each request — like 5ms or 1.2s ⏳
• --dry[=false] — do a dry run — don’t send any data to the server, just vibe 👻
• --dryFormat="markdown" — choose the dry-run output format — json, dump, markdown or curl 📝
• --examples[=false] — show examples for the current command — yes bestie, examples are self-care 💖
• --filter=[] — apply a client-side filter to the response before it comes back to you 🪄
• --flatten[=false] — flatten the json output by replacing nested json properties with properties whose names are represented by dot notation — it’s giving flat and fabulous 🫓
• -f, --force[=false] — skip the confirmation prompt entirely; heads up, this is ignored when you’re using --confirm ⚠️
• -H, --header=[] — add custom headers, like --header "Accept: value, AnotherHeader: myvalue" 📨
• --includeAll[=false] — include all the results by looping through every page — collect them all, bestie 🔁
• -k, --insecure[=false] — allow insecure server connections when using SSL — only when you mean it, bestie 🔓
• -l, --logMessage="" — drop a custom message into the activity log ✏️
• --maxJobs=0 — set the max number of jobs; 0 means unlimited — use with caution, bestie, seriously ⚠️💀
• --noAccept[=false] — ignore the Accept header by removing it from requests; but heads up, only PUT and POST requests see the effect 🚫📬
• --noCache[=false] — force cached responses off, overriding the cache setting 🚫✨
• -M, --noColor[=false] — no colors when log entries show up on the console — minimal, monochrome, mood 🖤
• --noLog[=false] — turn off the activity log for the current command 🚫📓
• --noProgress[=false] — disable progress bars — no little bars, just vibes 🚫📊
• --noProxy[=false] — ignore proxy settings entirely 🙅‍♀️
• -n, --nullInput[=false] — don’t read input (stdin); useful when you’re using shell for/while loops 🌀
• -o, --output="table" — choose your output format — table, json, csv, or csvheader 📤
• --outputFile="" — save JSON output to a file, after select/view 🗂️
• --outputFileRaw="" — save the raw response to a file, before select/view 🗃️
• --outputTemplate="" — apply a jsonnet template to the output 🎨
• -p, --pageSize=5 — set the max results per page — default is 5 📚
• --progress[=false] — show a progress bar; this also disables any other verbose output, so choose wisely 📊✨
• --proxy="" — set the proxy, like http://10.0.0.1:8080 🌐
• -r, --raw[=false] — show the raw response; this mode forces output=json and view=off 🥩
• --retries=3 — max number of attempts when an http call fails — default 3, resilient bestie 💪
• --select=[] — comma-separated list of properties to return; wildcards and globstar are accepted, like --select 'id,name,type,**.serialNumber' 🎯
• --session="" — session configuration, bestie 🔐
• --sessionMode="" — override the default session mode for a single command that would normally be disabled 🎛️
• -P, --sessionPassword="" — override the session password 🔑
• -U, --sessionUsername="" — override the session username, like peter or t1234/peter (with tenant) 🧑‍💻
• --silentExit[=false] — silent status codes won’t affect the exit code 🤫
• --silentStatusCodes="" — status codes that won’t print an error message — quiet girlie behavior 🤐
• --timeout="600s" — set the request timeout duration, like 60s or 2m — default 600s ⏰
• --totalPages=0 — total number of pages to get 📖
• -v, --verbose[=false] — verbose logging, because sometimes you need the whole story 🗣️
• --view="auto" — use views when displaying data on the terminal; disable it with --view off 👀
• --withError[=false] — print errors on stdout instead of stderr 📤❗
• --withTotalElements[=false] — ask Cumulocity to include the total elements in the response statistics under .statistics.totalElements — introduced in 10.13 📊
• -t, --withTotalPages[=false] — ask Cumulocity to include the total pages in the response statistics under .statistics.totalPages 📄
• --workers=1 — set the number of workers — default 1 👷‍♀️

🌈 SEE ALSO 🌈

go read these next, bestie — they’re all linked in the c8y cinematic universe 🎬:

• c8y(1)
• c8y-users-create(1)
• c8y-users-delete(1)
• c8y-users-get(1)
• c8y-users-getInventoryRole(1)
• c8y-users-getUserByName(1)
• c8y-users-list(1)
• c8y-users-listInventoryRoles(1)
• c8y-users-listUserMembership(1)
• c8y-users-resetUserPassword(1)
• c8y-users-revokeTOTPSecret(1)
• c8y-users-update(1)

xoxo, your c8y(1) bestie 💖 — Jan 1980 edition, slaying forever 🎀✨