c8y(1)

💅 c8y(1) — Cumulocity user references: the c8y-userreferences page 💅

🌸 NAME 🌸

c8y-userreferences — Cumulocity user references. that's the name, bestie, no cap ✨

🦋 SYNOPSIS 🦋

c8y userreferences [flags]

💖 DESCRIPTION 💖

Okay so this is the REST endpoint for interacting with Cumulocity user references. that's the whole vibe: it's the little doorway for user-reference stuff, and the flags below are the keys 🔑

🎀 OPTIONS 🎀

• -h, --help[=false] — shows help for userreferences. literally the "what does this thing do" button 🫶

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

These are the parent-command options that come along for the ride, bestie. same order, same flags, all the lore 👑

• --abortOnErrors=10 — abort the batch when it reaches the specified number of errors. default is 10, so it's giving "we tried, now we stop" 💀
• --allowEmptyPipe[=false] — don't fail when piped input is empty (stdin). empty pipe? not a crisis 💅
• --cache[=false] — enable cached responses. yes, we're caching, and it's iconic ✨
• --cacheBodyPaths=[] — cache should limit hashing of selected paths in the json body. empty indicates all values. so [] means "hash all the things" 🧚
• --cacheTTL="60s" — cache time-to-live (TTL) as a duration, i.e. 60s, 2m. default is "60s" ⏳
• -c, --compact[=false] — compact instead of pretty-printed output when using json output. pretty print is the default if output is the terminal. compact mode is lowkey neat 🌸
• --confirm[=false] — prompt for confirmation. the "are you sure, bestie?" moment 🙈
• --confirmText="" — custom confirmation text. make the "are you sure" say whatever you want 🎀
• --currentPage=0 — current page which should be returned. starting at 0, because we're page-zero girlies 💅
• --customQueryParam=[] — add custom URL query parameters, i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. custom params, custom destiny 🔥
• --debug[=false] — set very verbose log messages. debug mode is loud and proud 🗣️
• --delay="0ms" — delay after each request, i.e. 5ms, 1.2s. default "0ms" ⏱️
• --delayBefore="0ms" — delay before each request, i.e. 5ms, 1.2s. default "0ms" ⏱️
• --dry[=false] — dry run. don't send any data to the server. we're just practicing, bestie 🫧
• --dryFormat="markdown" — dry run output format, i.e. json, dump, markdown or curl. default "markdown" 📝
• --examples[=false] — show examples for the current command. examples ate, honestly ✨
• --filter=[] — apply a client side filter to response before returning it to the user. filter it before it hits your eyeballs 👀
• --flatten[=false] — flatten json output by replacing nested json properties with properties where their names are represented by dot notation. nested? not anymore 🪄
• -f, --force[=false] — do not prompt for confirmation. ignored when using --confirm. bold of you, but okay 💅
• -H, --header=[] — custom headers, i.e. --header "Accept: value, AnotherHeader: myvalue". headers are the accessory of HTTP 💖
• --includeAll[=false] — include all results by iterating through each page. all the pages, all the results, main character energy 👑
• -k, --insecure[=false] — allow insecure server connections when using SSL. yes, it says insecure; proceed with your eyes open 😭
• -l, --logMessage="" — add custom message to the activity log. leave a little note in the group chat 📓
• --maxJobs=0 — maximum number of jobs. 0 = unlimited (use with caution!). the caution is real, bestie ⚠️
• --noAccept[=false] — ignore Accept header will remove the Accept header from requests, however PUT and POST requests will only see the effect. Accept header? we don't know her 💀
• --noCache[=false] — force disabling of cached responses (overwrites cache setting). cache is cancelled, periodt 🚫
• -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. no receipts today 🙈
• --noProgress[=false] — disable progress bars. no little loading bar, just vibes 🫧
• --noProxy[=false] — ignore the proxy settings. proxy? never met her 🌸
• -n, --nullInput[=false] — don't read the input (stdin). useful if using in shell for/while loops. loops said "no input, thanks" 🔁
• -o, --output="table" — output format, i.e. table, json, csv, csvheader. default is "table" 📊
• --outputFile="" — save JSON output to file (after select/view). file goblin mode, but after select/view 💾
• --outputFileRaw="" — save raw response to file (before select/view). raw and unfiltered, before select/view 📦
• --outputTemplate="" — jsonnet template to apply to the output. template girlie 🎨
• -p, --pageSize=5 — maximum results per page. default is 5, cute and manageable 💅
• --progress[=false] — show progress bar. this will also disable any other verbose output. progress bar takes the aux, apparently 📈
• --proxy="" — proxy setting, i.e. http://10.0.0.1:8080. your proxy, your rules 🌐
• -r, --raw[=false] — show raw response. this mode will force output=json and view=off. raw is raw, no notes 🔥
• --retries=3 — max number of attempts when a failed http call is encountered. default 3, because we try again, bestie 🔁
• --select=[] — comma separated list of properties to return. wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. choose your faves 💖
• --session="" — session configuration. session stuff, very demure ✨
• --sessionMode="" — override default session mode for a single command which would normally be disabled. just for one command, bestie 🎀
• -P, --sessionPassword="" — override session password. password override, keep it cute and private 🔐
• -U, --sessionUsername="" — override session username, i.e. peter or t1234/peter (with tenant). username glow-up 🌟
• --silentExit[=false] — silent status codes do not affect the exit code. silent but not shady 🤫
• --silentStatusCodes="" — status codes which will not print out an error message. these codes are on mute 🔇
• --timeout="600s" — request timeout duration, i.e. 60s, 2m. default is "600s" ⌛
• --totalPages=0 — total number of pages to get. how many pages? this many 📚
• -v, --verbose[=false] — verbose logging. tell me everything, bestie 🗣️
• --view="auto" — use views when displaying data on the terminal. disable using --view off. auto view is the default vibe 👀
• --withError[=false] — errors will be printed on stdout instead of stderr. errors, but make it stdout 💅
• --withTotalElements[=false] — request Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). total elements, very stats-coded 📈
• -t, --withTotalPages[=false] — request Cumulocity to include the total pages in the response statistics under .statistics.totalPages. total pages, periodt 📚
• --workers=1 — number of workers. default 1, one worker doing their thing 🫶

👑 SEE ALSO 👑

• c8y(1)
• c8y-userreferences-addUserToGroup(1)
• c8y-userreferences-deleteUserFromGroup(1)
• c8y-userreferences-listGroupMembership(1)

mwah 💋 — this page is from c8y(1), dated Jan 1980. go be iconic with your user references, bestie 🫶💖