pyceo/docs/redoc-static.html

610 lines
1.2 MiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf8" />
<title>ceod - OpenAPI 3.0</title>
<!-- needed for adaptive design -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<style>
body {
padding: 0;
margin: 0;
}
</style>
<script>/*! For license information please see redoc.standalone.js.LICENSE.txt */
!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t(require("null")):"function"==typeof define&&define.amd?define(["null"],t):"object"==typeof exports?exports.Redoc=t(require("null")):e.Redoc=t(e.null)}(this,(function(e){return function(){var t={7228:function(e){e.exports=function(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,r=new Array(t);n<t;n++)r[n]=e[n];return r},e.exports.default=e.exports,e.exports.__esModule=!0},2858:function(e){e.exports=function(e){if(Array.isArray(e))return e},e.exports.default=e.exports,e.exports.__esModule=!0},3646:function(e,t,n){var r=n(7228);e.exports=function(e){if(Array.isArray(e))return r(e)},e.exports.default=e.exports,e.exports.__esModule=!0},1506:function(e){e.exports=function(e){if(void 0===e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return e},e.exports.default=e.exports,e.exports.__esModule=!0},4575:function(e){e.exports=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},e.exports.default=e.exports,e.exports.__esModule=!0},9100:function(e,t,n){var r=n(9489),o=n(7067);function i(t,n,a){return o()?(e.exports=i=Reflect.construct,e.exports.default=e.exports,e.exports.__esModule=!0):(e.exports=i=function(e,t,n){var o=[null];o.push.apply(o,t);var i=new(Function.bind.apply(e,o));return n&&r(i,n.prototype),i},e.exports.default=e.exports,e.exports.__esModule=!0),i.apply(null,arguments)}e.exports=i,e.exports.default=e.exports,e.exports.__esModule=!0},3913:function(e){function t(e,t){for(var n=0;n<t.length;n++){var r=t[n];r.enumerable=r.enumerable||!1,r.configurable=!0,"value"in r&&(r.writable=!0),Object.defineProperty(e,r.key,r)}}e.exports=function(e,n,r){return n&&t(e.prototype,n),r&&t(e,r),e},e.exports.default=e.exports,e.exports.__esModule=!0},3269:function(e,t,n){var r=n(379);e.exports=function(e,t){var n="undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(!n){if(Array.isArray(e)||(n=r(e))||t&&e&&"number"==typeof e.length){n&&(e=n);var o=0,i=function(){};return{s:i,n:function(){return o>=e.length?{done:!0}:{done:!1,value:e[o++]}},e:function(e){throw e},f:i}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}var a,s=!0,l=!1;return{s:function(){n=n.call(e)},n:function(){var e=n.next();return s=e.done,e},e:function(e){l=!0,a=e},f:function(){try{s||null==n.return||n.return()}finally{if(l)throw a}}}},e.exports.default=e.exports,e.exports.__esModule=!0},9842:function(e,t,n){var r=n(9754),o=n(7067),i=n(8585);e.exports=function(e){var t=o();return function(){var n,o=r(e);if(t){var a=r(this).constructor;n=Reflect.construct(o,arguments,a)}else n=o.apply(this,arguments);return i(this,n)}},e.exports.default=e.exports,e.exports.__esModule=!0},9713:function(e){e.exports=function(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e},e.exports.default=e.exports,e.exports.__esModule=!0},9754:function(e){function t(n){return e.exports=t=Object.setPrototypeOf?Object.getPrototypeOf:function(e){return e.__proto__||Object.getPrototypeOf(e)},e.exports.default=e.exports,e.exports.__esModule=!0,t(n)}e.exports=t,e.exports.default=e.exports,e.exports.__esModule=!0},2205:function(e,t,n){var r=n(9489);e.exports=function(e,t){if("function"!=typeof t&&null!==t)throw new TypeError("Super expression must either be null or a function");e.prototype=Object.create(t&&t.prototype,{constructor:{value:e,writable:!0,configurable:!0}}),t&&r(e,t)},e.exports.default=e.exports,e.exports.__esModule=!0},430:function(e){e.exports=function(e){return-1!==Function.toString.call(e).indexOf("[native code]")},e.exports.default=e.exports,e.exports.__esModule=!0},7067:function(e){e.exports=function(){if("undefined"==typeof Reflect||!Reflect.construct)return!1;if(Reflect.construct.sham)return!1;if("function"==typeof Proxy)return!0;try{return Boolean.prototype.valueOf.call(Reflect.construct(Boolean,[],(function(){}))),!0}catch(e){return!1}},e.expor
//# sourceMappingURL=redoc.standalone.js.map</script><style data-styled="true" data-styled-version="5.3.0">.egQuEZ{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
@media print,screen and (max-width:75rem){.egQuEZ{width:100%;padding:40px 40px;}}/*!sc*/
.dmghQN{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
@media print,screen and (max-width:75rem){.dmghQN{width:100%;padding:0px 40px;}}/*!sc*/
data-styled.g4[id="sc-hKFxyN"]{content:"egQuEZ,dmghQN,"}/*!sc*/
.fxZJZV{padding:40px 0;}/*!sc*/
.fxZJZV:last-child{min-height:calc(100vh + 1px);}/*!sc*/
.sc-eCApnc > .sc-eCApnc:last-child{min-height:initial;}/*!sc*/
@media print,screen and (max-width:75rem){.fxZJZV{padding:0;}}/*!sc*/
.bJnWIW{padding:40px 0;position:relative;}/*!sc*/
.bJnWIW:last-child{min-height:calc(100vh + 1px);}/*!sc*/
.sc-eCApnc > .sc-eCApnc:last-child{min-height:initial;}/*!sc*/
@media print,screen and (max-width:75rem){.bJnWIW{padding:0;}}/*!sc*/
.bJnWIW:not(:last-of-type):after{position:absolute;bottom:0;width:100%;display:block;content:'';border-bottom:1px solid rgba(0,0,0,0.2);}/*!sc*/
data-styled.g5[id="sc-eCApnc"]{content:"fxZJZV,bJnWIW,"}/*!sc*/
.hsSsLr{width:40%;color:#ffffff;background-color:#263238;padding:0 40px;}/*!sc*/
@media print,screen and (max-width:75rem){.hsSsLr{width:100%;padding:40px 40px;}}/*!sc*/
data-styled.g6[id="sc-jSFjdj"]{content:"hsSsLr,"}/*!sc*/
.gcushC{background-color:#263238;}/*!sc*/
data-styled.g7[id="sc-gKAaRy"]{content:"gcushC,"}/*!sc*/
.KWWXd{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;width:100%;padding:0;}/*!sc*/
@media print,screen and (max-width:75rem){.KWWXd{-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;}}/*!sc*/
data-styled.g8[id="sc-iCoGMd"]{content:"KWWXd,"}/*!sc*/
.cTueGk{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;}/*!sc*/
data-styled.g9[id="sc-fujyAs"]{content:"cTueGk,"}/*!sc*/
.euRMgx{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:black;}/*!sc*/
data-styled.g10[id="sc-pNWdM"]{content:"euRMgx,"}/*!sc*/
.iXmHCl{color:#ffffff;}/*!sc*/
data-styled.g12[id="sc-kEqXSa"]{content:"iXmHCl,"}/*!sc*/
.eONCmm{border-bottom:1px solid rgba(38,50,56,0.3);margin:1em 0 1em 0;color:rgba(38,50,56,0.5);font-weight:normal;text-transform:uppercase;font-size:0.929em;line-height:20px;}/*!sc*/
data-styled.g13[id="sc-iqAclL"]{content:"eONCmm,"}/*!sc*/
.iUxAWq{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.iUxAWq:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
h1:hover > .sc-crzoAE::before,h2:hover > .iUxAWq::before,.iUxAWq:hover::before{visibility:visible;}/*!sc*/
data-styled.g14[id="sc-crzoAE"]{content:"iUxAWq,"}/*!sc*/
.gmNZmS{height:18px;width:18px;vertical-align:middle;float:right;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/
.jLtOTj{height:1.5em;width:1.5em;vertical-align:middle;float:left;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/
.jLtOTj polygon{fill:#1d8127;}/*!sc*/
.gGvkZD{height:20px;width:20px;vertical-align:middle;float:right;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(0);-ms-transform:rotateZ(0);transform:rotateZ(0);}/*!sc*/
.gGvkZD polygon{fill:white;}/*!sc*/
.hikpbD{height:1.5em;width:1.5em;vertical-align:middle;float:left;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/
.hikpbD polygon{fill:#d41f1c;}/*!sc*/
data-styled.g15[id="sc-dIsUp"]{content:"gmNZmS,jLtOTj,gGvkZD,hikpbD,"}/*!sc*/
.fABPTr{border-left:1px solid #7c7cbb;box-sizing:border-box;position:relative;padding:10px 10px 10px 0;}/*!sc*/
@media screen and (max-width:50rem){.fABPTr{display:block;overflow:hidden;}}/*!sc*/
tr:first-of-type > .sc-hBMUJo,tr.last > .fABPTr{border-left-width:0;background-position:top left;background-repeat:no-repeat;background-size:1px 100%;}/*!sc*/
tr:first-of-type > .sc-hBMUJo{background-image:linear-gradient( to bottom, transparent 0%, transparent 22px, #7c7cbb 22px, #7c7cbb 100% );}/*!sc*/
tr.last > .sc-hBMUJo{background-image:linear-gradient( to bottom, #7c7cbb 0%, #7c7cbb 22px, transparent 22px, transparent 100% );}/*!sc*/
tr.last + tr > .sc-hBMUJo{border-left-color:transparent;}/*!sc*/
tr.last:first-child > .sc-hBMUJo{background:none;border-left-color:transparent;}/*!sc*/
data-styled.g18[id="sc-hBMUJo"]{content:"fABPTr,"}/*!sc*/
.eQzShU{vertical-align:top;line-height:20px;white-space:nowrap;font-size:13px;font-family:Courier,monospace;}/*!sc*/
.eQzShU.deprecated{-webkit-text-decoration:line-through;text-decoration:line-through;color:#707070;}/*!sc*/
.fcIjHV{vertical-align:top;line-height:20px;white-space:nowrap;font-size:13px;font-family:Courier,monospace;font-style:italic;}/*!sc*/
.fcIjHV.deprecated{-webkit-text-decoration:line-through;text-decoration:line-through;color:#707070;}/*!sc*/
data-styled.g20[id="sc-fFSPTT"]{content:"eQzShU,fcIjHV,"}/*!sc*/
.gWxDzL{border-bottom:1px solid #9fb4be;padding:10px 0;width:75%;box-sizing:border-box;}/*!sc*/
tr.expanded .sc-bkbkJK{border-bottom:none;}/*!sc*/
@media screen and (max-width:50rem){.gWxDzL{padding:0 20px;border-bottom:none;border-left:1px solid #7c7cbb;}tr.last > .sc-bkbkJK{border-left:none;}}/*!sc*/
data-styled.g21[id="sc-bkbkJK"]{content:"gWxDzL,"}/*!sc*/
.bcnRwz{color:#7c7cbb;font-family:Courier,monospace;margin-right:10px;}/*!sc*/
.bcnRwz::before{content:'';display:inline-block;vertical-align:middle;width:10px;height:1px;background:#7c7cbb;}/*!sc*/
.bcnRwz::after{content:'';display:inline-block;vertical-align:middle;width:1px;background:#7c7cbb;height:7px;}/*!sc*/
data-styled.g22[id="sc-iemWCZ"]{content:"bcnRwz,"}/*!sc*/
.dYlGyN{border-collapse:separate;border-radius:3px;font-size:14px;border-spacing:0;width:100%;}/*!sc*/
.dYlGyN > tr{vertical-align:middle;}/*!sc*/
@media screen and (max-width:50rem){.dYlGyN{display:block;}.dYlGyN > tr,.dYlGyN > tbody > tr{display:block;}}/*!sc*/
@media screen and (max-width:50rem) and (-ms-high-contrast:none){.dYlGyN td{float:left;width:100%;}}/*!sc*/
.dYlGyN .sc-dIvrsQ,.dYlGyN .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ,.dYlGyN .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ{margin:1em;margin-right:0;background:#fafafa;}/*!sc*/
.dYlGyN .sc-dIvrsQ .sc-dIvrsQ,.dYlGyN .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ,.dYlGyN .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ .sc-dIvrsQ{background:#ffffff;}/*!sc*/
data-styled.g24[id="sc-hHEiqL"]{content:"dYlGyN,"}/*!sc*/
.EoFth{margin:0 0 3px 0;display:inline-block;}/*!sc*/
data-styled.g25[id="sc-dlMDgC"]{content:"EoFth,"}/*!sc*/
.juYXUf{font-size:0.9em;margin-right:10px;color:#32329f;font-family:Montserrat,sans-serif;}/*!sc*/
data-styled.g26[id="sc-kfYoZR"]{content:"juYXUf,"}/*!sc*/
.hyMKIl{display:inline-block;margin-right:10px;margin-bottom:5px;font-size:0.8em;cursor:pointer;border:1px solid #32329f;padding:2px 10px;line-height:1.5em;outline:none;color:white;background-color:#32329f;}/*!sc*/
.hyMKIl:focus{box-shadow:0 0 0 1px #32329f;}/*!sc*/
.hyMKIl:focus{box-shadow:none;background-color:#202065;}/*!sc*/
.cWoVOF{display:inline-block;margin-right:10px;margin-bottom:5px;font-size:0.8em;cursor:pointer;border:1px solid #32329f;padding:2px 10px;line-height:1.5em;outline:none;color:#32329f;background-color:white;}/*!sc*/
.cWoVOF:focus{box-shadow:0 0 0 1px #32329f;}/*!sc*/
data-styled.g27[id="sc-fKgJPI"]{content:"hyMKIl,cWoVOF,"}/*!sc*/
.joKODG{margin-left:10px;text-transform:none;font-size:0.929em;color:black;}/*!sc*/
data-styled.g43[id="sc-jcwpoC"]{content:"joKODG,"}/*!sc*/
.evYMTo > ul{list-style:none;padding:0;margin:0;margin:0 -5px;}/*!sc*/
.evYMTo > ul > li{padding:5px 10px;display:inline-block;background-color:#11171a;border-bottom:1px solid rgba(0,0,0,0.5);cursor:pointer;text-align:center;outline:none;color:#ccc;margin:0 5px 5px 5px;border:1px solid #07090b;border-radius:5px;min-width:60px;font-size:0.9em;font-weight:bold;}/*!sc*/
.evYMTo > ul > li.react-tabs__tab--selected{color:#333333;background:#ffffff;}/*!sc*/
.evYMTo > ul > li.react-tabs__tab--selected:focus{outline:auto;}/*!sc*/
.evYMTo > ul > li:only-child{-webkit-flex:none;-ms-flex:none;flex:none;min-width:100px;}/*!sc*/
.evYMTo > ul > li.tab-success{color:#1d8127;}/*!sc*/
.evYMTo > ul > li.tab-redirect{color:#ffa500;}/*!sc*/
.evYMTo > ul > li.tab-info{color:#87ceeb;}/*!sc*/
.evYMTo > ul > li.tab-error{color:#d41f1c;}/*!sc*/
.evYMTo > .react-tabs__tab-panel{background:#11171a;}/*!sc*/
.evYMTo > .react-tabs__tab-panel > div,.evYMTo > .react-tabs__tab-panel > pre{padding:20px;margin:0;}/*!sc*/
.evYMTo > .react-tabs__tab-panel > div > pre{padding:0;}/*!sc*/
data-styled.g44[id="sc-carFqZ"]{content:"evYMTo,"}/*!sc*/
.dFWqin code[class*='language-'],.dFWqin pre[class*='language-']{text-shadow:0 -0.1em 0.2em black;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none;}/*!sc*/
@media print{.dFWqin code[class*='language-'],.dFWqin pre[class*='language-']{text-shadow:none;}}/*!sc*/
.dFWqin pre[class*='language-']{padding:1em;margin:0.5em 0;overflow:auto;}/*!sc*/
.dFWqin .token.comment,.dFWqin .token.prolog,.dFWqin .token.doctype,.dFWqin .token.cdata{color:hsl(30,20%,50%);}/*!sc*/
.dFWqin .token.punctuation{opacity:0.7;}/*!sc*/
.dFWqin .namespace{opacity:0.7;}/*!sc*/
.dFWqin .token.property,.dFWqin .token.tag,.dFWqin .token.number,.dFWqin .token.constant,.dFWqin .token.symbol{color:#4a8bb3;}/*!sc*/
.dFWqin .token.boolean{color:#e64441;}/*!sc*/
.dFWqin .token.selector,.dFWqin .token.attr-name,.dFWqin .token.string,.dFWqin .token.char,.dFWqin .token.builtin,.dFWqin .token.inserted{color:#a0fbaa;}/*!sc*/
.dFWqin .token.selector + a,.dFWqin .token.attr-name + a,.dFWqin .token.string + a,.dFWqin .token.char + a,.dFWqin .token.builtin + a,.dFWqin .token.inserted + a,.dFWqin .token.selector + a:visited,.dFWqin .token.attr-name + a:visited,.dFWqin .token.string + a:visited,.dFWqin .token.char + a:visited,.dFWqin .token.builtin + a:visited,.dFWqin .token.inserted + a:visited{color:#4ed2ba;-webkit-text-decoration:underline;text-decoration:underline;}/*!sc*/
.dFWqin .token.property.string{color:white;}/*!sc*/
.dFWqin .token.operator,.dFWqin .token.entity,.dFWqin .token.url,.dFWqin .token.variable{color:hsl(40,90%,60%);}/*!sc*/
.dFWqin .token.atrule,.dFWqin .token.attr-value,.dFWqin .token.keyword{color:hsl(350,40%,70%);}/*!sc*/
.dFWqin .token.regex,.dFWqin .token.important{color:#e90;}/*!sc*/
.dFWqin .token.important,.dFWqin .token.bold{font-weight:bold;}/*!sc*/
.dFWqin .token.italic{font-style:italic;}/*!sc*/
.dFWqin .token.entity{cursor:help;}/*!sc*/
.dFWqin .token.deleted{color:red;}/*!sc*/
data-styled.g46[id="sc-iBzEeX"]{content:"dFWqin,"}/*!sc*/
.eQQUSD{opacity:0.7;-webkit-transition:opacity 0.3s ease;transition:opacity 0.3s ease;text-align:right;}/*!sc*/
.eQQUSD:focus-within{opacity:1;}/*!sc*/
.eQQUSD > button{background-color:transparent;border:0;color:inherit;padding:2px 10px;font-family:Roboto,sans-serif;font-size:14px;line-height:1.5em;cursor:pointer;outline:0;}/*!sc*/
.eQQUSD > button:hover,.eQQUSD > button:focus{background:rgba(255,255,255,0.1);}/*!sc*/
data-styled.g47[id="sc-efHYUO"]{content:"eQQUSD,"}/*!sc*/
.gEtKwR:hover .sc-efHYUO{opacity:1;}/*!sc*/
data-styled.g48[id="sc-cTJkRt"]{content:"gEtKwR,"}/*!sc*/
.bnCoiE code[class*='language-'],.bnCoiE pre[class*='language-']{text-shadow:0 -0.1em 0.2em black;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none;}/*!sc*/
@media print{.bnCoiE code[class*='language-'],.bnCoiE pre[class*='language-']{text-shadow:none;}}/*!sc*/
.bnCoiE pre[class*='language-']{padding:1em;margin:0.5em 0;overflow:auto;}/*!sc*/
.bnCoiE .token.comment,.bnCoiE .token.prolog,.bnCoiE .token.doctype,.bnCoiE .token.cdata{color:hsl(30,20%,50%);}/*!sc*/
.bnCoiE .token.punctuation{opacity:0.7;}/*!sc*/
.bnCoiE .namespace{opacity:0.7;}/*!sc*/
.bnCoiE .token.property,.bnCoiE .token.tag,.bnCoiE .token.number,.bnCoiE .token.constant,.bnCoiE .token.symbol{color:#4a8bb3;}/*!sc*/
.bnCoiE .token.boolean{color:#e64441;}/*!sc*/
.bnCoiE .token.selector,.bnCoiE .token.attr-name,.bnCoiE .token.string,.bnCoiE .token.char,.bnCoiE .token.builtin,.bnCoiE .token.inserted{color:#a0fbaa;}/*!sc*/
.bnCoiE .token.selector + a,.bnCoiE .token.attr-name + a,.bnCoiE .token.string + a,.bnCoiE .token.char + a,.bnCoiE .token.builtin + a,.bnCoiE .token.inserted + a,.bnCoiE .token.selector + a:visited,.bnCoiE .token.attr-name + a:visited,.bnCoiE .token.string + a:visited,.bnCoiE .token.char + a:visited,.bnCoiE .token.builtin + a:visited,.bnCoiE .token.inserted + a:visited{color:#4ed2ba;-webkit-text-decoration:underline;text-decoration:underline;}/*!sc*/
.bnCoiE .token.property.string{color:white;}/*!sc*/
.bnCoiE .token.operator,.bnCoiE .token.entity,.bnCoiE .token.url,.bnCoiE .token.variable{color:hsl(40,90%,60%);}/*!sc*/
.bnCoiE .token.atrule,.bnCoiE .token.attr-value,.bnCoiE .token.keyword{color:hsl(350,40%,70%);}/*!sc*/
.bnCoiE .token.regex,.bnCoiE .token.important{color:#e90;}/*!sc*/
.bnCoiE .token.important,.bnCoiE .token.bold{font-weight:bold;}/*!sc*/
.bnCoiE .token.italic{font-style:italic;}/*!sc*/
.bnCoiE .token.entity{cursor:help;}/*!sc*/
.bnCoiE .token.deleted{color:red;}/*!sc*/
data-styled.g49[id="sc-jNnpgg"]{content:"bnCoiE,"}/*!sc*/
.dkqrXs{font-family:Courier,monospace;font-size:13px;overflow-x:auto;margin:0;white-space:pre;}/*!sc*/
data-styled.g50[id="sc-dPaNzc"]{content:"dkqrXs,"}/*!sc*/
.ps{overflow:hidden !important;overflow-anchor:none;-ms-overflow-style:none;touch-action:auto;-ms-touch-action:auto;}/*!sc*/
.ps__rail-x{display:none;opacity:0;-webkit-transition:background-color .2s linear,opacity .2s linear;transition:background-color .2s linear,opacity .2s linear;-webkit-transition:background-color .2s linear,opacity .2s linear;height:15px;bottom:0px;position:absolute;}/*!sc*/
.ps__rail-y{display:none;opacity:0;-webkit-transition:background-color .2s linear,opacity .2s linear;transition:background-color .2s linear,opacity .2s linear;-webkit-transition:background-color .2s linear,opacity .2s linear;width:15px;right:0;position:absolute;}/*!sc*/
.ps--active-x > .ps__rail-x,.ps--active-y > .ps__rail-y{display:block;background-color:transparent;}/*!sc*/
.ps:hover > .ps__rail-x,.ps:hover > .ps__rail-y,.ps--focus > .ps__rail-x,.ps--focus > .ps__rail-y,.ps--scrolling-x > .ps__rail-x,.ps--scrolling-y > .ps__rail-y{opacity:0.6;}/*!sc*/
.ps .ps__rail-x:hover,.ps .ps__rail-y:hover,.ps .ps__rail-x:focus,.ps .ps__rail-y:focus,.ps .ps__rail-x.ps--clicking,.ps .ps__rail-y.ps--clicking{background-color:#eee;opacity:0.9;}/*!sc*/
.ps__thumb-x{background-color:#aaa;border-radius:6px;-webkit-transition:background-color .2s linear,height .2s ease-in-out;transition:background-color .2s linear,height .2s ease-in-out;-webkit-transition:background-color .2s linear,height .2s ease-in-out;height:6px;bottom:2px;position:absolute;}/*!sc*/
.ps__thumb-y{background-color:#aaa;border-radius:6px;-webkit-transition:background-color .2s linear,width .2s ease-in-out;transition:background-color .2s linear,width .2s ease-in-out;-webkit-transition:background-color .2s linear,width .2s ease-in-out;width:6px;right:2px;position:absolute;}/*!sc*/
.ps__rail-x:hover > .ps__thumb-x,.ps__rail-x:focus > .ps__thumb-x,.ps__rail-x.ps--clicking .ps__thumb-x{background-color:#999;height:11px;}/*!sc*/
.ps__rail-y:hover > .ps__thumb-y,.ps__rail-y:focus > .ps__thumb-y,.ps__rail-y.ps--clicking .ps__thumb-y{background-color:#999;width:11px;}/*!sc*/
@supports (-ms-overflow-style:none){.ps{overflow:auto !important;}}/*!sc*/
@media screen and (-ms-high-contrast:active),(-ms-high-contrast:none){.ps{overflow:auto !important;}}/*!sc*/
data-styled.g51[id="sc-global-kjwiXH1"]{content:"sc-global-kjwiXH1,"}/*!sc*/
.bIbZvd{position:relative;}/*!sc*/
data-styled.g52[id="sc-bBjRSN"]{content:"bIbZvd,"}/*!sc*/
.bHzJuy{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
.bHzJuy p:last-child{margin-bottom:0;}/*!sc*/
.bHzJuy h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
.bHzJuy h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
.bHzJuy code{color:#e53935;background-color:rgba(38,50,56,0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38,50,56,0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
.bHzJuy pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0px;border:1px solid rgba(38,50,56,0.1);}/*!sc*/
.bHzJuy pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
.bHzJuy pre code:before,.bHzJuy pre code:after{content:none;}/*!sc*/
.bHzJuy blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
.bHzJuy img{max-width:100%;box-sizing:content-box;}/*!sc*/
.bHzJuy ul,.bHzJuy ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
.bHzJuy ul ul,.bHzJuy ol ul,.bHzJuy ul ol,.bHzJuy ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
.bHzJuy table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
.bHzJuy table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
.bHzJuy table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
.bHzJuy table th,.bHzJuy table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
.bHzJuy table th{text-align:left;font-weight:bold;}/*!sc*/
.bHzJuy .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.bHzJuy .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
.bHzJuy h1:hover > .share-link::before,.bHzJuy h2:hover > .share-link::before,.bHzJuy .share-link:hover::before{visibility:visible;}/*!sc*/
.bHzJuy a{-webkit-text-decoration:none;text-decoration:none;color:#32329f;}/*!sc*/
.bHzJuy a:visited{color:#32329f;}/*!sc*/
.bHzJuy a:hover{color:#6868cf;}/*!sc*/
.cJyzuM{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
.cJyzuM p:last-child{margin-bottom:0;}/*!sc*/
.cJyzuM p:first-child{margin-top:0;}/*!sc*/
.cJyzuM p:last-child{margin-bottom:0;}/*!sc*/
.cJyzuM h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
.cJyzuM h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
.cJyzuM code{color:#e53935;background-color:rgba(38,50,56,0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38,50,56,0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
.cJyzuM pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0px;border:1px solid rgba(38,50,56,0.1);}/*!sc*/
.cJyzuM pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
.cJyzuM pre code:before,.cJyzuM pre code:after{content:none;}/*!sc*/
.cJyzuM blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
.cJyzuM img{max-width:100%;box-sizing:content-box;}/*!sc*/
.cJyzuM ul,.cJyzuM ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
.cJyzuM ul ul,.cJyzuM ol ul,.cJyzuM ul ol,.cJyzuM ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
.cJyzuM table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
.cJyzuM table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
.cJyzuM table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
.cJyzuM table th,.cJyzuM table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
.cJyzuM table th{text-align:left;font-weight:bold;}/*!sc*/
.cJyzuM .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.cJyzuM .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
.cJyzuM h1:hover > .share-link::before,.cJyzuM h2:hover > .share-link::before,.cJyzuM .share-link:hover::before{visibility:visible;}/*!sc*/
.cJyzuM a{-webkit-text-decoration:none;text-decoration:none;color:#32329f;}/*!sc*/
.cJyzuM a:visited{color:#32329f;}/*!sc*/
.cJyzuM a:hover{color:#6868cf;}/*!sc*/
data-styled.g53[id="sc-cOifOu"]{content:"bHzJuy,cJyzuM,"}/*!sc*/
.dXjyFC{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
.dXjyFC p:last-child{margin-bottom:0;}/*!sc*/
.dXjyFC p:first-child{margin-top:0;}/*!sc*/
.dXjyFC p:last-child{margin-bottom:0;}/*!sc*/
.dXjyFC p{display:inline-block;}/*!sc*/
.dXjyFC h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
.dXjyFC h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
.dXjyFC code{color:#e53935;background-color:rgba(38,50,56,0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38,50,56,0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
.dXjyFC pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0px;border:1px solid rgba(38,50,56,0.1);}/*!sc*/
.dXjyFC pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
.dXjyFC pre code:before,.dXjyFC pre code:after{content:none;}/*!sc*/
.dXjyFC blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
.dXjyFC img{max-width:100%;box-sizing:content-box;}/*!sc*/
.dXjyFC ul,.dXjyFC ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
.dXjyFC ul ul,.dXjyFC ol ul,.dXjyFC ul ol,.dXjyFC ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
.dXjyFC table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
.dXjyFC table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
.dXjyFC table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
.dXjyFC table th,.dXjyFC table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
.dXjyFC table th{text-align:left;font-weight:bold;}/*!sc*/
.dXjyFC .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.dXjyFC .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
.dXjyFC h1:hover > .share-link::before,.dXjyFC h2:hover > .share-link::before,.dXjyFC .share-link:hover::before{visibility:visible;}/*!sc*/
.dXjyFC a{-webkit-text-decoration:none;text-decoration:none;color:#32329f;}/*!sc*/
.dXjyFC a:visited{color:#32329f;}/*!sc*/
.dXjyFC a:hover{color:#6868cf;}/*!sc*/
data-styled.g54[id="sc-Arkif"]{content:"dXjyFC,"}/*!sc*/
.llGFDD{position:relative;}/*!sc*/
data-styled.g55[id="sc-khIgEk"]{content:"llGFDD,"}/*!sc*/
.cVHUjN:hover > .sc-efHYUO{opacity:1;}/*!sc*/
data-styled.g60[id="sc-iNiQyp"]{content:"cVHUjN,"}/*!sc*/
.fqzhkP{font-family:Courier,monospace;font-size:13px;white-space:pre;contain:content;overflow-x:auto;}/*!sc*/
.fqzhkP .redoc-json code > .collapser{display:none;pointer-events:none;}/*!sc*/
.fqzhkP .callback-function{color:gray;}/*!sc*/
.fqzhkP .collapser:after{content:'-';cursor:pointer;}/*!sc*/
.fqzhkP .collapsed > .collapser:after{content:'+';cursor:pointer;}/*!sc*/
.fqzhkP .ellipsis:after{content:' … ';}/*!sc*/
.fqzhkP .collapsible{margin-left:2em;}/*!sc*/
.fqzhkP .hoverable{padding-top:1px;padding-bottom:1px;padding-left:2px;padding-right:2px;border-radius:2px;}/*!sc*/
.fqzhkP .hovered{background-color:rgba(235,238,249,1);}/*!sc*/
.fqzhkP .collapser{background-color:transparent;border:0;color:#fff;font-family:Courier,monospace;font-size:13px;padding-right:6px;padding-left:6px;padding-top:0;padding-bottom:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;width:15px;height:15px;position:absolute;top:4px;left:-1.5em;cursor:default;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-user-select:none;padding:2px;}/*!sc*/
.fqzhkP .collapser:focus{outline-color:#fff;outline-style:dotted;outline-width:1px;}/*!sc*/
.fqzhkP ul{list-style-type:none;padding:0px;margin:0px 0px 0px 26px;}/*!sc*/
.fqzhkP li{position:relative;display:block;}/*!sc*/
.fqzhkP .hoverable{display:inline-block;}/*!sc*/
.fqzhkP .selected{outline-style:solid;outline-width:1px;outline-style:dotted;}/*!sc*/
.fqzhkP .collapsed > .collapsible{display:none;}/*!sc*/
.fqzhkP .ellipsis{display:none;}/*!sc*/
.fqzhkP .collapsed > .ellipsis{display:inherit;}/*!sc*/
data-styled.g61[id="sc-jffHpj"]{content:"fqzhkP,"}/*!sc*/
.jzRrfm{padding:0.9em;background-color:rgba(38,50,56,0.4);margin:0 0 10px 0;display:block;font-family:Montserrat,sans-serif;font-size:0.929em;line-height:1.5em;}/*!sc*/
data-styled.g62[id="sc-eJocfa"]{content:"jzRrfm,"}/*!sc*/
.bmwRob{font-family:Montserrat,sans-serif;font-size:12px;position:absolute;z-index:1;top:-11px;left:12px;font-weight:600;color:rgba(255,255,255,0.7);}/*!sc*/
data-styled.g63[id="sc-oeezt"]{content:"bmwRob,"}/*!sc*/
.lhdonw{position:relative;}/*!sc*/
data-styled.g64[id="sc-hhIiOg"]{content:"lhdonw,"}/*!sc*/
.hINeXe{margin-top:15px;}/*!sc*/
data-styled.g67[id="sc-gGLxEB"]{content:"hINeXe,"}/*!sc*/
.CMpTe{vertical-align:middle;font-size:13px;line-height:20px;}/*!sc*/
data-styled.g69[id="sc-fbIWvP"]{content:"CMpTe,"}/*!sc*/
.bBFKjV{color:rgba(102,102,102,0.9);}/*!sc*/
data-styled.g70[id="sc-FRrlG"]{content:"bBFKjV,"}/*!sc*/
.gJKPGC{color:#666;}/*!sc*/
data-styled.g71[id="sc-fXazdy"]{content:"gJKPGC,"}/*!sc*/
.spbic{color:#666;word-break:break-word;}/*!sc*/
data-styled.g72[id="sc-dvXYtj"]{content:"spbic,"}/*!sc*/
.hUSnpT{vertical-align:middle;font-size:13px;line-height:20px;}/*!sc*/
data-styled.g73[id="sc-TtZnY"]{content:"hUSnpT,"}/*!sc*/
.bsGeIE{color:#d41f1c;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}/*!sc*/
data-styled.g74[id="sc-jHNicF"]{content:"bsGeIE,"}/*!sc*/
.cfctgs{border-radius:2px;background-color:rgba(51,51,51,0.05);color:rgba(51,51,51,0.9);padding:0 5px;border:1px solid rgba(51,51,51,0.1);font-family:Courier,monospace;}/*!sc*/
.sc-hmbstg + .sc-hmbstg{margin-left:0;}/*!sc*/
data-styled.g77[id="sc-hmbstg"]{content:"cfctgs,"}/*!sc*/
.ikafbi{margin-top:0;margin-bottom:0.5em;}/*!sc*/
data-styled.g87[id="sc-fcmMJX"]{content:"ikafbi,"}/*!sc*/
.ksfJAW{border:1px solid #32329f;color:#32329f;font-weight:normal;margin-left:0.5em;padding:4px 8px 4px;display:inline-block;-webkit-text-decoration:none;text-decoration:none;cursor:pointer;}/*!sc*/
data-styled.g88[id="sc-GvhzO"]{content:"ksfJAW,"}/*!sc*/
.gCgqqY::before{content:'|';display:inline-block;opacity:0.5;width:15px;text-align:center;}/*!sc*/
.gCgqqY:last-child::after{display:none;}/*!sc*/
data-styled.g89[id="sc-gsWcmt"]{content:"gCgqqY,"}/*!sc*/
.ePwgUU{overflow:hidden;}/*!sc*/
data-styled.g90[id="sc-bXexck"]{content:"ePwgUU,"}/*!sc*/
.hDhyRZ{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-wrap:wrap;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;}/*!sc*/
data-styled.g91[id="sc-eGJWMs"]{content:"hDhyRZ,"}/*!sc*/
.lkJIic{width:9ex;display:inline-block;height:13px;line-height:13px;background-color:#333;border-radius:3px;background-repeat:no-repeat;background-position:6px 4px;font-size:7px;font-family:Verdana,sans-serif;color:white;text-transform:uppercase;text-align:center;font-weight:bold;vertical-align:middle;margin-right:6px;margin-top:2px;}/*!sc*/
.lkJIic.get{background-color:#2F8132;}/*!sc*/
.lkJIic.post{background-color:#186FAF;}/*!sc*/
.lkJIic.put{background-color:#95507c;}/*!sc*/
.lkJIic.options{background-color:#947014;}/*!sc*/
.lkJIic.patch{background-color:#bf581d;}/*!sc*/
.lkJIic.delete{background-color:#cc3333;}/*!sc*/
.lkJIic.basic{background-color:#707070;}/*!sc*/
.lkJIic.link{background-color:#07818F;}/*!sc*/
.lkJIic.head{background-color:#A23DAD;}/*!sc*/
.lkJIic.hook{background-color:#32329f;}/*!sc*/
data-styled.g95[id="sc-gIvpjk"]{content:"lkJIic,"}/*!sc*/
.jxJlxZ{margin:0;padding:0;}/*!sc*/
.sc-euEtCV .sc-euEtCV{font-size:0.929em;}/*!sc*/
.gaEEuU{margin:0;padding:0;display:none;}/*!sc*/
.sc-euEtCV .sc-euEtCV{font-size:0.929em;}/*!sc*/
data-styled.g96[id="sc-euEtCV"]{content:"jxJlxZ,gaEEuU,"}/*!sc*/
.cTzVOd{list-style:none inside none;overflow:hidden;text-overflow:ellipsis;padding:0;}/*!sc*/
data-styled.g97[id="sc-fHCHyC"]{content:"cTzVOd,"}/*!sc*/
.pcWDP{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;font-family:Montserrat,sans-serif;font-size:0.929em;text-transform:none;}/*!sc*/
.pcWDP:hover{color:#32329f;}/*!sc*/
.pcWDP:hover{background-color:#ededed;}/*!sc*/
.pcWDP .sc-dIsUp{height:1.5em;width:1.5em;}/*!sc*/
.pcWDP .sc-dIsUp polygon{fill:#333333;}/*!sc*/
.jolsGY{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;font-family:Montserrat,sans-serif;color:#333333;}/*!sc*/
.jolsGY:hover{background-color:#e1e1e1;}/*!sc*/
.jolsGY .sc-dIsUp{height:1.5em;width:1.5em;}/*!sc*/
.jolsGY .sc-dIsUp polygon{fill:#333333;}/*!sc*/
data-styled.g98[id="sc-dtLLSn"]{content:"pcWDP,jolsGY,"}/*!sc*/
.hHRjJL{display:inline-block;vertical-align:middle;width:auto;overflow:hidden;text-overflow:ellipsis;}/*!sc*/
.ipvKNC{display:inline-block;vertical-align:middle;width:calc(100% - 38px);overflow:hidden;text-overflow:ellipsis;}/*!sc*/
data-styled.g99[id="sc-dkQUaI"]{content:"hHRjJL,ipvKNC,"}/*!sc*/
.gKXwn{font-size:0.8em;margin-top:10px;padding:0 20px;text-align:left;opacity:0.7;}/*!sc*/
.gKXwn a,.gKXwn a:visited,.gKXwn a:hover{color:#333333 !important;border-top:1px solid #e1e1e1;padding:5px 0;display:block;}/*!sc*/
data-styled.g100[id="sc-WZYut"]{content:"gKXwn,"}/*!sc*/
.jdCbTS{cursor:pointer;position:relative;margin-bottom:5px;}/*!sc*/
data-styled.g106[id="sc-kYPZxB"]{content:"jdCbTS,"}/*!sc*/
.jRjoAh{font-family:Courier,monospace;margin-left:10px;-webkit-flex:1;-ms-flex:1;flex:1;overflow-x:hidden;text-overflow:ellipsis;}/*!sc*/
data-styled.g107[id="sc-xGAEC"]{content:"jRjoAh,"}/*!sc*/
.jnEbBv{outline:0;color:inherit;width:100%;text-align:left;cursor:pointer;padding:10px 30px 10px 20px;border-radius:4px 4px 0 0;background-color:#11171a;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;white-space:nowrap;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;border:1px solid transparent;border-bottom:0;-webkit-transition:border-color 0.25s ease;transition:border-color 0.25s ease;}/*!sc*/
.jnEbBv ..sc-xGAEC{color:#ffffff;}/*!sc*/
.jnEbBv:focus{box-shadow:inset 0 2px 2px rgba(0,0,0,0.45),0 2px 0 rgba(128,128,128,0.25);}/*!sc*/
data-styled.g108[id="sc-dWBRfb"]{content:"jnEbBv,"}/*!sc*/
.bXnXQF{font-size:0.929em;line-height:20px;background-color:#186FAF;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
.cAOCuf{font-size:0.929em;line-height:20px;background-color:#2F8132;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
.iZkjfb{font-size:0.929em;line-height:20px;background-color:#bf581d;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
.gemyvL{font-size:0.929em;line-height:20px;background-color:#cc3333;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
data-styled.g109[id="sc-jHcXXw"]{content:"bXnXQF,cAOCuf,iZkjfb,gemyvL,"}/*!sc*/
.gBwOdz{position:absolute;width:100%;z-index:100;background:#fafafa;color:#263238;box-sizing:border-box;box-shadow:0px 0px 6px rgba(0,0,0,0.33);overflow:hidden;border-bottom-left-radius:4px;border-bottom-right-radius:4px;-webkit-transition:all 0.25s ease;transition:all 0.25s ease;visibility:hidden;-webkit-transform:translateY(-50%) scaleY(0);-ms-transform:translateY(-50%) scaleY(0);transform:translateY(-50%) scaleY(0);}/*!sc*/
data-styled.g110[id="sc-bQCEYZ"]{content:"gBwOdz,"}/*!sc*/
.fKFAhr{padding:10px;}/*!sc*/
data-styled.g111[id="sc-fXgAZx"]{content:"fKFAhr,"}/*!sc*/
.gjiGnZ{padding:5px;border:1px solid #ccc;background:#fff;word-break:break-all;color:#32329f;}/*!sc*/
.gjiGnZ > span{color:#333333;}/*!sc*/
data-styled.g112[id="sc-EZqKI"]{content:"gjiGnZ,"}/*!sc*/
.bCvCHz{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;background-color:#f2f2f2;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);}/*!sc*/
.bCvCHz:focus{outline:auto;outline-color:#1d8127;}/*!sc*/
.gkwAYh{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;background-color:#f2f2f2;cursor:pointer;color:#d41f1c;background-color:rgba(212,31,28,0.07);}/*!sc*/
.gkwAYh:focus{outline:auto;outline-color:#d41f1c;}/*!sc*/
data-styled.g113[id="sc-jXcxbT"]{content:"bCvCHz,gkwAYh,"}/*!sc*/
.jSPrUM{vertical-align:top;}/*!sc*/
data-styled.g117[id="sc-jlZJtj"]{content:"jSPrUM,"}/*!sc*/
.efuQZt{font-size:1.3em;padding:0.2em 0;margin:3em 0 1.1em;color:#333333;font-weight:normal;}/*!sc*/
data-styled.g118[id="sc-dTSzeu"]{content:"efuQZt,"}/*!sc*/
.ikavEm:after{content:' AND ';font-weight:bold;}/*!sc*/
.ikavEm:last-child:after{content:none;}/*!sc*/
.ikavEm a{-webkit-text-decoration:none;text-decoration:none;color:#32329f;}/*!sc*/
.ikavEm a:visited{color:#32329f;}/*!sc*/
.ikavEm a:hover{color:#6868cf;}/*!sc*/
data-styled.g120[id="sc-cbeScs"]{content:"ikavEm,"}/*!sc*/
.fguZND:before{content:'( ';font-weight:bold;}/*!sc*/
.fguZND:after{content:' ) OR ';font-weight:bold;}/*!sc*/
.fguZND:last-child:after{content:' )';}/*!sc*/
.fguZND:only-child:before,.fguZND:only-child:after{content:none;}/*!sc*/
.fguZND a{-webkit-text-decoration:none;text-decoration:none;color:#32329f;}/*!sc*/
.fguZND a:visited{color:#32329f;}/*!sc*/
.fguZND a:hover{color:#6868cf;}/*!sc*/
data-styled.g121[id="sc-hkeOVe"]{content:"fguZND,"}/*!sc*/
.cuYWRV{-webkit-flex:1 1 auto;-ms-flex:1 1 auto;flex:1 1 auto;}/*!sc*/
data-styled.g122[id="sc-gVFcvn"]{content:"cuYWRV,"}/*!sc*/
.bwNcZa{width:75%;}/*!sc*/
@media screen and (max-width:50rem){.bwNcZa{margin-top:10px;}}/*!sc*/
data-styled.g123[id="sc-fWWYYk"]{content:"bwNcZa,"}/*!sc*/
.kZsYIY{display:inline-block;margin:0;}/*!sc*/
data-styled.g124[id="sc-fIxmyt"]{content:"kZsYIY,"}/*!sc*/
.iEcHcE{width:100%;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;margin:1em 0;}/*!sc*/
@media screen and (max-width:50rem){.iEcHcE{-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;}}/*!sc*/
data-styled.g125[id="sc-gzcbmu"]{content:"iEcHcE,"}/*!sc*/
.kBgcMI{-webkit-backface-visibility:hidden;backface-visibility:hidden;contain:content;overflow:hidden;}/*!sc*/
data-styled.g130[id="sc-irKDMX"]{content:"kBgcMI,"}/*!sc*/
.eUdCtG{margin-bottom:30px;}/*!sc*/
data-styled.g131[id="sc-eWnToP"]{content:"eUdCtG,"}/*!sc*/
.dzKtIW{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;width:20px;height:20px;-webkit-align-self:center;-ms-flex-item-align:center;align-self:center;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;color:#32329f;}/*!sc*/
data-styled.g132[id="sc-kTCsyW"]{content:"dzKtIW,"}/*!sc*/
.gAerEa{width:260px;background-color:#fafafa;overflow:hidden;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;-webkit-backface-visibility:hidden;backface-visibility:hidden;height:100vh;position:-webkit-sticky;position:sticky;position:-webkit-sticky;top:0;}/*!sc*/
@media screen and (max-width:50rem){.gAerEa{position:fixed;z-index:20;width:100%;background:#fafafa;display:none;}}/*!sc*/
@media print{.gAerEa{display:none;}}/*!sc*/
data-styled.g133[id="sc-dvUynV"]{content:"gAerEa,"}/*!sc*/
.bymHyU{outline:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;background-color:#f2f2f2;color:#32329f;display:none;cursor:pointer;position:fixed;right:20px;z-index:100;border-radius:50%;box-shadow:0 0 20px rgba(0,0,0,0.3);bottom:44px;width:60px;height:60px;padding:0 20px;}/*!sc*/
@media screen and (max-width:50rem){.bymHyU{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;}}/*!sc*/
@media print{.bymHyU{display:none;}}/*!sc*/
data-styled.g134[id="sc-jtiXyc"]{content:"bymHyU,"}/*!sc*/
.bwfRit{font-family:Roboto,sans-serif;font-size:14px;font-weight:400;line-height:1.5em;color:#333333;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;position:relative;text-align:left;-webkit-font-smoothing:antialiased;font-smoothing:antialiased;text-rendering:optimizeSpeed !important;tap-highlight-color:rgba(0,0,0,0);-webkit-text-size-adjust:100%;text-size-adjust:100%;}/*!sc*/
.bwfRit *{box-sizing:border-box;-webkit-tap-highlight-color:rgba(255,255,255,0);}/*!sc*/
data-styled.g135[id="sc-ellfGf"]{content:"bwfRit,"}/*!sc*/
.eWToXe{z-index:1;position:relative;overflow:hidden;width:calc(100% - 260px);contain:layout;}/*!sc*/
@media print,screen and (max-width:50rem){.eWToXe{width:100%;}}/*!sc*/
data-styled.g136[id="sc-kizEQm"]{content:"eWToXe,"}/*!sc*/
.gBTuHc{background:#263238;position:absolute;top:0;bottom:0;right:0;width:calc((100% - 260px) * 0.4);}/*!sc*/
@media print,screen and (max-width:75rem){.gBTuHc{display:none;}}/*!sc*/
data-styled.g137[id="sc-cKRKFl"]{content:"gBTuHc,"}/*!sc*/
.fQwboL{padding:5px 0;}/*!sc*/
data-styled.g138[id="sc-iIgjPs"]{content:"fQwboL,"}/*!sc*/
.gPCWYe{width:calc(100% - 40px);box-sizing:border-box;margin:0 20px;padding:5px 10px 5px 20px;border:0;border-bottom:1px solid #e1e1e1;font-family:Roboto,sans-serif;font-weight:bold;font-size:13px;color:#333333;background-color:transparent;outline:none;}/*!sc*/
data-styled.g139[id="sc-gstuGz"]{content:"gPCWYe,"}/*!sc*/
.icZuVc{position:absolute;left:20px;height:1.8em;width:0.9em;}/*!sc*/
.icZuVc path{fill:#333333;}/*!sc*/
data-styled.g140[id="sc-amkrK"]{content:"icZuVc,"}/*!sc*/
</style>
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
</head>
<body>
<div id="redoc"><div class="sc-ellfGf bwfRit redoc-wrap"><div class="sc-dvUynV gAerEa menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-iIgjPs fQwboL"><svg class="sc-amkrK icZuVc search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input type="text" value="" placeholder="Search..." aria-label="Search" class="sc-gstuGz gPCWYe search-input"/></div><div class="sc-bBjRSN bIbZvd scrollbar-container undefined"><ul class="sc-euEtCV jxJlxZ" role="navigation"><li data-item-id="section/Streaming-Responses" class="sc-fHCHyC cTzVOd"><label type="section" role="menuitem" class="sc-dtLLSn pcWDP -depth1"><span title="Streaming Responses" class="sc-dkQUaI hHRjJL">Streaming Responses</span></label></li><li data-item-id="section/Authentication" class="sc-fHCHyC cTzVOd"><label type="section" role="menuitem" class="sc-dtLLSn pcWDP -depth1"><span title="Authentication" class="sc-dkQUaI hHRjJL">Authentication</span></label></li><li data-item-id="tag/members" class="sc-fHCHyC cTzVOd"><label type="tag" role="menuitem" class="sc-dtLLSn pcWDP -depth1"><span title="members" class="sc-dkQUaI hHRjJL">members</span><svg class="sc-dIsUp gmNZmS" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-euEtCV gaEEuU"><li data-item-id="tag/members/paths/~1members/post" class="sc-fHCHyC cTzVOd"><label role="menuitem" class="sc-dtLLSn jolsGY -depth2"><span type="post" class="sc-gIvpjk lkJIic operation-type post">post</span><span width="calc(100% - 38px)" class="sc-dkQUaI ipvKNC">Create a new user</span></label></li><li data-item-id="tag/members/paths/~1members~1{username}/get" class="sc-fHCHyC cTzVOd"><label role="menuitem" class="sc-dtLLSn jolsGY -depth2"><span type="get" class="sc-gIvpjk lkJIic operation-type get">get</span><span width="calc(100% - 38px)" class="sc-dkQUaI ipvKNC">Get information about a user</span></label></li><li data-item-id="tag/members/paths/~1members~1{username}/patch" class="sc-fHCHyC cTzVOd"><label role="menuitem" class="sc-dtLLSn jolsGY -depth2"><span type="patch" class="sc-gIvpjk lkJIic operation-type patch">patch</span><span width="calc(100% - 38px)" class="sc-dkQUaI ipvKNC">Modify a user</span></label></li><li data-item-id="tag/members/paths/~1members~1{username}~1renew/post" class="sc-fHCHyC cTzVOd"><label role="menuitem" class="sc-dtLLSn jolsGY -depth2"><span type="post" class="sc-gIvpjk lkJIic operation-type post">post</span><span width="calc(100% - 38px)" class="sc-dkQUaI ipvKNC">Renew a user</span></label></li><li data-item-id="tag/members/paths/~1members~1{username}~1pwreset/post" class="sc-fHCHyC cTzVOd"><label role="menuitem" class="sc-dtLLSn jolsGY -depth2"><span type="post" class="sc-gIvpjk lkJIic operation-type post">post</span><span width="calc(100% - 38px)" class="sc-dkQUaI ipvKNC">Reset a user&#x27;s password</span></label></li></ul></li><li data-item-id="tag/groups" class="sc-fHCHyC cTzVOd"><label type="tag" role="menuitem" class="sc-dtLLSn pcWDP -depth1"><span title="groups" class="sc-dkQUaI hHRjJL">groups</span><svg class="sc-dIsUp gmNZmS" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-euEtCV gaEEuU"><li data-item-id="tag/groups/paths/~1groups/post" class="sc-fHCHyC cTzVOd"><label role="menuitem" class="sc-dtLLSn jolsGY -depth2"><span type="post" class="sc-gIvpjk lkJIic operation-type post">post</span><span width="calc(100% - 38px)" class="sc-d
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
-174.68583 0.6895,0 26.281,25.03215 56.8701,
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
-104.0616 -231.873,-231.248 z
" fill="currentColor"></path></g></svg><svg class="" style="transform:translate(2px, 4px);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
-174.68583 0.6895,0 26.281,25.03215 56.8701,
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
-104.0616 -231.873,-231.248 z
" fill="currentColor"></path></g></svg></div></div><div class="sc-kizEQm eWToXe api-content"><div class="sc-eCApnc fxZJZV"><div class="sc-iCoGMd KWWXd"><div class="sc-hKFxyN egQuEZ api-info"><h1 class="sc-fujyAs sc-fcmMJX cTueGk ikafbi">ceod - OpenAPI 3.0<!-- --> <span>(<!-- -->1.0.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="swagger.json" target="_blank" class="sc-GvhzO ksfJAW">Download</a></p><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><div class="sc-bXexck ePwgUU"><div class="sc-eGJWMs hDhyRZ"><span class="sc-gsWcmt gCgqqY">E-mail<!-- -->:<!-- --> <a href="mailto:syscom@csclub.uwaterloo.ca">syscom@csclub.uwaterloo.ca</a></span> <!-- --> <!-- --> </div></div></div><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy" data-role="redoc-summary"></div><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy" data-role="redoc-description"><p>This is an OpenAPI specification of ceod, the CSC Electronic Office daemon.
Visit the <a href="https://git.csclub.uwaterloo.ca/public/pyceo">git repository</a> for
more details.</p>
</div></div></div></div><div id="section/Streaming-Responses" data-section-id="section/Streaming-Responses" class="sc-eCApnc fxZJZV"><div class="sc-iCoGMd KWWXd"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#section/Streaming-Responses" aria-label="section/Streaming-Responses"></a>Streaming Responses</h2></div></div><div class="sc-hKFxyN dmghQN"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy redoc-markdown "><p>Many endpoints return a &quot;streaming response&quot;, which consists of a series of JSON
objects, one per line (the mimetype is text/plain). For example:</p>
<pre><code><span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"replace_login_shell"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"replace_forwarding_addresses"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"completed"</span><span class="token punctuation">,</span> <span class="token string">"result"</span><span class="token punctuation">:</span> <span class="token string">"OK"</span><span class="token punctuation">}</span></code></pre><p>Whenever an operation is completed, a corresponding JSON object will be streamed
from the server to the client. This allows the client to track the server&#39;s progress
in real time.</p>
</div></div></div><div id="section/Authentication" data-section-id="section/Authentication" class="sc-eCApnc fxZJZV"><div class="sc-iCoGMd KWWXd"><div class="sc-hKFxyN egQuEZ"><h1 class="sc-fujyAs cTueGk"><a class="sc-crzoAE iUxAWq" href="#section/Authentication" aria-label="section/Authentication"></a>Authentication</h1></div></div><div id="section/Authentication/GSSAPIAuth" data-section-id="section/Authentication/GSSAPIAuth" class="sc-eCApnc fxZJZV"><div class="sc-iCoGMd KWWXd"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth"></a>GSSAPIAuth</h2><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>ceod uses SPNEGO-based authentication over HTTP, as specified in <a href="https://datatracker.ietf.org/doc/html/rfc4559">RFC 4559</a>.
It is basically a base64-encoded Kerberos ticket wrapped in a HTTP header. For endpoints which make modifications
to LDAP, the Delegate flag must also be set.</p>
<p>For example, with cURL:</p>
<pre><code class="language-sh">kinit
curl <span class="token operator">--</span>negotiate <span class="token operator">-</span>u <span class="token punctuation">:</span> <span class="token operator">--</span>service<span class="token operator">-</span>name ceod <span class="token operator">--</span>delegation always <span class="token operator">-</span>X POST <span class="token operator">-</span>d <span class="token string">'{"terms":["w2022"]}'</span> https<span class="token punctuation">:</span><span class="token operator">/</span><span class="token operator">/</span>phosphoric<span class="token operator">-</span>acid<span class="token punctuation">.</span>csclub<span class="token punctuation">.</span>uwaterloo<span class="token punctuation">.</span>ca<span class="token operator">/</span>api<span class="token operator">/</span>members<span class="token operator">/</span>ctdalek<span class="token operator">/</span>renew</code></pre>
</div><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><table class="security-details"><tbody><tr><th> Security Scheme Type </th><td> <!-- -->HTTP<!-- --> </td></tr><tr><th> HTTP Authorization Scheme </th><td> <!-- -->negotiate<!-- --> </td></tr></tbody></table></div></div></div></div></div><div id="tag/members" data-section-id="tag/members" class="sc-eCApnc fxZJZV"><div class="sc-iCoGMd KWWXd"><div class="sc-hKFxyN egQuEZ"><h1 class="sc-fujyAs cTueGk"><a class="sc-crzoAE iUxAWq" href="#tag/members" aria-label="tag/members"></a>members</h1></div></div><div class="sc-hKFxyN dmghQN"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy redoc-markdown "><p>Operations on members and club reps</p>
</div></div></div><div id="tag/members/paths/~1members/post" data-section-id="tag/members/paths/~1members/post" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/members/paths/~1members/post" aria-label="tag/members/paths/~1members/post"></a>Create a new user<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Creates a new member or club rep. If <code>terms</code> is specified, a member is created; if <code>non_member_terms</code> is specified, a club rep is created.</p>
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-jcwpoC joKODG">application/json</span></h5><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"></div><table class="sc-hHEiqL dYlGyN"><tbody><tr><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="uid"><span class="sc-iemWCZ bcnRwz"></span><span>uid</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span><span class="sc-fbIWvP sc-dvXYtj CMpTe spbic"> (<!-- -->UID<!-- -->) </span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>Username</p>
</div></div></div></td></tr><tr><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="cn"><span class="sc-iemWCZ bcnRwz"></span><span>cn</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span><span class="sc-fbIWvP sc-dvXYtj CMpTe spbic"> (<!-- -->UserCN<!-- -->) </span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>Full name</p>
</div></div></div></td></tr><tr><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="sn"><span class="sc-iemWCZ bcnRwz"></span><span>sn</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span><span class="sc-fbIWvP sc-dvXYtj CMpTe spbic"> (<!-- -->UserSN<!-- -->) </span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>Last name</p>
</div></div></div></td></tr><tr><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="given_name"><span class="sc-iemWCZ bcnRwz"></span><span>given_name</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span><span class="sc-fbIWvP sc-dvXYtj CMpTe spbic"> (<!-- -->UserGivenName<!-- -->) </span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>First name</p>
</div></div></div></td></tr><tr><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="program"><span class="sc-iemWCZ bcnRwz"></span><span>program</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span><span class="sc-fbIWvP sc-dvXYtj CMpTe spbic"> (<!-- -->Program<!-- -->) </span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>Academic program</p>
</div></div></div></td></tr><tr><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="terms"><span class="sc-iemWCZ bcnRwz"></span><span>terms</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV">Array of </span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">strings</span><span class="sc-fbIWvP sc-dvXYtj CMpTe spbic"> (<!-- -->Terms<!-- -->) </span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>Terms for which this user was a member</p>
</div></div></div></td></tr><tr><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="non_member_terms"><span class="sc-iemWCZ bcnRwz"></span><span>non_member_terms</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV">Array of </span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">strings</span><span class="sc-fbIWvP sc-dvXYtj CMpTe spbic"> (<!-- -->NonMemberTerms<!-- -->) </span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>Terms for which this user was a club rep</p>
</div></div></div></td></tr><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="forwarding_addresses"><span class="sc-iemWCZ bcnRwz"></span><span>forwarding_addresses</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV">Array of </span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">strings</span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC"> <!-- -->&lt;<!-- -->email<!-- -->&gt;<!-- --> </span><span class="sc-fbIWvP sc-dvXYtj CMpTe spbic"> (<!-- -->ForwardingAddresses<!-- -->) </span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>Forwarding addresses in ~/.forward</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="post" class="sc-jHcXXw bXnXQF http-verb post">post</span><span class="sc-xGAEC jRjoAh">/members</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://phosphoric-acid.csclub.uwaterloo.ca:9987/api</span>/members</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-0" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1" aria-labelledby="react-tabs-0"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"uid"</span>: <span class="token string">&quot;ctdalek&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cn"</span>: <span class="token string">&quot;Calum Dalek&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sn"</span>: <span class="token string">&quot;Dalek&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"given_name"</span>: <span class="token string">&quot;Calum&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"program"</span>: <span class="token string">&quot;MAT/Mathematics Computer Science&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"terms"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">&quot;f2021&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"non_member_terms"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">&quot;f2021&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forwarding_addresses"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">&quot;ctdalek@uwaterloo.ca&quot;</span></div></li></ul><span class="token punctuation
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"add_group_to_ldap"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"add_user_to_kerberos"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"create_home_dir"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"send_welcome_message"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"subscribe_to_mailing_list"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"announce_new_user"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"completed"</span><span class="token punctuation">,</span> <span class="token string">"result"</span><span class="token punctuation">:</span> <span class="token punctuation">{</span><span class="token string">"cn"</span><span class="token punctuation">:</span> <span class="token string">"Calum Dalek"</span><span class="token punctuation">,</span> <span class="token string">"given_name"</span><span class="token punctuation">:</span> <span class="token string">"Calum"</span><span class="token punctuation">,</span> <span class="token string">"sn"</span><span class="token punctuation">:</span> <span class="token string">"Dalek"</span><span class="token punctuation">,</span> <span class="token string">"uid"</span><span class="token punctuation">:</span> <span class="token string">"ctdalek"</span><span class="token punctuation">,</span> <span class="token string">"uid_number"</span><span class="token punctuation">:</span> <span class="token number">20001</span><span class="token punctuation">,</span> <span class="token string">"gid_number"</span><span class="token punctuation">:</span> <span class="token number">20001</span><span class="token punctuation">,</span> <span class="token string">"login_shell"</span><span class="token punctuation">:</span> <span class="token string">"/bin/bash"</span><span class="token punctuation">,</span> <span class="token string">"home_directory"</span><span class="token punctuation">:</span> <span class="token string">"/users/ctdalek"</span><span class="token punctuation">,</span> <span class="token string">"is_club"</span><span class="token punctuation">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token string">"program"</span><span class="token punctuation">:</span> <span class="token string">"MAT/Mathematics Computer Science"</span><span class="token punctuation">,</span> <span class="token string">"terms"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token string">"f2021"</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token string">"forwarding_addresses"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token string">"ctdalek@uwaterloo.ca"</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token string">"password"</span><span class="token punctuation">:</span> <span class="token string">"Wlw1wOTofERTEBlXWzR6/MZL"</span><span class="token punctuation">}</span><span class="token punctuation">}</span>
</pre></div></div></div></div></div></div></div></div></div><div id="tag/members/paths/~1members~1{username}/get" data-section-id="tag/members/paths/~1members~1{username}/get" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/members/paths/~1members~1{username}/get" aria-label="tag/members/paths/~1members~1{username}/get"></a>Get information about a user<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Returns information about a member or club rep. The <code>forwarding_addresses</code> field will only be present if the client is an authenticated syscom member.</p>
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="username"><span class="sc-iemWCZ bcnRwz"></span><span>username</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>username of the user to return</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">404<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>User not found</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="get" class="sc-jHcXXw cAOCuf http-verb get">get</span><span class="sc-xGAEC jRjoAh">/members/{username}</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://phosphoric-acid.csclub.uwaterloo.ca:9987/api</span>/members/{username}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-4" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-5" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-6" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-7">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-5" aria-labelledby="react-tabs-4"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cn"</span>: <span class="token string">&quot;Calum Dalek&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sn"</span>: <span class="token string">&quot;Dalek&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"given_name"</span>: <span class="token string">&quot;Calum&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uid"</span>: <span class="token string">&quot;ctdalek&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uid_number"</span>: <span class="token number">20001</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"gid_number"</span>: <span class="token number">20001</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"home_directory"</span>: <span class="token string">&quot;/users/ctdalek&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_club"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"login_shell"</span>: <span class="token string">&quot;/bin/bash&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"program"</span>: <span class="token string">&quot;MAT/Mathematics Computer Science&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"positions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul cl
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="username"><span class="sc-iemWCZ bcnRwz"></span><span>username</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>username of the user to modify</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-jcwpoC joKODG">application/json</span></h5><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"></div><table class="sc-hHEiqL dYlGyN"><tbody><tr><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="login_shell"><span class="sc-iemWCZ bcnRwz"></span><span>login_shell</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span><span class="sc-fbIWvP sc-dvXYtj CMpTe spbic"> (<!-- -->LoginShell<!-- -->) </span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>Login shell</p>
</div></div></div></td></tr><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="forwarding_addresses"><span class="sc-iemWCZ bcnRwz"></span><span>forwarding_addresses</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV">Array of </span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">strings</span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC"> <!-- -->&lt;<!-- -->email<!-- -->&gt;<!-- --> </span><span class="sc-fbIWvP sc-dvXYtj CMpTe spbic"> (<!-- -->ForwardingAddresses<!-- -->) </span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>Forwarding addresses in ~/.forward</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">404<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>User not found</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="patch" class="sc-jHcXXw iZkjfb http-verb patch">patch</span><span class="sc-xGAEC jRjoAh">/members/{username}</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://phosphoric-acid.csclub.uwaterloo.ca:9987/api</span>/members/{username}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-8" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-9" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-9" aria-labelledby="react-tabs-8"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"login_shell"</span>: <span class="token string">&quot;/bin/bash&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forwarding_addresses"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">&quot;ctdalek@uwaterloo.ca&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-10" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-11" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-12" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-13">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-11" aria-labelledby="react-tabs-10"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">text/plain</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-cTJkRt gEtKwR"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button></div><pre class="sc-jNnpgg sc-dPaNzc bnCoiE dkqrXs"><span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"replace_login_shell"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"replace_forwarding_addresses"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"completed"</span><span class="token punctuation">,</span> <span class="token string">"result"</span><span class="token punctuation">:</span> <span class="token string">"OK"</span><span class="token punctuation">}</span>
</pre></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-13" aria-labelledby="react-tabs-12"></div></div></div></div></div></div><div id="tag/members/paths/~1members~1{username}~1renew/post" data-section-id="tag/members/paths/~1members~1{username}~1renew/post" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/members/paths/~1members~1{username}~1renew/post" aria-label="tag/members/paths/~1members~1{username}~1renew/post"></a>Renew a user<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Add member <strong>or</strong> non-member terms to a user</p>
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="username"><span class="sc-iemWCZ bcnRwz"></span><span>username</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>username of the user to renew</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-jcwpoC joKODG">application/json</span></h5><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"></div><div><span class="sc-kfYoZR juYXUf"> <!-- -->One of<!-- --> </span><div class="sc-dlMDgC EoFth"><button class="sc-fKgJPI hyMKIl">object</button><button class="sc-fKgJPI cWoVOF">object</button></div><table class="sc-hHEiqL dYlGyN"><tbody><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="terms"><span class="sc-iemWCZ bcnRwz"></span><span>terms</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV">Array of </span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">strings</span><span class="sc-fbIWvP sc-dvXYtj CMpTe spbic"> (<!-- -->Term<!-- -->) </span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>Terms for which this user will be a member</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">404<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>User not found</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="post" class="sc-jHcXXw bXnXQF http-verb post">post</span><span class="sc-xGAEC jRjoAh">/members/{username}/renew</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://phosphoric-acid.csclub.uwaterloo.ca:9987/api</span>/members/{username}/renew</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-14" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-15" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-15" aria-labelledby="react-tabs-14"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"terms"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">&quot;f2021&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-16" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-17" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-18" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-19">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-17" aria-labelledby="react-tabs-16"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"terms_added"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">&quot;f2021&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><d
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="username"><span class="sc-iemWCZ bcnRwz"></span><span>username</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>username of the user whose password will be reset</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">404<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>User not found</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="post" class="sc-jHcXXw bXnXQF http-verb post">post</span><span class="sc-xGAEC jRjoAh">/members/{username}/pwreset</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://phosphoric-acid.csclub.uwaterloo.ca:9987/api</span>/members/{username}/pwreset</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-20" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-21" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-22" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-23">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-21" aria-labelledby="react-tabs-20"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"password"</span>: <span class="token string">&quot;EPGbJwLl1pmiWz8Wvu/MSs+v&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-23" aria-labelledby="react-tabs-22"></div></div></div></div></div></div><div id="tag/groups" data-section-id="tag/groups" class="sc-eCApnc fxZJZV"><div class="sc-iCoGMd KWWXd"><div class="sc-hKFxyN egQuEZ"><h1 class="sc-fujyAs cTueGk"><a class="sc-crzoAE iUxAWq" href="#tag/groups" aria-label="tag/groups"></a>groups</h1></div></div><div class="sc-hKFxyN dmghQN"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy redoc-markdown "><p>Operations on groups and clubs</p>
</div></div></div><div id="tag/groups/paths/~1groups/post" data-section-id="tag/groups/paths/~1groups/post" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/groups/paths/~1groups/post" aria-label="tag/groups/paths/~1groups/post"></a>Create a new group<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Creates a new Unix group for a club. A new Unix user account with the same name will also be created. A sudo role will be created allowing members of the group to become this user.</p>
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-jcwpoC joKODG">application/json</span></h5><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"></div><table class="sc-hHEiqL dYlGyN"><tbody><tr><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="cn"><span class="sc-iemWCZ bcnRwz"></span><span>cn</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span><span class="sc-fbIWvP sc-dvXYtj CMpTe spbic"> (<!-- -->GroupCN<!-- -->) </span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>the name of the group</p>
</div></div></div></td></tr><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="description"><span class="sc-iemWCZ bcnRwz"></span><span>description</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span><span class="sc-fbIWvP sc-dvXYtj CMpTe spbic"> (<!-- -->GroupDescription<!-- -->) </span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>a description of the group</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="post" class="sc-jHcXXw bXnXQF http-verb post">post</span><span class="sc-xGAEC jRjoAh">/groups</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://phosphoric-acid.csclub.uwaterloo.ca:9987/api</span>/groups</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-24" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-25" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-25" aria-labelledby="react-tabs-24"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cn"</span>: <span class="token string">&quot;uwclub1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;Club One&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-26" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-27" tabindex="0">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-27" aria-labelledby="react-tabs-26"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">text/plain</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-cTJkRt gEtKwR"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button></div><pre class="sc-jNnpgg sc-dPaNzc bnCoiE dkqrXs"><span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"add_user_to_ldap"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"add_group_to_ldap"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"add_sudo_role"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"create_home_dir"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"completed"</span><span class="token punctuation">,</span> <span class="token string">"result"</span><span class="token punctuation">:</span> <span class="token punctuation">{</span><span class="token string">"cn"</span><span class="token punctuation">:</span> <span class="token string">"uwclub1"</span><span class="token punctuation">,</span> <span class="token string">"gid_number"</span><span class="token punctuation">:</span> <span class="token number">30001</span><span class="token punctuation">,</span> <span class="token string">"description"</span><span class="token punctuation">:</span> <span class="token string">"Club One"</span><span class="token punctuation">,</span> <span class="token string">"members"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">}</span><span class="token punctuation">}</span>
</pre></div></div></div></div></div></div></div></div></div><div id="tag/groups/paths/~1groups~1{group_name}/get" data-section-id="tag/groups/paths/~1groups~1{group_name}/get" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/groups/paths/~1groups~1{group_name}/get" aria-label="tag/groups/paths/~1groups~1{group_name}/get"></a>Get information about a group<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Returns information about a group</p>
</div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="group_name"><span class="sc-iemWCZ bcnRwz"></span><span>group_name</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>name of the group to return</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">404<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Group not found</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="get" class="sc-jHcXXw cAOCuf http-verb get">get</span><span class="sc-xGAEC jRjoAh">/groups/{group_name}</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://phosphoric-acid.csclub.uwaterloo.ca:9987/api</span>/groups/{group_name}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-28" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-29" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-30" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-31">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-29" aria-labelledby="react-tabs-28"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cn"</span>: <span class="token string">&quot;uwclub1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;Club One&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"gid_number"</span>: <span class="token number">20001</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"members"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">&quot;ctdalek&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-31" aria-labelledby="react-tabs-30"></div></div></div></div></div></div><div id="tag/groups/paths/~1groups~1{group_name}~1members~1{username}/post" data-section-id="tag/groups/paths/~1groups~1{group_name}~1members~1{username}/post" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/groups/paths/~1groups~1{group_name}~1members~1{username}/post" aria-label="tag/groups/paths/~1groups~1{group_name}~1members~1{username}/post"></a>Add a member to a group<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Adds a member to a group. The member will also be added to any auxiliary groups specified in ceod.conf. The member may also be added to auxiliary mailing lists.</p>
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="group_name"><span class="sc-iemWCZ bcnRwz"></span><span>group_name</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>name of the group to which the member will be added</p>
</div></div></div></td></tr><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="username"><span class="sc-iemWCZ bcnRwz"></span><span>username</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>username of the member who will be added to the group</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="subscribe_to_lists"><span class="sc-iemWCZ bcnRwz"></span><span>subscribe_to_lists</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">boolean</span></div><div><span class="sc-fbIWvP CMpTe"> <!-- -->Default:<!-- --> </span> <span class="sc-fbIWvP sc-hmbstg CMpTe cfctgs">true</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>whether the member should be subscribed to auxiliary mailing lists</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">404<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Group not found</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="post" class="sc-jHcXXw bXnXQF http-verb post">post</span><span class="sc-xGAEC jRjoAh">/groups/{group_name}/members/{username}</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://phosphoric-acid.csclub.uwaterloo.ca:9987/api</span>/groups/{group_name}/members/{username}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-32" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-33" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-34" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-35">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-33" aria-labelledby="react-tabs-32"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">text/plain</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-cTJkRt gEtKwR"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button></div><pre class="sc-jNnpgg sc-dPaNzc bnCoiE dkqrXs"><span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"add_user_to_group"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"add_user_to_auxiliary_groups"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"subscribe_user_to_auxiliary_mailing_lists"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"completed"</span><span class="token punctuation">,</span> <span class="token string">"result"</span><span class="token punctuation">:</span> <span class="token punctuation">{</span><span class="token string">"added_to_groups"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token string">"group2"</span><span class="token punctuation">,</span><span class="token string">"group3"</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token string">"subscribed_to_lists"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token string">"list1"</span><span class="token punctuation">,</span><span class="token string">"list2"</span><span class="token punctuation">]</span><span class="token punctuation">}</span><span class="token punctuation">}</span>
</pre></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-35" aria-labelledby="react-tabs-34"></div></div></div></div></div></div><div id="tag/groups/paths/~1groups~1{group_name}~1members~1{username}/delete" data-section-id="tag/groups/paths/~1groups~1{group_name}~1members~1{username}/delete" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/groups/paths/~1groups~1{group_name}~1members~1{username}/delete" aria-label="tag/groups/paths/~1groups~1{group_name}~1members~1{username}/delete"></a>Remove a member from a group<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Removes a member from a group. The member will also be removed from any auxiliary groups specified in ceod.conf. The member may also be removed from auxiliary mailing lists.</p>
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="group_name"><span class="sc-iemWCZ bcnRwz"></span><span>group_name</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>name of the group from which the member will be removed</p>
</div></div></div></td></tr><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="username"><span class="sc-iemWCZ bcnRwz"></span><span>username</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>username of the member who will be removed from the group</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="unsubscribe_from_lists"><span class="sc-iemWCZ bcnRwz"></span><span>unsubscribe_from_lists</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">boolean</span></div><div><span class="sc-fbIWvP CMpTe"> <!-- -->Default:<!-- --> </span> <span class="sc-fbIWvP sc-hmbstg CMpTe cfctgs">true</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>whether the member should be unsubscribed from auxiliary mailing lists</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">404<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Group not found</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="delete" class="sc-jHcXXw gemyvL http-verb delete">delete</span><span class="sc-xGAEC jRjoAh">/groups/{group_name}/members/{username}</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://phosphoric-acid.csclub.uwaterloo.ca:9987/api</span>/groups/{group_name}/members/{username}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-36" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-37" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-38" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-39">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-37" aria-labelledby="react-tabs-36"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">text/plain</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-cTJkRt gEtKwR"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button></div><pre class="sc-jNnpgg sc-dPaNzc bnCoiE dkqrXs"><span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"remove_user_from_group"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"remove_user_from_auxiliary_groups"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"unsubscribe_user_from_auxiliary_mailing_lists"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"completed"</span><span class="token punctuation">,</span> <span class="token string">"result"</span><span class="token punctuation">:</span> <span class="token punctuation">{</span><span class="token string">"removed_from_groups"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token string">"group2"</span><span class="token punctuation">,</span><span class="token string">"group3"</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token string">"unsubscribed_from_lists"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token string">"list1"</span><span class="token punctuation">,</span><span class="token string">"list2"</span><span class="token punctuation">]</span><span class="token punctuation">}</span><span class="token punctuation">}</span>
</pre></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-39" aria-labelledby="react-tabs-38"></div></div></div></div></div></div><div id="tag/mailman" data-section-id="tag/mailman" class="sc-eCApnc fxZJZV"><div class="sc-iCoGMd KWWXd"><div class="sc-hKFxyN egQuEZ"><h1 class="sc-fujyAs cTueGk"><a class="sc-crzoAE iUxAWq" href="#tag/mailman" aria-label="tag/mailman"></a>mailman</h1></div></div><div class="sc-hKFxyN dmghQN"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy redoc-markdown "><p>Operations on mailing list subscriptions</p>
</div></div></div><div id="tag/mailman/paths/~1mailman~1{mailing_list}~1{username}/post" data-section-id="tag/mailman/paths/~1mailman~1{mailing_list}~1{username}/post" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/mailman/paths/~1mailman~1{mailing_list}~1{username}/post" aria-label="tag/mailman/paths/~1mailman~1{mailing_list}~1{username}/post"></a>subscribe a user to a mailing list<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Subscribes a user to a mailing list.</p>
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="mailing_list"><span class="sc-iemWCZ bcnRwz"></span><span>mailing_list</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>The name of the list to which the user will be subscribed. If there is no &#39;@&#39; symbol, then &#39;@csclub.uwaterloo.ca&#39; will be appended to the list name.</p>
</div></div></div></td></tr><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="username"><span class="sc-iemWCZ bcnRwz"></span><span>username</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>The user who will be subscribed to the list. If there is no &#39;@&#39; symbol, then &#39;@csclub.uwaterloo.ca&#39; will be appended to he username; otherwise, the given email address will be subscribed.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">404<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Mailing list does not exist</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">409<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>User is already subscribed</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="post" class="sc-jHcXXw bXnXQF http-verb post">post</span><span class="sc-xGAEC jRjoAh">/mailman/{mailing_list}/{username}</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://mail.csclub.uwaterloo.ca:9987/api</span>/mailman/{mailing_list}/{username}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-40" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-41" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-42" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-43">404</li><li class="tab-error" role="tab" id="react-tabs-44" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-45">409</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-41" aria-labelledby="react-tabs-40"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"result"</span>: <span class="token string">&quot;OK&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-43" aria-labelledby="react-tabs-42"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-45" aria-labelledby="react-tabs-44"></div></div></div></div></div></div><div id="tag/mailman/paths/~1mailman~1{mailing_list}~1{username}/delete" data-section-id="tag/mailman/paths/~1mailman~1{mailing_list}~1{username}/delete" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/mailman/paths/~1mailman~1{mailing_list}~1{username}/delete" aria-label="tag/mailman/paths/~1mailman~1{mailing_list}~1{username}/delete"></a>unsubscribe a user from a mailing list<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Unsubscribes a user from a mailing list.</p>
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="mailing_list"><span class="sc-iemWCZ bcnRwz"></span><span>mailing_list</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>The name of the list from which the user will be unsubscribed. If there is no &#39;@&#39; symbol, then &#39;@csclub.uwaterloo.ca&#39; will be appended to the list name.</p>
</div></div></div></td></tr><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="username"><span class="sc-iemWCZ bcnRwz"></span><span>username</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>The user who will be unsubscribed from the list. If there is no &#39;@&#39; symbol, then &#39;@csclub.uwaterloo.ca&#39; will be appended to he username; otherwise, the given email address will be unsubscribed.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">404<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>User is already subscribed or mailing list does not exist</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="delete" class="sc-jHcXXw gemyvL http-verb delete">delete</span><span class="sc-xGAEC jRjoAh">/mailman/{mailing_list}/{username}</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://mail.csclub.uwaterloo.ca:9987/api</span>/mailman/{mailing_list}/{username}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-46" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-47" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-48" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-49">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-47" aria-labelledby="react-tabs-46"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"result"</span>: <span class="token string">&quot;OK&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-49" aria-labelledby="react-tabs-48"></div></div></div></div></div></div><div id="tag/uwldap" data-section-id="tag/uwldap" class="sc-eCApnc fxZJZV"><div class="sc-iCoGMd KWWXd"><div class="sc-hKFxyN egQuEZ"><h1 class="sc-fujyAs cTueGk"><a class="sc-crzoAE iUxAWq" href="#tag/uwldap" aria-label="tag/uwldap"></a>uwldap</h1></div></div><div class="sc-hKFxyN dmghQN"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy redoc-markdown "><p>Operations related to the UW LDAP directory</p>
</div></div></div><div id="tag/uwldap/paths/~1uwldap~1{username}/get" data-section-id="tag/uwldap/paths/~1uwldap~1{username}/get" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/uwldap/paths/~1uwldap~1{username}/get" aria-label="tag/uwldap/paths/~1uwldap~1{username}/get"></a>get UWLDAP information for a user<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Returns information about a user from the UW LDAP directory.</p>
</div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="username"><span class="sc-iemWCZ bcnRwz"></span><span>username</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>username of the user to return</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">404<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>User not found</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="get" class="sc-jHcXXw cAOCuf http-verb get">get</span><span class="sc-xGAEC jRjoAh">/uwldap/{username}</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://phosphoric-acid.csclub.uwaterloo.ca:9987/api</span>/uwldap/{username}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-50" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-51" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-52" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-53">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-51" aria-labelledby="react-tabs-50"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"uid"</span>: <span class="token string">&quot;ctdalek&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cn"</span>: <span class="token string">&quot;Calum Dalek&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"given_name"</span>: <span class="token string">&quot;Calum&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sn"</span>: <span class="token string">&quot;Dalek&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mail_local_addresses"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">&quot;ctdalek@uwaterloo.ca&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-53" aria-labelledby="react-tabs-52"></div></div></div></div></div></div><div id="tag/uwldap/paths/~1uwldap~1updateprograms/post" data-section-id="tag/uwldap/paths/~1uwldap~1updateprograms/post" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/uwldap/paths/~1uwldap~1updateprograms/post" aria-label="tag/uwldap/paths/~1uwldap~1updateprograms/post"></a>update CSC programs from UWLDAP<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Sync the &#39;program&#39; attribute in the CSC LDAP with the UW LDAP.
The JSON request body may be omitted.</p>
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">query<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="dry_run"><span class="sc-iemWCZ bcnRwz"></span><span>dry_run</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">boolean</span></div><div><span class="sc-fbIWvP CMpTe"> <!-- -->Default:<!-- --> </span> <span class="sc-fbIWvP sc-hmbstg CMpTe cfctgs">false</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>Whether to perform a dry run or not. If true, a list of members who <em>would</em> have been changed is returned.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-jcwpoC joKODG">application/json</span></h5><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"></div><table class="sc-hHEiqL dYlGyN"><tbody><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="members"><span class="sc-iemWCZ bcnRwz"></span><span>members</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV">Array of </span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">strings</span><span class="sc-fbIWvP sc-dvXYtj CMpTe spbic"> (<!-- -->UID<!-- -->) </span></div><div><span class="sc-fbIWvP CMpTe"> <!-- -->Default:<!-- --> </span> <span class="sc-fbIWvP sc-hmbstg CMpTe cfctgs">[]</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>If non-empty, only these members will be synced with UWLDAP</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="post" class="sc-jHcXXw bXnXQF http-verb post">post</span><span class="sc-xGAEC jRjoAh">/uwldap/updateprograms</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://phosphoric-acid.csclub.uwaterloo.ca:9987/api</span>/uwldap/updateprograms</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-54" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-55" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-55" aria-labelledby="react-tabs-54"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"members"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-56" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-57" tabindex="0">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-57" aria-labelledby="react-tabs-56"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">&quot;ctdalek&quot;</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">&quot;old_program&quot;</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">&quot;new_program&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/database" data-section-id="tag/database" class="sc-eCApnc fxZJZV"><div class="sc-iCoGMd KWWXd"><div class="sc-hKFxyN egQuEZ"><h1 class="sc-fujyAs cTueGk"><a class="sc-crzoAE iUxAWq" href="#tag/datab
</div></div></div><div id="tag/database/paths/~1db~1mysql~1{username}/post" data-section-id="tag/database/paths/~1db~1mysql~1{username}/post" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/database/paths/~1db~1mysql~1{username}/post" aria-label="tag/database/paths/~1db~1mysql~1{username}/post"></a>Create a MySQL database<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Create a MySQL database for the user</p>
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="username"><span class="sc-iemWCZ bcnRwz"></span><span>username</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>name of the user to create MySQL database for</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">400<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Username contains invalid characters</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">404<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>User not found</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">409<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>User already has a database</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">500<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Unable to connect to database or action failed due to permissions</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="post" class="sc-jHcXXw bXnXQF http-verb post">post</span><span class="sc-xGAEC jRjoAh">/db/mysql/{username}</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://caffeine.csclub.uwaterloo.ca:9987/api</span>/db/mysql/{username}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-58" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-59" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-60" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-61">400</li><li class="tab-error" role="tab" id="react-tabs-62" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-63">404</li><li class="tab-error" role="tab" id="react-tabs-64" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-65">409</li><li class="tab-error" role="tab" id="react-tabs-66" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-67">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-59" aria-labelledby="react-tabs-58"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"password"</span>: <span class="token string">&quot;7fUi5rQr/lcpeEj4M86ZBbwM&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-61" aria-labelledby="react-tabs-60"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-63" aria-labelledby="react-tabs-62"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-65" aria-labelledby="react-tabs-64"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-67" aria-labelledby="react-tabs-66"></div></div></div></div></div></div><div id="tag/database/paths/~1db~1mysql~1{username}~1pwreset/post" data-section-id="tag/database/paths/~1db~1mysql~1{username}~1pwreset/post" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/database/paths/~1db~1mysql~1{username}~1pwreset/post" aria-label="tag/database/paths/~1db~1mysql~1{username}~1pwreset/post"></a>Reset MySQL database password<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Reset the password for a user&#39;s MySQL database</p>
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="username"><span class="sc-iemWCZ bcnRwz"></span><span>username</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>name of the user to reset the MySQL database password for</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">400<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Username contains invalid characters</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">404<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>User not found</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">500<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Unable to connect to database or action failed due to permissions</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="post" class="sc-jHcXXw bXnXQF http-verb post">post</span><span class="sc-xGAEC jRjoAh">/db/mysql/{username}/pwreset</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://caffeine.csclub.uwaterloo.ca:9987/api</span>/db/mysql/{username}/pwreset</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-68" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-69" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-70" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-71">400</li><li class="tab-error" role="tab" id="react-tabs-72" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-73">404</li><li class="tab-error" role="tab" id="react-tabs-74" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-75">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-69" aria-labelledby="react-tabs-68"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"password"</span>: <span class="token string">&quot;kM90d3G/eofIUxr9O3CQHTlP&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-71" aria-labelledby="react-tabs-70"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-73" aria-labelledby="react-tabs-72"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-75" aria-labelledby="react-tabs-74"></div></div></div></div></div></div><div id="tag/database/paths/~1db~1postgresql~1{username}/post" data-section-id="tag/database/paths/~1db~1postgresql~1{username}/post" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/database/paths/~1db~1postgresql~1{username}/post" aria-label="tag/database/paths/~1db~1postgresql~1{username}/post"></a>Create a PostgreSQL database<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Create a PostgreSQL database for the user</p>
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="username"><span class="sc-iemWCZ bcnRwz"></span><span>username</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>name of the user to create PostgreSQL database for</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">400<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Username contains invalid characters</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">404<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>User not found</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">409<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>User already has a database</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">500<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Unable to connect to database or action failed due to permissions</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="post" class="sc-jHcXXw bXnXQF http-verb post">post</span><span class="sc-xGAEC jRjoAh">/db/postgresql/{username}</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://caffeine.csclub.uwaterloo.ca:9987/api</span>/db/postgresql/{username}</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-76" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-77" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-78" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-79">400</li><li class="tab-error" role="tab" id="react-tabs-80" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-81">404</li><li class="tab-error" role="tab" id="react-tabs-82" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-83">409</li><li class="tab-error" role="tab" id="react-tabs-84" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-85">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-77" aria-labelledby="react-tabs-76"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"password"</span>: <span class="token string">&quot;iHxd62DC7Qt1HyYRj18P6ujS&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-79" aria-labelledby="react-tabs-78"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-81" aria-labelledby="react-tabs-80"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-83" aria-labelledby="react-tabs-82"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-85" aria-labelledby="react-tabs-84"></div></div></div></div></div></div><div id="tag/database/paths/~1db~1postgresql~1{username}~1pwreset/post" data-section-id="tag/database/paths/~1db~1postgresql~1{username}~1pwreset/post" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/database/paths/~1db~1postgresql~1{username}~1pwreset/post" aria-label="tag/database/paths/~1db~1postgresql~1{username}~1pwreset/post"></a>Reset PostgreSQL database password<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Reset the password for a user&#39;s PostgreSQL database</p>
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><div><h5 class="sc-iqAclL eONCmm">path<!-- --> Parameters</h5><table class="sc-hHEiqL dYlGyN"><tbody><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr eQzShU" kind="field" title="username"><span class="sc-iemWCZ bcnRwz"></span><span>username</span><div class="sc-TtZnY sc-jHNicF hUSnpT bsGeIE"> required </div></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"><p>name of the user to reset the PostgreSQL database password for</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">400<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Username contains invalid characters</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">404<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>User not found</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">500<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Unable to connect to database or action failed due to permissions</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="post" class="sc-jHcXXw bXnXQF http-verb post">post</span><span class="sc-xGAEC jRjoAh">/db/postgresql/{username}/pwreset</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://caffeine.csclub.uwaterloo.ca:9987/api</span>/db/postgresql/{username}/pwreset</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-86" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-87" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-88" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-89">400</li><li class="tab-error" role="tab" id="react-tabs-90" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-91">404</li><li class="tab-error" role="tab" id="react-tabs-92" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-93">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-87" aria-labelledby="react-tabs-86"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"password"</span>: <span class="token string">&quot;CdPHT49iYAWzzKuhKTt2dNeu&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-89" aria-labelledby="react-tabs-88"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-91" aria-labelledby="react-tabs-90"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-93" aria-labelledby="react-tabs-92"></div></div></div></div></div></div><div id="tag/positions" data-section-id="tag/positions" class="sc-eCApnc fxZJZV"><div class="sc-iCoGMd KWWXd"><div class="sc-hKFxyN egQuEZ"><h1 class="sc-fujyAs cTueGk"><a class="sc-crzoAE iUxAWq" href="#tag/positions" aria-label="tag/positions"></a>positions</h1></div></div></div><div id="tag/positions/paths/~1positions/get" data-section-id="tag/positions/paths/~1positions/get" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/positions/paths/~1positions/get" aria-label="tag/positions/paths/~1positions/get"></a>Show current positions<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Shows the list of positions and members holding them.</p>
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="get" class="sc-jHcXXw cAOCuf http-verb get">get</span><span class="sc-xGAEC jRjoAh">/positions</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://phosphoric-acid.csclub.uwaterloo.ca:9987/api</span>/positions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-94" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-95" tabindex="0">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-95" aria-labelledby="react-tabs-94"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"president"</span>: <span class="token string">&quot;user0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vice-president"</span>: <span class="token string">&quot;user1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sysadmin"</span>: <span class="token string">&quot;user2&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"treasurer"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/positions/paths/~1positions/post" data-section-id="tag/positions/paths/~1positions/post" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/positions/paths/~1positions/post" aria-label="tag/positions/paths/~1positions/post"></a>Update positions<!-- --> </h2><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Update members for each positions. Members not specified in the parameters will be removed from the position and unsubscribed from the exec&#39;s mailing list. New position holders will be subscribed to the mailing list.</p>
</div></div><div class="sc-gzcbmu iEcHcE"><div class="sc-gVFcvn cuYWRV"><h5 class="sc-iqAclL sc-fIxmyt eONCmm kZsYIY">Authorizations: </h5></div><div class="sc-fWWYYk bwNcZa"><span class="sc-hkeOVe fguZND"><span class="sc-cbeScs ikavEm"><a href="#section/Authentication/GSSAPIAuth" aria-label="section/Authentication/GSSAPIAuth">GSSAPIAuth</a></span></span></div></div><h5 class="sc-iqAclL eONCmm">Request Body schema: <span class="sc-jcwpoC joKODG">application/json</span></h5><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>New position holders</p>
</div><table class="sc-hHEiqL dYlGyN"><tbody><tr class="last undefined"><td class="sc-hBMUJo sc-fFSPTT fABPTr fcIjHV" kind="additionalProperties" title="property name*"><span class="sc-iemWCZ bcnRwz"></span><span>property name*</span></td><td class="sc-bkbkJK gWxDzL"><div><div><span class="sc-fbIWvP sc-FRrlG CMpTe bBFKjV"></span><span class="sc-fbIWvP sc-fXazdy CMpTe gJKPGC">string</span></div> <div><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div></div></div></td></tr></tbody></table><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Success</p>
</span></button></div><div><button class="sc-jXcxbT gkwAYh"><svg class="sc-dIsUp hikpbD" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">400<!-- --> </strong><span class="sc-Arkif dXjyFC"><p>Failed</p>
</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb jnEbBv"><span type="post" class="sc-jHcXXw bXnXQF http-verb post">post</span><span class="sc-xGAEC jRjoAh">/positions</span><svg class="sc-dIsUp gGvkZD" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span>https://phosphoric-acid.csclub.uwaterloo.ca:9987/api</span>/positions</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Request samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-96" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-97" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-97" aria-labelledby="react-tabs-96"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"president"</span>: <span class="token string">&quot;user0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vice-president"</span>: <span class="token string">&quot;user1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sysadmin"</span>: <span class="token string">&quot;user2&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"treasurer"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-98" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-99" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-100" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-101">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-99" aria-labelledby="react-tabs-98"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">text/plain</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-cTJkRt gEtKwR"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button></div><pre class="sc-jNnpgg sc-dPaNzc bnCoiE dkqrXs"><span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"update_positions_ldap"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"update_exec_group_ldap"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"in progress"</span><span class="token punctuation">,</span> <span class="token string">"operation"</span><span class="token punctuation">:</span> <span class="token string">"subscribe_to_mailing_list"</span><span class="token punctuation">}</span>
<span class="token punctuation">{</span><span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"completed"</span><span class="token punctuation">,</span> <span class="token string">"result"</span><span class="token punctuation">:</span> <span class="token string">"OK"</span><span class="token punctuation">}</span>
</pre></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-101" aria-labelledby="react-tabs-100"></div></div></div></div></div></div></div><div class="sc-cKRKFl gBTuHc"></div></div></div>
<script>
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"title":"ceod - OpenAPI 3.0","description":"This is an OpenAPI specification of ceod, the CSC Electronic Office daemon.\nVisit the [git repository](https://git.csclub.uwaterloo.ca/public/pyceo) for\nmore details.\n## Streaming Responses\nMany endpoints return a \"streaming response\", which consists of a series of JSON\nobjects, one per line (the mimetype is text/plain). For example:\n```\n{\"status\": \"in progress\", \"operation\": \"replace_login_shell\"}\n{\"status\": \"in progress\", \"operation\": \"replace_forwarding_addresses\"}\n{\"status\": \"completed\", \"result\": \"OK\"}\n```\nWhenever an operation is completed, a corresponding JSON object will be streamed\nfrom the server to the client. This allows the client to track the server's progress\nin real time.\n\n# Authentication\n\n<!-- ReDoc-Inject: <security-definitions> -->","contact":{"email":"syscom@csclub.uwaterloo.ca"},"version":"1.0.0"},"servers":[{"url":"https://phosphoric-acid.csclub.uwaterloo.ca:9987/api"}],"tags":[{"name":"members","description":"Operations on members and club reps"},{"name":"groups","description":"Operations on groups and clubs"},{"name":"mailman","description":"Operations on mailing list subscriptions"},{"name":"uwldap","description":"Operations related to the UW LDAP directory"},{"name":"database","description":"Operations related to databases"}],"security":[{"GSSAPIAuth":[]}],"paths":{"/members":{"post":{"tags":["members"],"summary":"Create a new user","description":"Creates a new member or club rep. If `terms` is specified, a member is created; if `non_member_terms` is specified, a club rep is created.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"uid":{"$ref":"#/components/schemas/UID"},"cn":{"$ref":"#/components/schemas/UserCN"},"sn":{"$ref":"#/components/schemas/UserSN"},"given_name":{"$ref":"#/components/schemas/UserGivenName"},"program":{"$ref":"#/components/schemas/Program"},"terms":{"$ref":"#/components/schemas/Terms"},"non_member_terms":{"$ref":"#/components/schemas/NonMemberTerms"},"forwarding_addresses":{"$ref":"#/components/schemas/ForwardingAddresses"}}}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string","description":"Streaming response"},"example":"{\"status\": \"in progress\", \"operation\": \"add_user_to_ldap\"}\n{\"status\": \"in progress\", \"operation\": \"add_group_to_ldap\"}\n{\"status\": \"in progress\", \"operation\": \"add_user_to_kerberos\"}\n{\"status\": \"in progress\", \"operation\": \"create_home_dir\"}\n{\"status\": \"in progress\", \"operation\": \"send_welcome_message\"}\n{\"status\": \"in progress\", \"operation\": \"subscribe_to_mailing_list\"}\n{\"status\": \"in progress\", \"operation\": \"announce_new_user\"}\n{\"status\": \"completed\", \"result\": {\"cn\": \"Calum Dalek\", \"given_name\": \"Calum\", \"sn\": \"Dalek\", \"uid\": \"ctdalek\", \"uid_number\": 20001, \"gid_number\": 20001, \"login_shell\": \"/bin/bash\", \"home_directory\": \"/users/ctdalek\", \"is_club\": false, \"program\": \"MAT/Mathematics Computer Science\", \"terms\": [\"f2021\"], \"forwarding_addresses\": [\"ctdalek@uwaterloo.ca\"], \"password\": \"Wlw1wOTofERTEBlXWzR6/MZL\"}}\n"}}}}}},"/members/{username}":{"get":{"tags":["members"],"summary":"Get information about a user","description":"Returns information about a member or club rep. The `forwarding_addresses` field will only be present if the client is an authenticated syscom member.","parameters":[{"name":"username","in":"path","description":"username of the user to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"404":{"$ref":"#/components/responses/UserNotFoundErrorResponse"}}},"patch":{"tags":["members"],"summary":"Modify a user","description":"Replace the login shell and/or forwarding addresses of a user","parameters":[{"name":"username","in":"path","de
var container = document.getElementById('redoc');
Redoc.hydrate(__redoc_state, container);
</script>
</body>
</html>