c8y(1)

📦 version 2.56.1, in nixpkgs unstable

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

okay so bestie, welcome to the c8y manual page (that's the manual name, yes, we're doing this) 💖 this particular page is all about one lil subcommand: c8y-userreferences-addUserToGroup — user references, adding a user to a group. iconic behaviour, honestly. let's get into it ✨

🌸 NAME 🌸

c8y-userreferences-addUserToGroup — add user to group 🫶 that's it, that's the whole job.

🦋 SYNOPSIS 🦋

c8y userreferences addUserToGroup [flags]

so it's c8y, then userreferences, then addUserToGroup, then whatever flags you feel like throwing at it. mwah 💅

✨ DESCRIPTION ✨

Add an existing user to a group. that's the assignment, and it ate 💅 no cap, that's literally it — the user has to already exist, we're not out here creating anybody new, we're just doing a little matchmaking 🎀

👑 OPTIONS 👑

okay the main character options, bestie — these belong to addUserToGroup itself:

  • --group=[] — the Group ID. required, so like… don't forget it 🙈
  • -h, --help[=false] — help for addUserToGroup. your emotional support flag 💖
  • --processingMode="" — Cumulocity processing mode. yes bestie, we're being fancy ✨
  • --tenant="" — the Tenant. whose house are we visiting 🏠
  • --user=[] — the user id. required (and it accepts pipeline — so you can pipe stuff straight in, we love a shortcut 🫶)

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these are the ones you get for free from the parent command — the whole family is showing up to support 🫶 there are,,, a lot. buckle up bestie, we're going through all of them, no skipping 💀

  • --abortOnErrors=10 — abort the batch when it hits the specified number of errors. like leaving the group chat when it gets too messy 😭
  • --allowEmptyPipe[=false] — don't fail when the piped input (stdin) is empty. be nice about it 💜
  • --cache[=false] — enable cached responses. memory of a queen 👑
  • --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. empty means all values 🌸
  • --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m. it's giving expiry date 🎀
  • -c, --compact[=false] — compact instead of pretty-printed output when using json output. pretty print is the default if output is the terminal, ngl 💅
  • --confirm[=false] — prompt for confirmation. are you sure, bestie? 🥺
  • --confirmText="" — custom confirmation text. write your own little "r u sure" note ✨
  • --currentPage=0 — the 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. it will NOT shut up and we love that 🔥
  • --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. fake it till you make it 🙈
  • --dryFormat="markdown" — dry run output format, i.e. json, dump, markdown or curl 💅
  • --examples[=false] — show examples for the current command. yes queen, show us the receipts 🎀
  • --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 🫶
  • -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. all of it, no crumbs left 💀
  • -k, --insecure[=false] — allow insecure server connections when using SSL. risky business, but it's your life bestie 🫶
  • -l, --logMessage="" — add a custom message to the activity log 📝
  • --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). and the manual literally said caution, so like… caution ⚠️
  • --noAccept[=false] — ignore the Accept header; this 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 the cache setting) 🚫
  • -M, --noColor[=false] — don't use colors when displaying log entries on the console. monochrome moment 🖤
  • --noLog[=false] — disables the activity log for the current command 🙈
  • --noProgress[=false] — disable progress bars. no bar, just vibes 🦋
  • --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. try again, bestie, you got this 💪
  • --select=[] — comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber' ✨
  • --session="" — session configuration 🔑
  • --sessionMode="" — override the 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. tell me EVERYTHING 🗣️
  • --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 bestie, the moment you've been waiting for — actual working examples, character for character, go off 👑

$ c8y userreferences addUserToGroup --group 1 --user peterpi@example.com
Add a user to a user group

one user, one group, done. slay ✨

$ c8y users list | c8y userreferences addUserToGroup --group admins
Add a list of users to admins group (using pipeline)

pipeline moment!! 🫶 the --user flag accepts pipeline, remember? this is why 💅

$ c8y users list | c8y userreferences addUserToGroup --group business | c8y userreferences addUserToGroup --group admins
Add a list of users to business and admins group (using pipeline)

double pipeline, double group, double iconic 🌈 two addUserToGroup calls chained with | — business AND admins, no cap 🔥

🧚 SEE ALSO 🧚

bestie reminder: --group and --user are required. like, actually required. the command will simply not be doing its little task without them 🙈

and that's the page!! you read the whole thing, i'm so proud 🥹💜 this was c8y(1) — yeah the manual name really is just c8y, we love a humble title — source/version c8y(1), dated Jan 1980 (yes, 1980, the lore is deep, don't question it 💀) mwah, go add those users to those groups, periodt 💅✨🎀

📦 where this page comes from