mirror of
https://github.com/mattermost/mattermost.git
synced 2025-02-25 18:55:24 -06:00
d9614cbb12
* merge mattermost-api-reference unchanged * api: update repostiory paths * api: drop GitPod for api (for now) * api: improved node_modules target * api: relocate GitHub actions to root * Update .github/workflows/api.yml Co-authored-by: Antonis Stamatiou <stamatiou.antonis@gmail.com> * fix cache-dependency-path * adopt node-version-file * pin versions for uses * tidy steps/runs * api/.gitpod.yml: tidy * api: rm now unused .gitlab-ci.yml --------- Co-authored-by: Antonis Stamatiou <stamatiou.antonis@gmail.com>
4363 lines
4.7 MiB
4363 lines
4.7 MiB
<!DOCTYPE html>
|
||
<html>
|
||
|
||
<head>
|
||
<meta charset="utf8" />
|
||
<title>Mattermost API Reference</title>
|
||
<!-- needed for adaptive design -->
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<link rel="shortcut icon" href="./static/favicon.ico">
|
||
<style>
|
||
body {
|
||
padding: 0;
|
||
margin: 0;
|
||
}
|
||
label[type="tag"] {
|
||
text-transform: uppercase;
|
||
}
|
||
h1{
|
||
text-transform: capitalize;
|
||
}
|
||
</style>
|
||
<script>/*!
|
||
* ReDoc - OpenAPI/Swagger-generated API Reference Documentation
|
||
* -------------------------------------------------------------
|
||
* Version: "2.0.0-rc.23"
|
||
* Repo: https://github.com/Redocly/redoc
|
||
*/
|
||
!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t(require("null"),function(){try{return require("esprima")}catch(e){}}()):"function"==typeof define&&define.amd?define(["null","esprima"],t):"object"==typeof exports?exports.Redoc=t(require("null"),function(){try{return require("esprima")}catch(e){}}()):e.Redoc=t(e.null,e.esprima)}(this,(function(e,t){return function(e){var t={};function n(r){if(t[r])return t[r].exports;var o=t[r]={i:r,l:!1,exports:{}};return e[r].call(o.exports,o,o.exports,n),o.l=!0,o.exports}return n.m=e,n.c=t,n.d=function(e,t,r){n.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:r})},n.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.t=function(e,t){if(1&t&&(e=n(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var r=Object.create(null);if(n.r(r),Object.defineProperty(r,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)n.d(r,o,function(t){return e[t]}.bind(null,o));return r},n.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(t,"a",t),t},n.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n.p="",n(n.s=159)}([function(e,t,n){"use strict";e.exports=n(222)},function(e,t,n){"use strict";n.r(t),n.d(t,"__extends",(function(){return o})),n.d(t,"__assign",(function(){return i})),n.d(t,"__rest",(function(){return a})),n.d(t,"__decorate",(function(){return s})),n.d(t,"__param",(function(){return l})),n.d(t,"__metadata",(function(){return c})),n.d(t,"__awaiter",(function(){return u})),n.d(t,"__generator",(function(){return f})),n.d(t,"__exportStar",(function(){return p})),n.d(t,"__values",(function(){return d})),n.d(t,"__read",(function(){return h})),n.d(t,"__spread",(function(){return m})),n.d(t,"__spreadArrays",(function(){return g})),n.d(t,"__await",(function(){return y})),n.d(t,"__asyncGenerator",(function(){return v})),n.d(t,"__asyncDelegator",(function(){return b})),n.d(t,"__asyncValues",(function(){return w})),n.d(t,"__makeTemplateObject",(function(){return x})),n.d(t,"__importStar",(function(){return k})),n.d(t,"__importDefault",(function(){return E}));
|
||
/*! *****************************************************************************
|
||
Copyright (c) Microsoft Corporation. All rights reserved.
|
||
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
|
||
this file except in compliance with the License. You may obtain a copy of the
|
||
License at http://www.apache.org/licenses/LICENSE-2.0
|
||
|
||
THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||
KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
|
||
WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
|
||
MERCHANTABLITY OR NON-INFRINGEMENT.
|
||
|
||
See the Apache Version 2.0 License for specific language governing permissions
|
||
and limitations under the License.
|
||
***************************************************************************** */
|
||
var r=function(e,t){return(r=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var n in t)t.hasOwnProperty(n)&&(e[n]=t[n])})(e,t)};function o(e,t){function n(){this.constructor=e}r(e,t),e.prototype=null===t?Object.create(t):(n.prototype=t.prototype,new n)}var i=function(){return(i=Object.assign||function(e){for(var t,n=1,r=arguments.length;n<r;n++)for(var o in t=arguments[n])Object.prototype.hasOwnProperty.call(t,o)&&(e[o]=t[o]);return e}).apply(this,arguments)};function a(e,t){var n={};for(var r in e)Object.prototype.hasOwnProperty.call(e,r)&&t.indexOf(r)<0&&(n[r]=e[r]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var o=0;for(r=Object.getOwnPropertySymbols(e);o<r.length;o++)t.indexOf(r[o])<0&&Object.prototype.propertyIsEnumerable.call(e,r[o])&&(n[r[o]]=e[r[o]])}return n}function s(e,t,n,r){var o,i=arguments.length,a=i<3?t:null===r?r=Object.getOwnPropertyDescriptor(t,n):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)a=Reflect.decorate(e,t,n,r);else for(var s=e.length-1;s>=0;s--)(o=e[s])&&(a=(i<3?o(a):i>3?o(t,n,a):o(t,n))||a);return i>3&&a&&Object.defineProperty(t,n,a),a}function l(e,t){return function(n,r){t(n,r,e)}}function c(e,t){if("object"==typeof Reflect&&"function"==typeof Reflect.metadata)return Reflect.metadata(e,t)}function u(e,t,n,r){return new(n||(n=Promise))((function(o,i){function a(e){try{l(r.next(e))}catch(e){i(e)}}function s(e){try{l(r.throw(e))}catch(e){i(e)}}function l(e){e.done?o(e.value):new n((function(t){t(e.value)})).then(a,s)}l((r=r.apply(e,t||[])).next())}))}function f(e,t){var n,r,o,i,a={label:0,sent:function(){if(1&o[0])throw o[1];return o[1]},trys:[],ops:[]};return i={next:s(0),throw:s(1),return:s(2)},"function"==typeof Symbol&&(i[Symbol.iterator]=function(){return this}),i;function s(i){return function(s){return function(i){if(n)throw new TypeError("Generator is already executing.");for(;a;)try{if(n=1,r&&(o=2&i[0]?r.return:i[0]?r.throw||((o=r.return)&&o.call(r),0):r.next)&&!(o=o.call(r,i[1])).done)return o;switch(r=0,o&&(i=[2&i[0],o.value]),i[0]){case 0:case 1:o=i;break;case 4:return a.label++,{value:i[1],done:!1};case 5:a.label++,r=i[1],i=[0];continue;case 7:i=a.ops.pop(),a.trys.pop();continue;default:if(!(o=(o=a.trys).length>0&&o[o.length-1])&&(6===i[0]||2===i[0])){a=0;continue}if(3===i[0]&&(!o||i[1]>o[0]&&i[1]<o[3])){a.label=i[1];break}if(6===i[0]&&a.label<o[1]){a.label=o[1],o=i;break}if(o&&a.label<o[2]){a.label=o[2],a.ops.push(i);break}o[2]&&a.ops.pop(),a.trys.pop();continue}i=t.call(e,a)}catch(e){i=[6,e],r=0}finally{n=o=0}if(5&i[0])throw i[1];return{value:i[0]?i[1]:void 0,done:!0}}([i,s])}}}function p(e,t){for(var n in e)t.hasOwnProperty(n)||(t[n]=e[n])}function d(e){var t="function"==typeof Symbol&&e[Symbol.iterator],n=0;return t?t.call(e):{next:function(){return e&&n>=e.length&&(e=void 0),{value:e&&e[n++],done:!e}}}}function h(e,t){var n="function"==typeof Symbol&&e[Symbol.iterator];if(!n)return e;var r,o,i=n.call(e),a=[];try{for(;(void 0===t||t-- >0)&&!(r=i.next()).done;)a.push(r.value)}catch(e){o={error:e}}finally{try{r&&!r.done&&(n=i.return)&&n.call(i)}finally{if(o)throw o.error}}return a}function m(){for(var e=[],t=0;t<arguments.length;t++)e=e.concat(h(arguments[t]));return e}function g(){for(var e=0,t=0,n=arguments.length;t<n;t++)e+=arguments[t].length;var r=Array(e),o=0;for(t=0;t<n;t++)for(var i=arguments[t],a=0,s=i.length;a<s;a++,o++)r[o]=i[a];return r}function y(e){return this instanceof y?(this.v=e,this):new y(e)}function v(e,t,n){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var r,o=n.apply(e,t||[]),i=[];return r={},a("next"),a("throw"),a("return"),r[Symbol.asyncIterator]=function(){return this},r;function a(e){o[e]&&(r[e]=function(t){return new Promise((function(n,r){i.push([e,t,n,r])>1||s(e,t)}))})}function s(e,t){try{(n=o[e](t)).value instanceof y?Promise.resolve(n.value.v).then(l,c):u(i[0][2],n)}catch(e){u(i[0][3],e)}var n}function l(e){s("next",e)}function c(e){s("throw",e)}function u(e,t){e(t),i.shift(),i.length&&s(i[0][0],i[0][1])}}function b(e){var t,n;return t={},r("next"),r("throw",(function(e){throw e})),r("return"),t[Symbol.iterator]=function(){return this},t;function r(r,o){t[r]=e[r]?function(t){return(n=!n)?{value:y(e[r](t)),done:"return"===r}:o?o(t):t}:o}}function w(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t,n=e[Symbol.asyncIterator];return n?n.call(e):(e=d(e),t={},r("next"),r("throw"),r("return"),t[Symbol.asyncIterator]=function(){return this},t);function r(n){t[n]=e[n]&&function(t){return new Promise((function(r,o){(function(e,t,n,r){Promise.resolve(r).then((function(t){e({value:t,done:n})}),t)})(r,o,(t=e[n](t)).done,t.value)}))}}}function x(e,t){return Object.defineProperty?Object.defineProperty(e,"raw",{value:t}):e.raw=t,e}function k(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var n in e)Object.hasOwnProperty.call(e,n)&&(t[n]=e[n]);return t.default=e,t}function E(e){return e&&e.__esModule?e:{default:e}}},function(e,t,n){"use strict";(function(e,r){n.d(t,"a",(function(){return fn})),n.d(t,"b",(function(){return qe})),n.d(t,"c",(function(){return Se})),n.d(t,"d",(function(){return it})),n.d(t,"e",(function(){return ce})),n.d(t,"f",(function(){return dt})),n.d(t,"g",(function(){return M})),n.d(t,"h",(function(){return mt})),n.d(t,"i",(function(){return $t})),n.d(t,"j",(function(){return Vt})),n.d(t,"k",(function(){return rn})),n.d(t,"l",(function(){return re})),n.d(t,"m",(function(){return wt})),n.d(t,"n",(function(){return at})),n.d(t,"o",(function(){return tt})),n.d(t,"p",(function(){return xt})),n.d(t,"q",(function(){return ge}));
|
||
/*! *****************************************************************************
|
||
Copyright (c) Microsoft Corporation. All rights reserved.
|
||
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
|
||
this file except in compliance with the License. You may obtain a copy of the
|
||
License at http://www.apache.org/licenses/LICENSE-2.0
|
||
|
||
THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||
KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
|
||
WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
|
||
MERCHANTABLITY OR NON-INFRINGEMENT.
|
||
|
||
See the Apache Version 2.0 License for specific language governing permissions
|
||
and limitations under the License.
|
||
***************************************************************************** */
|
||
var o=function(e,t){return(o=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var n in t)t.hasOwnProperty(n)&&(e[n]=t[n])})(e,t)};function i(e,t){function n(){this.constructor=e}o(e,t),e.prototype=null===t?Object.create(t):(n.prototype=t.prototype,new n)}var a=function(){return(a=Object.assign||function(e){for(var t,n=1,r=arguments.length;n<r;n++)for(var o in t=arguments[n])Object.prototype.hasOwnProperty.call(t,o)&&(e[o]=t[o]);return e}).apply(this,arguments)};function s(e,t){var n="function"==typeof Symbol&&e[Symbol.iterator];if(!n)return e;var r,o,i=n.call(e),a=[];try{for(;(void 0===t||t-- >0)&&!(r=i.next()).done;)a.push(r.value)}catch(e){o={error:e}}finally{try{r&&!r.done&&(n=i.return)&&n.call(i)}finally{if(o)throw o.error}}return a}function l(){for(var e=[],t=0;t<arguments.length;t++)e=e.concat(s(arguments[t]));return e}var c="An invariant failed, however the error is obfuscated because this is an production build.",u=[];Object.freeze(u);var f={};Object.freeze(f);var p={};function d(){return"undefined"!=typeof window?window:void 0!==e?e:"undefined"!=typeof self?self:p}function h(){return++Le.mobxGuid}function m(e){throw g(!1,e),"X"}function g(e,t){if(!e)throw new Error("[mobx] "+(t||c))}function y(e){var t=!1;return function(){if(!t)return t=!0,e.apply(this,arguments)}}var v=function(){};function b(e){return null!==e&&"object"==typeof e}function w(e){if(null===e||"object"!=typeof e)return!1;var t=Object.getPrototypeOf(e);return t===Object.prototype||null===t}function x(e,t,n){Object.defineProperty(e,t,{enumerable:!1,writable:!0,configurable:!0,value:n})}function k(e,t,n){Object.defineProperty(e,t,{enumerable:!1,writable:!1,configurable:!0,value:n})}function E(e,t){var n="isMobX"+e;return t.prototype[n]=!0,function(e){return b(e)&&!0===e[n]}}function O(e){return void 0!==d().Map&&e instanceof d().Map}function _(e){return e instanceof Set}function S(e){for(var t=[];;){var n=e.next();if(n.done)break;t.push(n.value)}return t}function T(){return"function"==typeof Symbol&&Symbol.toPrimitive||"@@toPrimitive"}function j(e){return null===e?null:"object"==typeof e?""+e:e}function C(){return"function"==typeof Symbol&&Symbol.iterator||"@@iterator"}function I(e,t){k(e,C(),t)}function A(e){return e[C()]=R,e}function P(){return"function"==typeof Symbol&&Symbol.toStringTag||"@@toStringTag"}function R(){return this}var N=function(){function e(e){void 0===e&&(e="Atom@"+h()),this.name=e,this.isPendingUnobservation=!1,this.isBeingObserved=!1,this.observers=[],this.observersIndexes={},this.diffValue=0,this.lastAccessedBy=0,this.lowestObserverState=ie.NOT_TRACKING}return e.prototype.onBecomeUnobserved=function(){},e.prototype.onBecomeObserved=function(){},e.prototype.reportObserved=function(){return Be(this)},e.prototype.reportChanged=function(){Ue(),function(e){if(e.lowestObserverState===ie.STALE)return;e.lowestObserverState=ie.STALE;var t=e.observers,n=t.length;for(;n--;){var r=t[n];r.dependenciesState===ie.UP_TO_DATE&&(r.isTracing!==ae.NONE&&$e(r,e),r.onBecomeStale()),r.dependenciesState=ie.STALE}}(this),ze()},e.prototype.toString=function(){return this.name},e}(),L=E("Atom",N);function M(e,t,n){void 0===t&&(t=v),void 0===n&&(n=v);var r,o=new N(e);return pt("onBecomeObserved",o,t,r),ft(o,n),o}function D(e,t){return e===t}var F={identity:D,structural:function(e,t){return ln(e,t)},default:function(e,t){return function(e,t){return"number"==typeof e&&"number"==typeof t&&isNaN(e)&&isNaN(t)}(e,t)||D(e,t)},shallow:function(e,t){return ln(e,t,1)}},U={},z={};function B(e,t){var n=t?U:z;return n[e]||(n[e]={configurable:!0,enumerable:t,get:function(){return $(this),this[e]},set:function(t){$(this),this[e]=t}})}function $(e){if(!0!==e.__mobxDidRunLazyInitializers){var t=e.__mobxDecorators;if(t)for(var n in x(e,"__mobxDidRunLazyInitializers",!0),t){var r=t[n];r.propertyCreator(e,r.prop,r.descriptor,r.decoratorTarget,r.decoratorArguments)}}}function q(e,t){return function(){var n,r=function(r,o,i,s){if(!0===s)return t(r,o,i,r,n),null;if(!Object.prototype.hasOwnProperty.call(r,"__mobxDecorators")){var l=r.__mobxDecorators;x(r,"__mobxDecorators",a({},l))}return r.__mobxDecorators[o]={prop:o,propertyCreator:t,descriptor:i,decoratorTarget:r,decoratorArguments:n},B(o,e)};return W(arguments)?(n=u,r.apply(null,arguments)):(n=Array.prototype.slice.call(arguments),r)}}function W(e){return(2===e.length||3===e.length)&&"string"==typeof e[1]||4===e.length&&!0===e[3]}function H(e,t,n){return bt(e)?e:Array.isArray(e)?re.array(e,{name:n}):w(e)?re.object(e,void 0,{name:n}):O(e)?re.map(e,{name:n}):_(e)?re.set(e,{name:n}):e}function V(e){return e}function Y(e){var t=q(!0,(function(t,n,r,o,i){Jt(t,n,r?r.initializer?r.initializer.call(t):r.value:void 0,e)})),n=(void 0!==r&&r.env,t);return n.enhancer=e,n}var G={deep:!0,name:void 0,defaultDecorator:void 0},Q={deep:!1,name:void 0,defaultDecorator:void 0};function X(e){return null==e?G:"string"==typeof e?{name:e,deep:!0}:e}function K(e){return e.defaultDecorator?e.defaultDecorator.enhancer:!1===e.deep?V:H}Object.freeze(G),Object.freeze(Q);var J=Y(H),Z=Y((function(e,t,n){return null==e?e:rn(e)||$t(e)||Vt(e)||Qt(e)?e:Array.isArray(e)?re.array(e,{name:n,deep:!1}):w(e)?re.object(e,void 0,{name:n,deep:!1}):O(e)?re.map(e,{name:n,deep:!1}):_(e)?re.set(e,{name:n,deep:!1}):m(!1)})),ee=Y(V),te=Y((function(e,t,n){return ln(e,t)?t:e}));var ne={box:function(e,t){arguments.length>2&&oe("box");var n=X(t);return new Ce(e,K(n),n.name,!0,n.equals)},shallowBox:function(e,t){return arguments.length>2&&oe("shallowBox"),re.box(e,{name:t,deep:!1})},array:function(e,t){arguments.length>2&&oe("array");var n=X(t);return new Mt(e,K(n),n.name)},shallowArray:function(e,t){return arguments.length>2&&oe("shallowArray"),re.array(e,{name:t,deep:!1})},map:function(e,t){arguments.length>2&&oe("map");var n=X(t);return new Wt(e,K(n),n.name)},shallowMap:function(e,t){return arguments.length>2&&oe("shallowMap"),re.map(e,{name:t,deep:!1})},set:function(e,t){arguments.length>2&&oe("set");var n=X(t);return new Gt(e,K(n),n.name)},object:function(e,t,n){"string"==typeof arguments[1]&&oe("object");var r=X(n);return ht({},e,t,r)},shallowObject:function(e,t){return"string"==typeof arguments[1]&&oe("shallowObject"),re.object(e,{},{name:t,deep:!1})},ref:ee,shallow:Z,deep:J,struct:te},re=function(e,t,n){if("string"==typeof arguments[1])return J.apply(null,arguments);if(bt(e))return e;var r=w(e)?re.object(e,t,n):Array.isArray(e)?re.array(e,t):O(e)?re.map(e,t):_(e)?re.set(e,t):e;if(r!==e)return r;m(!1)};function oe(e){m("Expected one or two arguments to observable."+e+". Did you accidentally try to use observable."+e+" as decorator?")}Object.keys(ne).forEach((function(e){return re[e]=ne[e]}));var ie,ae,se=q(!1,(function(e,t,n,r,o){var i=n.get,s=n.set,l=o[0]||{};!function(e,t,n){var r=Kt(e);n.name=r.name+"."+t,n.context=e,r.values[t]=new Ie(n),Object.defineProperty(e,t,function(e){return en[e]||(en[e]={configurable:Le.computedConfigurable,enumerable:!1,get:function(){return tn(this).read(this,e)},set:function(t){tn(this).write(this,e,t)}})}(t))}(e,t,a({get:i,set:s},l))})),le=se({equals:F.structural}),ce=function(e,t,n){if("string"==typeof t)return se.apply(null,arguments);if(null!==e&&"object"==typeof e&&1===arguments.length)return se.apply(null,arguments);var r="object"==typeof t?t:{};return r.get=e,r.set="function"==typeof t?t:r.set,r.name=r.name||e.name||"",new Ie(r)};ce.struct=le,function(e){e[e.NOT_TRACKING=-1]="NOT_TRACKING",e[e.UP_TO_DATE=0]="UP_TO_DATE",e[e.POSSIBLY_STALE=1]="POSSIBLY_STALE",e[e.STALE=2]="STALE"}(ie||(ie={})),function(e){e[e.NONE=0]="NONE",e[e.LOG=1]="LOG",e[e.BREAK=2]="BREAK"}(ae||(ae={}));var ue=function(e){this.cause=e};function fe(e){return e instanceof ue}function pe(e){switch(e.dependenciesState){case ie.UP_TO_DATE:return!1;case ie.NOT_TRACKING:case ie.STALE:return!0;case ie.POSSIBLY_STALE:for(var t=ye(),n=e.observing,r=n.length,o=0;o<r;o++){var i=n[o];if(Ae(i)){if(Le.disableErrorBoundaries)i.get();else try{i.get()}catch(e){return ve(t),!0}if(e.dependenciesState===ie.STALE)return ve(t),!0}}return xe(e),ve(t),!1}}function de(e){var t=e.observers.length>0;Le.computationDepth>0&&t&&m(!1),Le.allowStateChanges||!t&&"strict"!==Le.enforceActions||m(!1)}function he(e,t,n){var r=be(!0);xe(e),e.newObserving=new Array(e.observing.length+100),e.unboundDepsCount=0,e.runId=++Le.runId;var o,i=Le.trackingDerivation;if(Le.trackingDerivation=e,!0===Le.disableErrorBoundaries)o=t.call(n);else try{o=t.call(n)}catch(e){o=new ue(e)}return Le.trackingDerivation=i,function(e){for(var t=e.observing,n=e.observing=e.newObserving,r=ie.UP_TO_DATE,o=0,i=e.unboundDepsCount,a=0;a<i;a++){0===(s=n[a]).diffValue&&(s.diffValue=1,o!==a&&(n[o]=s),o++),s.dependenciesState>r&&(r=s.dependenciesState)}n.length=o,e.newObserving=null,i=t.length;for(;i--;){0===(s=t[i]).diffValue&&De(s,e),s.diffValue=0}for(;o--;){var s;1===(s=n[o]).diffValue&&(s.diffValue=0,Me(s,e))}r!==ie.UP_TO_DATE&&(e.dependenciesState=r,e.onBecomeStale())}(e),e.observing.length,we(r),o}function me(e){var t=e.observing;e.observing=[];for(var n=t.length;n--;)De(t[n],e);e.dependenciesState=ie.NOT_TRACKING}function ge(e){var t=ye(),n=e();return ve(t),n}function ye(){var e=Le.trackingDerivation;return Le.trackingDerivation=null,e}function ve(e){Le.trackingDerivation=e}function be(e){var t=Le.allowStateReads;return Le.allowStateReads=e,t}function we(e){Le.allowStateReads=e}function xe(e){if(e.dependenciesState!==ie.UP_TO_DATE){e.dependenciesState=ie.UP_TO_DATE;for(var t=e.observing,n=t.length;n--;)t[n].lowestObserverState=ie.UP_TO_DATE}}var ke=0,Ee=1;function Oe(e,t){var n=function(){return _e(e,t,this,arguments)};return n.isMobxAction=!0,n}function _e(e,t,n,r){var o=function(e,t,n){var r=Xe()&&!!e,o=0;if(r){o=Date.now();var i=n&&n.length||0,a=new Array(i);if(i>0)for(var s=0;s<i;s++)a[s]=n[s];Je({type:"action",name:e,object:t,arguments:a})}var l=ye();Ue();var c=Te(!0),u=be(!0),f={prevDerivation:l,prevAllowStateChanges:c,prevAllowStateReads:u,notifySpy:r,startTime:o,actionId:Ee++,parentActionId:ke};return ke=f.actionId,f}(e,n,r);try{return t.apply(n,r)}catch(e){throw o.error=e,e}finally{!function(e){ke!==e.actionId&&m("invalid action stack. did you forget to finish an action?");ke=e.parentActionId,void 0!==e.error&&(Le.suppressReactionErrors=!0);je(e.prevAllowStateChanges),we(e.prevAllowStateReads),ze(),ve(e.prevDerivation),e.notifySpy&&et({time:Date.now()-e.startTime});Le.suppressReactionErrors=!1}(o)}}function Se(e,t){var n,r=Te(e);try{n=t()}finally{je(r)}return n}function Te(e){var t=Le.allowStateChanges;return Le.allowStateChanges=e,t}function je(e){Le.allowStateChanges=e}var Ce=function(e){function t(t,n,r,o,i){void 0===r&&(r="ObservableValue@"+h()),void 0===o&&(o=!0),void 0===i&&(i=F.default);var a=e.call(this,r)||this;return a.enhancer=n,a.name=r,a.equals=i,a.hasUnreportedChange=!1,a.value=n(t,void 0,r),o&&Xe()&&Ke({type:"create",name:a.name,newValue:""+a.value}),a}return i(t,e),t.prototype.dehanceValue=function(e){return void 0!==this.dehancer?this.dehancer(e):e},t.prototype.set=function(e){var t=this.value;if((e=this.prepareNewValue(e))!==Le.UNCHANGED){var n=Xe();n&&Je({type:"update",name:this.name,newValue:e,oldValue:t}),this.setNewValue(e),n&&et()}},t.prototype.prepareNewValue=function(e){if(de(this),kt(this)){var t=Ot(this,{object:this,type:"update",newValue:e});if(!t)return Le.UNCHANGED;e=t.newValue}return e=this.enhancer(e,this.value,this.name),this.equals(this.value,e)?Le.UNCHANGED:e},t.prototype.setNewValue=function(e){var t=this.value;this.value=e,this.reportChanged(),_t(this)&&Tt(this,{type:"update",object:this,newValue:e,oldValue:t})},t.prototype.get=function(){return this.reportObserved(),this.dehanceValue(this.value)},t.prototype.intercept=function(e){return Et(this,e)},t.prototype.observe=function(e,t){return t&&e({object:this,type:"update",newValue:this.value,oldValue:void 0}),St(this,e)},t.prototype.toJSON=function(){return this.get()},t.prototype.toString=function(){return this.name+"["+this.value+"]"},t.prototype.valueOf=function(){return j(this.get())},t}(N);Ce.prototype[T()]=Ce.prototype.valueOf;E("ObservableValue",Ce);var Ie=function(){function e(e){this.dependenciesState=ie.NOT_TRACKING,this.observing=[],this.newObserving=null,this.isBeingObserved=!1,this.isPendingUnobservation=!1,this.observers=[],this.observersIndexes={},this.diffValue=0,this.runId=0,this.lastAccessedBy=0,this.lowestObserverState=ie.UP_TO_DATE,this.unboundDepsCount=0,this.__mapid="#"+h(),this.value=new ue(null),this.isComputing=!1,this.isRunningSetter=!1,this.isTracing=ae.NONE,this.derivation=e.get,this.name=e.name||"ComputedValue@"+h(),e.set&&(this.setter=Oe(this.name+"-setter",e.set)),this.equals=e.equals||(e.compareStructural||e.struct?F.structural:F.default),this.scope=e.context,this.requiresReaction=!!e.requiresReaction,this.keepAlive=!!e.keepAlive}return e.prototype.onBecomeStale=function(){!function(e){if(e.lowestObserverState!==ie.UP_TO_DATE)return;e.lowestObserverState=ie.POSSIBLY_STALE;var t=e.observers,n=t.length;for(;n--;){var r=t[n];r.dependenciesState===ie.UP_TO_DATE&&(r.dependenciesState=ie.POSSIBLY_STALE,r.isTracing!==ae.NONE&&$e(r,e),r.onBecomeStale())}}(this)},e.prototype.onBecomeUnobserved=function(){},e.prototype.onBecomeObserved=function(){},e.prototype.get=function(){this.isComputing&&m("Cycle detected in computation "+this.name+": "+this.derivation),0!==Le.inBatch||0!==this.observers.length||this.keepAlive?(Be(this),pe(this)&&this.trackAndCompute()&&function(e){if(e.lowestObserverState===ie.STALE)return;e.lowestObserverState=ie.STALE;var t=e.observers,n=t.length;for(;n--;){var r=t[n];r.dependenciesState===ie.POSSIBLY_STALE?r.dependenciesState=ie.STALE:r.dependenciesState===ie.UP_TO_DATE&&(e.lowestObserverState=ie.UP_TO_DATE)}}(this)):pe(this)&&(this.warnAboutUntrackedRead(),Ue(),this.value=this.computeValue(!1),ze());var e=this.value;if(fe(e))throw e.cause;return e},e.prototype.peek=function(){var e=this.computeValue(!1);if(fe(e))throw e.cause;return e},e.prototype.set=function(e){if(this.setter){g(!this.isRunningSetter,"The setter of computed value '"+this.name+"' is trying to update itself. Did you intend to update an _observable_ value, instead of the computed property?"),this.isRunningSetter=!0;try{this.setter.call(this.scope,e)}finally{this.isRunningSetter=!1}}else g(!1,!1)},e.prototype.trackAndCompute=function(){Xe()&&Ke({object:this.scope,type:"compute",name:this.name});var e=this.value,t=this.dependenciesState===ie.NOT_TRACKING,n=this.computeValue(!0),r=t||fe(e)||fe(n)||!this.equals(e,n);return r&&(this.value=n),r},e.prototype.computeValue=function(e){var t;if(this.isComputing=!0,Le.computationDepth++,e)t=he(this,this.derivation,this.scope);else if(!0===Le.disableErrorBoundaries)t=this.derivation.call(this.scope);else try{t=this.derivation.call(this.scope)}catch(e){t=new ue(e)}return Le.computationDepth--,this.isComputing=!1,t},e.prototype.suspend=function(){this.keepAlive||(me(this),this.value=void 0)},e.prototype.observe=function(e,t){var n=this,r=!0,o=void 0;return lt((function(){var i=n.get();if(!r||t){var a=ye();e({type:"update",object:n,newValue:i,oldValue:o}),ve(a)}r=!1,o=i}))},e.prototype.warnAboutUntrackedRead=function(){},e.prototype.toJSON=function(){return this.get()},e.prototype.toString=function(){return this.name+"["+this.derivation.toString()+"]"},e.prototype.valueOf=function(){return j(this.get())},e}();Ie.prototype[T()]=Ie.prototype.valueOf;var Ae=E("ComputedValue",Ie),Pe=function(){this.version=5,this.UNCHANGED={},this.trackingDerivation=null,this.computationDepth=0,this.runId=0,this.mobxGuid=0,this.inBatch=0,this.pendingUnobservations=[],this.pendingReactions=[],this.isRunningReactions=!1,this.allowStateChanges=!0,this.allowStateReads=!0,this.enforceActions=!1,this.spyListeners=[],this.globalReactionErrorHandlers=[],this.computedRequiresReaction=!1,this.reactionRequiresObservable=!1,this.observableRequiresReaction=!1,this.computedConfigurable=!1,this.disableErrorBoundaries=!1,this.suppressReactionErrors=!1},Re=!0,Ne=!1,Le=function(){var e=d();return e.__mobxInstanceCount>0&&!e.__mobxGlobals&&(Re=!1),e.__mobxGlobals&&e.__mobxGlobals.version!==(new Pe).version&&(Re=!1),Re?e.__mobxGlobals?(e.__mobxInstanceCount+=1,e.__mobxGlobals.UNCHANGED||(e.__mobxGlobals.UNCHANGED={}),e.__mobxGlobals):(e.__mobxInstanceCount=1,e.__mobxGlobals=new Pe):(setTimeout((function(){Ne||m("There are multiple, different versions of MobX active. Make sure MobX is loaded only once or use `configure({ isolateGlobalState: true })`")}),1),new Pe)}();function Me(e,t){var n=e.observers.length;n&&(e.observersIndexes[t.__mapid]=n),e.observers[n]=t,e.lowestObserverState>t.dependenciesState&&(e.lowestObserverState=t.dependenciesState)}function De(e,t){if(1===e.observers.length)e.observers.length=0,Fe(e);else{var n=e.observers,r=e.observersIndexes,o=n.pop();if(o!==t){var i=r[t.__mapid]||0;i?r[o.__mapid]=i:delete r[o.__mapid],n[i]=o}delete r[t.__mapid]}}function Fe(e){!1===e.isPendingUnobservation&&(e.isPendingUnobservation=!0,Le.pendingUnobservations.push(e))}function Ue(){Le.inBatch++}function ze(){if(0==--Le.inBatch){Ve();for(var e=Le.pendingUnobservations,t=0;t<e.length;t++){var n=e[t];n.isPendingUnobservation=!1,0===n.observers.length&&(n.isBeingObserved&&(n.isBeingObserved=!1,n.onBecomeUnobserved()),n instanceof Ie&&n.suspend())}Le.pendingUnobservations=[]}}function Be(e){var t=Le.trackingDerivation;return null!==t?(t.runId!==e.lastAccessedBy&&(e.lastAccessedBy=t.runId,t.newObserving[t.unboundDepsCount++]=e,e.isBeingObserved||(e.isBeingObserved=!0,e.onBecomeObserved())),!0):(0===e.observers.length&&Le.inBatch>0&&Fe(e),!1)}function $e(e,t){if(console.log("[mobx.trace] '"+e.name+"' is invalidated due to a change in: '"+t.name+"'"),e.isTracing===ae.BREAK){var n=[];!function e(t,n,r){if(n.length>=1e3)return void n.push("(and many more)");n.push(""+new Array(r).join("\t")+t.name),t.dependencies&&t.dependencies.forEach((function(t){return e(t,n,r+1)}))}(mt(e),n,1),new Function("debugger;\n/*\nTracing '"+e.name+"'\n\nYou are entering this break point because derivation '"+e.name+"' is being traced and '"+t.name+"' is now forcing it to update.\nJust follow the stacktrace you should now see in the devtools to see precisely what piece of your code is causing this update\nThe stackframe you are looking for is at least ~6-8 stack-frames up.\n\n"+(e instanceof Ie?e.derivation.toString().replace(/[*]\//g,"/"):"")+"\n\nThe dependencies for this derivation are:\n\n"+n.join("\n")+"\n*/\n ")()}}var qe=function(){function e(e,t,n,r){void 0===e&&(e="Reaction@"+h()),void 0===r&&(r=!1),this.name=e,this.onInvalidate=t,this.errorHandler=n,this.requiresObservable=r,this.observing=[],this.newObserving=[],this.dependenciesState=ie.NOT_TRACKING,this.diffValue=0,this.runId=0,this.unboundDepsCount=0,this.__mapid="#"+h(),this.isDisposed=!1,this._isScheduled=!1,this._isTrackPending=!1,this._isRunning=!1,this.isTracing=ae.NONE}return e.prototype.onBecomeStale=function(){this.schedule()},e.prototype.schedule=function(){this._isScheduled||(this._isScheduled=!0,Le.pendingReactions.push(this),Ve())},e.prototype.isScheduled=function(){return this._isScheduled},e.prototype.runReaction=function(){if(!this.isDisposed){if(Ue(),this._isScheduled=!1,pe(this)){this._isTrackPending=!0;try{this.onInvalidate(),this._isTrackPending&&Xe()&&Ke({name:this.name,type:"scheduled-reaction"})}catch(e){this.reportExceptionInDerivation(e)}}ze()}},e.prototype.track=function(e){Ue();var t,n=Xe();n&&(t=Date.now(),Je({name:this.name,type:"reaction"})),this._isRunning=!0;var r=he(this,e,void 0);this._isRunning=!1,this._isTrackPending=!1,this.isDisposed&&me(this),fe(r)&&this.reportExceptionInDerivation(r.cause),n&&et({time:Date.now()-t}),ze()},e.prototype.reportExceptionInDerivation=function(e){var t=this;if(this.errorHandler)this.errorHandler(e,this);else{if(Le.disableErrorBoundaries)throw e;var n="[mobx] Encountered an uncaught exception that was thrown by a reaction or observer component, in: '"+this+"'";Le.suppressReactionErrors?console.warn("[mobx] (error in reaction '"+this.name+"' suppressed, fix error of causing action below)"):console.error(n,e),Xe()&&Ke({type:"error",name:this.name,message:n,error:""+e}),Le.globalReactionErrorHandlers.forEach((function(n){return n(e,t)}))}},e.prototype.dispose=function(){this.isDisposed||(this.isDisposed=!0,this._isRunning||(Ue(),me(this),ze()))},e.prototype.getDisposer=function(){var e=this.dispose.bind(this);return e.$mobx=this,e},e.prototype.toString=function(){return"Reaction["+this.name+"]"},e.prototype.trace=function(e){void 0===e&&(e=!1),function(){for(var e=[],t=0;t<arguments.length;t++)e[t]=arguments[t];var n=!1;"boolean"==typeof e[e.length-1]&&(n=e.pop());var r=function(e){switch(e.length){case 0:return Le.trackingDerivation;case 1:return on(e[0]);case 2:return on(e[0],e[1])}}(e);if(!r)return m(!1);r.isTracing===ae.NONE&&console.log("[mobx.trace] '"+r.name+"' tracing enabled");r.isTracing=n?ae.BREAK:ae.LOG}(this,e)},e}();var We=100,He=function(e){return e()};function Ve(){Le.inBatch>0||Le.isRunningReactions||He(Ye)}function Ye(){Le.isRunningReactions=!0;for(var e=Le.pendingReactions,t=0;e.length>0;){++t===We&&(console.error("Reaction doesn't converge to a stable state after "+We+" iterations. Probably there is a cycle in the reactive function: "+e[0]),e.splice(0));for(var n=e.splice(0),r=0,o=n.length;r<o;r++)n[r].runReaction()}Le.isRunningReactions=!1}var Ge=E("Reaction",qe);function Qe(e){var t=He;He=function(n){return e((function(){return t(n)}))}}function Xe(){return!!Le.spyListeners.length}function Ke(e){if(Le.spyListeners.length)for(var t=Le.spyListeners,n=0,r=t.length;n<r;n++)t[n](e)}function Je(e){Ke(a(a({},e),{spyReportStart:!0}))}var Ze={spyReportEnd:!0};function et(e){Ke(e?a(a({},e),{spyReportEnd:!0}):Ze)}function tt(e){return Le.spyListeners.push(e),y((function(){Le.spyListeners=Le.spyListeners.filter((function(t){return t!==e}))}))}function nt(){m(!1)}function rt(e){return function(t,n,r){if(r){if(r.value)return{value:Oe(e,r.value),enumerable:!1,configurable:!0,writable:!0};var o=r.initializer;return{enumerable:!1,configurable:!0,writable:!0,initializer:function(){return Oe(e,o.call(this))}}}return ot(e).apply(this,arguments)}}function ot(e){return function(t,n,r){Object.defineProperty(t,n,{configurable:!0,enumerable:!1,get:function(){},set:function(t){x(this,n,it(e,t))}})}}var it=function(e,t,n,r){return 1===arguments.length&&"function"==typeof e?Oe(e.name||"<unnamed action>",e):2===arguments.length&&"function"==typeof t?Oe(e,t):1===arguments.length&&"string"==typeof e?rt(e):!0!==r?rt(t).apply(null,arguments):void(e[t]=Oe(e.name||t,n.value))};function at(e,t){return _e("string"==typeof e?e:e.name||"<unnamed action>","function"==typeof e?e:t,this,void 0)}function st(e,t,n){x(e,t,Oe(t,n.bind(e)))}function lt(e,t){void 0===t&&(t=f);var n,r=t&&t.name||e.name||"Autorun@"+h();if(!t.scheduler&&!t.delay)n=new qe(r,(function(){this.track(a)}),t.onError,t.requiresObservable);else{var o=ut(t),i=!1;n=new qe(r,(function(){i||(i=!0,o((function(){i=!1,n.isDisposed||n.track(a)})))}),t.onError,t.requiresObservable)}function a(){e(n)}return n.schedule(),n.getDisposer()}it.bound=function(e,t,n,r){return!0===r?(st(e,t,n.value),null):n?{configurable:!0,enumerable:!1,get:function(){return st(this,t,n.value||n.initializer.call(this)),this[t]},set:nt}:{enumerable:!1,configurable:!0,set:function(e){st(this,t,e)},get:function(){}}};var ct=function(e){return e()};function ut(e){return e.scheduler?e.scheduler:e.delay?function(t){return setTimeout(t,e.delay)}:ct}function ft(e,t,n){return pt("onBecomeUnobserved",e,t,n)}function pt(e,t,n,r){var o="function"==typeof r?on(t,n):on(t),i="function"==typeof r?r:n,a=o[e];return"function"!=typeof a?m(!1):(o[e]=function(){a.call(this),i.call(this)},function(){o[e]=a})}function dt(e){var t=e.enforceActions,n=e.computedRequiresReaction,r=e.computedConfigurable,o=e.disableErrorBoundaries,i=e.arrayBuffer,a=e.reactionScheduler,s=e.reactionRequiresObservable,l=e.observableRequiresReaction;if(!0===e.isolateGlobalState&&((Le.pendingReactions.length||Le.inBatch||Le.isRunningReactions)&&m("isolateGlobalState should be called before MobX is running any reactions"),Ne=!0,Re&&(0==--d().__mobxInstanceCount&&(d().__mobxGlobals=void 0),Le=new Pe)),void 0!==t){var c=void 0;switch(t){case!0:case"observed":c=!0;break;case!1:case"never":c=!1;break;case"strict":case"always":c="strict";break;default:m("Invalid value for 'enforceActions': '"+t+"', expected 'never', 'always' or 'observed'")}Le.enforceActions=c,Le.allowStateChanges=!0!==c&&"strict"!==c}void 0!==n&&(Le.computedRequiresReaction=!!n),void 0!==s&&(Le.reactionRequiresObservable=!!s),void 0!==l&&(Le.observableRequiresReaction=!!l,Le.allowStateReads=!Le.observableRequiresReaction),void 0!==r&&(Le.computedConfigurable=!!r),void 0!==o&&(!0===o&&console.warn("WARNING: Debug feature only. MobX will NOT recover from errors if this is on."),Le.disableErrorBoundaries=!!o),"number"==typeof i&&zt(i),a&&Qe(a)}function ht(e,t,n,r){var o=(r=X(r)).defaultDecorator||(!1===r.deep?ee:J);$(e),Kt(e,r.name,o.enhancer),Ue();try{for(var i in t){var a=Object.getOwnPropertyDescriptor(t,i);0;var s=(n&&i in n?n[i]:a.get?se:o)(e,i,a,!0);s&&Object.defineProperty(e,i,s)}}finally{ze()}return e}function mt(e,t){return gt(on(e,t))}function gt(e){var t,n,r={name:e.name};return e.observing&&e.observing.length>0&&(r.dependencies=(t=e.observing,n=[],t.forEach((function(e){-1===n.indexOf(e)&&n.push(e)})),n).map(gt)),r}function yt(){this.message="FLOW_CANCELLED"}function vt(e,t){if(null==e)return!1;if(void 0!==t){if(rn(e)){var n=e.$mobx;return n.values&&!!n.values[t]}return!1}return rn(e)||!!e.$mobx||L(e)||Ge(e)||Ae(e)}function bt(e){return 1!==arguments.length&&m(!1),vt(e)}function wt(e,t,n,r){return"function"==typeof n?function(e,t,n,r){return an(e,t).observe(n,r)}(e,t,n,r):function(e,t,n){return an(e).observe(t,n)}(e,t,n)}yt.prototype=Object.create(Error.prototype);function xt(e,t){void 0===t&&(t=void 0),Ue();try{return e.apply(t)}finally{ze()}}function kt(e){return void 0!==e.interceptors&&e.interceptors.length>0}function Et(e,t){var n=e.interceptors||(e.interceptors=[]);return n.push(t),y((function(){var e=n.indexOf(t);-1!==e&&n.splice(e,1)}))}function Ot(e,t){var n=ye();try{var r=e.interceptors;if(r)for(var o=0,i=r.length;o<i&&(g(!(t=r[o](t))||t.type,"Intercept handlers should return nothing or a change object"),t);o++);return t}finally{ve(n)}}function _t(e){return void 0!==e.changeListeners&&e.changeListeners.length>0}function St(e,t){var n=e.changeListeners||(e.changeListeners=[]);return n.push(t),y((function(){var e=n.indexOf(t);-1!==e&&n.splice(e,1)}))}function Tt(e,t){var n=ye(),r=e.changeListeners;if(r){for(var o=0,i=(r=r.slice()).length;o<i;o++)r[o](t);ve(n)}}var jt,Ct,It,At,Pt=(jt=!1,Ct={},Object.defineProperty(Ct,"0",{set:function(){jt=!0}}),Object.create(Ct)[0]=1,!1===jt),Rt=0,Nt=function(){};It=Nt,At=Array.prototype,void 0!==Object.setPrototypeOf?Object.setPrototypeOf(It.prototype,At):void 0!==It.prototype.__proto__?It.prototype.__proto__=At:It.prototype=At,Object.isFrozen(Array)&&["constructor","push","shift","concat","pop","unshift","replace","find","findIndex","splice","reverse","sort"].forEach((function(e){Object.defineProperty(Nt.prototype,e,{configurable:!0,writable:!0,value:Array.prototype[e]})}));var Lt=function(){function e(e,t,n,r){this.array=n,this.owned=r,this.values=[],this.lastKnownLength=0,this.atom=new N(e||"ObservableArray@"+h()),this.enhancer=function(n,r){return t(n,r,e+"[..]")}}return e.prototype.dehanceValue=function(e){return void 0!==this.dehancer?this.dehancer(e):e},e.prototype.dehanceValues=function(e){return void 0!==this.dehancer&&e.length>0?e.map(this.dehancer):e},e.prototype.intercept=function(e){return Et(this,e)},e.prototype.observe=function(e,t){return void 0===t&&(t=!1),t&&e({object:this.array,type:"splice",index:0,added:this.values.slice(),addedCount:this.values.length,removed:[],removedCount:0}),St(this,e)},e.prototype.getArrayLength=function(){return this.atom.reportObserved(),this.values.length},e.prototype.setArrayLength=function(e){if("number"!=typeof e||e<0)throw new Error("[mobx.array] Out of range: "+e);var t=this.values.length;if(e!==t)if(e>t){for(var n=new Array(e-t),r=0;r<e-t;r++)n[r]=void 0;this.spliceWithArray(t,0,n)}else this.spliceWithArray(e,t-e)},e.prototype.updateArrayLength=function(e,t){if(e!==this.lastKnownLength)throw new Error("[mobx] Modification exception: the internal structure of an observable array was changed. Did you use peek() to change it?");this.lastKnownLength+=t,t>0&&e+t+1>Rt&&zt(e+t+1)},e.prototype.spliceWithArray=function(e,t,n){var r=this;de(this.atom);var o=this.values.length;if(void 0===e?e=0:e>o?e=o:e<0&&(e=Math.max(0,o+e)),t=1===arguments.length?o-e:null==t?0:Math.max(0,Math.min(t,o-e)),void 0===n&&(n=u),kt(this)){var i=Ot(this,{object:this.array,type:"splice",index:e,removedCount:t,added:n});if(!i)return u;t=i.removedCount,n=i.added}var a=(n=0===n.length?n:n.map((function(e){return r.enhancer(e,void 0)}))).length-t;this.updateArrayLength(o,a);var s=this.spliceItemsIntoValues(e,t,n);return 0===t&&0===n.length||this.notifyArraySplice(e,n,s),this.dehanceValues(s)},e.prototype.spliceItemsIntoValues=function(e,t,n){var r;if(n.length<1e4)return(r=this.values).splice.apply(r,l([e,t],n));var o=this.values.slice(e,e+t);return this.values=this.values.slice(0,e).concat(n,this.values.slice(e+t)),o},e.prototype.notifyArrayChildUpdate=function(e,t,n){var r=!this.owned&&Xe(),o=_t(this),i=o||r?{object:this.array,type:"update",index:e,newValue:t,oldValue:n}:null;r&&Je(a(a({},i),{name:this.atom.name})),this.atom.reportChanged(),o&&Tt(this,i),r&&et()},e.prototype.notifyArraySplice=function(e,t,n){var r=!this.owned&&Xe(),o=_t(this),i=o||r?{object:this.array,type:"splice",index:e,removed:n,added:t,removedCount:n.length,addedCount:t.length}:null;r&&Je(a(a({},i),{name:this.atom.name})),this.atom.reportChanged(),o&&Tt(this,i),r&&et()},e}(),Mt=function(e){function t(t,n,r,o){void 0===r&&(r="ObservableArray@"+h()),void 0===o&&(o=!1);var i=e.call(this)||this,a=new Lt(r,n,i,o);if(k(i,"$mobx",a),t&&t.length){var s=Te(!0);i.spliceWithArray(0,0,t),je(s)}return Pt&&Object.defineProperty(a.array,"0",Dt),i}return i(t,e),t.prototype.intercept=function(e){return this.$mobx.intercept(e)},t.prototype.observe=function(e,t){return void 0===t&&(t=!1),this.$mobx.observe(e,t)},t.prototype.clear=function(){return this.splice(0)},t.prototype.concat=function(){for(var e=[],t=0;t<arguments.length;t++)e[t]=arguments[t];return this.$mobx.atom.reportObserved(),Array.prototype.concat.apply(this.peek(),e.map((function(e){return $t(e)?e.peek():e})))},t.prototype.replace=function(e){return this.$mobx.spliceWithArray(0,this.$mobx.values.length,e)},t.prototype.toJS=function(){return this.slice()},t.prototype.toJSON=function(){return this.toJS()},t.prototype.peek=function(){return this.$mobx.atom.reportObserved(),this.$mobx.dehanceValues(this.$mobx.values)},t.prototype.find=function(e,t,n){void 0===n&&(n=0),arguments.length;var r=this.findIndex.apply(this,arguments);return-1===r?void 0:this.get(r)},t.prototype.findIndex=function(e,t,n){void 0===n&&(n=0),arguments.length;for(var r=this.peek(),o=r.length,i=n;i<o;i++)if(e.call(t,r[i],i,this))return i;return-1},t.prototype.splice=function(e,t){for(var n=[],r=2;r<arguments.length;r++)n[r-2]=arguments[r];switch(arguments.length){case 0:return[];case 1:return this.$mobx.spliceWithArray(e);case 2:return this.$mobx.spliceWithArray(e,t)}return this.$mobx.spliceWithArray(e,t,n)},t.prototype.spliceWithArray=function(e,t,n){return this.$mobx.spliceWithArray(e,t,n)},t.prototype.push=function(){for(var e=[],t=0;t<arguments.length;t++)e[t]=arguments[t];var n=this.$mobx;return n.spliceWithArray(n.values.length,0,e),n.values.length},t.prototype.pop=function(){return this.splice(Math.max(this.$mobx.values.length-1,0),1)[0]},t.prototype.shift=function(){return this.splice(0,1)[0]},t.prototype.unshift=function(){for(var e=[],t=0;t<arguments.length;t++)e[t]=arguments[t];var n=this.$mobx;return n.spliceWithArray(0,0,e),n.values.length},t.prototype.reverse=function(){var e=this.slice();return e.reverse.apply(e,arguments)},t.prototype.sort=function(e){var t=this.slice();return t.sort.apply(t,arguments)},t.prototype.remove=function(e){var t=this.$mobx.dehanceValues(this.$mobx.values).indexOf(e);return t>-1&&(this.splice(t,1),!0)},t.prototype.move=function(e,t){function n(e){if(e<0)throw new Error("[mobx.array] Index out of bounds: "+e+" is negative");var t=this.$mobx.values.length;if(e>=t)throw new Error("[mobx.array] Index out of bounds: "+e+" is not smaller than "+t)}if(n.call(this,e),n.call(this,t),e!==t){var r,o=this.$mobx.values;r=e<t?l(o.slice(0,e),o.slice(e+1,t+1),[o[e]],o.slice(t+1)):l(o.slice(0,t),[o[e]],o.slice(t,e),o.slice(e+1)),this.replace(r)}},t.prototype.get=function(e){var t=this.$mobx;if(t){if(e<t.values.length)return t.atom.reportObserved(),t.dehanceValue(t.values[e]);console.warn("[mobx.array] Attempt to read an array index ("+e+") that is out of bounds ("+t.values.length+"). Please check length first. Out of bound indices will not be tracked by MobX")}},t.prototype.set=function(e,t){var n=this.$mobx,r=n.values;if(e<r.length){de(n.atom);var o=r[e];if(kt(n)){var i=Ot(n,{type:"update",object:this,index:e,newValue:t});if(!i)return;t=i.newValue}(t=n.enhancer(t,o))!==o&&(r[e]=t,n.notifyArrayChildUpdate(e,t,o))}else{if(e!==r.length)throw new Error("[mobx.array] Index out of bounds, "+e+" is larger than "+r.length);n.spliceWithArray(e,0,[t])}},t}(Nt);I(Mt.prototype,(function(){this.$mobx.atom.reportObserved();var e=this,t=0;return A({next:function(){return t<e.length?{value:e[t++],done:!1}:{done:!0,value:void 0}}})})),Object.defineProperty(Mt.prototype,"length",{enumerable:!1,configurable:!0,get:function(){return this.$mobx.getArrayLength()},set:function(e){this.$mobx.setArrayLength(e)}}),x(Mt.prototype,P(),"Array"),["every","filter","forEach","indexOf","join","lastIndexOf","map","reduce","reduceRight","slice","some","toString","toLocaleString"].forEach((function(e){var t=Array.prototype[e];g("function"==typeof t,"Base function not defined on Array prototype: '"+e+"'"),x(Mt.prototype,e,(function(){return t.apply(this.peek(),arguments)}))})),function(e,t){for(var n=0;n<t.length;n++)x(e,t[n],e[t[n]])}(Mt.prototype,["constructor","intercept","observe","clear","concat","get","replace","toJS","toJSON","peek","find","findIndex","splice","spliceWithArray","push","pop","set","shift","unshift","reverse","sort","remove","move","toString","toLocaleString"]);var Dt=Ft(0);function Ft(e){return{enumerable:!1,configurable:!1,get:function(){return this.get(e)},set:function(t){this.set(e,t)}}}function Ut(e){Object.defineProperty(Mt.prototype,""+e,Ft(e))}function zt(e){for(var t=Rt;t<e;t++)Ut(t);Rt=e}zt(1e3);var Bt=E("ObservableArrayAdministration",Lt);function $t(e){return b(e)&&Bt(e.$mobx)}var qt={},Wt=function(){function e(e,t,n){if(void 0===t&&(t=H),void 0===n&&(n="ObservableMap@"+h()),this.enhancer=t,this.name=n,this.$mobx=qt,this._keys=new Mt(void 0,V,this.name+".keys()",!0),"function"!=typeof Map)throw new Error("mobx.map requires Map polyfill for the current browser. Check babel-polyfill or core-js/es6/map.js");this._data=new Map,this._hasMap=new Map,this.merge(e)}return e.prototype._has=function(e){return this._data.has(e)},e.prototype.has=function(e){var t=this;if(!Le.trackingDerivation)return this._has(e);var n=this._hasMap.get(e);if(!n){var r=n=new Ce(this._has(e),V,this.name+"."+Ht(e)+"?",!1);this._hasMap.set(e,r),ft(r,(function(){return t._hasMap.delete(e)}))}return n.get()},e.prototype.set=function(e,t){var n=this._has(e);if(kt(this)){var r=Ot(this,{type:n?"update":"add",object:this,newValue:t,name:e});if(!r)return this;t=r.newValue}return n?this._updateValue(e,t):this._addValue(e,t),this},e.prototype.delete=function(e){var t=this;if(kt(this)&&!(o=Ot(this,{type:"delete",object:this,name:e})))return!1;if(this._has(e)){var n=Xe(),r=_t(this),o=r||n?{type:"delete",object:this,oldValue:this._data.get(e).value,name:e}:null;return n&&Je(a(a({},o),{name:this.name,key:e})),xt((function(){t._keys.remove(e),t._updateHasMapEntry(e,!1),t._data.get(e).setNewValue(void 0),t._data.delete(e)})),r&&Tt(this,o),n&&et(),!0}return!1},e.prototype._updateHasMapEntry=function(e,t){var n=this._hasMap.get(e);n&&n.setNewValue(t)},e.prototype._updateValue=function(e,t){var n=this._data.get(e);if((t=n.prepareNewValue(t))!==Le.UNCHANGED){var r=Xe(),o=_t(this),i=o||r?{type:"update",object:this,oldValue:n.value,name:e,newValue:t}:null;r&&Je(a(a({},i),{name:this.name,key:e})),n.setNewValue(t),o&&Tt(this,i),r&&et()}},e.prototype._addValue=function(e,t){var n=this;xt((function(){var r=new Ce(t,n.enhancer,n.name+"."+Ht(e),!1);n._data.set(e,r),t=r.value,n._updateHasMapEntry(e,!0),n._keys.push(e)}));var r=Xe(),o=_t(this),i=o||r?{type:"add",object:this,name:e,newValue:t}:null;r&&Je(a(a({},i),{name:this.name,key:e})),o&&Tt(this,i),r&&et()},e.prototype.get=function(e){return this.has(e)?this.dehanceValue(this._data.get(e).get()):this.dehanceValue(void 0)},e.prototype.dehanceValue=function(e){return void 0!==this.dehancer?this.dehancer(e):e},e.prototype.keys=function(){return this._keys[C()]()},e.prototype.values=function(){var e=this,t=0;return A({next:function(){return t<e._keys.length?{value:e.get(e._keys[t++]),done:!1}:{value:void 0,done:!0}}})},e.prototype.entries=function(){var e=this,t=0;return A({next:function(){if(t<e._keys.length){var n=e._keys[t++];return{value:[n,e.get(n)],done:!1}}return{done:!0}}})},e.prototype.forEach=function(e,t){var n=this;this._keys.forEach((function(r){return e.call(t,n.get(r),r,n)}))},e.prototype.merge=function(e){var t=this;return Vt(e)&&(e=e.toJS()),xt((function(){w(e)?Object.keys(e).forEach((function(n){return t.set(n,e[n])})):Array.isArray(e)?e.forEach((function(e){var n=s(e,2),r=n[0],o=n[1];return t.set(r,o)})):O(e)?e.constructor!==Map?m("Cannot initialize from classes that inherit from Map: "+e.constructor.name):e.forEach((function(e,n){return t.set(n,e)})):null!=e&&m("Cannot initialize map from "+e)})),this},e.prototype.clear=function(){var e=this;xt((function(){ge((function(){e._keys.slice().forEach((function(t){return e.delete(t)}))}))}))},e.prototype.replace=function(e){var t=this;return xt((function(){for(var n,r=O(n=e)||Vt(n)?n:Array.isArray(n)?new Map(n):w(n)?new Map(Object.entries(n)):m("Cannot convert to map from '"+n+"'"),o=t._keys,i=Array.from(r.keys()),a=!1,s=0;s<o.length;s++){var l=o[s];o.length===i.length&&l!==i[s]&&(a=!0),r.has(l)||(a=!0,t.delete(l))}r.forEach((function(e,n){t._data.has(n)||(a=!0),t.set(n,e)})),a&&t._keys.replace(i)})),this},Object.defineProperty(e.prototype,"size",{get:function(){return this._keys.length},enumerable:!0,configurable:!0}),e.prototype.toPOJO=function(){var e=this,t={};return this._keys.forEach((function(n){return t["symbol"==typeof n?n:Ht(n)]=e.get(n)})),t},e.prototype.toJS=function(){var e=this,t=new Map;return this._keys.forEach((function(n){return t.set(n,e.get(n))})),t},e.prototype.toJSON=function(){return this.toPOJO()},e.prototype.toString=function(){var e=this;return this.name+"[{ "+this._keys.map((function(t){return Ht(t)+": "+e.get(t)})).join(", ")+" }]"},e.prototype.observe=function(e,t){return St(this,e)},e.prototype.intercept=function(e){return Et(this,e)},e}();function Ht(e){return e&&e.toString?e.toString():new String(e).toString()}I(Wt.prototype,(function(){return this.entries()})),k(Wt.prototype,P(),"Map");var Vt=E("ObservableMap",Wt),Yt={},Gt=function(){function e(e,t,n){if(void 0===t&&(t=H),void 0===n&&(n="ObservableSet@"+h()),this.name=n,this.$mobx=Yt,this._data=new Set,this._atom=M(this.name),"function"!=typeof Set)throw new Error("mobx.set requires Set polyfill for the current browser. Check babel-polyfill or core-js/es6/set.js");this.enhancer=function(e,r){return t(e,r,n)},e&&this.replace(e)}return e.prototype.dehanceValue=function(e){return void 0!==this.dehancer?this.dehancer(e):e},e.prototype.clear=function(){var e=this;xt((function(){ge((function(){e._data.forEach((function(t){e.delete(t)}))}))}))},e.prototype.forEach=function(e,t){var n=this;this._data.forEach((function(r){e.call(t,r,r,n)}))},Object.defineProperty(e.prototype,"size",{get:function(){return this._atom.reportObserved(),this._data.size},enumerable:!0,configurable:!0}),e.prototype.add=function(e){var t=this;if((de(this._atom),kt(this))&&!(o=Ot(this,{type:"add",object:this,newValue:e})))return this;if(!this.has(e)){xt((function(){t._data.add(t.enhancer(e,void 0)),t._atom.reportChanged()}));var n=Xe(),r=_t(this),o=r||n?{type:"add",object:this,newValue:e}:null;0,r&&Tt(this,o)}return this},e.prototype.delete=function(e){var t=this;if(kt(this)&&!(o=Ot(this,{type:"delete",object:this,oldValue:e})))return!1;if(this.has(e)){var n=Xe(),r=_t(this),o=r||n?{type:"delete",object:this,oldValue:e}:null;return xt((function(){t._atom.reportChanged(),t._data.delete(e)})),r&&Tt(this,o),!0}return!1},e.prototype.has=function(e){return this._atom.reportObserved(),this._data.has(this.dehanceValue(e))},e.prototype.entries=function(){var e=0,t=S(this.keys()),n=S(this.values());return A({next:function(){var r=e;return e+=1,r<n.length?{value:[t[r],n[r]],done:!1}:{done:!0}}})},e.prototype.keys=function(){return this.values()},e.prototype.values=function(){this._atom.reportObserved();var e,t=this,n=0;return void 0!==this._data.values?e=S(this._data.values()):(e=[],this._data.forEach((function(t){return e.push(t)}))),A({next:function(){return n<e.length?{value:t.dehanceValue(e[n++]),done:!1}:{done:!0}}})},e.prototype.replace=function(e){var t=this;return Qt(e)&&(e=e.toJS()),xt((function(){Array.isArray(e)?(t.clear(),e.forEach((function(e){return t.add(e)}))):_(e)?(t.clear(),e.forEach((function(e){return t.add(e)}))):null!=e&&m("Cannot initialize set from "+e)})),this},e.prototype.observe=function(e,t){return St(this,e)},e.prototype.intercept=function(e){return Et(this,e)},e.prototype.toJS=function(){return new Set(this)},e.prototype.toString=function(){return this.name+"[ "+S(this.keys()).join(", ")+" ]"},e}();I(Gt.prototype,(function(){return this.values()})),k(Gt.prototype,P(),"Set");var Qt=E("ObservableSet",Gt),Xt=function(){function e(e,t,n){this.target=e,this.name=t,this.defaultEnhancer=n,this.values={}}return e.prototype.read=function(e,t){if(this.target===e||(this.illegalAccess(e,t),this.values[t]))return this.values[t].get()},e.prototype.write=function(e,t,n){var r=this.target;r!==e&&this.illegalAccess(e,t);var o=this.values[t];if(o instanceof Ie)o.set(n);else{if(kt(this)){if(!(l=Ot(this,{type:"update",object:r,name:t,newValue:n})))return;n=l.newValue}if((n=o.prepareNewValue(n))!==Le.UNCHANGED){var i=_t(this),s=Xe(),l=i||s?{type:"update",object:r,oldValue:o.value,name:t,newValue:n}:null;s&&Je(a(a({},l),{name:this.name,key:t})),o.setNewValue(n),i&&Tt(this,l),s&&et()}}},e.prototype.remove=function(e){if(this.values[e]){var t=this.target;if(kt(this))if(!(i=Ot(this,{object:t,name:e,type:"remove"})))return;try{Ue();var n=_t(this),r=Xe(),o=this.values[e].get();this.keys&&this.keys.remove(e),delete this.values[e],delete this.target[e];var i=n||r?{type:"remove",object:t,oldValue:o,name:e}:null;r&&Je(a(a({},i),{name:this.name,key:e})),n&&Tt(this,i),r&&et()}finally{ze()}}},e.prototype.illegalAccess=function(e,t){console.warn("Property '"+t+"' of '"+e+"' was accessed through the prototype chain. Use 'decorate' instead to declare the prop or access it statically through it's owner")},e.prototype.observe=function(e,t){return St(this,e)},e.prototype.intercept=function(e){return Et(this,e)},e.prototype.getKeys=function(){var e=this;return void 0===this.keys&&(this.keys=new Mt(Object.keys(this.values).filter((function(t){return e.values[t]instanceof Ce})),V,"keys("+this.name+")",!0)),this.keys.slice()},e}();function Kt(e,t,n){void 0===t&&(t=""),void 0===n&&(n=H);var r=e.$mobx;return r||(w(e)||(t=(e.constructor.name||"ObservableObject")+"@"+h()),t||(t="ObservableObject@"+h()),k(e,"$mobx",r=new Xt(e,t,n)),r)}function Jt(e,t,n,r){var o=Kt(e);if(kt(o)){var i=Ot(o,{object:e,name:t,type:"add",newValue:n});if(!i)return;n=i.newValue}n=(o.values[t]=new Ce(n,r,o.name+"."+t,!1)).value,Object.defineProperty(e,t,function(e){return Zt[e]||(Zt[e]={configurable:!0,enumerable:!0,get:function(){return this.$mobx.read(this,e)},set:function(t){this.$mobx.write(this,e,t)}})}(t)),o.keys&&o.keys.push(t),function(e,t,n,r){var o=_t(e),i=Xe(),s=o||i?{type:"add",object:t,name:n,newValue:r}:null;i&&Je(a(a({},s),{name:e.name,key:n}));o&&Tt(e,s);i&&et()}(o,e,t,n)}var Zt=Object.create(null),en=Object.create(null);function tn(e){var t=e.$mobx;return t||($(e),e.$mobx)}var nn=E("ObservableObjectAdministration",Xt);function rn(e){return!!b(e)&&($(e),nn(e.$mobx))}function on(e,t){if("object"==typeof e&&null!==e){if($t(e))return void 0!==t&&m(!1),e.$mobx.atom;if(Qt(e))return e.$mobx;if(Vt(e)){var n=e;return void 0===t?on(n._keys):((r=n._data.get(t)||n._hasMap.get(t))||m(!1),r)}var r;if($(e),t&&!e.$mobx&&e[t],rn(e))return t?((r=e.$mobx.values[t])||m(!1),r):m(!1);if(L(e)||Ae(e)||Ge(e))return e}else if("function"==typeof e&&Ge(e.$mobx))return e.$mobx;return m(!1)}function an(e,t){return e||m("Expecting some object"),void 0!==t?an(on(e,t)):L(e)||Ae(e)||Ge(e)?e:Vt(e)||Qt(e)?e:($(e),e.$mobx?e.$mobx:void m(!1))}var sn=Object.prototype.toString;function ln(e,t,n){return void 0===n&&(n=-1),function e(t,n,r,o,i){if(t===n)return 0!==t||1/t==1/n;if(null==t||null==n)return!1;if(t!=t)return n!=n;var a=typeof t;if("function"!==a&&"object"!==a&&"object"!=typeof n)return!1;t=cn(t),n=cn(n);var s=sn.call(t);if(s!==sn.call(n))return!1;switch(s){case"[object RegExp]":case"[object String]":return""+t==""+n;case"[object Number]":return+t!=+t?+n!=+n:0==+t?1/+t==1/n:+t==+n;case"[object Date]":case"[object Boolean]":return+t==+n;case"[object Symbol]":return"undefined"!=typeof Symbol&&Symbol.valueOf.call(t)===Symbol.valueOf.call(n)}var l="[object Array]"===s;if(!l){if("object"!=typeof t||"object"!=typeof n)return!1;var c=t.constructor,u=n.constructor;if(c!==u&&!("function"==typeof c&&c instanceof c&&"function"==typeof u&&u instanceof u)&&"constructor"in t&&"constructor"in n)return!1}if(0===r)return!1;r<0&&(r=-1);i=i||[];var f=(o=o||[]).length;for(;f--;)if(o[f]===t)return i[f]===n;if(o.push(t),i.push(n),l){if((f=t.length)!==n.length)return!1;for(;f--;)if(!e(t[f],n[f],r-1,o,i))return!1}else{var p=Object.keys(t),d=void 0;if(f=p.length,Object.keys(n).length!==f)return!1;for(;f--;)if(d=p[f],!un(n,d)||!e(t[d],n[d],r-1,o,i))return!1}return o.pop(),i.pop(),!0}(e,t,n)}function cn(e){return $t(e)?e.peek():O(e)||Vt(e)?S(e.entries()):_(e)||Qt(e)?S(e.entries()):e}function un(e,t){return Object.prototype.hasOwnProperty.call(e,t)}var fn="$mobx";"object"==typeof __MOBX_DEVTOOLS_GLOBAL_HOOK__&&__MOBX_DEVTOOLS_GLOBAL_HOOK__.injectMobx({spy:tt,extras:{getDebugName:function(e,t){return(void 0!==t?on(e,t):rn(e)||Vt(e)||Qt(e)?an(e):on(e)).name}},$mobx:fn})}).call(this,n(6),n(13))},function(e,t,n){(function(t){var n=function(e){return e&&e.Math==Math&&e};e.exports=n("object"==typeof globalThis&&globalThis)||n("object"==typeof window&&window)||n("object"==typeof self&&self)||n("object"==typeof t&&t)||Function("return this")()}).call(this,n(6))},function(e,t,n){var r=n(3),o=n(66),i=n(12),a=n(53),s=n(69),l=n(100),c=o("wks"),u=r.Symbol,f=l?u:a;e.exports=function(e){return i(c,e)||(s&&i(u,e)?c[e]=u[e]:c[e]=f("Symbol."+e)),c[e]}},function(e,t,n){"use strict";var r=n(57),o=["kind","resolve","construct","instanceOf","predicate","represent","defaultStyle","styleAliases"],i=["scalar","sequence","mapping"];e.exports=function(e,t){var n,a;if(t=t||{},Object.keys(t).forEach((function(t){if(-1===o.indexOf(t))throw new r('Unknown option "'+t+'" is met in definition of "'+e+'" YAML type.')})),this.tag=e,this.kind=t.kind||null,this.resolve=t.resolve||function(){return!0},this.construct=t.construct||function(e){return e},this.instanceOf=t.instanceOf||null,this.predicate=t.predicate||null,this.represent=t.represent||null,this.defaultStyle=t.defaultStyle||null,this.styleAliases=(n=t.styleAliases||null,a={},null!==n&&Object.keys(n).forEach((function(e){n[e].forEach((function(t){a[String(t)]=e}))})),a),-1===i.indexOf(this.kind))throw new r('Unknown kind "'+this.kind+'" is specified for "'+e+'" YAML type.')}},function(e,t){var n;n=function(){return this}();try{n=n||new Function("return this")()}catch(e){"object"==typeof window&&(n=window)}e.exports=n},function(e,t){e.exports=function(e){return"object"==typeof e?null!==e:"function"==typeof e}},function(e,t,n){"use strict";var r=n(228),o=n(230);function i(){this.protocol=null,this.slashes=null,this.auth=null,this.host=null,this.port=null,this.hostname=null,this.hash=null,this.search=null,this.query=null,this.pathname=null,this.path=null,this.href=null}t.parse=b,t.resolve=function(e,t){return b(e,!1,!0).resolve(t)},t.resolveObject=function(e,t){return e?b(e,!1,!0).resolveObject(t):t},t.format=function(e){o.isString(e)&&(e=b(e));return e instanceof i?e.format():i.prototype.format.call(e)},t.Url=i;var a=/^([a-z0-9.+-]+:)/i,s=/:[0-9]*$/,l=/^(\/\/?(?!\/)[^\?\s]*)(\?[^\s]*)?$/,c=["{","}","|","\\","^","`"].concat(["<",">",'"',"`"," ","\r","\n","\t"]),u=["'"].concat(c),f=["%","/","?",";","#"].concat(u),p=["/","?","#"],d=/^[+a-z0-9A-Z_-]{0,63}$/,h=/^([+a-z0-9A-Z_-]{0,63})(.*)$/,m={javascript:!0,"javascript:":!0},g={javascript:!0,"javascript:":!0},y={http:!0,https:!0,ftp:!0,gopher:!0,file:!0,"http:":!0,"https:":!0,"ftp:":!0,"gopher:":!0,"file:":!0},v=n(231);function b(e,t,n){if(e&&o.isObject(e)&&e instanceof i)return e;var r=new i;return r.parse(e,t,n),r}i.prototype.parse=function(e,t,n){if(!o.isString(e))throw new TypeError("Parameter 'url' must be a string, not "+typeof e);var i=e.indexOf("?"),s=-1!==i&&i<e.indexOf("#")?"?":"#",c=e.split(s);c[0]=c[0].replace(/\\/g,"/");var b=e=c.join(s);if(b=b.trim(),!n&&1===e.split("#").length){var w=l.exec(b);if(w)return this.path=b,this.href=b,this.pathname=w[1],w[2]?(this.search=w[2],this.query=t?v.parse(this.search.substr(1)):this.search.substr(1)):t&&(this.search="",this.query={}),this}var x=a.exec(b);if(x){var k=(x=x[0]).toLowerCase();this.protocol=k,b=b.substr(x.length)}if(n||x||b.match(/^\/\/[^@\/]+@[^@\/]+/)){var E="//"===b.substr(0,2);!E||x&&g[x]||(b=b.substr(2),this.slashes=!0)}if(!g[x]&&(E||x&&!y[x])){for(var O,_,S=-1,T=0;T<p.length;T++){-1!==(j=b.indexOf(p[T]))&&(-1===S||j<S)&&(S=j)}-1!==(_=-1===S?b.lastIndexOf("@"):b.lastIndexOf("@",S))&&(O=b.slice(0,_),b=b.slice(_+1),this.auth=decodeURIComponent(O)),S=-1;for(T=0;T<f.length;T++){var j;-1!==(j=b.indexOf(f[T]))&&(-1===S||j<S)&&(S=j)}-1===S&&(S=b.length),this.host=b.slice(0,S),b=b.slice(S),this.parseHost(),this.hostname=this.hostname||"";var C="["===this.hostname[0]&&"]"===this.hostname[this.hostname.length-1];if(!C)for(var I=this.hostname.split(/\./),A=(T=0,I.length);T<A;T++){var P=I[T];if(P&&!P.match(d)){for(var R="",N=0,L=P.length;N<L;N++)P.charCodeAt(N)>127?R+="x":R+=P[N];if(!R.match(d)){var M=I.slice(0,T),D=I.slice(T+1),F=P.match(h);F&&(M.push(F[1]),D.unshift(F[2])),D.length&&(b="/"+D.join(".")+b),this.hostname=M.join(".");break}}}this.hostname.length>255?this.hostname="":this.hostname=this.hostname.toLowerCase(),C||(this.hostname=r.toASCII(this.hostname));var U=this.port?":"+this.port:"",z=this.hostname||"";this.host=z+U,this.href+=this.host,C&&(this.hostname=this.hostname.substr(1,this.hostname.length-2),"/"!==b[0]&&(b="/"+b))}if(!m[k])for(T=0,A=u.length;T<A;T++){var B=u[T];if(-1!==b.indexOf(B)){var $=encodeURIComponent(B);$===B&&($=escape(B)),b=b.split(B).join($)}}var q=b.indexOf("#");-1!==q&&(this.hash=b.substr(q),b=b.slice(0,q));var W=b.indexOf("?");if(-1!==W?(this.search=b.substr(W),this.query=b.substr(W+1),t&&(this.query=v.parse(this.query)),b=b.slice(0,W)):t&&(this.search="",this.query={}),b&&(this.pathname=b),y[k]&&this.hostname&&!this.pathname&&(this.pathname="/"),this.pathname||this.search){U=this.pathname||"";var H=this.search||"";this.path=U+H}return this.href=this.format(),this},i.prototype.format=function(){var e=this.auth||"";e&&(e=(e=encodeURIComponent(e)).replace(/%3A/i,":"),e+="@");var t=this.protocol||"",n=this.pathname||"",r=this.hash||"",i=!1,a="";this.host?i=e+this.host:this.hostname&&(i=e+(-1===this.hostname.indexOf(":")?this.hostname:"["+this.hostname+"]"),this.port&&(i+=":"+this.port)),this.query&&o.isObject(this.query)&&Object.keys(this.query).length&&(a=v.stringify(this.query));var s=this.search||a&&"?"+a||"";return t&&":"!==t.substr(-1)&&(t+=":"),this.slashes||(!t||y[t])&&!1!==i?(i="//"+(i||""),n&&"/"!==n.charAt(0)&&(n="/"+n)):i||(i=""),r&&"#"!==r.charAt(0)&&(r="#"+r),s&&"?"!==s.charAt(0)&&(s="?"+s),t+i+(n=n.replace(/[?#]/g,(function(e){return encodeURIComponent(e)})))+(s=s.replace("#","%23"))+r},i.prototype.resolve=function(e){return this.resolveObject(b(e,!1,!0)).format()},i.prototype.resolveObject=function(e){if(o.isString(e)){var t=new i;t.parse(e,!1,!0),e=t}for(var n=new i,r=Object.keys(this),a=0;a<r.length;a++){var s=r[a];n[s]=this[s]}if(n.hash=e.hash,""===e.href)return n.href=n.format(),n;if(e.slashes&&!e.protocol){for(var l=Object.keys(e),c=0;c<l.length;c++){var u=l[c];"protocol"!==u&&(n[u]=e[u])}return y[n.protocol]&&n.hostname&&!n.pathname&&(n.path=n.pathname="/"),n.href=n.format(),n}if(e.protocol&&e.protocol!==n.protocol){if(!y[e.protocol]){for(var f=Object.keys(e),p=0;p<f.length;p++){var d=f[p];n[d]=e[d]}return n.href=n.format(),n}if(n.protocol=e.protocol,e.host||g[e.protocol])n.pathname=e.pathname;else{for(var h=(e.pathname||"").split("/");h.length&&!(e.host=h.shift()););e.host||(e.host=""),e.hostname||(e.hostname=""),""!==h[0]&&h.unshift(""),h.length<2&&h.unshift(""),n.pathname=h.join("/")}if(n.search=e.search,n.query=e.query,n.host=e.host||"",n.auth=e.auth,n.hostname=e.hostname||e.host,n.port=e.port,n.pathname||n.search){var m=n.pathname||"",v=n.search||"";n.path=m+v}return n.slashes=n.slashes||e.slashes,n.href=n.format(),n}var b=n.pathname&&"/"===n.pathname.charAt(0),w=e.host||e.pathname&&"/"===e.pathname.charAt(0),x=w||b||n.host&&e.pathname,k=x,E=n.pathname&&n.pathname.split("/")||[],O=(h=e.pathname&&e.pathname.split("/")||[],n.protocol&&!y[n.protocol]);if(O&&(n.hostname="",n.port=null,n.host&&(""===E[0]?E[0]=n.host:E.unshift(n.host)),n.host="",e.protocol&&(e.hostname=null,e.port=null,e.host&&(""===h[0]?h[0]=e.host:h.unshift(e.host)),e.host=null),x=x&&(""===h[0]||""===E[0])),w)n.host=e.host||""===e.host?e.host:n.host,n.hostname=e.hostname||""===e.hostname?e.hostname:n.hostname,n.search=e.search,n.query=e.query,E=h;else if(h.length)E||(E=[]),E.pop(),E=E.concat(h),n.search=e.search,n.query=e.query;else if(!o.isNullOrUndefined(e.search)){if(O)n.hostname=n.host=E.shift(),(C=!!(n.host&&n.host.indexOf("@")>0)&&n.host.split("@"))&&(n.auth=C.shift(),n.host=n.hostname=C.shift());return n.search=e.search,n.query=e.query,o.isNull(n.pathname)&&o.isNull(n.search)||(n.path=(n.pathname?n.pathname:"")+(n.search?n.search:"")),n.href=n.format(),n}if(!E.length)return n.pathname=null,n.search?n.path="/"+n.search:n.path=null,n.href=n.format(),n;for(var _=E.slice(-1)[0],S=(n.host||e.host||E.length>1)&&("."===_||".."===_)||""===_,T=0,j=E.length;j>=0;j--)"."===(_=E[j])?E.splice(j,1):".."===_?(E.splice(j,1),T++):T&&(E.splice(j,1),T--);if(!x&&!k)for(;T--;T)E.unshift("..");!x||""===E[0]||E[0]&&"/"===E[0].charAt(0)||E.unshift(""),S&&"/"!==E.join("/").substr(-1)&&E.push("");var C,I=""===E[0]||E[0]&&"/"===E[0].charAt(0);O&&(n.hostname=n.host=I?"":E.length?E.shift():"",(C=!!(n.host&&n.host.indexOf("@")>0)&&n.host.split("@"))&&(n.auth=C.shift(),n.host=n.hostname=C.shift()));return(x=x||n.host&&E.length)&&!I&&E.unshift(""),E.length?n.pathname=E.join("/"):(n.pathname=null,n.path=null),o.isNull(n.pathname)&&o.isNull(n.search)||(n.path=(n.pathname?n.pathname:"")+(n.search?n.search:"")),n.auth=e.auth||n.auth,n.slashes=n.slashes||e.slashes,n.href=n.format(),n},i.prototype.parseHost=function(){var e=this.host,t=s.exec(e);t&&(":"!==(t=t[0])&&(this.port=t.substr(1)),e=e.substr(0,e.length-t.length)),e&&(this.hostname=e)}},function(e,t){e.exports=function(e){try{return!!e()}catch(e){return!0}}},function(e,t,n){var r=n(34),o=n(12),i=n(126),a=n(15).f;e.exports=function(e){var t=r.Symbol||(r.Symbol={});o(t,e)||a(t,e,{value:i.f(e)})}},function(e,t,n){"use strict";(function(e){
|
||
/*!
|
||
* The buffer module from node.js, for the browser.
|
||
*
|
||
* @author Feross Aboukhadijeh <http://feross.org>
|
||
* @license MIT
|
||
*/
|
||
var r=n(235),o=n(236),i=n(128);function a(){return l.TYPED_ARRAY_SUPPORT?2147483647:1073741823}function s(e,t){if(a()<t)throw new RangeError("Invalid typed array length");return l.TYPED_ARRAY_SUPPORT?(e=new Uint8Array(t)).__proto__=l.prototype:(null===e&&(e=new l(t)),e.length=t),e}function l(e,t,n){if(!(l.TYPED_ARRAY_SUPPORT||this instanceof l))return new l(e,t,n);if("number"==typeof e){if("string"==typeof t)throw new Error("If encoding is specified then the first argument must be a string");return f(this,e)}return c(this,e,t,n)}function c(e,t,n,r){if("number"==typeof t)throw new TypeError('"value" argument must not be a number');return"undefined"!=typeof ArrayBuffer&&t instanceof ArrayBuffer?function(e,t,n,r){if(t.byteLength,n<0||t.byteLength<n)throw new RangeError("'offset' is out of bounds");if(t.byteLength<n+(r||0))throw new RangeError("'length' is out of bounds");t=void 0===n&&void 0===r?new Uint8Array(t):void 0===r?new Uint8Array(t,n):new Uint8Array(t,n,r);l.TYPED_ARRAY_SUPPORT?(e=t).__proto__=l.prototype:e=p(e,t);return e}(e,t,n,r):"string"==typeof t?function(e,t,n){"string"==typeof n&&""!==n||(n="utf8");if(!l.isEncoding(n))throw new TypeError('"encoding" must be a valid string encoding');var r=0|h(t,n),o=(e=s(e,r)).write(t,n);o!==r&&(e=e.slice(0,o));return e}(e,t,n):function(e,t){if(l.isBuffer(t)){var n=0|d(t.length);return 0===(e=s(e,n)).length?e:(t.copy(e,0,0,n),e)}if(t){if("undefined"!=typeof ArrayBuffer&&t.buffer instanceof ArrayBuffer||"length"in t)return"number"!=typeof t.length||(r=t.length)!=r?s(e,0):p(e,t);if("Buffer"===t.type&&i(t.data))return p(e,t.data)}var r;throw new TypeError("First argument must be a string, Buffer, ArrayBuffer, Array, or array-like object.")}(e,t)}function u(e){if("number"!=typeof e)throw new TypeError('"size" argument must be a number');if(e<0)throw new RangeError('"size" argument must not be negative')}function f(e,t){if(u(t),e=s(e,t<0?0:0|d(t)),!l.TYPED_ARRAY_SUPPORT)for(var n=0;n<t;++n)e[n]=0;return e}function p(e,t){var n=t.length<0?0:0|d(t.length);e=s(e,n);for(var r=0;r<n;r+=1)e[r]=255&t[r];return e}function d(e){if(e>=a())throw new RangeError("Attempt to allocate Buffer larger than maximum size: 0x"+a().toString(16)+" bytes");return 0|e}function h(e,t){if(l.isBuffer(e))return e.length;if("undefined"!=typeof ArrayBuffer&&"function"==typeof ArrayBuffer.isView&&(ArrayBuffer.isView(e)||e instanceof ArrayBuffer))return e.byteLength;"string"!=typeof e&&(e=""+e);var n=e.length;if(0===n)return 0;for(var r=!1;;)switch(t){case"ascii":case"latin1":case"binary":return n;case"utf8":case"utf-8":case void 0:return B(e).length;case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return 2*n;case"hex":return n>>>1;case"base64":return $(e).length;default:if(r)return B(e).length;t=(""+t).toLowerCase(),r=!0}}function m(e,t,n){var r=!1;if((void 0===t||t<0)&&(t=0),t>this.length)return"";if((void 0===n||n>this.length)&&(n=this.length),n<=0)return"";if((n>>>=0)<=(t>>>=0))return"";for(e||(e="utf8");;)switch(e){case"hex":return I(this,t,n);case"utf8":case"utf-8":return S(this,t,n);case"ascii":return j(this,t,n);case"latin1":case"binary":return C(this,t,n);case"base64":return _(this,t,n);case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return A(this,t,n);default:if(r)throw new TypeError("Unknown encoding: "+e);e=(e+"").toLowerCase(),r=!0}}function g(e,t,n){var r=e[t];e[t]=e[n],e[n]=r}function y(e,t,n,r,o){if(0===e.length)return-1;if("string"==typeof n?(r=n,n=0):n>2147483647?n=2147483647:n<-2147483648&&(n=-2147483648),n=+n,isNaN(n)&&(n=o?0:e.length-1),n<0&&(n=e.length+n),n>=e.length){if(o)return-1;n=e.length-1}else if(n<0){if(!o)return-1;n=0}if("string"==typeof t&&(t=l.from(t,r)),l.isBuffer(t))return 0===t.length?-1:v(e,t,n,r,o);if("number"==typeof t)return t&=255,l.TYPED_ARRAY_SUPPORT&&"function"==typeof Uint8Array.prototype.indexOf?o?Uint8Array.prototype.indexOf.call(e,t,n):Uint8Array.prototype.lastIndexOf.call(e,t,n):v(e,[t],n,r,o);throw new TypeError("val must be string, number or Buffer")}function v(e,t,n,r,o){var i,a=1,s=e.length,l=t.length;if(void 0!==r&&("ucs2"===(r=String(r).toLowerCase())||"ucs-2"===r||"utf16le"===r||"utf-16le"===r)){if(e.length<2||t.length<2)return-1;a=2,s/=2,l/=2,n/=2}function c(e,t){return 1===a?e[t]:e.readUInt16BE(t*a)}if(o){var u=-1;for(i=n;i<s;i++)if(c(e,i)===c(t,-1===u?0:i-u)){if(-1===u&&(u=i),i-u+1===l)return u*a}else-1!==u&&(i-=i-u),u=-1}else for(n+l>s&&(n=s-l),i=n;i>=0;i--){for(var f=!0,p=0;p<l;p++)if(c(e,i+p)!==c(t,p)){f=!1;break}if(f)return i}return-1}function b(e,t,n,r){n=Number(n)||0;var o=e.length-n;r?(r=Number(r))>o&&(r=o):r=o;var i=t.length;if(i%2!=0)throw new TypeError("Invalid hex string");r>i/2&&(r=i/2);for(var a=0;a<r;++a){var s=parseInt(t.substr(2*a,2),16);if(isNaN(s))return a;e[n+a]=s}return a}function w(e,t,n,r){return q(B(t,e.length-n),e,n,r)}function x(e,t,n,r){return q(function(e){for(var t=[],n=0;n<e.length;++n)t.push(255&e.charCodeAt(n));return t}(t),e,n,r)}function k(e,t,n,r){return x(e,t,n,r)}function E(e,t,n,r){return q($(t),e,n,r)}function O(e,t,n,r){return q(function(e,t){for(var n,r,o,i=[],a=0;a<e.length&&!((t-=2)<0);++a)n=e.charCodeAt(a),r=n>>8,o=n%256,i.push(o),i.push(r);return i}(t,e.length-n),e,n,r)}function _(e,t,n){return 0===t&&n===e.length?r.fromByteArray(e):r.fromByteArray(e.slice(t,n))}function S(e,t,n){n=Math.min(e.length,n);for(var r=[],o=t;o<n;){var i,a,s,l,c=e[o],u=null,f=c>239?4:c>223?3:c>191?2:1;if(o+f<=n)switch(f){case 1:c<128&&(u=c);break;case 2:128==(192&(i=e[o+1]))&&(l=(31&c)<<6|63&i)>127&&(u=l);break;case 3:i=e[o+1],a=e[o+2],128==(192&i)&&128==(192&a)&&(l=(15&c)<<12|(63&i)<<6|63&a)>2047&&(l<55296||l>57343)&&(u=l);break;case 4:i=e[o+1],a=e[o+2],s=e[o+3],128==(192&i)&&128==(192&a)&&128==(192&s)&&(l=(15&c)<<18|(63&i)<<12|(63&a)<<6|63&s)>65535&&l<1114112&&(u=l)}null===u?(u=65533,f=1):u>65535&&(u-=65536,r.push(u>>>10&1023|55296),u=56320|1023&u),r.push(u),o+=f}return function(e){var t=e.length;if(t<=T)return String.fromCharCode.apply(String,e);var n="",r=0;for(;r<t;)n+=String.fromCharCode.apply(String,e.slice(r,r+=T));return n}(r)}t.Buffer=l,t.SlowBuffer=function(e){+e!=e&&(e=0);return l.alloc(+e)},t.INSPECT_MAX_BYTES=50,l.TYPED_ARRAY_SUPPORT=void 0!==e.TYPED_ARRAY_SUPPORT?e.TYPED_ARRAY_SUPPORT:function(){try{var e=new Uint8Array(1);return e.__proto__={__proto__:Uint8Array.prototype,foo:function(){return 42}},42===e.foo()&&"function"==typeof e.subarray&&0===e.subarray(1,1).byteLength}catch(e){return!1}}(),t.kMaxLength=a(),l.poolSize=8192,l._augment=function(e){return e.__proto__=l.prototype,e},l.from=function(e,t,n){return c(null,e,t,n)},l.TYPED_ARRAY_SUPPORT&&(l.prototype.__proto__=Uint8Array.prototype,l.__proto__=Uint8Array,"undefined"!=typeof Symbol&&Symbol.species&&l[Symbol.species]===l&&Object.defineProperty(l,Symbol.species,{value:null,configurable:!0})),l.alloc=function(e,t,n){return function(e,t,n,r){return u(t),t<=0?s(e,t):void 0!==n?"string"==typeof r?s(e,t).fill(n,r):s(e,t).fill(n):s(e,t)}(null,e,t,n)},l.allocUnsafe=function(e){return f(null,e)},l.allocUnsafeSlow=function(e){return f(null,e)},l.isBuffer=function(e){return!(null==e||!e._isBuffer)},l.compare=function(e,t){if(!l.isBuffer(e)||!l.isBuffer(t))throw new TypeError("Arguments must be Buffers");if(e===t)return 0;for(var n=e.length,r=t.length,o=0,i=Math.min(n,r);o<i;++o)if(e[o]!==t[o]){n=e[o],r=t[o];break}return n<r?-1:r<n?1:0},l.isEncoding=function(e){switch(String(e).toLowerCase()){case"hex":case"utf8":case"utf-8":case"ascii":case"latin1":case"binary":case"base64":case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return!0;default:return!1}},l.concat=function(e,t){if(!i(e))throw new TypeError('"list" argument must be an Array of Buffers');if(0===e.length)return l.alloc(0);var n;if(void 0===t)for(t=0,n=0;n<e.length;++n)t+=e[n].length;var r=l.allocUnsafe(t),o=0;for(n=0;n<e.length;++n){var a=e[n];if(!l.isBuffer(a))throw new TypeError('"list" argument must be an Array of Buffers');a.copy(r,o),o+=a.length}return r},l.byteLength=h,l.prototype._isBuffer=!0,l.prototype.swap16=function(){var e=this.length;if(e%2!=0)throw new RangeError("Buffer size must be a multiple of 16-bits");for(var t=0;t<e;t+=2)g(this,t,t+1);return this},l.prototype.swap32=function(){var e=this.length;if(e%4!=0)throw new RangeError("Buffer size must be a multiple of 32-bits");for(var t=0;t<e;t+=4)g(this,t,t+3),g(this,t+1,t+2);return this},l.prototype.swap64=function(){var e=this.length;if(e%8!=0)throw new RangeError("Buffer size must be a multiple of 64-bits");for(var t=0;t<e;t+=8)g(this,t,t+7),g(this,t+1,t+6),g(this,t+2,t+5),g(this,t+3,t+4);return this},l.prototype.toString=function(){var e=0|this.length;return 0===e?"":0===arguments.length?S(this,0,e):m.apply(this,arguments)},l.prototype.equals=function(e){if(!l.isBuffer(e))throw new TypeError("Argument must be a Buffer");return this===e||0===l.compare(this,e)},l.prototype.inspect=function(){var e="",n=t.INSPECT_MAX_BYTES;return this.length>0&&(e=this.toString("hex",0,n).match(/.{2}/g).join(" "),this.length>n&&(e+=" ... ")),"<Buffer "+e+">"},l.prototype.compare=function(e,t,n,r,o){if(!l.isBuffer(e))throw new TypeError("Argument must be a Buffer");if(void 0===t&&(t=0),void 0===n&&(n=e?e.length:0),void 0===r&&(r=0),void 0===o&&(o=this.length),t<0||n>e.length||r<0||o>this.length)throw new RangeError("out of range index");if(r>=o&&t>=n)return 0;if(r>=o)return-1;if(t>=n)return 1;if(this===e)return 0;for(var i=(o>>>=0)-(r>>>=0),a=(n>>>=0)-(t>>>=0),s=Math.min(i,a),c=this.slice(r,o),u=e.slice(t,n),f=0;f<s;++f)if(c[f]!==u[f]){i=c[f],a=u[f];break}return i<a?-1:a<i?1:0},l.prototype.includes=function(e,t,n){return-1!==this.indexOf(e,t,n)},l.prototype.indexOf=function(e,t,n){return y(this,e,t,n,!0)},l.prototype.lastIndexOf=function(e,t,n){return y(this,e,t,n,!1)},l.prototype.write=function(e,t,n,r){if(void 0===t)r="utf8",n=this.length,t=0;else if(void 0===n&&"string"==typeof t)r=t,n=this.length,t=0;else{if(!isFinite(t))throw new Error("Buffer.write(string, encoding, offset[, length]) is no longer supported");t|=0,isFinite(n)?(n|=0,void 0===r&&(r="utf8")):(r=n,n=void 0)}var o=this.length-t;if((void 0===n||n>o)&&(n=o),e.length>0&&(n<0||t<0)||t>this.length)throw new RangeError("Attempt to write outside buffer bounds");r||(r="utf8");for(var i=!1;;)switch(r){case"hex":return b(this,e,t,n);case"utf8":case"utf-8":return w(this,e,t,n);case"ascii":return x(this,e,t,n);case"latin1":case"binary":return k(this,e,t,n);case"base64":return E(this,e,t,n);case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return O(this,e,t,n);default:if(i)throw new TypeError("Unknown encoding: "+r);r=(""+r).toLowerCase(),i=!0}},l.prototype.toJSON=function(){return{type:"Buffer",data:Array.prototype.slice.call(this._arr||this,0)}};var T=4096;function j(e,t,n){var r="";n=Math.min(e.length,n);for(var o=t;o<n;++o)r+=String.fromCharCode(127&e[o]);return r}function C(e,t,n){var r="";n=Math.min(e.length,n);for(var o=t;o<n;++o)r+=String.fromCharCode(e[o]);return r}function I(e,t,n){var r=e.length;(!t||t<0)&&(t=0),(!n||n<0||n>r)&&(n=r);for(var o="",i=t;i<n;++i)o+=z(e[i]);return o}function A(e,t,n){for(var r=e.slice(t,n),o="",i=0;i<r.length;i+=2)o+=String.fromCharCode(r[i]+256*r[i+1]);return o}function P(e,t,n){if(e%1!=0||e<0)throw new RangeError("offset is not uint");if(e+t>n)throw new RangeError("Trying to access beyond buffer length")}function R(e,t,n,r,o,i){if(!l.isBuffer(e))throw new TypeError('"buffer" argument must be a Buffer instance');if(t>o||t<i)throw new RangeError('"value" argument is out of bounds');if(n+r>e.length)throw new RangeError("Index out of range")}function N(e,t,n,r){t<0&&(t=65535+t+1);for(var o=0,i=Math.min(e.length-n,2);o<i;++o)e[n+o]=(t&255<<8*(r?o:1-o))>>>8*(r?o:1-o)}function L(e,t,n,r){t<0&&(t=4294967295+t+1);for(var o=0,i=Math.min(e.length-n,4);o<i;++o)e[n+o]=t>>>8*(r?o:3-o)&255}function M(e,t,n,r,o,i){if(n+r>e.length)throw new RangeError("Index out of range");if(n<0)throw new RangeError("Index out of range")}function D(e,t,n,r,i){return i||M(e,0,n,4),o.write(e,t,n,r,23,4),n+4}function F(e,t,n,r,i){return i||M(e,0,n,8),o.write(e,t,n,r,52,8),n+8}l.prototype.slice=function(e,t){var n,r=this.length;if((e=~~e)<0?(e+=r)<0&&(e=0):e>r&&(e=r),(t=void 0===t?r:~~t)<0?(t+=r)<0&&(t=0):t>r&&(t=r),t<e&&(t=e),l.TYPED_ARRAY_SUPPORT)(n=this.subarray(e,t)).__proto__=l.prototype;else{var o=t-e;n=new l(o,void 0);for(var i=0;i<o;++i)n[i]=this[i+e]}return n},l.prototype.readUIntLE=function(e,t,n){e|=0,t|=0,n||P(e,t,this.length);for(var r=this[e],o=1,i=0;++i<t&&(o*=256);)r+=this[e+i]*o;return r},l.prototype.readUIntBE=function(e,t,n){e|=0,t|=0,n||P(e,t,this.length);for(var r=this[e+--t],o=1;t>0&&(o*=256);)r+=this[e+--t]*o;return r},l.prototype.readUInt8=function(e,t){return t||P(e,1,this.length),this[e]},l.prototype.readUInt16LE=function(e,t){return t||P(e,2,this.length),this[e]|this[e+1]<<8},l.prototype.readUInt16BE=function(e,t){return t||P(e,2,this.length),this[e]<<8|this[e+1]},l.prototype.readUInt32LE=function(e,t){return t||P(e,4,this.length),(this[e]|this[e+1]<<8|this[e+2]<<16)+16777216*this[e+3]},l.prototype.readUInt32BE=function(e,t){return t||P(e,4,this.length),16777216*this[e]+(this[e+1]<<16|this[e+2]<<8|this[e+3])},l.prototype.readIntLE=function(e,t,n){e|=0,t|=0,n||P(e,t,this.length);for(var r=this[e],o=1,i=0;++i<t&&(o*=256);)r+=this[e+i]*o;return r>=(o*=128)&&(r-=Math.pow(2,8*t)),r},l.prototype.readIntBE=function(e,t,n){e|=0,t|=0,n||P(e,t,this.length);for(var r=t,o=1,i=this[e+--r];r>0&&(o*=256);)i+=this[e+--r]*o;return i>=(o*=128)&&(i-=Math.pow(2,8*t)),i},l.prototype.readInt8=function(e,t){return t||P(e,1,this.length),128&this[e]?-1*(255-this[e]+1):this[e]},l.prototype.readInt16LE=function(e,t){t||P(e,2,this.length);var n=this[e]|this[e+1]<<8;return 32768&n?4294901760|n:n},l.prototype.readInt16BE=function(e,t){t||P(e,2,this.length);var n=this[e+1]|this[e]<<8;return 32768&n?4294901760|n:n},l.prototype.readInt32LE=function(e,t){return t||P(e,4,this.length),this[e]|this[e+1]<<8|this[e+2]<<16|this[e+3]<<24},l.prototype.readInt32BE=function(e,t){return t||P(e,4,this.length),this[e]<<24|this[e+1]<<16|this[e+2]<<8|this[e+3]},l.prototype.readFloatLE=function(e,t){return t||P(e,4,this.length),o.read(this,e,!0,23,4)},l.prototype.readFloatBE=function(e,t){return t||P(e,4,this.length),o.read(this,e,!1,23,4)},l.prototype.readDoubleLE=function(e,t){return t||P(e,8,this.length),o.read(this,e,!0,52,8)},l.prototype.readDoubleBE=function(e,t){return t||P(e,8,this.length),o.read(this,e,!1,52,8)},l.prototype.writeUIntLE=function(e,t,n,r){(e=+e,t|=0,n|=0,r)||R(this,e,t,n,Math.pow(2,8*n)-1,0);var o=1,i=0;for(this[t]=255&e;++i<n&&(o*=256);)this[t+i]=e/o&255;return t+n},l.prototype.writeUIntBE=function(e,t,n,r){(e=+e,t|=0,n|=0,r)||R(this,e,t,n,Math.pow(2,8*n)-1,0);var o=n-1,i=1;for(this[t+o]=255&e;--o>=0&&(i*=256);)this[t+o]=e/i&255;return t+n},l.prototype.writeUInt8=function(e,t,n){return e=+e,t|=0,n||R(this,e,t,1,255,0),l.TYPED_ARRAY_SUPPORT||(e=Math.floor(e)),this[t]=255&e,t+1},l.prototype.writeUInt16LE=function(e,t,n){return e=+e,t|=0,n||R(this,e,t,2,65535,0),l.TYPED_ARRAY_SUPPORT?(this[t]=255&e,this[t+1]=e>>>8):N(this,e,t,!0),t+2},l.prototype.writeUInt16BE=function(e,t,n){return e=+e,t|=0,n||R(this,e,t,2,65535,0),l.TYPED_ARRAY_SUPPORT?(this[t]=e>>>8,this[t+1]=255&e):N(this,e,t,!1),t+2},l.prototype.writeUInt32LE=function(e,t,n){return e=+e,t|=0,n||R(this,e,t,4,4294967295,0),l.TYPED_ARRAY_SUPPORT?(this[t+3]=e>>>24,this[t+2]=e>>>16,this[t+1]=e>>>8,this[t]=255&e):L(this,e,t,!0),t+4},l.prototype.writeUInt32BE=function(e,t,n){return e=+e,t|=0,n||R(this,e,t,4,4294967295,0),l.TYPED_ARRAY_SUPPORT?(this[t]=e>>>24,this[t+1]=e>>>16,this[t+2]=e>>>8,this[t+3]=255&e):L(this,e,t,!1),t+4},l.prototype.writeIntLE=function(e,t,n,r){if(e=+e,t|=0,!r){var o=Math.pow(2,8*n-1);R(this,e,t,n,o-1,-o)}var i=0,a=1,s=0;for(this[t]=255&e;++i<n&&(a*=256);)e<0&&0===s&&0!==this[t+i-1]&&(s=1),this[t+i]=(e/a>>0)-s&255;return t+n},l.prototype.writeIntBE=function(e,t,n,r){if(e=+e,t|=0,!r){var o=Math.pow(2,8*n-1);R(this,e,t,n,o-1,-o)}var i=n-1,a=1,s=0;for(this[t+i]=255&e;--i>=0&&(a*=256);)e<0&&0===s&&0!==this[t+i+1]&&(s=1),this[t+i]=(e/a>>0)-s&255;return t+n},l.prototype.writeInt8=function(e,t,n){return e=+e,t|=0,n||R(this,e,t,1,127,-128),l.TYPED_ARRAY_SUPPORT||(e=Math.floor(e)),e<0&&(e=255+e+1),this[t]=255&e,t+1},l.prototype.writeInt16LE=function(e,t,n){return e=+e,t|=0,n||R(this,e,t,2,32767,-32768),l.TYPED_ARRAY_SUPPORT?(this[t]=255&e,this[t+1]=e>>>8):N(this,e,t,!0),t+2},l.prototype.writeInt16BE=function(e,t,n){return e=+e,t|=0,n||R(this,e,t,2,32767,-32768),l.TYPED_ARRAY_SUPPORT?(this[t]=e>>>8,this[t+1]=255&e):N(this,e,t,!1),t+2},l.prototype.writeInt32LE=function(e,t,n){return e=+e,t|=0,n||R(this,e,t,4,2147483647,-2147483648),l.TYPED_ARRAY_SUPPORT?(this[t]=255&e,this[t+1]=e>>>8,this[t+2]=e>>>16,this[t+3]=e>>>24):L(this,e,t,!0),t+4},l.prototype.writeInt32BE=function(e,t,n){return e=+e,t|=0,n||R(this,e,t,4,2147483647,-2147483648),e<0&&(e=4294967295+e+1),l.TYPED_ARRAY_SUPPORT?(this[t]=e>>>24,this[t+1]=e>>>16,this[t+2]=e>>>8,this[t+3]=255&e):L(this,e,t,!1),t+4},l.prototype.writeFloatLE=function(e,t,n){return D(this,e,t,!0,n)},l.prototype.writeFloatBE=function(e,t,n){return D(this,e,t,!1,n)},l.prototype.writeDoubleLE=function(e,t,n){return F(this,e,t,!0,n)},l.prototype.writeDoubleBE=function(e,t,n){return F(this,e,t,!1,n)},l.prototype.copy=function(e,t,n,r){if(n||(n=0),r||0===r||(r=this.length),t>=e.length&&(t=e.length),t||(t=0),r>0&&r<n&&(r=n),r===n)return 0;if(0===e.length||0===this.length)return 0;if(t<0)throw new RangeError("targetStart out of bounds");if(n<0||n>=this.length)throw new RangeError("sourceStart out of bounds");if(r<0)throw new RangeError("sourceEnd out of bounds");r>this.length&&(r=this.length),e.length-t<r-n&&(r=e.length-t+n);var o,i=r-n;if(this===e&&n<t&&t<r)for(o=i-1;o>=0;--o)e[o+t]=this[o+n];else if(i<1e3||!l.TYPED_ARRAY_SUPPORT)for(o=0;o<i;++o)e[o+t]=this[o+n];else Uint8Array.prototype.set.call(e,this.subarray(n,n+i),t);return i},l.prototype.fill=function(e,t,n,r){if("string"==typeof e){if("string"==typeof t?(r=t,t=0,n=this.length):"string"==typeof n&&(r=n,n=this.length),1===e.length){var o=e.charCodeAt(0);o<256&&(e=o)}if(void 0!==r&&"string"!=typeof r)throw new TypeError("encoding must be a string");if("string"==typeof r&&!l.isEncoding(r))throw new TypeError("Unknown encoding: "+r)}else"number"==typeof e&&(e&=255);if(t<0||this.length<t||this.length<n)throw new RangeError("Out of range index");if(n<=t)return this;var i;if(t>>>=0,n=void 0===n?this.length:n>>>0,e||(e=0),"number"==typeof e)for(i=t;i<n;++i)this[i]=e;else{var a=l.isBuffer(e)?e:B(new l(e,r).toString()),s=a.length;for(i=0;i<n-t;++i)this[i+t]=a[i%s]}return this};var U=/[^+\/0-9A-Za-z-_]/g;function z(e){return e<16?"0"+e.toString(16):e.toString(16)}function B(e,t){var n;t=t||1/0;for(var r=e.length,o=null,i=[],a=0;a<r;++a){if((n=e.charCodeAt(a))>55295&&n<57344){if(!o){if(n>56319){(t-=3)>-1&&i.push(239,191,189);continue}if(a+1===r){(t-=3)>-1&&i.push(239,191,189);continue}o=n;continue}if(n<56320){(t-=3)>-1&&i.push(239,191,189),o=n;continue}n=65536+(o-55296<<10|n-56320)}else o&&(t-=3)>-1&&i.push(239,191,189);if(o=null,n<128){if((t-=1)<0)break;i.push(n)}else if(n<2048){if((t-=2)<0)break;i.push(n>>6|192,63&n|128)}else if(n<65536){if((t-=3)<0)break;i.push(n>>12|224,n>>6&63|128,63&n|128)}else{if(!(n<1114112))throw new Error("Invalid code point");if((t-=4)<0)break;i.push(n>>18|240,n>>12&63|128,n>>6&63|128,63&n|128)}}return i}function $(e){return r.toByteArray(function(e){if((e=function(e){return e.trim?e.trim():e.replace(/^\s+|\s+$/g,"")}(e).replace(U,"")).length<2)return"";for(;e.length%4!=0;)e+="=";return e}(e))}function q(e,t,n,r){for(var o=0;o<r&&!(o+n>=t.length||o>=e.length);++o)t[o+n]=e[o];return o}}).call(this,n(6))},function(e,t){var n={}.hasOwnProperty;e.exports=function(e,t){return n.call(e,t)}},function(e,t){var n,r,o=e.exports={};function i(){throw new Error("setTimeout has not been defined")}function a(){throw new Error("clearTimeout has not been defined")}function s(e){if(n===setTimeout)return setTimeout(e,0);if((n===i||!n)&&setTimeout)return n=setTimeout,setTimeout(e,0);try{return n(e,0)}catch(t){try{return n.call(null,e,0)}catch(t){return n.call(this,e,0)}}}!function(){try{n="function"==typeof setTimeout?setTimeout:i}catch(e){n=i}try{r="function"==typeof clearTimeout?clearTimeout:a}catch(e){r=a}}();var l,c=[],u=!1,f=-1;function p(){u&&l&&(u=!1,l.length?c=l.concat(c):f=-1,c.length&&d())}function d(){if(!u){var e=s(p);u=!0;for(var t=c.length;t;){for(l=c,c=[];++f<t;)l&&l[f].run();f=-1,t=c.length}l=null,u=!1,function(e){if(r===clearTimeout)return clearTimeout(e);if((r===a||!r)&&clearTimeout)return r=clearTimeout,clearTimeout(e);try{r(e)}catch(t){try{return r.call(null,e)}catch(t){return r.call(this,e)}}}(e)}}function h(e,t){this.fun=e,this.array=t}function m(){}o.nextTick=function(e){var t=new Array(arguments.length-1);if(arguments.length>1)for(var n=1;n<arguments.length;n++)t[n-1]=arguments[n];c.push(new h(e,t)),1!==c.length||u||s(d)},h.prototype.run=function(){this.fun.apply(null,this.array)},o.title="browser",o.browser=!0,o.env={},o.argv=[],o.version="",o.versions={},o.on=m,o.addListener=m,o.once=m,o.off=m,o.removeListener=m,o.removeAllListeners=m,o.emit=m,o.prependListener=m,o.prependOnceListener=m,o.listeners=function(e){return[]},o.binding=function(e){throw new Error("process.binding is not supported")},o.cwd=function(){return"/"},o.chdir=function(e){throw new Error("process.chdir is not supported")},o.umask=function(){return 0}},function(e,t,n){var r=n(3),o=n(32).f,i=n(20),a=n(23),s=n(67),l=n(103),c=n(78);e.exports=function(e,t){var n,u,f,p,d,h=e.target,m=e.global,g=e.stat;if(n=m?r:g?r[h]||s(h,{}):(r[h]||{}).prototype)for(u in t){if(p=t[u],f=e.noTargetGet?(d=o(n,u))&&d.value:n[u],!c(m?u:h+(g?".":"#")+u,e.forced)&&void 0!==f){if(typeof p==typeof f)continue;l(p,f)}(e.sham||f&&f.sham)&&i(p,"sham",!0),a(n,u,p,e)}}},function(e,t,n){var r=n(18),o=n(99),i=n(19),a=n(52),s=Object.defineProperty;t.f=r?s:function(e,t,n){if(i(e),t=a(t,!0),i(n),o)try{return s(e,t,n)}catch(e){}if("get"in n||"set"in n)throw TypeError("Accessors not supported");return"value"in n&&(e[t]=n.value),e}},function(e,t,n){e.exports=n(226)()},function(e,t,n){var r;
|
||
/*!
|
||
Copyright (c) 2017 Jed Watson.
|
||
Licensed under the MIT License (MIT), see
|
||
http://jedwatson.github.io/classnames
|
||
*/!function(){"use strict";var n={}.hasOwnProperty;function o(){for(var e=[],t=0;t<arguments.length;t++){var r=arguments[t];if(r){var i=typeof r;if("string"===i||"number"===i)e.push(r);else if(Array.isArray(r)&&r.length){var a=o.apply(null,r);a&&e.push(a)}else if("object"===i)for(var s in r)n.call(r,s)&&r[s]&&e.push(s)}}return e.join(" ")}e.exports?(o.default=o,e.exports=o):void 0===(r=function(){return o}.apply(t,[]))||(e.exports=r)}()},function(e,t,n){var r=n(9);e.exports=!r((function(){return 7!=Object.defineProperty({},"a",{get:function(){return 7}}).a}))},function(e,t,n){var r=n(7);e.exports=function(e){if(!r(e))throw TypeError(String(e)+" is not an object");return e}},function(e,t,n){var r=n(18),o=n(15),i=n(39);e.exports=r?function(e,t,n){return o.f(e,t,i(1,n))}:function(e,t,n){return e[t]=n,e}},function(e,t,n){"use strict";var r=n(291);function o(e,t,n){if(3===arguments.length)return o.set(e,t,n);if(2===arguments.length)return o.get(e,t);var r=o.bind(o,e);for(var i in o)o.hasOwnProperty(i)&&(r[i]=o[i].bind(r,e));return r}e.exports=o,o.get=function(e,t){for(var n=Array.isArray(t)?t:o.parse(t),r=0;r<n.length;++r){var i=n[r];if(!("object"==typeof e&&i in e))throw new Error("Invalid reference token: "+i);e=e[i]}return e},o.set=function(e,t,n){for(var r=Array.isArray(t)?t:o.parse(t),i=r[0],a=0;a<r.length-1;++a){var s=r[a];"-"===s&&Array.isArray(e)&&(s=e.length),i=r[a+1],s in e||(i.match(/^(\d+|-)$/)?e[s]=[]:e[s]={}),e=e[s]}return"-"===i&&Array.isArray(e)&&(i=e.length),e[i]=n,this},o.remove=function(e,t){var n=Array.isArray(t)?t:o.parse(t),r=n[n.length-1];if(void 0===r)throw new Error('Invalid JSON pointer for remove: "'+t+'"');var i=o.get(e,n.slice(0,-1));if(Array.isArray(i)){var a=+r;if(""===r&&isNaN(a))throw new Error('Invalid array index: "'+r+'"');Array.prototype.splice.call(i,a,1)}else delete i[r]},o.dict=function(e,t){var n={};return o.walk(e,(function(e,t){n[t]=e}),t),n},o.walk=function(e,t,n){var i=[];n=n||function(e){var t=Object.prototype.toString.call(e);return"[object Object]"===t||"[object Array]"===t},function e(a){r(a,(function(r,a){i.push(String(a)),n(r)?e(r):t(r,o.compile(i)),i.pop()}))}(e)},o.has=function(e,t){try{o.get(e,t)}catch(e){return!1}return!0},o.escape=function(e){return e.toString().replace(/~/g,"~0").replace(/\//g,"~1")},o.unescape=function(e){return e.replace(/~1/g,"/").replace(/~0/g,"~")},o.parse=function(e){if(""===e)return[];if("/"!==e.charAt(0))throw new Error("Invalid JSON pointer: "+e);return e.substring(1).split(/\//).map(o.unescape)},o.compile=function(e){return 0===e.length?"":"/"+e.map(o.escape).join("/")}},function(e,t){e.exports=!1},function(e,t,n){var r=n(3),o=n(20),i=n(12),a=n(67),s=n(70),l=n(31),c=l.get,u=l.enforce,f=String(String).split("String");(e.exports=function(e,t,n,s){var l=!!s&&!!s.unsafe,c=!!s&&!!s.enumerable,p=!!s&&!!s.noTargetGet;"function"==typeof n&&("string"!=typeof t||i(n,"name")||o(n,"name",t),u(n).source=f.join("string"==typeof t?t:"")),e!==r?(l?!p&&e[t]&&(c=!0):delete e[t],c?e[t]=n:o(e,t,n)):c?e[t]=n:a(t,n)})(Function.prototype,"toString",(function(){return"function"==typeof this&&c(this).source||s(this)}))},function(e,t,n){"use strict";(function(r){var o=/^win/.test(r.platform),i=/\//g,a=/^(\w{2,}):\/\//i,s=e.exports,l=[/\?/g,"%3F",/\#/g,"%23"],c=[/\%23/g,"#",/\%24/g,"$",/\%26/g,"&",/\%2C/g,",",/\%40/g,"@"];t.parse=n(8).parse,t.resolve=n(8).resolve,t.cwd=function(){return r.browser?location.href:r.cwd()+"/"},t.getProtocol=function(e){var t=a.exec(e);if(t)return t[1].toLowerCase()},t.getExtension=function(e){var t=e.lastIndexOf(".");return t>=0?e.substr(t).toLowerCase():""},t.getHash=function(e){var t=e.indexOf("#");return t>=0?e.substr(t):"#"},t.stripHash=function(e){var t=e.indexOf("#");return t>=0&&(e=e.substr(0,t)),e},t.isHttp=function(e){var t=s.getProtocol(e);return"http"===t||"https"===t||void 0===t&&r.browser},t.isFileSystemPath=function(e){if(r.browser)return!1;var t=s.getProtocol(e);return void 0===t||"file"===t},t.fromFileSystemPath=function(e){o&&(e=e.replace(/\\/g,"/")),e=encodeURI(e);for(var t=0;t<l.length;t+=2)e=e.replace(l[t],l[t+1]);return e},t.toFileSystemPath=function(e,t){e=decodeURI(e);for(var n=0;n<c.length;n+=2)e=e.replace(c[n],c[n+1]);var r="file://"===e.substr(0,7).toLowerCase();return r&&(e="/"===e[7]?e.substr(8):e.substr(7),o&&"/"===e[1]&&(e=e[0]+":"+e.substr(1)),t?e="file:///"+e:(r=!1,e=o?e:"/"+e)),o&&!r&&":\\"===(e=e.replace(i,"\\")).substr(1,2)&&(e=e[0].toUpperCase()+e.substr(1)),e}}).call(this,n(13))},function(e,t){var n={}.toString;e.exports=function(e){return n.call(e).slice(8,-1)}},function(e,t,n){var r=n(34),o=n(3),i=function(e){return"function"==typeof e?e:void 0};e.exports=function(e,t){return arguments.length<2?i(r[e])||i(o[e]):r[e]&&r[e][t]||o[e]&&o[e][t]}},function(e,t,n){var r=n(15).f,o=n(12),i=n(4)("toStringTag");e.exports=function(e,t,n){e&&!o(e=n?e:e.prototype,i)&&r(e,i,{configurable:!0,value:t})}},function(e,t,n){"use strict";var r=n(261),o=Array.prototype.slice,i=["name","message","stack"],a=["name","message","description","number","code","fileName","lineNumber","columnNumber","sourceURL","line","column","stack"];function s(t){return function(n,r,i,a){var s=[],f="";"string"==typeof n?(s=o.call(arguments),n=r=void 0):"string"==typeof r?(s=o.call(arguments,1),r=void 0):"string"==typeof i&&(s=o.call(arguments,2)),s.length>0&&(f=e.exports.formatter.apply(null,s)),n&&n.message&&(f+=(f?" \n":"")+n.message);var p=new t(f);return l(p,n),c(p),u(p,r),p}}function l(e,t){!function(e,t){!function(e){if(!m)return!1;var t=Object.getOwnPropertyDescriptor(e,"stack");if(!t)return!1;return"function"==typeof t.get}(e)?e.stack=t?d(e.stack,t.stack):h(e.stack):t?function(e,t){var n=Object.getOwnPropertyDescriptor(e,"stack");Object.defineProperty(e,"stack",{get:function(){return d(n.get.apply(e),t.stack)},enumerable:!1,configurable:!0})}(e,t):(n=e,r=Object.getOwnPropertyDescriptor(n,"stack"),Object.defineProperty(n,"stack",{get:function(){return h(r.get.apply(n))},enumerable:!1,configurable:!0}));var n,r}(e,t),u(e,t)}function c(e){e.toJSON=f,e.inspect=p}function u(e,t){if(t&&"object"==typeof t)for(var n=Object.keys(t),r=0;r<n.length;r++){var o=n[r];if(!(i.indexOf(o)>=0))try{e[o]=t[o]}catch(e){}}}function f(){var e={},t=Object.keys(this);t=t.concat(a);for(var n=0;n<t.length;n++){var r=t[n],o=this[r],i=typeof o;"undefined"!==i&&"function"!==i&&(e[r]=o)}return e}function p(){return JSON.stringify(this,null,2).replace(/\\n/g,"\n")}function d(e,t){return(e=h(e))&&t?e+"\n\n"+t:e||t}function h(e){if(e){var t=e.split("\n");if(t.length<2)return e;for(var n=0;n<t.length;n++){if(t[n].indexOf("onoFactory")>=0)return t.splice(n,1),t.join("\n")}return e}}e.exports=s(Error),e.exports.error=s(Error),e.exports.eval=s(EvalError),e.exports.range=s(RangeError),e.exports.reference=s(ReferenceError),e.exports.syntax=s(SyntaxError),e.exports.type=s(TypeError),e.exports.uri=s(URIError),e.exports.formatter=r;var m=!(!Object.getOwnPropertyDescriptor||!Object.defineProperty||"undefined"!=typeof navigator&&/Android/.test(navigator.userAgent))},function(e,t){"function"==typeof Object.create?e.exports=function(e,t){t&&(e.super_=t,e.prototype=Object.create(t.prototype,{constructor:{value:e,enumerable:!1,writable:!0,configurable:!0}}))}:e.exports=function(e,t){if(t){e.super_=t;var n=function(){};n.prototype=t.prototype,e.prototype=new n,e.prototype.constructor=e}}},function(e,t,n){"use strict";!function e(){if("undefined"!=typeof __REACT_DEVTOOLS_GLOBAL_HOOK__&&"function"==typeof __REACT_DEVTOOLS_GLOBAL_HOOK__.checkDCE){0;try{__REACT_DEVTOOLS_GLOBAL_HOOK__.checkDCE(e)}catch(e){console.error(e)}}}(),e.exports=n(223)},function(e,t,n){var r,o,i,a=n(162),s=n(3),l=n(7),c=n(20),u=n(12),f=n(54),p=n(40),d=s.WeakMap;if(a){var h=new d,m=h.get,g=h.has,y=h.set;r=function(e,t){return y.call(h,e,t),t},o=function(e){return m.call(h,e)||{}},i=function(e){return g.call(h,e)}}else{var v=f("state");p[v]=!0,r=function(e,t){return c(e,v,t),t},o=function(e){return u(e,v)?e[v]:{}},i=function(e){return u(e,v)}}e.exports={set:r,get:o,has:i,enforce:function(e){return i(e)?o(e):r(e,{})},getterFor:function(e){return function(t){var n;if(!l(t)||(n=o(t)).type!==e)throw TypeError("Incompatible receiver, "+e+" required");return n}}}},function(e,t,n){var r=n(18),o=n(73),i=n(39),a=n(33),s=n(52),l=n(12),c=n(99),u=Object.getOwnPropertyDescriptor;t.f=r?u:function(e,t){if(e=a(e),t=s(t,!0),c)try{return u(e,t)}catch(e){}if(l(e,t))return i(!o.f.call(e,t),e[t])}},function(e,t,n){var r=n(74),o=n(41);e.exports=function(e){return r(o(e))}},function(e,t,n){var r=n(3);e.exports=r},function(e,t,n){var r=n(71),o=Math.min;e.exports=function(e){return e>0?o(r(e),9007199254740991):0}},function(e,t,n){"use strict";var r=n(46),o=n(57),i=n(5);function a(e,t,n){var r=[];return e.include.forEach((function(e){n=a(e,t,n)})),e[t].forEach((function(e){n.forEach((function(t,n){t.tag===e.tag&&t.kind===e.kind&&r.push(n)})),n.push(e)})),n.filter((function(e,t){return-1===r.indexOf(t)}))}function s(e){this.include=e.include||[],this.implicit=e.implicit||[],this.explicit=e.explicit||[],this.implicit.forEach((function(e){if(e.loadKind&&"scalar"!==e.loadKind)throw new o("There is a non-scalar type in the implicit list of a schema. Implicit resolving of such types is not supported.")})),this.compiledImplicit=a(this,"implicit",[]),this.compiledExplicit=a(this,"explicit",[]),this.compiledTypeMap=function(){var e,t,n={scalar:{},sequence:{},mapping:{},fallback:{}};function r(e){n[e.kind][e.tag]=n.fallback[e.tag]=e}for(e=0,t=arguments.length;e<t;e+=1)arguments[e].forEach(r);return n}(this.compiledImplicit,this.compiledExplicit)}s.DEFAULT=null,s.create=function(){var e,t;switch(arguments.length){case 1:e=s.DEFAULT,t=arguments[0];break;case 2:e=arguments[0],t=arguments[1];break;default:throw new o("Wrong number of arguments for Schema.create function")}if(e=r.toArray(e),t=r.toArray(t),!e.every((function(e){return e instanceof s})))throw new o("Specified list of super schemas (or a single Schema object) contains a non-Schema object.");if(!t.every((function(e){return e instanceof i})))throw new o("Specified list of YAML types (or a single Type object) contains a non-Type object.");return new s({include:e,explicit:t})},e.exports=s},function(e,t,n){"use strict";var r=n(59),o=Object.keys||function(e){var t=[];for(var n in e)t.push(n);return t};e.exports=f;var i=n(47);i.inherits=n(29);var a=n(136),s=n(140);i.inherits(f,a);for(var l=o(s.prototype),c=0;c<l.length;c++){var u=l[c];f.prototype[u]||(f.prototype[u]=s.prototype[u])}function f(e){if(!(this instanceof f))return new f(e);a.call(this,e),s.call(this,e),e&&!1===e.readable&&(this.readable=!1),e&&!1===e.writable&&(this.writable=!1),this.allowHalfOpen=!0,e&&!1===e.allowHalfOpen&&(this.allowHalfOpen=!1),this.once("end",p)}function p(){this.allowHalfOpen||this._writableState.ended||r.nextTick(d,this)}function d(e){e.end()}Object.defineProperty(f.prototype,"writableHighWaterMark",{enumerable:!1,get:function(){return this._writableState.highWaterMark}}),Object.defineProperty(f.prototype,"destroyed",{get:function(){return void 0!==this._readableState&&void 0!==this._writableState&&(this._readableState.destroyed&&this._writableState.destroyed)},set:function(e){void 0!==this._readableState&&void 0!==this._writableState&&(this._readableState.destroyed=e,this._writableState.destroyed=e)}}),f.prototype._destroy=function(e,t){this.push(null),this.end(),r.nextTick(t,e)}},function(e,t,n){(function(t){var n=function(e){var t=/\blang(?:uage)?-([\w-]+)\b/i,n=0,r={manual:e.Prism&&e.Prism.manual,disableWorkerMessageHandler:e.Prism&&e.Prism.disableWorkerMessageHandler,util:{encode:function(e){return e instanceof o?new o(e.type,r.util.encode(e.content),e.alias):Array.isArray(e)?e.map(r.util.encode):e.replace(/&/g,"&").replace(/</g,"<").replace(/\u00a0/g," ")},type:function(e){return Object.prototype.toString.call(e).slice(8,-1)},objId:function(e){return e.__id||Object.defineProperty(e,"__id",{value:++n}),e.__id},clone:function e(t,n){var o,i,a=r.util.type(t);switch(n=n||{},a){case"Object":if(i=r.util.objId(t),n[i])return n[i];for(var s in o={},n[i]=o,t)t.hasOwnProperty(s)&&(o[s]=e(t[s],n));return o;case"Array":return i=r.util.objId(t),n[i]?n[i]:(o=[],n[i]=o,t.forEach((function(t,r){o[r]=e(t,n)})),o);default:return t}}},languages:{extend:function(e,t){var n=r.util.clone(r.languages[e]);for(var o in t)n[o]=t[o];return n},insertBefore:function(e,t,n,o){var i=(o=o||r.languages)[e],a={};for(var s in i)if(i.hasOwnProperty(s)){if(s==t)for(var l in n)n.hasOwnProperty(l)&&(a[l]=n[l]);n.hasOwnProperty(s)||(a[s]=i[s])}var c=o[e];return o[e]=a,r.languages.DFS(r.languages,(function(t,n){n===c&&t!=e&&(this[t]=a)})),a},DFS:function e(t,n,o,i){i=i||{};var a=r.util.objId;for(var s in t)if(t.hasOwnProperty(s)){n.call(t,s,t[s],o||s);var l=t[s],c=r.util.type(l);"Object"!==c||i[a(l)]?"Array"!==c||i[a(l)]||(i[a(l)]=!0,e(l,n,s,i)):(i[a(l)]=!0,e(l,n,null,i))}}},plugins:{},highlightAll:function(e,t){r.highlightAllUnder(document,e,t)},highlightAllUnder:function(e,t,n){var o={callback:n,selector:'code[class*="language-"], [class*="language-"] code, code[class*="lang-"], [class*="lang-"] code'};r.hooks.run("before-highlightall",o);for(var i,a=e.querySelectorAll(o.selector),s=0;i=a[s++];)r.highlightElement(i,!0===t,o.callback)},highlightElement:function(n,o,i){for(var a,s="none",l=n;l&&!t.test(l.className);)l=l.parentNode;l&&(s=(l.className.match(t)||[,"none"])[1].toLowerCase(),a=r.languages[s]),n.className=n.className.replace(t,"").replace(/\s+/g," ")+" language-"+s,n.parentNode&&(l=n.parentNode,/pre/i.test(l.nodeName)&&(l.className=l.className.replace(t,"").replace(/\s+/g," ")+" language-"+s));var c={element:n,language:s,grammar:a,code:n.textContent},u=function(e){c.highlightedCode=e,r.hooks.run("before-insert",c),c.element.innerHTML=c.highlightedCode,r.hooks.run("after-highlight",c),r.hooks.run("complete",c),i&&i.call(c.element)};if(r.hooks.run("before-sanity-check",c),c.code)if(r.hooks.run("before-highlight",c),c.grammar)if(o&&e.Worker){var f=new Worker(r.filename);f.onmessage=function(e){u(e.data)},f.postMessage(JSON.stringify({language:c.language,code:c.code,immediateClose:!0}))}else u(r.highlight(c.code,c.grammar,c.language));else u(r.util.encode(c.code));else r.hooks.run("complete",c)},highlight:function(e,t,n){var i={code:e,grammar:t,language:n};return r.hooks.run("before-tokenize",i),i.tokens=r.tokenize(i.code,i.grammar),r.hooks.run("after-tokenize",i),o.stringify(r.util.encode(i.tokens),i.language)},matchGrammar:function(e,t,n,i,a,s,l){for(var c in n)if(n.hasOwnProperty(c)&&n[c]){if(c==l)return;var u=n[c];u="Array"===r.util.type(u)?u:[u];for(var f=0;f<u.length;++f){var p=u[f],d=p.inside,h=!!p.lookbehind,m=!!p.greedy,g=0,y=p.alias;if(m&&!p.pattern.global){var v=p.pattern.toString().match(/[imuy]*$/)[0];p.pattern=RegExp(p.pattern.source,v+"g")}p=p.pattern||p;for(var b=i,w=a;b<t.length;w+=t[b].length,++b){var x=t[b];if(t.length>e.length)return;if(!(x instanceof o)){if(m&&b!=t.length-1){if(p.lastIndex=w,!(T=p.exec(e)))break;for(var k=T.index+(h?T[1].length:0),E=T.index+T[0].length,O=b,_=w,S=t.length;O<S&&(_<E||!t[O].type&&!t[O-1].greedy);++O)k>=(_+=t[O].length)&&(++b,w=_);if(t[b]instanceof o)continue;j=O-b,x=e.slice(w,_),T.index-=w}else{p.lastIndex=0;var T=p.exec(x),j=1}if(T){h&&(g=T[1]?T[1].length:0);E=(k=T.index+g)+(T=T[0].slice(g)).length;var C=x.slice(0,k),I=x.slice(E),A=[b,j];C&&(++b,w+=C.length,A.push(C));var P=new o(c,d?r.tokenize(T,d):T,y,T,m);if(A.push(P),I&&A.push(I),Array.prototype.splice.apply(t,A),1!=j&&r.matchGrammar(e,t,n,b,w,!0,c),s)break}else if(s)break}}}}},tokenize:function(e,t){var n=[e],o=t.rest;if(o){for(var i in o)t[i]=o[i];delete t.rest}return r.matchGrammar(e,n,t,0,0,!1),n},hooks:{all:{},add:function(e,t){var n=r.hooks.all;n[e]=n[e]||[],n[e].push(t)},run:function(e,t){var n=r.hooks.all[e];if(n&&n.length)for(var o,i=0;o=n[i++];)o(t)}},Token:o};function o(e,t,n,r,o){this.type=e,this.content=t,this.alias=n,this.length=0|(r||"").length,this.greedy=!!o}if(e.Prism=r,o.stringify=function(e,t){if("string"==typeof e)return e;if(Array.isArray(e))return e.map((function(e){return o.stringify(e,t)})).join("");var n={type:e.type,content:o.stringify(e.content,t),tag:"span",classes:["token",e.type],attributes:{},language:t};if(e.alias){var i=Array.isArray(e.alias)?e.alias:[e.alias];Array.prototype.push.apply(n.classes,i)}r.hooks.run("wrap",n);var a=Object.keys(n.attributes).map((function(e){return e+'="'+(n.attributes[e]||"").replace(/"/g,""")+'"'})).join(" ");return"<"+n.tag+' class="'+n.classes.join(" ")+'"'+(a?" "+a:"")+">"+n.content+"</"+n.tag+">"},!e.document)return e.addEventListener?(r.disableWorkerMessageHandler||e.addEventListener("message",(function(t){var n=JSON.parse(t.data),o=n.language,i=n.code,a=n.immediateClose;e.postMessage(r.highlight(i,r.languages[o],o)),a&&e.close()}),!1),r):r;var i=document.currentScript||[].slice.call(document.getElementsByTagName("script")).pop();return i&&(r.filename=i.src,r.manual||i.hasAttribute("data-manual")||("loading"!==document.readyState?window.requestAnimationFrame?window.requestAnimationFrame(r.highlightAll):window.setTimeout(r.highlightAll,16):document.addEventListener("DOMContentLoaded",r.highlightAll))),r}("undefined"!=typeof window?window:"undefined"!=typeof WorkerGlobalScope&&self instanceof WorkerGlobalScope?self:{});e.exports&&(e.exports=n),void 0!==t&&(t.Prism=n),n.languages.markup={comment:/<!--[\s\S]*?-->/,prolog:/<\?[\s\S]+?\?>/,doctype:/<!DOCTYPE[\s\S]+?>/i,cdata:/<!\[CDATA\[[\s\S]*?]]>/i,tag:{pattern:/<\/?(?!\d)[^\s>\/=$<%]+(?:\s(?:\s*[^\s>\/=]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))|(?=[\s/>])))+)?\s*\/?>/i,greedy:!0,inside:{tag:{pattern:/^<\/?[^\s>\/]+/i,inside:{punctuation:/^<\/?/,namespace:/^[^\s>\/:]+:/}},"attr-value":{pattern:/=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+)/i,inside:{punctuation:[/^=/,{pattern:/^(\s*)["']|["']$/,lookbehind:!0}]}},punctuation:/\/?>/,"attr-name":{pattern:/[^\s>\/]+/,inside:{namespace:/^[^\s>\/:]+:/}}}},entity:/&#?[\da-z]{1,8};/i},n.languages.markup.tag.inside["attr-value"].inside.entity=n.languages.markup.entity,n.hooks.add("wrap",(function(e){"entity"===e.type&&(e.attributes.title=e.content.replace(/&/,"&"))})),Object.defineProperty(n.languages.markup.tag,"addInlined",{value:function(e,t){var r={};r["language-"+t]={pattern:/(^<!\[CDATA\[)[\s\S]+?(?=\]\]>$)/i,lookbehind:!0,inside:n.languages[t]},r.cdata=/^<!\[CDATA\[|\]\]>$/i;var o={"included-cdata":{pattern:/<!\[CDATA\[[\s\S]*?\]\]>/i,inside:r}};o["language-"+t]={pattern:/[\s\S]+/,inside:n.languages[t]};var i={};i[e]={pattern:RegExp(/(<__[\s\S]*?>)(?:<!\[CDATA\[[\s\S]*?\]\]>\s*|[\s\S])*?(?=<\/__>)/.source.replace(/__/g,e),"i"),lookbehind:!0,greedy:!0,inside:o},n.languages.insertBefore("markup","cdata",i)}}),n.languages.xml=n.languages.extend("markup",{}),n.languages.html=n.languages.markup,n.languages.mathml=n.languages.markup,n.languages.svg=n.languages.markup,function(e){var t=/("|')(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/;e.languages.css={comment:/\/\*[\s\S]*?\*\//,atrule:{pattern:/@[\w-]+[\s\S]*?(?:;|(?=\s*\{))/,inside:{rule:/@[\w-]+/}},url:{pattern:RegExp("url\\((?:"+t.source+"|[^\n\r()]*)\\)","i"),inside:{function:/^url/i,punctuation:/^\(|\)$/}},selector:RegExp("[^{}\\s](?:[^{};\"']|"+t.source+")*?(?=\\s*\\{)"),string:{pattern:t,greedy:!0},property:/[-_a-z\xA0-\uFFFF][-\w\xA0-\uFFFF]*(?=\s*:)/i,important:/!important\b/i,function:/[-a-z0-9]+(?=\()/i,punctuation:/[(){};:,]/},e.languages.css.atrule.inside.rest=e.languages.css;var n=e.languages.markup;n&&(n.tag.addInlined("style","css"),e.languages.insertBefore("inside","attr-value",{"style-attr":{pattern:/\s*style=("|')(?:\\[\s\S]|(?!\1)[^\\])*\1/i,inside:{"attr-name":{pattern:/^\s*style/i,inside:n.tag.inside},punctuation:/^\s*=\s*['"]|['"]\s*$/,"attr-value":{pattern:/.+/i,inside:e.languages.css}},alias:"language-css"}},n.tag))}(n),n.languages.clike={comment:[{pattern:/(^|[^\\])\/\*[\s\S]*?(?:\*\/|$)/,lookbehind:!0},{pattern:/(^|[^\\:])\/\/.*/,lookbehind:!0,greedy:!0}],string:{pattern:/(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0},"class-name":{pattern:/((?:\b(?:class|interface|extends|implements|trait|instanceof|new)\s+)|(?:catch\s+\())[\w.\\]+/i,lookbehind:!0,inside:{punctuation:/[.\\]/}},keyword:/\b(?:if|else|while|do|for|return|in|instanceof|function|new|try|throw|catch|finally|null|break|continue)\b/,boolean:/\b(?:true|false)\b/,function:/\w+(?=\()/,number:/\b0x[\da-f]+\b|(?:\b\d+\.?\d*|\B\.\d+)(?:e[+-]?\d+)?/i,operator:/--?|\+\+?|!=?=?|<=?|>=?|==?=?|&&?|\|\|?|\?|\*|\/|~|\^|%/,punctuation:/[{}[\];(),.:]/},n.languages.javascript=n.languages.extend("clike",{"class-name":[n.languages.clike["class-name"],{pattern:/(^|[^$\w\xA0-\uFFFF])[_$A-Z\xA0-\uFFFF][$\w\xA0-\uFFFF]*(?=\.(?:prototype|constructor))/,lookbehind:!0}],keyword:[{pattern:/((?:^|})\s*)(?:catch|finally)\b/,lookbehind:!0},{pattern:/(^|[^.])\b(?:as|async(?=\s*(?:function\b|\(|[$\w\xA0-\uFFFF]|$))|await|break|case|class|const|continue|debugger|default|delete|do|else|enum|export|extends|for|from|function|get|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)\b/,lookbehind:!0}],number:/\b(?:(?:0[xX](?:[\dA-Fa-f](?:_[\dA-Fa-f])?)+|0[bB](?:[01](?:_[01])?)+|0[oO](?:[0-7](?:_[0-7])?)+)n?|(?:\d(?:_\d)?)+n|NaN|Infinity)\b|(?:\b(?:\d(?:_\d)?)+\.?(?:\d(?:_\d)?)*|\B\.(?:\d(?:_\d)?)+)(?:[Ee][+-]?(?:\d(?:_\d)?)+)?/,function:/#?[_$a-zA-Z\xA0-\uFFFF][$\w\xA0-\uFFFF]*(?=\s*(?:\.\s*(?:apply|bind|call)\s*)?\()/,operator:/-[-=]?|\+[+=]?|!=?=?|<<?=?|>>?>?=?|=(?:==?|>)?|&[&=]?|\|[|=]?|\*\*?=?|\/=?|~|\^=?|%=?|\?|\.{3}/}),n.languages.javascript["class-name"][0].pattern=/(\b(?:class|interface|extends|implements|instanceof|new)\s+)[\w.\\]+/,n.languages.insertBefore("javascript","keyword",{regex:{pattern:/((?:^|[^$\w\xA0-\uFFFF."'\])\s])\s*)\/(\[(?:[^\]\\\r\n]|\\.)*]|\\.|[^/\\\[\r\n])+\/[gimyus]{0,6}(?=\s*($|[\r\n,.;})\]]))/,lookbehind:!0,greedy:!0},"function-variable":{pattern:/#?[_$a-zA-Z\xA0-\uFFFF][$\w\xA0-\uFFFF]*(?=\s*[=:]\s*(?:async\s*)?(?:\bfunction\b|(?:\((?:[^()]|\([^()]*\))*\)|[_$a-zA-Z\xA0-\uFFFF][$\w\xA0-\uFFFF]*)\s*=>))/,alias:"function"},parameter:[{pattern:/(function(?:\s+[_$A-Za-z\xA0-\uFFFF][$\w\xA0-\uFFFF]*)?\s*\(\s*)(?!\s)(?:[^()]|\([^()]*\))+?(?=\s*\))/,lookbehind:!0,inside:n.languages.javascript},{pattern:/[_$a-z\xA0-\uFFFF][$\w\xA0-\uFFFF]*(?=\s*=>)/i,inside:n.languages.javascript},{pattern:/(\(\s*)(?!\s)(?:[^()]|\([^()]*\))+?(?=\s*\)\s*=>)/,lookbehind:!0,inside:n.languages.javascript},{pattern:/((?:\b|\s|^)(?!(?:as|async|await|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally|for|from|function|get|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)(?![$\w\xA0-\uFFFF]))(?:[_$A-Za-z\xA0-\uFFFF][$\w\xA0-\uFFFF]*\s*)\(\s*)(?!\s)(?:[^()]|\([^()]*\))+?(?=\s*\)\s*\{)/,lookbehind:!0,inside:n.languages.javascript}],constant:/\b[A-Z](?:[A-Z_]|\dx?)*\b/}),n.languages.insertBefore("javascript","string",{"template-string":{pattern:/`(?:\\[\s\S]|\${(?:[^{}]|{(?:[^{}]|{[^}]*})*})+}|(?!\${)[^\\`])*`/,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},interpolation:{pattern:/((?:^|[^\\])(?:\\{2})*)\${(?:[^{}]|{(?:[^{}]|{[^}]*})*})+}/,lookbehind:!0,inside:{"interpolation-punctuation":{pattern:/^\${|}$/,alias:"punctuation"},rest:n.languages.javascript}},string:/[\s\S]+/}}}),n.languages.markup&&n.languages.markup.tag.addInlined("script","javascript"),n.languages.js=n.languages.javascript,"undefined"!=typeof self&&self.Prism&&self.document&&document.querySelector&&(self.Prism.fileHighlight=function(e){e=e||document;var t={js:"javascript",py:"python",rb:"ruby",ps1:"powershell",psm1:"powershell",sh:"bash",bat:"batch",h:"c",tex:"latex"};Array.prototype.slice.call(e.querySelectorAll("pre[data-src]")).forEach((function(e){if(!e.hasAttribute("data-src-loaded")){for(var r,o=e.getAttribute("data-src"),i=e,a=/\blang(?:uage)?-([\w-]+)\b/i;i&&!a.test(i.className);)i=i.parentNode;if(i&&(r=(e.className.match(a)||[,""])[1]),!r){var s=(o.match(/\.(\w+)$/)||[,""])[1];r=t[s]||s}var l=document.createElement("code");l.className="language-"+r,e.textContent="",l.textContent="Loading…",e.appendChild(l);var c=new XMLHttpRequest;c.open("GET",o,!0),c.onreadystatechange=function(){4==c.readyState&&(c.status<400&&c.responseText?(l.textContent=c.responseText,n.highlightElement(l),e.setAttribute("data-src-loaded","")):c.status>=400?l.textContent="✖ Error "+c.status+" while fetching file: "+c.statusText:l.textContent="✖ Error: File does not exist or is empty")},c.send(null)}})),n.plugins.toolbar&&n.plugins.toolbar.registerButton("download-file",(function(e){var t=e.element.parentNode;if(t&&/pre/i.test(t.nodeName)&&t.hasAttribute("data-src")&&t.hasAttribute("data-download-link")){var n=t.getAttribute("data-src"),r=document.createElement("a");return r.textContent=t.getAttribute("data-download-link-label")||"Download",r.setAttribute("download",""),r.href=n,r}}))},document.addEventListener("DOMContentLoaded",(function(){self.Prism.fileHighlight()})))}).call(this,n(6))},function(e,t){e.exports=function(e,t){return{enumerable:!(1&e),configurable:!(2&e),writable:!(4&e),value:t}}},function(e,t){e.exports={}},function(e,t){e.exports=function(e){if(null==e)throw TypeError("Can't call method on "+e);return e}},function(e,t,n){var r=n(41);e.exports=function(e){return Object(r(e))}},function(e,t){e.exports={}},function(e,t){e.exports=function(e){if("function"!=typeof e)throw TypeError(String(e)+" is not a function");return e}},function(e,t,n){var r=n(44);e.exports=function(e,t,n){if(r(e),void 0===t)return e;switch(n){case 0:return function(){return e.call(t)};case 1:return function(n){return e.call(t,n)};case 2:return function(n,r){return e.call(t,n,r)};case 3:return function(n,r,o){return e.call(t,n,r,o)}}return function(){return e.apply(t,arguments)}}},function(e,t,n){"use strict";function r(e){return null==e}e.exports.isNothing=r,e.exports.isObject=function(e){return"object"==typeof e&&null!==e},e.exports.toArray=function(e){return Array.isArray(e)?e:r(e)?[]:[e]},e.exports.repeat=function(e,t){var n,r="";for(n=0;n<t;n+=1)r+=e;return r},e.exports.isNegativeZero=function(e){return 0===e&&Number.NEGATIVE_INFINITY===1/e},e.exports.extend=function(e,t){var n,r,o,i;if(t)for(n=0,r=(i=Object.keys(t)).length;n<r;n+=1)e[o=i[n]]=t[o];return e}},function(e,t,n){(function(e){function n(e){return Object.prototype.toString.call(e)}t.isArray=function(e){return Array.isArray?Array.isArray(e):"[object Array]"===n(e)},t.isBoolean=function(e){return"boolean"==typeof e},t.isNull=function(e){return null===e},t.isNullOrUndefined=function(e){return null==e},t.isNumber=function(e){return"number"==typeof e},t.isString=function(e){return"string"==typeof e},t.isSymbol=function(e){return"symbol"==typeof e},t.isUndefined=function(e){return void 0===e},t.isRegExp=function(e){return"[object RegExp]"===n(e)},t.isObject=function(e){return"object"==typeof e&&null!==e},t.isDate=function(e){return"[object Date]"===n(e)},t.isError=function(e){return"[object Error]"===n(e)||e instanceof Error},t.isFunction=function(e){return"function"==typeof e},t.isPrimitive=function(e){return null===e||"boolean"==typeof e||"number"==typeof e||"string"==typeof e||"symbol"==typeof e||void 0===e},t.isBuffer=e.isBuffer}).call(this,n(11).Buffer)},function(t,n){t.exports=e},function(e,t,n){(function(e){function n(e,t){for(var n=0,r=e.length-1;r>=0;r--){var o=e[r];"."===o?e.splice(r,1):".."===o?(e.splice(r,1),n++):n&&(e.splice(r,1),n--)}if(t)for(;n--;n)e.unshift("..");return e}function r(e,t){if(e.filter)return e.filter(t);for(var n=[],r=0;r<e.length;r++)t(e[r],r,e)&&n.push(e[r]);return n}t.resolve=function(){for(var t="",o=!1,i=arguments.length-1;i>=-1&&!o;i--){var a=i>=0?arguments[i]:e.cwd();if("string"!=typeof a)throw new TypeError("Arguments to path.resolve must be strings");a&&(t=a+"/"+t,o="/"===a.charAt(0))}return(o?"/":"")+(t=n(r(t.split("/"),(function(e){return!!e})),!o).join("/"))||"."},t.normalize=function(e){var i=t.isAbsolute(e),a="/"===o(e,-1);return(e=n(r(e.split("/"),(function(e){return!!e})),!i).join("/"))||i||(e="."),e&&a&&(e+="/"),(i?"/":"")+e},t.isAbsolute=function(e){return"/"===e.charAt(0)},t.join=function(){var e=Array.prototype.slice.call(arguments,0);return t.normalize(r(e,(function(e,t){if("string"!=typeof e)throw new TypeError("Arguments to path.join must be strings");return e})).join("/"))},t.relative=function(e,n){function r(e){for(var t=0;t<e.length&&""===e[t];t++);for(var n=e.length-1;n>=0&&""===e[n];n--);return t>n?[]:e.slice(t,n-t+1)}e=t.resolve(e).substr(1),n=t.resolve(n).substr(1);for(var o=r(e.split("/")),i=r(n.split("/")),a=Math.min(o.length,i.length),s=a,l=0;l<a;l++)if(o[l]!==i[l]){s=l;break}var c=[];for(l=s;l<o.length;l++)c.push("..");return(c=c.concat(i.slice(s))).join("/")},t.sep="/",t.delimiter=":",t.dirname=function(e){if("string"!=typeof e&&(e+=""),0===e.length)return".";for(var t=e.charCodeAt(0),n=47===t,r=-1,o=!0,i=e.length-1;i>=1;--i)if(47===(t=e.charCodeAt(i))){if(!o){r=i;break}}else o=!1;return-1===r?n?"/":".":n&&1===r?"/":e.slice(0,r)},t.basename=function(e,t){var n=function(e){"string"!=typeof e&&(e+="");var t,n=0,r=-1,o=!0;for(t=e.length-1;t>=0;--t)if(47===e.charCodeAt(t)){if(!o){n=t+1;break}}else-1===r&&(o=!1,r=t+1);return-1===r?"":e.slice(n,r)}(e);return t&&n.substr(-1*t.length)===t&&(n=n.substr(0,n.length-t.length)),n},t.extname=function(e){"string"!=typeof e&&(e+="");for(var t=-1,n=0,r=-1,o=!0,i=0,a=e.length-1;a>=0;--a){var s=e.charCodeAt(a);if(47!==s)-1===r&&(o=!1,r=a+1),46===s?-1===t?t=a:1!==i&&(i=1):-1!==t&&(i=-1);else if(!o){n=a+1;break}}return-1===t||-1===r||0===i||1===i&&t===r-1&&t===n+1?"":e.slice(t,r)};var o="b"==="ab".substr(-1)?function(e,t,n){return e.substr(t,n)}:function(e,t,n){return t<0&&(t=e.length+t),e.substr(t,n)}}).call(this,n(13))},function(e,t,n){var r,o,i;o=[t],void 0===(i="function"==typeof(r=function(e){"use strict";e.__esModule=!0;var t={},n=Object.prototype.hasOwnProperty,r=function(e){var r=arguments.length<=1||void 0===arguments[1]?t:arguments[1],o=r.cache||{};return function(){for(var t=arguments.length,i=Array(t),a=0;a<t;a++)i[a]=arguments[a];var s=String(i[0]);return!1===r.caseSensitive&&(s=s.toLowerCase()),n.call(o,s)?o[s]:o[s]=e.apply(this,i)}},o=function(e,t){if("function"==typeof t){var n=e;e=t,t=n}var r=t&&t.delay||t||0,o=void 0,i=void 0,a=void 0;return function(){for(var t=arguments.length,n=Array(t),s=0;s<t;s++)n[s]=arguments[s];o=n,i=this,a||(a=setTimeout((function(){e.apply(i,o),o=i=a=null}),r))}},i=function(e,t,n){var r=n.value;return{configurable:!0,get:function(){var e=r.bind(this);return Object.defineProperty(this,t,{value:e,configurable:!0,writable:!0}),e}}},a=c(r),s=c(o),l=c((function(e,t){return e.bind(t)}),(function(){return i}));function c(e,t){var n,r=(t=t||e.decorate||(n=e,function(e){return"function"==typeof e?n(e):function(t,r,o){o.value=n(o.value,e,t,r,o)}}))();return function(){for(var n=arguments.length,o=Array(n),i=0;i<n;i++)o[i]=arguments[i];var a=o.length;return(a<2?t:a>2?r:e).apply(void 0,o)}}e.memoize=a,e.debounce=s,e.bind=l,e.default={memoize:a,debounce:s,bind:l}})?r.apply(t,o):r)||(e.exports=i)},function(e,t,n){(function(t){!function(t){"use strict";var n={newline:/^\n+/,code:/^( {4}[^\n]+\n*)+/,fences:/^ {0,3}(`{3,}|~{3,})([^`~\n]*)\n(?:|([\s\S]*?)\n)(?: {0,3}\1[~`]* *(?:\n+|$)|$)/,hr:/^ {0,3}((?:- *){3,}|(?:_ *){3,}|(?:\* *){3,})(?:\n+|$)/,heading:/^ {0,3}(#{1,6}) +([^\n]*?)(?: +#+)? *(?:\n+|$)/,blockquote:/^( {0,3}> ?(paragraph|[^\n]*)(?:\n|$))+/,list:/^( {0,3})(bull) [\s\S]+?(?:hr|def|\n{2,}(?! )(?!\1bull )\n*|\s*$)/,html:"^ {0,3}(?:<(script|pre|style)[\\s>][\\s\\S]*?(?:</\\1>[^\\n]*\\n+|$)|comment[^\\n]*(\\n+|$)|<\\?[\\s\\S]*?\\?>\\n*|<![A-Z][\\s\\S]*?>\\n*|<!\\[CDATA\\[[\\s\\S]*?\\]\\]>\\n*|</?(tag)(?: +|\\n|/?>)[\\s\\S]*?(?:\\n{2,}|$)|<(?!script|pre|style)([a-z][\\w-]*)(?:attribute)*? */?>(?=[ \\t]*(?:\\n|$))[\\s\\S]*?(?:\\n{2,}|$)|</(?!script|pre|style)[a-z][\\w-]*\\s*>(?=[ \\t]*(?:\\n|$))[\\s\\S]*?(?:\\n{2,}|$))",def:/^ {0,3}\[(label)\]: *\n? *<?([^\s>]+)>?(?:(?: +\n? *| *\n *)(title))? *(?:\n+|$)/,nptable:g,table:g,lheading:/^([^\n]+)\n {0,3}(=+|-+) *(?:\n+|$)/,_paragraph:/^([^\n]+(?:\n(?!hr|heading|lheading|blockquote|fences|list|html)[^\n]+)*)/,text:/^[^\n]+/};function r(e){this.tokens=[],this.tokens.links=Object.create(null),this.options=e||k.defaults,this.rules=n.normal,this.options.pedantic?this.rules=n.pedantic:this.options.gfm&&(this.rules=n.gfm)}n._label=/(?!\s*\])(?:\\[\[\]]|[^\[\]])+/,n._title=/(?:"(?:\\"?|[^"\\])*"|'[^'\n]*(?:\n[^'\n]+)*\n?'|\([^()]*\))/,n.def=p(n.def).replace("label",n._label).replace("title",n._title).getRegex(),n.bullet=/(?:[*+-]|\d{1,9}\.)/,n.item=/^( *)(bull) ?[^\n]*(?:\n(?!\1bull ?)[^\n]*)*/,n.item=p(n.item,"gm").replace(/bull/g,n.bullet).getRegex(),n.list=p(n.list).replace(/bull/g,n.bullet).replace("hr","\\n+(?=\\1?(?:(?:- *){3,}|(?:_ *){3,}|(?:\\* *){3,})(?:\\n+|$))").replace("def","\\n+(?="+n.def.source+")").getRegex(),n._tag="address|article|aside|base|basefont|blockquote|body|caption|center|col|colgroup|dd|details|dialog|dir|div|dl|dt|fieldset|figcaption|figure|footer|form|frame|frameset|h[1-6]|head|header|hr|html|iframe|legend|li|link|main|menu|menuitem|meta|nav|noframes|ol|optgroup|option|p|param|section|source|summary|table|tbody|td|tfoot|th|thead|title|tr|track|ul",n._comment=/<!--(?!-?>)[\s\S]*?-->/,n.html=p(n.html,"i").replace("comment",n._comment).replace("tag",n._tag).replace("attribute",/ +[a-zA-Z:_][\w.:-]*(?: *= *"[^"\n]*"| *= *'[^'\n]*'| *= *[^\s"'=<>`]+)?/).getRegex(),n.paragraph=p(n._paragraph).replace("hr",n.hr).replace("heading"," {0,3}#{1,6} +").replace("|lheading","").replace("blockquote"," {0,3}>").replace("fences"," {0,3}(?:`{3,}|~{3,})[^`\\n]*\\n").replace("list"," {0,3}(?:[*+-]|1[.)]) ").replace("html","</?(?:tag)(?: +|\\n|/?>)|<(?:script|pre|style|!--)").replace("tag",n._tag).getRegex(),n.blockquote=p(n.blockquote).replace("paragraph",n.paragraph).getRegex(),n.normal=y({},n),n.gfm=y({},n.normal,{nptable:/^ *([^|\n ].*\|.*)\n *([-:]+ *\|[-| :]*)(?:\n((?:.*[^>\n ].*(?:\n|$))*)\n*|$)/,table:/^ *\|(.+)\n *\|?( *[-:]+[-| :]*)(?:\n((?: *[^>\n ].*(?:\n|$))*)\n*|$)/}),n.pedantic=y({},n.normal,{html:p("^ *(?:comment *(?:\\n|\\s*$)|<(tag)[\\s\\S]+?</\\1> *(?:\\n{2,}|\\s*$)|<tag(?:\"[^\"]*\"|'[^']*'|\\s[^'\"/>\\s]*)*?/?> *(?:\\n{2,}|\\s*$))").replace("comment",n._comment).replace(/tag/g,"(?!(?:a|em|strong|small|s|cite|q|dfn|abbr|data|time|code|var|samp|kbd|sub|sup|i|b|u|mark|ruby|rt|rp|bdi|bdo|span|br|wbr|ins|del|img)\\b)\\w+(?!:|[^\\w\\s@]*@)\\b").getRegex(),def:/^ *\[([^\]]+)\]: *<?([^\s>]+)>?(?: +(["(][^\n]+[")]))? *(?:\n+|$)/,heading:/^ *(#{1,6}) *([^\n]+?) *(?:#+ *)?(?:\n+|$)/,fences:g,paragraph:p(n.normal._paragraph).replace("hr",n.hr).replace("heading"," *#{1,6} *[^\n]").replace("lheading",n.lheading).replace("blockquote"," {0,3}>").replace("|fences","").replace("|list","").replace("|html","").getRegex()}),r.rules=n,r.lex=function(e,t){return new r(t).lex(e)},r.prototype.lex=function(e){return e=e.replace(/\r\n|\r/g,"\n").replace(/\t/g," ").replace(/\u00a0/g," ").replace(/\u2424/g,"\n"),this.token(e,!0)},r.prototype.token=function(e,t){var r,o,i,a,s,l,c,f,p,d,h,m,g,y,w,x;for(e=e.replace(/^ +$/gm,"");e;)if((i=this.rules.newline.exec(e))&&(e=e.substring(i[0].length),i[0].length>1&&this.tokens.push({type:"space"})),i=this.rules.code.exec(e)){var k=this.tokens[this.tokens.length-1];e=e.substring(i[0].length),k&&"paragraph"===k.type?k.text+="\n"+i[0].trimRight():(i=i[0].replace(/^ {4}/gm,""),this.tokens.push({type:"code",codeBlockStyle:"indented",text:this.options.pedantic?i:b(i,"\n")}))}else if(i=this.rules.fences.exec(e))e=e.substring(i[0].length),this.tokens.push({type:"code",lang:i[2]?i[2].trim():i[2],text:i[3]||""});else if(i=this.rules.heading.exec(e))e=e.substring(i[0].length),this.tokens.push({type:"heading",depth:i[1].length,text:i[2]});else if((i=this.rules.nptable.exec(e))&&(l={type:"table",header:v(i[1].replace(/^ *| *\| *$/g,"")),align:i[2].replace(/^ *|\| *$/g,"").split(/ *\| */),cells:i[3]?i[3].replace(/\n$/,"").split("\n"):[]}).header.length===l.align.length){for(e=e.substring(i[0].length),h=0;h<l.align.length;h++)/^ *-+: *$/.test(l.align[h])?l.align[h]="right":/^ *:-+: *$/.test(l.align[h])?l.align[h]="center":/^ *:-+ *$/.test(l.align[h])?l.align[h]="left":l.align[h]=null;for(h=0;h<l.cells.length;h++)l.cells[h]=v(l.cells[h],l.header.length);this.tokens.push(l)}else if(i=this.rules.hr.exec(e))e=e.substring(i[0].length),this.tokens.push({type:"hr"});else if(i=this.rules.blockquote.exec(e))e=e.substring(i[0].length),this.tokens.push({type:"blockquote_start"}),i=i[0].replace(/^ *> ?/gm,""),this.token(i,t),this.tokens.push({type:"blockquote_end"});else if(i=this.rules.list.exec(e)){for(e=e.substring(i[0].length),c={type:"list_start",ordered:y=(a=i[2]).length>1,start:y?+a:"",loose:!1},this.tokens.push(c),f=[],r=!1,g=(i=i[0].match(this.rules.item)).length,h=0;h<g;h++)d=(l=i[h]).length,~(l=l.replace(/^ *([*+-]|\d+\.) */,"")).indexOf("\n ")&&(d-=l.length,l=this.options.pedantic?l.replace(/^ {1,4}/gm,""):l.replace(new RegExp("^ {1,"+d+"}","gm"),"")),h!==g-1&&(s=n.bullet.exec(i[h+1])[0],(a.length>1?1===s.length:s.length>1||this.options.smartLists&&s!==a)&&(e=i.slice(h+1).join("\n")+e,h=g-1)),o=r||/\n\n(?!\s*$)/.test(l),h!==g-1&&(r="\n"===l.charAt(l.length-1),o||(o=r)),o&&(c.loose=!0),x=void 0,(w=/^\[[ xX]\] /.test(l))&&(x=" "!==l[1],l=l.replace(/^\[[ xX]\] +/,"")),p={type:"list_item_start",task:w,checked:x,loose:o},f.push(p),this.tokens.push(p),this.token(l,!1),this.tokens.push({type:"list_item_end"});if(c.loose)for(g=f.length,h=0;h<g;h++)f[h].loose=!0;this.tokens.push({type:"list_end"})}else if(i=this.rules.html.exec(e))e=e.substring(i[0].length),this.tokens.push({type:this.options.sanitize?"paragraph":"html",pre:!this.options.sanitizer&&("pre"===i[1]||"script"===i[1]||"style"===i[1]),text:this.options.sanitize?this.options.sanitizer?this.options.sanitizer(i[0]):u(i[0]):i[0]});else if(t&&(i=this.rules.def.exec(e)))e=e.substring(i[0].length),i[3]&&(i[3]=i[3].substring(1,i[3].length-1)),m=i[1].toLowerCase().replace(/\s+/g," "),this.tokens.links[m]||(this.tokens.links[m]={href:i[2],title:i[3]});else if((i=this.rules.table.exec(e))&&(l={type:"table",header:v(i[1].replace(/^ *| *\| *$/g,"")),align:i[2].replace(/^ *|\| *$/g,"").split(/ *\| */),cells:i[3]?i[3].replace(/\n$/,"").split("\n"):[]}).header.length===l.align.length){for(e=e.substring(i[0].length),h=0;h<l.align.length;h++)/^ *-+: *$/.test(l.align[h])?l.align[h]="right":/^ *:-+: *$/.test(l.align[h])?l.align[h]="center":/^ *:-+ *$/.test(l.align[h])?l.align[h]="left":l.align[h]=null;for(h=0;h<l.cells.length;h++)l.cells[h]=v(l.cells[h].replace(/^ *\| *| *\| *$/g,""),l.header.length);this.tokens.push(l)}else if(i=this.rules.lheading.exec(e))e=e.substring(i[0].length),this.tokens.push({type:"heading",depth:"="===i[2].charAt(0)?1:2,text:i[1]});else if(t&&(i=this.rules.paragraph.exec(e)))e=e.substring(i[0].length),this.tokens.push({type:"paragraph",text:"\n"===i[1].charAt(i[1].length-1)?i[1].slice(0,-1):i[1]});else if(i=this.rules.text.exec(e))e=e.substring(i[0].length),this.tokens.push({type:"text",text:i[0]});else if(e)throw new Error("Infinite loop on byte: "+e.charCodeAt(0));return this.tokens};var o={escape:/^\\([!"#$%&'()*+,\-./:;<=>?@\[\]\\^_`{|}~])/,autolink:/^<(scheme:[^\s\x00-\x1f<>]*|email)>/,url:g,tag:"^comment|^</[a-zA-Z][\\w:-]*\\s*>|^<[a-zA-Z][\\w-]*(?:attribute)*?\\s*/?>|^<\\?[\\s\\S]*?\\?>|^<![a-zA-Z]+\\s[\\s\\S]*?>|^<!\\[CDATA\\[[\\s\\S]*?\\]\\]>",link:/^!?\[(label)\]\(\s*(href)(?:\s+(title))?\s*\)/,reflink:/^!?\[(label)\]\[(?!\s*\])((?:\\[\[\]]?|[^\[\]\\])+)\]/,nolink:/^!?\[(?!\s*\])((?:\[[^\[\]]*\]|\\[\[\]]|[^\[\]])*)\](?:\[\])?/,strong:/^__([^\s_])__(?!_)|^\*\*([^\s*])\*\*(?!\*)|^__([^\s][\s\S]*?[^\s])__(?!_)|^\*\*([^\s][\s\S]*?[^\s])\*\*(?!\*)/,em:/^_([^\s_])_(?!_)|^\*([^\s*<\[])\*(?!\*)|^_([^\s<][\s\S]*?[^\s_])_(?!_|[^\spunctuation])|^_([^\s_<][\s\S]*?[^\s])_(?!_|[^\spunctuation])|^\*([^\s<"][\s\S]*?[^\s\*])\*(?!\*|[^\spunctuation])|^\*([^\s*"<\[][\s\S]*?[^\s])\*(?!\*)/,code:/^(`+)([^`]|[^`][\s\S]*?[^`])\1(?!`)/,br:/^( {2,}|\\)\n(?!\s*$)/,del:g,text:/^(`+|[^`])(?:[\s\S]*?(?:(?=[\\<!\[`*]|\b_|$)|[^ ](?= {2,}\n))|(?= {2,}\n))/};function i(e,t){if(this.options=t||k.defaults,this.links=e,this.rules=o.normal,this.renderer=this.options.renderer||new a,this.renderer.options=this.options,!this.links)throw new Error("Tokens array requires a `links` property.");this.options.pedantic?this.rules=o.pedantic:this.options.gfm&&(this.options.breaks?this.rules=o.breaks:this.rules=o.gfm)}function a(e){this.options=e||k.defaults}function s(){}function l(e){this.tokens=[],this.token=null,this.options=e||k.defaults,this.options.renderer=this.options.renderer||new a,this.renderer=this.options.renderer,this.renderer.options=this.options,this.slugger=new c}function c(){this.seen={}}function u(e,t){if(t){if(u.escapeTest.test(e))return e.replace(u.escapeReplace,(function(e){return u.replacements[e]}))}else if(u.escapeTestNoEncode.test(e))return e.replace(u.escapeReplaceNoEncode,(function(e){return u.replacements[e]}));return e}function f(e){return e.replace(/&(#(?:\d+)|(?:#x[0-9A-Fa-f]+)|(?:\w+));?/gi,(function(e,t){return"colon"===(t=t.toLowerCase())?":":"#"===t.charAt(0)?"x"===t.charAt(1)?String.fromCharCode(parseInt(t.substring(2),16)):String.fromCharCode(+t.substring(1)):""}))}function p(e,t){return e=e.source||e,t=t||"",{replace:function(t,n){return n=(n=n.source||n).replace(/(^|[^\[])\^/g,"$1"),e=e.replace(t,n),this},getRegex:function(){return new RegExp(e,t)}}}function d(e,t,n){if(e){try{var r=decodeURIComponent(f(n)).replace(/[^\w:]/g,"").toLowerCase()}catch(e){return null}if(0===r.indexOf("javascript:")||0===r.indexOf("vbscript:")||0===r.indexOf("data:"))return null}t&&!m.test(n)&&(n=function(e,t){h[" "+e]||(/^[^:]+:\/*[^/]*$/.test(e)?h[" "+e]=e+"/":h[" "+e]=b(e,"/",!0));return e=h[" "+e],"//"===t.slice(0,2)?e.replace(/:[\s\S]*/,":")+t:"/"===t.charAt(0)?e.replace(/(:\/*[^/]*)[\s\S]*/,"$1")+t:e+t}(t,n));try{n=encodeURI(n).replace(/%25/g,"%")}catch(e){return null}return n}o._punctuation="!\"#$%&'()*+,\\-./:;<=>?@\\[^_{|}~",o.em=p(o.em).replace(/punctuation/g,o._punctuation).getRegex(),o._escapes=/\\([!"#$%&'()*+,\-./:;<=>?@\[\]\\^_`{|}~])/g,o._scheme=/[a-zA-Z][a-zA-Z0-9+.-]{1,31}/,o._email=/[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+(@)[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+(?![-_])/,o.autolink=p(o.autolink).replace("scheme",o._scheme).replace("email",o._email).getRegex(),o._attribute=/\s+[a-zA-Z:_][\w.:-]*(?:\s*=\s*"[^"]*"|\s*=\s*'[^']*'|\s*=\s*[^\s"'=<>`]+)?/,o.tag=p(o.tag).replace("comment",n._comment).replace("attribute",o._attribute).getRegex(),o._label=/(?:\[[^\[\]]*\]|\\.|`[^`]*`|[^\[\]\\`])*?/,o._href=/<(?:\\[<>]?|[^\s<>\\])*>|[^\s\x00-\x1f]*/,o._title=/"(?:\\"?|[^"\\])*"|'(?:\\'?|[^'\\])*'|\((?:\\\)?|[^)\\])*\)/,o.link=p(o.link).replace("label",o._label).replace("href",o._href).replace("title",o._title).getRegex(),o.reflink=p(o.reflink).replace("label",o._label).getRegex(),o.normal=y({},o),o.pedantic=y({},o.normal,{strong:/^__(?=\S)([\s\S]*?\S)__(?!_)|^\*\*(?=\S)([\s\S]*?\S)\*\*(?!\*)/,em:/^_(?=\S)([\s\S]*?\S)_(?!_)|^\*(?=\S)([\s\S]*?\S)\*(?!\*)/,link:p(/^!?\[(label)\]\((.*?)\)/).replace("label",o._label).getRegex(),reflink:p(/^!?\[(label)\]\s*\[([^\]]*)\]/).replace("label",o._label).getRegex()}),o.gfm=y({},o.normal,{escape:p(o.escape).replace("])","~|])").getRegex(),_extended_email:/[A-Za-z0-9._+-]+(@)[a-zA-Z0-9-_]+(?:\.[a-zA-Z0-9-_]*[a-zA-Z0-9])+(?![-_])/,url:/^((?:ftp|https?):\/\/|www\.)(?:[a-zA-Z0-9\-]+\.?)+[^\s<]*|^email/,_backpedal:/(?:[^?!.,:;*_~()&]+|\([^)]*\)|&(?![a-zA-Z0-9]+;$)|[?!.,:;*_~)]+(?!$))+/,del:/^~+(?=\S)([\s\S]*?\S)~+/,text:/^(`+|[^`])(?:[\s\S]*?(?:(?=[\\<!\[`*~]|\b_|https?:\/\/|ftp:\/\/|www\.|$)|[^ ](?= {2,}\n)|[^a-zA-Z0-9.!#$%&'*+\/=?_`{\|}~-](?=[a-zA-Z0-9.!#$%&'*+\/=?_`{\|}~-]+@))|(?= {2,}\n|[a-zA-Z0-9.!#$%&'*+\/=?_`{\|}~-]+@))/}),o.gfm.url=p(o.gfm.url,"i").replace("email",o.gfm._extended_email).getRegex(),o.breaks=y({},o.gfm,{br:p(o.br).replace("{2,}","*").getRegex(),text:p(o.gfm.text).replace("\\b_","\\b_| {2,}\\n").replace(/\{2,\}/g,"*").getRegex()}),i.rules=o,i.output=function(e,t,n){return new i(t,n).output(e)},i.prototype.output=function(e){for(var t,n,r,o,a,s,l="";e;)if(a=this.rules.escape.exec(e))e=e.substring(a[0].length),l+=u(a[1]);else if(a=this.rules.tag.exec(e))!this.inLink&&/^<a /i.test(a[0])?this.inLink=!0:this.inLink&&/^<\/a>/i.test(a[0])&&(this.inLink=!1),!this.inRawBlock&&/^<(pre|code|kbd|script)(\s|>)/i.test(a[0])?this.inRawBlock=!0:this.inRawBlock&&/^<\/(pre|code|kbd|script)(\s|>)/i.test(a[0])&&(this.inRawBlock=!1),e=e.substring(a[0].length),l+=this.options.sanitize?this.options.sanitizer?this.options.sanitizer(a[0]):u(a[0]):a[0];else if(a=this.rules.link.exec(e)){var c=w(a[2],"()");if(c>-1){var f=4+a[1].length+c;a[2]=a[2].substring(0,c),a[0]=a[0].substring(0,f).trim(),a[3]=""}e=e.substring(a[0].length),this.inLink=!0,r=a[2],this.options.pedantic?(t=/^([^'"]*[^\s])\s+(['"])(.*)\2/.exec(r))?(r=t[1],o=t[3]):o="":o=a[3]?a[3].slice(1,-1):"",r=r.trim().replace(/^<([\s\S]*)>$/,"$1"),l+=this.outputLink(a,{href:i.escapes(r),title:i.escapes(o)}),this.inLink=!1}else if((a=this.rules.reflink.exec(e))||(a=this.rules.nolink.exec(e))){if(e=e.substring(a[0].length),t=(a[2]||a[1]).replace(/\s+/g," "),!(t=this.links[t.toLowerCase()])||!t.href){l+=a[0].charAt(0),e=a[0].substring(1)+e;continue}this.inLink=!0,l+=this.outputLink(a,t),this.inLink=!1}else if(a=this.rules.strong.exec(e))e=e.substring(a[0].length),l+=this.renderer.strong(this.output(a[4]||a[3]||a[2]||a[1]));else if(a=this.rules.em.exec(e))e=e.substring(a[0].length),l+=this.renderer.em(this.output(a[6]||a[5]||a[4]||a[3]||a[2]||a[1]));else if(a=this.rules.code.exec(e))e=e.substring(a[0].length),l+=this.renderer.codespan(u(a[2].trim(),!0));else if(a=this.rules.br.exec(e))e=e.substring(a[0].length),l+=this.renderer.br();else if(a=this.rules.del.exec(e))e=e.substring(a[0].length),l+=this.renderer.del(this.output(a[1]));else if(a=this.rules.autolink.exec(e))e=e.substring(a[0].length),r="@"===a[2]?"mailto:"+(n=u(this.mangle(a[1]))):n=u(a[1]),l+=this.renderer.link(r,null,n);else if(this.inLink||!(a=this.rules.url.exec(e))){if(a=this.rules.text.exec(e))e=e.substring(a[0].length),this.inRawBlock?l+=this.renderer.text(this.options.sanitize?this.options.sanitizer?this.options.sanitizer(a[0]):u(a[0]):a[0]):l+=this.renderer.text(u(this.smartypants(a[0])));else if(e)throw new Error("Infinite loop on byte: "+e.charCodeAt(0))}else{if("@"===a[2])r="mailto:"+(n=u(a[0]));else{do{s=a[0],a[0]=this.rules._backpedal.exec(a[0])[0]}while(s!==a[0]);n=u(a[0]),r="www."===a[1]?"http://"+n:n}e=e.substring(a[0].length),l+=this.renderer.link(r,null,n)}return l},i.escapes=function(e){return e?e.replace(i.rules._escapes,"$1"):e},i.prototype.outputLink=function(e,t){var n=t.href,r=t.title?u(t.title):null;return"!"!==e[0].charAt(0)?this.renderer.link(n,r,this.output(e[1])):this.renderer.image(n,r,u(e[1]))},i.prototype.smartypants=function(e){return this.options.smartypants?e.replace(/---/g,"—").replace(/--/g,"–").replace(/(^|[-\u2014/(\[{"\s])'/g,"$1‘").replace(/'/g,"’").replace(/(^|[-\u2014/(\[{\u2018\s])"/g,"$1“").replace(/"/g,"”").replace(/\.{3}/g,"…"):e},i.prototype.mangle=function(e){if(!this.options.mangle)return e;for(var t,n="",r=e.length,o=0;o<r;o++)t=e.charCodeAt(o),Math.random()>.5&&(t="x"+t.toString(16)),n+="&#"+t+";";return n},a.prototype.code=function(e,t,n){var r=(t||"").match(/\S*/)[0];if(this.options.highlight){var o=this.options.highlight(e,r);null!=o&&o!==e&&(n=!0,e=o)}return r?'<pre><code class="'+this.options.langPrefix+u(r,!0)+'">'+(n?e:u(e,!0))+"</code></pre>\n":"<pre><code>"+(n?e:u(e,!0))+"</code></pre>"},a.prototype.blockquote=function(e){return"<blockquote>\n"+e+"</blockquote>\n"},a.prototype.html=function(e){return e},a.prototype.heading=function(e,t,n,r){return this.options.headerIds?"<h"+t+' id="'+this.options.headerPrefix+r.slug(n)+'">'+e+"</h"+t+">\n":"<h"+t+">"+e+"</h"+t+">\n"},a.prototype.hr=function(){return this.options.xhtml?"<hr/>\n":"<hr>\n"},a.prototype.list=function(e,t,n){var r=t?"ol":"ul";return"<"+r+(t&&1!==n?' start="'+n+'"':"")+">\n"+e+"</"+r+">\n"},a.prototype.listitem=function(e){return"<li>"+e+"</li>\n"},a.prototype.checkbox=function(e){return"<input "+(e?'checked="" ':"")+'disabled="" type="checkbox"'+(this.options.xhtml?" /":"")+"> "},a.prototype.paragraph=function(e){return"<p>"+e+"</p>\n"},a.prototype.table=function(e,t){return t&&(t="<tbody>"+t+"</tbody>"),"<table>\n<thead>\n"+e+"</thead>\n"+t+"</table>\n"},a.prototype.tablerow=function(e){return"<tr>\n"+e+"</tr>\n"},a.prototype.tablecell=function(e,t){var n=t.header?"th":"td";return(t.align?"<"+n+' align="'+t.align+'">':"<"+n+">")+e+"</"+n+">\n"},a.prototype.strong=function(e){return"<strong>"+e+"</strong>"},a.prototype.em=function(e){return"<em>"+e+"</em>"},a.prototype.codespan=function(e){return"<code>"+e+"</code>"},a.prototype.br=function(){return this.options.xhtml?"<br/>":"<br>"},a.prototype.del=function(e){return"<del>"+e+"</del>"},a.prototype.link=function(e,t,n){if(null===(e=d(this.options.sanitize,this.options.baseUrl,e)))return n;var r='<a href="'+u(e)+'"';return t&&(r+=' title="'+t+'"'),r+=">"+n+"</a>"},a.prototype.image=function(e,t,n){if(null===(e=d(this.options.sanitize,this.options.baseUrl,e)))return n;var r='<img src="'+e+'" alt="'+n+'"';return t&&(r+=' title="'+t+'"'),r+=this.options.xhtml?"/>":">"},a.prototype.text=function(e){return e},s.prototype.strong=s.prototype.em=s.prototype.codespan=s.prototype.del=s.prototype.text=function(e){return e},s.prototype.link=s.prototype.image=function(e,t,n){return""+n},s.prototype.br=function(){return""},l.parse=function(e,t){return new l(t).parse(e)},l.prototype.parse=function(e){this.inline=new i(e.links,this.options),this.inlineText=new i(e.links,y({},this.options,{renderer:new s})),this.tokens=e.reverse();for(var t="";this.next();)t+=this.tok();return t},l.prototype.next=function(){return this.token=this.tokens.pop(),this.token},l.prototype.peek=function(){return this.tokens[this.tokens.length-1]||0},l.prototype.parseText=function(){for(var e=this.token.text;"text"===this.peek().type;)e+="\n"+this.next().text;return this.inline.output(e)},l.prototype.tok=function(){switch(this.token.type){case"space":return"";case"hr":return this.renderer.hr();case"heading":return this.renderer.heading(this.inline.output(this.token.text),this.token.depth,f(this.inlineText.output(this.token.text)),this.slugger);case"code":return this.renderer.code(this.token.text,this.token.lang,this.token.escaped);case"table":var e,t,n,r,o="",i="";for(n="",e=0;e<this.token.header.length;e++)n+=this.renderer.tablecell(this.inline.output(this.token.header[e]),{header:!0,align:this.token.align[e]});for(o+=this.renderer.tablerow(n),e=0;e<this.token.cells.length;e++){for(t=this.token.cells[e],n="",r=0;r<t.length;r++)n+=this.renderer.tablecell(this.inline.output(t[r]),{header:!1,align:this.token.align[r]});i+=this.renderer.tablerow(n)}return this.renderer.table(o,i);case"blockquote_start":for(i="";"blockquote_end"!==this.next().type;)i+=this.tok();return this.renderer.blockquote(i);case"list_start":i="";for(var a=this.token.ordered,s=this.token.start;"list_end"!==this.next().type;)i+=this.tok();return this.renderer.list(i,a,s);case"list_item_start":i="";var l=this.token.loose,c=this.token.checked,u=this.token.task;for(this.token.task&&(i+=this.renderer.checkbox(c));"list_item_end"!==this.next().type;)i+=l||"text"!==this.token.type?this.tok():this.parseText();return this.renderer.listitem(i,u,c);case"html":return this.renderer.html(this.token.text);case"paragraph":return this.renderer.paragraph(this.inline.output(this.token.text));case"text":return this.renderer.paragraph(this.parseText());default:var p='Token with "'+this.token.type+'" type was not found.';if(!this.options.silent)throw new Error(p);console.log(p)}},c.prototype.slug=function(e){var t=e.toLowerCase().trim().replace(/[\u2000-\u206F\u2E00-\u2E7F\\'!"#$%&()*+,./:;<=>?@[\]^`{|}~]/g,"").replace(/\s/g,"-");if(this.seen.hasOwnProperty(t)){var n=t;do{this.seen[n]++,t=n+"-"+this.seen[n]}while(this.seen.hasOwnProperty(t))}return this.seen[t]=0,t},u.escapeTest=/[&<>"']/,u.escapeReplace=/[&<>"']/g,u.replacements={"&":"&","<":"<",">":">",'"':""","'":"'"},u.escapeTestNoEncode=/[<>"']|&(?!#?\w+;)/,u.escapeReplaceNoEncode=/[<>"']|&(?!#?\w+;)/g;var h={},m=/^$|^[a-z][a-z0-9+.-]*:|^[?#]/i;function g(){}function y(e){for(var t,n,r=1;r<arguments.length;r++)for(n in t=arguments[r])Object.prototype.hasOwnProperty.call(t,n)&&(e[n]=t[n]);return e}function v(e,t){var n=e.replace(/\|/g,(function(e,t,n){for(var r=!1,o=t;--o>=0&&"\\"===n[o];)r=!r;return r?"|":" |"})).split(/ \|/),r=0;if(n.length>t)n.splice(t);else for(;n.length<t;)n.push("");for(;r<n.length;r++)n[r]=n[r].trim().replace(/\\\|/g,"|");return n}function b(e,t,n){if(0===e.length)return"";for(var r=0;r<e.length;){var o=e.charAt(e.length-r-1);if(o!==t||n){if(o===t||!n)break;r++}else r++}return e.substr(0,e.length-r)}function w(e,t){if(-1===e.indexOf(t[1]))return-1;for(var n=0,r=0;r<e.length;r++)if("\\"===e[r])r++;else if(e[r]===t[0])n++;else if(e[r]===t[1]&&--n<0)return r;return-1}function x(e){e&&e.sanitize&&!e.silent&&console.warn("marked(): sanitize and sanitizer parameters are deprecated since version 0.7.0, should not be used and will be removed in the future. Read more here: https://marked.js.org/#/USING_ADVANCED.md#options")}function k(e,t,n){if(null==e)throw new Error("marked(): input parameter is undefined or null");if("string"!=typeof e)throw new Error("marked(): input parameter is of type "+Object.prototype.toString.call(e)+", string expected");if(n||"function"==typeof t){n||(n=t,t=null),x(t=y({},k.defaults,t||{}));var o,i,a=t.highlight,s=0;try{o=r.lex(e,t)}catch(e){return n(e)}i=o.length;var c=function(e){if(e)return t.highlight=a,n(e);var r;try{r=l.parse(o,t)}catch(t){e=t}return t.highlight=a,e?n(e):n(null,r)};if(!a||a.length<3)return c();if(delete t.highlight,!i)return c();for(;s<o.length;s++)!function(e){"code"!==e.type?--i||c():a(e.text,e.lang,(function(t,n){return t?c(t):null==n||n===e.text?--i||c():(e.text=n,e.escaped=!0,void(--i||c()))}))}(o[s])}else try{return t&&(t=y({},k.defaults,t)),x(t),l.parse(r.lex(e,t),t)}catch(e){if(e.message+="\nPlease report this to https://github.com/markedjs/marked.",(t||k.defaults).silent)return"<p>An error occurred:</p><pre>"+u(e.message+"",!0)+"</pre>";throw e}}g.exec=g,k.options=k.setOptions=function(e){return y(k.defaults,e),k},k.getDefaults=function(){return{baseUrl:null,breaks:!1,gfm:!0,headerIds:!0,headerPrefix:"",highlight:null,langPrefix:"language-",mangle:!0,pedantic:!1,renderer:new a,sanitize:!1,sanitizer:null,silent:!1,smartLists:!1,smartypants:!1,xhtml:!1}},k.defaults=k.getDefaults(),k.Parser=l,k.parser=l.parse,k.Renderer=a,k.TextRenderer=s,k.Lexer=r,k.lexer=r.lex,k.InlineLexer=i,k.inlineLexer=i.output,k.Slugger=c,k.parse=k,e.exports=k}(this||"undefined"!=typeof window&&window)}).call(this,n(6))},function(e,t,n){var r=n(7);e.exports=function(e,t){if(!r(e))return e;var n,o;if(t&&"function"==typeof(n=e.toString)&&!r(o=n.call(e)))return o;if("function"==typeof(n=e.valueOf)&&!r(o=n.call(e)))return o;if(!t&&"function"==typeof(n=e.toString)&&!r(o=n.call(e)))return o;throw TypeError("Can't convert object to primitive value")}},function(e,t){var n=0,r=Math.random();e.exports=function(e){return"Symbol("+String(void 0===e?"":e)+")_"+(++n+r).toString(36)}},function(e,t,n){var r=n(66),o=n(53),i=r("keys");e.exports=function(e){return i[e]||(i[e]=o(e))}},function(e,t,n){var r=n(19),o=n(170),i=n(76),a=n(40),s=n(107),l=n(68),c=n(54)("IE_PROTO"),u=function(){},f=function(){var e,t=l("iframe"),n=i.length;for(t.style.display="none",s.appendChild(t),t.src=String("javascript:"),(e=t.contentWindow.document).open(),e.write("<script>document.F=Object<\/script>"),e.close(),f=e.F;n--;)delete f.prototype[i[n]];return f()};e.exports=Object.create||function(e,t){var n;return null!==e?(u.prototype=r(e),n=new u,u.prototype=null,n[c]=e):n=f(),void 0===t?n:o(n,t)},a[c]=!0},function(e,t,n){var r=n(19),o=n(175),i=n(35),a=n(45),s=n(176),l=n(177),c=function(e,t){this.stopped=e,this.result=t};(e.exports=function(e,t,n,u,f){var p,d,h,m,g,y,v,b=a(t,n,u?2:1);if(f)p=e;else{if("function"!=typeof(d=s(e)))throw TypeError("Target is not iterable");if(o(d)){for(h=0,m=i(e.length);m>h;h++)if((g=u?b(r(v=e[h])[0],v[1]):b(e[h]))&&g instanceof c)return g;return new c(!1)}p=d.call(e)}for(y=p.next;!(v=y.call(p)).done;)if("object"==typeof(g=l(p,b,v.value,u))&&g&&g instanceof c)return g;return new c(!1)}).stop=function(e){return new c(!0,e)}},function(e,t,n){"use strict";function r(e,t){Error.call(this),this.name="YAMLException",this.reason=e,this.mark=t,this.message=(this.reason||"(unknown reason)")+(this.mark?" "+this.mark.toString():""),Error.captureStackTrace?Error.captureStackTrace(this,this.constructor):this.stack=(new Error).stack||""}r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r.prototype.toString=function(e){var t=this.name+": ";return t+=this.reason||"(unknown reason)",!e&&this.mark&&(t+=" "+this.mark.toString()),t},e.exports=r},function(e,t,n){"use strict";var r=n(36);e.exports=new r({include:[n(131)],implicit:[n(250),n(251)],explicit:[n(252),n(253),n(254),n(255)]})},function(e,t,n){"use strict";(function(t){void 0===t||!t.version||0===t.version.indexOf("v0.")||0===t.version.indexOf("v1.")&&0!==t.version.indexOf("v1.8.")?e.exports={nextTick:function(e,n,r,o){if("function"!=typeof e)throw new TypeError('"callback" argument must be a function');var i,a,s=arguments.length;switch(s){case 0:case 1:return t.nextTick(e);case 2:return t.nextTick((function(){e.call(null,n)}));case 3:return t.nextTick((function(){e.call(null,n,r)}));case 4:return t.nextTick((function(){e.call(null,n,r,o)}));default:for(i=new Array(s-1),a=0;a<i.length;)i[a++]=arguments[a];return t.nextTick((function(){e.apply(null,i)}))}}}:e.exports=t}).call(this,n(13))},function(e,t,n){"use strict";e.exports=o;var r=n(89);function o(){this.path=void 0,this.value=void 0,this.$refs=void 0,this.pathType=void 0}o.prototype.exists=function(e,t){try{return this.resolve(e,t),!0}catch(e){return!1}},o.prototype.get=function(e,t){return this.resolve(e,t).value},o.prototype.resolve=function(e,t,n){return new r(this,e,n).resolve(this.value,t)},o.prototype.set=function(e,t){var n=new r(this,e);this.value=n.set(this.value,t)},o.is$Ref=function(e){return e&&"object"==typeof e&&"string"==typeof e.$ref&&e.$ref.length>0},o.isExternal$Ref=function(e){return o.is$Ref(e)&&"#"!==e.$ref[0]},o.isAllowed$Ref=function(e,t){if(o.is$Ref(e)){if("#/"===e.$ref.substr(0,2)||"#"===e.$ref)return!0;if("#"!==e.$ref[0]&&(!t||t.resolve.external))return!0}},o.isExtended$Ref=function(e){return o.is$Ref(e)&&Object.keys(e).length>1},o.dereference=function(e,t){if(t&&"object"==typeof t&&o.isExtended$Ref(e)){var n={};return Object.keys(e).forEach((function(t){"$ref"!==t&&(n[t]=e[t])})),Object.keys(t).forEach((function(e){e in n||(n[e]=t[e])})),n}return t}},function(e,t,n){"use strict";function r(e){return e=(e=e.split("~1").join("/")).split("~0").join("~")}e.exports={jptr:function(e,t,n){if(void 0===e)return!1;if(!t||"#"===t)return void 0!==n?n:e;if(t.indexOf("#")>=0){var o=t.split("#");if(o[0])return!1;t=o[1],t=decodeURIComponent(t.slice(1).split("+").join(" "))}t.startsWith("/")&&(t=t.slice(1));for(var i=t.split("/"),a=0;a<i.length;a++){i[a]=r(i[a]);var s=void 0!==n&&a==i.length-1,l=parseInt(i[a],10);if(!Array.isArray(e)||isNaN(l)||l.toString()!==i[a]?l=Array.isArray(e)&&"-"===i[a]?-2:-1:i[a]=a>0?i[a-1]:"",-1!=l||e.hasOwnProperty(i[a]))if(l>=0)s&&(e[l]=n),e=e[l];else{if(-2===l)return s?(Array.isArray(e)&&e.push(n),n):void 0;s&&(e[i[a]]=n),e=e[i[a]]}else{if(void 0===n||"object"!=typeof e||Array.isArray(e))return!1;e[i[a]]=s?n:"0"===i[a+1]||"-"===i[a+1]?[]:{},e=e[i[a]]}}return e},jpescape:function(e){return e=(e=e.split("~").join("~0")).split("/").join("~1")},jpunescape:r}},function(e,t,n){"use strict";var r=n(1);e.exports={nop:function(e){return e},clone:function(e){return JSON.parse(JSON.stringify(e))},shallowClone:function(e){var t={};for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t},deepClone:function e(t){var n=Array.isArray(t)?[]:{};for(var r in t)(t.hasOwnProperty(r)||Array.isArray(t))&&(n[r]="object"==typeof t[r]?e(t[r]):t[r]);return n},fastClone:function(e){return Object.assign({},e)},circularClone:function e(t,n){if(n||(n=new WeakMap),Object(t)!==t||t instanceof Function)return t;if(n.has(t))return n.get(t);try{var o=new t.constructor}catch(e){o=Object.create(Object.getPrototypeOf(t))}return n.set(t,o),Object.assign.apply(Object,r.__spreadArrays([o],Object.keys(t).map((function(r){var o;return(o={})[r]=e(t[r],n),o}))))}}},function(e,t,n){"use strict";var r=Object.prototype.hasOwnProperty,o="~";function i(){}function a(e,t,n){this.fn=e,this.context=t,this.once=n||!1}function s(e,t,n,r,i){if("function"!=typeof n)throw new TypeError("The listener must be a function");var s=new a(n,r||e,i),l=o?o+t:t;return e._events[l]?e._events[l].fn?e._events[l]=[e._events[l],s]:e._events[l].push(s):(e._events[l]=s,e._eventsCount++),e}function l(e,t){0==--e._eventsCount?e._events=new i:delete e._events[t]}function c(){this._events=new i,this._eventsCount=0}Object.create&&(i.prototype=Object.create(null),(new i).__proto__||(o=!1)),c.prototype.eventNames=function(){var e,t,n=[];if(0===this._eventsCount)return n;for(t in e=this._events)r.call(e,t)&&n.push(o?t.slice(1):t);return Object.getOwnPropertySymbols?n.concat(Object.getOwnPropertySymbols(e)):n},c.prototype.listeners=function(e){var t=o?o+e:e,n=this._events[t];if(!n)return[];if(n.fn)return[n.fn];for(var r=0,i=n.length,a=new Array(i);r<i;r++)a[r]=n[r].fn;return a},c.prototype.listenerCount=function(e){var t=o?o+e:e,n=this._events[t];return n?n.fn?1:n.length:0},c.prototype.emit=function(e,t,n,r,i,a){var s=o?o+e:e;if(!this._events[s])return!1;var l,c,u=this._events[s],f=arguments.length;if(u.fn){switch(u.once&&this.removeListener(e,u.fn,void 0,!0),f){case 1:return u.fn.call(u.context),!0;case 2:return u.fn.call(u.context,t),!0;case 3:return u.fn.call(u.context,t,n),!0;case 4:return u.fn.call(u.context,t,n,r),!0;case 5:return u.fn.call(u.context,t,n,r,i),!0;case 6:return u.fn.call(u.context,t,n,r,i,a),!0}for(c=1,l=new Array(f-1);c<f;c++)l[c-1]=arguments[c];u.fn.apply(u.context,l)}else{var p,d=u.length;for(c=0;c<d;c++)switch(u[c].once&&this.removeListener(e,u[c].fn,void 0,!0),f){case 1:u[c].fn.call(u[c].context);break;case 2:u[c].fn.call(u[c].context,t);break;case 3:u[c].fn.call(u[c].context,t,n);break;case 4:u[c].fn.call(u[c].context,t,n,r);break;default:if(!l)for(p=1,l=new Array(f-1);p<f;p++)l[p-1]=arguments[p];u[c].fn.apply(u[c].context,l)}}return!0},c.prototype.on=function(e,t,n){return s(this,e,t,n,!1)},c.prototype.once=function(e,t,n){return s(this,e,t,n,!0)},c.prototype.removeListener=function(e,t,n,r){var i=o?o+e:e;if(!this._events[i])return this;if(!t)return l(this,i),this;var a=this._events[i];if(a.fn)a.fn!==t||r&&!a.once||n&&a.context!==n||l(this,i);else{for(var s=0,c=[],u=a.length;s<u;s++)(a[s].fn!==t||r&&!a[s].once||n&&a[s].context!==n)&&c.push(a[s]);c.length?this._events[i]=1===c.length?c[0]:c:l(this,i)}return this},c.prototype.removeAllListeners=function(e){var t;return e?(t=o?o+e:e,this._events[t]&&l(this,t)):(this._events=new i,this._eventsCount=0),this},c.prototype.off=c.prototype.removeListener,c.prototype.addListener=c.prototype.on,c.prefixed=o,c.EventEmitter=c,e.exports=c},function(e,t,n){var r=n(65),o=n(23),i=n(163);r||o(Object.prototype,"toString",i,{unsafe:!0})},function(e,t,n){var r={};r[n(4)("toStringTag")]="z",e.exports="[object z]"===String(r)},function(e,t,n){var r=n(22),o=n(98);(e.exports=function(e,t){return o[e]||(o[e]=void 0!==t?t:{})})("versions",[]).push({version:"3.5.0",mode:r?"pure":"global",copyright:"© 2019 Denis Pushkarev (zloirock.ru)"})},function(e,t,n){var r=n(3),o=n(20);e.exports=function(e,t){try{o(r,e,t)}catch(n){r[e]=t}return t}},function(e,t,n){var r=n(3),o=n(7),i=r.document,a=o(i)&&o(i.createElement);e.exports=function(e){return a?i.createElement(e):{}}},function(e,t,n){var r=n(9);e.exports=!!Object.getOwnPropertySymbols&&!r((function(){return!String(Symbol())}))},function(e,t,n){var r=n(98),o=Function.toString;"function"!=typeof r.inspectSource&&(r.inspectSource=function(e){return o.call(e)}),e.exports=r.inspectSource},function(e,t){var n=Math.ceil,r=Math.floor;e.exports=function(e){return isNaN(e=+e)?0:(e>0?r:n)(e)}},function(e,t,n){"use strict";var r=n(14),o=n(168),i=n(106),a=n(108),s=n(27),l=n(20),c=n(23),u=n(4),f=n(22),p=n(43),d=n(105),h=d.IteratorPrototype,m=d.BUGGY_SAFARI_ITERATORS,g=u("iterator"),y=function(){return this};e.exports=function(e,t,n,u,d,v,b){o(n,t,u);var w,x,k,E=function(e){if(e===d&&j)return j;if(!m&&e in S)return S[e];switch(e){case"keys":case"values":case"entries":return function(){return new n(this,e)}}return function(){return new n(this)}},O=t+" Iterator",_=!1,S=e.prototype,T=S[g]||S["@@iterator"]||d&&S[d],j=!m&&T||E(d),C="Array"==t&&S.entries||T;if(C&&(w=i(C.call(new e)),h!==Object.prototype&&w.next&&(f||i(w)===h||(a?a(w,h):"function"!=typeof w[g]&&l(w,g,y)),s(w,O,!0,!0),f&&(p[O]=y))),"values"==d&&T&&"values"!==T.name&&(_=!0,j=function(){return T.call(this)}),f&&!b||S[g]===j||l(S,g,j),p[t]=j,d)if(x={values:E("values"),keys:v?j:E("keys"),entries:E("entries")},b)for(k in x)!m&&!_&&k in S||c(S,k,x[k]);else r({target:t,proto:!0,forced:m||_},x);return x}},function(e,t,n){"use strict";var r={}.propertyIsEnumerable,o=Object.getOwnPropertyDescriptor,i=o&&!r.call({1:2},1);t.f=i?function(e){var t=o(this,e);return!!t&&t.enumerable}:r},function(e,t,n){var r=n(9),o=n(25),i="".split;e.exports=r((function(){return!Object("z").propertyIsEnumerable(0)}))?function(e){return"String"==o(e)?i.call(e,""):Object(e)}:Object},function(e,t,n){var r=n(104),o=n(76).concat("length","prototype");t.f=Object.getOwnPropertyNames||function(e){return r(e,o)}},function(e,t){e.exports=["constructor","hasOwnProperty","isPrototypeOf","propertyIsEnumerable","toLocaleString","toString","valueOf"]},function(e,t){t.f=Object.getOwnPropertySymbols},function(e,t,n){var r=n(9),o=/#|\.prototype\./,i=function(e,t){var n=s[a(e)];return n==c||n!=l&&("function"==typeof t?r(t):!!t)},a=i.normalize=function(e){return String(e).replace(o,".").toLowerCase()},s=i.data={},l=i.NATIVE="N",c=i.POLYFILL="P";e.exports=i},function(e,t,n){var r=n(104),o=n(76);e.exports=Object.keys||function(e){return r(e,o)}},function(e,t){e.exports=function(e,t,n){if(!(e instanceof t))throw TypeError("Incorrect "+(n?n+" ":"")+"invocation");return e}},function(e,t,n){"use strict";var r=n(44),o=function(e){var t,n;this.promise=new e((function(e,r){if(void 0!==t||void 0!==n)throw TypeError("Bad Promise constructor");t=e,n=r})),this.resolve=r(t),this.reject=r(n)};e.exports.f=function(e){return new o(e)}},function(e,t,n){var r,o,i=n(3),a=n(118),s=i.process,l=s&&s.versions,c=l&&l.v8;c?o=(r=c.split("."))[0]+r[1]:a&&(!(r=a.match(/Edge\/(\d+)/))||r[1]>=74)&&(r=a.match(/Chrome\/(\d+)/))&&(o=r[1]),e.exports=o&&+o},function(e,t,n){var r=n(25);e.exports=Array.isArray||function(e){return"Array"==r(e)}},function(e,t,n){var r=n(3),o=n(45),i=Function.call;e.exports=function(e,t,n){return o(i,r[e].prototype[t],n)}},function(e,t,n){"use strict";var r=n(36);e.exports=new r({explicit:[n(243),n(244),n(245)]})},function(e,t,n){"use strict";var r=n(36);e.exports=r.DEFAULT=new r({include:[n(58)],explicit:[n(256),n(257),n(258)]})},function(e,t,n){(function(e){var r=n(267),o=n(134),i=n(277),a=n(278),s=n(8),l=t;l.request=function(t,n){t="string"==typeof t?s.parse(t):i(t);var o=-1===e.location.protocol.search(/^https?:$/)?"http:":"",a=t.protocol||o,l=t.hostname||t.host,c=t.port,u=t.path||"/";l&&-1!==l.indexOf(":")&&(l="["+l+"]"),t.url=(l?a+"//"+l:"")+(c?":"+c:"")+u,t.method=(t.method||"GET").toUpperCase(),t.headers=t.headers||{};var f=new r(t);return n&&f.on("response",n),f},l.get=function(e,t){var n=l.request(e,t);return n.end(),n},l.ClientRequest=r,l.IncomingMessage=o.IncomingMessage,l.Agent=function(){},l.Agent.defaultMaxSockets=4,l.globalAgent=new l.Agent,l.STATUS_CODES=a,l.METHODS=["CHECKOUT","CONNECT","COPY","DELETE","GET","HEAD","LOCK","M-SEARCH","MERGE","MKACTIVITY","MKCOL","MOVE","NOTIFY","OPTIONS","PATCH","POST","PROPFIND","PROPPATCH","PURGE","PUT","REPORT","SEARCH","SUBSCRIBE","TRACE","UNLOCK","UNSUBSCRIBE"]}).call(this,n(6))},function(e,t,n){var r=n(11),o=r.Buffer;function i(e,t){for(var n in e)t[n]=e[n]}function a(e,t,n){return o(e,t,n)}o.from&&o.alloc&&o.allocUnsafe&&o.allocUnsafeSlow?e.exports=r:(i(r,t),t.Buffer=a),i(o,a),a.from=function(e,t,n){if("number"==typeof e)throw new TypeError("Argument must not be a number");return o(e,t,n)},a.alloc=function(e,t,n){if("number"!=typeof e)throw new TypeError("Argument must be a number");var r=o(e);return void 0!==t?"string"==typeof n?r.fill(t,n):r.fill(t):r.fill(0),r},a.allocUnsafe=function(e){if("number"!=typeof e)throw new TypeError("Argument must be a number");return o(e)},a.allocUnsafeSlow=function(e){if("number"!=typeof e)throw new TypeError("Argument must be a number");return r.SlowBuffer(e)}},function(e,t,n){"use strict";e.exports=u;var r=n(60),o=n(24),i=n(28),a=/\//g,s=/~/g,l=/~1/g,c=/~0/g;function u(e,t,n){this.$ref=e,this.path=t,this.originalPath=n||t,this.value=void 0,this.circular=!1,this.indirections=0}function f(e,t){if(r.isAllowed$Ref(e.value,t)){var n=o.resolve(e.path,e.value.$ref);if(n!==e.path){var i=e.$ref.$refs._resolve(n,t);return e.indirections+=i.indirections+1,r.isExtended$Ref(e.value)?(e.value=r.dereference(e.value,i.value),!1):(e.$ref=i.$ref,e.path=i.path,e.value=i.value,!0)}e.circular=!0}}function p(e,t,n){if(!e.value||"object"!=typeof e.value)throw i.syntax('Error assigning $ref pointer "%s". \nCannot set "%s" of a non-object.',e.path,t);return"-"===t&&Array.isArray(e.value)?e.value.push(n):e.value[t]=n,n}u.prototype.resolve=function(e,t){var n=u.parse(this.path);this.value=e;for(var r=0;r<n.length;r++){f(this,t)&&(this.path=u.join(this.path,n.slice(r)));var o=n[r];if(void 0===this.value[o])throw i.syntax('Error resolving $ref pointer "%s". \nToken "%s" does not exist.',this.originalPath,o);this.value=this.value[o]}return f(this,t),this},u.prototype.set=function(e,t,n){var r,o=u.parse(this.path);if(0===o.length)return this.value=t,t;this.value=e;for(var i=0;i<o.length-1;i++)f(this,n),r=o[i],this.value&&void 0!==this.value[r]?this.value=this.value[r]:this.value=p(this,r,{});return f(this,n),p(this,r=o[o.length-1],t),e},u.parse=function(e){var t=o.getHash(e).substr(1);if(!t)return[];t=t.split("/");for(var n=0;n<t.length;n++)t[n]=decodeURIComponent(t[n].replace(l,"/").replace(c,"~"));if(""!==t[0])throw i.syntax('Invalid $ref pointer "%s". Pointers must begin with "#/"',t);return t.slice(1)},u.join=function(e,t){-1===e.indexOf("#")&&(e+="#"),t=Array.isArray(t)?t:[t];for(var n=0;n<t.length;n++){var r=t[n];e+="/"+encodeURIComponent(r.replace(s,"~0").replace(a,"~1"))}return e}},function(e,t,n){"use strict";e.exports={isRef:function(e,t){return"$ref"===t&&!!e&&"string"==typeof e[t]}}},function(e,t,n){"use strict";var r=n(61).jpescape;e.exports={recurse:function e(t,n,o){if(n||(n={depth:0}),n.depth||(n=Object.assign({},{path:"#",depth:0,pkey:"",parent:{},payload:{},seen:new WeakMap,identity:!1,identityDetection:!1},n)),"object"==typeof t){var i=n.path;for(var a in t){if(n.key=a,n.path=n.path+"/"+encodeURIComponent(r(a)),n.identityPath=n.seen.get(t[a]),n.identity=void 0!==n.identityPath,o(t,a,n),"object"==typeof t[a]&&!n.identity){n.identityDetection&&!Array.isArray(t[a])&&null!==t[a]&&n.seen.set(t[a],n.path);var s={};s.parent=t,s.path=n.path,s.depth=n.depth?n.depth+1:1,s.pkey=a,s.payload=n.payload,s.seen=n.seen,s.identity=!1,s.identityDetection=n.identityDetection,e(t[a],s,o)}n.path=i}}}}},function(e,t,n){e.exports=function e(t){"use strict";var n=/^\0+/g,r=/[\0\r\f]/g,o=/: */g,i=/zoo|gra/,a=/([,: ])(transform)/g,s=/,+\s*(?![^(]*[)])/g,l=/ +\s*(?![^(]*[)])/g,c=/ *[\0] */g,u=/,\r+?/g,f=/([\t\r\n ])*\f?&/g,p=/:global\(((?:[^\(\)\[\]]*|\[.*\]|\([^\(\)]*\))*)\)/g,d=/\W+/g,h=/@(k\w+)\s*(\S*)\s*/,m=/::(place)/g,g=/:(read-only)/g,y=/\s+(?=[{\];=:>])/g,v=/([[}=:>])\s+/g,b=/(\{[^{]+?);(?=\})/g,w=/\s{2,}/g,x=/([^\(])(:+) */g,k=/[svh]\w+-[tblr]{2}/,E=/\(\s*(.*)\s*\)/g,O=/([\s\S]*?);/g,_=/-self|flex-/g,S=/[^]*?(:[rp][el]a[\w-]+)[^]*/,T=/stretch|:\s*\w+\-(?:conte|avail)/,j=/([^-])(image-set\()/,C="-webkit-",I="-moz-",A="-ms-",P=59,R=125,N=123,L=40,M=41,D=91,F=93,U=10,z=13,B=9,$=64,q=32,W=38,H=45,V=95,Y=42,G=44,Q=58,X=39,K=34,J=47,Z=62,ee=43,te=126,ne=0,re=12,oe=11,ie=107,ae=109,se=115,le=112,ce=111,ue=105,fe=99,pe=100,de=112,he=1,me=1,ge=0,ye=1,ve=1,be=1,we=0,xe=0,ke=0,Ee=[],Oe=[],_e=0,Se=null,Te=-2,je=-1,Ce=0,Ie=1,Ae=2,Pe=3,Re=0,Ne=1,Le="",Me="",De="";function Fe(e,t,o,i,a){for(var s,l,u=0,f=0,p=0,d=0,y=0,v=0,b=0,w=0,k=0,O=0,_=0,S=0,T=0,j=0,V=0,we=0,Oe=0,Se=0,Te=0,je=o.length,ze=je-1,Ve="",Ye="",Ge="",Qe="",Xe="",Ke="";V<je;){if(b=o.charCodeAt(V),V===ze&&f+d+p+u!==0&&(0!==f&&(b=f===J?U:J),d=p=u=0,je++,ze++),f+d+p+u===0){if(V===ze&&(we>0&&(Ye=Ye.replace(r,"")),Ye.trim().length>0)){switch(b){case q:case B:case P:case z:case U:break;default:Ye+=o.charAt(V)}b=P}if(1===Oe)switch(b){case N:case R:case P:case K:case X:case L:case M:case G:Oe=0;case B:case z:case U:case q:break;default:for(Oe=0,Te=V,y=b,V--,b=P;Te<je;)switch(o.charCodeAt(Te++)){case U:case z:case P:++V,b=y,Te=je;break;case Q:we>0&&(++V,b=y);case N:Te=je}}switch(b){case N:for(y=(Ye=Ye.trim()).charCodeAt(0),_=1,Te=++V;V<je;){switch(b=o.charCodeAt(V)){case N:_++;break;case R:_--;break;case J:switch(v=o.charCodeAt(V+1)){case Y:case J:V=He(v,V,ze,o)}break;case D:b++;case L:b++;case K:case X:for(;V++<ze&&o.charCodeAt(V)!==b;);}if(0===_)break;V++}switch(Ge=o.substring(Te,V),y===ne&&(y=(Ye=Ye.replace(n,"").trim()).charCodeAt(0)),y){case $:switch(we>0&&(Ye=Ye.replace(r,"")),v=Ye.charCodeAt(1)){case pe:case ae:case se:case H:s=t;break;default:s=Ee}if(Te=(Ge=Fe(t,s,Ge,v,a+1)).length,ke>0&&0===Te&&(Te=Ye.length),_e>0&&(s=Ue(Ee,Ye,Se),l=We(Pe,Ge,s,t,me,he,Te,v,a,i),Ye=s.join(""),void 0!==l&&0===(Te=(Ge=l.trim()).length)&&(v=0,Ge="")),Te>0)switch(v){case se:Ye=Ye.replace(E,qe);case pe:case ae:case H:Ge=Ye+"{"+Ge+"}";break;case ie:Ge=(Ye=Ye.replace(h,"$1 $2"+(Ne>0?Le:"")))+"{"+Ge+"}",Ge=1===ve||2===ve&&$e("@"+Ge,3)?"@"+C+Ge+"@"+Ge:"@"+Ge;break;default:Ge=Ye+Ge,i===de&&(Qe+=Ge,Ge="")}else Ge="";break;default:Ge=Fe(t,Ue(t,Ye,Se),Ge,i,a+1)}Xe+=Ge,S=0,Oe=0,j=0,we=0,Se=0,T=0,Ye="",Ge="",b=o.charCodeAt(++V);break;case R:case P:if((Te=(Ye=(we>0?Ye.replace(r,""):Ye).trim()).length)>1)switch(0===j&&((y=Ye.charCodeAt(0))===H||y>96&&y<123)&&(Te=(Ye=Ye.replace(" ",":")).length),_e>0&&void 0!==(l=We(Ie,Ye,t,e,me,he,Qe.length,i,a,i))&&0===(Te=(Ye=l.trim()).length)&&(Ye="\0\0"),y=Ye.charCodeAt(0),v=Ye.charCodeAt(1),y){case ne:break;case $:if(v===ue||v===fe){Ke+=Ye+o.charAt(V);break}default:if(Ye.charCodeAt(Te-1)===Q)break;Qe+=Be(Ye,y,v,Ye.charCodeAt(2))}S=0,Oe=0,j=0,we=0,Se=0,Ye="",b=o.charCodeAt(++V)}}switch(b){case z:case U:if(f+d+p+u+xe===0)switch(O){case M:case X:case K:case $:case te:case Z:case Y:case ee:case J:case H:case Q:case G:case P:case N:case R:break;default:j>0&&(Oe=1)}f===J?f=0:ye+S===0&&i!==ie&&Ye.length>0&&(we=1,Ye+="\0"),_e*Re>0&&We(Ce,Ye,t,e,me,he,Qe.length,i,a,i),he=1,me++;break;case P:case R:if(f+d+p+u===0){he++;break}default:switch(he++,Ve=o.charAt(V),b){case B:case q:if(d+u+f===0)switch(w){case G:case Q:case B:case q:Ve="";break;default:b!==q&&(Ve=" ")}break;case ne:Ve="\\0";break;case re:Ve="\\f";break;case oe:Ve="\\v";break;case W:d+f+u===0&&ye>0&&(Se=1,we=1,Ve="\f"+Ve);break;case 108:if(d+f+u+ge===0&&j>0)switch(V-j){case 2:w===le&&o.charCodeAt(V-3)===Q&&(ge=w);case 8:k===ce&&(ge=k)}break;case Q:d+f+u===0&&(j=V);break;case G:f+p+d+u===0&&(we=1,Ve+="\r");break;case K:case X:0===f&&(d=d===b?0:0===d?b:d);break;case D:d+f+p===0&&u++;break;case F:d+f+p===0&&u--;break;case M:d+f+u===0&&p--;break;case L:if(d+f+u===0){if(0===S)switch(2*w+3*k){case 533:break;default:_=0,S=1}p++}break;case $:f+p+d+u+j+T===0&&(T=1);break;case Y:case J:if(d+u+p>0)break;switch(f){case 0:switch(2*b+3*o.charCodeAt(V+1)){case 235:f=J;break;case 220:Te=V,f=Y}break;case Y:b===J&&w===Y&&Te+2!==V&&(33===o.charCodeAt(Te+2)&&(Qe+=o.substring(Te,V+1)),Ve="",f=0)}}if(0===f){if(ye+d+u+T===0&&i!==ie&&b!==P)switch(b){case G:case te:case Z:case ee:case M:case L:if(0===S){switch(w){case B:case q:case U:case z:Ve+="\0";break;default:Ve="\0"+Ve+(b===G?"":"\0")}we=1}else switch(b){case L:j+7===V&&108===w&&(j=0),S=++_;break;case M:0==(S=--_)&&(we=1,Ve+="\0")}break;case B:case q:switch(w){case ne:case N:case R:case P:case G:case re:case B:case q:case U:case z:break;default:0===S&&(we=1,Ve+="\0")}}Ye+=Ve,b!==q&&b!==B&&(O=b)}}k=w,w=b,V++}if(Te=Qe.length,ke>0&&0===Te&&0===Xe.length&&0===t[0].length==0&&(i!==ae||1===t.length&&(ye>0?Me:De)===t[0])&&(Te=t.join(",").length+2),Te>0){if(s=0===ye&&i!==ie?function(e){for(var t,n,o=0,i=e.length,a=Array(i);o<i;++o){for(var s=e[o].split(c),l="",u=0,f=0,p=0,d=0,h=s.length;u<h;++u)if(!(0===(f=(n=s[u]).length)&&h>1)){if(p=l.charCodeAt(l.length-1),d=n.charCodeAt(0),t="",0!==u)switch(p){case Y:case te:case Z:case ee:case q:case L:break;default:t=" "}switch(d){case W:n=t+Me;case te:case Z:case ee:case q:case M:case L:break;case D:n=t+n+Me;break;case Q:switch(2*n.charCodeAt(1)+3*n.charCodeAt(2)){case 530:if(be>0){n=t+n.substring(8,f-1);break}default:(u<1||s[u-1].length<1)&&(n=t+Me+n)}break;case G:t="";default:n=f>1&&n.indexOf(":")>0?t+n.replace(x,"$1"+Me+"$2"):t+n+Me}l+=n}a[o]=l.replace(r,"").trim()}return a}(t):t,_e>0&&void 0!==(l=We(Ae,Qe,s,e,me,he,Te,i,a,i))&&0===(Qe=l).length)return Ke+Qe+Xe;if(Qe=s.join(",")+"{"+Qe+"}",ve*ge!=0){switch(2!==ve||$e(Qe,2)||(ge=0),ge){case ce:Qe=Qe.replace(g,":"+I+"$1")+Qe;break;case le:Qe=Qe.replace(m,"::"+C+"input-$1")+Qe.replace(m,"::"+I+"$1")+Qe.replace(m,":"+A+"input-$1")+Qe}ge=0}}return Ke+Qe+Xe}function Ue(e,t,n){var r=t.trim().split(u),o=r,i=r.length,a=e.length;switch(a){case 0:case 1:for(var s=0,l=0===a?"":e[0]+" ";s<i;++s)o[s]=ze(l,o[s],n,a).trim();break;default:s=0;var c=0;for(o=[];s<i;++s)for(var f=0;f<a;++f)o[c++]=ze(e[f]+" ",r[s],n,a).trim()}return o}function ze(e,t,n,r){var o=t,i=o.charCodeAt(0);switch(i<33&&(i=(o=o.trim()).charCodeAt(0)),i){case W:switch(ye+r){case 0:case 1:if(0===e.trim().length)break;default:return o.replace(f,"$1"+e.trim())}break;case Q:switch(o.charCodeAt(1)){case 103:if(be>0&&ye>0)return o.replace(p,"$1").replace(f,"$1"+De);break;default:return e.trim()+o.replace(f,"$1"+e.trim())}default:if(n*ye>0&&o.indexOf("\f")>0)return o.replace(f,(e.charCodeAt(0)===Q?"":"$1")+e.trim())}return e+o}function Be(e,t,n,r){var c,u=0,f=e+";",p=2*t+3*n+4*r;if(944===p)return function(e){var t=e.length,n=e.indexOf(":",9)+1,r=e.substring(0,n).trim(),o=e.substring(n,t-1).trim();switch(e.charCodeAt(9)*Ne){case 0:break;case H:if(110!==e.charCodeAt(10))break;default:var i=o.split((o="",s)),a=0;for(n=0,t=i.length;a<t;n=0,++a){for(var c=i[a],u=c.split(l);c=u[n];){var f=c.charCodeAt(0);if(1===Ne&&(f>$&&f<90||f>96&&f<123||f===V||f===H&&c.charCodeAt(1)!==H))switch(isNaN(parseFloat(c))+(-1!==c.indexOf("("))){case 1:switch(c){case"infinite":case"alternate":case"backwards":case"running":case"normal":case"forwards":case"both":case"none":case"linear":case"ease":case"ease-in":case"ease-out":case"ease-in-out":case"paused":case"reverse":case"alternate-reverse":case"inherit":case"initial":case"unset":case"step-start":case"step-end":break;default:c+=Le}}u[n++]=c}o+=(0===a?"":",")+u.join(" ")}}return o=r+o+";",1===ve||2===ve&&$e(o,1)?C+o+o:o}(f);if(0===ve||2===ve&&!$e(f,1))return f;switch(p){case 1015:return 97===f.charCodeAt(10)?C+f+f:f;case 951:return 116===f.charCodeAt(3)?C+f+f:f;case 963:return 110===f.charCodeAt(5)?C+f+f:f;case 1009:if(100!==f.charCodeAt(4))break;case 969:case 942:return C+f+f;case 978:return C+f+I+f+f;case 1019:case 983:return C+f+I+f+A+f+f;case 883:return f.charCodeAt(8)===H?C+f+f:f.indexOf("image-set(",11)>0?f.replace(j,"$1"+C+"$2")+f:f;case 932:if(f.charCodeAt(4)===H)switch(f.charCodeAt(5)){case 103:return C+"box-"+f.replace("-grow","")+C+f+A+f.replace("grow","positive")+f;case 115:return C+f+A+f.replace("shrink","negative")+f;case 98:return C+f+A+f.replace("basis","preferred-size")+f}return C+f+A+f+f;case 964:return C+f+A+"flex-"+f+f;case 1023:if(99!==f.charCodeAt(8))break;return c=f.substring(f.indexOf(":",15)).replace("flex-","").replace("space-between","justify"),C+"box-pack"+c+C+f+A+"flex-pack"+c+f;case 1005:return i.test(f)?f.replace(o,":"+C)+f.replace(o,":"+I)+f:f;case 1e3:switch(u=(c=f.substring(13).trim()).indexOf("-")+1,c.charCodeAt(0)+c.charCodeAt(u)){case 226:c=f.replace(k,"tb");break;case 232:c=f.replace(k,"tb-rl");break;case 220:c=f.replace(k,"lr");break;default:return f}return C+f+A+c+f;case 1017:if(-1===f.indexOf("sticky",9))return f;case 975:switch(u=(f=e).length-10,p=(c=(33===f.charCodeAt(u)?f.substring(0,u):f).substring(e.indexOf(":",7)+1).trim()).charCodeAt(0)+(0|c.charCodeAt(7))){case 203:if(c.charCodeAt(8)<111)break;case 115:f=f.replace(c,C+c)+";"+f;break;case 207:case 102:f=f.replace(c,C+(p>102?"inline-":"")+"box")+";"+f.replace(c,C+c)+";"+f.replace(c,A+c+"box")+";"+f}return f+";";case 938:if(f.charCodeAt(5)===H)switch(f.charCodeAt(6)){case 105:return c=f.replace("-items",""),C+f+C+"box-"+c+A+"flex-"+c+f;case 115:return C+f+A+"flex-item-"+f.replace(_,"")+f;default:return C+f+A+"flex-line-pack"+f.replace("align-content","").replace(_,"")+f}break;case 973:case 989:if(f.charCodeAt(3)!==H||122===f.charCodeAt(4))break;case 931:case 953:if(!0===T.test(e))return 115===(c=e.substring(e.indexOf(":")+1)).charCodeAt(0)?Be(e.replace("stretch","fill-available"),t,n,r).replace(":fill-available",":stretch"):f.replace(c,C+c)+f.replace(c,I+c.replace("fill-",""))+f;break;case 962:if(f=C+f+(102===f.charCodeAt(5)?A+f:"")+f,n+r===211&&105===f.charCodeAt(13)&&f.indexOf("transform",10)>0)return f.substring(0,f.indexOf(";",27)+1).replace(a,"$1"+C+"$2")+f}return f}function $e(e,t){var n=e.indexOf(1===t?":":"{"),r=e.substring(0,3!==t?n:10),o=e.substring(n+1,e.length-1);return Se(2!==t?r:r.replace(S,"$1"),o,t)}function qe(e,t){var n=Be(t,t.charCodeAt(0),t.charCodeAt(1),t.charCodeAt(2));return n!==t+";"?n.replace(O," or ($1)").substring(4):"("+t+")"}function We(e,t,n,r,o,i,a,s,l,c){for(var u,f=0,p=t;f<_e;++f)switch(u=Oe[f].call(Ye,e,p,n,r,o,i,a,s,l,c)){case void 0:case!1:case!0:case null:break;default:p=u}if(p!==t)return p}function He(e,t,n,r){for(var o=t+1;o<n;++o)switch(r.charCodeAt(o)){case J:if(e===Y&&r.charCodeAt(o-1)===Y&&t+2!==o)return o+1;break;case U:if(e===J)return o+1}return o}function Ve(e){for(var t in e){var n=e[t];switch(t){case"keyframe":Ne=0|n;break;case"global":be=0|n;break;case"cascade":ye=0|n;break;case"compress":we=0|n;break;case"semicolon":xe=0|n;break;case"preserve":ke=0|n;break;case"prefix":Se=null,n?"function"!=typeof n?ve=1:(ve=2,Se=n):ve=0}}return Ve}function Ye(t,n){if(void 0!==this&&this.constructor===Ye)return e(t);var o=t,i=o.charCodeAt(0);i<33&&(i=(o=o.trim()).charCodeAt(0)),Ne>0&&(Le=o.replace(d,i===D?"":"-")),i=1,1===ye?De=o:Me=o;var a,s=[De];_e>0&&void 0!==(a=We(je,n,s,s,me,he,0,0,0,0))&&"string"==typeof a&&(n=a);var l=Fe(Ee,s,n,0,0);return _e>0&&void 0!==(a=We(Te,l,s,s,me,he,l.length,0,0,0))&&"string"!=typeof(l=a)&&(i=0),Le="",De="",Me="",ge=0,me=1,he=1,we*i==0?l:l.replace(r,"").replace(y,"").replace(v,"$1").replace(b,"$1").replace(w," ")}return Ye.use=function e(t){switch(t){case void 0:case null:_e=Oe.length=0;break;default:if("function"==typeof t)Oe[_e++]=t;else if("object"==typeof t)for(var n=0,r=t.length;n<r;++n)e(t[n]);else Re=0|!!t}return e},Ye.set=Ve,void 0!==t&&Ve(t),Ye}(null)},function(e,t,n){"use strict";e.exports=n(234)},function(e,t,n){"use strict";function r(e,t){if(e.length!==t.length)return!1;for(var n=0;n<e.length;n++)if(e[n]!==t[n])return!1;return!0}t.a=function(e,t){var n;void 0===t&&(t=r);var o,i=[],a=!1;return function(){for(var r=[],s=0;s<arguments.length;s++)r[s]=arguments[s];return a&&n===this&&t(r,i)?o:(o=e.apply(this,r),a=!0,n=this,i=r,o)}}},function(e,t,n){
|
||
/*!***************************************************
|
||
* mark.js v8.11.1
|
||
* https://markjs.io/
|
||
* Copyright (c) 2014–2018, Julian Kühnel
|
||
* Released under the MIT license https://git.io/vwTVl
|
||
*****************************************************/
|
||
e.exports=function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(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)}}return function(t,n,r){return n&&e(t.prototype,n),r&&e(t,r),t}}(),r=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e},o=function(){function e(n){var r=!(arguments.length>1&&void 0!==arguments[1])||arguments[1],o=arguments.length>2&&void 0!==arguments[2]?arguments[2]:[],i=arguments.length>3&&void 0!==arguments[3]?arguments[3]:5e3;t(this,e),this.ctx=n,this.iframes=r,this.exclude=o,this.iframesTimeout=i}return n(e,[{key:"getContexts",value:function(){var e=[];return(void 0!==this.ctx&&this.ctx?NodeList.prototype.isPrototypeOf(this.ctx)?Array.prototype.slice.call(this.ctx):Array.isArray(this.ctx)?this.ctx:"string"==typeof this.ctx?Array.prototype.slice.call(document.querySelectorAll(this.ctx)):[this.ctx]:[]).forEach((function(t){var n=e.filter((function(e){return e.contains(t)})).length>0;-1!==e.indexOf(t)||n||e.push(t)})),e}},{key:"getIframeContents",value:function(e,t){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:function(){},r=void 0;try{var o=e.contentWindow;if(r=o.document,!o||!r)throw new Error("iframe inaccessible")}catch(e){n()}r&&t(r)}},{key:"isIframeBlank",value:function(e){var t="about:blank",n=e.getAttribute("src").trim();return e.contentWindow.location.href===t&&n!==t&&n}},{key:"observeIframeLoad",value:function(e,t,n){var r=this,o=!1,i=null,a=function a(){if(!o){o=!0,clearTimeout(i);try{r.isIframeBlank(e)||(e.removeEventListener("load",a),r.getIframeContents(e,t,n))}catch(e){n()}}};e.addEventListener("load",a),i=setTimeout(a,this.iframesTimeout)}},{key:"onIframeReady",value:function(e,t,n){try{"complete"===e.contentWindow.document.readyState?this.isIframeBlank(e)?this.observeIframeLoad(e,t,n):this.getIframeContents(e,t,n):this.observeIframeLoad(e,t,n)}catch(e){n()}}},{key:"waitForIframes",value:function(e,t){var n=this,r=0;this.forEachIframe(e,(function(){return!0}),(function(e){r++,n.waitForIframes(e.querySelector("html"),(function(){--r||t()}))}),(function(e){e||t()}))}},{key:"forEachIframe",value:function(t,n,r){var o=this,i=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},a=t.querySelectorAll("iframe"),s=a.length,l=0;a=Array.prototype.slice.call(a);var c=function(){--s<=0&&i(l)};s||c(),a.forEach((function(t){e.matches(t,o.exclude)?c():o.onIframeReady(t,(function(e){n(t)&&(l++,r(e)),c()}),c)}))}},{key:"createIterator",value:function(e,t,n){return document.createNodeIterator(e,t,n,!1)}},{key:"createInstanceOnIframe",value:function(t){return new e(t.querySelector("html"),this.iframes)}},{key:"compareNodeIframe",value:function(e,t,n){if(e.compareDocumentPosition(n)&Node.DOCUMENT_POSITION_PRECEDING){if(null===t)return!0;if(t.compareDocumentPosition(n)&Node.DOCUMENT_POSITION_FOLLOWING)return!0}return!1}},{key:"getIteratorNode",value:function(e){var t=e.previousNode();return{prevNode:t,node:null===t?e.nextNode():e.nextNode()&&e.nextNode()}}},{key:"checkIframeFilter",value:function(e,t,n,r){var o=!1,i=!1;return r.forEach((function(e,t){e.val===n&&(o=t,i=e.handled)})),this.compareNodeIframe(e,t,n)?(!1!==o||i?!1===o||i||(r[o].handled=!0):r.push({val:n,handled:!0}),!0):(!1===o&&r.push({val:n,handled:!1}),!1)}},{key:"handleOpenIframes",value:function(e,t,n,r){var o=this;e.forEach((function(e){e.handled||o.getIframeContents(e.val,(function(e){o.createInstanceOnIframe(e).forEachNode(t,n,r)}))}))}},{key:"iterateThroughNodes",value:function(e,t,n,r,o){for(var i,a=this,s=this.createIterator(t,e,r),l=[],c=[],u=void 0,f=void 0;i=void 0,i=a.getIteratorNode(s),f=i.prevNode,u=i.node;)this.iframes&&this.forEachIframe(t,(function(e){return a.checkIframeFilter(u,f,e,l)}),(function(t){a.createInstanceOnIframe(t).forEachNode(e,(function(e){return c.push(e)}),r)})),c.push(u);c.forEach((function(e){n(e)})),this.iframes&&this.handleOpenIframes(l,e,n,r),o()}},{key:"forEachNode",value:function(e,t,n){var r=this,o=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},i=this.getContexts(),a=i.length;a||o(),i.forEach((function(i){var s=function(){r.iterateThroughNodes(e,i,t,n,(function(){--a<=0&&o()}))};r.iframes?r.waitForIframes(i,s):s()}))}}],[{key:"matches",value:function(e,t){var n="string"==typeof t?[t]:t,r=e.matches||e.matchesSelector||e.msMatchesSelector||e.mozMatchesSelector||e.oMatchesSelector||e.webkitMatchesSelector;if(r){var o=!1;return n.every((function(t){return!r.call(e,t)||(o=!0,!1)})),o}return!1}}]),e}(),i=function(){function i(e){t(this,i),this.ctx=e,this.ie=!1;var n=window.navigator.userAgent;(n.indexOf("MSIE")>-1||n.indexOf("Trident")>-1)&&(this.ie=!0)}return n(i,[{key:"log",value:function(t){var n=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"debug",r=this.opt.log;this.opt.debug&&"object"===(void 0===r?"undefined":e(r))&&"function"==typeof r[n]&&r[n]("mark.js: "+t)}},{key:"escapeStr",value:function(e){return e.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g,"\\$&")}},{key:"createRegExp",value:function(e){return"disabled"!==this.opt.wildcards&&(e=this.setupWildcardsRegExp(e)),e=this.escapeStr(e),Object.keys(this.opt.synonyms).length&&(e=this.createSynonymsRegExp(e)),(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.setupIgnoreJoinersRegExp(e)),this.opt.diacritics&&(e=this.createDiacriticsRegExp(e)),e=this.createMergedBlanksRegExp(e),(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.createJoinersRegExp(e)),"disabled"!==this.opt.wildcards&&(e=this.createWildcardsRegExp(e)),e=this.createAccuracyRegExp(e)}},{key:"createSynonymsRegExp",value:function(e){var t=this.opt.synonyms,n=this.opt.caseSensitive?"":"i",r=this.opt.ignoreJoiners||this.opt.ignorePunctuation.length?"\0":"";for(var o in t)if(t.hasOwnProperty(o)){var i=t[o],a="disabled"!==this.opt.wildcards?this.setupWildcardsRegExp(o):this.escapeStr(o),s="disabled"!==this.opt.wildcards?this.setupWildcardsRegExp(i):this.escapeStr(i);""!==a&&""!==s&&(e=e.replace(new RegExp("("+this.escapeStr(a)+"|"+this.escapeStr(s)+")","gm"+n),r+"("+this.processSynomyms(a)+"|"+this.processSynomyms(s)+")"+r))}return e}},{key:"processSynomyms",value:function(e){return(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.setupIgnoreJoinersRegExp(e)),e}},{key:"setupWildcardsRegExp",value:function(e){return(e=e.replace(/(?:\\)*\?/g,(function(e){return"\\"===e.charAt(0)?"?":""}))).replace(/(?:\\)*\*/g,(function(e){return"\\"===e.charAt(0)?"*":""}))}},{key:"createWildcardsRegExp",value:function(e){var t="withSpaces"===this.opt.wildcards;return e.replace(/\u0001/g,t?"[\\S\\s]?":"\\S?").replace(/\u0002/g,t?"[\\S\\s]*?":"\\S*")}},{key:"setupIgnoreJoinersRegExp",value:function(e){return e.replace(/[^(|)\\]/g,(function(e,t,n){var r=n.charAt(t+1);return/[(|)\\]/.test(r)||""===r?e:e+"\0"}))}},{key:"createJoinersRegExp",value:function(e){var t=[],n=this.opt.ignorePunctuation;return Array.isArray(n)&&n.length&&t.push(this.escapeStr(n.join(""))),this.opt.ignoreJoiners&&t.push("\\u00ad\\u200b\\u200c\\u200d"),t.length?e.split(/\u0000+/).join("["+t.join("")+"]*"):e}},{key:"createDiacriticsRegExp",value:function(e){var t=this.opt.caseSensitive?"":"i",n=this.opt.caseSensitive?["aàáảãạăằắẳẵặâầấẩẫậäåāą","AÀÁẢÃẠĂẰẮẲẴẶÂẦẤẨẪẬÄÅĀĄ","cçćč","CÇĆČ","dđď","DĐĎ","eèéẻẽẹêềếểễệëěēę","EÈÉẺẼẸÊỀẾỂỄỆËĚĒĘ","iìíỉĩịîïī","IÌÍỈĨỊÎÏĪ","lł","LŁ","nñňń","NÑŇŃ","oòóỏõọôồốổỗộơởỡớờợöøō","OÒÓỎÕỌÔỒỐỔỖỘƠỞỠỚỜỢÖØŌ","rř","RŘ","sšśșş","SŠŚȘŞ","tťțţ","TŤȚŢ","uùúủũụưừứửữựûüůū","UÙÚỦŨỤƯỪỨỬỮỰÛÜŮŪ","yýỳỷỹỵÿ","YÝỲỶỸỴŸ","zžżź","ZŽŻŹ"]:["aàáảãạăằắẳẵặâầấẩẫậäåāąAÀÁẢÃẠĂẰẮẲẴẶÂẦẤẨẪẬÄÅĀĄ","cçćčCÇĆČ","dđďDĐĎ","eèéẻẽẹêềếểễệëěēęEÈÉẺẼẸÊỀẾỂỄỆËĚĒĘ","iìíỉĩịîïīIÌÍỈĨỊÎÏĪ","lłLŁ","nñňńNÑŇŃ","oòóỏõọôồốổỗộơởỡớờợöøōOÒÓỎÕỌÔỒỐỔỖỘƠỞỠỚỜỢÖØŌ","rřRŘ","sšśșşSŠŚȘŞ","tťțţTŤȚŢ","uùúủũụưừứửữựûüůūUÙÚỦŨỤƯỪỨỬỮỰÛÜŮŪ","yýỳỷỹỵÿYÝỲỶỸỴŸ","zžżźZŽŻŹ"],r=[];return e.split("").forEach((function(o){n.every((function(n){if(-1!==n.indexOf(o)){if(r.indexOf(n)>-1)return!1;e=e.replace(new RegExp("["+n+"]","gm"+t),"["+n+"]"),r.push(n)}return!0}))})),e}},{key:"createMergedBlanksRegExp",value:function(e){return e.replace(/[\s]+/gim,"[\\s]+")}},{key:"createAccuracyRegExp",value:function(e){var t=this,n=this.opt.accuracy,r="string"==typeof n?n:n.value,o="string"==typeof n?[]:n.limiters,i="";switch(o.forEach((function(e){i+="|"+t.escapeStr(e)})),r){case"partially":default:return"()("+e+")";case"complementary":return"()([^"+(i="\\s"+(i||this.escapeStr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~¡¿")))+"]*"+e+"[^"+i+"]*)";case"exactly":return"(^|\\s"+i+")("+e+")(?=$|\\s"+i+")"}}},{key:"getSeparatedKeywords",value:function(e){var t=this,n=[];return e.forEach((function(e){t.opt.separateWordSearch?e.split(" ").forEach((function(e){e.trim()&&-1===n.indexOf(e)&&n.push(e)})):e.trim()&&-1===n.indexOf(e)&&n.push(e)})),{keywords:n.sort((function(e,t){return t.length-e.length})),length:n.length}}},{key:"isNumeric",value:function(e){return Number(parseFloat(e))==e}},{key:"checkRanges",value:function(e){var t=this;if(!Array.isArray(e)||"[object Object]"!==Object.prototype.toString.call(e[0]))return this.log("markRanges() will only accept an array of objects"),this.opt.noMatch(e),[];var n=[],r=0;return e.sort((function(e,t){return e.start-t.start})).forEach((function(e){var o=t.callNoMatchOnInvalidRanges(e,r),i=o.start,a=o.end;o.valid&&(e.start=i,e.length=a-i,n.push(e),r=a)})),n}},{key:"callNoMatchOnInvalidRanges",value:function(e,t){var n=void 0,r=void 0,o=!1;return e&&void 0!==e.start?(r=(n=parseInt(e.start,10))+parseInt(e.length,10),this.isNumeric(e.start)&&this.isNumeric(e.length)&&r-t>0&&r-n>0?o=!0:(this.log("Ignoring invalid or overlapping range: "+JSON.stringify(e)),this.opt.noMatch(e))):(this.log("Ignoring invalid range: "+JSON.stringify(e)),this.opt.noMatch(e)),{start:n,end:r,valid:o}}},{key:"checkWhitespaceRanges",value:function(e,t,n){var r=void 0,o=!0,i=n.length,a=t-i,s=parseInt(e.start,10)-a;return(r=(s=s>i?i:s)+parseInt(e.length,10))>i&&(r=i,this.log("End range automatically set to the max value of "+i)),s<0||r-s<0||s>i||r>i?(o=!1,this.log("Invalid range: "+JSON.stringify(e)),this.opt.noMatch(e)):""===n.substring(s,r).replace(/\s+/g,"")&&(o=!1,this.log("Skipping whitespace only range: "+JSON.stringify(e)),this.opt.noMatch(e)),{start:s,end:r,valid:o}}},{key:"getTextNodes",value:function(e){var t=this,n="",r=[];this.iterator.forEachNode(NodeFilter.SHOW_TEXT,(function(e){r.push({start:n.length,end:(n+=e.textContent).length,node:e})}),(function(e){return t.matchesExclude(e.parentNode)?NodeFilter.FILTER_REJECT:NodeFilter.FILTER_ACCEPT}),(function(){e({value:n,nodes:r})}))}},{key:"matchesExclude",value:function(e){return o.matches(e,this.opt.exclude.concat(["script","style","title","head","html"]))}},{key:"wrapRangeInTextNode",value:function(e,t,n){var r=this.opt.element?this.opt.element:"mark",o=e.splitText(t),i=o.splitText(n-t),a=document.createElement(r);return a.setAttribute("data-markjs","true"),this.opt.className&&a.setAttribute("class",this.opt.className),a.textContent=o.textContent,o.parentNode.replaceChild(a,o),i}},{key:"wrapRangeInMappedTextNode",value:function(e,t,n,r,o){var i=this;e.nodes.every((function(a,s){var l=e.nodes[s+1];if(void 0===l||l.start>t){if(!r(a.node))return!1;var c=t-a.start,u=(n>a.end?a.end:n)-a.start,f=e.value.substr(0,a.start),p=e.value.substr(u+a.start);if(a.node=i.wrapRangeInTextNode(a.node,c,u),e.value=f+p,e.nodes.forEach((function(t,n){n>=s&&(e.nodes[n].start>0&&n!==s&&(e.nodes[n].start-=u),e.nodes[n].end-=u)})),n-=u,o(a.node.previousSibling,a.start),!(n>a.end))return!1;t=a.end}return!0}))}},{key:"wrapMatches",value:function(e,t,n,r,o){var i=this,a=0===t?0:t+1;this.getTextNodes((function(t){t.nodes.forEach((function(t){t=t.node;for(var o=void 0;null!==(o=e.exec(t.textContent))&&""!==o[a];)if(n(o[a],t)){var s=o.index;if(0!==a)for(var l=1;l<a;l++)s+=o[l].length;t=i.wrapRangeInTextNode(t,s,s+o[a].length),r(t.previousSibling),e.lastIndex=0}})),o()}))}},{key:"wrapMatchesAcrossElements",value:function(e,t,n,r,o){var i=this,a=0===t?0:t+1;this.getTextNodes((function(t){for(var s=void 0;null!==(s=e.exec(t.value))&&""!==s[a];){var l=s.index;if(0!==a)for(var c=1;c<a;c++)l+=s[c].length;var u=l+s[a].length;i.wrapRangeInMappedTextNode(t,l,u,(function(e){return n(s[a],e)}),(function(t,n){e.lastIndex=n,r(t)}))}o()}))}},{key:"wrapRangeFromIndex",value:function(e,t,n,r){var o=this;this.getTextNodes((function(i){var a=i.value.length;e.forEach((function(e,r){var s=o.checkWhitespaceRanges(e,a,i.value),l=s.start,c=s.end;s.valid&&o.wrapRangeInMappedTextNode(i,l,c,(function(n){return t(n,e,i.value.substring(l,c),r)}),(function(t){n(t,e)}))})),r()}))}},{key:"unwrapMatches",value:function(e){for(var t=e.parentNode,n=document.createDocumentFragment();e.firstChild;)n.appendChild(e.removeChild(e.firstChild));t.replaceChild(n,e),this.ie?this.normalizeTextNode(t):t.normalize()}},{key:"normalizeTextNode",value:function(e){if(e){if(3===e.nodeType)for(;e.nextSibling&&3===e.nextSibling.nodeType;)e.nodeValue+=e.nextSibling.nodeValue,e.parentNode.removeChild(e.nextSibling);else this.normalizeTextNode(e.firstChild);this.normalizeTextNode(e.nextSibling)}}},{key:"markRegExp",value:function(e,t){var n=this;this.opt=t,this.log('Searching with expression "'+e+'"');var r=0,o="wrapMatches";this.opt.acrossElements&&(o="wrapMatchesAcrossElements"),this[o](e,this.opt.ignoreGroups,(function(e,t){return n.opt.filter(t,e,r)}),(function(e){r++,n.opt.each(e)}),(function(){0===r&&n.opt.noMatch(e),n.opt.done(r)}))}},{key:"mark",value:function(e,t){var n=this;this.opt=t;var r=0,o="wrapMatches",i=this.getSeparatedKeywords("string"==typeof e?[e]:e),a=i.keywords,s=i.length,l=this.opt.caseSensitive?"":"i";this.opt.acrossElements&&(o="wrapMatchesAcrossElements"),0===s?this.opt.done(r):function e(t){var i=new RegExp(n.createRegExp(t),"gm"+l),c=0;n.log('Searching with expression "'+i+'"'),n[o](i,1,(function(e,o){return n.opt.filter(o,t,r,c)}),(function(e){c++,r++,n.opt.each(e)}),(function(){0===c&&n.opt.noMatch(t),a[s-1]===t?n.opt.done(r):e(a[a.indexOf(t)+1])}))}(a[0])}},{key:"markRanges",value:function(e,t){var n=this;this.opt=t;var r=0,o=this.checkRanges(e);o&&o.length?(this.log("Starting to mark with the following ranges: "+JSON.stringify(o)),this.wrapRangeFromIndex(o,(function(e,t,r,o){return n.opt.filter(e,t,r,o)}),(function(e,t){r++,n.opt.each(e,t)}),(function(){n.opt.done(r)}))):this.opt.done(r)}},{key:"unmark",value:function(e){var t=this;this.opt=e;var n=this.opt.element?this.opt.element:"*";n+="[data-markjs]",this.opt.className&&(n+="."+this.opt.className),this.log('Removal selector "'+n+'"'),this.iterator.forEachNode(NodeFilter.SHOW_ELEMENT,(function(e){t.unwrapMatches(e)}),(function(e){var r=o.matches(e,n),i=t.matchesExclude(e);return!r||i?NodeFilter.FILTER_REJECT:NodeFilter.FILTER_ACCEPT}),this.opt.done)}},{key:"opt",set:function(e){this._opt=r({},{element:"",className:"",exclude:[],iframes:!1,iframesTimeout:5e3,separateWordSearch:!0,diacritics:!0,synonyms:{},accuracy:"partially",acrossElements:!1,caseSensitive:!1,ignoreJoiners:!1,ignoreGroups:0,ignorePunctuation:[],wildcards:"disabled",each:function(){},noMatch:function(){},filter:function(){return!0},done:function(){},debug:!1,log:window.console},e)},get:function(){return this._opt}},{key:"iterator",get:function(){return new o(this.ctx,this.opt.iframes,this.opt.exclude,this.opt.iframesTimeout)}}]),i}();return function(e){var t=this,n=new i(e);return this.mark=function(e,r){return n.mark(e,r),t},this.markRegExp=function(e,r){return n.markRegExp(e,r),t},this.markRanges=function(e,r){return n.markRanges(e,r),t},this.unmark=function(e){return n.unmark(e),t},this}}()},function(e,t,n){var r;e.exports=function e(t,n,o){function i(s,l){if(!n[s]){if(!t[s]){if(!l&&"function"==typeof r&&r)return r(s,!0);if(a)return a(s,!0);var c=new Error("Cannot find module '"+s+"'");throw c.code="MODULE_NOT_FOUND",c}var u=n[s]={exports:{}};t[s][0].call(u.exports,(function(e){return i(t[s][1][e]||e)}),u,u.exports,e,t,n,o)}return n[s].exports}for(var a="function"==typeof r&&r,s=0;s<o.length;s++)i(o[s]);return i}({1:[function(e,t,n){var r=Object.prototype.hasOwnProperty,o=Object.prototype.toString;t.exports=function(e,t,n){if("[object Function]"!==o.call(t))throw new TypeError("iterator must be a function");var i=e.length;if(i===+i)for(var a=0;a<i;a++)t.call(n,e[a],a,e);else for(var s in e)r.call(e,s)&&t.call(n,e[s],s,e)}},{}],2:[function(e,t,n){"use strict";var r=e("foreach");function o(e,t,n){if(3===arguments.length)return o.set(e,t,n);if(2===arguments.length)return o.get(e,t);var r=o.bind(o,e);for(var i in o)o.hasOwnProperty(i)&&(r[i]=o[i].bind(r,e));return r}t.exports=o,o.get=function(e,t){for(var n=Array.isArray(t)?t:o.parse(t),r=0;r<n.length;++r){var i=n[r];if(!("object"==typeof e&&i in e))throw new Error("Invalid reference token: "+i);e=e[i]}return e},o.set=function(e,t,n){for(var r=Array.isArray(t)?t:o.parse(t),i=r[0],a=0;a<r.length-1;++a){var s=r[a];"-"===s&&Array.isArray(e)&&(s=e.length),i=r[a+1],s in e||(i.match(/^(\d+|-)$/)?e[s]=[]:e[s]={}),e=e[s]}return"-"===i&&Array.isArray(e)&&(i=e.length),e[i]=n,this},o.remove=function(e,t){var n=Array.isArray(t)?t:o.parse(t),r=n[n.length-1];if(void 0===r)throw new Error('Invalid JSON pointer for remove: "'+t+'"');var i=o.get(e,n.slice(0,-1));if(Array.isArray(i)){var a=+r;if(""===r&&isNaN(a))throw new Error('Invalid array index: "'+r+'"');Array.prototype.splice.call(i,a,1)}else delete i[r]},o.dict=function(e,t){var n={};return o.walk(e,(function(e,t){n[t]=e}),t),n},o.walk=function(e,t,n){var i=[];n=n||function(e){var t=Object.prototype.toString.call(e);return"[object Object]"===t||"[object Array]"===t},function e(a){r(a,(function(r,a){i.push(String(a)),n(r)?e(r):t(r,o.compile(i)),i.pop()}))}(e)},o.has=function(e,t){try{o.get(e,t)}catch(e){return!1}return!0},o.escape=function(e){return e.toString().replace(/~/g,"~0").replace(/\//g,"~1")},o.unescape=function(e){return e.replace(/~1/g,"/").replace(/~0/g,"~")},o.parse=function(e){if(""===e)return[];if("/"!==e.charAt(0))throw new Error("Invalid JSON pointer: "+e);return e.substring(1).split(/\//).map(o.unescape)},o.compile=function(e){return 0===e.length?"":"/"+e.map(o.escape).join("/")}},{foreach:1}],3:[function(e,t,n){"use strict";Object.defineProperty(n,"__esModule",{value:!0}),n.allOfSample=function(e,t,n,a){var s=(0,r.traverse)(e,n,a),l=[],c=!0,u=!1,f=void 0;try{for(var p,d=t[Symbol.iterator]();!(c=(p=d.next()).done);c=!0){var h=p.value,m=(0,r.traverse)(i({type:g},h),n,a),g=m.type,y=m.readOnly,v=m.writeOnly,b=m.value;if(s.type&&g&&g!==s.type)throw new Error("allOf: schemas with different types can't be merged");s.type=s.type||g,s.readOnly=s.readOnly||y,s.writeOnly=s.writeOnly||v,null!=b&&l.push(b)}}catch(e){u=!0,f=e}finally{try{c||null==d.return||d.return()}finally{if(u)throw f}}if("object"===s.type)return s.value=o.mergeDeep.apply(void 0,[s.value||{}].concat(l)),s;"array"===s.type&&(n.quiet||console.warn('OpenAPI Sampler: found allOf with "array" type. Result may be incorrect'));var w=l[l.length-1];return s.value=null!=w?w:s.value,s};var r=e("./traverse"),o=e("./utils");function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{},r=Object.keys(n);"function"==typeof Object.getOwnPropertySymbols&&(r=r.concat(Object.getOwnPropertySymbols(n).filter((function(e){return Object.getOwnPropertyDescriptor(n,e).enumerable})))),r.forEach((function(t){a(e,t,n[t])}))}return e}function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}},{"./traverse":12,"./utils":13}],4:[function(e,t,n){"use strict";Object.defineProperty(n,"__esModule",{value:!0}),n.inferType=function(e){if(void 0!==e.type)return e.type;for(var t=Object.keys(r),n=0;n<t.length;n++){var o=t[n],i=r[o];if(void 0!==e[o])return i}return null};var r={multipleOf:"number",maximum:"number",exclusiveMaximum:"number",minimum:"number",exclusiveMinimum:"number",maxLength:"string",minLength:"string",pattern:"string",items:"array",maxItems:"array",minItems:"array",uniqueItems:"array",additionalItems:"array",maxProperties:"object",minProperties:"object",required:"object",additionalProperties:"object",properties:"object",patternProperties:"object",dependencies:"object"}},{}],5:[function(e,t,n){"use strict";Object.defineProperty(n,"__esModule",{value:!0}),n.sample=function(e,t,n){var o=Object.assign({},s,t);return(0,r.clearCache)(),(0,r.traverse)(e,o,n).value},n._registerSampler=l,Object.defineProperty(n,"inferType",{enumerable:!0,get:function(){return i.inferType}}),n._samplers=void 0;var r=e("./traverse"),o=e("./samplers/index"),i=e("./infer"),a={};n._samplers=a;var s={skipReadOnly:!1};function l(e,t){a[e]=t}l("array",o.sampleArray),l("boolean",o.sampleBoolean),l("integer",o.sampleNumber),l("number",o.sampleNumber),l("object",o.sampleObject),l("string",o.sampleString)},{"./infer":4,"./samplers/index":8,"./traverse":12}],6:[function(e,t,n){"use strict";Object.defineProperty(n,"__esModule",{value:!0}),n.sampleArray=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},n=arguments.length>2?arguments[2]:void 0,o=e.minItems||1;Array.isArray(e.items)&&(o=Math.max(o,e.items.length));var i,a=[];if(!e.items)return a;for(var s=0;s<o;s++){var l=(i=s,Array.isArray(e.items)?e.items[i]||{}:e.items||{}),c=(0,r.traverse)(l,t,n).value;a.push(c)}return a};var r=e("../traverse")},{"../traverse":12}],7:[function(e,t,n){"use strict";Object.defineProperty(n,"__esModule",{value:!0}),n.sampleBoolean=function(e){return!0}},{}],8:[function(e,t,n){"use strict";Object.defineProperty(n,"__esModule",{value:!0}),Object.defineProperty(n,"sampleArray",{enumerable:!0,get:function(){return r.sampleArray}}),Object.defineProperty(n,"sampleBoolean",{enumerable:!0,get:function(){return o.sampleBoolean}}),Object.defineProperty(n,"sampleNumber",{enumerable:!0,get:function(){return i.sampleNumber}}),Object.defineProperty(n,"sampleObject",{enumerable:!0,get:function(){return a.sampleObject}}),Object.defineProperty(n,"sampleString",{enumerable:!0,get:function(){return s.sampleString}});var r=e("./array"),o=e("./boolean"),i=e("./number"),a=e("./object"),s=e("./string")},{"./array":6,"./boolean":7,"./number":9,"./object":10,"./string":11}],9:[function(e,t,n){"use strict";Object.defineProperty(n,"__esModule",{value:!0}),n.sampleNumber=function(e){var t;return e.maximum&&e.minimum?(t=e.exclusiveMinimum?Math.floor(e.minimum)+1:e.minimum,(e.exclusiveMaximum&&t>=e.maximum||!e.exclusiveMaximum&&t>e.maximum)&&(t=(e.maximum+e.minimum)/2),t):e.minimum?e.exclusiveMinimum?Math.floor(e.minimum)+1:e.minimum:e.maximum?e.exclusiveMaximum?e.maximum>0?0:Math.floor(e.maximum)-1:e.maximum>0?0:e.maximum:0}},{}],10:[function(e,t,n){"use strict";Object.defineProperty(n,"__esModule",{value:!0}),n.sampleObject=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},n=arguments.length>2?arguments[2]:void 0,i={};if(e&&"object"===o(e.properties)){var a=(Array.isArray(e.required)?e.required:[]).reduce((function(e,t){return e[t]=!0,e}),{});Object.keys(e.properties).forEach((function(o){if(!t.skipNonRequired||a.hasOwnProperty(o)){var s=(0,r.traverse)(e.properties[o],t,n);t.skipReadOnly&&s.readOnly||t.skipWriteOnly&&s.writeOnly||(i[o]=s.value)}}))}return e&&"object"===o(e.additionalProperties)&&(i.property1=(0,r.traverse)(e.additionalProperties,t,n).value,i.property2=(0,r.traverse)(e.additionalProperties,t,n).value),i};var r=e("../traverse");function o(e){return(o="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e})(e)}},{"../traverse":12}],11:[function(e,t,n){"use strict";Object.defineProperty(n,"__esModule",{value:!0}),n.sampleString=function(e){var t=e.format||"default";return(s[t]||a)(0|e.minLength,e.maxLength)};var r=e("../utils"),o="qwerty!@#$%^123456";function i(e,t,n){var o=(0,r.toRFCDateTime)(new Date,n,!1);if(o.length<e)throw new Error("Using minLength = ".concat(e,' is incorrect with format "date-time"'));if(t&&o.length>t)throw new Error("Using maxLength = ".concat(t,' is incorrect with format "date-time"'));return o}function a(e,t){var n=(0,r.ensureMinLength)("string",e);return t&&n.length>t&&(n=n.substring(0,t)),n}var s={email:function(){return"user@example.com"},password:function(e,t){var n="pa$$word";return e>n.length&&(n+="_",n+=(0,r.ensureMinLength)(o,e-n.length).substring(0,e-n.length)),n},"date-time":function(e,t){return i(e,t)},date:function(e,t){return i(e,t,!0)},ipv4:function(){return"192.168.0.1"},ipv6:function(){return"2001:0db8:85a3:0000:0000:8a2e:0370:7334"},hostname:function(){return"example.com"},uri:function(){return"http://example.com"},default:a}},{"../utils":13}],12:[function(e,t,n){"use strict";Object.defineProperty(n,"__esModule",{value:!0}),n.clearCache=function(){c={}},n.traverse=function e(t,n,r){if(t.$ref){if(!r)throw new Error("Your schema contains $ref. You must provide specification in the third parameter.");var u=decodeURIComponent(t.$ref);u.startsWith("#")&&(u=u.substring(1));var f,p=s.default.get(r,u);if(!0!==c[u])c[u]=!0,f=e(p,n,r),c[u]=!1;else{var d=(0,a.inferType)(p);f={value:"object"===d?{}:"array"===d?[]:void 0}}return f}if(void 0!==t.example)return{value:t.example,readOnly:t.readOnly,writeOnly:t.writeOnly,type:t.type};if(void 0!==t.allOf)return(0,i.allOfSample)(function(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{},r=Object.keys(n);"function"==typeof Object.getOwnPropertySymbols&&(r=r.concat(Object.getOwnPropertySymbols(n).filter((function(e){return Object.getOwnPropertyDescriptor(n,e).enumerable})))),r.forEach((function(t){l(e,t,n[t])}))}return e}({},t,{allOf:void 0}),t.allOf,n,r);if(t.oneOf&&t.oneOf.length)return t.anyOf&&(n.quiet||console.warn("oneOf and anyOf are not supported on the same level. Skipping anyOf")),e(t.oneOf[0],n,r);if(t.anyOf&&t.anyOf.length)return e(t.anyOf[0],n,r);var h=null,m=null;if(void 0!==t.default)h=t.default;else if(void 0!==t.const)h=t.const;else if(void 0!==t.enum&&t.enum.length)h=t.enum[0];else if(void 0!==t.examples&&t.examples.length)h=t.examples[0];else{(m=t.type)||(m=(0,a.inferType)(t));var g=o._samplers[m];g&&(h=g(t,n,r))}return{value:h,readOnly:t.readOnly,writeOnly:t.writeOnly,type:m}};var r,o=e("./openapi-sampler"),i=e("./allOf"),a=e("./infer"),s=(r=e("json-pointer"))&&r.__esModule?r:{default:r};function l(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}var c={}},{"./allOf":3,"./infer":4,"./openapi-sampler":5,"json-pointer":2}],13:[function(e,t,n){"use strict";function r(e){return(r="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e})(e)}function o(e){return e<10?"0"+e:e}Object.defineProperty(n,"__esModule",{value:!0}),n.toRFCDateTime=function(e,t,n){var r=e.getUTCFullYear()+"-"+o(e.getUTCMonth()+1)+"-"+o(e.getUTCDate());return t||(r+="T"+o(e.getUTCHours())+":"+o(e.getUTCMinutes())+":"+o(e.getUTCSeconds())+(n?"."+(e.getUTCMilliseconds()/1e3).toFixed(3).slice(2,5):"")+"Z"),r},n.ensureMinLength=function(e,t){return t>e.length?e.repeat(Math.trunc(t/e.length)+1).substring(0,t):e},n.mergeDeep=function e(){for(var t=function(e){return e&&"object"===r(e)},n=arguments.length,o=new Array(n),i=0;i<n;i++)o[i]=arguments[i];return o.reduce((function(n,r){return Object.keys(r).forEach((function(o){var i=n[o],a=r[o];t(i)&&t(a)?n[o]=e(i,a):n[o]=a})),n}),Array.isArray(o[o.length-1])?[]:{})}},{}]},{},[5])(5)},function(e,t,n){(e.exports=n(315)(!1)).push([e.i,"/*\n * Container style\n */\n.ps {\n overflow: hidden !important;\n overflow-anchor: none;\n -ms-overflow-style: none;\n touch-action: auto;\n -ms-touch-action: auto;\n}\n\n/*\n * Scrollbar rail styles\n */\n.ps__rail-x {\n display: none;\n opacity: 0;\n transition: background-color .2s linear, opacity .2s linear;\n -webkit-transition: background-color .2s linear, opacity .2s linear;\n height: 15px;\n /* there must be 'bottom' or 'top' for ps__rail-x */\n bottom: 0px;\n /* please don't change 'position' */\n position: absolute;\n}\n\n.ps__rail-y {\n display: none;\n opacity: 0;\n transition: background-color .2s linear, opacity .2s linear;\n -webkit-transition: background-color .2s linear, opacity .2s linear;\n width: 15px;\n /* there must be 'right' or 'left' for ps__rail-y */\n right: 0;\n /* please don't change 'position' */\n position: absolute;\n}\n\n.ps--active-x > .ps__rail-x,\n.ps--active-y > .ps__rail-y {\n display: block;\n background-color: transparent;\n}\n\n.ps:hover > .ps__rail-x,\n.ps:hover > .ps__rail-y,\n.ps--focus > .ps__rail-x,\n.ps--focus > .ps__rail-y,\n.ps--scrolling-x > .ps__rail-x,\n.ps--scrolling-y > .ps__rail-y {\n opacity: 0.6;\n}\n\n.ps .ps__rail-x:hover,\n.ps .ps__rail-y:hover,\n.ps .ps__rail-x:focus,\n.ps .ps__rail-y:focus,\n.ps .ps__rail-x.ps--clicking,\n.ps .ps__rail-y.ps--clicking {\n background-color: #eee;\n opacity: 0.9;\n}\n\n/*\n * Scrollbar thumb styles\n */\n.ps__thumb-x {\n background-color: #aaa;\n border-radius: 6px;\n transition: background-color .2s linear, height .2s ease-in-out;\n -webkit-transition: background-color .2s linear, height .2s ease-in-out;\n height: 6px;\n /* there must be 'bottom' for ps__thumb-x */\n bottom: 2px;\n /* please don't change 'position' */\n position: absolute;\n}\n\n.ps__thumb-y {\n background-color: #aaa;\n border-radius: 6px;\n transition: background-color .2s linear, width .2s ease-in-out;\n -webkit-transition: background-color .2s linear, width .2s ease-in-out;\n width: 6px;\n /* there must be 'right' for ps__thumb-y */\n right: 2px;\n /* please don't change 'position' */\n position: absolute;\n}\n\n.ps__rail-x:hover > .ps__thumb-x,\n.ps__rail-x:focus > .ps__thumb-x,\n.ps__rail-x.ps--clicking .ps__thumb-x {\n background-color: #999;\n height: 11px;\n}\n\n.ps__rail-y:hover > .ps__thumb-y,\n.ps__rail-y:focus > .ps__thumb-y,\n.ps__rail-y.ps--clicking .ps__thumb-y {\n background-color: #999;\n width: 11px;\n}\n\n/* MS supports */\n@supports (-ms-overflow-style: none) {\n .ps {\n overflow: auto !important;\n }\n}\n\n@media screen and (-ms-high-contrast: active), (-ms-high-contrast: none) {\n .ps {\n overflow: auto !important;\n }\n}\n",""])},function(e,t,n){var r=n(3),o=n(67),i=r["__core-js_shared__"]||o("__core-js_shared__",{});e.exports=i},function(e,t,n){var r=n(18),o=n(9),i=n(68);e.exports=!r&&!o((function(){return 7!=Object.defineProperty(i("div"),"a",{get:function(){return 7}}).a}))},function(e,t,n){var r=n(69);e.exports=r&&!Symbol.sham&&"symbol"==typeof Symbol()},function(e,t,n){var r=n(65),o=n(25),i=n(4)("toStringTag"),a="Arguments"==o(function(){return arguments}());e.exports=r?o:function(e){var t,n,r;return void 0===e?"Undefined":null===e?"Null":"string"==typeof(n=function(e,t){try{return e[t]}catch(e){}}(t=Object(e),i))?n:a?o(t):"Object"==(r=o(t))&&"function"==typeof t.callee?"Arguments":r}},function(e,t,n){"use strict";var r=n(164).charAt,o=n(31),i=n(72),a=o.set,s=o.getterFor("String Iterator");i(String,"String",(function(e){a(this,{type:"String Iterator",string:String(e),index:0})}),(function(){var e,t=s(this),n=t.string,o=t.index;return o>=n.length?{value:void 0,done:!0}:(e=r(n,o),t.index+=e.length,{value:e,done:!1})}))},function(e,t,n){var r=n(12),o=n(165),i=n(32),a=n(15);e.exports=function(e,t){for(var n=o(t),s=a.f,l=i.f,c=0;c<n.length;c++){var u=n[c];r(e,u)||s(e,u,l(t,u))}}},function(e,t,n){var r=n(12),o=n(33),i=n(166).indexOf,a=n(40);e.exports=function(e,t){var n,s=o(e),l=0,c=[];for(n in s)!r(a,n)&&r(s,n)&&c.push(n);for(;t.length>l;)r(s,n=t[l++])&&(~i(c,n)||c.push(n));return c}},function(e,t,n){"use strict";var r,o,i,a=n(106),s=n(20),l=n(12),c=n(4),u=n(22),f=c("iterator"),p=!1;[].keys&&("next"in(i=[].keys())?(o=a(a(i)))!==Object.prototype&&(r=o):p=!0),null==r&&(r={}),u||l(r,f)||s(r,f,(function(){return this})),e.exports={IteratorPrototype:r,BUGGY_SAFARI_ITERATORS:p}},function(e,t,n){var r=n(12),o=n(42),i=n(54),a=n(169),s=i("IE_PROTO"),l=Object.prototype;e.exports=a?Object.getPrototypeOf:function(e){return e=o(e),r(e,s)?e[s]:"function"==typeof e.constructor&&e instanceof e.constructor?e.constructor.prototype:e instanceof Object?l:null}},function(e,t,n){var r=n(26);e.exports=r("document","documentElement")},function(e,t,n){var r=n(19),o=n(171);e.exports=Object.setPrototypeOf||("__proto__"in{}?function(){var e,t=!1,n={};try{(e=Object.getOwnPropertyDescriptor(Object.prototype,"__proto__").set).call(n,[]),t=n instanceof Array}catch(e){}return function(n,i){return r(n),o(i),t?e.call(n,i):n.__proto__=i,n}}():void 0)},function(e,t,n){var r=n(3),o=n(172),i=n(173),a=n(20),s=n(4),l=s("iterator"),c=s("toStringTag"),u=i.values;for(var f in o){var p=r[f],d=p&&p.prototype;if(d){if(d[l]!==u)try{a(d,l,u)}catch(e){d[l]=u}if(d[c]||a(d,c,f),o[f])for(var h in i)if(d[h]!==i[h])try{a(d,h,i[h])}catch(e){d[h]=i[h]}}}},function(e,t,n){var r=n(4),o=n(55),i=n(20),a=r("unscopables"),s=Array.prototype;null==s[a]&&i(s,a,o(null)),e.exports=function(e){s[a][e]=!0}},function(e,t,n){var r=n(3);e.exports=r.Promise},function(e,t,n){var r=n(23);e.exports=function(e,t,n){for(var o in t)r(e,o,t[o],n);return e}},function(e,t,n){"use strict";var r=n(26),o=n(15),i=n(4),a=n(18),s=i("species");e.exports=function(e){var t=r(e),n=o.f;a&&t&&!t[s]&&n(t,s,{configurable:!0,get:function(){return this}})}},function(e,t,n){var r=n(4)("iterator"),o=!1;try{var i=0,a={next:function(){return{done:!!i++}},return:function(){o=!0}};a[r]=function(){return this},Array.from(a,(function(){throw 2}))}catch(e){}e.exports=function(e,t){if(!t&&!o)return!1;var n=!1;try{var i={};i[r]=function(){return{next:function(){return{done:n=!0}}}},e(i)}catch(e){}return n}},function(e,t,n){var r=n(19),o=n(44),i=n(4)("species");e.exports=function(e,t){var n,a=r(e).constructor;return void 0===a||null==(n=r(a)[i])?t:o(n)}},function(e,t,n){var r,o,i,a=n(3),s=n(9),l=n(25),c=n(45),u=n(107),f=n(68),p=n(117),d=a.location,h=a.setImmediate,m=a.clearImmediate,g=a.process,y=a.MessageChannel,v=a.Dispatch,b=0,w={},x=function(e){if(w.hasOwnProperty(e)){var t=w[e];delete w[e],t()}},k=function(e){return function(){x(e)}},E=function(e){x(e.data)},O=function(e){a.postMessage(e+"",d.protocol+"//"+d.host)};h&&m||(h=function(e){for(var t=[],n=1;arguments.length>n;)t.push(arguments[n++]);return w[++b]=function(){("function"==typeof e?e:Function(e)).apply(void 0,t)},r(b),b},m=function(e){delete w[e]},"process"==l(g)?r=function(e){g.nextTick(k(e))}:v&&v.now?r=function(e){v.now(k(e))}:y&&!p?(i=(o=new y).port2,o.port1.onmessage=E,r=c(i.postMessage,i,1)):!a.addEventListener||"function"!=typeof postMessage||a.importScripts||s(O)?r="onreadystatechange"in f("script")?function(e){u.appendChild(f("script")).onreadystatechange=function(){u.removeChild(this),x(e)}}:function(e){setTimeout(k(e),0)}:(r=O,a.addEventListener("message",E,!1))),e.exports={set:h,clear:m}},function(e,t,n){var r=n(118);e.exports=/(iphone|ipod|ipad).*applewebkit/i.test(r)},function(e,t,n){var r=n(26);e.exports=r("navigator","userAgent")||""},function(e,t,n){var r=n(19),o=n(7),i=n(81);e.exports=function(e,t){if(r(e),o(t)&&t.constructor===e)return t;var n=i.f(e);return(0,n.resolve)(t),n.promise}},function(e,t){e.exports=function(e){try{return{error:!1,value:e()}}catch(e){return{error:!0,value:e}}}},function(e,t,n){var r=n(45),o=n(74),i=n(42),a=n(35),s=n(122),l=[].push,c=function(e){var t=1==e,n=2==e,c=3==e,u=4==e,f=6==e,p=5==e||f;return function(d,h,m,g){for(var y,v,b=i(d),w=o(b),x=r(h,m,3),k=a(w.length),E=0,O=g||s,_=t?O(d,k):n?O(d,0):void 0;k>E;E++)if((p||E in w)&&(v=x(y=w[E],E,b),e))if(t)_[E]=v;else if(v)switch(e){case 3:return!0;case 5:return y;case 6:return E;case 2:l.call(_,y)}else if(u)return!1;return f?-1:c||u?u:_}};e.exports={forEach:c(0),map:c(1),filter:c(2),some:c(3),every:c(4),find:c(5),findIndex:c(6)}},function(e,t,n){var r=n(7),o=n(83),i=n(4)("species");e.exports=function(e,t){var n;return o(e)&&("function"!=typeof(n=e.constructor)||n!==Array&&!o(n.prototype)?r(n)&&null===(n=n[i])&&(n=void 0):n=void 0),new(void 0===n?Array:n)(0===t?0:t)}},function(e,t,n){var r=n(189);e.exports=function(e){if(r(e))throw TypeError("The method doesn't accept regular expressions");return e}},function(e,t,n){var r=n(4)("match");e.exports=function(e){var t=/./;try{"/./"[e](t)}catch(n){try{return t[r]=!1,"/./"[e](t)}catch(e){}}return!1}},function(e,t,n){var r=n(40),o=n(7),i=n(12),a=n(15).f,s=n(53),l=n(195),c=s("meta"),u=0,f=Object.isExtensible||function(){return!0},p=function(e){a(e,c,{value:{objectID:"O"+ ++u,weakData:{}}})},d=e.exports={REQUIRED:!1,fastKey:function(e,t){if(!o(e))return"symbol"==typeof e?e:("string"==typeof e?"S":"P")+e;if(!i(e,c)){if(!f(e))return"F";if(!t)return"E";p(e)}return e[c].objectID},getWeakData:function(e,t){if(!i(e,c)){if(!f(e))return!0;if(!t)return!1;p(e)}return e[c].weakData},onFreeze:function(e){return l&&d.REQUIRED&&f(e)&&!i(e,c)&&p(e),e}};r[c]=!0},function(e,t,n){var r=n(4);t.f=r},function(e,t,n){"use strict";
|
||
/*
|
||
object-assign
|
||
(c) Sindre Sorhus
|
||
@license MIT
|
||
*/var r=Object.getOwnPropertySymbols,o=Object.prototype.hasOwnProperty,i=Object.prototype.propertyIsEnumerable;function a(e){if(null==e)throw new TypeError("Object.assign cannot be called with null or undefined");return Object(e)}e.exports=function(){try{if(!Object.assign)return!1;var e=new String("abc");if(e[5]="de","5"===Object.getOwnPropertyNames(e)[0])return!1;for(var t={},n=0;n<10;n++)t["_"+String.fromCharCode(n)]=n;if("0123456789"!==Object.getOwnPropertyNames(t).map((function(e){return t[e]})).join(""))return!1;var r={};return"abcdefghijklmnopqrst".split("").forEach((function(e){r[e]=e})),"abcdefghijklmnopqrst"===Object.keys(Object.assign({},r)).join("")}catch(e){return!1}}()?Object.assign:function(e,t){for(var n,s,l=a(e),c=1;c<arguments.length;c++){for(var u in n=Object(arguments[c]))o.call(n,u)&&(l[u]=n[u]);if(r){s=r(n);for(var f=0;f<s.length;f++)i.call(n,s[f])&&(l[s[f]]=n[s[f]])}}return l}},function(e,t){var n={}.toString;e.exports=Array.isArray||function(e){return"[object Array]"==n.call(e)}},function(e,t,n){"use strict";var r=n(237),o=n(238),i=n(262),a=n(263),s=n(264),l=n(266);function c(e){u(this,c.defaults),u(this,e)}function u(e,t){if(f(t))for(var n=Object.keys(t),r=0;r<n.length;r++){var o=n[r],i=t[o],a=e[o];f(i)?e[o]=u(a||{},i):void 0!==i&&(e[o]=i)}return e}function f(e){return e&&"object"==typeof e&&!Array.isArray(e)&&!(e instanceof RegExp)&&!(e instanceof Date)}e.exports=c,c.defaults={parse:{json:r,yaml:o,text:i,binary:a},resolve:{file:s,http:l,external:!0},dereference:{circular:!0}}},function(e,t,n){"use strict";var r=n(239),o=n(28);e.exports={parse:function(e,t){try{return r.safeLoad(e)}catch(e){throw e instanceof Error?e:o(e,e.message)}},stringify:function(e,t,n){try{var i=("string"==typeof n?n.length:n)||2;return r.safeDump(e,{indent:i})}catch(e){throw e instanceof Error?e:o(e,e.message)}}}},function(e,t,n){"use strict";var r=n(36);e.exports=new r({include:[n(132)]})},function(e,t,n){"use strict";var r=n(36);e.exports=new r({include:[n(85)],implicit:[n(246),n(247),n(248),n(249)]})},function(e,t,n){(function(e){t.fetch=s(e.fetch)&&s(e.ReadableStream),t.writableStream=s(e.WritableStream),t.abortController=s(e.AbortController),t.blobConstructor=!1;try{new Blob([new ArrayBuffer(1)]),t.blobConstructor=!0}catch(e){}var n;function r(){if(void 0!==n)return n;if(e.XMLHttpRequest){n=new e.XMLHttpRequest;try{n.open("GET",e.XDomainRequest?"/":"https://example.com")}catch(e){n=null}}else n=null;return n}function o(e){var t=r();if(!t)return!1;try{return t.responseType=e,t.responseType===e}catch(e){}return!1}var i=void 0!==e.ArrayBuffer,a=i&&s(e.ArrayBuffer.prototype.slice);function s(e){return"function"==typeof e}t.arraybuffer=t.fetch||i&&o("arraybuffer"),t.msstream=!t.fetch&&a&&o("ms-stream"),t.mozchunkedarraybuffer=!t.fetch&&i&&o("moz-chunked-arraybuffer"),t.overrideMimeType=t.fetch||!!r()&&s(r().overrideMimeType),t.vbArray=s(e.VBArray),n=null}).call(this,n(6))},function(e,t,n){(function(e,r,o){var i=n(133),a=n(29),s=n(135),l=t.readyStates={UNSENT:0,OPENED:1,HEADERS_RECEIVED:2,LOADING:3,DONE:4},c=t.IncomingMessage=function(t,n,a,l){var c=this;if(s.Readable.call(c),c._mode=a,c.headers={},c.rawHeaders=[],c.trailers={},c.rawTrailers=[],c.on("end",(function(){e.nextTick((function(){c.emit("close")}))})),"fetch"===a){if(c._fetchResponse=n,c.url=n.url,c.statusCode=n.status,c.statusMessage=n.statusText,n.headers.forEach((function(e,t){c.headers[t.toLowerCase()]=e,c.rawHeaders.push(t,e)})),i.writableStream){var u=new WritableStream({write:function(e){return new Promise((function(t,n){c._destroyed?n():c.push(new r(e))?t():c._resumeFetch=t}))},close:function(){o.clearTimeout(l),c._destroyed||c.push(null)},abort:function(e){c._destroyed||c.emit("error",e)}});try{return void n.body.pipeTo(u).catch((function(e){o.clearTimeout(l),c._destroyed||c.emit("error",e)}))}catch(e){}}var f=n.body.getReader();!function e(){f.read().then((function(t){if(!c._destroyed){if(t.done)return o.clearTimeout(l),void c.push(null);c.push(new r(t.value)),e()}})).catch((function(e){o.clearTimeout(l),c._destroyed||c.emit("error",e)}))}()}else{if(c._xhr=t,c._pos=0,c.url=t.responseURL,c.statusCode=t.status,c.statusMessage=t.statusText,t.getAllResponseHeaders().split(/\r?\n/).forEach((function(e){var t=e.match(/^([^:]+):\s*(.*)/);if(t){var n=t[1].toLowerCase();"set-cookie"===n?(void 0===c.headers[n]&&(c.headers[n]=[]),c.headers[n].push(t[2])):void 0!==c.headers[n]?c.headers[n]+=", "+t[2]:c.headers[n]=t[2],c.rawHeaders.push(t[1],t[2])}})),c._charset="x-user-defined",!i.overrideMimeType){var p=c.rawHeaders["mime-type"];if(p){var d=p.match(/;\s*charset=([^;])(;|$)/);d&&(c._charset=d[1].toLowerCase())}c._charset||(c._charset="utf-8")}}};a(c,s.Readable),c.prototype._read=function(){var e=this._resumeFetch;e&&(this._resumeFetch=null,e())},c.prototype._onXHRProgress=function(){var e=this,t=e._xhr,n=null;switch(e._mode){case"text:vbarray":if(t.readyState!==l.DONE)break;try{n=new o.VBArray(t.responseBody).toArray()}catch(e){}if(null!==n){e.push(new r(n));break}case"text":try{n=t.responseText}catch(t){e._mode="text:vbarray";break}if(n.length>e._pos){var i=n.substr(e._pos);if("x-user-defined"===e._charset){for(var a=new r(i.length),s=0;s<i.length;s++)a[s]=255&i.charCodeAt(s);e.push(a)}else e.push(i,e._charset);e._pos=n.length}break;case"arraybuffer":if(t.readyState!==l.DONE||!t.response)break;n=t.response,e.push(new r(new Uint8Array(n)));break;case"moz-chunked-arraybuffer":if(n=t.response,t.readyState!==l.LOADING||!n)break;e.push(new r(new Uint8Array(n)));break;case"ms-stream":if(n=t.response,t.readyState!==l.LOADING)break;var c=new o.MSStreamReader;c.onprogress=function(){c.result.byteLength>e._pos&&(e.push(new r(new Uint8Array(c.result.slice(e._pos)))),e._pos=c.result.byteLength)},c.onload=function(){e.push(null)},c.readAsArrayBuffer(n)}e._xhr.readyState===l.DONE&&"ms-stream"!==e._mode&&e.push(null)}}).call(this,n(13),n(11).Buffer,n(6))},function(e,t,n){(t=e.exports=n(136)).Stream=t,t.Readable=t,t.Writable=n(140),t.Duplex=n(37),t.Transform=n(142),t.PassThrough=n(275)},function(e,t,n){"use strict";(function(t,r){var o=n(59);e.exports=b;var i,a=n(128);b.ReadableState=v;n(137).EventEmitter;var s=function(e,t){return e.listeners(t).length},l=n(138),c=n(88).Buffer,u=t.Uint8Array||function(){};var f=n(47);f.inherits=n(29);var p=n(268),d=void 0;d=p&&p.debuglog?p.debuglog("stream"):function(){};var h,m=n(269),g=n(139);f.inherits(b,l);var y=["error","close","destroy","pause","resume"];function v(e,t){e=e||{};var r=t instanceof(i=i||n(37));this.objectMode=!!e.objectMode,r&&(this.objectMode=this.objectMode||!!e.readableObjectMode);var o=e.highWaterMark,a=e.readableHighWaterMark,s=this.objectMode?16:16384;this.highWaterMark=o||0===o?o:r&&(a||0===a)?a:s,this.highWaterMark=Math.floor(this.highWaterMark),this.buffer=new m,this.length=0,this.pipes=null,this.pipesCount=0,this.flowing=null,this.ended=!1,this.endEmitted=!1,this.reading=!1,this.sync=!0,this.needReadable=!1,this.emittedReadable=!1,this.readableListening=!1,this.resumeScheduled=!1,this.destroyed=!1,this.defaultEncoding=e.defaultEncoding||"utf8",this.awaitDrain=0,this.readingMore=!1,this.decoder=null,this.encoding=null,e.encoding&&(h||(h=n(141).StringDecoder),this.decoder=new h(e.encoding),this.encoding=e.encoding)}function b(e){if(i=i||n(37),!(this instanceof b))return new b(e);this._readableState=new v(e,this),this.readable=!0,e&&("function"==typeof e.read&&(this._read=e.read),"function"==typeof e.destroy&&(this._destroy=e.destroy)),l.call(this)}function w(e,t,n,r,o){var i,a=e._readableState;null===t?(a.reading=!1,function(e,t){if(t.ended)return;if(t.decoder){var n=t.decoder.end();n&&n.length&&(t.buffer.push(n),t.length+=t.objectMode?1:n.length)}t.ended=!0,O(e)}(e,a)):(o||(i=function(e,t){var n;r=t,c.isBuffer(r)||r instanceof u||"string"==typeof t||void 0===t||e.objectMode||(n=new TypeError("Invalid non-string/buffer chunk"));var r;return n}(a,t)),i?e.emit("error",i):a.objectMode||t&&t.length>0?("string"==typeof t||a.objectMode||Object.getPrototypeOf(t)===c.prototype||(t=function(e){return c.from(e)}(t)),r?a.endEmitted?e.emit("error",new Error("stream.unshift() after end event")):x(e,a,t,!0):a.ended?e.emit("error",new Error("stream.push() after EOF")):(a.reading=!1,a.decoder&&!n?(t=a.decoder.write(t),a.objectMode||0!==t.length?x(e,a,t,!1):S(e,a)):x(e,a,t,!1))):r||(a.reading=!1));return function(e){return!e.ended&&(e.needReadable||e.length<e.highWaterMark||0===e.length)}(a)}function x(e,t,n,r){t.flowing&&0===t.length&&!t.sync?(e.emit("data",n),e.read(0)):(t.length+=t.objectMode?1:n.length,r?t.buffer.unshift(n):t.buffer.push(n),t.needReadable&&O(e)),S(e,t)}Object.defineProperty(b.prototype,"destroyed",{get:function(){return void 0!==this._readableState&&this._readableState.destroyed},set:function(e){this._readableState&&(this._readableState.destroyed=e)}}),b.prototype.destroy=g.destroy,b.prototype._undestroy=g.undestroy,b.prototype._destroy=function(e,t){this.push(null),t(e)},b.prototype.push=function(e,t){var n,r=this._readableState;return r.objectMode?n=!0:"string"==typeof e&&((t=t||r.defaultEncoding)!==r.encoding&&(e=c.from(e,t),t=""),n=!0),w(this,e,t,!1,n)},b.prototype.unshift=function(e){return w(this,e,null,!0,!1)},b.prototype.isPaused=function(){return!1===this._readableState.flowing},b.prototype.setEncoding=function(e){return h||(h=n(141).StringDecoder),this._readableState.decoder=new h(e),this._readableState.encoding=e,this};var k=8388608;function E(e,t){return e<=0||0===t.length&&t.ended?0:t.objectMode?1:e!=e?t.flowing&&t.length?t.buffer.head.data.length:t.length:(e>t.highWaterMark&&(t.highWaterMark=function(e){return e>=k?e=k:(e--,e|=e>>>1,e|=e>>>2,e|=e>>>4,e|=e>>>8,e|=e>>>16,e++),e}(e)),e<=t.length?e:t.ended?t.length:(t.needReadable=!0,0))}function O(e){var t=e._readableState;t.needReadable=!1,t.emittedReadable||(d("emitReadable",t.flowing),t.emittedReadable=!0,t.sync?o.nextTick(_,e):_(e))}function _(e){d("emit readable"),e.emit("readable"),I(e)}function S(e,t){t.readingMore||(t.readingMore=!0,o.nextTick(T,e,t))}function T(e,t){for(var n=t.length;!t.reading&&!t.flowing&&!t.ended&&t.length<t.highWaterMark&&(d("maybeReadMore read 0"),e.read(0),n!==t.length);)n=t.length;t.readingMore=!1}function j(e){d("readable nexttick read 0"),e.read(0)}function C(e,t){t.reading||(d("resume read 0"),e.read(0)),t.resumeScheduled=!1,t.awaitDrain=0,e.emit("resume"),I(e),t.flowing&&!t.reading&&e.read(0)}function I(e){var t=e._readableState;for(d("flow",t.flowing);t.flowing&&null!==e.read(););}function A(e,t){return 0===t.length?null:(t.objectMode?n=t.buffer.shift():!e||e>=t.length?(n=t.decoder?t.buffer.join(""):1===t.buffer.length?t.buffer.head.data:t.buffer.concat(t.length),t.buffer.clear()):n=function(e,t,n){var r;e<t.head.data.length?(r=t.head.data.slice(0,e),t.head.data=t.head.data.slice(e)):r=e===t.head.data.length?t.shift():n?function(e,t){var n=t.head,r=1,o=n.data;e-=o.length;for(;n=n.next;){var i=n.data,a=e>i.length?i.length:e;if(a===i.length?o+=i:o+=i.slice(0,e),0===(e-=a)){a===i.length?(++r,n.next?t.head=n.next:t.head=t.tail=null):(t.head=n,n.data=i.slice(a));break}++r}return t.length-=r,o}(e,t):function(e,t){var n=c.allocUnsafe(e),r=t.head,o=1;r.data.copy(n),e-=r.data.length;for(;r=r.next;){var i=r.data,a=e>i.length?i.length:e;if(i.copy(n,n.length-e,0,a),0===(e-=a)){a===i.length?(++o,r.next?t.head=r.next:t.head=t.tail=null):(t.head=r,r.data=i.slice(a));break}++o}return t.length-=o,n}(e,t);return r}(e,t.buffer,t.decoder),n);var n}function P(e){var t=e._readableState;if(t.length>0)throw new Error('"endReadable()" called on non-empty stream');t.endEmitted||(t.ended=!0,o.nextTick(R,t,e))}function R(e,t){e.endEmitted||0!==e.length||(e.endEmitted=!0,t.readable=!1,t.emit("end"))}function N(e,t){for(var n=0,r=e.length;n<r;n++)if(e[n]===t)return n;return-1}b.prototype.read=function(e){d("read",e),e=parseInt(e,10);var t=this._readableState,n=e;if(0!==e&&(t.emittedReadable=!1),0===e&&t.needReadable&&(t.length>=t.highWaterMark||t.ended))return d("read: emitReadable",t.length,t.ended),0===t.length&&t.ended?P(this):O(this),null;if(0===(e=E(e,t))&&t.ended)return 0===t.length&&P(this),null;var r,o=t.needReadable;return d("need readable",o),(0===t.length||t.length-e<t.highWaterMark)&&d("length less than watermark",o=!0),t.ended||t.reading?d("reading or ended",o=!1):o&&(d("do read"),t.reading=!0,t.sync=!0,0===t.length&&(t.needReadable=!0),this._read(t.highWaterMark),t.sync=!1,t.reading||(e=E(n,t))),null===(r=e>0?A(e,t):null)?(t.needReadable=!0,e=0):t.length-=e,0===t.length&&(t.ended||(t.needReadable=!0),n!==e&&t.ended&&P(this)),null!==r&&this.emit("data",r),r},b.prototype._read=function(e){this.emit("error",new Error("_read() is not implemented"))},b.prototype.pipe=function(e,t){var n=this,i=this._readableState;switch(i.pipesCount){case 0:i.pipes=e;break;case 1:i.pipes=[i.pipes,e];break;default:i.pipes.push(e)}i.pipesCount+=1,d("pipe count=%d opts=%j",i.pipesCount,t);var l=(!t||!1!==t.end)&&e!==r.stdout&&e!==r.stderr?u:b;function c(t,r){d("onunpipe"),t===n&&r&&!1===r.hasUnpiped&&(r.hasUnpiped=!0,d("cleanup"),e.removeListener("close",y),e.removeListener("finish",v),e.removeListener("drain",f),e.removeListener("error",g),e.removeListener("unpipe",c),n.removeListener("end",u),n.removeListener("end",b),n.removeListener("data",m),p=!0,!i.awaitDrain||e._writableState&&!e._writableState.needDrain||f())}function u(){d("onend"),e.end()}i.endEmitted?o.nextTick(l):n.once("end",l),e.on("unpipe",c);var f=function(e){return function(){var t=e._readableState;d("pipeOnDrain",t.awaitDrain),t.awaitDrain&&t.awaitDrain--,0===t.awaitDrain&&s(e,"data")&&(t.flowing=!0,I(e))}}(n);e.on("drain",f);var p=!1;var h=!1;function m(t){d("ondata"),h=!1,!1!==e.write(t)||h||((1===i.pipesCount&&i.pipes===e||i.pipesCount>1&&-1!==N(i.pipes,e))&&!p&&(d("false write response, pause",n._readableState.awaitDrain),n._readableState.awaitDrain++,h=!0),n.pause())}function g(t){d("onerror",t),b(),e.removeListener("error",g),0===s(e,"error")&&e.emit("error",t)}function y(){e.removeListener("finish",v),b()}function v(){d("onfinish"),e.removeListener("close",y),b()}function b(){d("unpipe"),n.unpipe(e)}return n.on("data",m),function(e,t,n){if("function"==typeof e.prependListener)return e.prependListener(t,n);e._events&&e._events[t]?a(e._events[t])?e._events[t].unshift(n):e._events[t]=[n,e._events[t]]:e.on(t,n)}(e,"error",g),e.once("close",y),e.once("finish",v),e.emit("pipe",n),i.flowing||(d("pipe resume"),n.resume()),e},b.prototype.unpipe=function(e){var t=this._readableState,n={hasUnpiped:!1};if(0===t.pipesCount)return this;if(1===t.pipesCount)return e&&e!==t.pipes?this:(e||(e=t.pipes),t.pipes=null,t.pipesCount=0,t.flowing=!1,e&&e.emit("unpipe",this,n),this);if(!e){var r=t.pipes,o=t.pipesCount;t.pipes=null,t.pipesCount=0,t.flowing=!1;for(var i=0;i<o;i++)r[i].emit("unpipe",this,n);return this}var a=N(t.pipes,e);return-1===a?this:(t.pipes.splice(a,1),t.pipesCount-=1,1===t.pipesCount&&(t.pipes=t.pipes[0]),e.emit("unpipe",this,n),this)},b.prototype.on=function(e,t){var n=l.prototype.on.call(this,e,t);if("data"===e)!1!==this._readableState.flowing&&this.resume();else if("readable"===e){var r=this._readableState;r.endEmitted||r.readableListening||(r.readableListening=r.needReadable=!0,r.emittedReadable=!1,r.reading?r.length&&O(this):o.nextTick(j,this))}return n},b.prototype.addListener=b.prototype.on,b.prototype.resume=function(){var e=this._readableState;return e.flowing||(d("resume"),e.flowing=!0,function(e,t){t.resumeScheduled||(t.resumeScheduled=!0,o.nextTick(C,e,t))}(this,e)),this},b.prototype.pause=function(){return d("call pause flowing=%j",this._readableState.flowing),!1!==this._readableState.flowing&&(d("pause"),this._readableState.flowing=!1,this.emit("pause")),this},b.prototype.wrap=function(e){var t=this,n=this._readableState,r=!1;for(var o in e.on("end",(function(){if(d("wrapped end"),n.decoder&&!n.ended){var e=n.decoder.end();e&&e.length&&t.push(e)}t.push(null)})),e.on("data",(function(o){(d("wrapped data"),n.decoder&&(o=n.decoder.write(o)),n.objectMode&&null==o)||(n.objectMode||o&&o.length)&&(t.push(o)||(r=!0,e.pause()))})),e)void 0===this[o]&&"function"==typeof e[o]&&(this[o]=function(t){return function(){return e[t].apply(e,arguments)}}(o));for(var i=0;i<y.length;i++)e.on(y[i],this.emit.bind(this,y[i]));return this._read=function(t){d("wrapped _read",t),r&&(r=!1,e.resume())},this},Object.defineProperty(b.prototype,"readableHighWaterMark",{enumerable:!1,get:function(){return this._readableState.highWaterMark}}),b._fromList=A}).call(this,n(6),n(13))},function(e,t,n){"use strict";var r,o="object"==typeof Reflect?Reflect:null,i=o&&"function"==typeof o.apply?o.apply:function(e,t,n){return Function.prototype.apply.call(e,t,n)};r=o&&"function"==typeof o.ownKeys?o.ownKeys:Object.getOwnPropertySymbols?function(e){return Object.getOwnPropertyNames(e).concat(Object.getOwnPropertySymbols(e))}:function(e){return Object.getOwnPropertyNames(e)};var a=Number.isNaN||function(e){return e!=e};function s(){s.init.call(this)}e.exports=s,s.EventEmitter=s,s.prototype._events=void 0,s.prototype._eventsCount=0,s.prototype._maxListeners=void 0;var l=10;function c(e){return void 0===e._maxListeners?s.defaultMaxListeners:e._maxListeners}function u(e,t,n,r){var o,i,a,s;if("function"!=typeof n)throw new TypeError('The "listener" argument must be of type Function. Received type '+typeof n);if(void 0===(i=e._events)?(i=e._events=Object.create(null),e._eventsCount=0):(void 0!==i.newListener&&(e.emit("newListener",t,n.listener?n.listener:n),i=e._events),a=i[t]),void 0===a)a=i[t]=n,++e._eventsCount;else if("function"==typeof a?a=i[t]=r?[n,a]:[a,n]:r?a.unshift(n):a.push(n),(o=c(e))>0&&a.length>o&&!a.warned){a.warned=!0;var l=new Error("Possible EventEmitter memory leak detected. "+a.length+" "+String(t)+" listeners added. Use emitter.setMaxListeners() to increase limit");l.name="MaxListenersExceededWarning",l.emitter=e,l.type=t,l.count=a.length,s=l,console&&console.warn&&console.warn(s)}return e}function f(){for(var e=[],t=0;t<arguments.length;t++)e.push(arguments[t]);this.fired||(this.target.removeListener(this.type,this.wrapFn),this.fired=!0,i(this.listener,this.target,e))}function p(e,t,n){var r={fired:!1,wrapFn:void 0,target:e,type:t,listener:n},o=f.bind(r);return o.listener=n,r.wrapFn=o,o}function d(e,t,n){var r=e._events;if(void 0===r)return[];var o=r[t];return void 0===o?[]:"function"==typeof o?n?[o.listener||o]:[o]:n?function(e){for(var t=new Array(e.length),n=0;n<t.length;++n)t[n]=e[n].listener||e[n];return t}(o):m(o,o.length)}function h(e){var t=this._events;if(void 0!==t){var n=t[e];if("function"==typeof n)return 1;if(void 0!==n)return n.length}return 0}function m(e,t){for(var n=new Array(t),r=0;r<t;++r)n[r]=e[r];return n}Object.defineProperty(s,"defaultMaxListeners",{enumerable:!0,get:function(){return l},set:function(e){if("number"!=typeof e||e<0||a(e))throw new RangeError('The value of "defaultMaxListeners" is out of range. It must be a non-negative number. Received '+e+".");l=e}}),s.init=function(){void 0!==this._events&&this._events!==Object.getPrototypeOf(this)._events||(this._events=Object.create(null),this._eventsCount=0),this._maxListeners=this._maxListeners||void 0},s.prototype.setMaxListeners=function(e){if("number"!=typeof e||e<0||a(e))throw new RangeError('The value of "n" is out of range. It must be a non-negative number. Received '+e+".");return this._maxListeners=e,this},s.prototype.getMaxListeners=function(){return c(this)},s.prototype.emit=function(e){for(var t=[],n=1;n<arguments.length;n++)t.push(arguments[n]);var r="error"===e,o=this._events;if(void 0!==o)r=r&&void 0===o.error;else if(!r)return!1;if(r){var a;if(t.length>0&&(a=t[0]),a instanceof Error)throw a;var s=new Error("Unhandled error."+(a?" ("+a.message+")":""));throw s.context=a,s}var l=o[e];if(void 0===l)return!1;if("function"==typeof l)i(l,this,t);else{var c=l.length,u=m(l,c);for(n=0;n<c;++n)i(u[n],this,t)}return!0},s.prototype.addListener=function(e,t){return u(this,e,t,!1)},s.prototype.on=s.prototype.addListener,s.prototype.prependListener=function(e,t){return u(this,e,t,!0)},s.prototype.once=function(e,t){if("function"!=typeof t)throw new TypeError('The "listener" argument must be of type Function. Received type '+typeof t);return this.on(e,p(this,e,t)),this},s.prototype.prependOnceListener=function(e,t){if("function"!=typeof t)throw new TypeError('The "listener" argument must be of type Function. Received type '+typeof t);return this.prependListener(e,p(this,e,t)),this},s.prototype.removeListener=function(e,t){var n,r,o,i,a;if("function"!=typeof t)throw new TypeError('The "listener" argument must be of type Function. Received type '+typeof t);if(void 0===(r=this._events))return this;if(void 0===(n=r[e]))return this;if(n===t||n.listener===t)0==--this._eventsCount?this._events=Object.create(null):(delete r[e],r.removeListener&&this.emit("removeListener",e,n.listener||t));else if("function"!=typeof n){for(o=-1,i=n.length-1;i>=0;i--)if(n[i]===t||n[i].listener===t){a=n[i].listener,o=i;break}if(o<0)return this;0===o?n.shift():function(e,t){for(;t+1<e.length;t++)e[t]=e[t+1];e.pop()}(n,o),1===n.length&&(r[e]=n[0]),void 0!==r.removeListener&&this.emit("removeListener",e,a||t)}return this},s.prototype.off=s.prototype.removeListener,s.prototype.removeAllListeners=function(e){var t,n,r;if(void 0===(n=this._events))return this;if(void 0===n.removeListener)return 0===arguments.length?(this._events=Object.create(null),this._eventsCount=0):void 0!==n[e]&&(0==--this._eventsCount?this._events=Object.create(null):delete n[e]),this;if(0===arguments.length){var o,i=Object.keys(n);for(r=0;r<i.length;++r)"removeListener"!==(o=i[r])&&this.removeAllListeners(o);return this.removeAllListeners("removeListener"),this._events=Object.create(null),this._eventsCount=0,this}if("function"==typeof(t=n[e]))this.removeListener(e,t);else if(void 0!==t)for(r=t.length-1;r>=0;r--)this.removeListener(e,t[r]);return this},s.prototype.listeners=function(e){return d(this,e,!0)},s.prototype.rawListeners=function(e){return d(this,e,!1)},s.listenerCount=function(e,t){return"function"==typeof e.listenerCount?e.listenerCount(t):h.call(e,t)},s.prototype.listenerCount=h,s.prototype.eventNames=function(){return this._eventsCount>0?r(this._events):[]}},function(e,t,n){e.exports=n(137).EventEmitter},function(e,t,n){"use strict";var r=n(59);function o(e,t){e.emit("error",t)}e.exports={destroy:function(e,t){var n=this,i=this._readableState&&this._readableState.destroyed,a=this._writableState&&this._writableState.destroyed;return i||a?(t?t(e):!e||this._writableState&&this._writableState.errorEmitted||r.nextTick(o,this,e),this):(this._readableState&&(this._readableState.destroyed=!0),this._writableState&&(this._writableState.destroyed=!0),this._destroy(e||null,(function(e){!t&&e?(r.nextTick(o,n,e),n._writableState&&(n._writableState.errorEmitted=!0)):t&&t(e)})),this)},undestroy:function(){this._readableState&&(this._readableState.destroyed=!1,this._readableState.reading=!1,this._readableState.ended=!1,this._readableState.endEmitted=!1),this._writableState&&(this._writableState.destroyed=!1,this._writableState.ended=!1,this._writableState.ending=!1,this._writableState.finished=!1,this._writableState.errorEmitted=!1)}}},function(e,t,n){"use strict";(function(t,r,o){var i=n(59);function a(e){var t=this;this.next=null,this.entry=null,this.finish=function(){!function(e,t,n){var r=e.entry;e.entry=null;for(;r;){var o=r.callback;t.pendingcb--,o(n),r=r.next}t.corkedRequestsFree?t.corkedRequestsFree.next=e:t.corkedRequestsFree=e}(t,e)}}e.exports=v;var s,l=!t.browser&&["v0.10","v0.9."].indexOf(t.version.slice(0,5))>-1?r:i.nextTick;v.WritableState=y;var c=n(47);c.inherits=n(29);var u={deprecate:n(273)},f=n(138),p=n(88).Buffer,d=o.Uint8Array||function(){};var h,m=n(139);function g(){}function y(e,t){s=s||n(37),e=e||{};var r=t instanceof s;this.objectMode=!!e.objectMode,r&&(this.objectMode=this.objectMode||!!e.writableObjectMode);var o=e.highWaterMark,c=e.writableHighWaterMark,u=this.objectMode?16:16384;this.highWaterMark=o||0===o?o:r&&(c||0===c)?c:u,this.highWaterMark=Math.floor(this.highWaterMark),this.finalCalled=!1,this.needDrain=!1,this.ending=!1,this.ended=!1,this.finished=!1,this.destroyed=!1;var f=!1===e.decodeStrings;this.decodeStrings=!f,this.defaultEncoding=e.defaultEncoding||"utf8",this.length=0,this.writing=!1,this.corked=0,this.sync=!0,this.bufferProcessing=!1,this.onwrite=function(e){!function(e,t){var n=e._writableState,r=n.sync,o=n.writecb;if(function(e){e.writing=!1,e.writecb=null,e.length-=e.writelen,e.writelen=0}(n),t)!function(e,t,n,r,o){--t.pendingcb,n?(i.nextTick(o,r),i.nextTick(O,e,t),e._writableState.errorEmitted=!0,e.emit("error",r)):(o(r),e._writableState.errorEmitted=!0,e.emit("error",r),O(e,t))}(e,n,r,t,o);else{var a=k(n);a||n.corked||n.bufferProcessing||!n.bufferedRequest||x(e,n),r?l(w,e,n,a,o):w(e,n,a,o)}}(t,e)},this.writecb=null,this.writelen=0,this.bufferedRequest=null,this.lastBufferedRequest=null,this.pendingcb=0,this.prefinished=!1,this.errorEmitted=!1,this.bufferedRequestCount=0,this.corkedRequestsFree=new a(this)}function v(e){if(s=s||n(37),!(h.call(v,this)||this instanceof s))return new v(e);this._writableState=new y(e,this),this.writable=!0,e&&("function"==typeof e.write&&(this._write=e.write),"function"==typeof e.writev&&(this._writev=e.writev),"function"==typeof e.destroy&&(this._destroy=e.destroy),"function"==typeof e.final&&(this._final=e.final)),f.call(this)}function b(e,t,n,r,o,i,a){t.writelen=r,t.writecb=a,t.writing=!0,t.sync=!0,n?e._writev(o,t.onwrite):e._write(o,i,t.onwrite),t.sync=!1}function w(e,t,n,r){n||function(e,t){0===t.length&&t.needDrain&&(t.needDrain=!1,e.emit("drain"))}(e,t),t.pendingcb--,r(),O(e,t)}function x(e,t){t.bufferProcessing=!0;var n=t.bufferedRequest;if(e._writev&&n&&n.next){var r=t.bufferedRequestCount,o=new Array(r),i=t.corkedRequestsFree;i.entry=n;for(var s=0,l=!0;n;)o[s]=n,n.isBuf||(l=!1),n=n.next,s+=1;o.allBuffers=l,b(e,t,!0,t.length,o,"",i.finish),t.pendingcb++,t.lastBufferedRequest=null,i.next?(t.corkedRequestsFree=i.next,i.next=null):t.corkedRequestsFree=new a(t),t.bufferedRequestCount=0}else{for(;n;){var c=n.chunk,u=n.encoding,f=n.callback;if(b(e,t,!1,t.objectMode?1:c.length,c,u,f),n=n.next,t.bufferedRequestCount--,t.writing)break}null===n&&(t.lastBufferedRequest=null)}t.bufferedRequest=n,t.bufferProcessing=!1}function k(e){return e.ending&&0===e.length&&null===e.bufferedRequest&&!e.finished&&!e.writing}function E(e,t){e._final((function(n){t.pendingcb--,n&&e.emit("error",n),t.prefinished=!0,e.emit("prefinish"),O(e,t)}))}function O(e,t){var n=k(t);return n&&(!function(e,t){t.prefinished||t.finalCalled||("function"==typeof e._final?(t.pendingcb++,t.finalCalled=!0,i.nextTick(E,e,t)):(t.prefinished=!0,e.emit("prefinish")))}(e,t),0===t.pendingcb&&(t.finished=!0,e.emit("finish"))),n}c.inherits(v,f),y.prototype.getBuffer=function(){for(var e=this.bufferedRequest,t=[];e;)t.push(e),e=e.next;return t},function(){try{Object.defineProperty(y.prototype,"buffer",{get:u.deprecate((function(){return this.getBuffer()}),"_writableState.buffer is deprecated. Use _writableState.getBuffer instead.","DEP0003")})}catch(e){}}(),"function"==typeof Symbol&&Symbol.hasInstance&&"function"==typeof Function.prototype[Symbol.hasInstance]?(h=Function.prototype[Symbol.hasInstance],Object.defineProperty(v,Symbol.hasInstance,{value:function(e){return!!h.call(this,e)||this===v&&(e&&e._writableState instanceof y)}})):h=function(e){return e instanceof this},v.prototype.pipe=function(){this.emit("error",new Error("Cannot pipe, not readable"))},v.prototype.write=function(e,t,n){var r,o=this._writableState,a=!1,s=!o.objectMode&&(r=e,p.isBuffer(r)||r instanceof d);return s&&!p.isBuffer(e)&&(e=function(e){return p.from(e)}(e)),"function"==typeof t&&(n=t,t=null),s?t="buffer":t||(t=o.defaultEncoding),"function"!=typeof n&&(n=g),o.ended?function(e,t){var n=new Error("write after end");e.emit("error",n),i.nextTick(t,n)}(this,n):(s||function(e,t,n,r){var o=!0,a=!1;return null===n?a=new TypeError("May not write null values to stream"):"string"==typeof n||void 0===n||t.objectMode||(a=new TypeError("Invalid non-string/buffer chunk")),a&&(e.emit("error",a),i.nextTick(r,a),o=!1),o}(this,o,e,n))&&(o.pendingcb++,a=function(e,t,n,r,o,i){if(!n){var a=function(e,t,n){e.objectMode||!1===e.decodeStrings||"string"!=typeof t||(t=p.from(t,n));return t}(t,r,o);r!==a&&(n=!0,o="buffer",r=a)}var s=t.objectMode?1:r.length;t.length+=s;var l=t.length<t.highWaterMark;l||(t.needDrain=!0);if(t.writing||t.corked){var c=t.lastBufferedRequest;t.lastBufferedRequest={chunk:r,encoding:o,isBuf:n,callback:i,next:null},c?c.next=t.lastBufferedRequest:t.bufferedRequest=t.lastBufferedRequest,t.bufferedRequestCount+=1}else b(e,t,!1,s,r,o,i);return l}(this,o,s,e,t,n)),a},v.prototype.cork=function(){this._writableState.corked++},v.prototype.uncork=function(){var e=this._writableState;e.corked&&(e.corked--,e.writing||e.corked||e.finished||e.bufferProcessing||!e.bufferedRequest||x(this,e))},v.prototype.setDefaultEncoding=function(e){if("string"==typeof e&&(e=e.toLowerCase()),!(["hex","utf8","utf-8","ascii","binary","base64","ucs2","ucs-2","utf16le","utf-16le","raw"].indexOf((e+"").toLowerCase())>-1))throw new TypeError("Unknown encoding: "+e);return this._writableState.defaultEncoding=e,this},Object.defineProperty(v.prototype,"writableHighWaterMark",{enumerable:!1,get:function(){return this._writableState.highWaterMark}}),v.prototype._write=function(e,t,n){n(new Error("_write() is not implemented"))},v.prototype._writev=null,v.prototype.end=function(e,t,n){var r=this._writableState;"function"==typeof e?(n=e,e=null,t=null):"function"==typeof t&&(n=t,t=null),null!=e&&this.write(e,t),r.corked&&(r.corked=1,this.uncork()),r.ending||r.finished||function(e,t,n){t.ending=!0,O(e,t),n&&(t.finished?i.nextTick(n):e.once("finish",n));t.ended=!0,e.writable=!1}(this,r,n)},Object.defineProperty(v.prototype,"destroyed",{get:function(){return void 0!==this._writableState&&this._writableState.destroyed},set:function(e){this._writableState&&(this._writableState.destroyed=e)}}),v.prototype.destroy=m.destroy,v.prototype._undestroy=m.undestroy,v.prototype._destroy=function(e,t){this.end(),t(e)}}).call(this,n(13),n(271).setImmediate,n(6))},function(e,t,n){"use strict";var r=n(274).Buffer,o=r.isEncoding||function(e){switch((e=""+e)&&e.toLowerCase()){case"hex":case"utf8":case"utf-8":case"ascii":case"binary":case"base64":case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":case"raw":return!0;default:return!1}};function i(e){var t;switch(this.encoding=function(e){var t=function(e){if(!e)return"utf8";for(var t;;)switch(e){case"utf8":case"utf-8":return"utf8";case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return"utf16le";case"latin1":case"binary":return"latin1";case"base64":case"ascii":case"hex":return e;default:if(t)return;e=(""+e).toLowerCase(),t=!0}}(e);if("string"!=typeof t&&(r.isEncoding===o||!o(e)))throw new Error("Unknown encoding: "+e);return t||e}(e),this.encoding){case"utf16le":this.text=l,this.end=c,t=4;break;case"utf8":this.fillLast=s,t=4;break;case"base64":this.text=u,this.end=f,t=3;break;default:return this.write=p,void(this.end=d)}this.lastNeed=0,this.lastTotal=0,this.lastChar=r.allocUnsafe(t)}function a(e){return e<=127?0:e>>5==6?2:e>>4==14?3:e>>3==30?4:e>>6==2?-1:-2}function s(e){var t=this.lastTotal-this.lastNeed,n=function(e,t,n){if(128!=(192&t[0]))return e.lastNeed=0,"<22>";if(e.lastNeed>1&&t.length>1){if(128!=(192&t[1]))return e.lastNeed=1,"<22>";if(e.lastNeed>2&&t.length>2&&128!=(192&t[2]))return e.lastNeed=2,"<22>"}}(this,e);return void 0!==n?n:this.lastNeed<=e.length?(e.copy(this.lastChar,t,0,this.lastNeed),this.lastChar.toString(this.encoding,0,this.lastTotal)):(e.copy(this.lastChar,t,0,e.length),void(this.lastNeed-=e.length))}function l(e,t){if((e.length-t)%2==0){var n=e.toString("utf16le",t);if(n){var r=n.charCodeAt(n.length-1);if(r>=55296&&r<=56319)return this.lastNeed=2,this.lastTotal=4,this.lastChar[0]=e[e.length-2],this.lastChar[1]=e[e.length-1],n.slice(0,-1)}return n}return this.lastNeed=1,this.lastTotal=2,this.lastChar[0]=e[e.length-1],e.toString("utf16le",t,e.length-1)}function c(e){var t=e&&e.length?this.write(e):"";if(this.lastNeed){var n=this.lastTotal-this.lastNeed;return t+this.lastChar.toString("utf16le",0,n)}return t}function u(e,t){var n=(e.length-t)%3;return 0===n?e.toString("base64",t):(this.lastNeed=3-n,this.lastTotal=3,1===n?this.lastChar[0]=e[e.length-1]:(this.lastChar[0]=e[e.length-2],this.lastChar[1]=e[e.length-1]),e.toString("base64",t,e.length-n))}function f(e){var t=e&&e.length?this.write(e):"";return this.lastNeed?t+this.lastChar.toString("base64",0,3-this.lastNeed):t}function p(e){return e.toString(this.encoding)}function d(e){return e&&e.length?this.write(e):""}t.StringDecoder=i,i.prototype.write=function(e){if(0===e.length)return"";var t,n;if(this.lastNeed){if(void 0===(t=this.fillLast(e)))return"";n=this.lastNeed,this.lastNeed=0}else n=0;return n<e.length?t?t+this.text(e,n):this.text(e,n):t||""},i.prototype.end=function(e){var t=e&&e.length?this.write(e):"";return this.lastNeed?t+"<22>":t},i.prototype.text=function(e,t){var n=function(e,t,n){var r=t.length-1;if(r<n)return 0;var o=a(t[r]);if(o>=0)return o>0&&(e.lastNeed=o-1),o;if(--r<n||-2===o)return 0;if((o=a(t[r]))>=0)return o>0&&(e.lastNeed=o-2),o;if(--r<n||-2===o)return 0;if((o=a(t[r]))>=0)return o>0&&(2===o?o=0:e.lastNeed=o-3),o;return 0}(this,e,t);if(!this.lastNeed)return e.toString("utf8",t);this.lastTotal=n;var r=e.length-(n-this.lastNeed);return e.copy(this.lastChar,0,r),e.toString("utf8",t,r)},i.prototype.fillLast=function(e){if(this.lastNeed<=e.length)return e.copy(this.lastChar,this.lastTotal-this.lastNeed,0,this.lastNeed),this.lastChar.toString(this.encoding,0,this.lastTotal);e.copy(this.lastChar,this.lastTotal-this.lastNeed,0,e.length),this.lastNeed-=e.length}},function(e,t,n){"use strict";e.exports=a;var r=n(37),o=n(47);function i(e,t){var n=this._transformState;n.transforming=!1;var r=n.writecb;if(!r)return this.emit("error",new Error("write callback called multiple times"));n.writechunk=null,n.writecb=null,null!=t&&this.push(t),r(e);var o=this._readableState;o.reading=!1,(o.needReadable||o.length<o.highWaterMark)&&this._read(o.highWaterMark)}function a(e){if(!(this instanceof a))return new a(e);r.call(this,e),this._transformState={afterTransform:i.bind(this),needTransform:!1,transforming:!1,writecb:null,writechunk:null,writeencoding:null},this._readableState.needReadable=!0,this._readableState.sync=!1,e&&("function"==typeof e.transform&&(this._transform=e.transform),"function"==typeof e.flush&&(this._flush=e.flush)),this.on("prefinish",s)}function s(){var e=this;"function"==typeof this._flush?this._flush((function(t,n){l(e,t,n)})):l(this,null,null)}function l(e,t,n){if(t)return e.emit("error",t);if(null!=n&&e.push(n),e._writableState.length)throw new Error("Calling transform done when ws.length != 0");if(e._transformState.transforming)throw new Error("Calling transform done when still transforming");return e.push(null)}o.inherits=n(29),o.inherits(a,r),a.prototype.push=function(e,t){return this._transformState.needTransform=!1,r.prototype.push.call(this,e,t)},a.prototype._transform=function(e,t,n){throw new Error("_transform() is not implemented")},a.prototype._write=function(e,t,n){var r=this._transformState;if(r.writecb=n,r.writechunk=e,r.writeencoding=t,!r.transforming){var o=this._readableState;(r.needTransform||o.needReadable||o.length<o.highWaterMark)&&this._read(o.highWaterMark)}},a.prototype._read=function(e){var t=this._transformState;null!==t.writechunk&&t.writecb&&!t.transforming?(t.transforming=!0,this._transform(t.writechunk,t.writeencoding,t.afterTransform)):t.needTransform=!0},a.prototype._destroy=function(e,t){var n=this;r.prototype._destroy.call(this,e,(function(e){t(e),n.emit("close")}))}},function(e,t,n){"use strict";(function(t){var r=n(28),o=n(24),i=n(281);e.exports=function(e,n,a){try{e=o.stripHash(e);var s=n._add(e),l={url:e,extension:o.getExtension(e)};return function(e,t){return new Promise((function(n,o){var a=i.all(t.resolve);a=i.filter(a,"canRead",e),i.sort(a),i.run(a,"read",e).then(n,(function(t){!t||t instanceof SyntaxError?o(r.syntax('Unable to resolve $ref pointer "%s"',e.url)):o(t)}))}))}(l,a).then((function(e){return s.pathType=e.plugin.name,l.data=e.result,function(e,n){return new Promise((function(o,a){var s=i.all(n.parse),l=i.filter(s,"canParse",e),c=l.length>0?l:s;i.sort(c),i.run(c,"parse",e).then((function(n){!n.plugin.allowEmpty&&(i=n.result,void 0===i||"object"==typeof i&&0===Object.keys(i).length||"string"==typeof i&&0===i.trim().length||t.isBuffer(i)&&0===i.length)?a(r.syntax('Error parsing "%s" as %s. \nParsed value is empty',e.url,n.plugin.name)):o(n);var i}),(function(t){t?(t=t instanceof Error?t:new Error(t),a(r.syntax(t,"Error parsing %s",e.url))):a(r.syntax("Unable to parse %s",e.url))}))}))}(l,a)})).then((function(e){return s.value=e.result,e.result}))}catch(e){return Promise.reject(e)}}}).call(this,n(11).Buffer)},function(e,t,n){"use strict";(function(t,n){var r=t.process&&n.nextTick||t.setImmediate||function(e){setTimeout(e,0)};e.exports=function(e,t){return e?void t.then((function(t){r((function(){e(null,t)}))}),(function(t){r((function(){e(t)}))})):t}}).call(this,n(6),n(13))},function(e,t){},function(e,t,n){"use strict";(function(t){var r=n(48),o=t.env.NODE_DISABLE_COLORS?{red:"",yellow:"",green:"",normal:""}:{red:"[31m",yellow:"[33;1m",green:"[32m",normal:"[0m"};function i(e){for(var t=[],n=function(e){t.find((function(t,n,o){return function(e,t){function n(e,t){return r.stringify(e)===r.stringify(Object.assign({},e,t))}return n(e,t)&&n(t,e)}(t,e)}))||t.push(e)},o=0,i=e;o<i.length;o++){n(i[o])}return t}String.prototype.toCamelCase=function(){return this.toLowerCase().replace(/[-_ \/\.](.)/g,(function(e,t){return t.toUpperCase()}))};function a(e){var t=(e=e.replace("[]","Array")).split("/");return t[0]=t[0].replace(/[^A-Za-z0-9_\-\.]+|\s+/gm,"_"),t.join("/")}e.exports={colour:o,uniqueOnly:function(e,t,n){return n.indexOf(e)===t},hasDuplicates:function(e){return new Set(e).size!==e.length},allSame:function(e){return new Set(e).size<=1},distinctArray:function(e){return e.length===i(e).length},firstDupe:function(e){return e.find((function(t,n,r){return e.indexOf(t)<n}))},hash:function(e){var t=0;if(0===e.length)return t;for(var n=0;n<e.length;n++)t=(t<<5)-t+e.charCodeAt(n),t|=0;return t},parameterTypeProperties:["format","minimum","maximum","exclusiveMinimum","exclusiveMaximum","minLength","maxLength","multipleOf","minItems","maxItems","uniqueItems","minProperties","maxProperties","additionalProperties","pattern","enum","default"],arrayProperties:["items","minItems","maxItems","uniqueItems"],httpMethods:["get","post","put","delete","patch","head","options","trace"],sanitise:a,sanitiseAll:function(e){return a(e.split("/").join("_"))}}}).call(this,n(13))},function(e,t){e.exports=function(){}},function(e,t,n){var r;r=function(){var e=JSON.parse('{"$":"dollar","%":"percent","&":"and","<":"less",">":"greater","|":"or","¢":"cent","£":"pound","¤":"currency","¥":"yen","©":"(c)","ª":"a","®":"(r)","º":"o","À":"A","Á":"A","Â":"A","Ã":"A","Ä":"A","Å":"A","Æ":"AE","Ç":"C","È":"E","É":"E","Ê":"E","Ë":"E","Ì":"I","Í":"I","Î":"I","Ï":"I","Ð":"D","Ñ":"N","Ò":"O","Ó":"O","Ô":"O","Õ":"O","Ö":"O","Ø":"O","Ù":"U","Ú":"U","Û":"U","Ü":"U","Ý":"Y","Þ":"TH","ß":"ss","à":"a","á":"a","â":"a","ã":"a","ä":"a","å":"a","æ":"ae","ç":"c","è":"e","é":"e","ê":"e","ë":"e","ì":"i","í":"i","î":"i","ï":"i","ð":"d","ñ":"n","ò":"o","ó":"o","ô":"o","õ":"o","ö":"o","ø":"o","ù":"u","ú":"u","û":"u","ü":"u","ý":"y","þ":"th","ÿ":"y","Ā":"A","ā":"a","Ă":"A","ă":"a","Ą":"A","ą":"a","Ć":"C","ć":"c","Č":"C","č":"c","Ď":"D","ď":"d","Đ":"DJ","đ":"dj","Ē":"E","ē":"e","Ė":"E","ė":"e","Ę":"e","ę":"e","Ě":"E","ě":"e","Ğ":"G","ğ":"g","Ģ":"G","ģ":"g","Ĩ":"I","ĩ":"i","Ī":"i","ī":"i","Į":"I","į":"i","İ":"I","ı":"i","Ķ":"k","ķ":"k","Ļ":"L","ļ":"l","Ľ":"L","ľ":"l","Ł":"L","ł":"l","Ń":"N","ń":"n","Ņ":"N","ņ":"n","Ň":"N","ň":"n","Ő":"O","ő":"o","Œ":"OE","œ":"oe","Ŕ":"R","ŕ":"r","Ř":"R","ř":"r","Ś":"S","ś":"s","Ş":"S","ş":"s","Š":"S","š":"s","Ţ":"T","ţ":"t","Ť":"T","ť":"t","Ũ":"U","ũ":"u","Ū":"u","ū":"u","Ů":"U","ů":"u","Ű":"U","ű":"u","Ų":"U","ų":"u","Ŵ":"W","ŵ":"w","Ŷ":"Y","ŷ":"y","Ÿ":"Y","Ź":"Z","ź":"z","Ż":"Z","ż":"z","Ž":"Z","ž":"z","ƒ":"f","Ơ":"O","ơ":"o","Ư":"U","ư":"u","Lj":"LJ","lj":"lj","Nj":"NJ","nj":"nj","Ș":"S","ș":"s","Ț":"T","ț":"t","˚":"o","Ά":"A","Έ":"E","Ή":"H","Ί":"I","Ό":"O","Ύ":"Y","Ώ":"W","ΐ":"i","Α":"A","Β":"B","Γ":"G","Δ":"D","Ε":"E","Ζ":"Z","Η":"H","Θ":"8","Ι":"I","Κ":"K","Λ":"L","Μ":"M","Ν":"N","Ξ":"3","Ο":"O","Π":"P","Ρ":"R","Σ":"S","Τ":"T","Υ":"Y","Φ":"F","Χ":"X","Ψ":"PS","Ω":"W","Ϊ":"I","Ϋ":"Y","ά":"a","έ":"e","ή":"h","ί":"i","ΰ":"y","α":"a","β":"b","γ":"g","δ":"d","ε":"e","ζ":"z","η":"h","θ":"8","ι":"i","κ":"k","λ":"l","μ":"m","ν":"n","ξ":"3","ο":"o","π":"p","ρ":"r","ς":"s","σ":"s","τ":"t","υ":"y","φ":"f","χ":"x","ψ":"ps","ω":"w","ϊ":"i","ϋ":"y","ό":"o","ύ":"y","ώ":"w","Ё":"Yo","Ђ":"DJ","Є":"Ye","І":"I","Ї":"Yi","Ј":"J","Љ":"LJ","Њ":"NJ","Ћ":"C","Џ":"DZ","А":"A","Б":"B","В":"V","Г":"G","Д":"D","Е":"E","Ж":"Zh","З":"Z","И":"I","Й":"J","К":"K","Л":"L","М":"M","Н":"N","О":"O","П":"P","Р":"R","С":"S","Т":"T","У":"U","Ф":"F","Х":"H","Ц":"C","Ч":"Ch","Ш":"Sh","Щ":"Sh","Ъ":"U","Ы":"Y","Ь":"","Э":"E","Ю":"Yu","Я":"Ya","а":"a","б":"b","в":"v","г":"g","д":"d","е":"e","ж":"zh","з":"z","и":"i","й":"j","к":"k","л":"l","м":"m","н":"n","о":"o","п":"p","р":"r","с":"s","т":"t","у":"u","ф":"f","х":"h","ц":"c","ч":"ch","ш":"sh","щ":"sh","ъ":"u","ы":"y","ь":"","э":"e","ю":"yu","я":"ya","ё":"yo","ђ":"dj","є":"ye","і":"i","ї":"yi","ј":"j","љ":"lj","њ":"nj","ћ":"c","ѝ":"u","џ":"dz","Ґ":"G","ґ":"g","Ғ":"GH","ғ":"gh","Қ":"KH","қ":"kh","Ң":"NG","ң":"ng","Ү":"UE","ү":"ue","Ұ":"U","ұ":"u","Һ":"H","һ":"h","Ә":"AE","ә":"ae","Ө":"OE","ө":"oe","฿":"baht","ა":"a","ბ":"b","გ":"g","დ":"d","ე":"e","ვ":"v","ზ":"z","თ":"t","ი":"i","კ":"k","ლ":"l","მ":"m","ნ":"n","ო":"o","პ":"p","ჟ":"zh","რ":"r","ს":"s","ტ":"t","უ":"u","ფ":"f","ქ":"k","ღ":"gh","ყ":"q","შ":"sh","ჩ":"ch","ც":"ts","ძ":"dz","წ":"ts","ჭ":"ch","ხ":"kh","ჯ":"j","ჰ":"h","Ẁ":"W","ẁ":"w","Ẃ":"W","ẃ":"w","Ẅ":"W","ẅ":"w","ẞ":"SS","Ạ":"A","ạ":"a","Ả":"A","ả":"a","Ấ":"A","ấ":"a","Ầ":"A","ầ":"a","Ẩ":"A","ẩ":"a","Ẫ":"A","ẫ":"a","Ậ":"A","ậ":"a","Ắ":"A","ắ":"a","Ằ":"A","ằ":"a","Ẳ":"A","ẳ":"a","Ẵ":"A","ẵ":"a","Ặ":"A","ặ":"a","Ẹ":"E","ẹ":"e","Ẻ":"E","ẻ":"e","Ẽ":"E","ẽ":"e","Ế":"E","ế":"e","Ề":"E","ề":"e","Ể":"E","ể":"e","Ễ":"E","ễ":"e","Ệ":"E","ệ":"e","Ỉ":"I","ỉ":"i","Ị":"I","ị":"i","Ọ":"O","ọ":"o","Ỏ":"O","ỏ":"o","Ố":"O","ố":"o","Ồ":"O","ồ":"o","Ổ":"O","ổ":"o","Ỗ":"O","ỗ":"o","Ộ":"O","ộ":"o","Ớ":"O","ớ":"o","Ờ":"O","ờ":"o","Ở":"O","ở":"o","Ỡ":"O","ỡ":"o","Ợ":"O","ợ":"o","Ụ":"U","ụ":"u","Ủ":"U","ủ":"u","Ứ":"U","ứ":"u","Ừ":"U","ừ":"u","Ử":"U","ử":"u","Ữ":"U","ữ":"u","Ự":"U","ự":"u","Ỳ":"Y","ỳ":"y","Ỵ":"Y","ỵ":"y","Ỷ":"Y","ỷ":"y","Ỹ":"Y","ỹ":"y","‘":"\'","’":"\'","“":"\\"","”":"\\"","†":"+","•":"*","…":"...","₠":"ecu","₢":"cruzeiro","₣":"french franc","₤":"lira","₥":"mill","₦":"naira","₧":"peseta","₨":"rupee","₩":"won","₪":"new shequel","₫":"dong","€":"euro","₭":"kip","₮":"tugrik","₯":"drachma","₰":"penny","₱":"peso","₲":"guarani","₳":"austral","₴":"hryvnia","₵":"cedi","₸":"kazakhstani tenge","₹":"indian rupee","₽":"russian ruble","₿":"bitcoin","℠":"sm","™":"tm","∂":"d","∆":"delta","∑":"sum","∞":"infinity","♥":"love","元":"yuan","円":"yen","﷼":"rial"}'),t=JSON.parse('{"vi":{"Đ":"D","đ":"d"}}');function n(n,r){if("string"!=typeof n)throw new Error("slugify: string argument expected");var o=t[(r="string"==typeof r?{replacement:r}:r||{}).locale]||{},i=n.split("").reduce((function(t,n){return t+(o[n]||e[n]||n).replace(r.remove||/[^\w\s$*_+~.()'"!\-:@]/g,"")}),"").trim().replace(/[-\s]+/g,r.replacement||"-");return r.lower?i.toLowerCase():i}return n.extend=function(t){for(var n in t)e[n]=t[n]},n},e.exports=r(),e.exports.default=r()},function(e,t,n){"use strict";n.r(t),function(e){n.d(t,"createGlobalStyle",(function(){return ot})),n.d(t,"css",(function(){return we})),n.d(t,"isStyledComponent",(function(){return T})),n.d(t,"keyframes",(function(){return at})),n.d(t,"ServerStyleSheet",(function(){return Qe})),n.d(t,"StyleSheetConsumer",(function(){return Ke})),n.d(t,"StyleSheetContext",(function(){return Xe})),n.d(t,"StyleSheetManager",(function(){return Je})),n.d(t,"ThemeConsumer",(function(){return Ye})),n.d(t,"ThemeContext",(function(){return Ve})),n.d(t,"ThemeProvider",(function(){return Ge})),n.d(t,"withTheme",(function(){return st})),n.d(t,"__DO_NOT_USE_OR_YOU_WILL_BE_HAUNTED_BY_SPOOKY_GHOSTS",(function(){return lt}));var r=n(92),o=n.n(r),i=n(150),a=n.n(i),s=n(0),l=n.n(s),c=n(151),u=n(93),f=n(94),p=(n(16),n(157)),d=n(158),h=function(e,t){for(var n=[e[0]],r=0,o=t.length;r<o;r+=1)n.push(t[r],e[r+1]);return n},m="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},g=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},y=function(){function e(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)}}return function(t,n,r){return n&&e(t.prototype,n),r&&e(t,r),t}}(),v=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e},b=function(e,t){if("function"!=typeof t&&null!==t)throw new TypeError("Super expression must either be null or a function, not "+typeof t);e.prototype=Object.create(t&&t.prototype,{constructor:{value:e,enumerable:!1,writable:!0,configurable:!0}}),t&&(Object.setPrototypeOf?Object.setPrototypeOf(e,t):e.__proto__=t)},w=function(e,t){var n={};for(var r in e)t.indexOf(r)>=0||Object.prototype.hasOwnProperty.call(e,r)&&(n[r]=e[r]);return n},x=function(e,t){if(!e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return!t||"object"!=typeof t&&"function"!=typeof t?e:t},k=function(e){return"object"===(void 0===e?"undefined":m(e))&&e.constructor===Object},E=Object.freeze([]),O=Object.freeze({});function _(e){return"function"==typeof e}function S(e){return e.displayName||e.name||"Component"}function T(e){return e&&"string"==typeof e.styledComponentId}var j=void 0!==e&&(e.env.REACT_APP_SC_ATTR||e.env.SC_ATTR)||"data-styled",C="undefined"!=typeof window&&"HTMLElement"in window,I="boolean"==typeof SC_DISABLE_SPEEDY&&SC_DISABLE_SPEEDY||void 0!==e&&(e.env.REACT_APP_SC_DISABLE_SPEEDY||e.env.SC_DISABLE_SPEEDY)||!1,A={};var P=function(e){function t(n){g(this,t);for(var r=arguments.length,o=Array(r>1?r-1:0),i=1;i<r;i++)o[i-1]=arguments[i];var a=x(this,e.call(this,"An error occurred. See https://github.com/styled-components/styled-components/blob/master/packages/styled-components/src/utils/errors.md#"+n+" for more information."+(o.length>0?" Additional arguments: "+o.join(", "):"")));return x(a)}return b(t,e),t}(Error),R=/^[^\S\n]*?\/\* sc-component-id:\s*(\S+)\s+\*\//gm,N=function(e){var t=""+(e||""),n=[];return t.replace(R,(function(e,t,r){return n.push({componentId:t,matchIndex:r}),e})),n.map((function(e,r){var o=e.componentId,i=e.matchIndex,a=n[r+1];return{componentId:o,cssFromDOM:a?t.slice(i,a.matchIndex):t.slice(i)}}))},L=/^\s*\/\/.*$/gm,M=new o.a({global:!1,cascade:!0,keyframe:!1,prefix:!1,compress:!1,semicolon:!0}),D=new o.a({global:!1,cascade:!0,keyframe:!1,prefix:!0,compress:!1,semicolon:!1}),F=[],U=function(e){if(-2===e){var t=F;return F=[],t}},z=a()((function(e){F.push(e)})),B=void 0,$=void 0,q=void 0,W=function(e,t,n){return t>0&&-1!==n.slice(0,t).indexOf($)&&n.slice(t-$.length,t)!==$?"."+B:e};D.use([function(e,t,n){2===e&&n.length&&n[0].lastIndexOf($)>0&&(n[0]=n[0].replace(q,W))},z,U]),M.use([z,U]);var H=function(e){return M("",e)};function V(e,t,n){var r=arguments.length>3&&void 0!==arguments[3]?arguments[3]:"&",o=e.join("").replace(L,""),i=t&&n?n+" "+t+" { "+o+" }":o;return B=r,$=t,q=new RegExp("\\"+$+"\\b","g"),D(n||!t?"":t,i)}var Y=function(){return n.nc},G=function(e,t,n){n&&((e[t]||(e[t]=Object.create(null)))[n]=!0)},Q=function(e,t){e[t]=Object.create(null)},X=function(e){return function(t,n){return void 0!==e[t]&&e[t][n]}},K=function(e){var t="";for(var n in e)t+=Object.keys(e[n]).join(" ")+" ";return t.trim()},J=function(e){if(e.sheet)return e.sheet;for(var t=e.ownerDocument.styleSheets.length,n=0;n<t;n+=1){var r=e.ownerDocument.styleSheets[n];if(r.ownerNode===e)return r}throw new P(10)},Z=function(e,t,n){if(!t)return!1;var r=e.cssRules.length;try{e.insertRule(t,n<=r?n:r)}catch(e){return!1}return!0},ee=function(e){return"\n/* sc-component-id: "+e+" */\n"},te=function(e,t){for(var n=0,r=0;r<=t;r+=1)n+=e[r];return n},ne=function(e,t){return function(n){var r=Y();return"<style "+[r&&'nonce="'+r+'"',j+'="'+K(t)+'"','data-styled-version="4.4.1"',n].filter(Boolean).join(" ")+">"+e()+"</style>"}},re=function(e,t){return function(){var n,r=((n={})[j]=K(t),n["data-styled-version"]="4.4.1",n),o=Y();return o&&(r.nonce=o),l.a.createElement("style",v({},r,{dangerouslySetInnerHTML:{__html:e()}}))}},oe=function(e){return function(){return Object.keys(e)}},ie=function(e,t){return e.createTextNode(ee(t))},ae=function e(t,n){var r=void 0===t?Object.create(null):t,o=void 0===n?Object.create(null):n,i=function(e){var t=o[e];return void 0!==t?t:o[e]=[""]},a=function(){var e="";for(var t in o){var n=o[t][0];n&&(e+=ee(t)+n)}return e};return{clone:function(){var t=function(e){var t=Object.create(null);for(var n in e)t[n]=v({},e[n]);return t}(r),n=Object.create(null);for(var i in o)n[i]=[o[i][0]];return e(t,n)},css:a,getIds:oe(o),hasNameForId:X(r),insertMarker:i,insertRules:function(e,t,n){i(e)[0]+=t.join(" "),G(r,e,n)},removeRules:function(e){var t=o[e];void 0!==t&&(t[0]="",Q(r,e))},sealed:!1,styleTag:null,toElement:re(a,r),toHTML:ne(a,r)}},se=function(e,t,n,r,o){if(C&&!n){var i=function(e,t,n){var r=document;e?r=e.ownerDocument:t&&(r=t.ownerDocument);var o=r.createElement("style");o.setAttribute(j,""),o.setAttribute("data-styled-version","4.4.1");var i=Y();if(i&&o.setAttribute("nonce",i),o.appendChild(r.createTextNode("")),e&&!t)e.appendChild(o);else{if(!t||!e||!t.parentNode)throw new P(6);t.parentNode.insertBefore(o,n?t:t.nextSibling)}return o}(e,t,r);return I?function(e,t){var n=Object.create(null),r=Object.create(null),o=void 0!==t,i=!1,a=function(t){var o=r[t];return void 0!==o?o:(r[t]=ie(e.ownerDocument,t),e.appendChild(r[t]),n[t]=Object.create(null),r[t])},s=function(){var e="";for(var t in r)e+=r[t].data;return e};return{clone:function(){throw new P(5)},css:s,getIds:oe(r),hasNameForId:X(n),insertMarker:a,insertRules:function(e,r,s){for(var l=a(e),c=[],u=r.length,f=0;f<u;f+=1){var p=r[f],d=o;if(d&&-1!==p.indexOf("@import"))c.push(p);else{d=!1;var h=f===u-1?"":" ";l.appendData(""+p+h)}}G(n,e,s),o&&c.length>0&&(i=!0,t().insertRules(e+"-import",c))},removeRules:function(a){var s=r[a];if(void 0!==s){var l=ie(e.ownerDocument,a);e.replaceChild(l,s),r[a]=l,Q(n,a),o&&i&&t().removeRules(a+"-import")}},sealed:!1,styleTag:e,toElement:re(s,n),toHTML:ne(s,n)}}(i,o):function(e,t){var n=Object.create(null),r=Object.create(null),o=[],i=void 0!==t,a=!1,s=function(e){var t=r[e];return void 0!==t?t:(r[e]=o.length,o.push(0),Q(n,e),r[e])},l=function(){var t=J(e).cssRules,n="";for(var i in r){n+=ee(i);for(var a=r[i],s=te(o,a),l=s-o[a];l<s;l+=1){var c=t[l];void 0!==c&&(n+=c.cssText)}}return n};return{clone:function(){throw new P(5)},css:l,getIds:oe(r),hasNameForId:X(n),insertMarker:s,insertRules:function(r,l,c){for(var u=s(r),f=J(e),p=te(o,u),d=0,h=[],m=l.length,g=0;g<m;g+=1){var y=l[g],v=i;v&&-1!==y.indexOf("@import")?h.push(y):Z(f,y,p+d)&&(v=!1,d+=1)}i&&h.length>0&&(a=!0,t().insertRules(r+"-import",h)),o[u]+=d,G(n,r,c)},removeRules:function(s){var l=r[s];if(void 0!==l&&!1!==e.isConnected){var c=o[l];!function(e,t,n){for(var r=t-n,o=t;o>r;o-=1)e.deleteRule(o)}(J(e),te(o,l)-1,c),o[l]=0,Q(n,s),i&&a&&t().removeRules(s+"-import")}},sealed:!1,styleTag:e,toElement:re(l,n),toHTML:ne(l,n)}}(i,o)}return ae()},le=/\s+/,ce=void 0;ce=C?I?40:1e3:-1;var ue=0,fe=void 0,pe=function(){function e(){var t=this,n=arguments.length>0&&void 0!==arguments[0]?arguments[0]:C?document.head:null,r=arguments.length>1&&void 0!==arguments[1]&&arguments[1];g(this,e),this.getImportRuleTag=function(){var e=t.importRuleTag;if(void 0!==e)return e;var n=t.tags[0];return t.importRuleTag=se(t.target,n?n.styleTag:null,t.forceServer,!0)},ue+=1,this.id=ue,this.forceServer=r,this.target=r?null:n,this.tagMap={},this.deferred={},this.rehydratedNames={},this.ignoreRehydratedNames={},this.tags=[],this.capacity=1,this.clones=[]}return e.prototype.rehydrate=function(){if(!C||this.forceServer)return this;var e=[],t=[],n=!1,r=document.querySelectorAll("style["+j+'][data-styled-version="4.4.1"]'),o=r.length;if(!o)return this;for(var i=0;i<o;i+=1){var a=r[i];n||(n=!!a.getAttribute("data-styled-streamed"));for(var s,l=(a.getAttribute(j)||"").trim().split(le),c=l.length,u=0;u<c;u+=1)s=l[u],this.rehydratedNames[s]=!0;t.push.apply(t,N(a.textContent)),e.push(a)}var f=t.length;if(!f)return this;var p=this.makeTag(null);!function(e,t,n){for(var r=0,o=n.length;r<o;r+=1){var i=n[r],a=i.componentId,s=i.cssFromDOM,l=H(s);e.insertRules(a,l)}for(var c=0,u=t.length;c<u;c+=1){var f=t[c];f.parentNode&&f.parentNode.removeChild(f)}}(p,e,t),this.capacity=Math.max(1,ce-f),this.tags.push(p);for(var d=0;d<f;d+=1)this.tagMap[t[d].componentId]=p;return this},e.reset=function(){var t=arguments.length>0&&void 0!==arguments[0]&&arguments[0];fe=new e(void 0,t).rehydrate()},e.prototype.clone=function(){var t=new e(this.target,this.forceServer);return this.clones.push(t),t.tags=this.tags.map((function(e){for(var n=e.getIds(),r=e.clone(),o=0;o<n.length;o+=1)t.tagMap[n[o]]=r;return r})),t.rehydratedNames=v({},this.rehydratedNames),t.deferred=v({},this.deferred),t},e.prototype.sealAllTags=function(){this.capacity=1,this.tags.forEach((function(e){e.sealed=!0}))},e.prototype.makeTag=function(e){var t=e?e.styleTag:null;return se(this.target,t,this.forceServer,!1,this.getImportRuleTag)},e.prototype.getTagForId=function(e){var t=this.tagMap[e];if(void 0!==t&&!t.sealed)return t;var n=this.tags[this.tags.length-1];return this.capacity-=1,0===this.capacity&&(this.capacity=ce,n=this.makeTag(n),this.tags.push(n)),this.tagMap[e]=n},e.prototype.hasId=function(e){return void 0!==this.tagMap[e]},e.prototype.hasNameForId=function(e,t){if(void 0===this.ignoreRehydratedNames[e]&&this.rehydratedNames[t])return!0;var n=this.tagMap[e];return void 0!==n&&n.hasNameForId(e,t)},e.prototype.deferredInject=function(e,t){if(void 0===this.tagMap[e]){for(var n=this.clones,r=0;r<n.length;r+=1)n[r].deferredInject(e,t);this.getTagForId(e).insertMarker(e),this.deferred[e]=t}},e.prototype.inject=function(e,t,n){for(var r=this.clones,o=0;o<r.length;o+=1)r[o].inject(e,t,n);var i=this.getTagForId(e);if(void 0!==this.deferred[e]){var a=this.deferred[e].concat(t);i.insertRules(e,a,n),this.deferred[e]=void 0}else i.insertRules(e,t,n)},e.prototype.remove=function(e){var t=this.tagMap[e];if(void 0!==t){for(var n=this.clones,r=0;r<n.length;r+=1)n[r].remove(e);t.removeRules(e),this.ignoreRehydratedNames[e]=!0,this.deferred[e]=void 0}},e.prototype.toHTML=function(){return this.tags.map((function(e){return e.toHTML()})).join("")},e.prototype.toReactElements=function(){var e=this.id;return this.tags.map((function(t,n){var r="sc-"+e+"-"+n;return Object(s.cloneElement)(t.toElement(),{key:r})}))},y(e,null,[{key:"master",get:function(){return fe||(fe=(new e).rehydrate())}},{key:"instance",get:function(){return e.master}}]),e}(),de=function(){function e(t,n){var r=this;g(this,e),this.inject=function(e){e.hasNameForId(r.id,r.name)||e.inject(r.id,r.rules,r.name)},this.toString=function(){throw new P(12,String(r.name))},this.name=t,this.rules=n,this.id="sc-keyframes-"+t}return e.prototype.getName=function(){return this.name},e}(),he=/([A-Z])/g,me=/^ms-/;function ge(e){return e.replace(he,"-$1").toLowerCase().replace(me,"-ms-")}var ye=function(e){return null==e||!1===e||""===e},ve=function e(t,n){var r=[];return Object.keys(t).forEach((function(n){if(!ye(t[n])){if(k(t[n]))return r.push.apply(r,e(t[n],n)),r;if(_(t[n]))return r.push(ge(n)+":",t[n],";"),r;r.push(ge(n)+": "+(o=n,null==(i=t[n])||"boolean"==typeof i||""===i?"":"number"!=typeof i||0===i||o in c.a?String(i).trim():i+"px")+";")}var o,i;return r})),n?[n+" {"].concat(r,["}"]):r};function be(e,t,n){if(Array.isArray(e)){for(var r,o=[],i=0,a=e.length;i<a;i+=1)null!==(r=be(e[i],t,n))&&(Array.isArray(r)?o.push.apply(o,r):o.push(r));return o}return ye(e)?null:T(e)?"."+e.styledComponentId:_(e)?"function"!=typeof(s=e)||s.prototype&&s.prototype.isReactComponent||!t?e:be(e(t),t,n):e instanceof de?n?(e.inject(n),e.getName()):e:k(e)?ve(e):e.toString();var s}function we(e){for(var t=arguments.length,n=Array(t>1?t-1:0),r=1;r<t;r++)n[r-1]=arguments[r];return _(e)||k(e)?be(h(E,[e].concat(n))):be(h(e,n))}function xe(e){for(var t,n=0|e.length,r=0|n,o=0;n>=4;)t=1540483477*(65535&(t=255&e.charCodeAt(o)|(255&e.charCodeAt(++o))<<8|(255&e.charCodeAt(++o))<<16|(255&e.charCodeAt(++o))<<24))+((1540483477*(t>>>16)&65535)<<16),r=1540483477*(65535&r)+((1540483477*(r>>>16)&65535)<<16)^(t=1540483477*(65535&(t^=t>>>24))+((1540483477*(t>>>16)&65535)<<16)),n-=4,++o;switch(n){case 3:r^=(255&e.charCodeAt(o+2))<<16;case 2:r^=(255&e.charCodeAt(o+1))<<8;case 1:r=1540483477*(65535&(r^=255&e.charCodeAt(o)))+((1540483477*(r>>>16)&65535)<<16)}return((r=1540483477*(65535&(r^=r>>>13))+((1540483477*(r>>>16)&65535)<<16))^r>>>15)>>>0}var ke=52,Ee=function(e){return String.fromCharCode(e+(e>25?39:97))};function Oe(e){var t="",n=void 0;for(n=e;n>ke;n=Math.floor(n/ke))t=Ee(n%ke)+t;return Ee(n%ke)+t}function _e(e,t){for(var n=0;n<e.length;n+=1){var r=e[n];if(Array.isArray(r)&&!_e(r,t))return!1;if(_(r)&&!T(r))return!1}return!t.some((function(e){return _(e)||function(e){for(var t in e)if(_(e[t]))return!0;return!1}(e)}))}var Se,Te=function(e){return Oe(xe(e))},je=function(){function e(t,n,r){g(this,e),this.rules=t,this.isStatic=_e(t,n),this.componentId=r,pe.master.hasId(r)||pe.master.deferredInject(r,[])}return e.prototype.generateAndInjectStyles=function(e,t){var n=this.isStatic,r=this.componentId,o=this.lastClassName;if(C&&n&&"string"==typeof o&&t.hasNameForId(r,o))return o;var i=be(this.rules,e,t),a=Te(this.componentId+i.join(""));return t.hasNameForId(r,a)||t.inject(this.componentId,V(i,"."+a,void 0,r),a),this.lastClassName=a,a},e.generateName=function(e){return Te(e)},e}(),Ce=function(e,t){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:O,r=!!n&&e.theme===n.theme,o=e.theme&&!r?e.theme:t||n.theme;return o},Ie=/[[\].#*$><+~=|^:(),"'`-]+/g,Ae=/(^-|-$)/g;function Pe(e){return e.replace(Ie,"-").replace(Ae,"")}function Re(e){return"string"==typeof e&&!0}var Ne={childContextTypes:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDerivedStateFromProps:!0,propTypes:!0,type:!0},Le={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},Me=((Se={})[u.ForwardRef]={$$typeof:!0,render:!0},Se),De=Object.defineProperty,Fe=Object.getOwnPropertyNames,Ue=Object.getOwnPropertySymbols,ze=void 0===Ue?function(){return[]}:Ue,Be=Object.getOwnPropertyDescriptor,$e=Object.getPrototypeOf,qe=Object.prototype,We=Array.prototype;function He(e,t,n){if("string"!=typeof t){var r=$e(t);r&&r!==qe&&He(e,r,n);for(var o=We.concat(Fe(t),ze(t)),i=Me[e.$$typeof]||Ne,a=Me[t.$$typeof]||Ne,s=o.length,l=void 0,c=void 0;s--;)if(c=o[s],!(Le[c]||n&&n[c]||a&&a[c]||i&&i[c])&&(l=Be(t,c)))try{De(e,c,l)}catch(e){}return e}return e}var Ve=Object(s.createContext)(),Ye=Ve.Consumer,Ge=function(e){function t(n){g(this,t);var r=x(this,e.call(this,n));return r.getContext=Object(f.a)(r.getContext.bind(r)),r.renderInner=r.renderInner.bind(r),r}return b(t,e),t.prototype.render=function(){return this.props.children?l.a.createElement(Ve.Consumer,null,this.renderInner):null},t.prototype.renderInner=function(e){var t=this.getContext(this.props.theme,e);return l.a.createElement(Ve.Provider,{value:t},this.props.children)},t.prototype.getTheme=function(e,t){if(_(e))return e(t);if(null===e||Array.isArray(e)||"object"!==(void 0===e?"undefined":m(e)))throw new P(8);return v({},t,e)},t.prototype.getContext=function(e,t){return this.getTheme(e,t)},t}(s.Component),Qe=function(){function e(){g(this,e),this.masterSheet=pe.master,this.instance=this.masterSheet.clone(),this.sealed=!1}return e.prototype.seal=function(){if(!this.sealed){var e=this.masterSheet.clones.indexOf(this.instance);this.masterSheet.clones.splice(e,1),this.sealed=!0}},e.prototype.collectStyles=function(e){if(this.sealed)throw new P(2);return l.a.createElement(Je,{sheet:this.instance},e)},e.prototype.getStyleTags=function(){return this.seal(),this.instance.toHTML()},e.prototype.getStyleElement=function(){return this.seal(),this.instance.toReactElements()},e.prototype.interleaveWithNodeStream=function(e){throw new P(3)},e}(),Xe=Object(s.createContext)(),Ke=Xe.Consumer,Je=function(e){function t(n){g(this,t);var r=x(this,e.call(this,n));return r.getContext=Object(f.a)(r.getContext),r}return b(t,e),t.prototype.getContext=function(e,t){if(e)return e;if(t)return new pe(t);throw new P(4)},t.prototype.render=function(){var e=this.props,t=e.children,n=e.sheet,r=e.target;return l.a.createElement(Xe.Provider,{value:this.getContext(n,r)},t)},t}(s.Component),Ze={};var et=function(e){function t(){g(this,t);var n=x(this,e.call(this));return n.attrs={},n.renderOuter=n.renderOuter.bind(n),n.renderInner=n.renderInner.bind(n),n}return b(t,e),t.prototype.render=function(){return l.a.createElement(Ke,null,this.renderOuter)},t.prototype.renderOuter=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:pe.master;return this.styleSheet=e,this.props.forwardedComponent.componentStyle.isStatic?this.renderInner():l.a.createElement(Ye,null,this.renderInner)},t.prototype.renderInner=function(e){var t=this.props.forwardedComponent,n=t.componentStyle,r=t.defaultProps,o=(t.displayName,t.foldedComponentIds),i=t.styledComponentId,a=t.target,l=void 0;l=n.isStatic?this.generateAndInjectStyles(O,this.props):this.generateAndInjectStyles(Ce(this.props,e,r)||O,this.props);var c=this.props.as||this.attrs.as||a,u=Re(c),f={},d=v({},this.props,this.attrs),h=void 0;for(h in d)"forwardedComponent"!==h&&"as"!==h&&("forwardedRef"===h?f.ref=d[h]:"forwardedAs"===h?f.as=d[h]:u&&!Object(p.a)(h)||(f[h]=d[h]));return this.props.style&&this.attrs.style&&(f.style=v({},this.attrs.style,this.props.style)),f.className=Array.prototype.concat(o,i,l!==i?l:null,this.props.className,this.attrs.className).filter(Boolean).join(" "),Object(s.createElement)(c,f)},t.prototype.buildExecutionContext=function(e,t,n){var r=this,o=v({},t,{theme:e});return n.length?(this.attrs={},n.forEach((function(e){var t,n=e,i=!1,a=void 0,s=void 0;for(s in _(n)&&(n=n(o),i=!0),n)a=n[s],i||!_(a)||(t=a)&&t.prototype&&t.prototype.isReactComponent||T(a)||(a=a(o)),r.attrs[s]=a,o[s]=a})),o):o},t.prototype.generateAndInjectStyles=function(e,t){var n=t.forwardedComponent,r=n.attrs,o=n.componentStyle;n.warnTooManyClasses;return o.isStatic&&!r.length?o.generateAndInjectStyles(O,this.styleSheet):o.generateAndInjectStyles(this.buildExecutionContext(e,t,r),this.styleSheet)},t}(s.Component);function tt(e,t,n){var r=T(e),o=!Re(e),i=t.displayName,a=void 0===i?function(e){return Re(e)?"styled."+e:"Styled("+S(e)+")"}(e):i,s=t.componentId,c=void 0===s?function(e,t,n){var r="string"!=typeof t?"sc":Pe(t),o=(Ze[r]||0)+1;Ze[r]=o;var i=r+"-"+e.generateName(r+o);return n?n+"-"+i:i}(je,t.displayName,t.parentComponentId):s,u=t.ParentComponent,f=void 0===u?et:u,p=t.attrs,h=void 0===p?E:p,m=t.displayName&&t.componentId?Pe(t.displayName)+"-"+t.componentId:t.componentId||c,g=r&&e.attrs?Array.prototype.concat(e.attrs,h).filter(Boolean):h,y=new je(r?e.componentStyle.rules.concat(n):n,g,m),b=void 0,x=function(e,t){return l.a.createElement(f,v({},e,{forwardedComponent:b,forwardedRef:t}))};return x.displayName=a,(b=l.a.forwardRef(x)).displayName=a,b.attrs=g,b.componentStyle=y,b.foldedComponentIds=r?Array.prototype.concat(e.foldedComponentIds,e.styledComponentId):E,b.styledComponentId=m,b.target=r?e.target:e,b.withComponent=function(e){var r=t.componentId,o=w(t,["componentId"]),i=r&&r+"-"+(Re(e)?e:Pe(S(e)));return tt(e,v({},o,{attrs:g,componentId:i,ParentComponent:f}),n)},Object.defineProperty(b,"defaultProps",{get:function(){return this._foldedDefaultProps},set:function(t){this._foldedDefaultProps=r?Object(d.a)(e.defaultProps,t):t}}),b.toString=function(){return"."+b.styledComponentId},o&&He(b,e,{attrs:!0,componentStyle:!0,displayName:!0,foldedComponentIds:!0,styledComponentId:!0,target:!0,withComponent:!0}),b}var nt=function(e){return function e(t,n){var r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:O;if(!Object(u.isValidElementType)(n))throw new P(1,String(n));var o=function(){return t(n,r,we.apply(void 0,arguments))};return o.withConfig=function(o){return e(t,n,v({},r,o))},o.attrs=function(o){return e(t,n,v({},r,{attrs:Array.prototype.concat(r.attrs,o).filter(Boolean)}))},o}(tt,e)};["a","abbr","address","area","article","aside","audio","b","base","bdi","bdo","big","blockquote","body","br","button","canvas","caption","cite","code","col","colgroup","data","datalist","dd","del","details","dfn","dialog","div","dl","dt","em","embed","fieldset","figcaption","figure","footer","form","h1","h2","h3","h4","h5","h6","head","header","hgroup","hr","html","i","iframe","img","input","ins","kbd","keygen","label","legend","li","link","main","map","mark","marquee","menu","menuitem","meta","meter","nav","noscript","object","ol","optgroup","option","output","p","param","picture","pre","progress","q","rp","rt","ruby","s","samp","script","section","select","small","source","span","strong","style","sub","summary","sup","table","tbody","td","textarea","tfoot","th","thead","time","title","tr","track","u","ul","var","video","wbr","circle","clipPath","defs","ellipse","foreignObject","g","image","line","linearGradient","marker","mask","path","pattern","polygon","polyline","radialGradient","rect","stop","svg","text","tspan"].forEach((function(e){nt[e]=nt(e)}));var rt=function(){function e(t,n){g(this,e),this.rules=t,this.componentId=n,this.isStatic=_e(t,E),pe.master.hasId(n)||pe.master.deferredInject(n,[])}return e.prototype.createStyles=function(e,t){var n=V(be(this.rules,e,t),"");t.inject(this.componentId,n)},e.prototype.removeStyles=function(e){var t=this.componentId;e.hasId(t)&&e.remove(t)},e.prototype.renderStyles=function(e,t){this.removeStyles(t),this.createStyles(e,t)},e}();function ot(e){for(var t=arguments.length,n=Array(t>1?t-1:0),r=1;r<t;r++)n[r-1]=arguments[r];var o=we.apply(void 0,[e].concat(n)),i="sc-global-"+xe(JSON.stringify(o)),a=new rt(o,i),s=function(e){function t(n){g(this,t);var r=x(this,e.call(this,n)),o=r.constructor,i=o.globalStyle,a=o.styledComponentId;return C&&(window.scCGSHMRCache[a]=(window.scCGSHMRCache[a]||0)+1),r.state={globalStyle:i,styledComponentId:a},r}return b(t,e),t.prototype.componentWillUnmount=function(){window.scCGSHMRCache[this.state.styledComponentId]&&(window.scCGSHMRCache[this.state.styledComponentId]-=1),0===window.scCGSHMRCache[this.state.styledComponentId]&&this.state.globalStyle.removeStyles(this.styleSheet)},t.prototype.render=function(){var e=this;return l.a.createElement(Ke,null,(function(t){e.styleSheet=t||pe.master;var n=e.state.globalStyle;return n.isStatic?(n.renderStyles(A,e.styleSheet),null):l.a.createElement(Ye,null,(function(t){var r=e.constructor.defaultProps,o=v({},e.props);return void 0!==t&&(o.theme=Ce(e.props,t,r)),n.renderStyles(o,e.styleSheet),null}))}))},t}(l.a.Component);return s.globalStyle=a,s.styledComponentId=i,s}C&&(window.scCGSHMRCache={});var it=function(e){return e.replace(/\s|\\n/g,"")};function at(e){for(var t=arguments.length,n=Array(t>1?t-1:0),r=1;r<t;r++)n[r-1]=arguments[r];var o=we.apply(void 0,[e].concat(n)),i=Oe(xe(it(JSON.stringify(o))));return new de(i,V(o,i,"@keyframes"))}var st=function(e){var t=l.a.forwardRef((function(t,n){return l.a.createElement(Ye,null,(function(r){var o=e.defaultProps,i=Ce(t,r,o);return l.a.createElement(e,v({},t,{theme:i,ref:n}))}))}));return He(t,e),t.displayName="WithTheme("+S(e)+")",t},lt={StyleSheet:pe};t.default=nt}.call(this,n(13))},function(e,t,n){e.exports=function(){"use strict";return function(e){function t(t){if(t)try{e(t+"}")}catch(e){}}return function(n,r,o,i,a,s,l,c,u,f){switch(n){case 1:if(0===u&&64===r.charCodeAt(0))return e(r+";"),"";break;case 2:if(0===c)return r+"/*|*/";break;case 3:switch(c){case 102:case 112:return e(o[0]+r),"";default:return r+(0===f?"/*|*/":"")}case-2:r.split("/*|*/}").forEach(t)}}}}()},function(e,t,n){"use strict";t.a={animationIterationCount:1,borderImageOutset:1,borderImageSlice:1,borderImageWidth:1,boxFlex:1,boxFlexGroup:1,boxOrdinalGroup:1,columnCount:1,columns:1,flex:1,flexGrow:1,flexPositive:1,flexShrink:1,flexNegative:1,flexOrder:1,gridRow:1,gridRowEnd:1,gridRowSpan:1,gridRowStart:1,gridColumn:1,gridColumnEnd:1,gridColumnSpan:1,gridColumnStart:1,msGridRow:1,msGridRowSpan:1,msGridColumn:1,msGridColumnSpan:1,fontWeight:1,lineHeight:1,opacity:1,order:1,orphans:1,tabSize:1,widows:1,zIndex:1,zoom:1,WebkitLineClamp:1,fillOpacity:1,floodOpacity:1,stopOpacity:1,strokeDasharray:1,strokeDashoffset:1,strokeMiterlimit:1,strokeOpacity:1,strokeWidth:1}},function(e,t,n){"use strict";(function(t){n(129);var r=n(280),o=n(143),i=n(282),a=n(283),s=n(284),l=n(285),c=n(24),u=n(144),f=n(28);function p(){this.schema=null,this.$refs=new r}e.exports=p,e.exports.YAML=n(130),p.parse=function(e,t,n,r){var o=this,i=new o;return i.parse.apply(i,arguments)},p.prototype.parse=function(e,n,a,s){var l,p=i(arguments);if(!p.path&&!p.schema){var d=f("Expected a file path, URL, or object. Got %s",p.path||p.schema);return u(p.callback,Promise.reject(d))}this.schema=null,this.$refs=new r;var h="http";if(c.isFileSystemPath(p.path)&&(p.path=c.fromFileSystemPath(p.path),h="file"),p.path=c.resolve(c.cwd(),p.path),p.schema&&"object"==typeof p.schema){var m=this.$refs._add(p.path);m.value=p.schema,m.pathType=h,l=Promise.resolve(p.schema)}else l=o(p.path,this.$refs,p.options);var g=this;return l.then((function(e){if(!e||"object"!=typeof e||t.isBuffer(e))throw f.syntax('"%s" is not a valid JSON Schema',g.$refs._root$Ref.path||e);return g.schema=e,u(p.callback,Promise.resolve(g.schema))})).catch((function(e){return u(p.callback,Promise.reject(e))}))},p.resolve=function(e,t,n,r){var o=this,i=new o;return i.resolve.apply(i,arguments)},p.prototype.resolve=function(e,t,n,r){var o=this,s=i(arguments);return this.parse(s.path,s.schema,s.options).then((function(){return a(o,s.options)})).then((function(){return u(s.callback,Promise.resolve(o.$refs))})).catch((function(e){return u(s.callback,Promise.reject(e))}))},p.bundle=function(e,t,n,r){var o=this,i=new o;return i.bundle.apply(i,arguments)},p.prototype.bundle=function(e,t,n,r){var o=this,a=i(arguments);return this.resolve(a.path,a.schema,a.options).then((function(){return s(o,a.options),u(a.callback,Promise.resolve(o.schema))})).catch((function(e){return u(a.callback,Promise.reject(e))}))},p.dereference=function(e,t,n,r){var o=this,i=new o;return i.dereference.apply(i,arguments)},p.prototype.dereference=function(e,t,n,r){var o=this,a=i(arguments);return this.resolve(a.path,a.schema,a.options).then((function(){return l(o,a.options),u(a.callback,Promise.resolve(o.schema))})).catch((function(e){return u(a.callback,Promise.reject(e))}))}}).call(this,n(11).Buffer)},function(e,t,n){"use strict";var r,o=n(1),i=n(145),a=n(8),s=(n(49),n(144)),l=n(48),c=n(48),u=n(61),f=u.jptr,p=n(90).isRef,d=n(62).clone,h=n(62).circularClone,m=n(91).recurse,g=n(286),y=n(288),v=n(146),b=n(289).statusCodes,w=n(290).version,x="3.0.0",k=function(e){function t(t){var n=e.call(this,t)||this;return n.name="S2OError",n}return o.__extends(t,e),t}(Error);function E(e,t){var n=new k(e);if(n.options=t,!t.promise)throw n;t.promise.reject(n)}function O(e,t,n){n.warnOnly?t[n.warnProperty||"x-s2o-warning"]=e:E(e,n)}function _(e,t){y.walkSchema(e,{},{},(function(e,n,r){!function(e,t){if(e["x-required"]&&Array.isArray(e["x-required"])&&(e.required||(e.required=[]),e.required=e.required.concat(e["x-required"]),delete e["x-required"]),e["x-anyOf"]&&(e.anyOf=e["x-anyOf"],delete e["x-anyOf"]),e["x-oneOf"]&&(e.oneOf=e["x-oneOf"],delete e["x-oneOf"]),e["x-not"]&&(e.not=e["x-not"],delete e["x-not"]),"boolean"==typeof e["x-nullable"]&&(e.nullable=e["x-nullable"],delete e["x-nullable"]),"object"==typeof e["x-discriminator"]&&"string"==typeof e["x-discriminator"].propertyName)for(var n in e.discriminator=e["x-discriminator"],delete e["x-discriminator"],e.discriminator.mapping){var r=e.discriminator.mapping[n];r.startsWith("#/definitions/")&&(e.discriminator.mapping[n]=r.replace("#/definitions/","#/components/schemas/"))}}(e),function(e,t,n){if(e.discriminator&&"string"==typeof e.discriminator&&(e.discriminator={propertyName:e.discriminator}),e.items&&Array.isArray(e.items)&&(0===e.items.length?e.items={}:1===e.items.length?e.items=e.items[0]:e.items={anyOf:e.items}),e.type&&Array.isArray(e.type))if(n.patch){if(0===e.type.length)delete e.type;else{e.oneOf||(e.oneOf=[]);for(var r=0,o=e.type;r<o.length;r++){var i=o[r],a={};if("null"===i)e.nullable=!0;else{a.type=i;for(var s=0,l=v.arrayProperties;s<l.length;s++){var c=l[s];void 0!==e.prop&&(a[c]=e[c],delete e[c])}}a.type&&e.oneOf.push(a)}delete e.type,0===e.oneOf.length?delete e.oneOf:e.oneOf.length<2&&(e.type=e.oneOf[0].type,Object.keys(e.oneOf[0]).length>1&&O("Lost properties from oneOf",e,n),delete e.oneOf)}e.type&&Array.isArray(e.type)&&1===e.type.length&&(e.type=e.type[0])}else E("(Patchable) schema type must not be an array",n);e.type&&"null"===e.type&&(delete e.type,e.nullable=!0),"array"!==e.type||e.items||(e.items={}),"boolean"==typeof e.required&&(e.required&&e.name&&(void 0===t.required&&(t.required=[]),Array.isArray(t.required)&&t.required.push(e.name)),delete e.required),e.xml&&"string"==typeof e.xml.namespace&&(e.xml.namespace||delete e.xml.namespace)}(e,n,t)}))}function S(e,t,n){var o,i=n.payload.options;if(p(e,t)){if(e[t].startsWith("#/components/"));else if("#/consumes"===e[t])delete e[t],n.parent[n.pkey]=d(i.openapi.consumes);else if("#/produces"===e[t])delete e[t],n.parent[n.pkey]=d(i.openapi.produces);else if(e[t].startsWith("#/definitions/")){var a=e[t].replace("#/definitions/","").split("/");(x=r.schemas[decodeURIComponent(a[0])])?a[0]=x:O("Could not resolve reference "+e[t],e,i),e[t]="#/components/schemas/"+a.join("/")}else if(e[t].startsWith("#/parameters/"))e[t]="#/components/parameters/"+v.sanitise(e[t].replace("#/parameters/",""));else if(e[t].startsWith("#/responses/"))e[t]="#/components/responses/"+v.sanitise(e[t].replace("#/responses/",""));else if(e[t].startsWith("#")){var s=d(u.jptr(i.openapi,e[t]));if(!1===s)O("direct $ref not found "+e[t],e,i);else if(i.refmap[e[t]])e[t]=i.refmap[e[t]];else{var l=e[t],c="schemas",f=(l=(l=(l=(l=l.replace("/properties/headers/","")).replace("/properties/responses/","")).replace("/properties/parameters/","")).replace("/properties/schemas/","")).lastIndexOf("/schema");if("schemas"===(c=l.indexOf("/headers/")>f?"headers":l.indexOf("/responses/")>f?"responses":l.indexOf("/example")>f?"examples":l.indexOf("/x-")>f?"extensions":l.indexOf("/parameters/")>f?"parameters":"schemas")&&_(s,i),"responses"!==c&&"extensions"!==c){var h=c.substr(0,c.length-1);"parameter"===h&&s.name&&s.name===v.sanitise(s.name)&&(h=encodeURIComponent(s.name));var m=1;for(e["x-miro"]&&(o=(o=e["x-miro"]).indexOf("#")>=0?o.split("#")[1].split("/").pop():o.split("/").pop().split(".")[0],h=encodeURIComponent(v.sanitise(o)),m="");u.jptr(i.openapi,"#/components/"+c+"/"+h+m);)m=""===m?2:++m;var g="#/components/"+c+"/"+h+m,y="";"examples"===c&&(s={value:s},y="/value"),u.jptr(i.openapi,g,s),i.refmap[e[t]]=g+y,e[t]=g+y}}}if(delete e["x-miro"],Object.keys(e).length>1){var b=e[t],w=n.path.indexOf("/schema")>=0;"preserve"===i.refSiblings||(w&&"allOf"===i.refSiblings?(delete e.$ref,n.parent[n.pkey]={allOf:[{$ref:b},e]}):n.parent[n.pkey]={$ref:b})}}if("x-ms-odata"===t&&"string"==typeof e[t]&&e[t].startsWith("#/")){var x;a=e[t].replace("#/definitions/","").replace("#/components/schemas/","").split("/");(x=r.schemas[decodeURIComponent(a[0])])?a[0]=x:O("Could not resolve reference "+e[t],e,i),e[t]="#/components/schemas/"+a.join("/")}}function T(e){for(var t in e)for(var n in e[t]){var r=v.sanitise(n);n!=r&&(e[t][r]=e[t][n],delete e[t][n])}}function j(e,t){if("basic"===e.type&&(e.type="http",e.scheme="basic"),"oauth2"===e.type){var n={},r=e.flow;"application"===e.flow&&(r="clientCredentials"),"accessCode"===e.flow&&(r="authorizationCode"),void 0!==e.authorizationUrl&&(n.authorizationUrl=e.authorizationUrl.split("?")[0].trim()||"/"),"string"==typeof e.tokenUrl&&(n.tokenUrl=e.tokenUrl.split("?")[0].trim()||"/"),n.scopes=e.scopes||{},e.flows={},e.flows[r]=n,delete e.flow,delete e.authorizationUrl,delete e.tokenUrl,delete e.scopes,void 0!==e.name&&(t.patch?delete e.name:E("(Patchable) oauth2 securitySchemes should not have name property",t))}}function C(e){return e&&!e["x-s2o-delete"]}function I(e,t){if(e.$ref)e.$ref=e.$ref.replace("#/responses/","#/components/responses/");else{e.type&&!e.schema&&(e.schema={}),e.type&&(e.schema.type=e.type),e.items&&e.items.collectionFormat&&e.items.type&&"array"!=e.items.type&&(e.items.collectionFormat!=e.collectionFormat&&O("Nested collectionFormats are not supported",e,t),delete e.items.collectionFormat),void 0!==e.collectionFormat&&("array"!=e.type&&(t.patch?delete e.collectionFormat:E("(Patchable) collectionFormat is only applicable to header.type array",t)),"csv"===e.collectionFormat&&(e.style="simple"),"ssv"===e.collectionFormat&&O("collectionFormat:ssv is no longer supported for headers",e,t),"pipes"===e.collectionFormat&&O("collectionFormat:pipes is no longer supported for headers",e,t),"multi"===e.collectionFormat&&(e.explode=!0),"tsv"===e.collectionFormat&&(O("collectionFormat:tsv is no longer supported",e,t),e["x-collectionFormat"]="tsv"),delete e.collectionFormat),delete e.type;for(var n=0,r=v.parameterTypeProperties;n<r.length;n++){void 0!==e[a=r[n]]&&(e.schema[a]=e[a],delete e[a])}for(var o=0,i=v.arrayProperties;o<i.length;o++){var a;void 0!==e[a=i[o]]&&(e.schema[a]=e[a],delete e[a])}}}function A(e,t){if(e.$ref.indexOf("#/parameters/")>=0){var n=e.$ref.split("#/parameters/");e.$ref=n[0]+"#/components/parameters/"+v.sanitise(n[1])}e.$ref.indexOf("#/definitions/")>=0&&O("Definition used as parameter",e,t)}function P(e,t,n,r,o,i,a){var s,l={},c=!0;if(t&&t.consumes&&"string"==typeof t.consumes){if(!a.patch)return E("(Patchable) operation.consumes must be an array",a);t.consumes=[t.consumes]}Array.isArray(i.consumes)||delete i.consumes;var u=((t?t.consumes:null)||i.consumes||[]).filter(v.uniqueOnly);if(e&&e.$ref&&"string"==typeof e.$ref){A(e,a);var p=decodeURIComponent(e.$ref.replace("#/components/parameters/","")),h=!1;if((j=i.components.parameters[p])&&!j["x-s2o-delete"]||!e.$ref.startsWith("#/")||(e["x-s2o-delete"]=!0,h=!0),h){var g=e.$ref,y=f(i,e.$ref);!y&&g.startsWith("#/")?O("Could not resolve reference "+g,e,a):y&&(e=y)}}if(e&&(e.name||e.in)){"boolean"==typeof e["x-deprecated"]&&(e.deprecated=e["x-deprecated"],delete e["x-deprecated"]),void 0!==e["x-example"]&&(e.example=e["x-example"],delete e["x-example"]),"body"==e.in||e.type||(a.patch?e.type="string":E("(Patchable) parameter.type is mandatory for non-body parameters",a)),e.type&&"object"==typeof e.type&&e.type.$ref&&(e.type=f(i,e.type.$ref)),"file"===e.type&&(e["x-s2o-originalType"]=e.type,s=e.type),e.description&&"object"==typeof e.description&&e.description.$ref&&(e.description=f(i,e.description.$ref)),null===e.description&&delete e.description;var b=e.collectionFormat;if(e.collectionFormat&&("array"!=e.type&&(a.patch?delete e.collectionFormat:E("(Patchable) collectionFormat is only applicable to param.type array",a)),"csv"!==e.collectionFormat||"query"!==e.in&&"cookie"!==e.in||(e.style="form",e.explode=!1),"csv"!==e.collectionFormat||"path"!==e.in&&"header"!==e.in||(e.style="simple"),"ssv"===e.collectionFormat&&("query"===e.in?e.style="spaceDelimited":O("collectionFormat:ssv is no longer supported except for in:query parameters",e,a)),"pipes"===e.collectionFormat&&("query"===e.in?e.style="pipeDelimited":O("collectionFormat:pipes is no longer supported except for in:query parameters",e,a)),"multi"===e.collectionFormat&&(e.explode=!0),"tsv"===e.collectionFormat&&(O("collectionFormat:tsv is no longer supported",e,a),e["x-collectionFormat"]="tsv"),delete e.collectionFormat),e.type&&"object"!=e.type&&"body"!=e.type&&"formData"!=e.in)if(e.items&&e.schema)O("parameter has array,items and schema",e,a);else{e.schema&&"object"==typeof e.schema||(e.schema={}),e.schema.type=e.type,e.items&&(e.schema.items=e.items,delete e.items,m(e.schema.items,null,(function(t,n,r){"collectionFormat"===n&&"string"==typeof t[n]&&(b&&t[n]!==b&&O("Nested collectionFormats are not supported",e,a),delete t[n])})));for(var w=0,x=v.parameterTypeProperties;w<x.length;w++){var k=x[w];void 0!==e[k]&&(e.schema[k]=e[k]),delete e[k]}}e.schema&&_(e.schema,a),e["x-ms-skip-url-encoding"]&&"query"===e.in&&(e.allowReserved=!0,delete e["x-ms-skip-url-encoding"])}if(e&&"formData"===e.in){c=!1,l.content={};var S="application/x-www-form-urlencoded";if(u.length&&u.indexOf("multipart/form-data")>=0&&(S="multipart/form-data"),l.content[S]={},e.schema)l.content[S].schema=e.schema,e.schema.$ref&&(l["x-s2o-name"]=decodeURIComponent(e.schema.$ref.replace("#/components/schemas/","")));else{l.content[S].schema={},l.content[S].schema.type="object",l.content[S].schema.properties={},l.content[S].schema.properties[e.name]={};var T=l.content[S].schema,j=l.content[S].schema.properties[e.name];e.description&&(j.description=e.description),e.example&&(j.example=e.example),e.type&&(j.type=e.type);for(var C=0,I=v.parameterTypeProperties;C<I.length;C++){k=I[C];void 0!==e[k]&&(j[k]=e[k])}!0===e.required&&(T.required||(T.required=[]),T.required.push(e.name)),void 0!==e.default&&(j.default=e.default),j.properties&&(j.properties=e.properties),e.allOf&&(j.allOf=e.allOf),"array"===e.type&&e.items&&(j.items=e.items,j.items.collectionFormat&&delete j.items.collectionFormat),"file"!==s&&"file"!==e["x-s2o-originalType"]||(j.type="string",j.format="binary"),R(e,j)}}else e&&"file"===e.type&&(e.required&&(l.required=e.required),l.content={},l.content["application/octet-stream"]={},l.content["application/octet-stream"].schema={},l.content["application/octet-stream"].schema.type="string",l.content["application/octet-stream"].schema.format="binary",R(e,l));if(e&&"body"===e.in){l.content={},e.name&&(l["x-s2o-name"]=(t&&t.operationId?v.sanitiseAll(t.operationId):"")+("_"+e.name).toCamelCase()),e.description&&(l.description=e.description),e.required&&(l.required=e.required),t&&a.rbname&&e.name&&(t[a.rbname]=e.name),e.schema&&e.schema.$ref?l["x-s2o-name"]=decodeURIComponent(e.schema.$ref.replace("#/components/schemas/","")):e.schema&&"array"===e.schema.type&&e.schema.items&&e.schema.items.$ref&&(l["x-s2o-name"]=decodeURIComponent(e.schema.items.$ref.replace("#/components/schemas/",""))+"Array"),u.length||u.push("application/json");for(var P=0,N=u;P<N.length;P++){var L=N[P];l.content[L]={},l.content[L].schema=d(e.schema||{}),_(l.content[L].schema,a)}R(e,l)}Object.keys(l).length>0&&(e["x-s2o-delete"]=!0,t&&(t.requestBody&&c?(t.requestBody["x-s2o-overloaded"]=!0,O("Operation "+(t.operationId||o)+" has multiple requestBodies",t,a)):(t.requestBody||(t=n[r]=function(e,t){for(var n={},r=0,o=Object.keys(e);r<o.length;r++){var i=o[r];n[i]=e[i],"parameters"===i&&(n.requestBody={},t.rbname&&(n[t.rbname]=""))}return n.requestBody={},n}(t,a)),t.requestBody.content&&t.requestBody.content["multipart/form-data"]&&t.requestBody.content["multipart/form-data"].schema&&t.requestBody.content["multipart/form-data"].schema.properties&&l.content["multipart/form-data"]&&l.content["multipart/form-data"].schema&&l.content["multipart/form-data"].schema.properties?(t.requestBody.content["multipart/form-data"].schema.properties=Object.assign(t.requestBody.content["multipart/form-data"].schema.properties,l.content["multipart/form-data"].schema.properties),t.requestBody.content["multipart/form-data"].schema.required=(t.requestBody.content["multipart/form-data"].schema.required||[]).concat(l.content["multipart/form-data"].schema.required||[]),t.requestBody.content["multipart/form-data"].schema.required.length||delete t.requestBody.content["multipart/form-data"].schema.required):t.requestBody.content&&t.requestBody.content["application/x-www-form-urlencoded"]&&t.requestBody.content["application/x-www-form-urlencoded"].schema&&t.requestBody.content["application/x-www-form-urlencoded"].schema.properties&&l.content["application/x-www-form-urlencoded"]&&l.content["application/x-www-form-urlencoded"].schema&&l.content["application/x-www-form-urlencoded"].schema.properties?(t.requestBody.content["application/x-www-form-urlencoded"].schema.properties=Object.assign(t.requestBody.content["application/x-www-form-urlencoded"].schema.properties,l.content["application/x-www-form-urlencoded"].schema.properties),t.requestBody.content["application/x-www-form-urlencoded"].schema.required=(t.requestBody.content["application/x-www-form-urlencoded"].schema.required||[]).concat(l.content["application/x-www-form-urlencoded"].schema.required||[]),t.requestBody.content["application/x-www-form-urlencoded"].schema.required.length||delete t.requestBody.content["application/x-www-form-urlencoded"].schema.required):(t.requestBody=Object.assign(t.requestBody,l),t.requestBody["x-s2o-name"]||(t.requestBody.schema&&t.requestBody.schema.$ref?t.requestBody["x-s2o-name"]=decodeURIComponent(t.requestBody.schema.$ref.replace("#/components/schemas/","")).split("/").join(""):t.operationId&&(t.requestBody["x-s2o-name"]=v.sanitiseAll(t.operationId)))))));if(e&&!e["x-s2o-delete"]){delete e.type;for(var M=0,D=v.parameterTypeProperties;M<D.length;M++){k=D[M];delete e[k]}"path"!==e.in||void 0!==e.required&&!0===e.required||(a.patch?e.required=!0:E("(Patchable) path parameters must be required:true ["+e.name+" in "+o+"]",a))}return t}function R(e,t){for(var n in e)n.startsWith("x-")&&!n.startsWith("x-s2o")&&(t[n]=e[n])}function N(e,t,n,r,o){if(!e)return!1;if(e.$ref&&"string"==typeof e.$ref)e.$ref.indexOf("#/definitions/")>=0?O("definition used as response: "+e.$ref,e,o):e.$ref.startsWith("#/responses/")&&(e.$ref="#/components/responses/"+v.sanitise(decodeURIComponent(e.$ref.replace("#/responses/",""))));else{if((void 0===e.description||null===e.description||""===e.description&&o.patch)&&(o.patch?"object"!=typeof e||Array.isArray(e)||(e.description=b[e]||""):E("(Patchable) response.description is mandatory",o)),void 0!==e.schema){if(_(e.schema,o),e.schema.$ref&&"string"==typeof e.schema.$ref&&e.schema.$ref.startsWith("#/responses/")&&(e.schema.$ref="#/components/responses/"+v.sanitise(decodeURIComponent(e.schema.$ref.replace("#/responses/","")))),n&&n.produces&&"string"==typeof n.produces){if(!o.patch)return E("(Patchable) operation.produces must be an array",o);n.produces=[n.produces]}r.produces&&!Array.isArray(r.produces)&&delete r.produces;var i=((n?n.produces:null)||r.produces||[]).filter(v.uniqueOnly);i.length||i.push("*/*"),e.content={};for(var a=0,s=i;a<s.length;a++){var l=s[a];if(e.content[l]={},e.content[l].schema=d(e.schema),e.examples&&e.examples[l]){var c={};c.value=e.examples[l],e.content[l].examples={},e.content[l].examples.response=c,delete e.examples[l]}"file"===e.content[l].schema.type&&(e.content[l].schema={type:"string",format:"binary"})}delete e.schema}for(var l in e.examples)e.content||(e.content={}),e.content[l]||(e.content[l]={}),e.content[l].examples={},e.content[l].examples.response={},e.content[l].examples.response.value=e.examples[l];if(delete e.examples,e.headers)for(var u in e.headers)"status code"===u.toLowerCase()?o.patch?delete e.headers[u]:E('(Patchable) "Status Code" is not a valid header',o):I(e.headers[u],o)}}function L(e,t,n,r,o){for(var i in e){var s=e[i];for(var l in s&&s["x-trace"]&&"object"==typeof s["x-trace"]&&(s.trace=s["x-trace"],delete s["x-trace"]),s&&s["x-summary"]&&"string"==typeof s["x-summary"]&&(s.summary=s["x-summary"],delete s["x-summary"]),s&&s["x-description"]&&"string"==typeof s["x-description"]&&(s.description=s["x-description"],delete s["x-description"]),s&&s["x-servers"]&&Array.isArray(s["x-servers"])&&(s.servers=s["x-servers"],delete s["x-servers"]),s)if(v.httpMethods.indexOf(l)>=0||"x-amazon-apigateway-any-method"===l){var c=s[l];if(c&&c.parameters&&Array.isArray(c.parameters)){if(s.parameters)for(var p=function(e){"string"==typeof e.$ref&&(A(e,n),e=f(o,e.$ref)),c.parameters.find((function(t,n,r){return t.name===e.name&&t.in===e.in}))||"formData"!==e.in&&"body"!==e.in&&"file"!==e.type||(c=P(e,c,s,l,i,o,n),n.rbname&&""===c[n.rbname]&&delete c[n.rbname])},h=0,m=s.parameters;h<m.length;h++){p(b=m[h])}for(var g=0,y=c.parameters;g<y.length;g++){var b=y[g];c=P(b,c,s,l,l+":"+i,o,n)}n.rbname&&""===c[n.rbname]&&delete c[n.rbname],n.debug||(c.parameters=c.parameters.filter(C))}if(c&&c.security&&T(c.security),"object"==typeof c){if(!c.responses){var w={description:"Default response"};c.responses={default:w}}for(var x in c.responses){N(c.responses[x],0,c,o,n)}}if(c&&c["x-servers"]&&Array.isArray(c["x-servers"]))c.servers=c["x-servers"],delete c["x-servers"];else if(c&&c.schemes&&c.schemes.length)for(var k=0,E=c.schemes;k<E.length;k++){var O=E[k];if((!o.schemes||o.schemes.indexOf(O)<0)&&(c.servers||(c.servers=[]),Array.isArray(o.servers)))for(var _=0,S=o.servers;_<S.length;_++){var j=S[_],I=d(j),R=a.parse(I.url);R.protocol=O,I.url=R.format(),c.servers.push(I)}}if(n.debug&&(c["x-s2o-consumes"]=c.consumes||[],c["x-s2o-produces"]=c.produces||[]),c){if(delete c.consumes,delete c.produces,delete c.schemes,c["x-ms-examples"]){for(var L in c["x-ms-examples"]){var M=c["x-ms-examples"][L],D=v.sanitiseAll(L);if(M.parameters)for(var F in M.parameters)for(var U=M.parameters[F],z=0,B=(c.parameters||[]).concat(s.parameters||[]);z<B.length;z++){(b=B[z]).$ref&&(b=u.jptr(o,b.$ref)),b.name!==F||b.example||(b.examples||(b.examples={}),b.examples[L]={value:U})}if(M.responses)for(var x in M.responses){if(M.responses[x].headers)for(var $ in M.responses[x].headers){U=M.responses[x].headers[$];for(var q in c.responses[x].headers){if(q===$)c.responses[x].headers[q].example=U}}if(M.responses[x].body&&(o.components.examples[D]={value:d(M.responses[x].body)},c.responses[x]&&c.responses[x].content))for(var W in c.responses[x].content){var H=c.responses[x].content[W];H.examples||(H.examples={}),H.examples[L]={$ref:"#/components/examples/"+D}}}}delete c["x-ms-examples"]}if(c.parameters&&0===c.parameters.length&&delete c.parameters,c.requestBody){var V=c.operationId?v.sanitiseAll(c.operationId):v.sanitiseAll(l+i).toCamelCase(),Y=v.sanitise(c.requestBody["x-s2o-name"]||V||"");delete c.requestBody["x-s2o-name"];var G=JSON.stringify(c.requestBody),Q=v.hash(G);if(!r[Q]){var X={};X.name=Y,X.body=c.requestBody,X.refs=[],r[Q]=X}var K="#/"+t+"/"+encodeURIComponent(u.jpescape(i))+"/"+l+"/requestBody";r[Q].refs.push(K)}}}if(s&&s.parameters){for(var J in s.parameters){P(b=s.parameters[J],null,s,null,i,o,n)}!n.debug&&Array.isArray(s.parameters)&&(s.parameters=s.parameters.filter(C))}}}function M(e,t){var n={};for(var o in r={schemas:{}},e.security&&T(e.security),e.components.securitySchemes){o!=(l=v.sanitise(o))&&(e.components.securitySchemes[l]&&E("Duplicate sanitised securityScheme name "+l,t),e.components.securitySchemes[l]=e.components.securitySchemes[o],delete e.components.securitySchemes[o]),j(e.components.securitySchemes[l],t)}for(var o in e.components.schemas){var i="";if(o!=(l=v.sanitiseAll(o))){for(;e.components.schemas[l+i];)i=i?++i:2;e.components.schemas[l+i]=e.components.schemas[o],delete e.components.schemas[o]}r.schemas[o]=l+i,_(e.components.schemas[l+i],t)}for(var a in t.refmap={},m(e,{payload:{options:t}},S),function(e,t){for(var n in t.refmap)u.jptr(e,n,{$ref:t.refmap[n]})}(e,t),e.components.parameters){a!=(l=v.sanitise(a))&&(e.components.parameters[l]&&E("Duplicate sanitised parameter name "+l,t),e.components.parameters[l]=e.components.parameters[a],delete e.components.parameters[a]),P(e.components.parameters[l],null,null,null,l,e,t)}for(var s in e.components.responses){var l;s!=(l=v.sanitise(s))&&(e.components.responses[l]&&E("Duplicate sanitised response name "+l,t),e.components.responses[l]=e.components.responses[s],delete e.components.responses[s]);var c=e.components.responses[l];if(N(c,0,null,e,t),c.headers)for(var f in c.headers)"status code"===f.toLowerCase()?t.patch?delete c.headers[f]:E('(Patchable) "Status Code" is not a valid header',t):I(c.headers[f],t)}for(var s in e.components.requestBodies){var p=e.components.requestBodies[s],h=JSON.stringify(p),g=v.hash(h);(x={}).name=s,x.body=p,x.refs=[],n[g]=x}if(L(e.paths,"paths",t,n,e),e["x-ms-paths"]&&L(e["x-ms-paths"],"x-ms-paths",t,n,e),!t.debug)for(var a in e.components.parameters){e.components.parameters[a]["x-s2o-delete"]&&delete e.components.parameters[a]}t.debug&&(e["x-s2o-consumes"]=e.consumes||[],e["x-s2o-produces"]=e.produces||[]),delete e.consumes,delete e.produces,delete e.schemes;var y=[];if(e.components.requestBodies={},!t.resolveInternal){var b=1;for(var w in n){var x;if((x=n[w]).refs.length>1){i="";for(x.name||(x.name="requestBody",i=b++);y.indexOf(x.name+i)>=0;)i=i?++i:2;for(var s in x.name=x.name+i,y.push(x.name),e.components.requestBodies[x.name]=d(x.body),x.refs){var k={};k.$ref="#/components/requestBodies/"+x.name,u.jptr(e,x.refs[s],k)}}}}return e.components.responses&&0===Object.keys(e.components.responses).length&&delete e.components.responses,e.components.parameters&&0===Object.keys(e.components.parameters).length&&delete e.components.parameters,e.components.examples&&0===Object.keys(e.components.examples).length&&delete e.components.examples,e.components.requestBodies&&0===Object.keys(e.components.requestBodies).length&&delete e.components.requestBodies,e.components.securitySchemes&&0===Object.keys(e.components.securitySchemes).length&&delete e.components.securitySchemes,e.components.headers&&0===Object.keys(e.components.headers).length&&delete e.components.headers,e.components.schemas&&0===Object.keys(e.components.schemas).length&&delete e.components.schemas,e.components&&0===Object.keys(e.components).length&&delete e.components,e}function D(e){return e&&e.url&&"string"==typeof e.url?(e.url=e.url.split("{{").join("{"),e.url=e.url.split("}}").join("}"),e.url.replace(/\{(.+?)\}/g,(function(t,n){e.variables||(e.variables={}),e.variables[n]={default:"unknown"}})),e):e}function F(e,t,n){if(void 0===e.info||null===e.info){if(!t.patch)return n(new k("(Patchable) info object is mandatory"));e.info={version:"",title:""}}if("object"!=typeof e.info||Array.isArray(e.info))return n(new k("info must be an object"));if(void 0===e.info.title||null===e.info.title){if(!t.patch)return n(new k("(Patchable) info.title cannot be null"));e.info.title=""}if(void 0===e.info.version||null===e.info.version){if(!t.patch)return n(new k("(Patchable) info.version cannot be null"));e.info.version=""}if("string"!=typeof e.info.version){if(!t.patch)return n(new k("(Patchable) info.version must be a string"));e.info.version=e.info.version.toString()}if(void 0!==e.info.logo){if(!t.patch)return n(new k("(Patchable) info should not have logo property"));e.info["x-logo"]=e.info.logo,delete e.info.logo}if(void 0!==e.info.termsOfService){if(null===e.info.termsOfService){if(!t.patch)return n(new k("(Patchable) info.termsOfService cannot be null"));e.info.termsOfService=""}if(a.URL&&t.whatwg)try{a.URL.parse(e.info.termsOfService)}catch(r){if(!t.patch)return n(new k("(Patchable) info.termsOfService must be a URL"));delete e.info.termsOfService}}}function U(e,t,n){if(void 0===e.paths){if(!t.patch)return n(new k("(Patchable) paths object is mandatory"));e.paths={}}}function z(e,t,n){return s(n,new Promise((function(n,r){if(e||(e={}),t.original=e,t.text||(t.text=c.stringify(e)),t.externals=[],t.externalRefs={},t.rewriteRefs=!0,t.preserveMiro=!0,t.promise={},t.promise.resolve=n,t.promise.reject=r,t.cache||(t.cache={}),t.source&&(t.cache[t.source]=t.original),e.openapi&&"string"==typeof e.openapi&&e.openapi.startsWith("3."))return t.openapi=h(e),F(t.openapi,t,r),U(t.openapi,t,r),void g.optionalResolve(t).then((function(){return t.direct?n(t.openapi):n(t)})).catch((function(e){console.warn(e),r(e)}));if(!e.swagger||"2.0"!=e.swagger)return r(new k("Unsupported swagger/OpenAPI version: "+(e.openapi?e.openapi:e.swagger)));var o=t.openapi={};if(o.openapi="string"==typeof t.targetVersion&&t.targetVersion.startsWith("3.")?t.targetVersion:x,t.origin){o["x-origin"]||(o["x-origin"]=[]);var i={};i.url=t.source||t.origin,i.format="swagger",i.version=e.swagger,i.converter={},i.converter.url="https://github.com/mermade/oas-kit",i.converter.version=w,o["x-origin"].push(i)}if(delete(o=Object.assign(o,h(e))).swagger,m(o,{},(function(e,t,n){null===e[t]&&!t.startsWith("x-")&&"default"!==t&&n.path.indexOf("/example")<0&&delete e[t]})),e.host)for(var a=0,s=Array.isArray(e.schemes)?e.schemes:[""];a<s.length;a++){var l=s[a];(u={}).url=(l?l+":":"")+"//"+e.host+(e.basePath?e.basePath:""),D(u),o.servers||(o.servers=[]),o.servers.push(u)}else if(e.basePath){var u;(u={}).url=e.basePath,D(u),o.servers||(o.servers=[]),o.servers.push(u)}if(delete o.host,delete o.basePath,o["x-servers"]&&Array.isArray(o["x-servers"])&&(o.servers=o["x-servers"],delete o["x-servers"]),e["x-ms-parameterized-host"]){var p=e["x-ms-parameterized-host"],y={};for(var v in y.url=p.hostTemplate+(e.basePath?e.basePath:""),y.variables={},p.parameters){var b=p.parameters[v];b.$ref&&(b=d(f(o,b.$ref))),v.startsWith("x-")||(delete b.required,delete b.type,delete b.in,void 0===b.default&&(b.enum?b.default=b.enum[0]:b.default=""),y.variables[b.name]=b,delete b.name)}o.servers||(o.servers=[]),!1===p.useSchemePrefix?o.servers.push(y):e.schemes.forEach((function(e){o.servers.push(Object.assign({},y,{url:e+"://"+y.url}))})),delete o["x-ms-parameterized-host"]}F(o,t,r),U(o,t,r),"string"==typeof o.consumes&&(o.consumes=[o.consumes]),"string"==typeof o.produces&&(o.produces=[o.produces]),o.components={},o["x-callbacks"]&&(o.components.callbacks=o["x-callbacks"],delete o["x-callbacks"]),o.components.examples={},o.components.headers={},o["x-links"]&&(o.components.links=o["x-links"],delete o["x-links"]),o.components.parameters=o.parameters||{},o.components.responses=o.responses||{},o.components.requestBodies={},o.components.securitySchemes=o.securityDefinitions||{},o.components.schemas=o.definitions||{},delete o.definitions,delete o.responses,delete o.parameters,delete o.securityDefinitions,g.optionalResolve(t).then((function(){M(t.openapi,t),t.direct?n(t.openapi):n(t)})).catch((function(e){console.warn(e),r(e)}))})))}function B(e,t,n){return s(n,new Promise((function(n,r){var o=null;try{o=JSON.parse(e),t.text=JSON.stringify(o,null,2)}catch(n){try{o=c.parse(e,{schema:"core"}),t.sourceYaml=!0,t.text=e}catch(e){}}o?z(o,t).then((function(e){return n(e)})).catch((function(e){return r(e)})):r(new k("Could not parse string"))})))}e.exports={S2OError:k,targetVersion:x,convert:z,convertObj:z,convertUrl:function(e,t,n){return s(n,new Promise((function(n,r){t.origin=!0,t.source||(t.source=e),t.verbose&&console.warn("GET "+e),l(e,{agent:t.agent}).then((function(e){if(200!==e.status)throw new k("Received status code "+e.status);return e.text()})).then((function(e){B(e,t).then((function(e){return n(e)})).catch((function(e){return r(e)}))})).catch((function(e){r(e)}))})))},convertStr:B,convertFile:function(e,t,n){return s(n,new Promise((function(n,r){i.readFile(e,t.encoding||"utf8",(function(o,i){o?r(o):(t.sourceFile=e,B(i,t).then((function(e){return n(e)})).catch((function(e){return r(e)})))}))})))},convertStream:function(e,t,n){return s(n,new Promise((function(n,r){var o="";e.on("data",(function(e){o+=e})).on("end",(function(){B(o,t).then((function(e){return n(e)})).catch((function(e){return r(e)}))}))})))}}},function(e,t,n){"use strict";function r(e,t){if(e.length!==t.length)return!1;for(var n=0;n<e.length;n++)if(e[n]!==t[n])return!1;return!0}e.exports=function(e,t){var n;void 0===t&&(t=r);var o,i=[],a=!1;return function(){for(var r=[],s=0;s<arguments.length;s++)r[s]=arguments[s];return a&&n===this&&t(r,i)?o:(o=e.apply(this,r),a=!0,n=this,i=r,o)}}},function(e,t,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0});var r=function(){function e(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)}}return function(t,n,r){return n&&e(t.prototype,n),r&&e(t,r),t}}(),o=n(0),i=l(o),a=l(n(30)),s=l(n(17));function l(e){return e&&e.__esModule?e:{default:e}}function c(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}var u="Select...",f=function(e){function t(e){!function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}(this,t);var n=function(e,t){if(!e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return!t||"object"!=typeof t&&"function"!=typeof t?e:t}(this,(t.__proto__||Object.getPrototypeOf(t)).call(this,e));return n.state={selected:n.parseValue(e.value,e.options)||{label:void 0===e.placeholder?u:e.placeholder,value:""},isOpen:!1},n.mounted=!0,n.handleDocumentClick=n.handleDocumentClick.bind(n),n.fireChangeEvent=n.fireChangeEvent.bind(n),n}return function(e,t){if("function"!=typeof t&&null!==t)throw new TypeError("Super expression must either be null or a function, not "+typeof t);e.prototype=Object.create(t&&t.prototype,{constructor:{value:e,enumerable:!1,writable:!0,configurable:!0}}),t&&(Object.setPrototypeOf?Object.setPrototypeOf(e,t):e.__proto__=t)}(t,e),r(t,[{key:"componentWillReceiveProps",value:function(e){if(e.value){var t=this.parseValue(e.value,e.options);t!==this.state.selected&&this.setState({selected:t})}else this.setState({selected:{label:void 0===e.placeholder?u:e.placeholder,value:""}})}},{key:"componentDidMount",value:function(){document.addEventListener("click",this.handleDocumentClick,!1),document.addEventListener("touchend",this.handleDocumentClick,!1)}},{key:"componentWillUnmount",value:function(){this.mounted=!1,document.removeEventListener("click",this.handleDocumentClick,!1),document.removeEventListener("touchend",this.handleDocumentClick,!1)}},{key:"handleMouseDown",value:function(e){this.props.onFocus&&"function"==typeof this.props.onFocus&&this.props.onFocus(this.state.isOpen),"mousedown"===e.type&&0!==e.button||(e.stopPropagation(),e.preventDefault(),this.props.disabled||this.setState({isOpen:!this.state.isOpen}))}},{key:"parseValue",value:function(e,t){var n=void 0;if("string"==typeof e)for(var r=0,o=t.length;r<o;r++)if("group"===t[r].type){var i=t[r].items.filter((function(t){return t.value===e}));i.length&&(n=i[0])}else void 0!==t[r].value&&t[r].value===e&&(n=t[r]);return n||e}},{key:"setValue",value:function(e,t){var n={selected:{value:e,label:t},isOpen:!1};this.fireChangeEvent(n),this.setState(n)}},{key:"fireChangeEvent",value:function(e){e.selected!==this.state.selected&&this.props.onChange&&this.props.onChange(e.selected)}},{key:"renderOption",value:function(e){var t,n=e.value;void 0===n&&(n=e.label||e);var r=e.label||e.value||e,o=n===this.state.selected.value||n===this.state.selected,a=(c(t={},this.props.baseClassName+"-option",!0),c(t,e.className,!!e.className),c(t,"is-selected",o),t),l=(0,s.default)(a);return i.default.createElement("div",{key:n,className:l,onMouseDown:this.setValue.bind(this,n,r),onClick:this.setValue.bind(this,n,r),role:"option","aria-selected":o?"true":"false"},r)}},{key:"buildMenu",value:function(){var e=this,t=this.props,n=t.options,r=t.baseClassName,o=n.map((function(t){if("group"===t.type){var n=i.default.createElement("div",{className:r+"-title"},t.name),o=t.items.map((function(t){return e.renderOption(t)}));return i.default.createElement("div",{className:r+"-group",key:t.name,role:"listbox",tabIndex:"-1"},n,o)}return e.renderOption(t)}));return o.length?o:i.default.createElement("div",{className:r+"-noresults"},"No options found")}},{key:"handleDocumentClick",value:function(e){this.mounted&&(a.default.findDOMNode(this).contains(e.target)||this.state.isOpen&&this.setState({isOpen:!1}))}},{key:"isValueSelected",value:function(){return"string"==typeof this.state.selected||""!==this.state.selected.value}},{key:"render",value:function(){var e,t,n,r,o,a=this.props,l=a.baseClassName,u=a.controlClassName,f=a.placeholderClassName,p=a.menuClassName,d=a.arrowClassName,h=a.arrowClosed,m=a.arrowOpen,g=a.className,y=this.props.disabled?"Dropdown-disabled":"",v="string"==typeof this.state.selected?this.state.selected:this.state.selected.label,b=(0,s.default)((c(e={},l+"-root",!0),c(e,g,!!g),c(e,"is-open",this.state.isOpen),e)),w=(0,s.default)((c(t={},l+"-control",!0),c(t,u,!!u),c(t,y,!!y),t)),x=(0,s.default)((c(n={},l+"-placeholder",!0),c(n,f,!!f),c(n,"is-selected",this.isValueSelected()),n)),k=(0,s.default)((c(r={},l+"-menu",!0),c(r,p,!!p),r)),E=(0,s.default)((c(o={},l+"-arrow",!0),c(o,d,!!d),o)),O=i.default.createElement("div",{className:x},v),_=this.state.isOpen?i.default.createElement("div",{className:k,"aria-expanded":"true"},this.buildMenu()):null;return i.default.createElement("div",{className:b},i.default.createElement("div",{className:w,onMouseDown:this.handleMouseDown.bind(this),onTouchEnd:this.handleMouseDown.bind(this),"aria-haspopup":"listbox"},O,i.default.createElement("div",{className:l+"-arrow-wrapper"},m&&h?this.state.isOpen?m:h:i.default.createElement("span",{className:E}))),_)}}]),t}(o.Component);f.defaultProps={baseClassName:"Dropdown"},t.default=f},function(e,t,n){e.exports=function(){"use strict";var e=Object.freeze||function(e){return e},t=e(["a","abbr","acronym","address","area","article","aside","audio","b","bdi","bdo","big","blink","blockquote","body","br","button","canvas","caption","center","cite","code","col","colgroup","content","data","datalist","dd","decorator","del","details","dfn","dir","div","dl","dt","element","em","fieldset","figcaption","figure","font","footer","form","h1","h2","h3","h4","h5","h6","head","header","hgroup","hr","html","i","img","input","ins","kbd","label","legend","li","main","map","mark","marquee","menu","menuitem","meter","nav","nobr","ol","optgroup","option","output","p","pre","progress","q","rp","rt","ruby","s","samp","section","select","shadow","small","source","spacer","span","strike","strong","style","sub","summary","sup","table","tbody","td","template","textarea","tfoot","th","thead","time","tr","track","tt","u","ul","var","video","wbr"]),n=e(["svg","a","altglyph","altglyphdef","altglyphitem","animatecolor","animatemotion","animatetransform","audio","canvas","circle","clippath","defs","desc","ellipse","filter","font","g","glyph","glyphref","hkern","image","line","lineargradient","marker","mask","metadata","mpath","path","pattern","polygon","polyline","radialgradient","rect","stop","style","switch","symbol","text","textpath","title","tref","tspan","video","view","vkern"]),r=e(["feBlend","feColorMatrix","feComponentTransfer","feComposite","feConvolveMatrix","feDiffuseLighting","feDisplacementMap","feDistantLight","feFlood","feFuncA","feFuncB","feFuncG","feFuncR","feGaussianBlur","feMerge","feMergeNode","feMorphology","feOffset","fePointLight","feSpecularLighting","feSpotLight","feTile","feTurbulence"]),o=e(["math","menclose","merror","mfenced","mfrac","mglyph","mi","mlabeledtr","mmultiscripts","mn","mo","mover","mpadded","mphantom","mroot","mrow","ms","mspace","msqrt","mstyle","msub","msup","msubsup","mtable","mtd","mtext","mtr","munder","munderover"]),i=e(["#text"]),a=Object.freeze||function(e){return e},s=a(["accept","action","align","alt","autocomplete","background","bgcolor","border","cellpadding","cellspacing","checked","cite","class","clear","color","cols","colspan","controls","coords","crossorigin","datetime","default","dir","disabled","download","enctype","face","for","headers","height","hidden","high","href","hreflang","id","integrity","ismap","label","lang","list","loop","low","max","maxlength","media","method","min","minlength","multiple","name","noshade","novalidate","nowrap","open","optimum","pattern","placeholder","poster","preload","pubdate","radiogroup","readonly","rel","required","rev","reversed","role","rows","rowspan","spellcheck","scope","selected","shape","size","sizes","span","srclang","start","src","srcset","step","style","summary","tabindex","title","type","usemap","valign","value","width","xmlns"]),l=a(["accent-height","accumulate","additive","alignment-baseline","ascent","attributename","attributetype","azimuth","basefrequency","baseline-shift","begin","bias","by","class","clip","clip-path","clip-rule","color","color-interpolation","color-interpolation-filters","color-profile","color-rendering","cx","cy","d","dx","dy","diffuseconstant","direction","display","divisor","dur","edgemode","elevation","end","fill","fill-opacity","fill-rule","filter","filterunits","flood-color","flood-opacity","font-family","font-size","font-size-adjust","font-stretch","font-style","font-variant","font-weight","fx","fy","g1","g2","glyph-name","glyphref","gradientunits","gradienttransform","height","href","id","image-rendering","in","in2","k","k1","k2","k3","k4","kerning","keypoints","keysplines","keytimes","lang","lengthadjust","letter-spacing","kernelmatrix","kernelunitlength","lighting-color","local","marker-end","marker-mid","marker-start","markerheight","markerunits","markerwidth","maskcontentunits","maskunits","max","mask","media","method","mode","min","name","numoctaves","offset","operator","opacity","order","orient","orientation","origin","overflow","paint-order","path","pathlength","patterncontentunits","patterntransform","patternunits","points","preservealpha","preserveaspectratio","primitiveunits","r","rx","ry","radius","refx","refy","repeatcount","repeatdur","restart","result","rotate","scale","seed","shape-rendering","specularconstant","specularexponent","spreadmethod","stddeviation","stitchtiles","stop-color","stop-opacity","stroke-dasharray","stroke-dashoffset","stroke-linecap","stroke-linejoin","stroke-miterlimit","stroke-opacity","stroke","stroke-width","style","surfacescale","tabindex","targetx","targety","transform","text-anchor","text-decoration","text-rendering","textlength","type","u1","u2","unicode","values","viewbox","visibility","version","vert-adv-y","vert-origin-x","vert-origin-y","width","word-spacing","wrap","writing-mode","xchannelselector","ychannelselector","x","x1","x2","xmlns","y","y1","y2","z","zoomandpan"]),c=a(["accent","accentunder","align","bevelled","close","columnsalign","columnlines","columnspan","denomalign","depth","dir","display","displaystyle","encoding","fence","frame","height","href","id","largeop","length","linethickness","lspace","lquote","mathbackground","mathcolor","mathsize","mathvariant","maxsize","minsize","movablelimits","notation","numalign","open","rowalign","rowlines","rowspacing","rowspan","rspace","rquote","scriptlevel","scriptminsize","scriptsizemultiplier","selection","separator","separators","stretchy","subscriptshift","supscriptshift","symmetric","voffset","width","xmlns"]),u=a(["xlink:href","xml:id","xlink:title","xml:space","xmlns:xlink"]),f=Object.hasOwnProperty,p=Object.setPrototypeOf,d=("undefined"!=typeof Reflect&&Reflect).apply;function h(e,t){p&&p(e,null);for(var n=t.length;n--;){var r=t[n];if("string"==typeof r){var o=r.toLowerCase();o!==r&&(Object.isFrozen(t)||(t[n]=o),r=o)}e[r]=!0}return e}function m(e){var t={},n=void 0;for(n in e)d(f,e,[n])&&(t[n]=e[n]);return t}d||(d=function(e,t,n){return e.apply(t,n)});var g=Object.seal||function(e){return e},y=g(/\{\{[\s\S]*|[\s\S]*\}\}/gm),v=g(/<%[\s\S]*|[\s\S]*%>/gm),b=g(/^data-[\-\w.\u00B7-\uFFFF]/),w=g(/^aria-[\-\w]+$/),x=g(/^(?:(?:(?:f|ht)tps?|mailto|tel|callto|cid|xmpp):|[^a-z]|[a-z+.\-]+(?:[^a-z+.\-:]|$))/i),k=g(/^(?:\w+script|data):/i),E=g(/[\u0000-\u0020\u00A0\u1680\u180E\u2000-\u2029\u205f\u3000]/g),O="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e};function _(e){if(Array.isArray(e)){for(var t=0,n=Array(e.length);t<e.length;t++)n[t]=e[t];return n}return Array.from(e)}var S=("undefined"!=typeof Reflect&&Reflect).apply,T=Array.prototype.slice,j=Object.freeze,C=function(){return"undefined"==typeof window?null:window};S||(S=function(e,t,n){return e.apply(t,n)});var I=function(e,t){if("object"!==(void 0===e?"undefined":O(e))||"function"!=typeof e.createPolicy)return null;var n=null;t.currentScript&&t.currentScript.hasAttribute("data-tt-policy-suffix")&&(n=t.currentScript.getAttribute("data-tt-policy-suffix"));var r="dompurify"+(n?"#"+n:"");try{return e.createPolicy(r,{createHTML:function(e){return e}})}catch(e){return console.warn("TrustedTypes policy "+r+" could not be created."),null}};return function e(){var a=arguments.length>0&&void 0!==arguments[0]?arguments[0]:C(),f=function(t){return e(t)};if(f.version="2.0.7",f.removed=[],!a||!a.document||9!==a.document.nodeType)return f.isSupported=!1,f;var p=a.document,d=!1,g=!1,A=a.document,P=a.DocumentFragment,R=a.HTMLTemplateElement,N=a.Node,L=a.NodeFilter,M=a.NamedNodeMap,D=void 0===M?a.NamedNodeMap||a.MozNamedAttrMap:M,F=a.Text,U=a.Comment,z=a.DOMParser,B=a.TrustedTypes;if("function"==typeof R){var $=A.createElement("template");$.content&&$.content.ownerDocument&&(A=$.content.ownerDocument)}var q=I(B,p),W=q?q.createHTML(""):"",H=A,V=H.implementation,Y=H.createNodeIterator,G=H.getElementsByTagName,Q=H.createDocumentFragment,X=p.importNode,K={};f.isSupported=V&&void 0!==V.createHTMLDocument&&9!==A.documentMode;var J=y,Z=v,ee=b,te=w,ne=k,re=E,oe=x,ie=null,ae=h({},[].concat(_(t),_(n),_(r),_(o),_(i))),se=null,le=h({},[].concat(_(s),_(l),_(c),_(u))),ce=null,ue=null,fe=!0,pe=!0,de=!1,he=!1,me=!1,ge=!1,ye=!1,ve=!1,be=!1,we=!1,xe=!1,ke=!1,Ee=!0,Oe=!0,_e=!1,Se={},Te=h({},["annotation-xml","audio","colgroup","desc","foreignobject","head","iframe","math","mi","mn","mo","ms","mtext","noembed","noframes","plaintext","script","style","svg","template","thead","title","video","xmp"]),je=h({},["audio","video","img","source","image"]),Ce=null,Ie=h({},["alt","class","for","id","label","name","pattern","placeholder","summary","title","value","style","xmlns"]),Ae=null,Pe=A.createElement("form"),Re=function(e){Ae&&Ae===e||(e&&"object"===(void 0===e?"undefined":O(e))||(e={}),ie="ALLOWED_TAGS"in e?h({},e.ALLOWED_TAGS):ae,se="ALLOWED_ATTR"in e?h({},e.ALLOWED_ATTR):le,Ce="ADD_URI_SAFE_ATTR"in e?h(m(Ie),e.ADD_URI_SAFE_ATTR):Ie,ce="FORBID_TAGS"in e?h({},e.FORBID_TAGS):{},ue="FORBID_ATTR"in e?h({},e.FORBID_ATTR):{},Se="USE_PROFILES"in e&&e.USE_PROFILES,fe=!1!==e.ALLOW_ARIA_ATTR,pe=!1!==e.ALLOW_DATA_ATTR,de=e.ALLOW_UNKNOWN_PROTOCOLS||!1,he=e.SAFE_FOR_JQUERY||!1,me=e.SAFE_FOR_TEMPLATES||!1,ge=e.WHOLE_DOCUMENT||!1,be=e.RETURN_DOM||!1,we=e.RETURN_DOM_FRAGMENT||!1,xe=e.RETURN_DOM_IMPORT||!1,ke=e.RETURN_TRUSTED_TYPE||!1,ve=e.FORCE_BODY||!1,Ee=!1!==e.SANITIZE_DOM,Oe=!1!==e.KEEP_CONTENT,_e=e.IN_PLACE||!1,oe=e.ALLOWED_URI_REGEXP||oe,me&&(pe=!1),we&&(be=!0),Se&&(ie=h({},[].concat(_(i))),se=[],!0===Se.html&&(h(ie,t),h(se,s)),!0===Se.svg&&(h(ie,n),h(se,l),h(se,u)),!0===Se.svgFilters&&(h(ie,r),h(se,l),h(se,u)),!0===Se.mathMl&&(h(ie,o),h(se,c),h(se,u))),e.ADD_TAGS&&(ie===ae&&(ie=m(ie)),h(ie,e.ADD_TAGS)),e.ADD_ATTR&&(se===le&&(se=m(se)),h(se,e.ADD_ATTR)),e.ADD_URI_SAFE_ATTR&&h(Ce,e.ADD_URI_SAFE_ATTR),Oe&&(ie["#text"]=!0),ge&&h(ie,["html","head","body"]),ie.table&&(h(ie,["tbody"]),delete ce.tbody),j&&j(e),Ae=e)},Ne=function(e){f.removed.push({element:e});try{e.parentNode.removeChild(e)}catch(t){e.outerHTML=W}},Le=function(e,t){try{f.removed.push({attribute:t.getAttributeNode(e),from:t})}catch(e){f.removed.push({attribute:null,from:t})}t.removeAttribute(e)},Me=function(e){var t=void 0,n=void 0;if(ve)e="<remove></remove>"+e;else{var r=e.match(/^[\s]+/);(n=r&&r[0])&&(e=e.slice(n.length))}if(d)try{t=(new z).parseFromString(e,"text/html")}catch(e){}if(g&&h(ce,["title"]),!t||!t.documentElement){var o=(t=V.createHTMLDocument("")).body;o.parentNode.removeChild(o.parentNode.firstElementChild),o.outerHTML=q?q.createHTML(e):e}return e&&n&&t.body.insertBefore(A.createTextNode(n),t.body.childNodes[0]||null),G.call(t,ge?"html":"body")[0]};f.isSupported&&(function(){try{Me('<svg><p><textarea><img src="</textarea><img src=x abc=1//">').querySelector("svg img")&&(d=!0)}catch(e){}}(),function(){try{var e=Me("<x/><title></title><img>");/<\/title/.test(e.querySelector("title").innerHTML)&&(g=!0)}catch(e){}}());var De=function(e){return Y.call(e.ownerDocument||e,e,L.SHOW_ELEMENT|L.SHOW_COMMENT|L.SHOW_TEXT,(function(){return L.FILTER_ACCEPT}),!1)},Fe=function(e){return"object"===(void 0===N?"undefined":O(N))?e instanceof N:e&&"object"===(void 0===e?"undefined":O(e))&&"number"==typeof e.nodeType&&"string"==typeof e.nodeName},Ue=function(e,t,n){K[e]&&K[e].forEach((function(e){e.call(f,t,n,Ae)}))},ze=function(e){var t,n=void 0;if(Ue("beforeSanitizeElements",e,null),!((t=e)instanceof F||t instanceof U||"string"==typeof t.nodeName&&"string"==typeof t.textContent&&"function"==typeof t.removeChild&&t.attributes instanceof D&&"function"==typeof t.removeAttribute&&"function"==typeof t.setAttribute&&"string"==typeof t.namespaceURI))return Ne(e),!0;var r=e.nodeName.toLowerCase();if(Ue("uponSanitizeElement",e,{tagName:r,allowedTags:ie}),("svg"===r||"math"===r)&&0!==e.querySelectorAll("p, br").length)return Ne(e),!0;if(!ie[r]||ce[r]){if(Oe&&!Te[r]&&"function"==typeof e.insertAdjacentHTML)try{var o=e.innerHTML;e.insertAdjacentHTML("AfterEnd",q?q.createHTML(o):o)}catch(e){}return Ne(e),!0}return"noscript"===r&&/<\/noscript/i.test(e.innerHTML)?(Ne(e),!0):"noembed"===r&&/<\/noembed/i.test(e.innerHTML)?(Ne(e),!0):(!he||e.firstElementChild||e.content&&e.content.firstElementChild||!/</g.test(e.textContent)||(f.removed.push({element:e.cloneNode()}),e.innerHTML?e.innerHTML=e.innerHTML.replace(/</g,"<"):e.innerHTML=e.textContent.replace(/</g,"<")),me&&3===e.nodeType&&(n=(n=(n=e.textContent).replace(J," ")).replace(Z," "),e.textContent!==n&&(f.removed.push({element:e.cloneNode()}),e.textContent=n)),Ue("afterSanitizeElements",e,null),!1)},Be=function(e,t,n){if(Ee&&("id"===t||"name"===t)&&(n in A||n in Pe))return!1;if(pe&&ee.test(t));else if(fe&&te.test(t));else{if(!se[t]||ue[t])return!1;if(Ce[t]);else if(oe.test(n.replace(re,"")));else if("src"!==t&&"xlink:href"!==t&&"href"!==t||"script"===e||0!==n.indexOf("data:")||!je[e])if(de&&!ne.test(n.replace(re,"")));else if(n)return!1}return!0},$e=function(e){var t=void 0,n=void 0,r=void 0,o=void 0,i=void 0;Ue("beforeSanitizeAttributes",e,null);var a=e.attributes;if(a){var s={attrName:"",attrValue:"",keepAttr:!0,allowedAttributes:se};for(i=a.length;i--;){var l=t=a[i],c=l.name,u=l.namespaceURI;if(n=t.value.trim(),r=c.toLowerCase(),s.attrName=r,s.attrValue=n,s.keepAttr=!0,Ue("uponSanitizeAttribute",e,s),n=s.attrValue,"name"===r&&"IMG"===e.nodeName&&a.id)o=a.id,a=S(T,a,[]),Le("id",e),Le(c,e),a.indexOf(o)>i&&e.setAttribute("id",o.value);else{if("INPUT"===e.nodeName&&"type"===r&&"file"===n&&s.keepAttr&&(se[r]||!ue[r]))continue;"id"===c&&e.setAttribute(c,""),Le(c,e)}if(s.keepAttr)if(/svg|math/i.test(e.namespaceURI)&&new RegExp("</("+Object.keys(Te).join("|")+")","i").test(n))Le(c,e);else{me&&(n=(n=n.replace(J," ")).replace(Z," "));var p=e.nodeName.toLowerCase();if(Be(p,r,n))try{u?e.setAttributeNS(u,c,n):e.setAttribute(c,n),f.removed.pop()}catch(e){}}}Ue("afterSanitizeAttributes",e,null)}},qe=function e(t){var n=void 0,r=De(t);for(Ue("beforeSanitizeShadowDOM",t,null);n=r.nextNode();)Ue("uponSanitizeShadowNode",n,null),ze(n)||(n.content instanceof P&&e(n.content),$e(n));Ue("afterSanitizeShadowDOM",t,null)};return f.sanitize=function(e,t){var n=void 0,r=void 0,o=void 0,i=void 0,s=void 0;if(e||(e="\x3c!--\x3e"),"string"!=typeof e&&!Fe(e)){if("function"!=typeof e.toString)throw new TypeError("toString is not a function");if("string"!=typeof(e=e.toString()))throw new TypeError("dirty is not a string, aborting")}if(!f.isSupported){if("object"===O(a.toStaticHTML)||"function"==typeof a.toStaticHTML){if("string"==typeof e)return a.toStaticHTML(e);if(Fe(e))return a.toStaticHTML(e.outerHTML)}return e}if(ye||Re(t),f.removed=[],_e);else if(e instanceof N)1===(r=(n=Me("\x3c!--\x3e")).ownerDocument.importNode(e,!0)).nodeType&&"BODY"===r.nodeName?n=r:"HTML"===r.nodeName?n=r:n.appendChild(r);else{if(!be&&!me&&!ge&&ke&&-1===e.indexOf("<"))return q?q.createHTML(e):e;if(!(n=Me(e)))return be?null:W}n&&ve&&Ne(n.firstChild);for(var l=De(_e?e:n);o=l.nextNode();)3===o.nodeType&&o===i||ze(o)||(o.content instanceof P&&qe(o.content),$e(o),i=o);if(i=null,_e)return e;if(be){if(we)for(s=Q.call(n.ownerDocument);n.firstChild;)s.appendChild(n.firstChild);else s=n;return xe&&(s=X.call(p,s,!0)),s}var c=ge?n.outerHTML:n.innerHTML;return me&&(c=(c=c.replace(J," ")).replace(Z," ")),q&&ke?q.createHTML(c):c},f.setConfig=function(e){Re(e),ye=!0},f.clearConfig=function(){Ae=null,ye=!1},f.isValidAttribute=function(e,t,n){Ae||Re({});var r=e.toLowerCase(),o=t.toLowerCase();return Be(r,o,n)},f.addHook=function(e,t){"function"==typeof t&&(K[e]=K[e]||[],K[e].push(t))},f.removeHook=function(e){K[e]&&K[e].pop()},f.removeHooks=function(e){K[e]&&(K[e]=[])},f.removeAllHooks=function(){K={}},f}()}()},function(e,t,n){"use strict";var r=/^((children|dangerouslySetInnerHTML|key|ref|autoFocus|defaultValue|defaultChecked|innerHTML|suppressContentEditableWarning|suppressHydrationWarning|valueLink|accept|acceptCharset|accessKey|action|allow|allowUserMedia|allowPaymentRequest|allowFullScreen|allowTransparency|alt|async|autoComplete|autoPlay|capture|cellPadding|cellSpacing|challenge|charSet|checked|cite|classID|className|cols|colSpan|content|contentEditable|contextMenu|controls|controlsList|coords|crossOrigin|data|dateTime|decoding|default|defer|dir|disabled|download|draggable|encType|form|formAction|formEncType|formMethod|formNoValidate|formTarget|frameBorder|headers|height|hidden|high|href|hrefLang|htmlFor|httpEquiv|id|inputMode|integrity|is|keyParams|keyType|kind|label|lang|list|loading|loop|low|marginHeight|marginWidth|max|maxLength|media|mediaGroup|method|min|minLength|multiple|muted|name|nonce|noValidate|open|optimum|pattern|placeholder|playsInline|poster|preload|profile|radioGroup|readOnly|referrerPolicy|rel|required|reversed|role|rows|rowSpan|sandbox|scope|scoped|scrolling|seamless|selected|shape|size|sizes|slot|span|spellCheck|src|srcDoc|srcLang|srcSet|start|step|style|summary|tabIndex|target|title|type|useMap|value|width|wmode|wrap|about|datatype|inlist|prefix|property|resource|typeof|vocab|autoCapitalize|autoCorrect|autoSave|color|itemProp|itemScope|itemType|itemID|itemRef|on|results|security|unselectable|accentHeight|accumulate|additive|alignmentBaseline|allowReorder|alphabetic|amplitude|arabicForm|ascent|attributeName|attributeType|autoReverse|azimuth|baseFrequency|baselineShift|baseProfile|bbox|begin|bias|by|calcMode|capHeight|clip|clipPathUnits|clipPath|clipRule|colorInterpolation|colorInterpolationFilters|colorProfile|colorRendering|contentScriptType|contentStyleType|cursor|cx|cy|d|decelerate|descent|diffuseConstant|direction|display|divisor|dominantBaseline|dur|dx|dy|edgeMode|elevation|enableBackground|end|exponent|externalResourcesRequired|fill|fillOpacity|fillRule|filter|filterRes|filterUnits|floodColor|floodOpacity|focusable|fontFamily|fontSize|fontSizeAdjust|fontStretch|fontStyle|fontVariant|fontWeight|format|from|fr|fx|fy|g1|g2|glyphName|glyphOrientationHorizontal|glyphOrientationVertical|glyphRef|gradientTransform|gradientUnits|hanging|horizAdvX|horizOriginX|ideographic|imageRendering|in|in2|intercept|k|k1|k2|k3|k4|kernelMatrix|kernelUnitLength|kerning|keyPoints|keySplines|keyTimes|lengthAdjust|letterSpacing|lightingColor|limitingConeAngle|local|markerEnd|markerMid|markerStart|markerHeight|markerUnits|markerWidth|mask|maskContentUnits|maskUnits|mathematical|mode|numOctaves|offset|opacity|operator|order|orient|orientation|origin|overflow|overlinePosition|overlineThickness|panose1|paintOrder|pathLength|patternContentUnits|patternTransform|patternUnits|pointerEvents|points|pointsAtX|pointsAtY|pointsAtZ|preserveAlpha|preserveAspectRatio|primitiveUnits|r|radius|refX|refY|renderingIntent|repeatCount|repeatDur|requiredExtensions|requiredFeatures|restart|result|rotate|rx|ry|scale|seed|shapeRendering|slope|spacing|specularConstant|specularExponent|speed|spreadMethod|startOffset|stdDeviation|stemh|stemv|stitchTiles|stopColor|stopOpacity|strikethroughPosition|strikethroughThickness|string|stroke|strokeDasharray|strokeDashoffset|strokeLinecap|strokeLinejoin|strokeMiterlimit|strokeOpacity|strokeWidth|surfaceScale|systemLanguage|tableValues|targetX|targetY|textAnchor|textDecoration|textRendering|textLength|to|transform|u1|u2|underlinePosition|underlineThickness|unicode|unicodeBidi|unicodeRange|unitsPerEm|vAlphabetic|vHanging|vIdeographic|vMathematical|values|vectorEffect|version|vertAdvY|vertOriginX|vertOriginY|viewBox|viewTarget|visibility|widths|wordSpacing|writingMode|x|xHeight|x1|x2|xChannelSelector|xlinkActuate|xlinkArcrole|xlinkHref|xlinkRole|xlinkShow|xlinkTitle|xlinkType|xmlBase|xmlns|xmlnsXlink|xmlLang|xmlSpace|y|y1|y2|yChannelSelector|z|zoomAndPan|for|class|autofocus)|(([Dd][Aa][Tt][Aa]|[Aa][Rr][Ii][Aa]|x)-.*))$/,o=function(e){var t={};return function(n){return void 0===t[n]&&(t[n]=e(n)),t[n]}}((function(e){return r.test(e)||111===e.charCodeAt(0)&&110===e.charCodeAt(1)&&e.charCodeAt(2)<91}));t.a=o},function(e,t,n){"use strict";function r(e){return Object.prototype.toString.call(e).slice(8,-1)}function o(e){return"Object"===r(e)&&(e.constructor===Object&&Object.getPrototypeOf(e)===Object.prototype)}function i(e){return"Array"===r(e)}function a(e){return"Symbol"===r(e)}
|
||
/*! *****************************************************************************
|
||
Copyright (c) Microsoft Corporation. All rights reserved.
|
||
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
|
||
this file except in compliance with the License. You may obtain a copy of the
|
||
License at http://www.apache.org/licenses/LICENSE-2.0
|
||
|
||
THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||
KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
|
||
WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
|
||
MERCHANTABLITY OR NON-INFRINGEMENT.
|
||
|
||
See the Apache Version 2.0 License for specific language governing permissions
|
||
and limitations under the License.
|
||
***************************************************************************** */
|
||
function s(){for(var e=0,t=0,n=arguments.length;t<n;t++)e+=arguments[t].length;var r=Array(e),o=0;for(t=0;t<n;t++)for(var i=arguments[t],a=0,s=i.length;a<s;a++,o++)r[o]=i[a];return r}function l(e,t,n,r){var o=r.propertyIsEnumerable(t)?"enumerable":"nonenumerable";"enumerable"===o&&(e[t]=n),"nonenumerable"===o&&Object.defineProperty(e,t,{value:n,enumerable:!1,writable:!0,configurable:!0})}t.a=function(e){for(var t=[],n=1;n<arguments.length;n++)t[n-1]=arguments[n];var r=null,c=e;return o(e)&&e.extensions&&1===Object.keys(e).length&&(c={},r=e.extensions),t.reduce((function(e,t){return function e(t,n,r){if(!o(n))return r&&i(r)&&r.forEach((function(e){n=e(t,n)})),n;var c={};return o(t)&&(c=s(Object.getOwnPropertyNames(t),Object.getOwnPropertySymbols(t)).reduce((function(e,r){var o=t[r];return(!a(r)&&!Object.getOwnPropertyNames(n).includes(r)||a(r)&&!Object.getOwnPropertySymbols(n).includes(r))&&l(e,r,o,t),e}),{})),s(Object.getOwnPropertyNames(n),Object.getOwnPropertySymbols(n)).reduce((function(a,s){var c=n[s],u=o(t)?t[s]:void 0;return r&&i(r)&&r.forEach((function(e){c=e(u,c)})),void 0!==u&&o(c)&&(c=e(u,c,r)),l(a,s,c,n),a}),c)}(e,t,r)}),c)}},function(e,t,n){n(160),e.exports=n(317)},function(e,t,n){"use strict";n.r(t);n(161),n(182),n(184),n(187),n(190),n(192),n(198),n(220),n(221)},function(e,t,n){n(64),n(102),n(109),n(174),n(180),n(181);var r=n(34);e.exports=r.Promise},function(e,t,n){var r=n(3),o=n(70),i=r.WeakMap;e.exports="function"==typeof i&&/native code/.test(o(i))},function(e,t,n){"use strict";var r=n(65),o=n(101);e.exports=r?{}.toString:function(){return"[object "+o(this)+"]"}},function(e,t,n){var r=n(71),o=n(41),i=function(e){return function(t,n){var i,a,s=String(o(t)),l=r(n),c=s.length;return l<0||l>=c?e?"":void 0:(i=s.charCodeAt(l))<55296||i>56319||l+1===c||(a=s.charCodeAt(l+1))<56320||a>57343?e?s.charAt(l):i:e?s.slice(l,l+2):a-56320+(i-55296<<10)+65536}};e.exports={codeAt:i(!1),charAt:i(!0)}},function(e,t,n){var r=n(26),o=n(75),i=n(77),a=n(19);e.exports=r("Reflect","ownKeys")||function(e){var t=o.f(a(e)),n=i.f;return n?t.concat(n(e)):t}},function(e,t,n){var r=n(33),o=n(35),i=n(167),a=function(e){return function(t,n,a){var s,l=r(t),c=o(l.length),u=i(a,c);if(e&&n!=n){for(;c>u;)if((s=l[u++])!=s)return!0}else for(;c>u;u++)if((e||u in l)&&l[u]===n)return e||u||0;return!e&&-1}};e.exports={includes:a(!0),indexOf:a(!1)}},function(e,t,n){var r=n(71),o=Math.max,i=Math.min;e.exports=function(e,t){var n=r(e);return n<0?o(n+t,0):i(n,t)}},function(e,t,n){"use strict";var r=n(105).IteratorPrototype,o=n(55),i=n(39),a=n(27),s=n(43),l=function(){return this};e.exports=function(e,t,n){var c=t+" Iterator";return e.prototype=o(r,{next:i(1,n)}),a(e,c,!1,!0),s[c]=l,e}},function(e,t,n){var r=n(9);e.exports=!r((function(){function e(){}return e.prototype.constructor=null,Object.getPrototypeOf(new e)!==e.prototype}))},function(e,t,n){var r=n(18),o=n(15),i=n(19),a=n(79);e.exports=r?Object.defineProperties:function(e,t){i(e);for(var n,r=a(t),s=r.length,l=0;s>l;)o.f(e,n=r[l++],t[n]);return e}},function(e,t,n){var r=n(7);e.exports=function(e){if(!r(e)&&null!==e)throw TypeError("Can't set "+String(e)+" as a prototype");return e}},function(e,t){e.exports={CSSRuleList:0,CSSStyleDeclaration:0,CSSValueList:0,ClientRectList:0,DOMRectList:0,DOMStringList:0,DOMTokenList:1,DataTransferItemList:0,FileList:0,HTMLAllCollection:0,HTMLCollection:0,HTMLFormElement:0,HTMLSelectElement:0,MediaList:0,MimeTypeArray:0,NamedNodeMap:0,NodeList:1,PaintRequestList:0,Plugin:0,PluginArray:0,SVGLengthList:0,SVGNumberList:0,SVGPathSegList:0,SVGPointList:0,SVGStringList:0,SVGTransformList:0,SourceBufferList:0,StyleSheetList:0,TextTrackCueList:0,TextTrackList:0,TouchList:0}},function(e,t,n){"use strict";var r=n(33),o=n(110),i=n(43),a=n(31),s=n(72),l=a.set,c=a.getterFor("Array Iterator");e.exports=s(Array,"Array",(function(e,t){l(this,{type:"Array Iterator",target:r(e),index:0,kind:t})}),(function(){var e=c(this),t=e.target,n=e.kind,r=e.index++;return!t||r>=t.length?(e.target=void 0,{value:void 0,done:!0}):"keys"==n?{value:r,done:!1}:"values"==n?{value:t[r],done:!1}:{value:[r,t[r]],done:!1}}),"values"),i.Arguments=i.Array,o("keys"),o("values"),o("entries")},function(e,t,n){"use strict";var r,o,i,a,s=n(14),l=n(22),c=n(3),u=n(26),f=n(111),p=n(23),d=n(112),h=n(27),m=n(113),g=n(7),y=n(44),v=n(80),b=n(25),w=n(70),x=n(56),k=n(114),E=n(115),O=n(116).set,_=n(178),S=n(119),T=n(179),j=n(81),C=n(120),I=n(31),A=n(78),P=n(4),R=n(82),N=P("species"),L="Promise",M=I.get,D=I.set,F=I.getterFor(L),U=f,z=c.TypeError,B=c.document,$=c.process,q=u("fetch"),W=j.f,H=W,V="process"==b($),Y=!!(B&&B.createEvent&&c.dispatchEvent),G=A(L,(function(){if(!(w(U)!==String(U))){if(66===R)return!0;if(!V&&"function"!=typeof PromiseRejectionEvent)return!0}if(l&&!U.prototype.finally)return!0;if(R>=51&&/native code/.test(U))return!1;var e=U.resolve(1),t=function(e){e((function(){}),(function(){}))};return(e.constructor={})[N]=t,!(e.then((function(){}))instanceof t)})),Q=G||!k((function(e){U.all(e).catch((function(){}))})),X=function(e){var t;return!(!g(e)||"function"!=typeof(t=e.then))&&t},K=function(e,t,n){if(!t.notified){t.notified=!0;var r=t.reactions;_((function(){for(var o=t.value,i=1==t.state,a=0;r.length>a;){var s,l,c,u=r[a++],f=i?u.ok:u.fail,p=u.resolve,d=u.reject,h=u.domain;try{f?(i||(2===t.rejection&&te(e,t),t.rejection=1),!0===f?s=o:(h&&h.enter(),s=f(o),h&&(h.exit(),c=!0)),s===u.promise?d(z("Promise-chain cycle")):(l=X(s))?l.call(s,p,d):p(s)):d(o)}catch(e){h&&!c&&h.exit(),d(e)}}t.reactions=[],t.notified=!1,n&&!t.rejection&&Z(e,t)}))}},J=function(e,t,n){var r,o;Y?((r=B.createEvent("Event")).promise=t,r.reason=n,r.initEvent(e,!1,!0),c.dispatchEvent(r)):r={promise:t,reason:n},(o=c["on"+e])?o(r):"unhandledrejection"===e&&T("Unhandled promise rejection",n)},Z=function(e,t){O.call(c,(function(){var n,r=t.value;if(ee(t)&&(n=C((function(){V?$.emit("unhandledRejection",r,e):J("unhandledrejection",e,r)})),t.rejection=V||ee(t)?2:1,n.error))throw n.value}))},ee=function(e){return 1!==e.rejection&&!e.parent},te=function(e,t){O.call(c,(function(){V?$.emit("rejectionHandled",e):J("rejectionhandled",e,t.value)}))},ne=function(e,t,n,r){return function(o){e(t,n,o,r)}},re=function(e,t,n,r){t.done||(t.done=!0,r&&(t=r),t.value=n,t.state=2,K(e,t,!0))},oe=function(e,t,n,r){if(!t.done){t.done=!0,r&&(t=r);try{if(e===n)throw z("Promise can't be resolved itself");var o=X(n);o?_((function(){var r={done:!1};try{o.call(n,ne(oe,e,r,t),ne(re,e,r,t))}catch(n){re(e,r,n,t)}})):(t.value=n,t.state=1,K(e,t,!1))}catch(n){re(e,{done:!1},n,t)}}};G&&(U=function(e){v(this,U,L),y(e),r.call(this);var t=M(this);try{e(ne(oe,this,t),ne(re,this,t))}catch(e){re(this,t,e)}},(r=function(e){D(this,{type:L,done:!1,notified:!1,parent:!1,reactions:[],rejection:!1,state:0,value:void 0})}).prototype=d(U.prototype,{then:function(e,t){var n=F(this),r=W(E(this,U));return r.ok="function"!=typeof e||e,r.fail="function"==typeof t&&t,r.domain=V?$.domain:void 0,n.parent=!0,n.reactions.push(r),0!=n.state&&K(this,n,!1),r.promise},catch:function(e){return this.then(void 0,e)}}),o=function(){var e=new r,t=M(e);this.promise=e,this.resolve=ne(oe,e,t),this.reject=ne(re,e,t)},j.f=W=function(e){return e===U||e===i?new o(e):H(e)},l||"function"!=typeof f||(a=f.prototype.then,p(f.prototype,"then",(function(e,t){var n=this;return new U((function(e,t){a.call(n,e,t)})).then(e,t)}),{unsafe:!0}),"function"==typeof q&&s({global:!0,enumerable:!0,forced:!0},{fetch:function(e){return S(U,q.apply(c,arguments))}}))),s({global:!0,wrap:!0,forced:G},{Promise:U}),h(U,L,!1,!0),m(L),i=u(L),s({target:L,stat:!0,forced:G},{reject:function(e){var t=W(this);return t.reject.call(void 0,e),t.promise}}),s({target:L,stat:!0,forced:l||G},{resolve:function(e){return S(l&&this===i?U:this,e)}}),s({target:L,stat:!0,forced:Q},{all:function(e){var t=this,n=W(t),r=n.resolve,o=n.reject,i=C((function(){var n=y(t.resolve),i=[],a=0,s=1;x(e,(function(e){var l=a++,c=!1;i.push(void 0),s++,n.call(t,e).then((function(e){c||(c=!0,i[l]=e,--s||r(i))}),o)})),--s||r(i)}));return i.error&&o(i.value),n.promise},race:function(e){var t=this,n=W(t),r=n.reject,o=C((function(){var o=y(t.resolve);x(e,(function(e){o.call(t,e).then(n.resolve,r)}))}));return o.error&&r(o.value),n.promise}})},function(e,t,n){var r=n(4),o=n(43),i=r("iterator"),a=Array.prototype;e.exports=function(e){return void 0!==e&&(o.Array===e||a[i]===e)}},function(e,t,n){var r=n(101),o=n(43),i=n(4)("iterator");e.exports=function(e){if(null!=e)return e[i]||e["@@iterator"]||o[r(e)]}},function(e,t,n){var r=n(19);e.exports=function(e,t,n,o){try{return o?t(r(n)[0],n[1]):t(n)}catch(t){var i=e.return;throw void 0!==i&&r(i.call(e)),t}}},function(e,t,n){var r,o,i,a,s,l,c,u,f=n(3),p=n(32).f,d=n(25),h=n(116).set,m=n(117),g=f.MutationObserver||f.WebKitMutationObserver,y=f.process,v=f.Promise,b="process"==d(y),w=p(f,"queueMicrotask"),x=w&&w.value;x||(r=function(){var e,t;for(b&&(e=y.domain)&&e.exit();o;){t=o.fn,o=o.next;try{t()}catch(e){throw o?a():i=void 0,e}}i=void 0,e&&e.enter()},b?a=function(){y.nextTick(r)}:g&&!m?(s=!0,l=document.createTextNode(""),new g(r).observe(l,{characterData:!0}),a=function(){l.data=s=!s}):v&&v.resolve?(c=v.resolve(void 0),u=c.then,a=function(){u.call(c,r)}):a=function(){h.call(f,r)}),e.exports=x||function(e){var t={fn:e,next:void 0};i&&(i.next=t),o||(o=t,a()),i=t}},function(e,t,n){var r=n(3);e.exports=function(e,t){var n=r.console;n&&n.error&&(1===arguments.length?n.error(e):n.error(e,t))}},function(e,t,n){"use strict";var r=n(14),o=n(44),i=n(81),a=n(120),s=n(56);r({target:"Promise",stat:!0},{allSettled:function(e){var t=this,n=i.f(t),r=n.resolve,l=n.reject,c=a((function(){var n=o(t.resolve),i=[],a=0,l=1;s(e,(function(e){var o=a++,s=!1;i.push(void 0),l++,n.call(t,e).then((function(e){s||(s=!0,i[o]={status:"fulfilled",value:e},--l||r(i))}),(function(e){s||(s=!0,i[o]={status:"rejected",reason:e},--l||r(i))}))})),--l||r(i)}));return c.error&&l(c.value),n.promise}})},function(e,t,n){"use strict";var r=n(14),o=n(22),i=n(111),a=n(9),s=n(26),l=n(115),c=n(119),u=n(23);r({target:"Promise",proto:!0,real:!0,forced:!!i&&a((function(){i.prototype.finally.call({then:function(){}},(function(){}))}))},{finally:function(e){var t=l(this,s("Promise")),n="function"==typeof e;return this.then(n?function(n){return c(t,e()).then((function(){return n}))}:e,n?function(n){return c(t,e()).then((function(){throw n}))}:e)}}),o||"function"!=typeof i||i.prototype.finally||u(i.prototype,"finally",s("Promise").prototype.finally)},function(e,t,n){n(183);var r=n(84);e.exports=r("Array","find")},function(e,t,n){"use strict";var r=n(14),o=n(121).find,i=n(110),a=!0;"find"in[]&&Array(1).find((function(){a=!1})),r({target:"Array",proto:!0,forced:a},{find:function(e){return o(this,e,arguments.length>1?arguments[1]:void 0)}}),i("find")},function(e,t,n){n(185);var r=n(34);e.exports=r.Object.assign},function(e,t,n){var r=n(14),o=n(186);r({target:"Object",stat:!0,forced:Object.assign!==o},{assign:o})},function(e,t,n){"use strict";var r=n(18),o=n(9),i=n(79),a=n(77),s=n(73),l=n(42),c=n(74),u=Object.assign,f=Object.defineProperty;e.exports=!u||o((function(){if(r&&1!==u({b:1},u(f({},"a",{enumerable:!0,get:function(){f(this,"b",{value:3,enumerable:!1})}}),{b:2})).b)return!0;var e={},t={},n=Symbol();return e[n]=7,"abcdefghijklmnopqrst".split("").forEach((function(e){t[e]=e})),7!=u({},e)[n]||"abcdefghijklmnopqrst"!=i(u({},t)).join("")}))?function(e,t){for(var n=l(e),o=arguments.length,u=1,f=a.f,p=s.f;o>u;)for(var d,h=c(arguments[u++]),m=f?i(h).concat(f(h)):i(h),g=m.length,y=0;g>y;)d=m[y++],r&&!p.call(h,d)||(n[d]=h[d]);return n}:u},function(e,t,n){n(188);var r=n(84);e.exports=r("String","endsWith")},function(e,t,n){"use strict";var r,o=n(14),i=n(32).f,a=n(35),s=n(123),l=n(41),c=n(124),u=n(22),f="".endsWith,p=Math.min,d=c("endsWith");o({target:"String",proto:!0,forced:!!(u||d||(r=i(String.prototype,"endsWith"),!r||r.writable))&&!d},{endsWith:function(e){var t=String(l(this));s(e);var n=arguments.length>1?arguments[1]:void 0,r=a(t.length),o=void 0===n?r:p(a(n),r),i=String(e);return f?f.call(t,i,o):t.slice(o-i.length,o)===i}})},function(e,t,n){var r=n(7),o=n(25),i=n(4)("match");e.exports=function(e){var t;return r(e)&&(void 0!==(t=e[i])?!!t:"RegExp"==o(e))}},function(e,t,n){n(191);var r=n(84);e.exports=r("String","startsWith")},function(e,t,n){"use strict";var r,o=n(14),i=n(32).f,a=n(35),s=n(123),l=n(41),c=n(124),u=n(22),f="".startsWith,p=Math.min,d=c("startsWith");o({target:"String",proto:!0,forced:!!(u||d||(r=i(String.prototype,"startsWith"),!r||r.writable))&&!d},{startsWith:function(e){var t=String(l(this));s(e);var n=a(p(arguments.length>1?arguments[1]:void 0,t.length)),r=String(e);return f?f.call(t,r,n):t.slice(n,n+r.length)===r}})},function(e,t,n){n(193),n(64),n(102),n(109);var r=n(34);e.exports=r.Map},function(e,t,n){"use strict";var r=n(194),o=n(197);e.exports=r("Map",(function(e){return function(){return e(this,arguments.length?arguments[0]:void 0)}}),o)},function(e,t,n){"use strict";var r=n(14),o=n(3),i=n(78),a=n(23),s=n(125),l=n(56),c=n(80),u=n(7),f=n(9),p=n(114),d=n(27),h=n(196);e.exports=function(e,t,n){var m=-1!==e.indexOf("Map"),g=-1!==e.indexOf("Weak"),y=m?"set":"add",v=o[e],b=v&&v.prototype,w=v,x={},k=function(e){var t=b[e];a(b,e,"add"==e?function(e){return t.call(this,0===e?0:e),this}:"delete"==e?function(e){return!(g&&!u(e))&&t.call(this,0===e?0:e)}:"get"==e?function(e){return g&&!u(e)?void 0:t.call(this,0===e?0:e)}:"has"==e?function(e){return!(g&&!u(e))&&t.call(this,0===e?0:e)}:function(e,n){return t.call(this,0===e?0:e,n),this})};if(i(e,"function"!=typeof v||!(g||b.forEach&&!f((function(){(new v).entries().next()})))))w=n.getConstructor(t,e,m,y),s.REQUIRED=!0;else if(i(e,!0)){var E=new w,O=E[y](g?{}:-0,1)!=E,_=f((function(){E.has(1)})),S=p((function(e){new v(e)})),T=!g&&f((function(){for(var e=new v,t=5;t--;)e[y](t,t);return!e.has(-0)}));S||((w=t((function(t,n){c(t,w,e);var r=h(new v,t,w);return null!=n&&l(n,r[y],r,m),r}))).prototype=b,b.constructor=w),(_||T)&&(k("delete"),k("has"),m&&k("get")),(T||O)&&k(y),g&&b.clear&&delete b.clear}return x[e]=w,r({global:!0,forced:w!=v},x),d(w,e),g||n.setStrong(w,e,m),w}},function(e,t,n){var r=n(9);e.exports=!r((function(){return Object.isExtensible(Object.preventExtensions({}))}))},function(e,t,n){var r=n(7),o=n(108);e.exports=function(e,t,n){var i,a;return o&&"function"==typeof(i=t.constructor)&&i!==n&&r(a=i.prototype)&&a!==n.prototype&&o(e,a),e}},function(e,t,n){"use strict";var r=n(15).f,o=n(55),i=n(112),a=n(45),s=n(80),l=n(56),c=n(72),u=n(113),f=n(18),p=n(125).fastKey,d=n(31),h=d.set,m=d.getterFor;e.exports={getConstructor:function(e,t,n,c){var u=e((function(e,r){s(e,u,t),h(e,{type:t,index:o(null),first:void 0,last:void 0,size:0}),f||(e.size=0),null!=r&&l(r,e[c],e,n)})),d=m(t),g=function(e,t,n){var r,o,i=d(e),a=y(e,t);return a?a.value=n:(i.last=a={index:o=p(t,!0),key:t,value:n,previous:r=i.last,next:void 0,removed:!1},i.first||(i.first=a),r&&(r.next=a),f?i.size++:e.size++,"F"!==o&&(i.index[o]=a)),e},y=function(e,t){var n,r=d(e),o=p(t);if("F"!==o)return r.index[o];for(n=r.first;n;n=n.next)if(n.key==t)return n};return i(u.prototype,{clear:function(){for(var e=d(this),t=e.index,n=e.first;n;)n.removed=!0,n.previous&&(n.previous=n.previous.next=void 0),delete t[n.index],n=n.next;e.first=e.last=void 0,f?e.size=0:this.size=0},delete:function(e){var t=d(this),n=y(this,e);if(n){var r=n.next,o=n.previous;delete t.index[n.index],n.removed=!0,o&&(o.next=r),r&&(r.previous=o),t.first==n&&(t.first=r),t.last==n&&(t.last=o),f?t.size--:this.size--}return!!n},forEach:function(e){for(var t,n=d(this),r=a(e,arguments.length>1?arguments[1]:void 0,3);t=t?t.next:n.first;)for(r(t.value,t.key,this);t&&t.removed;)t=t.previous},has:function(e){return!!y(this,e)}}),i(u.prototype,n?{get:function(e){var t=y(this,e);return t&&t.value},set:function(e,t){return g(this,0===e?0:e,t)}}:{add:function(e){return g(this,e=0===e?0:e,e)}}),f&&r(u.prototype,"size",{get:function(){return d(this).size}}),u},setStrong:function(e,t,n){var r=t+" Iterator",o=m(t),i=m(r);c(e,t,(function(e,t){h(this,{type:r,target:e,state:o(e),kind:t,last:void 0})}),(function(){for(var e=i(this),t=e.kind,n=e.last;n&&n.removed;)n=n.previous;return e.target&&(e.last=n=n?n.next:e.state.first)?"keys"==t?{value:n.key,done:!1}:"values"==t?{value:n.value,done:!1}:{value:[n.key,n.value],done:!1}:(e.target=void 0,{value:void 0,done:!0})}),n?"entries":"values",!n,!0),u(t)}}},function(e,t,n){n(199),n(64),n(202),n(204),n(205),n(206),n(207),n(208),n(209),n(210),n(211),n(212),n(213),n(214),n(215),n(216),n(217),n(218),n(219);var r=n(34);e.exports=r.Symbol},function(e,t,n){"use strict";var r=n(14),o=n(9),i=n(83),a=n(7),s=n(42),l=n(35),c=n(200),u=n(122),f=n(201),p=n(4),d=n(82),h=p("isConcatSpreadable"),m=d>=51||!o((function(){var e=[];return e[h]=!1,e.concat()[0]!==e})),g=f("concat"),y=function(e){if(!a(e))return!1;var t=e[h];return void 0!==t?!!t:i(e)};r({target:"Array",proto:!0,forced:!m||!g},{concat:function(e){var t,n,r,o,i,a=s(this),f=u(a,0),p=0;for(t=-1,r=arguments.length;t<r;t++)if(i=-1===t?a:arguments[t],y(i)){if(p+(o=l(i.length))>9007199254740991)throw TypeError("Maximum allowed index exceeded");for(n=0;n<o;n++,p++)n in i&&c(f,p,i[n])}else{if(p>=9007199254740991)throw TypeError("Maximum allowed index exceeded");c(f,p++,i)}return f.length=p,f}})},function(e,t,n){"use strict";var r=n(52),o=n(15),i=n(39);e.exports=function(e,t,n){var a=r(t);a in e?o.f(e,a,i(0,n)):e[a]=n}},function(e,t,n){var r=n(9),o=n(4),i=n(82),a=o("species");e.exports=function(e){return i>=51||!r((function(){var t=[];return(t.constructor={})[a]=function(){return{foo:1}},1!==t[e](Boolean).foo}))}},function(e,t,n){"use strict";var r=n(14),o=n(3),i=n(26),a=n(22),s=n(18),l=n(69),c=n(100),u=n(9),f=n(12),p=n(83),d=n(7),h=n(19),m=n(42),g=n(33),y=n(52),v=n(39),b=n(55),w=n(79),x=n(75),k=n(203),E=n(77),O=n(32),_=n(15),S=n(73),T=n(20),j=n(23),C=n(66),I=n(54),A=n(40),P=n(53),R=n(4),N=n(126),L=n(10),M=n(27),D=n(31),F=n(121).forEach,U=I("hidden"),z=R("toPrimitive"),B=D.set,$=D.getterFor("Symbol"),q=Object.prototype,W=o.Symbol,H=i("JSON","stringify"),V=O.f,Y=_.f,G=k.f,Q=S.f,X=C("symbols"),K=C("op-symbols"),J=C("string-to-symbol-registry"),Z=C("symbol-to-string-registry"),ee=C("wks"),te=o.QObject,ne=!te||!te.prototype||!te.prototype.findChild,re=s&&u((function(){return 7!=b(Y({},"a",{get:function(){return Y(this,"a",{value:7}).a}})).a}))?function(e,t,n){var r=V(q,t);r&&delete q[t],Y(e,t,n),r&&e!==q&&Y(q,t,r)}:Y,oe=function(e,t){var n=X[e]=b(W.prototype);return B(n,{type:"Symbol",tag:e,description:t}),s||(n.description=t),n},ie=l&&"symbol"==typeof W.iterator?function(e){return"symbol"==typeof e}:function(e){return Object(e)instanceof W},ae=function(e,t,n){e===q&&ae(K,t,n),h(e);var r=y(t,!0);return h(n),f(X,r)?(n.enumerable?(f(e,U)&&e[U][r]&&(e[U][r]=!1),n=b(n,{enumerable:v(0,!1)})):(f(e,U)||Y(e,U,v(1,{})),e[U][r]=!0),re(e,r,n)):Y(e,r,n)},se=function(e,t){h(e);var n=g(t),r=w(n).concat(fe(n));return F(r,(function(t){s&&!le.call(n,t)||ae(e,t,n[t])})),e},le=function(e){var t=y(e,!0),n=Q.call(this,t);return!(this===q&&f(X,t)&&!f(K,t))&&(!(n||!f(this,t)||!f(X,t)||f(this,U)&&this[U][t])||n)},ce=function(e,t){var n=g(e),r=y(t,!0);if(n!==q||!f(X,r)||f(K,r)){var o=V(n,r);return!o||!f(X,r)||f(n,U)&&n[U][r]||(o.enumerable=!0),o}},ue=function(e){var t=G(g(e)),n=[];return F(t,(function(e){f(X,e)||f(A,e)||n.push(e)})),n},fe=function(e){var t=e===q,n=G(t?K:g(e)),r=[];return F(n,(function(e){!f(X,e)||t&&!f(q,e)||r.push(X[e])})),r};(l||(j((W=function(){if(this instanceof W)throw TypeError("Symbol is not a constructor");var e=arguments.length&&void 0!==arguments[0]?String(arguments[0]):void 0,t=P(e),n=function(e){this===q&&n.call(K,e),f(this,U)&&f(this[U],t)&&(this[U][t]=!1),re(this,t,v(1,e))};return s&&ne&&re(q,t,{configurable:!0,set:n}),oe(t,e)}).prototype,"toString",(function(){return $(this).tag})),S.f=le,_.f=ae,O.f=ce,x.f=k.f=ue,E.f=fe,s&&(Y(W.prototype,"description",{configurable:!0,get:function(){return $(this).description}}),a||j(q,"propertyIsEnumerable",le,{unsafe:!0}))),c||(N.f=function(e){return oe(R(e),e)}),r({global:!0,wrap:!0,forced:!l,sham:!l},{Symbol:W}),F(w(ee),(function(e){L(e)})),r({target:"Symbol",stat:!0,forced:!l},{for:function(e){var t=String(e);if(f(J,t))return J[t];var n=W(t);return J[t]=n,Z[n]=t,n},keyFor:function(e){if(!ie(e))throw TypeError(e+" is not a symbol");if(f(Z,e))return Z[e]},useSetter:function(){ne=!0},useSimple:function(){ne=!1}}),r({target:"Object",stat:!0,forced:!l,sham:!s},{create:function(e,t){return void 0===t?b(e):se(b(e),t)},defineProperty:ae,defineProperties:se,getOwnPropertyDescriptor:ce}),r({target:"Object",stat:!0,forced:!l},{getOwnPropertyNames:ue,getOwnPropertySymbols:fe}),r({target:"Object",stat:!0,forced:u((function(){E.f(1)}))},{getOwnPropertySymbols:function(e){return E.f(m(e))}}),H)&&r({target:"JSON",stat:!0,forced:!l||u((function(){var e=W();return"[null]"!=H([e])||"{}"!=H({a:e})||"{}"!=H(Object(e))}))},{stringify:function(e,t,n){for(var r,o=[e],i=1;arguments.length>i;)o.push(arguments[i++]);if(r=t,(d(t)||void 0!==e)&&!ie(e))return p(t)||(t=function(e,t){if("function"==typeof r&&(t=r.call(this,e,t)),!ie(t))return t}),o[1]=t,H.apply(null,o)}});W.prototype[z]||T(W.prototype,z,W.prototype.valueOf),M(W,"Symbol"),A[U]=!0},function(e,t,n){var r=n(33),o=n(75).f,i={}.toString,a="object"==typeof window&&window&&Object.getOwnPropertyNames?Object.getOwnPropertyNames(window):[];e.exports.f=function(e){return a&&"[object Window]"==i.call(e)?function(e){try{return o(e)}catch(e){return a.slice()}}(e):o(r(e))}},function(e,t,n){n(10)("asyncIterator")},function(e,t,n){"use strict";var r=n(14),o=n(18),i=n(3),a=n(12),s=n(7),l=n(15).f,c=n(103),u=i.Symbol;if(o&&"function"==typeof u&&(!("description"in u.prototype)||void 0!==u().description)){var f={},p=function(){var e=arguments.length<1||void 0===arguments[0]?void 0:String(arguments[0]),t=this instanceof p?new u(e):void 0===e?u():u(e);return""===e&&(f[t]=!0),t};c(p,u);var d=p.prototype=u.prototype;d.constructor=p;var h=d.toString,m="Symbol(test)"==String(u("test")),g=/^Symbol\((.*)\)[^)]+$/;l(d,"description",{configurable:!0,get:function(){var e=s(this)?this.valueOf():this,t=h.call(e);if(a(f,e))return"";var n=m?t.slice(7,-1):t.replace(g,"$1");return""===n?void 0:n}}),r({global:!0,forced:!0},{Symbol:p})}},function(e,t,n){n(10)("hasInstance")},function(e,t,n){n(10)("isConcatSpreadable")},function(e,t,n){n(10)("iterator")},function(e,t,n){n(10)("match")},function(e,t,n){n(10)("matchAll")},function(e,t,n){n(10)("replace")},function(e,t,n){n(10)("search")},function(e,t,n){n(10)("species")},function(e,t,n){n(10)("split")},function(e,t,n){n(10)("toPrimitive")},function(e,t,n){n(10)("toStringTag")},function(e,t,n){n(10)("unscopables")},function(e,t,n){n(27)(Math,"Math",!0)},function(e,t,n){var r=n(3);n(27)(r.JSON,"JSON",!0)},function(e,t){self.fetch||(self.fetch=function(e,t){return t=t||{},new Promise((function(n,r){var o=new XMLHttpRequest,i=[],a=[],s={},l=function(){return{ok:2==(o.status/100|0),statusText:o.statusText,status:o.status,url:o.responseURL,text:function(){return Promise.resolve(o.responseText)},json:function(){return Promise.resolve(JSON.parse(o.responseText))},blob:function(){return Promise.resolve(new Blob([o.response]))},clone:l,headers:{keys:function(){return i},entries:function(){return a},get:function(e){return s[e.toLowerCase()]},has:function(e){return e.toLowerCase()in s}}}};for(var c in o.open(t.method||"get",e,!0),o.onload=function(){o.getAllResponseHeaders().replace(/^(.*?):[^\S\n]*([\s\S]*?)$/gm,(function(e,t,n){i.push(t=t.toLowerCase()),a.push([t,n]),s[t]=s[t]?s[t]+","+n:n})),n(l())},o.onerror=r,o.withCredentials="include"==t.credentials,t.headers)o.setRequestHeader(c,t.headers[c]);o.send(t.body||null)}))})},function(e,t,n){(function(e){!function(e){var t=function(){try{return!!Symbol.iterator}catch(e){return!1}}(),n=function(e){var n={next:function(){var t=e.shift();return{done:void 0===t,value:t}}};return t&&(n[Symbol.iterator]=function(){return n}),n},r=function(e){return encodeURIComponent(e).replace(/%20/g,"+")},o=function(e){return decodeURIComponent(String(e).replace(/\+/g," "))};(function(){try{var t=e.URLSearchParams;return"a=1"===new t("?a=1").toString()&&"function"==typeof t.prototype.set}catch(e){return!1}})()||function(){var o=function(e){Object.defineProperty(this,"_entries",{writable:!0,value:{}});var t=typeof e;if("undefined"===t);else if("string"===t)""!==e&&this._fromString(e);else if(e instanceof o){var n=this;e.forEach((function(e,t){n.append(t,e)}))}else{if(null===e||"object"!==t)throw new TypeError("Unsupported input's type for URLSearchParams");if("[object Array]"===Object.prototype.toString.call(e))for(var r=0;r<e.length;r++){var i=e[r];if("[object Array]"!==Object.prototype.toString.call(i)&&2===i.length)throw new TypeError("Expected [string, any] as entry at index "+r+" of URLSearchParams's input");this.append(i[0],i[1])}else for(var a in e)e.hasOwnProperty(a)&&this.append(a,e[a])}},i=o.prototype;i.append=function(e,t){e in this._entries?this._entries[e].push(String(t)):this._entries[e]=[String(t)]},i.delete=function(e){delete this._entries[e]},i.get=function(e){return e in this._entries?this._entries[e][0]:null},i.getAll=function(e){return e in this._entries?this._entries[e].slice(0):[]},i.has=function(e){return e in this._entries},i.set=function(e,t){this._entries[e]=[String(t)]},i.forEach=function(e,t){var n;for(var r in this._entries)if(this._entries.hasOwnProperty(r)){n=this._entries[r];for(var o=0;o<n.length;o++)e.call(t,n[o],r,this)}},i.keys=function(){var e=[];return this.forEach((function(t,n){e.push(n)})),n(e)},i.values=function(){var e=[];return this.forEach((function(t){e.push(t)})),n(e)},i.entries=function(){var e=[];return this.forEach((function(t,n){e.push([n,t])})),n(e)},t&&(i[Symbol.iterator]=i.entries),i.toString=function(){var e=[];return this.forEach((function(t,n){e.push(r(n)+"="+r(t))})),e.join("&")},e.URLSearchParams=o}();var i=e.URLSearchParams.prototype;"function"!=typeof i.sort&&(i.sort=function(){var e=this,t=[];this.forEach((function(n,r){t.push([r,n]),e._entries||e.delete(r)})),t.sort((function(e,t){return e[0]<t[0]?-1:e[0]>t[0]?1:0})),e._entries&&(e._entries={});for(var n=0;n<t.length;n++)this.append(t[n][0],t[n][1])}),"function"!=typeof i._fromString&&Object.defineProperty(i,"_fromString",{enumerable:!1,configurable:!1,writable:!1,value:function(e){if(this._entries)this._entries={};else{var t=[];this.forEach((function(e,n){t.push(n)}));for(var n=0;n<t.length;n++)this.delete(t[n])}var r,i=(e=e.replace(/^\?/,"")).split("&");for(n=0;n<i.length;n++)r=i[n].split("="),this.append(o(r[0]),r.length>1?o(r[1]):"")}})}(void 0!==e?e:"undefined"!=typeof window?window:"undefined"!=typeof self?self:this),function(e){if(function(){try{var t=new e.URL("b","http://a");return t.pathname="c%20d","http://a/c%20d"===t.href&&t.searchParams}catch(e){return!1}}()||function(){var t=e.URL,n=function(t,n){"string"!=typeof t&&(t=String(t));var r,o=document;if(n&&(void 0===e.location||n!==e.location.href)){(r=(o=document.implementation.createHTMLDocument("")).createElement("base")).href=n,o.head.appendChild(r);try{if(0!==r.href.indexOf(n))throw new Error(r.href)}catch(e){throw new Error("URL unable to set base "+n+" due to "+e)}}var i=o.createElement("a");if(i.href=t,r&&(o.body.appendChild(i),i.href=i.href),":"===i.protocol||!/:/.test(i.href))throw new TypeError("Invalid URL");Object.defineProperty(this,"_anchorElement",{value:i});var a=new e.URLSearchParams(this.search),s=!0,l=!0,c=this;["append","delete","set"].forEach((function(e){var t=a[e];a[e]=function(){t.apply(a,arguments),s&&(l=!1,c.search=a.toString(),l=!0)}})),Object.defineProperty(this,"searchParams",{value:a,enumerable:!0});var u=void 0;Object.defineProperty(this,"_updateSearchParams",{enumerable:!1,configurable:!1,writable:!1,value:function(){this.search!==u&&(u=this.search,l&&(s=!1,this.searchParams._fromString(this.search),s=!0))}})},r=n.prototype;["hash","host","hostname","port","protocol"].forEach((function(e){!function(e){Object.defineProperty(r,e,{get:function(){return this._anchorElement[e]},set:function(t){this._anchorElement[e]=t},enumerable:!0})}(e)})),Object.defineProperty(r,"search",{get:function(){return this._anchorElement.search},set:function(e){this._anchorElement.search=e,this._updateSearchParams()},enumerable:!0}),Object.defineProperties(r,{toString:{get:function(){var e=this;return function(){return e.href}}},href:{get:function(){return this._anchorElement.href.replace(/\?$/,"")},set:function(e){this._anchorElement.href=e,this._updateSearchParams()},enumerable:!0},pathname:{get:function(){return this._anchorElement.pathname.replace(/(^\/?)/,"/")},set:function(e){this._anchorElement.pathname=e},enumerable:!0},origin:{get:function(){var e={"http:":80,"https:":443,"ftp:":21}[this._anchorElement.protocol],t=this._anchorElement.port!=e&&""!==this._anchorElement.port;return this._anchorElement.protocol+"//"+this._anchorElement.hostname+(t?":"+this._anchorElement.port:"")},enumerable:!0},password:{get:function(){return""},set:function(e){},enumerable:!0},username:{get:function(){return""},set:function(e){},enumerable:!0}}),n.createObjectURL=function(e){return t.createObjectURL.apply(t,arguments)},n.revokeObjectURL=function(e){return t.revokeObjectURL.apply(t,arguments)},e.URL=n}(),void 0!==e.location&&!("origin"in e.location)){var t=function(){return e.location.protocol+"//"+e.location.hostname+(e.location.port?":"+e.location.port:"")};try{Object.defineProperty(e.location,"origin",{get:t,enumerable:!0})}catch(n){setInterval((function(){e.location.origin=t()}),100)}}}(void 0!==e?e:"undefined"!=typeof window?window:"undefined"!=typeof self?self:this)}).call(this,n(6))},function(e,t,n){"use strict";
|
||
/** @license React v16.12.0
|
||
* react.production.min.js
|
||
*
|
||
* Copyright (c) Facebook, Inc. and its affiliates.
|
||
*
|
||
* This source code is licensed under the MIT license found in the
|
||
* LICENSE file in the root directory of this source tree.
|
||
*/var r=n(127),o="function"==typeof Symbol&&Symbol.for,i=o?Symbol.for("react.element"):60103,a=o?Symbol.for("react.portal"):60106,s=o?Symbol.for("react.fragment"):60107,l=o?Symbol.for("react.strict_mode"):60108,c=o?Symbol.for("react.profiler"):60114,u=o?Symbol.for("react.provider"):60109,f=o?Symbol.for("react.context"):60110,p=o?Symbol.for("react.forward_ref"):60112,d=o?Symbol.for("react.suspense"):60113;o&&Symbol.for("react.suspense_list");var h=o?Symbol.for("react.memo"):60115,m=o?Symbol.for("react.lazy"):60116;o&&Symbol.for("react.fundamental"),o&&Symbol.for("react.responder"),o&&Symbol.for("react.scope");var g="function"==typeof Symbol&&Symbol.iterator;function y(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n<arguments.length;n++)t+="&args[]="+encodeURIComponent(arguments[n]);return"Minified React error #"+e+"; visit "+t+" for the full message or use the non-minified dev environment for full errors and additional helpful warnings."}var v={isMounted:function(){return!1},enqueueForceUpdate:function(){},enqueueReplaceState:function(){},enqueueSetState:function(){}},b={};function w(e,t,n){this.props=e,this.context=t,this.refs=b,this.updater=n||v}function x(){}function k(e,t,n){this.props=e,this.context=t,this.refs=b,this.updater=n||v}w.prototype.isReactComponent={},w.prototype.setState=function(e,t){if("object"!=typeof e&&"function"!=typeof e&&null!=e)throw Error(y(85));this.updater.enqueueSetState(this,e,t,"setState")},w.prototype.forceUpdate=function(e){this.updater.enqueueForceUpdate(this,e,"forceUpdate")},x.prototype=w.prototype;var E=k.prototype=new x;E.constructor=k,r(E,w.prototype),E.isPureReactComponent=!0;var O={current:null},_={current:null},S=Object.prototype.hasOwnProperty,T={key:!0,ref:!0,__self:!0,__source:!0};function j(e,t,n){var r,o={},a=null,s=null;if(null!=t)for(r in void 0!==t.ref&&(s=t.ref),void 0!==t.key&&(a=""+t.key),t)S.call(t,r)&&!T.hasOwnProperty(r)&&(o[r]=t[r]);var l=arguments.length-2;if(1===l)o.children=n;else if(1<l){for(var c=Array(l),u=0;u<l;u++)c[u]=arguments[u+2];o.children=c}if(e&&e.defaultProps)for(r in l=e.defaultProps)void 0===o[r]&&(o[r]=l[r]);return{$$typeof:i,type:e,key:a,ref:s,props:o,_owner:_.current}}function C(e){return"object"==typeof e&&null!==e&&e.$$typeof===i}var I=/\/+/g,A=[];function P(e,t,n,r){if(A.length){var o=A.pop();return o.result=e,o.keyPrefix=t,o.func=n,o.context=r,o.count=0,o}return{result:e,keyPrefix:t,func:n,context:r,count:0}}function R(e){e.result=null,e.keyPrefix=null,e.func=null,e.context=null,e.count=0,10>A.length&&A.push(e)}function N(e,t,n){return null==e?0:function e(t,n,r,o){var s=typeof t;"undefined"!==s&&"boolean"!==s||(t=null);var l=!1;if(null===t)l=!0;else switch(s){case"string":case"number":l=!0;break;case"object":switch(t.$$typeof){case i:case a:l=!0}}if(l)return r(o,t,""===n?"."+L(t,0):n),1;if(l=0,n=""===n?".":n+":",Array.isArray(t))for(var c=0;c<t.length;c++){var u=n+L(s=t[c],c);l+=e(s,u,r,o)}else if(null===t||"object"!=typeof t?u=null:u="function"==typeof(u=g&&t[g]||t["@@iterator"])?u:null,"function"==typeof u)for(t=u.call(t),c=0;!(s=t.next()).done;)l+=e(s=s.value,u=n+L(s,c++),r,o);else if("object"===s)throw r=""+t,Error(y(31,"[object Object]"===r?"object with keys {"+Object.keys(t).join(", ")+"}":r,""));return l}(e,"",t,n)}function L(e,t){return"object"==typeof e&&null!==e&&null!=e.key?function(e){var t={"=":"=0",":":"=2"};return"$"+(""+e).replace(/[=:]/g,(function(e){return t[e]}))}(e.key):t.toString(36)}function M(e,t){e.func.call(e.context,t,e.count++)}function D(e,t,n){var r=e.result,o=e.keyPrefix;e=e.func.call(e.context,t,e.count++),Array.isArray(e)?F(e,r,n,(function(e){return e})):null!=e&&(C(e)&&(e=function(e,t){return{$$typeof:i,type:e.type,key:t,ref:e.ref,props:e.props,_owner:e._owner}}(e,o+(!e.key||t&&t.key===e.key?"":(""+e.key).replace(I,"$&/")+"/")+n)),r.push(e))}function F(e,t,n,r,o){var i="";null!=n&&(i=(""+n).replace(I,"$&/")+"/"),N(e,D,t=P(t,i,r,o)),R(t)}function U(){var e=O.current;if(null===e)throw Error(y(321));return e}var z={Children:{map:function(e,t,n){if(null==e)return e;var r=[];return F(e,r,null,t,n),r},forEach:function(e,t,n){if(null==e)return e;N(e,M,t=P(null,null,t,n)),R(t)},count:function(e){return N(e,(function(){return null}),null)},toArray:function(e){var t=[];return F(e,t,null,(function(e){return e})),t},only:function(e){if(!C(e))throw Error(y(143));return e}},createRef:function(){return{current:null}},Component:w,PureComponent:k,createContext:function(e,t){return void 0===t&&(t=null),(e={$$typeof:f,_calculateChangedBits:t,_currentValue:e,_currentValue2:e,_threadCount:0,Provider:null,Consumer:null}).Provider={$$typeof:u,_context:e},e.Consumer=e},forwardRef:function(e){return{$$typeof:p,render:e}},lazy:function(e){return{$$typeof:m,_ctor:e,_status:-1,_result:null}},memo:function(e,t){return{$$typeof:h,type:e,compare:void 0===t?null:t}},useCallback:function(e,t){return U().useCallback(e,t)},useContext:function(e,t){return U().useContext(e,t)},useEffect:function(e,t){return U().useEffect(e,t)},useImperativeHandle:function(e,t,n){return U().useImperativeHandle(e,t,n)},useDebugValue:function(){},useLayoutEffect:function(e,t){return U().useLayoutEffect(e,t)},useMemo:function(e,t){return U().useMemo(e,t)},useReducer:function(e,t,n){return U().useReducer(e,t,n)},useRef:function(e){return U().useRef(e)},useState:function(e){return U().useState(e)},Fragment:s,Profiler:c,StrictMode:l,Suspense:d,createElement:j,cloneElement:function(e,t,n){if(null==e)throw Error(y(267,e));var o=r({},e.props),a=e.key,s=e.ref,l=e._owner;if(null!=t){if(void 0!==t.ref&&(s=t.ref,l=_.current),void 0!==t.key&&(a=""+t.key),e.type&&e.type.defaultProps)var c=e.type.defaultProps;for(u in t)S.call(t,u)&&!T.hasOwnProperty(u)&&(o[u]=void 0===t[u]&&void 0!==c?c[u]:t[u])}var u=arguments.length-2;if(1===u)o.children=n;else if(1<u){c=Array(u);for(var f=0;f<u;f++)c[f]=arguments[f+2];o.children=c}return{$$typeof:i,type:e.type,key:a,ref:s,props:o,_owner:l}},createFactory:function(e){var t=j.bind(null,e);return t.type=e,t},isValidElement:C,version:"16.12.0",__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED:{ReactCurrentDispatcher:O,ReactCurrentBatchConfig:{suspense:null},ReactCurrentOwner:_,IsSomeRendererActing:{current:!1},assign:r}},B={default:z},$=B&&z||B;e.exports=$.default||$},function(e,t,n){"use strict";
|
||
/** @license React v16.12.0
|
||
* react-dom.production.min.js
|
||
*
|
||
* Copyright (c) Facebook, Inc. and its affiliates.
|
||
*
|
||
* This source code is licensed under the MIT license found in the
|
||
* LICENSE file in the root directory of this source tree.
|
||
*/var r=n(0),o=n(127),i=n(224);function a(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n<arguments.length;n++)t+="&args[]="+encodeURIComponent(arguments[n]);return"Minified React error #"+e+"; visit "+t+" for the full message or use the non-minified dev environment for full errors and additional helpful warnings."}if(!r)throw Error(a(227));var s=null,l={};function c(){if(s)for(var e in l){var t=l[e],n=s.indexOf(e);if(!(-1<n))throw Error(a(96,e));if(!f[n]){if(!t.extractEvents)throw Error(a(97,e));for(var r in f[n]=t,n=t.eventTypes){var o=void 0,i=n[r],c=t,d=r;if(p.hasOwnProperty(d))throw Error(a(99,d));p[d]=i;var h=i.phasedRegistrationNames;if(h){for(o in h)h.hasOwnProperty(o)&&u(h[o],c,d);o=!0}else i.registrationName?(u(i.registrationName,c,d),o=!0):o=!1;if(!o)throw Error(a(98,r,e))}}}}function u(e,t,n){if(d[e])throw Error(a(100,e));d[e]=t,h[e]=t.eventTypes[n].dependencies}var f=[],p={},d={},h={};function m(e,t,n,r,o,i,a,s,l){var c=Array.prototype.slice.call(arguments,3);try{t.apply(n,c)}catch(e){this.onError(e)}}var g=!1,y=null,v=!1,b=null,w={onError:function(e){g=!0,y=e}};function x(e,t,n,r,o,i,a,s,l){g=!1,y=null,m.apply(w,arguments)}var k=null,E=null,O=null;function _(e,t,n){var r=e.type||"unknown-event";e.currentTarget=O(n),function(e,t,n,r,o,i,s,l,c){if(x.apply(this,arguments),g){if(!g)throw Error(a(198));var u=y;g=!1,y=null,v||(v=!0,b=u)}}(r,t,void 0,e),e.currentTarget=null}function S(e,t){if(null==t)throw Error(a(30));return null==e?t:Array.isArray(e)?Array.isArray(t)?(e.push.apply(e,t),e):(e.push(t),e):Array.isArray(t)?[e].concat(t):[e,t]}function T(e,t,n){Array.isArray(e)?e.forEach(t,n):e&&t.call(n,e)}var j=null;function C(e){if(e){var t=e._dispatchListeners,n=e._dispatchInstances;if(Array.isArray(t))for(var r=0;r<t.length&&!e.isPropagationStopped();r++)_(e,t[r],n[r]);else t&&_(e,t,n);e._dispatchListeners=null,e._dispatchInstances=null,e.isPersistent()||e.constructor.release(e)}}function I(e){if(null!==e&&(j=S(j,e)),e=j,j=null,e){if(T(e,C),j)throw Error(a(95));if(v)throw e=b,v=!1,b=null,e}}var A={injectEventPluginOrder:function(e){if(s)throw Error(a(101));s=Array.prototype.slice.call(e),c()},injectEventPluginsByName:function(e){var t,n=!1;for(t in e)if(e.hasOwnProperty(t)){var r=e[t];if(!l.hasOwnProperty(t)||l[t]!==r){if(l[t])throw Error(a(102,t));l[t]=r,n=!0}}n&&c()}};function P(e,t){var n=e.stateNode;if(!n)return null;var r=k(n);if(!r)return null;n=r[t];e:switch(t){case"onClick":case"onClickCapture":case"onDoubleClick":case"onDoubleClickCapture":case"onMouseDown":case"onMouseDownCapture":case"onMouseMove":case"onMouseMoveCapture":case"onMouseUp":case"onMouseUpCapture":(r=!r.disabled)||(r=!("button"===(e=e.type)||"input"===e||"select"===e||"textarea"===e)),e=!r;break e;default:e=!1}if(e)return null;if(n&&"function"!=typeof n)throw Error(a(231,t,typeof n));return n}var R=r.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED;R.hasOwnProperty("ReactCurrentDispatcher")||(R.ReactCurrentDispatcher={current:null}),R.hasOwnProperty("ReactCurrentBatchConfig")||(R.ReactCurrentBatchConfig={suspense:null});var N=/^(.*)[\\\/]/,L="function"==typeof Symbol&&Symbol.for,M=L?Symbol.for("react.element"):60103,D=L?Symbol.for("react.portal"):60106,F=L?Symbol.for("react.fragment"):60107,U=L?Symbol.for("react.strict_mode"):60108,z=L?Symbol.for("react.profiler"):60114,B=L?Symbol.for("react.provider"):60109,$=L?Symbol.for("react.context"):60110,q=L?Symbol.for("react.concurrent_mode"):60111,W=L?Symbol.for("react.forward_ref"):60112,H=L?Symbol.for("react.suspense"):60113,V=L?Symbol.for("react.suspense_list"):60120,Y=L?Symbol.for("react.memo"):60115,G=L?Symbol.for("react.lazy"):60116;L&&Symbol.for("react.fundamental"),L&&Symbol.for("react.responder"),L&&Symbol.for("react.scope");var Q="function"==typeof Symbol&&Symbol.iterator;function X(e){return null===e||"object"!=typeof e?null:"function"==typeof(e=Q&&e[Q]||e["@@iterator"])?e:null}function K(e){if(null==e)return null;if("function"==typeof e)return e.displayName||e.name||null;if("string"==typeof e)return e;switch(e){case F:return"Fragment";case D:return"Portal";case z:return"Profiler";case U:return"StrictMode";case H:return"Suspense";case V:return"SuspenseList"}if("object"==typeof e)switch(e.$$typeof){case $:return"Context.Consumer";case B:return"Context.Provider";case W:var t=e.render;return t=t.displayName||t.name||"",e.displayName||(""!==t?"ForwardRef("+t+")":"ForwardRef");case Y:return K(e.type);case G:if(e=1===e._status?e._result:null)return K(e)}return null}function J(e){var t="";do{e:switch(e.tag){case 3:case 4:case 6:case 7:case 10:case 9:var n="";break e;default:var r=e._debugOwner,o=e._debugSource,i=K(e.type);n=null,r&&(n=K(r.type)),r=i,i="",o?i=" (at "+o.fileName.replace(N,"")+":"+o.lineNumber+")":n&&(i=" (created by "+n+")"),n="\n in "+(r||"Unknown")+i}t+=n,e=e.return}while(e);return t}var Z=!("undefined"==typeof window||void 0===window.document||void 0===window.document.createElement),ee=null,te=null,ne=null;function re(e){if(e=E(e)){if("function"!=typeof ee)throw Error(a(280));var t=k(e.stateNode);ee(e.stateNode,e.type,t)}}function oe(e){te?ne?ne.push(e):ne=[e]:te=e}function ie(){if(te){var e=te,t=ne;if(ne=te=null,re(e),t)for(e=0;e<t.length;e++)re(t[e])}}function ae(e,t){return e(t)}function se(e,t,n,r){return e(t,n,r)}function le(){}var ce=ae,ue=!1,fe=!1;function pe(){null===te&&null===ne||(le(),ie())}new Map;var de=/^[:A-Z_a-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD][:A-Z_a-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\-.0-9\u00B7\u0300-\u036F\u203F-\u2040]*$/,he=Object.prototype.hasOwnProperty,me={},ge={};function ye(e,t,n,r,o,i){this.acceptsBooleans=2===t||3===t||4===t,this.attributeName=r,this.attributeNamespace=o,this.mustUseProperty=n,this.propertyName=e,this.type=t,this.sanitizeURL=i}var ve={};"children dangerouslySetInnerHTML defaultValue defaultChecked innerHTML suppressContentEditableWarning suppressHydrationWarning style".split(" ").forEach((function(e){ve[e]=new ye(e,0,!1,e,null,!1)})),[["acceptCharset","accept-charset"],["className","class"],["htmlFor","for"],["httpEquiv","http-equiv"]].forEach((function(e){var t=e[0];ve[t]=new ye(t,1,!1,e[1],null,!1)})),["contentEditable","draggable","spellCheck","value"].forEach((function(e){ve[e]=new ye(e,2,!1,e.toLowerCase(),null,!1)})),["autoReverse","externalResourcesRequired","focusable","preserveAlpha"].forEach((function(e){ve[e]=new ye(e,2,!1,e,null,!1)})),"allowFullScreen async autoFocus autoPlay controls default defer disabled disablePictureInPicture formNoValidate hidden loop noModule noValidate open playsInline readOnly required reversed scoped seamless itemScope".split(" ").forEach((function(e){ve[e]=new ye(e,3,!1,e.toLowerCase(),null,!1)})),["checked","multiple","muted","selected"].forEach((function(e){ve[e]=new ye(e,3,!0,e,null,!1)})),["capture","download"].forEach((function(e){ve[e]=new ye(e,4,!1,e,null,!1)})),["cols","rows","size","span"].forEach((function(e){ve[e]=new ye(e,6,!1,e,null,!1)})),["rowSpan","start"].forEach((function(e){ve[e]=new ye(e,5,!1,e.toLowerCase(),null,!1)}));var be=/[\-:]([a-z])/g;function we(e){return e[1].toUpperCase()}function xe(e){switch(typeof e){case"boolean":case"number":case"object":case"string":case"undefined":return e;default:return""}}function ke(e,t,n,r){var o=ve.hasOwnProperty(t)?ve[t]:null;(null!==o?0===o.type:!r&&(2<t.length&&("o"===t[0]||"O"===t[0])&&("n"===t[1]||"N"===t[1])))||(function(e,t,n,r){if(null==t||function(e,t,n,r){if(null!==n&&0===n.type)return!1;switch(typeof t){case"function":case"symbol":return!0;case"boolean":return!r&&(null!==n?!n.acceptsBooleans:"data-"!==(e=e.toLowerCase().slice(0,5))&&"aria-"!==e);default:return!1}}(e,t,n,r))return!0;if(r)return!1;if(null!==n)switch(n.type){case 3:return!t;case 4:return!1===t;case 5:return isNaN(t);case 6:return isNaN(t)||1>t}return!1}(t,n,o,r)&&(n=null),r||null===o?function(e){return!!he.call(ge,e)||!he.call(me,e)&&(de.test(e)?ge[e]=!0:(me[e]=!0,!1))}(t)&&(null===n?e.removeAttribute(t):e.setAttribute(t,""+n)):o.mustUseProperty?e[o.propertyName]=null===n?3!==o.type&&"":n:(t=o.attributeName,r=o.attributeNamespace,null===n?e.removeAttribute(t):(n=3===(o=o.type)||4===o&&!0===n?"":""+n,r?e.setAttributeNS(r,t,n):e.setAttribute(t,n))))}function Ee(e){var t=e.type;return(e=e.nodeName)&&"input"===e.toLowerCase()&&("checkbox"===t||"radio"===t)}function Oe(e){e._valueTracker||(e._valueTracker=function(e){var t=Ee(e)?"checked":"value",n=Object.getOwnPropertyDescriptor(e.constructor.prototype,t),r=""+e[t];if(!e.hasOwnProperty(t)&&void 0!==n&&"function"==typeof n.get&&"function"==typeof n.set){var o=n.get,i=n.set;return Object.defineProperty(e,t,{configurable:!0,get:function(){return o.call(this)},set:function(e){r=""+e,i.call(this,e)}}),Object.defineProperty(e,t,{enumerable:n.enumerable}),{getValue:function(){return r},setValue:function(e){r=""+e},stopTracking:function(){e._valueTracker=null,delete e[t]}}}}(e))}function _e(e){if(!e)return!1;var t=e._valueTracker;if(!t)return!0;var n=t.getValue(),r="";return e&&(r=Ee(e)?e.checked?"true":"false":e.value),(e=r)!==n&&(t.setValue(e),!0)}function Se(e,t){var n=t.checked;return o({},t,{defaultChecked:void 0,defaultValue:void 0,value:void 0,checked:null!=n?n:e._wrapperState.initialChecked})}function Te(e,t){var n=null==t.defaultValue?"":t.defaultValue,r=null!=t.checked?t.checked:t.defaultChecked;n=xe(null!=t.value?t.value:n),e._wrapperState={initialChecked:r,initialValue:n,controlled:"checkbox"===t.type||"radio"===t.type?null!=t.checked:null!=t.value}}function je(e,t){null!=(t=t.checked)&&ke(e,"checked",t,!1)}function Ce(e,t){je(e,t);var n=xe(t.value),r=t.type;if(null!=n)"number"===r?(0===n&&""===e.value||e.value!=n)&&(e.value=""+n):e.value!==""+n&&(e.value=""+n);else if("submit"===r||"reset"===r)return void e.removeAttribute("value");t.hasOwnProperty("value")?Ae(e,t.type,n):t.hasOwnProperty("defaultValue")&&Ae(e,t.type,xe(t.defaultValue)),null==t.checked&&null!=t.defaultChecked&&(e.defaultChecked=!!t.defaultChecked)}function Ie(e,t,n){if(t.hasOwnProperty("value")||t.hasOwnProperty("defaultValue")){var r=t.type;if(!("submit"!==r&&"reset"!==r||void 0!==t.value&&null!==t.value))return;t=""+e._wrapperState.initialValue,n||t===e.value||(e.value=t),e.defaultValue=t}""!==(n=e.name)&&(e.name=""),e.defaultChecked=!e.defaultChecked,e.defaultChecked=!!e._wrapperState.initialChecked,""!==n&&(e.name=n)}function Ae(e,t,n){"number"===t&&e.ownerDocument.activeElement===e||(null==n?e.defaultValue=""+e._wrapperState.initialValue:e.defaultValue!==""+n&&(e.defaultValue=""+n))}function Pe(e,t){return e=o({children:void 0},t),(t=function(e){var t="";return r.Children.forEach(e,(function(e){null!=e&&(t+=e)})),t}(t.children))&&(e.children=t),e}function Re(e,t,n,r){if(e=e.options,t){t={};for(var o=0;o<n.length;o++)t["$"+n[o]]=!0;for(n=0;n<e.length;n++)o=t.hasOwnProperty("$"+e[n].value),e[n].selected!==o&&(e[n].selected=o),o&&r&&(e[n].defaultSelected=!0)}else{for(n=""+xe(n),t=null,o=0;o<e.length;o++){if(e[o].value===n)return e[o].selected=!0,void(r&&(e[o].defaultSelected=!0));null!==t||e[o].disabled||(t=e[o])}null!==t&&(t.selected=!0)}}function Ne(e,t){if(null!=t.dangerouslySetInnerHTML)throw Error(a(91));return o({},t,{value:void 0,defaultValue:void 0,children:""+e._wrapperState.initialValue})}function Le(e,t){var n=t.value;if(null==n){if(n=t.defaultValue,null!=(t=t.children)){if(null!=n)throw Error(a(92));if(Array.isArray(t)){if(!(1>=t.length))throw Error(a(93));t=t[0]}n=t}null==n&&(n="")}e._wrapperState={initialValue:xe(n)}}function Me(e,t){var n=xe(t.value),r=xe(t.defaultValue);null!=n&&((n=""+n)!==e.value&&(e.value=n),null==t.defaultValue&&e.defaultValue!==n&&(e.defaultValue=n)),null!=r&&(e.defaultValue=""+r)}function De(e){var t=e.textContent;t===e._wrapperState.initialValue&&""!==t&&null!==t&&(e.value=t)}"accent-height alignment-baseline arabic-form baseline-shift cap-height clip-path clip-rule color-interpolation color-interpolation-filters color-profile color-rendering dominant-baseline enable-background fill-opacity fill-rule flood-color flood-opacity font-family font-size font-size-adjust font-stretch font-style font-variant font-weight glyph-name glyph-orientation-horizontal glyph-orientation-vertical horiz-adv-x horiz-origin-x image-rendering letter-spacing lighting-color marker-end marker-mid marker-start overline-position overline-thickness paint-order panose-1 pointer-events rendering-intent shape-rendering stop-color stop-opacity strikethrough-position strikethrough-thickness stroke-dasharray stroke-dashoffset stroke-linecap stroke-linejoin stroke-miterlimit stroke-opacity stroke-width text-anchor text-decoration text-rendering underline-position underline-thickness unicode-bidi unicode-range units-per-em v-alphabetic v-hanging v-ideographic v-mathematical vector-effect vert-adv-y vert-origin-x vert-origin-y word-spacing writing-mode xmlns:xlink x-height".split(" ").forEach((function(e){var t=e.replace(be,we);ve[t]=new ye(t,1,!1,e,null,!1)})),"xlink:actuate xlink:arcrole xlink:role xlink:show xlink:title xlink:type".split(" ").forEach((function(e){var t=e.replace(be,we);ve[t]=new ye(t,1,!1,e,"http://www.w3.org/1999/xlink",!1)})),["xml:base","xml:lang","xml:space"].forEach((function(e){var t=e.replace(be,we);ve[t]=new ye(t,1,!1,e,"http://www.w3.org/XML/1998/namespace",!1)})),["tabIndex","crossOrigin"].forEach((function(e){ve[e]=new ye(e,1,!1,e.toLowerCase(),null,!1)})),ve.xlinkHref=new ye("xlinkHref",1,!1,"xlink:href","http://www.w3.org/1999/xlink",!0),["src","href","action","formAction"].forEach((function(e){ve[e]=new ye(e,1,!1,e.toLowerCase(),null,!0)}));var Fe={html:"http://www.w3.org/1999/xhtml",mathml:"http://www.w3.org/1998/Math/MathML",svg:"http://www.w3.org/2000/svg"};function Ue(e){switch(e){case"svg":return"http://www.w3.org/2000/svg";case"math":return"http://www.w3.org/1998/Math/MathML";default:return"http://www.w3.org/1999/xhtml"}}function ze(e,t){return null==e||"http://www.w3.org/1999/xhtml"===e?Ue(t):"http://www.w3.org/2000/svg"===e&&"foreignObject"===t?"http://www.w3.org/1999/xhtml":e}var Be,$e=function(e){return"undefined"!=typeof MSApp&&MSApp.execUnsafeLocalFunction?function(t,n,r,o){MSApp.execUnsafeLocalFunction((function(){return e(t,n)}))}:e}((function(e,t){if(e.namespaceURI!==Fe.svg||"innerHTML"in e)e.innerHTML=t;else{for((Be=Be||document.createElement("div")).innerHTML="<svg>"+t.valueOf().toString()+"</svg>",t=Be.firstChild;e.firstChild;)e.removeChild(e.firstChild);for(;t.firstChild;)e.appendChild(t.firstChild)}}));function qe(e,t){if(t){var n=e.firstChild;if(n&&n===e.lastChild&&3===n.nodeType)return void(n.nodeValue=t)}e.textContent=t}function We(e,t){var n={};return n[e.toLowerCase()]=t.toLowerCase(),n["Webkit"+e]="webkit"+t,n["Moz"+e]="moz"+t,n}var He={animationend:We("Animation","AnimationEnd"),animationiteration:We("Animation","AnimationIteration"),animationstart:We("Animation","AnimationStart"),transitionend:We("Transition","TransitionEnd")},Ve={},Ye={};function Ge(e){if(Ve[e])return Ve[e];if(!He[e])return e;var t,n=He[e];for(t in n)if(n.hasOwnProperty(t)&&t in Ye)return Ve[e]=n[t];return e}Z&&(Ye=document.createElement("div").style,"AnimationEvent"in window||(delete He.animationend.animation,delete He.animationiteration.animation,delete He.animationstart.animation),"TransitionEvent"in window||delete He.transitionend.transition);var Qe=Ge("animationend"),Xe=Ge("animationiteration"),Ke=Ge("animationstart"),Je=Ge("transitionend"),Ze="abort canplay canplaythrough durationchange emptied encrypted ended error loadeddata loadedmetadata loadstart pause play playing progress ratechange seeked seeking stalled suspend timeupdate volumechange waiting".split(" ");function et(e){var t=e,n=e;if(e.alternate)for(;t.return;)t=t.return;else{e=t;do{0!=(1026&(t=e).effectTag)&&(n=t.return),e=t.return}while(e)}return 3===t.tag?n:null}function tt(e){if(13===e.tag){var t=e.memoizedState;if(null===t&&(null!==(e=e.alternate)&&(t=e.memoizedState)),null!==t)return t.dehydrated}return null}function nt(e){if(et(e)!==e)throw Error(a(188))}function rt(e){if(!(e=function(e){var t=e.alternate;if(!t){if(null===(t=et(e)))throw Error(a(188));return t!==e?null:e}for(var n=e,r=t;;){var o=n.return;if(null===o)break;var i=o.alternate;if(null===i){if(null!==(r=o.return)){n=r;continue}break}if(o.child===i.child){for(i=o.child;i;){if(i===n)return nt(o),e;if(i===r)return nt(o),t;i=i.sibling}throw Error(a(188))}if(n.return!==r.return)n=o,r=i;else{for(var s=!1,l=o.child;l;){if(l===n){s=!0,n=o,r=i;break}if(l===r){s=!0,r=o,n=i;break}l=l.sibling}if(!s){for(l=i.child;l;){if(l===n){s=!0,n=i,r=o;break}if(l===r){s=!0,r=i,n=o;break}l=l.sibling}if(!s)throw Error(a(189))}}if(n.alternate!==r)throw Error(a(190))}if(3!==n.tag)throw Error(a(188));return n.stateNode.current===n?e:t}(e)))return null;for(var t=e;;){if(5===t.tag||6===t.tag)return t;if(t.child)t.child.return=t,t=t.child;else{if(t===e)break;for(;!t.sibling;){if(!t.return||t.return===e)return null;t=t.return}t.sibling.return=t.return,t=t.sibling}}return null}var ot,it,at,st=!1,lt=[],ct=null,ut=null,ft=null,pt=new Map,dt=new Map,ht=[],mt="mousedown mouseup touchcancel touchend touchstart auxclick dblclick pointercancel pointerdown pointerup dragend dragstart drop compositionend compositionstart keydown keypress keyup input textInput close cancel copy cut paste click change contextmenu reset submit".split(" "),gt="focus blur dragenter dragleave mouseover mouseout pointerover pointerout gotpointercapture lostpointercapture".split(" ");function yt(e,t,n,r){return{blockedOn:e,topLevelType:t,eventSystemFlags:32|n,nativeEvent:r}}function vt(e,t){switch(e){case"focus":case"blur":ct=null;break;case"dragenter":case"dragleave":ut=null;break;case"mouseover":case"mouseout":ft=null;break;case"pointerover":case"pointerout":pt.delete(t.pointerId);break;case"gotpointercapture":case"lostpointercapture":dt.delete(t.pointerId)}}function bt(e,t,n,r,o){return null===e||e.nativeEvent!==o?(e=yt(t,n,r,o),null!==t&&(null!==(t=dr(t))&&it(t)),e):(e.eventSystemFlags|=r,e)}function wt(e){var t=pr(e.target);if(null!==t){var n=et(t);if(null!==n)if(13===(t=n.tag)){if(null!==(t=tt(n)))return e.blockedOn=t,void i.unstable_runWithPriority(e.priority,(function(){at(n)}))}else if(3===t&&n.stateNode.hydrate)return void(e.blockedOn=3===n.tag?n.stateNode.containerInfo:null)}e.blockedOn=null}function xt(e){if(null!==e.blockedOn)return!1;var t=An(e.topLevelType,e.eventSystemFlags,e.nativeEvent);if(null!==t){var n=dr(t);return null!==n&&it(n),e.blockedOn=t,!1}return!0}function kt(e,t,n){xt(e)&&n.delete(t)}function Et(){for(st=!1;0<lt.length;){var e=lt[0];if(null!==e.blockedOn){null!==(e=dr(e.blockedOn))&&ot(e);break}var t=An(e.topLevelType,e.eventSystemFlags,e.nativeEvent);null!==t?e.blockedOn=t:lt.shift()}null!==ct&&xt(ct)&&(ct=null),null!==ut&&xt(ut)&&(ut=null),null!==ft&&xt(ft)&&(ft=null),pt.forEach(kt),dt.forEach(kt)}function Ot(e,t){e.blockedOn===t&&(e.blockedOn=null,st||(st=!0,i.unstable_scheduleCallback(i.unstable_NormalPriority,Et)))}function _t(e){function t(t){return Ot(t,e)}if(0<lt.length){Ot(lt[0],e);for(var n=1;n<lt.length;n++){var r=lt[n];r.blockedOn===e&&(r.blockedOn=null)}}for(null!==ct&&Ot(ct,e),null!==ut&&Ot(ut,e),null!==ft&&Ot(ft,e),pt.forEach(t),dt.forEach(t),n=0;n<ht.length;n++)(r=ht[n]).blockedOn===e&&(r.blockedOn=null);for(;0<ht.length&&null===(n=ht[0]).blockedOn;)wt(n),null===n.blockedOn&&ht.shift()}function St(e){return(e=e.target||e.srcElement||window).correspondingUseElement&&(e=e.correspondingUseElement),3===e.nodeType?e.parentNode:e}function Tt(e){do{e=e.return}while(e&&5!==e.tag);return e||null}function jt(e,t,n){(t=P(e,n.dispatchConfig.phasedRegistrationNames[t]))&&(n._dispatchListeners=S(n._dispatchListeners,t),n._dispatchInstances=S(n._dispatchInstances,e))}function Ct(e){if(e&&e.dispatchConfig.phasedRegistrationNames){for(var t=e._targetInst,n=[];t;)n.push(t),t=Tt(t);for(t=n.length;0<t--;)jt(n[t],"captured",e);for(t=0;t<n.length;t++)jt(n[t],"bubbled",e)}}function It(e,t,n){e&&n&&n.dispatchConfig.registrationName&&(t=P(e,n.dispatchConfig.registrationName))&&(n._dispatchListeners=S(n._dispatchListeners,t),n._dispatchInstances=S(n._dispatchInstances,e))}function At(e){e&&e.dispatchConfig.registrationName&&It(e._targetInst,null,e)}function Pt(e){T(e,Ct)}function Rt(){return!0}function Nt(){return!1}function Lt(e,t,n,r){for(var o in this.dispatchConfig=e,this._targetInst=t,this.nativeEvent=n,e=this.constructor.Interface)e.hasOwnProperty(o)&&((t=e[o])?this[o]=t(n):"target"===o?this.target=r:this[o]=n[o]);return this.isDefaultPrevented=(null!=n.defaultPrevented?n.defaultPrevented:!1===n.returnValue)?Rt:Nt,this.isPropagationStopped=Nt,this}function Mt(e,t,n,r){if(this.eventPool.length){var o=this.eventPool.pop();return this.call(o,e,t,n,r),o}return new this(e,t,n,r)}function Dt(e){if(!(e instanceof this))throw Error(a(279));e.destructor(),10>this.eventPool.length&&this.eventPool.push(e)}function Ft(e){e.eventPool=[],e.getPooled=Mt,e.release=Dt}o(Lt.prototype,{preventDefault:function(){this.defaultPrevented=!0;var e=this.nativeEvent;e&&(e.preventDefault?e.preventDefault():"unknown"!=typeof e.returnValue&&(e.returnValue=!1),this.isDefaultPrevented=Rt)},stopPropagation:function(){var e=this.nativeEvent;e&&(e.stopPropagation?e.stopPropagation():"unknown"!=typeof e.cancelBubble&&(e.cancelBubble=!0),this.isPropagationStopped=Rt)},persist:function(){this.isPersistent=Rt},isPersistent:Nt,destructor:function(){var e,t=this.constructor.Interface;for(e in t)this[e]=null;this.nativeEvent=this._targetInst=this.dispatchConfig=null,this.isPropagationStopped=this.isDefaultPrevented=Nt,this._dispatchInstances=this._dispatchListeners=null}}),Lt.Interface={type:null,target:null,currentTarget:function(){return null},eventPhase:null,bubbles:null,cancelable:null,timeStamp:function(e){return e.timeStamp||Date.now()},defaultPrevented:null,isTrusted:null},Lt.extend=function(e){function t(){}function n(){return r.apply(this,arguments)}var r=this;t.prototype=r.prototype;var i=new t;return o(i,n.prototype),n.prototype=i,n.prototype.constructor=n,n.Interface=o({},r.Interface,e),n.extend=r.extend,Ft(n),n},Ft(Lt);var Ut=Lt.extend({animationName:null,elapsedTime:null,pseudoElement:null}),zt=Lt.extend({clipboardData:function(e){return"clipboardData"in e?e.clipboardData:window.clipboardData}}),Bt=Lt.extend({view:null,detail:null}),$t=Bt.extend({relatedTarget:null});function qt(e){var t=e.keyCode;return"charCode"in e?0===(e=e.charCode)&&13===t&&(e=13):e=t,10===e&&(e=13),32<=e||13===e?e:0}var Wt={Esc:"Escape",Spacebar:" ",Left:"ArrowLeft",Up:"ArrowUp",Right:"ArrowRight",Down:"ArrowDown",Del:"Delete",Win:"OS",Menu:"ContextMenu",Apps:"ContextMenu",Scroll:"ScrollLock",MozPrintableKey:"Unidentified"},Ht={8:"Backspace",9:"Tab",12:"Clear",13:"Enter",16:"Shift",17:"Control",18:"Alt",19:"Pause",20:"CapsLock",27:"Escape",32:" ",33:"PageUp",34:"PageDown",35:"End",36:"Home",37:"ArrowLeft",38:"ArrowUp",39:"ArrowRight",40:"ArrowDown",45:"Insert",46:"Delete",112:"F1",113:"F2",114:"F3",115:"F4",116:"F5",117:"F6",118:"F7",119:"F8",120:"F9",121:"F10",122:"F11",123:"F12",144:"NumLock",145:"ScrollLock",224:"Meta"},Vt={Alt:"altKey",Control:"ctrlKey",Meta:"metaKey",Shift:"shiftKey"};function Yt(e){var t=this.nativeEvent;return t.getModifierState?t.getModifierState(e):!!(e=Vt[e])&&!!t[e]}function Gt(){return Yt}for(var Qt=Bt.extend({key:function(e){if(e.key){var t=Wt[e.key]||e.key;if("Unidentified"!==t)return t}return"keypress"===e.type?13===(e=qt(e))?"Enter":String.fromCharCode(e):"keydown"===e.type||"keyup"===e.type?Ht[e.keyCode]||"Unidentified":""},location:null,ctrlKey:null,shiftKey:null,altKey:null,metaKey:null,repeat:null,locale:null,getModifierState:Gt,charCode:function(e){return"keypress"===e.type?qt(e):0},keyCode:function(e){return"keydown"===e.type||"keyup"===e.type?e.keyCode:0},which:function(e){return"keypress"===e.type?qt(e):"keydown"===e.type||"keyup"===e.type?e.keyCode:0}}),Xt=0,Kt=0,Jt=!1,Zt=!1,en=Bt.extend({screenX:null,screenY:null,clientX:null,clientY:null,pageX:null,pageY:null,ctrlKey:null,shiftKey:null,altKey:null,metaKey:null,getModifierState:Gt,button:null,buttons:null,relatedTarget:function(e){return e.relatedTarget||(e.fromElement===e.srcElement?e.toElement:e.fromElement)},movementX:function(e){if("movementX"in e)return e.movementX;var t=Xt;return Xt=e.screenX,Jt?"mousemove"===e.type?e.screenX-t:0:(Jt=!0,0)},movementY:function(e){if("movementY"in e)return e.movementY;var t=Kt;return Kt=e.screenY,Zt?"mousemove"===e.type?e.screenY-t:0:(Zt=!0,0)}}),tn=en.extend({pointerId:null,width:null,height:null,pressure:null,tangentialPressure:null,tiltX:null,tiltY:null,twist:null,pointerType:null,isPrimary:null}),nn=en.extend({dataTransfer:null}),rn=Bt.extend({touches:null,targetTouches:null,changedTouches:null,altKey:null,metaKey:null,ctrlKey:null,shiftKey:null,getModifierState:Gt}),on=Lt.extend({propertyName:null,elapsedTime:null,pseudoElement:null}),an=en.extend({deltaX:function(e){return"deltaX"in e?e.deltaX:"wheelDeltaX"in e?-e.wheelDeltaX:0},deltaY:function(e){return"deltaY"in e?e.deltaY:"wheelDeltaY"in e?-e.wheelDeltaY:"wheelDelta"in e?-e.wheelDelta:0},deltaZ:null,deltaMode:null}),sn=[["blur","blur",0],["cancel","cancel",0],["click","click",0],["close","close",0],["contextmenu","contextMenu",0],["copy","copy",0],["cut","cut",0],["auxclick","auxClick",0],["dblclick","doubleClick",0],["dragend","dragEnd",0],["dragstart","dragStart",0],["drop","drop",0],["focus","focus",0],["input","input",0],["invalid","invalid",0],["keydown","keyDown",0],["keypress","keyPress",0],["keyup","keyUp",0],["mousedown","mouseDown",0],["mouseup","mouseUp",0],["paste","paste",0],["pause","pause",0],["play","play",0],["pointercancel","pointerCancel",0],["pointerdown","pointerDown",0],["pointerup","pointerUp",0],["ratechange","rateChange",0],["reset","reset",0],["seeked","seeked",0],["submit","submit",0],["touchcancel","touchCancel",0],["touchend","touchEnd",0],["touchstart","touchStart",0],["volumechange","volumeChange",0],["drag","drag",1],["dragenter","dragEnter",1],["dragexit","dragExit",1],["dragleave","dragLeave",1],["dragover","dragOver",1],["mousemove","mouseMove",1],["mouseout","mouseOut",1],["mouseover","mouseOver",1],["pointermove","pointerMove",1],["pointerout","pointerOut",1],["pointerover","pointerOver",1],["scroll","scroll",1],["toggle","toggle",1],["touchmove","touchMove",1],["wheel","wheel",1],["abort","abort",2],[Qe,"animationEnd",2],[Xe,"animationIteration",2],[Ke,"animationStart",2],["canplay","canPlay",2],["canplaythrough","canPlayThrough",2],["durationchange","durationChange",2],["emptied","emptied",2],["encrypted","encrypted",2],["ended","ended",2],["error","error",2],["gotpointercapture","gotPointerCapture",2],["load","load",2],["loadeddata","loadedData",2],["loadedmetadata","loadedMetadata",2],["loadstart","loadStart",2],["lostpointercapture","lostPointerCapture",2],["playing","playing",2],["progress","progress",2],["seeking","seeking",2],["stalled","stalled",2],["suspend","suspend",2],["timeupdate","timeUpdate",2],[Je,"transitionEnd",2],["waiting","waiting",2]],ln={},cn={},un=0;un<sn.length;un++){var fn=sn[un],pn=fn[0],dn=fn[1],hn=fn[2],mn="on"+(dn[0].toUpperCase()+dn.slice(1)),gn={phasedRegistrationNames:{bubbled:mn,captured:mn+"Capture"},dependencies:[pn],eventPriority:hn};ln[dn]=gn,cn[pn]=gn}var yn={eventTypes:ln,getEventPriority:function(e){return void 0!==(e=cn[e])?e.eventPriority:2},extractEvents:function(e,t,n,r){var o=cn[e];if(!o)return null;switch(e){case"keypress":if(0===qt(n))return null;case"keydown":case"keyup":e=Qt;break;case"blur":case"focus":e=$t;break;case"click":if(2===n.button)return null;case"auxclick":case"dblclick":case"mousedown":case"mousemove":case"mouseup":case"mouseout":case"mouseover":case"contextmenu":e=en;break;case"drag":case"dragend":case"dragenter":case"dragexit":case"dragleave":case"dragover":case"dragstart":case"drop":e=nn;break;case"touchcancel":case"touchend":case"touchmove":case"touchstart":e=rn;break;case Qe:case Xe:case Ke:e=Ut;break;case Je:e=on;break;case"scroll":e=Bt;break;case"wheel":e=an;break;case"copy":case"cut":case"paste":e=zt;break;case"gotpointercapture":case"lostpointercapture":case"pointercancel":case"pointerdown":case"pointermove":case"pointerout":case"pointerover":case"pointerup":e=tn;break;default:e=Lt}return Pt(t=e.getPooled(o,t,n,r)),t}},vn=i.unstable_UserBlockingPriority,bn=i.unstable_runWithPriority,wn=yn.getEventPriority,xn=10,kn=[];function En(e){var t=e.targetInst,n=t;do{if(!n){e.ancestors.push(n);break}var r=n;if(3===r.tag)r=r.stateNode.containerInfo;else{for(;r.return;)r=r.return;r=3!==r.tag?null:r.stateNode.containerInfo}if(!r)break;5!==(t=n.tag)&&6!==t||e.ancestors.push(n),n=pr(r)}while(n);for(n=0;n<e.ancestors.length;n++){t=e.ancestors[n];var o=St(e.nativeEvent);r=e.topLevelType;for(var i=e.nativeEvent,a=e.eventSystemFlags,s=null,l=0;l<f.length;l++){var c=f[l];c&&(c=c.extractEvents(r,t,i,o,a))&&(s=S(s,c))}I(s)}}var On=!0;function _n(e,t){Sn(t,e,!1)}function Sn(e,t,n){switch(wn(t)){case 0:var r=Tn.bind(null,t,1);break;case 1:r=jn.bind(null,t,1);break;default:r=In.bind(null,t,1)}n?e.addEventListener(t,r,!0):e.addEventListener(t,r,!1)}function Tn(e,t,n){ue||le();var r=In,o=ue;ue=!0;try{se(r,e,t,n)}finally{(ue=o)||pe()}}function jn(e,t,n){bn(vn,In.bind(null,e,t,n))}function Cn(e,t,n,r){if(kn.length){var o=kn.pop();o.topLevelType=e,o.eventSystemFlags=t,o.nativeEvent=n,o.targetInst=r,e=o}else e={topLevelType:e,eventSystemFlags:t,nativeEvent:n,targetInst:r,ancestors:[]};try{if(t=En,n=e,fe)t(n,void 0);else{fe=!0;try{ce(t,n,void 0)}finally{fe=!1,pe()}}}finally{e.topLevelType=null,e.nativeEvent=null,e.targetInst=null,e.ancestors.length=0,kn.length<xn&&kn.push(e)}}function In(e,t,n){if(On)if(0<lt.length&&-1<mt.indexOf(e))e=yt(null,e,t,n),lt.push(e);else{var r=An(e,t,n);null===r?vt(e,n):-1<mt.indexOf(e)?(e=yt(r,e,t,n),lt.push(e)):function(e,t,n,r){switch(t){case"focus":return ct=bt(ct,e,t,n,r),!0;case"dragenter":return ut=bt(ut,e,t,n,r),!0;case"mouseover":return ft=bt(ft,e,t,n,r),!0;case"pointerover":var o=r.pointerId;return pt.set(o,bt(pt.get(o)||null,e,t,n,r)),!0;case"gotpointercapture":return o=r.pointerId,dt.set(o,bt(dt.get(o)||null,e,t,n,r)),!0}return!1}(r,e,t,n)||(vt(e,n),Cn(e,t,n,null))}}function An(e,t,n){var r=St(n);if(null!==(r=pr(r))){var o=et(r);if(null===o)r=null;else{var i=o.tag;if(13===i){if(null!==(r=tt(o)))return r;r=null}else if(3===i){if(o.stateNode.hydrate)return 3===o.tag?o.stateNode.containerInfo:null;r=null}else o!==r&&(r=null)}}return Cn(e,t,n,r),null}function Pn(e){if(!Z)return!1;var t=(e="on"+e)in document;return t||((t=document.createElement("div")).setAttribute(e,"return;"),t="function"==typeof t[e]),t}var Rn=new("function"==typeof WeakMap?WeakMap:Map);function Nn(e){var t=Rn.get(e);return void 0===t&&(t=new Set,Rn.set(e,t)),t}function Ln(e,t,n){if(!n.has(e)){switch(e){case"scroll":Sn(t,"scroll",!0);break;case"focus":case"blur":Sn(t,"focus",!0),Sn(t,"blur",!0),n.add("blur"),n.add("focus");break;case"cancel":case"close":Pn(e)&&Sn(t,e,!0);break;case"invalid":case"submit":case"reset":break;default:-1===Ze.indexOf(e)&&_n(e,t)}n.add(e)}}var Mn={animationIterationCount:!0,borderImageOutset:!0,borderImageSlice:!0,borderImageWidth:!0,boxFlex:!0,boxFlexGroup:!0,boxOrdinalGroup:!0,columnCount:!0,columns:!0,flex:!0,flexGrow:!0,flexPositive:!0,flexShrink:!0,flexNegative:!0,flexOrder:!0,gridArea:!0,gridRow:!0,gridRowEnd:!0,gridRowSpan:!0,gridRowStart:!0,gridColumn:!0,gridColumnEnd:!0,gridColumnSpan:!0,gridColumnStart:!0,fontWeight:!0,lineClamp:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,tabSize:!0,widows:!0,zIndex:!0,zoom:!0,fillOpacity:!0,floodOpacity:!0,stopOpacity:!0,strokeDasharray:!0,strokeDashoffset:!0,strokeMiterlimit:!0,strokeOpacity:!0,strokeWidth:!0},Dn=["Webkit","ms","Moz","O"];function Fn(e,t,n){return null==t||"boolean"==typeof t||""===t?"":n||"number"!=typeof t||0===t||Mn.hasOwnProperty(e)&&Mn[e]?(""+t).trim():t+"px"}function Un(e,t){for(var n in e=e.style,t)if(t.hasOwnProperty(n)){var r=0===n.indexOf("--"),o=Fn(n,t[n],r);"float"===n&&(n="cssFloat"),r?e.setProperty(n,o):e[n]=o}}Object.keys(Mn).forEach((function(e){Dn.forEach((function(t){t=t+e.charAt(0).toUpperCase()+e.substring(1),Mn[t]=Mn[e]}))}));var zn=o({menuitem:!0},{area:!0,base:!0,br:!0,col:!0,embed:!0,hr:!0,img:!0,input:!0,keygen:!0,link:!0,meta:!0,param:!0,source:!0,track:!0,wbr:!0});function Bn(e,t){if(t){if(zn[e]&&(null!=t.children||null!=t.dangerouslySetInnerHTML))throw Error(a(137,e,""));if(null!=t.dangerouslySetInnerHTML){if(null!=t.children)throw Error(a(60));if(!("object"==typeof t.dangerouslySetInnerHTML&&"__html"in t.dangerouslySetInnerHTML))throw Error(a(61))}if(null!=t.style&&"object"!=typeof t.style)throw Error(a(62,""))}}function $n(e,t){if(-1===e.indexOf("-"))return"string"==typeof t.is;switch(e){case"annotation-xml":case"color-profile":case"font-face":case"font-face-src":case"font-face-uri":case"font-face-format":case"font-face-name":case"missing-glyph":return!1;default:return!0}}function qn(e,t){var n=Nn(e=9===e.nodeType||11===e.nodeType?e:e.ownerDocument);t=h[t];for(var r=0;r<t.length;r++)Ln(t[r],e,n)}function Wn(){}function Hn(e){if(void 0===(e=e||("undefined"!=typeof document?document:void 0)))return null;try{return e.activeElement||e.body}catch(t){return e.body}}function Vn(e){for(;e&&e.firstChild;)e=e.firstChild;return e}function Yn(e,t){var n,r=Vn(e);for(e=0;r;){if(3===r.nodeType){if(n=e+r.textContent.length,e<=t&&n>=t)return{node:r,offset:t-e};e=n}e:{for(;r;){if(r.nextSibling){r=r.nextSibling;break e}r=r.parentNode}r=void 0}r=Vn(r)}}function Gn(){for(var e=window,t=Hn();t instanceof e.HTMLIFrameElement;){try{var n="string"==typeof t.contentWindow.location.href}catch(e){n=!1}if(!n)break;t=Hn((e=t.contentWindow).document)}return t}function Qn(e){var t=e&&e.nodeName&&e.nodeName.toLowerCase();return t&&("input"===t&&("text"===e.type||"search"===e.type||"tel"===e.type||"url"===e.type||"password"===e.type)||"textarea"===t||"true"===e.contentEditable)}var Xn="$",Kn="/$",Jn="$?",Zn="$!",er=null,tr=null;function nr(e,t){switch(e){case"button":case"input":case"select":case"textarea":return!!t.autoFocus}return!1}function rr(e,t){return"textarea"===e||"option"===e||"noscript"===e||"string"==typeof t.children||"number"==typeof t.children||"object"==typeof t.dangerouslySetInnerHTML&&null!==t.dangerouslySetInnerHTML&&null!=t.dangerouslySetInnerHTML.__html}var or="function"==typeof setTimeout?setTimeout:void 0,ir="function"==typeof clearTimeout?clearTimeout:void 0;function ar(e){for(;null!=e;e=e.nextSibling){var t=e.nodeType;if(1===t||3===t)break}return e}function sr(e){e=e.previousSibling;for(var t=0;e;){if(8===e.nodeType){var n=e.data;if(n===Xn||n===Zn||n===Jn){if(0===t)return e;t--}else n===Kn&&t++}e=e.previousSibling}return null}var lr=Math.random().toString(36).slice(2),cr="__reactInternalInstance$"+lr,ur="__reactEventHandlers$"+lr,fr="__reactContainere$"+lr;function pr(e){var t=e[cr];if(t)return t;for(var n=e.parentNode;n;){if(t=n[fr]||n[cr]){if(n=t.alternate,null!==t.child||null!==n&&null!==n.child)for(e=sr(e);null!==e;){if(n=e[cr])return n;e=sr(e)}return t}n=(e=n).parentNode}return null}function dr(e){return!(e=e[cr]||e[fr])||5!==e.tag&&6!==e.tag&&13!==e.tag&&3!==e.tag?null:e}function hr(e){if(5===e.tag||6===e.tag)return e.stateNode;throw Error(a(33))}function mr(e){return e[ur]||null}var gr=null,yr=null,vr=null;function br(){if(vr)return vr;var e,t,n=yr,r=n.length,o="value"in gr?gr.value:gr.textContent,i=o.length;for(e=0;e<r&&n[e]===o[e];e++);var a=r-e;for(t=1;t<=a&&n[r-t]===o[i-t];t++);return vr=o.slice(e,1<t?1-t:void 0)}var wr=Lt.extend({data:null}),xr=Lt.extend({data:null}),kr=[9,13,27,32],Er=Z&&"CompositionEvent"in window,Or=null;Z&&"documentMode"in document&&(Or=document.documentMode);var _r=Z&&"TextEvent"in window&&!Or,Sr=Z&&(!Er||Or&&8<Or&&11>=Or),Tr=String.fromCharCode(32),jr={beforeInput:{phasedRegistrationNames:{bubbled:"onBeforeInput",captured:"onBeforeInputCapture"},dependencies:["compositionend","keypress","textInput","paste"]},compositionEnd:{phasedRegistrationNames:{bubbled:"onCompositionEnd",captured:"onCompositionEndCapture"},dependencies:"blur compositionend keydown keypress keyup mousedown".split(" ")},compositionStart:{phasedRegistrationNames:{bubbled:"onCompositionStart",captured:"onCompositionStartCapture"},dependencies:"blur compositionstart keydown keypress keyup mousedown".split(" ")},compositionUpdate:{phasedRegistrationNames:{bubbled:"onCompositionUpdate",captured:"onCompositionUpdateCapture"},dependencies:"blur compositionupdate keydown keypress keyup mousedown".split(" ")}},Cr=!1;function Ir(e,t){switch(e){case"keyup":return-1!==kr.indexOf(t.keyCode);case"keydown":return 229!==t.keyCode;case"keypress":case"mousedown":case"blur":return!0;default:return!1}}function Ar(e){return"object"==typeof(e=e.detail)&&"data"in e?e.data:null}var Pr=!1;var Rr={eventTypes:jr,extractEvents:function(e,t,n,r){var o;if(Er)e:{switch(e){case"compositionstart":var i=jr.compositionStart;break e;case"compositionend":i=jr.compositionEnd;break e;case"compositionupdate":i=jr.compositionUpdate;break e}i=void 0}else Pr?Ir(e,n)&&(i=jr.compositionEnd):"keydown"===e&&229===n.keyCode&&(i=jr.compositionStart);return i?(Sr&&"ko"!==n.locale&&(Pr||i!==jr.compositionStart?i===jr.compositionEnd&&Pr&&(o=br()):(yr="value"in(gr=r)?gr.value:gr.textContent,Pr=!0)),i=wr.getPooled(i,t,n,r),o?i.data=o:null!==(o=Ar(n))&&(i.data=o),Pt(i),o=i):o=null,(e=_r?function(e,t){switch(e){case"compositionend":return Ar(t);case"keypress":return 32!==t.which?null:(Cr=!0,Tr);case"textInput":return(e=t.data)===Tr&&Cr?null:e;default:return null}}(e,n):function(e,t){if(Pr)return"compositionend"===e||!Er&&Ir(e,t)?(e=br(),vr=yr=gr=null,Pr=!1,e):null;switch(e){case"paste":return null;case"keypress":if(!(t.ctrlKey||t.altKey||t.metaKey)||t.ctrlKey&&t.altKey){if(t.char&&1<t.char.length)return t.char;if(t.which)return String.fromCharCode(t.which)}return null;case"compositionend":return Sr&&"ko"!==t.locale?null:t.data;default:return null}}(e,n))?((t=xr.getPooled(jr.beforeInput,t,n,r)).data=e,Pt(t)):t=null,null===o?t:null===t?o:[o,t]}},Nr={color:!0,date:!0,datetime:!0,"datetime-local":!0,email:!0,month:!0,number:!0,password:!0,range:!0,search:!0,tel:!0,text:!0,time:!0,url:!0,week:!0};function Lr(e){var t=e&&e.nodeName&&e.nodeName.toLowerCase();return"input"===t?!!Nr[e.type]:"textarea"===t}var Mr={change:{phasedRegistrationNames:{bubbled:"onChange",captured:"onChangeCapture"},dependencies:"blur change click focus input keydown keyup selectionchange".split(" ")}};function Dr(e,t,n){return(e=Lt.getPooled(Mr.change,e,t,n)).type="change",oe(n),Pt(e),e}var Fr=null,Ur=null;function zr(e){I(e)}function Br(e){if(_e(hr(e)))return e}function $r(e,t){if("change"===e)return t}var qr=!1;function Wr(){Fr&&(Fr.detachEvent("onpropertychange",Hr),Ur=Fr=null)}function Hr(e){if("value"===e.propertyName&&Br(Ur))if(e=Dr(Ur,e,St(e)),ue)I(e);else{ue=!0;try{ae(zr,e)}finally{ue=!1,pe()}}}function Vr(e,t,n){"focus"===e?(Wr(),Ur=n,(Fr=t).attachEvent("onpropertychange",Hr)):"blur"===e&&Wr()}function Yr(e){if("selectionchange"===e||"keyup"===e||"keydown"===e)return Br(Ur)}function Gr(e,t){if("click"===e)return Br(t)}function Qr(e,t){if("input"===e||"change"===e)return Br(t)}Z&&(qr=Pn("input")&&(!document.documentMode||9<document.documentMode));var Xr,Kr={eventTypes:Mr,_isInputEventSupported:qr,extractEvents:function(e,t,n,r){var o=t?hr(t):window,i=o.nodeName&&o.nodeName.toLowerCase();if("select"===i||"input"===i&&"file"===o.type)var a=$r;else if(Lr(o))if(qr)a=Qr;else{a=Yr;var s=Vr}else(i=o.nodeName)&&"input"===i.toLowerCase()&&("checkbox"===o.type||"radio"===o.type)&&(a=Gr);if(a&&(a=a(e,t)))return Dr(a,n,r);s&&s(e,o,t),"blur"===e&&(e=o._wrapperState)&&e.controlled&&"number"===o.type&&Ae(o,"number",o.value)}},Jr={mouseEnter:{registrationName:"onMouseEnter",dependencies:["mouseout","mouseover"]},mouseLeave:{registrationName:"onMouseLeave",dependencies:["mouseout","mouseover"]},pointerEnter:{registrationName:"onPointerEnter",dependencies:["pointerout","pointerover"]},pointerLeave:{registrationName:"onPointerLeave",dependencies:["pointerout","pointerover"]}},Zr={eventTypes:Jr,extractEvents:function(e,t,n,r,o){var i="mouseover"===e||"pointerover"===e,a="mouseout"===e||"pointerout"===e;if(i&&0==(32&o)&&(n.relatedTarget||n.fromElement)||!a&&!i)return null;if(o=r.window===r?r:(o=r.ownerDocument)?o.defaultView||o.parentWindow:window,a?(a=t,null!==(t=(t=n.relatedTarget||n.toElement)?pr(t):null)&&(t!==(i=et(t))||5!==t.tag&&6!==t.tag)&&(t=null)):a=null,a===t)return null;if("mouseout"===e||"mouseover"===e)var s=en,l=Jr.mouseLeave,c=Jr.mouseEnter,u="mouse";else"pointerout"!==e&&"pointerover"!==e||(s=tn,l=Jr.pointerLeave,c=Jr.pointerEnter,u="pointer");if(e=null==a?o:hr(a),o=null==t?o:hr(t),(l=s.getPooled(l,a,n,r)).type=u+"leave",l.target=e,l.relatedTarget=o,(r=s.getPooled(c,t,n,r)).type=u+"enter",r.target=o,r.relatedTarget=e,u=t,(s=a)&&u)e:{for(e=u,a=0,t=c=s;t;t=Tt(t))a++;for(t=0,o=e;o;o=Tt(o))t++;for(;0<a-t;)c=Tt(c),a--;for(;0<t-a;)e=Tt(e),t--;for(;a--;){if(c===e||c===e.alternate)break e;c=Tt(c),e=Tt(e)}c=null}else c=null;for(e=c,c=[];s&&s!==e&&(null===(a=s.alternate)||a!==e);)c.push(s),s=Tt(s);for(s=[];u&&u!==e&&(null===(a=u.alternate)||a!==e);)s.push(u),u=Tt(u);for(u=0;u<c.length;u++)It(c[u],"bubbled",l);for(u=s.length;0<u--;)It(s[u],"captured",r);return n===Xr?(Xr=null,[l]):(Xr=n,[l,r])}};var eo="function"==typeof Object.is?Object.is:function(e,t){return e===t&&(0!==e||1/e==1/t)||e!=e&&t!=t},to=Object.prototype.hasOwnProperty;function no(e,t){if(eo(e,t))return!0;if("object"!=typeof e||null===e||"object"!=typeof t||null===t)return!1;var n=Object.keys(e),r=Object.keys(t);if(n.length!==r.length)return!1;for(r=0;r<n.length;r++)if(!to.call(t,n[r])||!eo(e[n[r]],t[n[r]]))return!1;return!0}var ro=Z&&"documentMode"in document&&11>=document.documentMode,oo={select:{phasedRegistrationNames:{bubbled:"onSelect",captured:"onSelectCapture"},dependencies:"blur contextmenu dragend focus keydown keyup mousedown mouseup selectionchange".split(" ")}},io=null,ao=null,so=null,lo=!1;function co(e,t){var n=t.window===t?t.document:9===t.nodeType?t:t.ownerDocument;return lo||null==io||io!==Hn(n)?null:("selectionStart"in(n=io)&&Qn(n)?n={start:n.selectionStart,end:n.selectionEnd}:n={anchorNode:(n=(n.ownerDocument&&n.ownerDocument.defaultView||window).getSelection()).anchorNode,anchorOffset:n.anchorOffset,focusNode:n.focusNode,focusOffset:n.focusOffset},so&&no(so,n)?null:(so=n,(e=Lt.getPooled(oo.select,ao,e,t)).type="select",e.target=io,Pt(e),e))}var uo={eventTypes:oo,extractEvents:function(e,t,n,r){var o,i=r.window===r?r.document:9===r.nodeType?r:r.ownerDocument;if(!(o=!i)){e:{i=Nn(i),o=h.onSelect;for(var a=0;a<o.length;a++)if(!i.has(o[a])){i=!1;break e}i=!0}o=!i}if(o)return null;switch(i=t?hr(t):window,e){case"focus":(Lr(i)||"true"===i.contentEditable)&&(io=i,ao=t,so=null);break;case"blur":so=ao=io=null;break;case"mousedown":lo=!0;break;case"contextmenu":case"mouseup":case"dragend":return lo=!1,co(n,r);case"selectionchange":if(ro)break;case"keydown":case"keyup":return co(n,r)}return null}};A.injectEventPluginOrder("ResponderEventPlugin SimpleEventPlugin EnterLeaveEventPlugin ChangeEventPlugin SelectEventPlugin BeforeInputEventPlugin".split(" ")),k=mr,E=dr,O=hr,A.injectEventPluginsByName({SimpleEventPlugin:yn,EnterLeaveEventPlugin:Zr,ChangeEventPlugin:Kr,SelectEventPlugin:uo,BeforeInputEventPlugin:Rr}),new Set;var fo=[],po=-1;function ho(e){0>po||(e.current=fo[po],fo[po]=null,po--)}function mo(e,t){po++,fo[po]=e.current,e.current=t}var go={},yo={current:go},vo={current:!1},bo=go;function wo(e,t){var n=e.type.contextTypes;if(!n)return go;var r=e.stateNode;if(r&&r.__reactInternalMemoizedUnmaskedChildContext===t)return r.__reactInternalMemoizedMaskedChildContext;var o,i={};for(o in n)i[o]=t[o];return r&&((e=e.stateNode).__reactInternalMemoizedUnmaskedChildContext=t,e.__reactInternalMemoizedMaskedChildContext=i),i}function xo(e){return null!=(e=e.childContextTypes)}function ko(e){ho(vo),ho(yo)}function Eo(e){ho(vo),ho(yo)}function Oo(e,t,n){if(yo.current!==go)throw Error(a(168));mo(yo,t),mo(vo,n)}function _o(e,t,n){var r=e.stateNode;if(e=t.childContextTypes,"function"!=typeof r.getChildContext)return n;for(var i in r=r.getChildContext())if(!(i in e))throw Error(a(108,K(t)||"Unknown",i));return o({},n,{},r)}function So(e){var t=e.stateNode;return t=t&&t.__reactInternalMemoizedMergedChildContext||go,bo=yo.current,mo(yo,t),mo(vo,vo.current),!0}function To(e,t,n){var r=e.stateNode;if(!r)throw Error(a(169));n?(t=_o(e,t,bo),r.__reactInternalMemoizedMergedChildContext=t,ho(vo),ho(yo),mo(yo,t)):ho(vo),mo(vo,n)}var jo=i.unstable_runWithPriority,Co=i.unstable_scheduleCallback,Io=i.unstable_cancelCallback,Ao=i.unstable_shouldYield,Po=i.unstable_requestPaint,Ro=i.unstable_now,No=i.unstable_getCurrentPriorityLevel,Lo=i.unstable_ImmediatePriority,Mo=i.unstable_UserBlockingPriority,Do=i.unstable_NormalPriority,Fo=i.unstable_LowPriority,Uo=i.unstable_IdlePriority,zo={},Bo=void 0!==Po?Po:function(){},$o=null,qo=null,Wo=!1,Ho=Ro(),Vo=1e4>Ho?Ro:function(){return Ro()-Ho};function Yo(){switch(No()){case Lo:return 99;case Mo:return 98;case Do:return 97;case Fo:return 96;case Uo:return 95;default:throw Error(a(332))}}function Go(e){switch(e){case 99:return Lo;case 98:return Mo;case 97:return Do;case 96:return Fo;case 95:return Uo;default:throw Error(a(332))}}function Qo(e,t){return e=Go(e),jo(e,t)}function Xo(e,t,n){return e=Go(e),Co(e,t,n)}function Ko(e){return null===$o?($o=[e],qo=Co(Lo,Zo)):$o.push(e),zo}function Jo(){if(null!==qo){var e=qo;qo=null,Io(e)}Zo()}function Zo(){if(!Wo&&null!==$o){Wo=!0;var e=0;try{var t=$o;Qo(99,(function(){for(;e<t.length;e++){var n=t[e];do{n=n(!0)}while(null!==n)}})),$o=null}catch(t){throw null!==$o&&($o=$o.slice(e+1)),Co(Lo,Jo),t}finally{Wo=!1}}}var ei=3;function ti(e,t,n){return 1073741821-(1+((1073741821-e+t/10)/(n/=10)|0))*n}function ni(e,t){if(e&&e.defaultProps)for(var n in t=o({},t),e=e.defaultProps)void 0===t[n]&&(t[n]=e[n]);return t}var ri={current:null},oi=null,ii=null,ai=null;function si(){ai=ii=oi=null}function li(e,t){var n=e.type._context;mo(ri,n._currentValue),n._currentValue=t}function ci(e){var t=ri.current;ho(ri),e.type._context._currentValue=t}function ui(e,t){for(;null!==e;){var n=e.alternate;if(e.childExpirationTime<t)e.childExpirationTime=t,null!==n&&n.childExpirationTime<t&&(n.childExpirationTime=t);else{if(!(null!==n&&n.childExpirationTime<t))break;n.childExpirationTime=t}e=e.return}}function fi(e,t){oi=e,ai=ii=null,null!==(e=e.dependencies)&&null!==e.firstContext&&(e.expirationTime>=t&&(Ha=!0),e.firstContext=null)}function pi(e,t){if(ai!==e&&!1!==t&&0!==t)if("number"==typeof t&&1073741823!==t||(ai=e,t=1073741823),t={context:e,observedBits:t,next:null},null===ii){if(null===oi)throw Error(a(308));ii=t,oi.dependencies={expirationTime:0,firstContext:t,responders:null}}else ii=ii.next=t;return e._currentValue}var di=!1;function hi(e){return{baseState:e,firstUpdate:null,lastUpdate:null,firstCapturedUpdate:null,lastCapturedUpdate:null,firstEffect:null,lastEffect:null,firstCapturedEffect:null,lastCapturedEffect:null}}function mi(e){return{baseState:e.baseState,firstUpdate:e.firstUpdate,lastUpdate:e.lastUpdate,firstCapturedUpdate:null,lastCapturedUpdate:null,firstEffect:null,lastEffect:null,firstCapturedEffect:null,lastCapturedEffect:null}}function gi(e,t){return{expirationTime:e,suspenseConfig:t,tag:0,payload:null,callback:null,next:null,nextEffect:null}}function yi(e,t){null===e.lastUpdate?e.firstUpdate=e.lastUpdate=t:(e.lastUpdate.next=t,e.lastUpdate=t)}function vi(e,t){var n=e.alternate;if(null===n){var r=e.updateQueue,o=null;null===r&&(r=e.updateQueue=hi(e.memoizedState))}else r=e.updateQueue,o=n.updateQueue,null===r?null===o?(r=e.updateQueue=hi(e.memoizedState),o=n.updateQueue=hi(n.memoizedState)):r=e.updateQueue=mi(o):null===o&&(o=n.updateQueue=mi(r));null===o||r===o?yi(r,t):null===r.lastUpdate||null===o.lastUpdate?(yi(r,t),yi(o,t)):(yi(r,t),o.lastUpdate=t)}function bi(e,t){var n=e.updateQueue;null===(n=null===n?e.updateQueue=hi(e.memoizedState):wi(e,n)).lastCapturedUpdate?n.firstCapturedUpdate=n.lastCapturedUpdate=t:(n.lastCapturedUpdate.next=t,n.lastCapturedUpdate=t)}function wi(e,t){var n=e.alternate;return null!==n&&t===n.updateQueue&&(t=e.updateQueue=mi(t)),t}function xi(e,t,n,r,i,a){switch(n.tag){case 1:return"function"==typeof(e=n.payload)?e.call(a,r,i):e;case 3:e.effectTag=-4097&e.effectTag|64;case 0:if(null==(i="function"==typeof(e=n.payload)?e.call(a,r,i):e))break;return o({},r,i);case 2:di=!0}return r}function ki(e,t,n,r,o){di=!1;for(var i=(t=wi(e,t)).baseState,a=null,s=0,l=t.firstUpdate,c=i;null!==l;){var u=l.expirationTime;u<o?(null===a&&(a=l,i=c),s<u&&(s=u)):(Tl(u,l.suspenseConfig),c=xi(e,0,l,c,n,r),null!==l.callback&&(e.effectTag|=32,l.nextEffect=null,null===t.lastEffect?t.firstEffect=t.lastEffect=l:(t.lastEffect.nextEffect=l,t.lastEffect=l))),l=l.next}for(u=null,l=t.firstCapturedUpdate;null!==l;){var f=l.expirationTime;f<o?(null===u&&(u=l,null===a&&(i=c)),s<f&&(s=f)):(c=xi(e,0,l,c,n,r),null!==l.callback&&(e.effectTag|=32,l.nextEffect=null,null===t.lastCapturedEffect?t.firstCapturedEffect=t.lastCapturedEffect=l:(t.lastCapturedEffect.nextEffect=l,t.lastCapturedEffect=l))),l=l.next}null===a&&(t.lastUpdate=null),null===u?t.lastCapturedUpdate=null:e.effectTag|=32,null===a&&null===u&&(i=c),t.baseState=i,t.firstUpdate=a,t.firstCapturedUpdate=u,jl(s),e.expirationTime=s,e.memoizedState=c}function Ei(e,t,n){null!==t.firstCapturedUpdate&&(null!==t.lastUpdate&&(t.lastUpdate.next=t.firstCapturedUpdate,t.lastUpdate=t.lastCapturedUpdate),t.firstCapturedUpdate=t.lastCapturedUpdate=null),Oi(t.firstEffect,n),t.firstEffect=t.lastEffect=null,Oi(t.firstCapturedEffect,n),t.firstCapturedEffect=t.lastCapturedEffect=null}function Oi(e,t){for(;null!==e;){var n=e.callback;if(null!==n){e.callback=null;var r=t;if("function"!=typeof n)throw Error(a(191,n));n.call(r)}e=e.nextEffect}}var _i=R.ReactCurrentBatchConfig,Si=(new r.Component).refs;function Ti(e,t,n,r){n=null==(n=n(r,t=e.memoizedState))?t:o({},t,n),e.memoizedState=n,null!==(r=e.updateQueue)&&0===e.expirationTime&&(r.baseState=n)}var ji={isMounted:function(e){return!!(e=e._reactInternalFiber)&&et(e)===e},enqueueSetState:function(e,t,n){e=e._reactInternalFiber;var r=hl(),o=_i.suspense;(o=gi(r=ml(r,e,o),o)).payload=t,null!=n&&(o.callback=n),vi(e,o),gl(e,r)},enqueueReplaceState:function(e,t,n){e=e._reactInternalFiber;var r=hl(),o=_i.suspense;(o=gi(r=ml(r,e,o),o)).tag=1,o.payload=t,null!=n&&(o.callback=n),vi(e,o),gl(e,r)},enqueueForceUpdate:function(e,t){e=e._reactInternalFiber;var n=hl(),r=_i.suspense;(r=gi(n=ml(n,e,r),r)).tag=2,null!=t&&(r.callback=t),vi(e,r),gl(e,n)}};function Ci(e,t,n,r,o,i,a){return"function"==typeof(e=e.stateNode).shouldComponentUpdate?e.shouldComponentUpdate(r,i,a):!t.prototype||!t.prototype.isPureReactComponent||(!no(n,r)||!no(o,i))}function Ii(e,t,n){var r=!1,o=go,i=t.contextType;return"object"==typeof i&&null!==i?i=pi(i):(o=xo(t)?bo:yo.current,i=(r=null!=(r=t.contextTypes))?wo(e,o):go),t=new t(n,i),e.memoizedState=null!==t.state&&void 0!==t.state?t.state:null,t.updater=ji,e.stateNode=t,t._reactInternalFiber=e,r&&((e=e.stateNode).__reactInternalMemoizedUnmaskedChildContext=o,e.__reactInternalMemoizedMaskedChildContext=i),t}function Ai(e,t,n,r){e=t.state,"function"==typeof t.componentWillReceiveProps&&t.componentWillReceiveProps(n,r),"function"==typeof t.UNSAFE_componentWillReceiveProps&&t.UNSAFE_componentWillReceiveProps(n,r),t.state!==e&&ji.enqueueReplaceState(t,t.state,null)}function Pi(e,t,n,r){var o=e.stateNode;o.props=n,o.state=e.memoizedState,o.refs=Si;var i=t.contextType;"object"==typeof i&&null!==i?o.context=pi(i):(i=xo(t)?bo:yo.current,o.context=wo(e,i)),null!==(i=e.updateQueue)&&(ki(e,i,n,o,r),o.state=e.memoizedState),"function"==typeof(i=t.getDerivedStateFromProps)&&(Ti(e,t,i,n),o.state=e.memoizedState),"function"==typeof t.getDerivedStateFromProps||"function"==typeof o.getSnapshotBeforeUpdate||"function"!=typeof o.UNSAFE_componentWillMount&&"function"!=typeof o.componentWillMount||(t=o.state,"function"==typeof o.componentWillMount&&o.componentWillMount(),"function"==typeof o.UNSAFE_componentWillMount&&o.UNSAFE_componentWillMount(),t!==o.state&&ji.enqueueReplaceState(o,o.state,null),null!==(i=e.updateQueue)&&(ki(e,i,n,o,r),o.state=e.memoizedState)),"function"==typeof o.componentDidMount&&(e.effectTag|=4)}var Ri=Array.isArray;function Ni(e,t,n){if(null!==(e=n.ref)&&"function"!=typeof e&&"object"!=typeof e){if(n._owner){if(n=n._owner){if(1!==n.tag)throw Error(a(309));var r=n.stateNode}if(!r)throw Error(a(147,e));var o=""+e;return null!==t&&null!==t.ref&&"function"==typeof t.ref&&t.ref._stringRef===o?t.ref:((t=function(e){var t=r.refs;t===Si&&(t=r.refs={}),null===e?delete t[o]:t[o]=e})._stringRef=o,t)}if("string"!=typeof e)throw Error(a(284));if(!n._owner)throw Error(a(290,e))}return e}function Li(e,t){if("textarea"!==e.type)throw Error(a(31,"[object Object]"===Object.prototype.toString.call(t)?"object with keys {"+Object.keys(t).join(", ")+"}":t,""))}function Mi(e){function t(t,n){if(e){var r=t.lastEffect;null!==r?(r.nextEffect=n,t.lastEffect=n):t.firstEffect=t.lastEffect=n,n.nextEffect=null,n.effectTag=8}}function n(n,r){if(!e)return null;for(;null!==r;)t(n,r),r=r.sibling;return null}function r(e,t){for(e=new Map;null!==t;)null!==t.key?e.set(t.key,t):e.set(t.index,t),t=t.sibling;return e}function o(e,t,n){return(e=Gl(e,t)).index=0,e.sibling=null,e}function i(t,n,r){return t.index=r,e?null!==(r=t.alternate)?(r=r.index)<n?(t.effectTag=2,n):r:(t.effectTag=2,n):n}function s(t){return e&&null===t.alternate&&(t.effectTag=2),t}function l(e,t,n,r){return null===t||6!==t.tag?((t=Kl(n,e.mode,r)).return=e,t):((t=o(t,n)).return=e,t)}function c(e,t,n,r){return null!==t&&t.elementType===n.type?((r=o(t,n.props)).ref=Ni(e,t,n),r.return=e,r):((r=Ql(n.type,n.key,n.props,null,e.mode,r)).ref=Ni(e,t,n),r.return=e,r)}function u(e,t,n,r){return null===t||4!==t.tag||t.stateNode.containerInfo!==n.containerInfo||t.stateNode.implementation!==n.implementation?((t=Jl(n,e.mode,r)).return=e,t):((t=o(t,n.children||[])).return=e,t)}function f(e,t,n,r,i){return null===t||7!==t.tag?((t=Xl(n,e.mode,r,i)).return=e,t):((t=o(t,n)).return=e,t)}function p(e,t,n){if("string"==typeof t||"number"==typeof t)return(t=Kl(""+t,e.mode,n)).return=e,t;if("object"==typeof t&&null!==t){switch(t.$$typeof){case M:return(n=Ql(t.type,t.key,t.props,null,e.mode,n)).ref=Ni(e,null,t),n.return=e,n;case D:return(t=Jl(t,e.mode,n)).return=e,t}if(Ri(t)||X(t))return(t=Xl(t,e.mode,n,null)).return=e,t;Li(e,t)}return null}function d(e,t,n,r){var o=null!==t?t.key:null;if("string"==typeof n||"number"==typeof n)return null!==o?null:l(e,t,""+n,r);if("object"==typeof n&&null!==n){switch(n.$$typeof){case M:return n.key===o?n.type===F?f(e,t,n.props.children,r,o):c(e,t,n,r):null;case D:return n.key===o?u(e,t,n,r):null}if(Ri(n)||X(n))return null!==o?null:f(e,t,n,r,null);Li(e,n)}return null}function h(e,t,n,r,o){if("string"==typeof r||"number"==typeof r)return l(t,e=e.get(n)||null,""+r,o);if("object"==typeof r&&null!==r){switch(r.$$typeof){case M:return e=e.get(null===r.key?n:r.key)||null,r.type===F?f(t,e,r.props.children,o,r.key):c(t,e,r,o);case D:return u(t,e=e.get(null===r.key?n:r.key)||null,r,o)}if(Ri(r)||X(r))return f(t,e=e.get(n)||null,r,o,null);Li(t,r)}return null}function m(o,a,s,l){for(var c=null,u=null,f=a,m=a=0,g=null;null!==f&&m<s.length;m++){f.index>m?(g=f,f=null):g=f.sibling;var y=d(o,f,s[m],l);if(null===y){null===f&&(f=g);break}e&&f&&null===y.alternate&&t(o,f),a=i(y,a,m),null===u?c=y:u.sibling=y,u=y,f=g}if(m===s.length)return n(o,f),c;if(null===f){for(;m<s.length;m++)null!==(f=p(o,s[m],l))&&(a=i(f,a,m),null===u?c=f:u.sibling=f,u=f);return c}for(f=r(o,f);m<s.length;m++)null!==(g=h(f,o,m,s[m],l))&&(e&&null!==g.alternate&&f.delete(null===g.key?m:g.key),a=i(g,a,m),null===u?c=g:u.sibling=g,u=g);return e&&f.forEach((function(e){return t(o,e)})),c}function g(o,s,l,c){var u=X(l);if("function"!=typeof u)throw Error(a(150));if(null==(l=u.call(l)))throw Error(a(151));for(var f=u=null,m=s,g=s=0,y=null,v=l.next();null!==m&&!v.done;g++,v=l.next()){m.index>g?(y=m,m=null):y=m.sibling;var b=d(o,m,v.value,c);if(null===b){null===m&&(m=y);break}e&&m&&null===b.alternate&&t(o,m),s=i(b,s,g),null===f?u=b:f.sibling=b,f=b,m=y}if(v.done)return n(o,m),u;if(null===m){for(;!v.done;g++,v=l.next())null!==(v=p(o,v.value,c))&&(s=i(v,s,g),null===f?u=v:f.sibling=v,f=v);return u}for(m=r(o,m);!v.done;g++,v=l.next())null!==(v=h(m,o,g,v.value,c))&&(e&&null!==v.alternate&&m.delete(null===v.key?g:v.key),s=i(v,s,g),null===f?u=v:f.sibling=v,f=v);return e&&m.forEach((function(e){return t(o,e)})),u}return function(e,r,i,l){var c="object"==typeof i&&null!==i&&i.type===F&&null===i.key;c&&(i=i.props.children);var u="object"==typeof i&&null!==i;if(u)switch(i.$$typeof){case M:e:{for(u=i.key,c=r;null!==c;){if(c.key===u){if(7===c.tag?i.type===F:c.elementType===i.type){n(e,c.sibling),(r=o(c,i.type===F?i.props.children:i.props)).ref=Ni(e,c,i),r.return=e,e=r;break e}n(e,c);break}t(e,c),c=c.sibling}i.type===F?((r=Xl(i.props.children,e.mode,l,i.key)).return=e,e=r):((l=Ql(i.type,i.key,i.props,null,e.mode,l)).ref=Ni(e,r,i),l.return=e,e=l)}return s(e);case D:e:{for(c=i.key;null!==r;){if(r.key===c){if(4===r.tag&&r.stateNode.containerInfo===i.containerInfo&&r.stateNode.implementation===i.implementation){n(e,r.sibling),(r=o(r,i.children||[])).return=e,e=r;break e}n(e,r);break}t(e,r),r=r.sibling}(r=Jl(i,e.mode,l)).return=e,e=r}return s(e)}if("string"==typeof i||"number"==typeof i)return i=""+i,null!==r&&6===r.tag?(n(e,r.sibling),(r=o(r,i)).return=e,e=r):(n(e,r),(r=Kl(i,e.mode,l)).return=e,e=r),s(e);if(Ri(i))return m(e,r,i,l);if(X(i))return g(e,r,i,l);if(u&&Li(e,i),void 0===i&&!c)switch(e.tag){case 1:case 0:throw e=e.type,Error(a(152,e.displayName||e.name||"Component"))}return n(e,r)}}var Di=Mi(!0),Fi=Mi(!1),Ui={},zi={current:Ui},Bi={current:Ui},$i={current:Ui};function qi(e){if(e===Ui)throw Error(a(174));return e}function Wi(e,t){mo($i,t),mo(Bi,e),mo(zi,Ui);var n=t.nodeType;switch(n){case 9:case 11:t=(t=t.documentElement)?t.namespaceURI:ze(null,"");break;default:t=ze(t=(n=8===n?t.parentNode:t).namespaceURI||null,n=n.tagName)}ho(zi),mo(zi,t)}function Hi(e){ho(zi),ho(Bi),ho($i)}function Vi(e){qi($i.current);var t=qi(zi.current),n=ze(t,e.type);t!==n&&(mo(Bi,e),mo(zi,n))}function Yi(e){Bi.current===e&&(ho(zi),ho(Bi))}var Gi={current:0};function Qi(e){for(var t=e;null!==t;){if(13===t.tag){var n=t.memoizedState;if(null!==n&&(null===(n=n.dehydrated)||n.data===Jn||n.data===Zn))return t}else if(19===t.tag&&void 0!==t.memoizedProps.revealOrder){if(0!=(64&t.effectTag))return t}else if(null!==t.child){t.child.return=t,t=t.child;continue}if(t===e)break;for(;null===t.sibling;){if(null===t.return||t.return===e)return null;t=t.return}t.sibling.return=t.return,t=t.sibling}return null}function Xi(e,t){return{responder:e,props:t}}var Ki=R.ReactCurrentDispatcher,Ji=R.ReactCurrentBatchConfig,Zi=0,ea=null,ta=null,na=null,ra=null,oa=null,ia=null,aa=0,sa=null,la=0,ca=!1,ua=null,fa=0;function pa(){throw Error(a(321))}function da(e,t){if(null===t)return!1;for(var n=0;n<t.length&&n<e.length;n++)if(!eo(e[n],t[n]))return!1;return!0}function ha(e,t,n,r,o,i){if(Zi=i,ea=t,na=null!==e?e.memoizedState:null,Ki.current=null===na?Ra:Na,t=n(r,o),ca){do{ca=!1,fa+=1,na=null!==e?e.memoizedState:null,ia=ra,sa=oa=ta=null,Ki.current=Na,t=n(r,o)}while(ca);ua=null,fa=0}if(Ki.current=Pa,(e=ea).memoizedState=ra,e.expirationTime=aa,e.updateQueue=sa,e.effectTag|=la,e=null!==ta&&null!==ta.next,Zi=0,ia=oa=ra=na=ta=ea=null,aa=0,sa=null,la=0,e)throw Error(a(300));return t}function ma(){Ki.current=Pa,Zi=0,ia=oa=ra=na=ta=ea=null,aa=0,sa=null,la=0,ca=!1,ua=null,fa=0}function ga(){var e={memoizedState:null,baseState:null,queue:null,baseUpdate:null,next:null};return null===oa?ra=oa=e:oa=oa.next=e,oa}function ya(){if(null!==ia)ia=(oa=ia).next,na=null!==(ta=na)?ta.next:null;else{if(null===na)throw Error(a(310));var e={memoizedState:(ta=na).memoizedState,baseState:ta.baseState,queue:ta.queue,baseUpdate:ta.baseUpdate,next:null};oa=null===oa?ra=e:oa.next=e,na=ta.next}return oa}function va(e,t){return"function"==typeof t?t(e):t}function ba(e){var t=ya(),n=t.queue;if(null===n)throw Error(a(311));if(n.lastRenderedReducer=e,0<fa){var r=n.dispatch;if(null!==ua){var o=ua.get(n);if(void 0!==o){ua.delete(n);var i=t.memoizedState;do{i=e(i,o.action),o=o.next}while(null!==o);return eo(i,t.memoizedState)||(Ha=!0),t.memoizedState=i,t.baseUpdate===n.last&&(t.baseState=i),n.lastRenderedState=i,[i,r]}}return[t.memoizedState,r]}r=n.last;var s=t.baseUpdate;if(i=t.baseState,null!==s?(null!==r&&(r.next=null),r=s.next):r=null!==r?r.next:null,null!==r){var l=o=null,c=r,u=!1;do{var f=c.expirationTime;f<Zi?(u||(u=!0,l=s,o=i),f>aa&&jl(aa=f)):(Tl(f,c.suspenseConfig),i=c.eagerReducer===e?c.eagerState:e(i,c.action)),s=c,c=c.next}while(null!==c&&c!==r);u||(l=s,o=i),eo(i,t.memoizedState)||(Ha=!0),t.memoizedState=i,t.baseUpdate=l,t.baseState=o,n.lastRenderedState=i}return[t.memoizedState,n.dispatch]}function wa(e){var t=ga();return"function"==typeof e&&(e=e()),t.memoizedState=t.baseState=e,e=(e=t.queue={last:null,dispatch:null,lastRenderedReducer:va,lastRenderedState:e}).dispatch=Aa.bind(null,ea,e),[t.memoizedState,e]}function xa(e){return ba(va)}function ka(e,t,n,r){return e={tag:e,create:t,destroy:n,deps:r,next:null},null===sa?(sa={lastEffect:null}).lastEffect=e.next=e:null===(t=sa.lastEffect)?sa.lastEffect=e.next=e:(n=t.next,t.next=e,e.next=n,sa.lastEffect=e),e}function Ea(e,t,n,r){var o=ga();la|=e,o.memoizedState=ka(t,n,void 0,void 0===r?null:r)}function Oa(e,t,n,r){var o=ya();r=void 0===r?null:r;var i=void 0;if(null!==ta){var a=ta.memoizedState;if(i=a.destroy,null!==r&&da(r,a.deps))return void ka(0,n,i,r)}la|=e,o.memoizedState=ka(t,n,i,r)}function _a(e,t){return Ea(516,192,e,t)}function Sa(e,t){return Oa(516,192,e,t)}function Ta(e,t){return"function"==typeof t?(e=e(),t(e),function(){t(null)}):null!=t?(e=e(),t.current=e,function(){t.current=null}):void 0}function ja(){}function Ca(e,t){return ga().memoizedState=[e,void 0===t?null:t],e}function Ia(e,t){var n=ya();t=void 0===t?null:t;var r=n.memoizedState;return null!==r&&null!==t&&da(t,r[1])?r[0]:(n.memoizedState=[e,t],e)}function Aa(e,t,n){if(!(25>fa))throw Error(a(301));var r=e.alternate;if(e===ea||null!==r&&r===ea)if(ca=!0,e={expirationTime:Zi,suspenseConfig:null,action:n,eagerReducer:null,eagerState:null,next:null},null===ua&&(ua=new Map),void 0===(n=ua.get(t)))ua.set(t,e);else{for(t=n;null!==t.next;)t=t.next;t.next=e}else{var o=hl(),i=_i.suspense;i={expirationTime:o=ml(o,e,i),suspenseConfig:i,action:n,eagerReducer:null,eagerState:null,next:null};var s=t.last;if(null===s)i.next=i;else{var l=s.next;null!==l&&(i.next=l),s.next=i}if(t.last=i,0===e.expirationTime&&(null===r||0===r.expirationTime)&&null!==(r=t.lastRenderedReducer))try{var c=t.lastRenderedState,u=r(c,n);if(i.eagerReducer=r,i.eagerState=u,eo(u,c))return}catch(e){}gl(e,o)}}var Pa={readContext:pi,useCallback:pa,useContext:pa,useEffect:pa,useImperativeHandle:pa,useLayoutEffect:pa,useMemo:pa,useReducer:pa,useRef:pa,useState:pa,useDebugValue:pa,useResponder:pa,useDeferredValue:pa,useTransition:pa},Ra={readContext:pi,useCallback:Ca,useContext:pi,useEffect:_a,useImperativeHandle:function(e,t,n){return n=null!=n?n.concat([e]):null,Ea(4,36,Ta.bind(null,t,e),n)},useLayoutEffect:function(e,t){return Ea(4,36,e,t)},useMemo:function(e,t){var n=ga();return t=void 0===t?null:t,e=e(),n.memoizedState=[e,t],e},useReducer:function(e,t,n){var r=ga();return t=void 0!==n?n(t):t,r.memoizedState=r.baseState=t,e=(e=r.queue={last:null,dispatch:null,lastRenderedReducer:e,lastRenderedState:t}).dispatch=Aa.bind(null,ea,e),[r.memoizedState,e]},useRef:function(e){return e={current:e},ga().memoizedState=e},useState:wa,useDebugValue:ja,useResponder:Xi,useDeferredValue:function(e,t){var n=wa(e),r=n[0],o=n[1];return _a((function(){i.unstable_next((function(){var n=Ji.suspense;Ji.suspense=void 0===t?null:t;try{o(e)}finally{Ji.suspense=n}}))}),[e,t]),r},useTransition:function(e){var t=wa(!1),n=t[0],r=t[1];return[Ca((function(t){r(!0),i.unstable_next((function(){var n=Ji.suspense;Ji.suspense=void 0===e?null:e;try{r(!1),t()}finally{Ji.suspense=n}}))}),[e,n]),n]}},Na={readContext:pi,useCallback:Ia,useContext:pi,useEffect:Sa,useImperativeHandle:function(e,t,n){return n=null!=n?n.concat([e]):null,Oa(4,36,Ta.bind(null,t,e),n)},useLayoutEffect:function(e,t){return Oa(4,36,e,t)},useMemo:function(e,t){var n=ya();t=void 0===t?null:t;var r=n.memoizedState;return null!==r&&null!==t&&da(t,r[1])?r[0]:(e=e(),n.memoizedState=[e,t],e)},useReducer:ba,useRef:function(){return ya().memoizedState},useState:xa,useDebugValue:ja,useResponder:Xi,useDeferredValue:function(e,t){var n=xa(),r=n[0],o=n[1];return Sa((function(){i.unstable_next((function(){var n=Ji.suspense;Ji.suspense=void 0===t?null:t;try{o(e)}finally{Ji.suspense=n}}))}),[e,t]),r},useTransition:function(e){var t=xa(),n=t[0],r=t[1];return[Ia((function(t){r(!0),i.unstable_next((function(){var n=Ji.suspense;Ji.suspense=void 0===e?null:e;try{r(!1),t()}finally{Ji.suspense=n}}))}),[e,n]),n]}},La=null,Ma=null,Da=!1;function Fa(e,t){var n=Vl(5,null,null,0);n.elementType="DELETED",n.type="DELETED",n.stateNode=t,n.return=e,n.effectTag=8,null!==e.lastEffect?(e.lastEffect.nextEffect=n,e.lastEffect=n):e.firstEffect=e.lastEffect=n}function Ua(e,t){switch(e.tag){case 5:var n=e.type;return null!==(t=1!==t.nodeType||n.toLowerCase()!==t.nodeName.toLowerCase()?null:t)&&(e.stateNode=t,!0);case 6:return null!==(t=""===e.pendingProps||3!==t.nodeType?null:t)&&(e.stateNode=t,!0);case 13:default:return!1}}function za(e){if(Da){var t=Ma;if(t){var n=t;if(!Ua(e,t)){if(!(t=ar(n.nextSibling))||!Ua(e,t))return e.effectTag=-1025&e.effectTag|2,Da=!1,void(La=e);Fa(La,n)}La=e,Ma=ar(t.firstChild)}else e.effectTag=-1025&e.effectTag|2,Da=!1,La=e}}function Ba(e){for(e=e.return;null!==e&&5!==e.tag&&3!==e.tag&&13!==e.tag;)e=e.return;La=e}function $a(e){if(e!==La)return!1;if(!Da)return Ba(e),Da=!0,!1;var t=e.type;if(5!==e.tag||"head"!==t&&"body"!==t&&!rr(t,e.memoizedProps))for(t=Ma;t;)Fa(e,t),t=ar(t.nextSibling);if(Ba(e),13===e.tag){if(!(e=null!==(e=e.memoizedState)?e.dehydrated:null))throw Error(a(317));e:{for(e=e.nextSibling,t=0;e;){if(8===e.nodeType){var n=e.data;if(n===Kn){if(0===t){Ma=ar(e.nextSibling);break e}t--}else n!==Xn&&n!==Zn&&n!==Jn||t++}e=e.nextSibling}Ma=null}}else Ma=La?ar(e.stateNode.nextSibling):null;return!0}function qa(){Ma=La=null,Da=!1}var Wa=R.ReactCurrentOwner,Ha=!1;function Va(e,t,n,r){t.child=null===e?Fi(t,null,n,r):Di(t,e.child,n,r)}function Ya(e,t,n,r,o){n=n.render;var i=t.ref;return fi(t,o),r=ha(e,t,n,r,i,o),null===e||Ha?(t.effectTag|=1,Va(e,t,r,o),t.child):(t.updateQueue=e.updateQueue,t.effectTag&=-517,e.expirationTime<=o&&(e.expirationTime=0),us(e,t,o))}function Ga(e,t,n,r,o,i){if(null===e){var a=n.type;return"function"!=typeof a||Yl(a)||void 0!==a.defaultProps||null!==n.compare||void 0!==n.defaultProps?((e=Ql(n.type,null,r,null,t.mode,i)).ref=t.ref,e.return=t,t.child=e):(t.tag=15,t.type=a,Qa(e,t,a,r,o,i))}return a=e.child,o<i&&(o=a.memoizedProps,(n=null!==(n=n.compare)?n:no)(o,r)&&e.ref===t.ref)?us(e,t,i):(t.effectTag|=1,(e=Gl(a,r)).ref=t.ref,e.return=t,t.child=e)}function Qa(e,t,n,r,o,i){return null!==e&&no(e.memoizedProps,r)&&e.ref===t.ref&&(Ha=!1,o<i)?us(e,t,i):Ka(e,t,n,r,i)}function Xa(e,t){var n=t.ref;(null===e&&null!==n||null!==e&&e.ref!==n)&&(t.effectTag|=128)}function Ka(e,t,n,r,o){var i=xo(n)?bo:yo.current;return i=wo(t,i),fi(t,o),n=ha(e,t,n,r,i,o),null===e||Ha?(t.effectTag|=1,Va(e,t,n,o),t.child):(t.updateQueue=e.updateQueue,t.effectTag&=-517,e.expirationTime<=o&&(e.expirationTime=0),us(e,t,o))}function Ja(e,t,n,r,o){if(xo(n)){var i=!0;So(t)}else i=!1;if(fi(t,o),null===t.stateNode)null!==e&&(e.alternate=null,t.alternate=null,t.effectTag|=2),Ii(t,n,r),Pi(t,n,r,o),r=!0;else if(null===e){var a=t.stateNode,s=t.memoizedProps;a.props=s;var l=a.context,c=n.contextType;"object"==typeof c&&null!==c?c=pi(c):c=wo(t,c=xo(n)?bo:yo.current);var u=n.getDerivedStateFromProps,f="function"==typeof u||"function"==typeof a.getSnapshotBeforeUpdate;f||"function"!=typeof a.UNSAFE_componentWillReceiveProps&&"function"!=typeof a.componentWillReceiveProps||(s!==r||l!==c)&&Ai(t,a,r,c),di=!1;var p=t.memoizedState;l=a.state=p;var d=t.updateQueue;null!==d&&(ki(t,d,r,a,o),l=t.memoizedState),s!==r||p!==l||vo.current||di?("function"==typeof u&&(Ti(t,n,u,r),l=t.memoizedState),(s=di||Ci(t,n,s,r,p,l,c))?(f||"function"!=typeof a.UNSAFE_componentWillMount&&"function"!=typeof a.componentWillMount||("function"==typeof a.componentWillMount&&a.componentWillMount(),"function"==typeof a.UNSAFE_componentWillMount&&a.UNSAFE_componentWillMount()),"function"==typeof a.componentDidMount&&(t.effectTag|=4)):("function"==typeof a.componentDidMount&&(t.effectTag|=4),t.memoizedProps=r,t.memoizedState=l),a.props=r,a.state=l,a.context=c,r=s):("function"==typeof a.componentDidMount&&(t.effectTag|=4),r=!1)}else a=t.stateNode,s=t.memoizedProps,a.props=t.type===t.elementType?s:ni(t.type,s),l=a.context,"object"==typeof(c=n.contextType)&&null!==c?c=pi(c):c=wo(t,c=xo(n)?bo:yo.current),(f="function"==typeof(u=n.getDerivedStateFromProps)||"function"==typeof a.getSnapshotBeforeUpdate)||"function"!=typeof a.UNSAFE_componentWillReceiveProps&&"function"!=typeof a.componentWillReceiveProps||(s!==r||l!==c)&&Ai(t,a,r,c),di=!1,l=t.memoizedState,p=a.state=l,null!==(d=t.updateQueue)&&(ki(t,d,r,a,o),p=t.memoizedState),s!==r||l!==p||vo.current||di?("function"==typeof u&&(Ti(t,n,u,r),p=t.memoizedState),(u=di||Ci(t,n,s,r,l,p,c))?(f||"function"!=typeof a.UNSAFE_componentWillUpdate&&"function"!=typeof a.componentWillUpdate||("function"==typeof a.componentWillUpdate&&a.componentWillUpdate(r,p,c),"function"==typeof a.UNSAFE_componentWillUpdate&&a.UNSAFE_componentWillUpdate(r,p,c)),"function"==typeof a.componentDidUpdate&&(t.effectTag|=4),"function"==typeof a.getSnapshotBeforeUpdate&&(t.effectTag|=256)):("function"!=typeof a.componentDidUpdate||s===e.memoizedProps&&l===e.memoizedState||(t.effectTag|=4),"function"!=typeof a.getSnapshotBeforeUpdate||s===e.memoizedProps&&l===e.memoizedState||(t.effectTag|=256),t.memoizedProps=r,t.memoizedState=p),a.props=r,a.state=p,a.context=c,r=u):("function"!=typeof a.componentDidUpdate||s===e.memoizedProps&&l===e.memoizedState||(t.effectTag|=4),"function"!=typeof a.getSnapshotBeforeUpdate||s===e.memoizedProps&&l===e.memoizedState||(t.effectTag|=256),r=!1);return Za(e,t,n,r,i,o)}function Za(e,t,n,r,o,i){Xa(e,t);var a=0!=(64&t.effectTag);if(!r&&!a)return o&&To(t,n,!1),us(e,t,i);r=t.stateNode,Wa.current=t;var s=a&&"function"!=typeof n.getDerivedStateFromError?null:r.render();return t.effectTag|=1,null!==e&&a?(t.child=Di(t,e.child,null,i),t.child=Di(t,null,s,i)):Va(e,t,s,i),t.memoizedState=r.state,o&&To(t,n,!0),t.child}function es(e){var t=e.stateNode;t.pendingContext?Oo(0,t.pendingContext,t.pendingContext!==t.context):t.context&&Oo(0,t.context,!1),Wi(e,t.containerInfo)}var ts,ns,rs,os,is={dehydrated:null,retryTime:0};function as(e,t,n){var r,o=t.mode,i=t.pendingProps,a=Gi.current,s=!1;if((r=0!=(64&t.effectTag))||(r=0!=(2&a)&&(null===e||null!==e.memoizedState)),r?(s=!0,t.effectTag&=-65):null!==e&&null===e.memoizedState||void 0===i.fallback||!0===i.unstable_avoidThisFallback||(a|=1),mo(Gi,1&a),null===e){if(void 0!==i.fallback&&za(t),s){if(s=i.fallback,(i=Xl(null,o,0,null)).return=t,0==(2&t.mode))for(e=null!==t.memoizedState?t.child.child:t.child,i.child=e;null!==e;)e.return=i,e=e.sibling;return(n=Xl(s,o,n,null)).return=t,i.sibling=n,t.memoizedState=is,t.child=i,n}return o=i.children,t.memoizedState=null,t.child=Fi(t,null,o,n)}if(null!==e.memoizedState){if(o=(e=e.child).sibling,s){if(i=i.fallback,(n=Gl(e,e.pendingProps)).return=t,0==(2&t.mode)&&(s=null!==t.memoizedState?t.child.child:t.child)!==e.child)for(n.child=s;null!==s;)s.return=n,s=s.sibling;return(o=Gl(o,i,o.expirationTime)).return=t,n.sibling=o,n.childExpirationTime=0,t.memoizedState=is,t.child=n,o}return n=Di(t,e.child,i.children,n),t.memoizedState=null,t.child=n}if(e=e.child,s){if(s=i.fallback,(i=Xl(null,o,0,null)).return=t,i.child=e,null!==e&&(e.return=i),0==(2&t.mode))for(e=null!==t.memoizedState?t.child.child:t.child,i.child=e;null!==e;)e.return=i,e=e.sibling;return(n=Xl(s,o,n,null)).return=t,i.sibling=n,n.effectTag|=2,i.childExpirationTime=0,t.memoizedState=is,t.child=i,n}return t.memoizedState=null,t.child=Di(t,e,i.children,n)}function ss(e,t){e.expirationTime<t&&(e.expirationTime=t);var n=e.alternate;null!==n&&n.expirationTime<t&&(n.expirationTime=t),ui(e.return,t)}function ls(e,t,n,r,o,i){var a=e.memoizedState;null===a?e.memoizedState={isBackwards:t,rendering:null,last:r,tail:n,tailExpiration:0,tailMode:o,lastEffect:i}:(a.isBackwards=t,a.rendering=null,a.last=r,a.tail=n,a.tailExpiration=0,a.tailMode=o,a.lastEffect=i)}function cs(e,t,n){var r=t.pendingProps,o=r.revealOrder,i=r.tail;if(Va(e,t,r.children,n),0!=(2&(r=Gi.current)))r=1&r|2,t.effectTag|=64;else{if(null!==e&&0!=(64&e.effectTag))e:for(e=t.child;null!==e;){if(13===e.tag)null!==e.memoizedState&&ss(e,n);else if(19===e.tag)ss(e,n);else if(null!==e.child){e.child.return=e,e=e.child;continue}if(e===t)break e;for(;null===e.sibling;){if(null===e.return||e.return===t)break e;e=e.return}e.sibling.return=e.return,e=e.sibling}r&=1}if(mo(Gi,r),0==(2&t.mode))t.memoizedState=null;else switch(o){case"forwards":for(n=t.child,o=null;null!==n;)null!==(e=n.alternate)&&null===Qi(e)&&(o=n),n=n.sibling;null===(n=o)?(o=t.child,t.child=null):(o=n.sibling,n.sibling=null),ls(t,!1,o,n,i,t.lastEffect);break;case"backwards":for(n=null,o=t.child,t.child=null;null!==o;){if(null!==(e=o.alternate)&&null===Qi(e)){t.child=o;break}e=o.sibling,o.sibling=n,n=o,o=e}ls(t,!0,n,null,i,t.lastEffect);break;case"together":ls(t,!1,null,null,void 0,t.lastEffect);break;default:t.memoizedState=null}return t.child}function us(e,t,n){null!==e&&(t.dependencies=e.dependencies);var r=t.expirationTime;if(0!==r&&jl(r),t.childExpirationTime<n)return null;if(null!==e&&t.child!==e.child)throw Error(a(153));if(null!==t.child){for(n=Gl(e=t.child,e.pendingProps,e.expirationTime),t.child=n,n.return=t;null!==e.sibling;)e=e.sibling,(n=n.sibling=Gl(e,e.pendingProps,e.expirationTime)).return=t;n.sibling=null}return t.child}function fs(e){e.effectTag|=4}function ps(e,t){switch(e.tailMode){case"hidden":t=e.tail;for(var n=null;null!==t;)null!==t.alternate&&(n=t),t=t.sibling;null===n?e.tail=null:n.sibling=null;break;case"collapsed":n=e.tail;for(var r=null;null!==n;)null!==n.alternate&&(r=n),n=n.sibling;null===r?t||null===e.tail?e.tail=null:e.tail.sibling=null:r.sibling=null}}function ds(e){switch(e.tag){case 1:xo(e.type)&&ko();var t=e.effectTag;return 4096&t?(e.effectTag=-4097&t|64,e):null;case 3:if(Hi(),Eo(),0!=(64&(t=e.effectTag)))throw Error(a(285));return e.effectTag=-4097&t|64,e;case 5:return Yi(e),null;case 13:return ho(Gi),4096&(t=e.effectTag)?(e.effectTag=-4097&t|64,e):null;case 19:return ho(Gi),null;case 4:return Hi(),null;case 10:return ci(e),null;default:return null}}function hs(e,t){return{value:e,source:t,stack:J(t)}}ts=function(e,t){for(var n=t.child;null!==n;){if(5===n.tag||6===n.tag)e.appendChild(n.stateNode);else if(4!==n.tag&&null!==n.child){n.child.return=n,n=n.child;continue}if(n===t)break;for(;null===n.sibling;){if(null===n.return||n.return===t)return;n=n.return}n.sibling.return=n.return,n=n.sibling}},ns=function(){},rs=function(e,t,n,r,i){var a=e.memoizedProps;if(a!==r){var s,l,c=t.stateNode;switch(qi(zi.current),e=null,n){case"input":a=Se(c,a),r=Se(c,r),e=[];break;case"option":a=Pe(c,a),r=Pe(c,r),e=[];break;case"select":a=o({},a,{value:void 0}),r=o({},r,{value:void 0}),e=[];break;case"textarea":a=Ne(c,a),r=Ne(c,r),e=[];break;default:"function"!=typeof a.onClick&&"function"==typeof r.onClick&&(c.onclick=Wn)}for(s in Bn(n,r),n=null,a)if(!r.hasOwnProperty(s)&&a.hasOwnProperty(s)&&null!=a[s])if("style"===s)for(l in c=a[s])c.hasOwnProperty(l)&&(n||(n={}),n[l]="");else"dangerouslySetInnerHTML"!==s&&"children"!==s&&"suppressContentEditableWarning"!==s&&"suppressHydrationWarning"!==s&&"autoFocus"!==s&&(d.hasOwnProperty(s)?e||(e=[]):(e=e||[]).push(s,null));for(s in r){var u=r[s];if(c=null!=a?a[s]:void 0,r.hasOwnProperty(s)&&u!==c&&(null!=u||null!=c))if("style"===s)if(c){for(l in c)!c.hasOwnProperty(l)||u&&u.hasOwnProperty(l)||(n||(n={}),n[l]="");for(l in u)u.hasOwnProperty(l)&&c[l]!==u[l]&&(n||(n={}),n[l]=u[l])}else n||(e||(e=[]),e.push(s,n)),n=u;else"dangerouslySetInnerHTML"===s?(u=u?u.__html:void 0,c=c?c.__html:void 0,null!=u&&c!==u&&(e=e||[]).push(s,""+u)):"children"===s?c===u||"string"!=typeof u&&"number"!=typeof u||(e=e||[]).push(s,""+u):"suppressContentEditableWarning"!==s&&"suppressHydrationWarning"!==s&&(d.hasOwnProperty(s)?(null!=u&&qn(i,s),e||c===u||(e=[])):(e=e||[]).push(s,u))}n&&(e=e||[]).push("style",n),i=e,(t.updateQueue=i)&&fs(t)}},os=function(e,t,n,r){n!==r&&fs(t)};var ms="function"==typeof WeakSet?WeakSet:Set;function gs(e,t){var n=t.source,r=t.stack;null===r&&null!==n&&(r=J(n)),null!==n&&K(n.type),t=t.value,null!==e&&1===e.tag&&K(e.type);try{console.error(t)}catch(e){setTimeout((function(){throw e}))}}function ys(e){var t=e.ref;if(null!==t)if("function"==typeof t)try{t(null)}catch(t){zl(e,t)}else t.current=null}function vs(e,t){switch(t.tag){case 0:case 11:case 15:bs(2,0,t);break;case 1:if(256&t.effectTag&&null!==e){var n=e.memoizedProps,r=e.memoizedState;t=(e=t.stateNode).getSnapshotBeforeUpdate(t.elementType===t.type?n:ni(t.type,n),r),e.__reactInternalSnapshotBeforeUpdate=t}break;case 3:case 5:case 6:case 4:case 17:break;default:throw Error(a(163))}}function bs(e,t,n){if(null!==(n=null!==(n=n.updateQueue)?n.lastEffect:null)){var r=n=n.next;do{if(0!=(r.tag&e)){var o=r.destroy;r.destroy=void 0,void 0!==o&&o()}0!=(r.tag&t)&&(o=r.create,r.destroy=o()),r=r.next}while(r!==n)}}function ws(e,t,n){switch("function"==typeof Wl&&Wl(t),t.tag){case 0:case 11:case 14:case 15:if(null!==(e=t.updateQueue)&&null!==(e=e.lastEffect)){var r=e.next;Qo(97<n?97:n,(function(){var e=r;do{var n=e.destroy;if(void 0!==n){var o=t;try{n()}catch(e){zl(o,e)}}e=e.next}while(e!==r)}))}break;case 1:ys(t),"function"==typeof(n=t.stateNode).componentWillUnmount&&function(e,t){try{t.props=e.memoizedProps,t.state=e.memoizedState,t.componentWillUnmount()}catch(t){zl(e,t)}}(t,n);break;case 5:ys(t);break;case 4:Os(e,t,n)}}function xs(e){var t=e.alternate;e.return=null,e.child=null,e.memoizedState=null,e.updateQueue=null,e.dependencies=null,e.alternate=null,e.firstEffect=null,e.lastEffect=null,e.pendingProps=null,e.memoizedProps=null,null!==t&&xs(t)}function ks(e){return 5===e.tag||3===e.tag||4===e.tag}function Es(e){e:{for(var t=e.return;null!==t;){if(ks(t)){var n=t;break e}t=t.return}throw Error(a(160))}switch(t=n.stateNode,n.tag){case 5:var r=!1;break;case 3:case 4:t=t.containerInfo,r=!0;break;default:throw Error(a(161))}16&n.effectTag&&(qe(t,""),n.effectTag&=-17);e:t:for(n=e;;){for(;null===n.sibling;){if(null===n.return||ks(n.return)){n=null;break e}n=n.return}for(n.sibling.return=n.return,n=n.sibling;5!==n.tag&&6!==n.tag&&18!==n.tag;){if(2&n.effectTag)continue t;if(null===n.child||4===n.tag)continue t;n.child.return=n,n=n.child}if(!(2&n.effectTag)){n=n.stateNode;break e}}for(var o=e;;){var i=5===o.tag||6===o.tag;if(i){var s=i?o.stateNode:o.stateNode.instance;if(n)if(r){var l=s;s=n,8===(i=t).nodeType?i.parentNode.insertBefore(l,s):i.insertBefore(l,s)}else t.insertBefore(s,n);else r?(8===(l=t).nodeType?(i=l.parentNode).insertBefore(s,l):(i=l).appendChild(s),null!=(l=l._reactRootContainer)||null!==i.onclick||(i.onclick=Wn)):t.appendChild(s)}else if(4!==o.tag&&null!==o.child){o.child.return=o,o=o.child;continue}if(o===e)break;for(;null===o.sibling;){if(null===o.return||o.return===e)return;o=o.return}o.sibling.return=o.return,o=o.sibling}}function Os(e,t,n){for(var r,o,i=t,s=!1;;){if(!s){s=i.return;e:for(;;){if(null===s)throw Error(a(160));switch(r=s.stateNode,s.tag){case 5:o=!1;break e;case 3:case 4:r=r.containerInfo,o=!0;break e}s=s.return}s=!0}if(5===i.tag||6===i.tag){e:for(var l=e,c=i,u=n,f=c;;)if(ws(l,f,u),null!==f.child&&4!==f.tag)f.child.return=f,f=f.child;else{if(f===c)break;for(;null===f.sibling;){if(null===f.return||f.return===c)break e;f=f.return}f.sibling.return=f.return,f=f.sibling}o?(l=r,c=i.stateNode,8===l.nodeType?l.parentNode.removeChild(c):l.removeChild(c)):r.removeChild(i.stateNode)}else if(4===i.tag){if(null!==i.child){r=i.stateNode.containerInfo,o=!0,i.child.return=i,i=i.child;continue}}else if(ws(e,i,n),null!==i.child){i.child.return=i,i=i.child;continue}if(i===t)break;for(;null===i.sibling;){if(null===i.return||i.return===t)return;4===(i=i.return).tag&&(s=!1)}i.sibling.return=i.return,i=i.sibling}}function _s(e,t){switch(t.tag){case 0:case 11:case 14:case 15:bs(4,8,t);break;case 1:break;case 5:var n=t.stateNode;if(null!=n){var r=t.memoizedProps,o=null!==e?e.memoizedProps:r;e=t.type;var i=t.updateQueue;if(t.updateQueue=null,null!==i){for(n[ur]=r,"input"===e&&"radio"===r.type&&null!=r.name&&je(n,r),$n(e,o),t=$n(e,r),o=0;o<i.length;o+=2){var s=i[o],l=i[o+1];"style"===s?Un(n,l):"dangerouslySetInnerHTML"===s?$e(n,l):"children"===s?qe(n,l):ke(n,s,l,t)}switch(e){case"input":Ce(n,r);break;case"textarea":Me(n,r);break;case"select":t=n._wrapperState.wasMultiple,n._wrapperState.wasMultiple=!!r.multiple,null!=(e=r.value)?Re(n,!!r.multiple,e,!1):t!==!!r.multiple&&(null!=r.defaultValue?Re(n,!!r.multiple,r.defaultValue,!0):Re(n,!!r.multiple,r.multiple?[]:"",!1))}}}break;case 6:if(null===t.stateNode)throw Error(a(162));t.stateNode.nodeValue=t.memoizedProps;break;case 3:(t=t.stateNode).hydrate&&(t.hydrate=!1,_t(t.containerInfo));break;case 12:break;case 13:if(n=t,null===t.memoizedState?r=!1:(r=!0,n=t.child,tl=Vo()),null!==n)e:for(e=n;;){if(5===e.tag)i=e.stateNode,r?"function"==typeof(i=i.style).setProperty?i.setProperty("display","none","important"):i.display="none":(i=e.stateNode,o=null!=(o=e.memoizedProps.style)&&o.hasOwnProperty("display")?o.display:null,i.style.display=Fn("display",o));else if(6===e.tag)e.stateNode.nodeValue=r?"":e.memoizedProps;else{if(13===e.tag&&null!==e.memoizedState&&null===e.memoizedState.dehydrated){(i=e.child.sibling).return=e,e=i;continue}if(null!==e.child){e.child.return=e,e=e.child;continue}}if(e===n)break e;for(;null===e.sibling;){if(null===e.return||e.return===n)break e;e=e.return}e.sibling.return=e.return,e=e.sibling}Ss(t);break;case 19:Ss(t);break;case 17:case 20:case 21:break;default:throw Error(a(163))}}function Ss(e){var t=e.updateQueue;if(null!==t){e.updateQueue=null;var n=e.stateNode;null===n&&(n=e.stateNode=new ms),t.forEach((function(t){var r=$l.bind(null,e,t);n.has(t)||(n.add(t),t.then(r,r))}))}}var Ts="function"==typeof WeakMap?WeakMap:Map;function js(e,t,n){(n=gi(n,null)).tag=3,n.payload={element:null};var r=t.value;return n.callback=function(){ol||(ol=!0,il=r),gs(e,t)},n}function Cs(e,t,n){(n=gi(n,null)).tag=3;var r=e.type.getDerivedStateFromError;if("function"==typeof r){var o=t.value;n.payload=function(){return gs(e,t),r(o)}}var i=e.stateNode;return null!==i&&"function"==typeof i.componentDidCatch&&(n.callback=function(){"function"!=typeof r&&(null===al?al=new Set([this]):al.add(this),gs(e,t));var n=t.stack;this.componentDidCatch(t.value,{componentStack:null!==n?n:""})}),n}var Is,As=Math.ceil,Ps=R.ReactCurrentDispatcher,Rs=R.ReactCurrentOwner,Ns=0,Ls=8,Ms=16,Ds=32,Fs=0,Us=1,zs=2,Bs=3,$s=4,qs=5,Ws=Ns,Hs=null,Vs=null,Ys=0,Gs=Fs,Qs=null,Xs=1073741823,Ks=1073741823,Js=null,Zs=0,el=!1,tl=0,nl=500,rl=null,ol=!1,il=null,al=null,sl=!1,ll=null,cl=90,ul=null,fl=0,pl=null,dl=0;function hl(){return(Ws&(Ms|Ds))!==Ns?1073741821-(Vo()/10|0):0!==dl?dl:dl=1073741821-(Vo()/10|0)}function ml(e,t,n){if(0==(2&(t=t.mode)))return 1073741823;var r=Yo();if(0==(4&t))return 99===r?1073741823:1073741822;if((Ws&Ms)!==Ns)return Ys;if(null!==n)e=ti(e,0|n.timeoutMs||5e3,250);else switch(r){case 99:e=1073741823;break;case 98:e=ti(e,150,100);break;case 97:case 96:e=ti(e,5e3,250);break;case 95:e=2;break;default:throw Error(a(326))}return null!==Hs&&e===Ys&&--e,e}function gl(e,t){if(50<fl)throw fl=0,pl=null,Error(a(185));if(null!==(e=yl(e,t))){var n=Yo();1073741823===t?(Ws&Ls)!==Ns&&(Ws&(Ms|Ds))===Ns?xl(e):(bl(e),Ws===Ns&&Jo()):bl(e),(4&Ws)===Ns||98!==n&&99!==n||(null===ul?ul=new Map([[e,t]]):(void 0===(n=ul.get(e))||n>t)&&ul.set(e,t))}}function yl(e,t){e.expirationTime<t&&(e.expirationTime=t);var n=e.alternate;null!==n&&n.expirationTime<t&&(n.expirationTime=t);var r=e.return,o=null;if(null===r&&3===e.tag)o=e.stateNode;else for(;null!==r;){if(n=r.alternate,r.childExpirationTime<t&&(r.childExpirationTime=t),null!==n&&n.childExpirationTime<t&&(n.childExpirationTime=t),null===r.return&&3===r.tag){o=r.stateNode;break}r=r.return}return null!==o&&(Hs===o&&(jl(t),Gs===$s&&tc(o,Ys)),nc(o,t)),o}function vl(e){var t=e.lastExpiredTime;return 0!==t?t:ec(e,t=e.firstPendingTime)?(t=e.lastPingedTime)>(e=e.nextKnownPendingLevel)?t:e:t}function bl(e){if(0!==e.lastExpiredTime)e.callbackExpirationTime=1073741823,e.callbackPriority=99,e.callbackNode=Ko(xl.bind(null,e));else{var t=vl(e),n=e.callbackNode;if(0===t)null!==n&&(e.callbackNode=null,e.callbackExpirationTime=0,e.callbackPriority=90);else{var r=hl();if(1073741823===t?r=99:1===t||2===t?r=95:r=0>=(r=10*(1073741821-t)-10*(1073741821-r))?99:250>=r?98:5250>=r?97:95,null!==n){var o=e.callbackPriority;if(e.callbackExpirationTime===t&&o>=r)return;n!==zo&&Io(n)}e.callbackExpirationTime=t,e.callbackPriority=r,t=1073741823===t?Ko(xl.bind(null,e)):Xo(r,wl.bind(null,e),{timeout:10*(1073741821-t)-Vo()}),e.callbackNode=t}}}function wl(e,t){if(dl=0,t)return rc(e,t=hl()),bl(e),null;var n=vl(e);if(0!==n){if(t=e.callbackNode,(Ws&(Ms|Ds))!==Ns)throw Error(a(327));if(Dl(),e===Hs&&n===Ys||Ol(e,n),null!==Vs){var r=Ws;Ws|=Ms;for(var o=Sl();;)try{Il();break}catch(t){_l(e,t)}if(si(),Ws=r,Ps.current=o,Gs===Us)throw t=Qs,Ol(e,n),tc(e,n),bl(e),t;if(null===Vs)switch(o=e.finishedWork=e.current.alternate,e.finishedExpirationTime=n,r=Gs,Hs=null,r){case Fs:case Us:throw Error(a(345));case zs:rc(e,2<n?2:n);break;case Bs:if(tc(e,n),n===(r=e.lastSuspendedTime)&&(e.nextKnownPendingLevel=Rl(o)),1073741823===Xs&&10<(o=tl+nl-Vo())){if(el){var i=e.lastPingedTime;if(0===i||i>=n){e.lastPingedTime=n,Ol(e,n);break}}if(0!==(i=vl(e))&&i!==n)break;if(0!==r&&r!==n){e.lastPingedTime=r;break}e.timeoutHandle=or(Nl.bind(null,e),o);break}Nl(e);break;case $s:if(tc(e,n),n===(r=e.lastSuspendedTime)&&(e.nextKnownPendingLevel=Rl(o)),el&&(0===(o=e.lastPingedTime)||o>=n)){e.lastPingedTime=n,Ol(e,n);break}if(0!==(o=vl(e))&&o!==n)break;if(0!==r&&r!==n){e.lastPingedTime=r;break}if(1073741823!==Ks?r=10*(1073741821-Ks)-Vo():1073741823===Xs?r=0:(r=10*(1073741821-Xs)-5e3,0>(r=(o=Vo())-r)&&(r=0),(n=10*(1073741821-n)-o)<(r=(120>r?120:480>r?480:1080>r?1080:1920>r?1920:3e3>r?3e3:4320>r?4320:1960*As(r/1960))-r)&&(r=n)),10<r){e.timeoutHandle=or(Nl.bind(null,e),r);break}Nl(e);break;case qs:if(1073741823!==Xs&&null!==Js){i=Xs;var s=Js;if(0>=(r=0|s.busyMinDurationMs)?r=0:(o=0|s.busyDelayMs,r=(i=Vo()-(10*(1073741821-i)-(0|s.timeoutMs||5e3)))<=o?0:o+r-i),10<r){tc(e,n),e.timeoutHandle=or(Nl.bind(null,e),r);break}}Nl(e);break;default:throw Error(a(329))}if(bl(e),e.callbackNode===t)return wl.bind(null,e)}}return null}function xl(e){var t=e.lastExpiredTime;if(t=0!==t?t:1073741823,e.finishedExpirationTime===t)Nl(e);else{if((Ws&(Ms|Ds))!==Ns)throw Error(a(327));if(Dl(),e===Hs&&t===Ys||Ol(e,t),null!==Vs){var n=Ws;Ws|=Ms;for(var r=Sl();;)try{Cl();break}catch(t){_l(e,t)}if(si(),Ws=n,Ps.current=r,Gs===Us)throw n=Qs,Ol(e,t),tc(e,t),bl(e),n;if(null!==Vs)throw Error(a(261));e.finishedWork=e.current.alternate,e.finishedExpirationTime=t,Hs=null,Nl(e),bl(e)}}return null}function kl(e,t){var n=Ws;Ws|=1;try{return e(t)}finally{(Ws=n)===Ns&&Jo()}}function El(e,t){var n=Ws;Ws&=-2,Ws|=Ls;try{return e(t)}finally{(Ws=n)===Ns&&Jo()}}function Ol(e,t){e.finishedWork=null,e.finishedExpirationTime=0;var n=e.timeoutHandle;if(-1!==n&&(e.timeoutHandle=-1,ir(n)),null!==Vs)for(n=Vs.return;null!==n;){var r=n;switch(r.tag){case 1:var o=r.type.childContextTypes;null!=o&&ko();break;case 3:Hi(),Eo();break;case 5:Yi(r);break;case 4:Hi();break;case 13:case 19:ho(Gi);break;case 10:ci(r)}n=n.return}Hs=e,Vs=Gl(e.current,null),Ys=t,Gs=Fs,Qs=null,Ks=Xs=1073741823,Js=null,Zs=0,el=!1}function _l(e,t){for(;;){try{if(si(),ma(),null===Vs||null===Vs.return)return Gs=Us,Qs=t,null;e:{var n=e,r=Vs.return,o=Vs,i=t;if(t=Ys,o.effectTag|=2048,o.firstEffect=o.lastEffect=null,null!==i&&"object"==typeof i&&"function"==typeof i.then){var a=i,s=0!=(1&Gi.current),l=r;do{var c;if(c=13===l.tag){var u=l.memoizedState;if(null!==u)c=null!==u.dehydrated;else{var f=l.memoizedProps;c=void 0!==f.fallback&&(!0!==f.unstable_avoidThisFallback||!s)}}if(c){var p=l.updateQueue;if(null===p){var d=new Set;d.add(a),l.updateQueue=d}else p.add(a);if(0==(2&l.mode)){if(l.effectTag|=64,o.effectTag&=-2981,1===o.tag)if(null===o.alternate)o.tag=17;else{var h=gi(1073741823,null);h.tag=2,vi(o,h)}o.expirationTime=1073741823;break e}i=void 0,o=t;var m=n.pingCache;if(null===m?(m=n.pingCache=new Ts,i=new Set,m.set(a,i)):void 0===(i=m.get(a))&&(i=new Set,m.set(a,i)),!i.has(o)){i.add(o);var g=Bl.bind(null,n,a,o);a.then(g,g)}l.effectTag|=4096,l.expirationTime=t;break e}l=l.return}while(null!==l);i=Error((K(o.type)||"A React component")+" suspended while rendering, but no fallback UI was specified.\n\nAdd a <Suspense fallback=...> component higher in the tree to provide a loading indicator or placeholder to display."+J(o))}Gs!==qs&&(Gs=zs),i=hs(i,o),l=r;do{switch(l.tag){case 3:a=i,l.effectTag|=4096,l.expirationTime=t,bi(l,js(l,a,t));break e;case 1:a=i;var y=l.type,v=l.stateNode;if(0==(64&l.effectTag)&&("function"==typeof y.getDerivedStateFromError||null!==v&&"function"==typeof v.componentDidCatch&&(null===al||!al.has(v)))){l.effectTag|=4096,l.expirationTime=t,bi(l,Cs(l,a,t));break e}}l=l.return}while(null!==l)}Vs=Pl(Vs)}catch(e){t=e;continue}break}}function Sl(){var e=Ps.current;return Ps.current=Pa,null===e?Pa:e}function Tl(e,t){e<Xs&&2<e&&(Xs=e),null!==t&&e<Ks&&2<e&&(Ks=e,Js=t)}function jl(e){e>Zs&&(Zs=e)}function Cl(){for(;null!==Vs;)Vs=Al(Vs)}function Il(){for(;null!==Vs&&!Ao();)Vs=Al(Vs)}function Al(e){var t=Is(e.alternate,e,Ys);return e.memoizedProps=e.pendingProps,null===t&&(t=Pl(e)),Rs.current=null,t}function Pl(e){Vs=e;do{var t=Vs.alternate;if(e=Vs.return,0==(2048&Vs.effectTag)){e:{var n=t,r=Ys,i=(t=Vs).pendingProps;switch(t.tag){case 2:case 16:break;case 15:case 0:break;case 1:xo(t.type)&&ko();break;case 3:Hi(),Eo(),(i=t.stateNode).pendingContext&&(i.context=i.pendingContext,i.pendingContext=null),(null===n||null===n.child)&&$a(t)&&fs(t),ns(t);break;case 5:Yi(t),r=qi($i.current);var s=t.type;if(null!==n&&null!=t.stateNode)rs(n,t,s,i,r),n.ref!==t.ref&&(t.effectTag|=128);else if(i){var l=qi(zi.current);if($a(t)){var c=(i=t).stateNode;n=i.type;var u=i.memoizedProps,f=r;switch(c[cr]=i,c[ur]=u,s=void 0,r=c,n){case"iframe":case"object":case"embed":_n("load",r);break;case"video":case"audio":for(c=0;c<Ze.length;c++)_n(Ze[c],r);break;case"source":_n("error",r);break;case"img":case"image":case"link":_n("error",r),_n("load",r);break;case"form":_n("reset",r),_n("submit",r);break;case"details":_n("toggle",r);break;case"input":Te(r,u),_n("invalid",r),qn(f,"onChange");break;case"select":r._wrapperState={wasMultiple:!!u.multiple},_n("invalid",r),qn(f,"onChange");break;case"textarea":Le(r,u),_n("invalid",r),qn(f,"onChange")}for(s in Bn(n,u),c=null,u)u.hasOwnProperty(s)&&(l=u[s],"children"===s?"string"==typeof l?r.textContent!==l&&(c=["children",l]):"number"==typeof l&&r.textContent!==""+l&&(c=["children",""+l]):d.hasOwnProperty(s)&&null!=l&&qn(f,s));switch(n){case"input":Oe(r),Ie(r,u,!0);break;case"textarea":Oe(r),De(r);break;case"select":case"option":break;default:"function"==typeof u.onClick&&(r.onclick=Wn)}s=c,i.updateQueue=s,(i=null!==s)&&fs(t)}else{n=t,f=s,u=i,c=9===r.nodeType?r:r.ownerDocument,l===Fe.html&&(l=Ue(f)),l===Fe.html?"script"===f?((u=c.createElement("div")).innerHTML="<script><\/script>",c=u.removeChild(u.firstChild)):"string"==typeof u.is?c=c.createElement(f,{is:u.is}):(c=c.createElement(f),"select"===f&&(f=c,u.multiple?f.multiple=!0:u.size&&(f.size=u.size))):c=c.createElementNS(l,f),(u=c)[cr]=n,u[ur]=i,ts(u,t,!1,!1),t.stateNode=u;var p=r,h=$n(f=s,n=i);switch(f){case"iframe":case"object":case"embed":_n("load",u),r=n;break;case"video":case"audio":for(r=0;r<Ze.length;r++)_n(Ze[r],u);r=n;break;case"source":_n("error",u),r=n;break;case"img":case"image":case"link":_n("error",u),_n("load",u),r=n;break;case"form":_n("reset",u),_n("submit",u),r=n;break;case"details":_n("toggle",u),r=n;break;case"input":Te(u,n),r=Se(u,n),_n("invalid",u),qn(p,"onChange");break;case"option":r=Pe(u,n);break;case"select":u._wrapperState={wasMultiple:!!n.multiple},r=o({},n,{value:void 0}),_n("invalid",u),qn(p,"onChange");break;case"textarea":Le(u,n),r=Ne(u,n),_n("invalid",u),qn(p,"onChange");break;default:r=n}Bn(f,r),c=void 0,l=f;var m=u,g=r;for(c in g)if(g.hasOwnProperty(c)){var y=g[c];"style"===c?Un(m,y):"dangerouslySetInnerHTML"===c?null!=(y=y?y.__html:void 0)&&$e(m,y):"children"===c?"string"==typeof y?("textarea"!==l||""!==y)&&qe(m,y):"number"==typeof y&&qe(m,""+y):"suppressContentEditableWarning"!==c&&"suppressHydrationWarning"!==c&&"autoFocus"!==c&&(d.hasOwnProperty(c)?null!=y&&qn(p,c):null!=y&&ke(m,c,y,h))}switch(f){case"input":Oe(u),Ie(u,n,!1);break;case"textarea":Oe(u),De(u);break;case"option":null!=n.value&&u.setAttribute("value",""+xe(n.value));break;case"select":(r=u).multiple=!!n.multiple,null!=(u=n.value)?Re(r,!!n.multiple,u,!1):null!=n.defaultValue&&Re(r,!!n.multiple,n.defaultValue,!0);break;default:"function"==typeof r.onClick&&(u.onclick=Wn)}(i=nr(s,i))&&fs(t)}null!==t.ref&&(t.effectTag|=128)}else if(null===t.stateNode)throw Error(a(166));break;case 6:if(n&&null!=t.stateNode)os(n,t,n.memoizedProps,i);else{if("string"!=typeof i&&null===t.stateNode)throw Error(a(166));r=qi($i.current),qi(zi.current),$a(t)?(s=(i=t).stateNode,r=i.memoizedProps,s[cr]=i,(i=s.nodeValue!==r)&&fs(t)):(s=t,(i=(9===r.nodeType?r:r.ownerDocument).createTextNode(i))[cr]=s,t.stateNode=i)}break;case 11:break;case 13:if(ho(Gi),i=t.memoizedState,0!=(64&t.effectTag)){t.expirationTime=r;break e}i=null!==i,s=!1,null===n?void 0!==t.memoizedProps.fallback&&$a(t):(s=null!==(r=n.memoizedState),i||null===r||null!==(r=n.child.sibling)&&(null!==(u=t.firstEffect)?(t.firstEffect=r,r.nextEffect=u):(t.firstEffect=t.lastEffect=r,r.nextEffect=null),r.effectTag=8)),i&&!s&&0!=(2&t.mode)&&(null===n&&!0!==t.memoizedProps.unstable_avoidThisFallback||0!=(1&Gi.current)?Gs===Fs&&(Gs=Bs):(Gs!==Fs&&Gs!==Bs||(Gs=$s),0!==Zs&&null!==Hs&&(tc(Hs,Ys),nc(Hs,Zs)))),(i||s)&&(t.effectTag|=4);break;case 7:case 8:case 12:break;case 4:Hi(),ns(t);break;case 10:ci(t);break;case 9:case 14:break;case 17:xo(t.type)&&ko();break;case 19:if(ho(Gi),null===(i=t.memoizedState))break;if(s=0!=(64&t.effectTag),null===(u=i.rendering)){if(s)ps(i,!1);else if(Gs!==Fs||null!==n&&0!=(64&n.effectTag))for(n=t.child;null!==n;){if(null!==(u=Qi(n))){for(t.effectTag|=64,ps(i,!1),null!==(s=u.updateQueue)&&(t.updateQueue=s,t.effectTag|=4),null===i.lastEffect&&(t.firstEffect=null),t.lastEffect=i.lastEffect,i=r,s=t.child;null!==s;)n=i,(r=s).effectTag&=2,r.nextEffect=null,r.firstEffect=null,r.lastEffect=null,null===(u=r.alternate)?(r.childExpirationTime=0,r.expirationTime=n,r.child=null,r.memoizedProps=null,r.memoizedState=null,r.updateQueue=null,r.dependencies=null):(r.childExpirationTime=u.childExpirationTime,r.expirationTime=u.expirationTime,r.child=u.child,r.memoizedProps=u.memoizedProps,r.memoizedState=u.memoizedState,r.updateQueue=u.updateQueue,n=u.dependencies,r.dependencies=null===n?null:{expirationTime:n.expirationTime,firstContext:n.firstContext,responders:n.responders}),s=s.sibling;mo(Gi,1&Gi.current|2),t=t.child;break e}n=n.sibling}}else{if(!s)if(null!==(n=Qi(u))){if(t.effectTag|=64,s=!0,null!==(r=n.updateQueue)&&(t.updateQueue=r,t.effectTag|=4),ps(i,!0),null===i.tail&&"hidden"===i.tailMode&&!u.alternate){null!==(t=t.lastEffect=i.lastEffect)&&(t.nextEffect=null);break}}else Vo()>i.tailExpiration&&1<r&&(t.effectTag|=64,s=!0,ps(i,!1),t.expirationTime=t.childExpirationTime=r-1);i.isBackwards?(u.sibling=t.child,t.child=u):(null!==(r=i.last)?r.sibling=u:t.child=u,i.last=u)}if(null!==i.tail){0===i.tailExpiration&&(i.tailExpiration=Vo()+500),r=i.tail,i.rendering=r,i.tail=r.sibling,i.lastEffect=t.lastEffect,r.sibling=null,i=Gi.current,mo(Gi,i=s?1&i|2:1&i),t=r;break e}break;case 20:case 21:break;default:throw Error(a(156,t.tag))}t=null}if(i=Vs,1===Ys||1!==i.childExpirationTime){for(s=0,r=i.child;null!==r;)(n=r.expirationTime)>s&&(s=n),(u=r.childExpirationTime)>s&&(s=u),r=r.sibling;i.childExpirationTime=s}if(null!==t)return t;null!==e&&0==(2048&e.effectTag)&&(null===e.firstEffect&&(e.firstEffect=Vs.firstEffect),null!==Vs.lastEffect&&(null!==e.lastEffect&&(e.lastEffect.nextEffect=Vs.firstEffect),e.lastEffect=Vs.lastEffect),1<Vs.effectTag&&(null!==e.lastEffect?e.lastEffect.nextEffect=Vs:e.firstEffect=Vs,e.lastEffect=Vs))}else{if(null!==(t=ds(Vs)))return t.effectTag&=2047,t;null!==e&&(e.firstEffect=e.lastEffect=null,e.effectTag|=2048)}if(null!==(t=Vs.sibling))return t;Vs=e}while(null!==Vs);return Gs===Fs&&(Gs=qs),null}function Rl(e){var t=e.expirationTime;return t>(e=e.childExpirationTime)?t:e}function Nl(e){var t=Yo();return Qo(99,Ll.bind(null,e,t)),null}function Ll(e,t){do{Dl()}while(null!==ll);if((Ws&(Ms|Ds))!==Ns)throw Error(a(327));var n=e.finishedWork,r=e.finishedExpirationTime;if(null===n)return null;if(e.finishedWork=null,e.finishedExpirationTime=0,n===e.current)throw Error(a(177));e.callbackNode=null,e.callbackExpirationTime=0,e.callbackPriority=90,e.nextKnownPendingLevel=0;var o=Rl(n);if(e.firstPendingTime=o,r<=e.lastSuspendedTime?e.firstSuspendedTime=e.lastSuspendedTime=e.nextKnownPendingLevel=0:r<=e.firstSuspendedTime&&(e.firstSuspendedTime=r-1),r<=e.lastPingedTime&&(e.lastPingedTime=0),r<=e.lastExpiredTime&&(e.lastExpiredTime=0),e===Hs&&(Vs=Hs=null,Ys=0),1<n.effectTag?null!==n.lastEffect?(n.lastEffect.nextEffect=n,o=n.firstEffect):o=n:o=n.firstEffect,null!==o){var i=Ws;Ws|=Ds,Rs.current=null,er=On;var s=Gn();if(Qn(s)){if("selectionStart"in s)var l={start:s.selectionStart,end:s.selectionEnd};else e:{var c=(l=(l=s.ownerDocument)&&l.defaultView||window).getSelection&&l.getSelection();if(c&&0!==c.rangeCount){l=c.anchorNode;var u=c.anchorOffset,f=c.focusNode;c=c.focusOffset;try{l.nodeType,f.nodeType}catch(e){l=null;break e}var p=0,d=-1,h=-1,m=0,g=0,y=s,v=null;t:for(;;){for(var b;y!==l||0!==u&&3!==y.nodeType||(d=p+u),y!==f||0!==c&&3!==y.nodeType||(h=p+c),3===y.nodeType&&(p+=y.nodeValue.length),null!==(b=y.firstChild);)v=y,y=b;for(;;){if(y===s)break t;if(v===l&&++m===u&&(d=p),v===f&&++g===c&&(h=p),null!==(b=y.nextSibling))break;v=(y=v).parentNode}y=b}l=-1===d||-1===h?null:{start:d,end:h}}else l=null}l=l||{start:0,end:0}}else l=null;tr={focusedElem:s,selectionRange:l},On=!1,rl=o;do{try{Ml()}catch(e){if(null===rl)throw Error(a(330));zl(rl,e),rl=rl.nextEffect}}while(null!==rl);rl=o;do{try{for(s=e,l=t;null!==rl;){var w=rl.effectTag;if(16&w&&qe(rl.stateNode,""),128&w){var x=rl.alternate;if(null!==x){var k=x.ref;null!==k&&("function"==typeof k?k(null):k.current=null)}}switch(1038&w){case 2:Es(rl),rl.effectTag&=-3;break;case 6:Es(rl),rl.effectTag&=-3,_s(rl.alternate,rl);break;case 1024:rl.effectTag&=-1025;break;case 1028:rl.effectTag&=-1025,_s(rl.alternate,rl);break;case 4:_s(rl.alternate,rl);break;case 8:Os(s,u=rl,l),xs(u)}rl=rl.nextEffect}}catch(e){if(null===rl)throw Error(a(330));zl(rl,e),rl=rl.nextEffect}}while(null!==rl);if(k=tr,x=Gn(),w=k.focusedElem,l=k.selectionRange,x!==w&&w&&w.ownerDocument&&function e(t,n){return!(!t||!n)&&(t===n||(!t||3!==t.nodeType)&&(n&&3===n.nodeType?e(t,n.parentNode):"contains"in t?t.contains(n):!!t.compareDocumentPosition&&!!(16&t.compareDocumentPosition(n))))}(w.ownerDocument.documentElement,w)){null!==l&&Qn(w)&&(x=l.start,void 0===(k=l.end)&&(k=x),"selectionStart"in w?(w.selectionStart=x,w.selectionEnd=Math.min(k,w.value.length)):(k=(x=w.ownerDocument||document)&&x.defaultView||window).getSelection&&(k=k.getSelection(),u=w.textContent.length,s=Math.min(l.start,u),l=void 0===l.end?s:Math.min(l.end,u),!k.extend&&s>l&&(u=l,l=s,s=u),u=Yn(w,s),f=Yn(w,l),u&&f&&(1!==k.rangeCount||k.anchorNode!==u.node||k.anchorOffset!==u.offset||k.focusNode!==f.node||k.focusOffset!==f.offset)&&((x=x.createRange()).setStart(u.node,u.offset),k.removeAllRanges(),s>l?(k.addRange(x),k.extend(f.node,f.offset)):(x.setEnd(f.node,f.offset),k.addRange(x))))),x=[];for(k=w;k=k.parentNode;)1===k.nodeType&&x.push({element:k,left:k.scrollLeft,top:k.scrollTop});for("function"==typeof w.focus&&w.focus(),w=0;w<x.length;w++)(k=x[w]).element.scrollLeft=k.left,k.element.scrollTop=k.top}tr=null,On=!!er,er=null,e.current=n,rl=o;do{try{for(w=r;null!==rl;){var E=rl.effectTag;if(36&E){var O=rl.alternate;switch(k=w,(x=rl).tag){case 0:case 11:case 15:bs(16,32,x);break;case 1:var _=x.stateNode;if(4&x.effectTag)if(null===O)_.componentDidMount();else{var S=x.elementType===x.type?O.memoizedProps:ni(x.type,O.memoizedProps);_.componentDidUpdate(S,O.memoizedState,_.__reactInternalSnapshotBeforeUpdate)}var T=x.updateQueue;null!==T&&Ei(0,T,_);break;case 3:var j=x.updateQueue;if(null!==j){if(s=null,null!==x.child)switch(x.child.tag){case 5:s=x.child.stateNode;break;case 1:s=x.child.stateNode}Ei(0,j,s)}break;case 5:var C=x.stateNode;null===O&&4&x.effectTag&&nr(x.type,x.memoizedProps)&&C.focus();break;case 6:case 4:case 12:break;case 13:if(null===x.memoizedState){var I=x.alternate;if(null!==I){var A=I.memoizedState;if(null!==A){var P=A.dehydrated;null!==P&&_t(P)}}}break;case 19:case 17:case 20:case 21:break;default:throw Error(a(163))}}if(128&E){x=void 0;var R=rl.ref;if(null!==R){var N=rl.stateNode;switch(rl.tag){case 5:x=N;break;default:x=N}"function"==typeof R?R(x):R.current=x}}rl=rl.nextEffect}}catch(e){if(null===rl)throw Error(a(330));zl(rl,e),rl=rl.nextEffect}}while(null!==rl);rl=null,Bo(),Ws=i}else e.current=n;if(sl)sl=!1,ll=e,cl=t;else for(rl=o;null!==rl;)t=rl.nextEffect,rl.nextEffect=null,rl=t;if(0===(t=e.firstPendingTime)&&(al=null),1073741823===t?e===pl?fl++:(fl=0,pl=e):fl=0,"function"==typeof ql&&ql(n.stateNode,r),bl(e),ol)throw ol=!1,e=il,il=null,e;return(Ws&Ls)!==Ns?null:(Jo(),null)}function Ml(){for(;null!==rl;){var e=rl.effectTag;0!=(256&e)&&vs(rl.alternate,rl),0==(512&e)||sl||(sl=!0,Xo(97,(function(){return Dl(),null}))),rl=rl.nextEffect}}function Dl(){if(90!==cl){var e=97<cl?97:cl;return cl=90,Qo(e,Fl)}}function Fl(){if(null===ll)return!1;var e=ll;if(ll=null,(Ws&(Ms|Ds))!==Ns)throw Error(a(331));var t=Ws;for(Ws|=Ds,e=e.current.firstEffect;null!==e;){try{var n=e;if(0!=(512&n.effectTag))switch(n.tag){case 0:case 11:case 15:bs(128,0,n),bs(0,64,n)}}catch(t){if(null===e)throw Error(a(330));zl(e,t)}n=e.nextEffect,e.nextEffect=null,e=n}return Ws=t,Jo(),!0}function Ul(e,t,n){vi(e,t=js(e,t=hs(n,t),1073741823)),null!==(e=yl(e,1073741823))&&bl(e)}function zl(e,t){if(3===e.tag)Ul(e,e,t);else for(var n=e.return;null!==n;){if(3===n.tag){Ul(n,e,t);break}if(1===n.tag){var r=n.stateNode;if("function"==typeof n.type.getDerivedStateFromError||"function"==typeof r.componentDidCatch&&(null===al||!al.has(r))){vi(n,e=Cs(n,e=hs(t,e),1073741823)),null!==(n=yl(n,1073741823))&&bl(n);break}}n=n.return}}function Bl(e,t,n){var r=e.pingCache;null!==r&&r.delete(t),Hs===e&&Ys===n?Gs===$s||Gs===Bs&&1073741823===Xs&&Vo()-tl<nl?Ol(e,Ys):el=!0:ec(e,n)&&(0!==(t=e.lastPingedTime)&&t<n||(e.lastPingedTime=n,e.finishedExpirationTime===n&&(e.finishedExpirationTime=0,e.finishedWork=null),bl(e)))}function $l(e,t){var n=e.stateNode;null!==n&&n.delete(t),0===(t=0)&&(t=ml(t=hl(),e,null)),null!==(e=yl(e,t))&&bl(e)}Is=function(e,t,n){var r=t.expirationTime;if(null!==e){var o=t.pendingProps;if(e.memoizedProps!==o||vo.current)Ha=!0;else{if(r<n){switch(Ha=!1,t.tag){case 3:es(t),qa();break;case 5:if(Vi(t),4&t.mode&&1!==n&&o.hidden)return t.expirationTime=t.childExpirationTime=1,null;break;case 1:xo(t.type)&&So(t);break;case 4:Wi(t,t.stateNode.containerInfo);break;case 10:li(t,t.memoizedProps.value);break;case 13:if(null!==t.memoizedState)return 0!==(r=t.child.childExpirationTime)&&r>=n?as(e,t,n):(mo(Gi,1&Gi.current),null!==(t=us(e,t,n))?t.sibling:null);mo(Gi,1&Gi.current);break;case 19:if(r=t.childExpirationTime>=n,0!=(64&e.effectTag)){if(r)return cs(e,t,n);t.effectTag|=64}if(null!==(o=t.memoizedState)&&(o.rendering=null,o.tail=null),mo(Gi,Gi.current),!r)return null}return us(e,t,n)}Ha=!1}}else Ha=!1;switch(t.expirationTime=0,t.tag){case 2:if(r=t.type,null!==e&&(e.alternate=null,t.alternate=null,t.effectTag|=2),e=t.pendingProps,o=wo(t,yo.current),fi(t,n),o=ha(null,t,r,e,o,n),t.effectTag|=1,"object"==typeof o&&null!==o&&"function"==typeof o.render&&void 0===o.$$typeof){if(t.tag=1,ma(),xo(r)){var i=!0;So(t)}else i=!1;t.memoizedState=null!==o.state&&void 0!==o.state?o.state:null;var s=r.getDerivedStateFromProps;"function"==typeof s&&Ti(t,r,s,e),o.updater=ji,t.stateNode=o,o._reactInternalFiber=t,Pi(t,r,e,n),t=Za(null,t,r,!0,i,n)}else t.tag=0,Va(null,t,o,n),t=t.child;return t;case 16:if(o=t.elementType,null!==e&&(e.alternate=null,t.alternate=null,t.effectTag|=2),e=t.pendingProps,function(e){if(-1===e._status){e._status=0;var t=e._ctor;t=t(),e._result=t,t.then((function(t){0===e._status&&(t=t.default,e._status=1,e._result=t)}),(function(t){0===e._status&&(e._status=2,e._result=t)}))}}(o),1!==o._status)throw o._result;switch(o=o._result,t.type=o,i=t.tag=function(e){if("function"==typeof e)return Yl(e)?1:0;if(null!=e){if((e=e.$$typeof)===W)return 11;if(e===Y)return 14}return 2}(o),e=ni(o,e),i){case 0:t=Ka(null,t,o,e,n);break;case 1:t=Ja(null,t,o,e,n);break;case 11:t=Ya(null,t,o,e,n);break;case 14:t=Ga(null,t,o,ni(o.type,e),r,n);break;default:throw Error(a(306,o,""))}return t;case 0:return r=t.type,o=t.pendingProps,Ka(e,t,r,o=t.elementType===r?o:ni(r,o),n);case 1:return r=t.type,o=t.pendingProps,Ja(e,t,r,o=t.elementType===r?o:ni(r,o),n);case 3:if(es(t),null===(r=t.updateQueue))throw Error(a(282));if(o=null!==(o=t.memoizedState)?o.element:null,ki(t,r,t.pendingProps,null,n),(r=t.memoizedState.element)===o)qa(),t=us(e,t,n);else{if((o=t.stateNode.hydrate)&&(Ma=ar(t.stateNode.containerInfo.firstChild),La=t,o=Da=!0),o)for(n=Fi(t,null,r,n),t.child=n;n;)n.effectTag=-3&n.effectTag|1024,n=n.sibling;else Va(e,t,r,n),qa();t=t.child}return t;case 5:return Vi(t),null===e&&za(t),r=t.type,o=t.pendingProps,i=null!==e?e.memoizedProps:null,s=o.children,rr(r,o)?s=null:null!==i&&rr(r,i)&&(t.effectTag|=16),Xa(e,t),4&t.mode&&1!==n&&o.hidden?(t.expirationTime=t.childExpirationTime=1,t=null):(Va(e,t,s,n),t=t.child),t;case 6:return null===e&&za(t),null;case 13:return as(e,t,n);case 4:return Wi(t,t.stateNode.containerInfo),r=t.pendingProps,null===e?t.child=Di(t,null,r,n):Va(e,t,r,n),t.child;case 11:return r=t.type,o=t.pendingProps,Ya(e,t,r,o=t.elementType===r?o:ni(r,o),n);case 7:return Va(e,t,t.pendingProps,n),t.child;case 8:case 12:return Va(e,t,t.pendingProps.children,n),t.child;case 10:e:{if(r=t.type._context,o=t.pendingProps,s=t.memoizedProps,li(t,i=o.value),null!==s){var l=s.value;if(0===(i=eo(l,i)?0:0|("function"==typeof r._calculateChangedBits?r._calculateChangedBits(l,i):1073741823))){if(s.children===o.children&&!vo.current){t=us(e,t,n);break e}}else for(null!==(l=t.child)&&(l.return=t);null!==l;){var c=l.dependencies;if(null!==c){s=l.child;for(var u=c.firstContext;null!==u;){if(u.context===r&&0!=(u.observedBits&i)){1===l.tag&&((u=gi(n,null)).tag=2,vi(l,u)),l.expirationTime<n&&(l.expirationTime=n),null!==(u=l.alternate)&&u.expirationTime<n&&(u.expirationTime=n),ui(l.return,n),c.expirationTime<n&&(c.expirationTime=n);break}u=u.next}}else s=10===l.tag&&l.type===t.type?null:l.child;if(null!==s)s.return=l;else for(s=l;null!==s;){if(s===t){s=null;break}if(null!==(l=s.sibling)){l.return=s.return,s=l;break}s=s.return}l=s}}Va(e,t,o.children,n),t=t.child}return t;case 9:return o=t.type,r=(i=t.pendingProps).children,fi(t,n),r=r(o=pi(o,i.unstable_observedBits)),t.effectTag|=1,Va(e,t,r,n),t.child;case 14:return i=ni(o=t.type,t.pendingProps),Ga(e,t,o,i=ni(o.type,i),r,n);case 15:return Qa(e,t,t.type,t.pendingProps,r,n);case 17:return r=t.type,o=t.pendingProps,o=t.elementType===r?o:ni(r,o),null!==e&&(e.alternate=null,t.alternate=null,t.effectTag|=2),t.tag=1,xo(r)?(e=!0,So(t)):e=!1,fi(t,n),Ii(t,r,o),Pi(t,r,o,n),Za(null,t,r,!0,e,n);case 19:return cs(e,t,n)}throw Error(a(156,t.tag))};var ql=null,Wl=null;function Hl(e,t,n,r){this.tag=e,this.key=n,this.sibling=this.child=this.return=this.stateNode=this.type=this.elementType=null,this.index=0,this.ref=null,this.pendingProps=t,this.dependencies=this.memoizedState=this.updateQueue=this.memoizedProps=null,this.mode=r,this.effectTag=0,this.lastEffect=this.firstEffect=this.nextEffect=null,this.childExpirationTime=this.expirationTime=0,this.alternate=null}function Vl(e,t,n,r){return new Hl(e,t,n,r)}function Yl(e){return!(!(e=e.prototype)||!e.isReactComponent)}function Gl(e,t){var n=e.alternate;return null===n?((n=Vl(e.tag,t,e.key,e.mode)).elementType=e.elementType,n.type=e.type,n.stateNode=e.stateNode,n.alternate=e,e.alternate=n):(n.pendingProps=t,n.effectTag=0,n.nextEffect=null,n.firstEffect=null,n.lastEffect=null),n.childExpirationTime=e.childExpirationTime,n.expirationTime=e.expirationTime,n.child=e.child,n.memoizedProps=e.memoizedProps,n.memoizedState=e.memoizedState,n.updateQueue=e.updateQueue,t=e.dependencies,n.dependencies=null===t?null:{expirationTime:t.expirationTime,firstContext:t.firstContext,responders:t.responders},n.sibling=e.sibling,n.index=e.index,n.ref=e.ref,n}function Ql(e,t,n,r,o,i){var s=2;if(r=e,"function"==typeof e)Yl(e)&&(s=1);else if("string"==typeof e)s=5;else e:switch(e){case F:return Xl(n.children,o,i,t);case q:s=8,o|=7;break;case U:s=8,o|=1;break;case z:return(e=Vl(12,n,t,8|o)).elementType=z,e.type=z,e.expirationTime=i,e;case H:return(e=Vl(13,n,t,o)).type=H,e.elementType=H,e.expirationTime=i,e;case V:return(e=Vl(19,n,t,o)).elementType=V,e.expirationTime=i,e;default:if("object"==typeof e&&null!==e)switch(e.$$typeof){case B:s=10;break e;case $:s=9;break e;case W:s=11;break e;case Y:s=14;break e;case G:s=16,r=null;break e}throw Error(a(130,null==e?e:typeof e,""))}return(t=Vl(s,n,t,o)).elementType=e,t.type=r,t.expirationTime=i,t}function Xl(e,t,n,r){return(e=Vl(7,e,r,t)).expirationTime=n,e}function Kl(e,t,n){return(e=Vl(6,e,null,t)).expirationTime=n,e}function Jl(e,t,n){return(t=Vl(4,null!==e.children?e.children:[],e.key,t)).expirationTime=n,t.stateNode={containerInfo:e.containerInfo,pendingChildren:null,implementation:e.implementation},t}function Zl(e,t,n){this.tag=t,this.current=null,this.containerInfo=e,this.pingCache=this.pendingChildren=null,this.finishedExpirationTime=0,this.finishedWork=null,this.timeoutHandle=-1,this.pendingContext=this.context=null,this.hydrate=n,this.callbackNode=null,this.callbackPriority=90,this.lastExpiredTime=this.lastPingedTime=this.nextKnownPendingLevel=this.lastSuspendedTime=this.firstSuspendedTime=this.firstPendingTime=0}function ec(e,t){var n=e.firstSuspendedTime;return e=e.lastSuspendedTime,0!==n&&n>=t&&e<=t}function tc(e,t){var n=e.firstSuspendedTime,r=e.lastSuspendedTime;n<t&&(e.firstSuspendedTime=t),(r>t||0===n)&&(e.lastSuspendedTime=t),t<=e.lastPingedTime&&(e.lastPingedTime=0),t<=e.lastExpiredTime&&(e.lastExpiredTime=0)}function nc(e,t){t>e.firstPendingTime&&(e.firstPendingTime=t);var n=e.firstSuspendedTime;0!==n&&(t>=n?e.firstSuspendedTime=e.lastSuspendedTime=e.nextKnownPendingLevel=0:t>=e.lastSuspendedTime&&(e.lastSuspendedTime=t+1),t>e.nextKnownPendingLevel&&(e.nextKnownPendingLevel=t))}function rc(e,t){var n=e.lastExpiredTime;(0===n||n>t)&&(e.lastExpiredTime=t)}function oc(e,t,n,r){var o=t.current,i=hl(),s=_i.suspense;i=ml(i,o,s);e:if(n){t:{if(et(n=n._reactInternalFiber)!==n||1!==n.tag)throw Error(a(170));var l=n;do{switch(l.tag){case 3:l=l.stateNode.context;break t;case 1:if(xo(l.type)){l=l.stateNode.__reactInternalMemoizedMergedChildContext;break t}}l=l.return}while(null!==l);throw Error(a(171))}if(1===n.tag){var c=n.type;if(xo(c)){n=_o(n,c,l);break e}}n=l}else n=go;return null===t.context?t.context=n:t.pendingContext=n,(t=gi(i,s)).payload={element:e},null!==(r=void 0===r?null:r)&&(t.callback=r),vi(o,t),gl(o,i),i}function ic(e){if(!(e=e.current).child)return null;switch(e.child.tag){case 5:default:return e.child.stateNode}}function ac(e,t){null!==(e=e.memoizedState)&&null!==e.dehydrated&&e.retryTime<t&&(e.retryTime=t)}function sc(e,t){ac(e,t),(e=e.alternate)&&ac(e,t)}function lc(e,t,n){var r=new Zl(e,t,n=null!=n&&!0===n.hydrate),o=Vl(3,null,null,2===t?7:1===t?3:0);r.current=o,o.stateNode=r,e[fr]=r.current,n&&0!==t&&function(e){var t=Nn(e);mt.forEach((function(n){Ln(n,e,t)})),gt.forEach((function(n){Ln(n,e,t)}))}(9===e.nodeType?e:e.ownerDocument),this._internalRoot=r}function cc(e){return!(!e||1!==e.nodeType&&9!==e.nodeType&&11!==e.nodeType&&(8!==e.nodeType||" react-mount-point-unstable "!==e.nodeValue))}function uc(e,t,n,r,o){var i=n._reactRootContainer;if(i){var a=i._internalRoot;if("function"==typeof o){var s=o;o=function(){var e=ic(a);s.call(e)}}oc(t,a,e,o)}else{if(i=n._reactRootContainer=function(e,t){if(t||(t=!(!(t=e?9===e.nodeType?e.documentElement:e.firstChild:null)||1!==t.nodeType||!t.hasAttribute("data-reactroot"))),!t)for(var n;n=e.lastChild;)e.removeChild(n);return new lc(e,0,t?{hydrate:!0}:void 0)}(n,r),a=i._internalRoot,"function"==typeof o){var l=o;o=function(){var e=ic(a);l.call(e)}}El((function(){oc(t,a,e,o)}))}return ic(a)}function fc(e,t){var n=2<arguments.length&&void 0!==arguments[2]?arguments[2]:null;if(!cc(t))throw Error(a(200));return function(e,t,n){var r=3<arguments.length&&void 0!==arguments[3]?arguments[3]:null;return{$$typeof:D,key:null==r?null:""+r,children:e,containerInfo:t,implementation:n}}(e,t,null,n)}lc.prototype.render=function(e,t){oc(e,this._internalRoot,null,void 0===t?null:t)},lc.prototype.unmount=function(e){var t=this._internalRoot,n=void 0===e?null:e,r=t.containerInfo;oc(null,t,null,(function(){r[fr]=null,null!==n&&n()}))},ot=function(e){if(13===e.tag){var t=ti(hl(),150,100);gl(e,t),sc(e,t)}},it=function(e){if(13===e.tag){hl();var t=ei++;gl(e,t),sc(e,t)}},at=function(e){if(13===e.tag){var t=hl();gl(e,t=ml(t,e,null)),sc(e,t)}},ee=function(e,t,n){switch(t){case"input":if(Ce(e,n),t=n.name,"radio"===n.type&&null!=t){for(n=e;n.parentNode;)n=n.parentNode;for(n=n.querySelectorAll("input[name="+JSON.stringify(""+t)+'][type="radio"]'),t=0;t<n.length;t++){var r=n[t];if(r!==e&&r.form===e.form){var o=mr(r);if(!o)throw Error(a(90));_e(r),Ce(r,o)}}}break;case"textarea":Me(e,n);break;case"select":null!=(t=n.value)&&Re(e,!!n.multiple,t,!1)}},ae=kl,se=function(e,t,n,r){var o=Ws;Ws|=4;try{return Qo(98,e.bind(null,t,n,r))}finally{(Ws=o)===Ns&&Jo()}},le=function(){(Ws&(1|Ms|Ds))===Ns&&(function(){if(null!==ul){var e=ul;ul=null,e.forEach((function(e,t){rc(t,e),bl(t)})),Jo()}}(),Dl())},ce=function(e,t){var n=Ws;Ws|=2;try{return e(t)}finally{(Ws=n)===Ns&&Jo()}};var pc,dc,hc={createPortal:fc,findDOMNode:function(e){if(null==e)return null;if(1===e.nodeType)return e;var t=e._reactInternalFiber;if(void 0===t){if("function"==typeof e.render)throw Error(a(188));throw Error(a(268,Object.keys(e)))}return e=null===(e=rt(t))?null:e.stateNode},hydrate:function(e,t,n){if(!cc(t))throw Error(a(200));return uc(null,e,t,!0,n)},render:function(e,t,n){if(!cc(t))throw Error(a(200));return uc(null,e,t,!1,n)},unstable_renderSubtreeIntoContainer:function(e,t,n,r){if(!cc(n))throw Error(a(200));if(null==e||void 0===e._reactInternalFiber)throw Error(a(38));return uc(e,t,n,!1,r)},unmountComponentAtNode:function(e){if(!cc(e))throw Error(a(40));return!!e._reactRootContainer&&(El((function(){uc(null,null,e,!1,(function(){e._reactRootContainer=null,e[fr]=null}))})),!0)},unstable_createPortal:function(){return fc.apply(void 0,arguments)},unstable_batchedUpdates:kl,flushSync:function(e,t){if((Ws&(Ms|Ds))!==Ns)throw Error(a(187));var n=Ws;Ws|=1;try{return Qo(99,e.bind(null,t))}finally{Ws=n,Jo()}},__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED:{Events:[dr,hr,mr,A.injectEventPluginsByName,p,Pt,function(e){T(e,At)},oe,ie,In,I,Dl,{current:!1}]}};dc=(pc={findFiberByHostInstance:pr,bundleType:0,version:"16.12.0",rendererPackageName:"react-dom"}).findFiberByHostInstance,function(e){if("undefined"==typeof __REACT_DEVTOOLS_GLOBAL_HOOK__)return!1;var t=__REACT_DEVTOOLS_GLOBAL_HOOK__;if(t.isDisabled||!t.supportsFiber)return!0;try{var n=t.inject(e);ql=function(e){try{t.onCommitFiberRoot(n,e,void 0,64==(64&e.current.effectTag))}catch(e){}},Wl=function(e){try{t.onCommitFiberUnmount(n,e)}catch(e){}}}catch(e){}}(o({},pc,{overrideHookState:null,overrideProps:null,setSuspenseHandler:null,scheduleUpdate:null,currentDispatcherRef:R.ReactCurrentDispatcher,findHostInstanceByFiber:function(e){return null===(e=rt(e))?null:e.stateNode},findFiberByHostInstance:function(e){return dc?dc(e):null},findHostInstancesForRefresh:null,scheduleRefresh:null,scheduleRoot:null,setRefreshHandler:null,getCurrentFiber:null}));var mc={default:hc},gc=mc&&hc||mc;e.exports=gc.default||gc},function(e,t,n){"use strict";e.exports=n(225)},function(e,t,n){"use strict";
|
||
/** @license React v0.18.0
|
||
* scheduler.production.min.js
|
||
*
|
||
* Copyright (c) Facebook, Inc. and its affiliates.
|
||
*
|
||
* This source code is licensed under the MIT license found in the
|
||
* LICENSE file in the root directory of this source tree.
|
||
*/var r,o,i,a,s;if(Object.defineProperty(t,"__esModule",{value:!0}),"undefined"==typeof window||"function"!=typeof MessageChannel){var l=null,c=null,u=function(){if(null!==l)try{var e=t.unstable_now();l(!0,e),l=null}catch(e){throw setTimeout(u,0),e}},f=Date.now();t.unstable_now=function(){return Date.now()-f},r=function(e){null!==l?setTimeout(r,0,e):(l=e,setTimeout(u,0))},o=function(e,t){c=setTimeout(e,t)},i=function(){clearTimeout(c)},a=function(){return!1},s=t.unstable_forceFrameRate=function(){}}else{var p=window.performance,d=window.Date,h=window.setTimeout,m=window.clearTimeout;if("undefined"!=typeof console){var g=window.cancelAnimationFrame;"function"!=typeof window.requestAnimationFrame&&console.error("This browser doesn't support requestAnimationFrame. Make sure that you load a polyfill in older browsers. https://fb.me/react-polyfills"),"function"!=typeof g&&console.error("This browser doesn't support cancelAnimationFrame. Make sure that you load a polyfill in older browsers. https://fb.me/react-polyfills")}if("object"==typeof p&&"function"==typeof p.now)t.unstable_now=function(){return p.now()};else{var y=d.now();t.unstable_now=function(){return d.now()-y}}var v=!1,b=null,w=-1,x=5,k=0;a=function(){return t.unstable_now()>=k},s=function(){},t.unstable_forceFrameRate=function(e){0>e||125<e?console.error("forceFrameRate takes a positive int between 0 and 125, forcing framerates higher than 125 fps is not unsupported"):x=0<e?Math.floor(1e3/e):5};var E=new MessageChannel,O=E.port2;E.port1.onmessage=function(){if(null!==b){var e=t.unstable_now();k=e+x;try{b(!0,e)?O.postMessage(null):(v=!1,b=null)}catch(e){throw O.postMessage(null),e}}else v=!1},r=function(e){b=e,v||(v=!0,O.postMessage(null))},o=function(e,n){w=h((function(){e(t.unstable_now())}),n)},i=function(){m(w),w=-1}}function _(e,t){var n=e.length;e.push(t);e:for(;;){var r=Math.floor((n-1)/2),o=e[r];if(!(void 0!==o&&0<j(o,t)))break e;e[r]=t,e[n]=o,n=r}}function S(e){return void 0===(e=e[0])?null:e}function T(e){var t=e[0];if(void 0!==t){var n=e.pop();if(n!==t){e[0]=n;e:for(var r=0,o=e.length;r<o;){var i=2*(r+1)-1,a=e[i],s=i+1,l=e[s];if(void 0!==a&&0>j(a,n))void 0!==l&&0>j(l,a)?(e[r]=l,e[s]=n,r=s):(e[r]=a,e[i]=n,r=i);else{if(!(void 0!==l&&0>j(l,n)))break e;e[r]=l,e[s]=n,r=s}}}return t}return null}function j(e,t){var n=e.sortIndex-t.sortIndex;return 0!==n?n:e.id-t.id}var C=[],I=[],A=1,P=null,R=3,N=!1,L=!1,M=!1;function D(e){for(var t=S(I);null!==t;){if(null===t.callback)T(I);else{if(!(t.startTime<=e))break;T(I),t.sortIndex=t.expirationTime,_(C,t)}t=S(I)}}function F(e){if(M=!1,D(e),!L)if(null!==S(C))L=!0,r(U);else{var t=S(I);null!==t&&o(F,t.startTime-e)}}function U(e,n){L=!1,M&&(M=!1,i()),N=!0;var r=R;try{for(D(n),P=S(C);null!==P&&(!(P.expirationTime>n)||e&&!a());){var s=P.callback;if(null!==s){P.callback=null,R=P.priorityLevel;var l=s(P.expirationTime<=n);n=t.unstable_now(),"function"==typeof l?P.callback=l:P===S(C)&&T(C),D(n)}else T(C);P=S(C)}if(null!==P)var c=!0;else{var u=S(I);null!==u&&o(F,u.startTime-n),c=!1}return c}finally{P=null,R=r,N=!1}}function z(e){switch(e){case 1:return-1;case 2:return 250;case 5:return 1073741823;case 4:return 1e4;default:return 5e3}}var B=s;t.unstable_ImmediatePriority=1,t.unstable_UserBlockingPriority=2,t.unstable_NormalPriority=3,t.unstable_IdlePriority=5,t.unstable_LowPriority=4,t.unstable_runWithPriority=function(e,t){switch(e){case 1:case 2:case 3:case 4:case 5:break;default:e=3}var n=R;R=e;try{return t()}finally{R=n}},t.unstable_next=function(e){switch(R){case 1:case 2:case 3:var t=3;break;default:t=R}var n=R;R=t;try{return e()}finally{R=n}},t.unstable_scheduleCallback=function(e,n,a){var s=t.unstable_now();if("object"==typeof a&&null!==a){var l=a.delay;l="number"==typeof l&&0<l?s+l:s,a="number"==typeof a.timeout?a.timeout:z(e)}else a=z(e),l=s;return e={id:A++,callback:n,priorityLevel:e,startTime:l,expirationTime:a=l+a,sortIndex:-1},l>s?(e.sortIndex=l,_(I,e),null===S(C)&&e===S(I)&&(M?i():M=!0,o(F,l-s))):(e.sortIndex=a,_(C,e),L||N||(L=!0,r(U))),e},t.unstable_cancelCallback=function(e){e.callback=null},t.unstable_wrapCallback=function(e){var t=R;return function(){var n=R;R=t;try{return e.apply(this,arguments)}finally{R=n}}},t.unstable_getCurrentPriorityLevel=function(){return R},t.unstable_shouldYield=function(){var e=t.unstable_now();D(e);var n=S(C);return n!==P&&null!==P&&null!==n&&null!==n.callback&&n.startTime<=e&&n.expirationTime<P.expirationTime||a()},t.unstable_requestPaint=B,t.unstable_continueExecution=function(){L||N||(L=!0,r(U))},t.unstable_pauseExecution=function(){},t.unstable_getFirstCallbackNode=function(){return S(C)},t.unstable_Profiling=null},function(e,t,n){"use strict";var r=n(227);function o(){}function i(){}i.resetWarningCache=o,e.exports=function(){function e(e,t,n,o,i,a){if(a!==r){var s=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw s.name="Invariant Violation",s}}function t(){return e}e.isRequired=e;var n={array:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:i,resetWarningCache:o};return n.PropTypes=n,n}},function(e,t,n){"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},function(e,t,n){(function(e,r){var o;/*! https://mths.be/punycode v1.4.1 by @mathias */!function(i){t&&t.nodeType,e&&e.nodeType;var a="object"==typeof r&&r;a.global!==a&&a.window!==a&&a.self;var s,l=2147483647,c=36,u=1,f=26,p=38,d=700,h=72,m=128,g="-",y=/^xn--/,v=/[^\x20-\x7E]/,b=/[\x2E\u3002\uFF0E\uFF61]/g,w={overflow:"Overflow: input needs wider integers to process","not-basic":"Illegal input >= 0x80 (not a basic code point)","invalid-input":"Invalid input"},x=c-u,k=Math.floor,E=String.fromCharCode;function O(e){throw new RangeError(w[e])}function _(e,t){for(var n=e.length,r=[];n--;)r[n]=t(e[n]);return r}function S(e,t){var n=e.split("@"),r="";return n.length>1&&(r=n[0]+"@",e=n[1]),r+_((e=e.replace(b,".")).split("."),t).join(".")}function T(e){for(var t,n,r=[],o=0,i=e.length;o<i;)(t=e.charCodeAt(o++))>=55296&&t<=56319&&o<i?56320==(64512&(n=e.charCodeAt(o++)))?r.push(((1023&t)<<10)+(1023&n)+65536):(r.push(t),o--):r.push(t);return r}function j(e){return _(e,(function(e){var t="";return e>65535&&(t+=E((e-=65536)>>>10&1023|55296),e=56320|1023&e),t+=E(e)})).join("")}function C(e,t){return e+22+75*(e<26)-((0!=t)<<5)}function I(e,t,n){var r=0;for(e=n?k(e/d):e>>1,e+=k(e/t);e>x*f>>1;r+=c)e=k(e/x);return k(r+(x+1)*e/(e+p))}function A(e){var t,n,r,o,i,a,s,p,d,y,v,b=[],w=e.length,x=0,E=m,_=h;for((n=e.lastIndexOf(g))<0&&(n=0),r=0;r<n;++r)e.charCodeAt(r)>=128&&O("not-basic"),b.push(e.charCodeAt(r));for(o=n>0?n+1:0;o<w;){for(i=x,a=1,s=c;o>=w&&O("invalid-input"),((p=(v=e.charCodeAt(o++))-48<10?v-22:v-65<26?v-65:v-97<26?v-97:c)>=c||p>k((l-x)/a))&&O("overflow"),x+=p*a,!(p<(d=s<=_?u:s>=_+f?f:s-_));s+=c)a>k(l/(y=c-d))&&O("overflow"),a*=y;_=I(x-i,t=b.length+1,0==i),k(x/t)>l-E&&O("overflow"),E+=k(x/t),x%=t,b.splice(x++,0,E)}return j(b)}function P(e){var t,n,r,o,i,a,s,p,d,y,v,b,w,x,_,S=[];for(b=(e=T(e)).length,t=m,n=0,i=h,a=0;a<b;++a)(v=e[a])<128&&S.push(E(v));for(r=o=S.length,o&&S.push(g);r<b;){for(s=l,a=0;a<b;++a)(v=e[a])>=t&&v<s&&(s=v);for(s-t>k((l-n)/(w=r+1))&&O("overflow"),n+=(s-t)*w,t=s,a=0;a<b;++a)if((v=e[a])<t&&++n>l&&O("overflow"),v==t){for(p=n,d=c;!(p<(y=d<=i?u:d>=i+f?f:d-i));d+=c)_=p-y,x=c-y,S.push(E(C(y+_%x,0))),p=k(_/x);S.push(E(C(p,0))),i=I(n,w,r==o),n=0,++r}++n,++t}return S.join("")}s={version:"1.4.1",ucs2:{decode:T,encode:j},decode:A,encode:P,toASCII:function(e){return S(e,(function(e){return v.test(e)?"xn--"+P(e):e}))},toUnicode:function(e){return S(e,(function(e){return y.test(e)?A(e.slice(4).toLowerCase()):e}))}},void 0===(o=function(){return s}.call(t,n,t,e))||(e.exports=o)}()}).call(this,n(229)(e),n(6))},function(e,t){e.exports=function(e){return e.webpackPolyfill||(e.deprecate=function(){},e.paths=[],e.children||(e.children=[]),Object.defineProperty(e,"loaded",{enumerable:!0,get:function(){return e.l}}),Object.defineProperty(e,"id",{enumerable:!0,get:function(){return e.i}}),e.webpackPolyfill=1),e}},function(e,t,n){"use strict";e.exports={isString:function(e){return"string"==typeof e},isObject:function(e){return"object"==typeof e&&null!==e},isNull:function(e){return null===e},isNullOrUndefined:function(e){return null==e}}},function(e,t,n){"use strict";t.decode=t.parse=n(232),t.encode=t.stringify=n(233)},function(e,t,n){"use strict";function r(e,t){return Object.prototype.hasOwnProperty.call(e,t)}e.exports=function(e,t,n,i){t=t||"&",n=n||"=";var a={};if("string"!=typeof e||0===e.length)return a;var s=/\+/g;e=e.split(t);var l=1e3;i&&"number"==typeof i.maxKeys&&(l=i.maxKeys);var c=e.length;l>0&&c>l&&(c=l);for(var u=0;u<c;++u){var f,p,d,h,m=e[u].replace(s,"%20"),g=m.indexOf(n);g>=0?(f=m.substr(0,g),p=m.substr(g+1)):(f=m,p=""),d=decodeURIComponent(f),h=decodeURIComponent(p),r(a,d)?o(a[d])?a[d].push(h):a[d]=[a[d],h]:a[d]=h}return a};var o=Array.isArray||function(e){return"[object Array]"===Object.prototype.toString.call(e)}},function(e,t,n){"use strict";var r=function(e){switch(typeof e){case"string":return e;case"boolean":return e?"true":"false";case"number":return isFinite(e)?e:"";default:return""}};e.exports=function(e,t,n,s){return t=t||"&",n=n||"=",null===e&&(e=void 0),"object"==typeof e?i(a(e),(function(a){var s=encodeURIComponent(r(a))+n;return o(e[a])?i(e[a],(function(e){return s+encodeURIComponent(r(e))})).join(t):s+encodeURIComponent(r(e[a]))})).join(t):s?encodeURIComponent(r(s))+n+encodeURIComponent(r(e)):""};var o=Array.isArray||function(e){return"[object Array]"===Object.prototype.toString.call(e)};function i(e,t){if(e.map)return e.map(t);for(var n=[],r=0;r<e.length;r++)n.push(t(e[r],r));return n}var a=Object.keys||function(e){var t=[];for(var n in e)Object.prototype.hasOwnProperty.call(e,n)&&t.push(n);return t}},function(e,t,n){"use strict";
|
||
/** @license React v16.12.0
|
||
* react-is.production.min.js
|
||
*
|
||
* Copyright (c) Facebook, Inc. and its affiliates.
|
||
*
|
||
* This source code is licensed under the MIT license found in the
|
||
* LICENSE file in the root directory of this source tree.
|
||
*/Object.defineProperty(t,"__esModule",{value:!0});var r="function"==typeof Symbol&&Symbol.for,o=r?Symbol.for("react.element"):60103,i=r?Symbol.for("react.portal"):60106,a=r?Symbol.for("react.fragment"):60107,s=r?Symbol.for("react.strict_mode"):60108,l=r?Symbol.for("react.profiler"):60114,c=r?Symbol.for("react.provider"):60109,u=r?Symbol.for("react.context"):60110,f=r?Symbol.for("react.async_mode"):60111,p=r?Symbol.for("react.concurrent_mode"):60111,d=r?Symbol.for("react.forward_ref"):60112,h=r?Symbol.for("react.suspense"):60113,m=r?Symbol.for("react.suspense_list"):60120,g=r?Symbol.for("react.memo"):60115,y=r?Symbol.for("react.lazy"):60116,v=r?Symbol.for("react.fundamental"):60117,b=r?Symbol.for("react.responder"):60118,w=r?Symbol.for("react.scope"):60119;function x(e){if("object"==typeof e&&null!==e){var t=e.$$typeof;switch(t){case o:switch(e=e.type){case f:case p:case a:case l:case s:case h:return e;default:switch(e=e&&e.$$typeof){case u:case d:case y:case g:case c:return e;default:return t}}case i:return t}}}function k(e){return x(e)===p}t.typeOf=x,t.AsyncMode=f,t.ConcurrentMode=p,t.ContextConsumer=u,t.ContextProvider=c,t.Element=o,t.ForwardRef=d,t.Fragment=a,t.Lazy=y,t.Memo=g,t.Portal=i,t.Profiler=l,t.StrictMode=s,t.Suspense=h,t.isValidElementType=function(e){return"string"==typeof e||"function"==typeof e||e===a||e===p||e===l||e===s||e===h||e===m||"object"==typeof e&&null!==e&&(e.$$typeof===y||e.$$typeof===g||e.$$typeof===c||e.$$typeof===u||e.$$typeof===d||e.$$typeof===v||e.$$typeof===b||e.$$typeof===w)},t.isAsyncMode=function(e){return k(e)||x(e)===f},t.isConcurrentMode=k,t.isContextConsumer=function(e){return x(e)===u},t.isContextProvider=function(e){return x(e)===c},t.isElement=function(e){return"object"==typeof e&&null!==e&&e.$$typeof===o},t.isForwardRef=function(e){return x(e)===d},t.isFragment=function(e){return x(e)===a},t.isLazy=function(e){return x(e)===y},t.isMemo=function(e){return x(e)===g},t.isPortal=function(e){return x(e)===i},t.isProfiler=function(e){return x(e)===l},t.isStrictMode=function(e){return x(e)===s},t.isSuspense=function(e){return x(e)===h}},function(e,t,n){"use strict";t.byteLength=function(e){var t=c(e),n=t[0],r=t[1];return 3*(n+r)/4-r},t.toByteArray=function(e){var t,n,r=c(e),a=r[0],s=r[1],l=new i(function(e,t,n){return 3*(t+n)/4-n}(0,a,s)),u=0,f=s>0?a-4:a;for(n=0;n<f;n+=4)t=o[e.charCodeAt(n)]<<18|o[e.charCodeAt(n+1)]<<12|o[e.charCodeAt(n+2)]<<6|o[e.charCodeAt(n+3)],l[u++]=t>>16&255,l[u++]=t>>8&255,l[u++]=255&t;2===s&&(t=o[e.charCodeAt(n)]<<2|o[e.charCodeAt(n+1)]>>4,l[u++]=255&t);1===s&&(t=o[e.charCodeAt(n)]<<10|o[e.charCodeAt(n+1)]<<4|o[e.charCodeAt(n+2)]>>2,l[u++]=t>>8&255,l[u++]=255&t);return l},t.fromByteArray=function(e){for(var t,n=e.length,o=n%3,i=[],a=0,s=n-o;a<s;a+=16383)i.push(u(e,a,a+16383>s?s:a+16383));1===o?(t=e[n-1],i.push(r[t>>2]+r[t<<4&63]+"==")):2===o&&(t=(e[n-2]<<8)+e[n-1],i.push(r[t>>10]+r[t>>4&63]+r[t<<2&63]+"="));return i.join("")};for(var r=[],o=[],i="undefined"!=typeof Uint8Array?Uint8Array:Array,a="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/",s=0,l=a.length;s<l;++s)r[s]=a[s],o[a.charCodeAt(s)]=s;function c(e){var t=e.length;if(t%4>0)throw new Error("Invalid string. Length must be a multiple of 4");var n=e.indexOf("=");return-1===n&&(n=t),[n,n===t?0:4-n%4]}function u(e,t,n){for(var o,i,a=[],s=t;s<n;s+=3)o=(e[s]<<16&16711680)+(e[s+1]<<8&65280)+(255&e[s+2]),a.push(r[(i=o)>>18&63]+r[i>>12&63]+r[i>>6&63]+r[63&i]);return a.join("")}o["-".charCodeAt(0)]=62,o["_".charCodeAt(0)]=63},function(e,t){t.read=function(e,t,n,r,o){var i,a,s=8*o-r-1,l=(1<<s)-1,c=l>>1,u=-7,f=n?o-1:0,p=n?-1:1,d=e[t+f];for(f+=p,i=d&(1<<-u)-1,d>>=-u,u+=s;u>0;i=256*i+e[t+f],f+=p,u-=8);for(a=i&(1<<-u)-1,i>>=-u,u+=r;u>0;a=256*a+e[t+f],f+=p,u-=8);if(0===i)i=1-c;else{if(i===l)return a?NaN:1/0*(d?-1:1);a+=Math.pow(2,r),i-=c}return(d?-1:1)*a*Math.pow(2,i-r)},t.write=function(e,t,n,r,o,i){var a,s,l,c=8*i-o-1,u=(1<<c)-1,f=u>>1,p=23===o?Math.pow(2,-24)-Math.pow(2,-77):0,d=r?0:i-1,h=r?1:-1,m=t<0||0===t&&1/t<0?1:0;for(t=Math.abs(t),isNaN(t)||t===1/0?(s=isNaN(t)?1:0,a=u):(a=Math.floor(Math.log(t)/Math.LN2),t*(l=Math.pow(2,-a))<1&&(a--,l*=2),(t+=a+f>=1?p/l:p*Math.pow(2,1-f))*l>=2&&(a++,l/=2),a+f>=u?(s=0,a=u):a+f>=1?(s=(t*l-1)*Math.pow(2,o),a+=f):(s=t*Math.pow(2,f-1)*Math.pow(2,o),a=0));o>=8;e[n+d]=255&s,d+=h,s/=256,o-=8);for(a=a<<o|s,c+=o;c>0;e[n+d]=255&a,d+=h,a/=256,c-=8);e[n+d-h]|=128*m}},function(e,t,n){"use strict";(function(t){e.exports={order:100,allowEmpty:!0,canParse:".json",parse:function(e){return new Promise((function(n,r){var o=e.data;t.isBuffer(o)&&(o=o.toString()),"string"==typeof o?0===o.trim().length?n(void 0):n(JSON.parse(o)):n(o)}))}}}).call(this,n(11).Buffer)},function(e,t,n){"use strict";(function(t){var r=n(130);e.exports={order:200,allowEmpty:!0,canParse:[".yaml",".yml",".json"],parse:function(e){return new Promise((function(n,o){var i=e.data;t.isBuffer(i)&&(i=i.toString()),n("string"==typeof i?r.parse(i):i)}))}}}).call(this,n(11).Buffer)},function(e,t,n){"use strict";var r=n(240);e.exports=r},function(e,t,n){"use strict";var r=n(241),o=n(260);function i(e){return function(){throw new Error("Function "+e+" is deprecated and cannot be used.")}}e.exports.Type=n(5),e.exports.Schema=n(36),e.exports.FAILSAFE_SCHEMA=n(85),e.exports.JSON_SCHEMA=n(132),e.exports.CORE_SCHEMA=n(131),e.exports.DEFAULT_SAFE_SCHEMA=n(58),e.exports.DEFAULT_FULL_SCHEMA=n(86),e.exports.load=r.load,e.exports.loadAll=r.loadAll,e.exports.safeLoad=r.safeLoad,e.exports.safeLoadAll=r.safeLoadAll,e.exports.dump=o.dump,e.exports.safeDump=o.safeDump,e.exports.YAMLException=n(57),e.exports.MINIMAL_SCHEMA=n(85),e.exports.SAFE_SCHEMA=n(58),e.exports.DEFAULT_SCHEMA=n(86),e.exports.scan=i("scan"),e.exports.parse=i("parse"),e.exports.compose=i("compose"),e.exports.addConstructor=i("addConstructor")},function(e,t,n){"use strict";var r=n(46),o=n(57),i=n(242),a=n(58),s=n(86),l=Object.prototype.hasOwnProperty,c=1,u=2,f=3,p=4,d=1,h=2,m=3,g=/[\x00-\x08\x0B\x0C\x0E-\x1F\x7F-\x84\x86-\x9F\uFFFE\uFFFF]|[\uD800-\uDBFF](?![\uDC00-\uDFFF])|(?:[^\uD800-\uDBFF]|^)[\uDC00-\uDFFF]/,y=/[\x85\u2028\u2029]/,v=/[,\[\]\{\}]/,b=/^(?:!|!!|![a-z\-]+!)$/i,w=/^(?:!|[^,\[\]\{\}])(?:%[0-9a-f]{2}|[0-9a-z\-#;\/\?:@&=\+\$,_\.!~\*'\(\)\[\]])*$/i;function x(e){return Object.prototype.toString.call(e)}function k(e){return 10===e||13===e}function E(e){return 9===e||32===e}function O(e){return 9===e||32===e||10===e||13===e}function _(e){return 44===e||91===e||93===e||123===e||125===e}function S(e){var t;return 48<=e&&e<=57?e-48:97<=(t=32|e)&&t<=102?t-97+10:-1}function T(e){return 48===e?"\0":97===e?"":98===e?"\b":116===e?"\t":9===e?"\t":110===e?"\n":118===e?"\v":102===e?"\f":114===e?"\r":101===e?"":32===e?" ":34===e?'"':47===e?"/":92===e?"\\":78===e?"
":95===e?" ":76===e?"\u2028":80===e?"\u2029":""}function j(e){return e<=65535?String.fromCharCode(e):String.fromCharCode(55296+(e-65536>>10),56320+(e-65536&1023))}for(var C=new Array(256),I=new Array(256),A=0;A<256;A++)C[A]=T(A)?1:0,I[A]=T(A);function P(e,t){this.input=e,this.filename=t.filename||null,this.schema=t.schema||s,this.onWarning=t.onWarning||null,this.legacy=t.legacy||!1,this.json=t.json||!1,this.listener=t.listener||null,this.implicitTypes=this.schema.compiledImplicit,this.typeMap=this.schema.compiledTypeMap,this.length=e.length,this.position=0,this.line=0,this.lineStart=0,this.lineIndent=0,this.documents=[]}function R(e,t){return new o(t,new i(e.filename,e.input,e.position,e.line,e.position-e.lineStart))}function N(e,t){throw R(e,t)}function L(e,t){e.onWarning&&e.onWarning.call(null,R(e,t))}var M={YAML:function(e,t,n){var r,o,i;null!==e.version&&N(e,"duplication of %YAML directive"),1!==n.length&&N(e,"YAML directive accepts exactly one argument"),null===(r=/^([0-9]+)\.([0-9]+)$/.exec(n[0]))&&N(e,"ill-formed argument of the YAML directive"),o=parseInt(r[1],10),i=parseInt(r[2],10),1!==o&&N(e,"unacceptable YAML version of the document"),e.version=n[0],e.checkLineBreaks=i<2,1!==i&&2!==i&&L(e,"unsupported YAML version of the document")},TAG:function(e,t,n){var r,o;2!==n.length&&N(e,"TAG directive accepts exactly two arguments"),r=n[0],o=n[1],b.test(r)||N(e,"ill-formed tag handle (first argument) of the TAG directive"),l.call(e.tagMap,r)&&N(e,'there is a previously declared suffix for "'+r+'" tag handle'),w.test(o)||N(e,"ill-formed tag prefix (second argument) of the TAG directive"),e.tagMap[r]=o}};function D(e,t,n,r){var o,i,a,s;if(t<n){if(s=e.input.slice(t,n),r)for(o=0,i=s.length;o<i;o+=1)9===(a=s.charCodeAt(o))||32<=a&&a<=1114111||N(e,"expected valid JSON character");else g.test(s)&&N(e,"the stream contains non-printable characters");e.result+=s}}function F(e,t,n,o){var i,a,s,c;for(r.isObject(n)||N(e,"cannot merge mappings; the provided source object is unacceptable"),s=0,c=(i=Object.keys(n)).length;s<c;s+=1)a=i[s],l.call(t,a)||(t[a]=n[a],o[a]=!0)}function U(e,t,n,r,o,i,a,s){var c,u;if(Array.isArray(o))for(c=0,u=(o=Array.prototype.slice.call(o)).length;c<u;c+=1)Array.isArray(o[c])&&N(e,"nested arrays are not supported inside keys"),"object"==typeof o&&"[object Object]"===x(o[c])&&(o[c]="[object Object]");if("object"==typeof o&&"[object Object]"===x(o)&&(o="[object Object]"),o=String(o),null===t&&(t={}),"tag:yaml.org,2002:merge"===r)if(Array.isArray(i))for(c=0,u=i.length;c<u;c+=1)F(e,t,i[c],n);else F(e,t,i,n);else e.json||l.call(n,o)||!l.call(t,o)||(e.line=a||e.line,e.position=s||e.position,N(e,"duplicated mapping key")),t[o]=i,delete n[o];return t}function z(e){var t;10===(t=e.input.charCodeAt(e.position))?e.position++:13===t?(e.position++,10===e.input.charCodeAt(e.position)&&e.position++):N(e,"a line break is expected"),e.line+=1,e.lineStart=e.position}function B(e,t,n){for(var r=0,o=e.input.charCodeAt(e.position);0!==o;){for(;E(o);)o=e.input.charCodeAt(++e.position);if(t&&35===o)do{o=e.input.charCodeAt(++e.position)}while(10!==o&&13!==o&&0!==o);if(!k(o))break;for(z(e),o=e.input.charCodeAt(e.position),r++,e.lineIndent=0;32===o;)e.lineIndent++,o=e.input.charCodeAt(++e.position)}return-1!==n&&0!==r&&e.lineIndent<n&&L(e,"deficient indentation"),r}function $(e){var t,n=e.position;return!(45!==(t=e.input.charCodeAt(n))&&46!==t||t!==e.input.charCodeAt(n+1)||t!==e.input.charCodeAt(n+2)||(n+=3,0!==(t=e.input.charCodeAt(n))&&!O(t)))}function q(e,t){1===t?e.result+=" ":t>1&&(e.result+=r.repeat("\n",t-1))}function W(e,t){var n,r,o=e.tag,i=e.anchor,a=[],s=!1;for(null!==e.anchor&&(e.anchorMap[e.anchor]=a),r=e.input.charCodeAt(e.position);0!==r&&45===r&&O(e.input.charCodeAt(e.position+1));)if(s=!0,e.position++,B(e,!0,-1)&&e.lineIndent<=t)a.push(null),r=e.input.charCodeAt(e.position);else if(n=e.line,Y(e,t,f,!1,!0),a.push(e.result),B(e,!0,-1),r=e.input.charCodeAt(e.position),(e.line===n||e.lineIndent>t)&&0!==r)N(e,"bad indentation of a sequence entry");else if(e.lineIndent<t)break;return!!s&&(e.tag=o,e.anchor=i,e.kind="sequence",e.result=a,!0)}function H(e){var t,n,r,o,i=!1,a=!1;if(33!==(o=e.input.charCodeAt(e.position)))return!1;if(null!==e.tag&&N(e,"duplication of a tag property"),60===(o=e.input.charCodeAt(++e.position))?(i=!0,o=e.input.charCodeAt(++e.position)):33===o?(a=!0,n="!!",o=e.input.charCodeAt(++e.position)):n="!",t=e.position,i){do{o=e.input.charCodeAt(++e.position)}while(0!==o&&62!==o);e.position<e.length?(r=e.input.slice(t,e.position),o=e.input.charCodeAt(++e.position)):N(e,"unexpected end of the stream within a verbatim tag")}else{for(;0!==o&&!O(o);)33===o&&(a?N(e,"tag suffix cannot contain exclamation marks"):(n=e.input.slice(t-1,e.position+1),b.test(n)||N(e,"named tag handle cannot contain such characters"),a=!0,t=e.position+1)),o=e.input.charCodeAt(++e.position);r=e.input.slice(t,e.position),v.test(r)&&N(e,"tag suffix cannot contain flow indicator characters")}return r&&!w.test(r)&&N(e,"tag name cannot contain such characters: "+r),i?e.tag=r:l.call(e.tagMap,n)?e.tag=e.tagMap[n]+r:"!"===n?e.tag="!"+r:"!!"===n?e.tag="tag:yaml.org,2002:"+r:N(e,'undeclared tag handle "'+n+'"'),!0}function V(e){var t,n;if(38!==(n=e.input.charCodeAt(e.position)))return!1;for(null!==e.anchor&&N(e,"duplication of an anchor property"),n=e.input.charCodeAt(++e.position),t=e.position;0!==n&&!O(n)&&!_(n);)n=e.input.charCodeAt(++e.position);return e.position===t&&N(e,"name of an anchor node must contain at least one character"),e.anchor=e.input.slice(t,e.position),!0}function Y(e,t,n,o,i){var a,s,g,y,v,b,w,x,T=1,A=!1,P=!1;if(null!==e.listener&&e.listener("open",e),e.tag=null,e.anchor=null,e.kind=null,e.result=null,a=s=g=p===n||f===n,o&&B(e,!0,-1)&&(A=!0,e.lineIndent>t?T=1:e.lineIndent===t?T=0:e.lineIndent<t&&(T=-1)),1===T)for(;H(e)||V(e);)B(e,!0,-1)?(A=!0,g=a,e.lineIndent>t?T=1:e.lineIndent===t?T=0:e.lineIndent<t&&(T=-1)):g=!1;if(g&&(g=A||i),1!==T&&p!==n||(w=c===n||u===n?t:t+1,x=e.position-e.lineStart,1===T?g&&(W(e,x)||function(e,t,n){var r,o,i,a,s,l=e.tag,c=e.anchor,f={},d={},h=null,m=null,g=null,y=!1,v=!1;for(null!==e.anchor&&(e.anchorMap[e.anchor]=f),s=e.input.charCodeAt(e.position);0!==s;){if(r=e.input.charCodeAt(e.position+1),i=e.line,a=e.position,63!==s&&58!==s||!O(r)){if(!Y(e,n,u,!1,!0))break;if(e.line===i){for(s=e.input.charCodeAt(e.position);E(s);)s=e.input.charCodeAt(++e.position);if(58===s)O(s=e.input.charCodeAt(++e.position))||N(e,"a whitespace character is expected after the key-value separator within a block mapping"),y&&(U(e,f,d,h,m,null),h=m=g=null),v=!0,y=!1,o=!1,h=e.tag,m=e.result;else{if(!v)return e.tag=l,e.anchor=c,!0;N(e,"can not read an implicit mapping pair; a colon is missed")}}else{if(!v)return e.tag=l,e.anchor=c,!0;N(e,"can not read a block mapping entry; a multiline key may not be an implicit key")}}else 63===s?(y&&(U(e,f,d,h,m,null),h=m=g=null),v=!0,y=!0,o=!0):y?(y=!1,o=!0):N(e,"incomplete explicit mapping pair; a key node is missed; or followed by a non-tabulated empty line"),e.position+=1,s=r;if((e.line===i||e.lineIndent>t)&&(Y(e,t,p,!0,o)&&(y?m=e.result:g=e.result),y||(U(e,f,d,h,m,g,i,a),h=m=g=null),B(e,!0,-1),s=e.input.charCodeAt(e.position)),e.lineIndent>t&&0!==s)N(e,"bad indentation of a mapping entry");else if(e.lineIndent<t)break}return y&&U(e,f,d,h,m,null),v&&(e.tag=l,e.anchor=c,e.kind="mapping",e.result=f),v}(e,x,w))||function(e,t){var n,r,o,i,a,s,l,u,f,p,d=!0,h=e.tag,m=e.anchor,g={};if(91===(p=e.input.charCodeAt(e.position)))o=93,s=!1,r=[];else{if(123!==p)return!1;o=125,s=!0,r={}}for(null!==e.anchor&&(e.anchorMap[e.anchor]=r),p=e.input.charCodeAt(++e.position);0!==p;){if(B(e,!0,t),(p=e.input.charCodeAt(e.position))===o)return e.position++,e.tag=h,e.anchor=m,e.kind=s?"mapping":"sequence",e.result=r,!0;d||N(e,"missed comma between flow collection entries"),f=null,i=a=!1,63===p&&O(e.input.charCodeAt(e.position+1))&&(i=a=!0,e.position++,B(e,!0,t)),n=e.line,Y(e,t,c,!1,!0),u=e.tag,l=e.result,B(e,!0,t),p=e.input.charCodeAt(e.position),!a&&e.line!==n||58!==p||(i=!0,p=e.input.charCodeAt(++e.position),B(e,!0,t),Y(e,t,c,!1,!0),f=e.result),s?U(e,r,g,u,l,f):i?r.push(U(e,null,g,u,l,f)):r.push(l),B(e,!0,t),44===(p=e.input.charCodeAt(e.position))?(d=!0,p=e.input.charCodeAt(++e.position)):d=!1}N(e,"unexpected end of the stream within a flow collection")}(e,w)?P=!0:(s&&function(e,t){var n,o,i,a,s,l=d,c=!1,u=!1,f=t,p=0,g=!1;if(124===(a=e.input.charCodeAt(e.position)))o=!1;else{if(62!==a)return!1;o=!0}for(e.kind="scalar",e.result="";0!==a;)if(43===(a=e.input.charCodeAt(++e.position))||45===a)d===l?l=43===a?m:h:N(e,"repeat of a chomping mode identifier");else{if(!((i=48<=(s=a)&&s<=57?s-48:-1)>=0))break;0===i?N(e,"bad explicit indentation width of a block scalar; it cannot be less than one"):u?N(e,"repeat of an indentation width identifier"):(f=t+i-1,u=!0)}if(E(a)){do{a=e.input.charCodeAt(++e.position)}while(E(a));if(35===a)do{a=e.input.charCodeAt(++e.position)}while(!k(a)&&0!==a)}for(;0!==a;){for(z(e),e.lineIndent=0,a=e.input.charCodeAt(e.position);(!u||e.lineIndent<f)&&32===a;)e.lineIndent++,a=e.input.charCodeAt(++e.position);if(!u&&e.lineIndent>f&&(f=e.lineIndent),k(a))p++;else{if(e.lineIndent<f){l===m?e.result+=r.repeat("\n",c?1+p:p):l===d&&c&&(e.result+="\n");break}for(o?E(a)?(g=!0,e.result+=r.repeat("\n",c?1+p:p)):g?(g=!1,e.result+=r.repeat("\n",p+1)):0===p?c&&(e.result+=" "):e.result+=r.repeat("\n",p):e.result+=r.repeat("\n",c?1+p:p),c=!0,u=!0,p=0,n=e.position;!k(a)&&0!==a;)a=e.input.charCodeAt(++e.position);D(e,n,e.position,!1)}}return!0}(e,w)||function(e,t){var n,r,o;if(39!==(n=e.input.charCodeAt(e.position)))return!1;for(e.kind="scalar",e.result="",e.position++,r=o=e.position;0!==(n=e.input.charCodeAt(e.position));)if(39===n){if(D(e,r,e.position,!0),39!==(n=e.input.charCodeAt(++e.position)))return!0;r=e.position,e.position++,o=e.position}else k(n)?(D(e,r,o,!0),q(e,B(e,!1,t)),r=o=e.position):e.position===e.lineStart&&$(e)?N(e,"unexpected end of the document within a single quoted scalar"):(e.position++,o=e.position);N(e,"unexpected end of the stream within a single quoted scalar")}(e,w)||function(e,t){var n,r,o,i,a,s,l;if(34!==(s=e.input.charCodeAt(e.position)))return!1;for(e.kind="scalar",e.result="",e.position++,n=r=e.position;0!==(s=e.input.charCodeAt(e.position));){if(34===s)return D(e,n,e.position,!0),e.position++,!0;if(92===s){if(D(e,n,e.position,!0),k(s=e.input.charCodeAt(++e.position)))B(e,!1,t);else if(s<256&&C[s])e.result+=I[s],e.position++;else if((a=120===(l=s)?2:117===l?4:85===l?8:0)>0){for(o=a,i=0;o>0;o--)(a=S(s=e.input.charCodeAt(++e.position)))>=0?i=(i<<4)+a:N(e,"expected hexadecimal character");e.result+=j(i),e.position++}else N(e,"unknown escape sequence");n=r=e.position}else k(s)?(D(e,n,r,!0),q(e,B(e,!1,t)),n=r=e.position):e.position===e.lineStart&&$(e)?N(e,"unexpected end of the document within a double quoted scalar"):(e.position++,r=e.position)}N(e,"unexpected end of the stream within a double quoted scalar")}(e,w)?P=!0:!function(e){var t,n,r;if(42!==(r=e.input.charCodeAt(e.position)))return!1;for(r=e.input.charCodeAt(++e.position),t=e.position;0!==r&&!O(r)&&!_(r);)r=e.input.charCodeAt(++e.position);return e.position===t&&N(e,"name of an alias node must contain at least one character"),n=e.input.slice(t,e.position),e.anchorMap.hasOwnProperty(n)||N(e,'unidentified alias "'+n+'"'),e.result=e.anchorMap[n],B(e,!0,-1),!0}(e)?function(e,t,n){var r,o,i,a,s,l,c,u,f=e.kind,p=e.result;if(O(u=e.input.charCodeAt(e.position))||_(u)||35===u||38===u||42===u||33===u||124===u||62===u||39===u||34===u||37===u||64===u||96===u)return!1;if((63===u||45===u)&&(O(r=e.input.charCodeAt(e.position+1))||n&&_(r)))return!1;for(e.kind="scalar",e.result="",o=i=e.position,a=!1;0!==u;){if(58===u){if(O(r=e.input.charCodeAt(e.position+1))||n&&_(r))break}else if(35===u){if(O(e.input.charCodeAt(e.position-1)))break}else{if(e.position===e.lineStart&&$(e)||n&&_(u))break;if(k(u)){if(s=e.line,l=e.lineStart,c=e.lineIndent,B(e,!1,-1),e.lineIndent>=t){a=!0,u=e.input.charCodeAt(e.position);continue}e.position=i,e.line=s,e.lineStart=l,e.lineIndent=c;break}}a&&(D(e,o,i,!1),q(e,e.line-s),o=i=e.position,a=!1),E(u)||(i=e.position+1),u=e.input.charCodeAt(++e.position)}return D(e,o,i,!1),!!e.result||(e.kind=f,e.result=p,!1)}(e,w,c===n)&&(P=!0,null===e.tag&&(e.tag="?")):(P=!0,null===e.tag&&null===e.anchor||N(e,"alias node should not have any properties")),null!==e.anchor&&(e.anchorMap[e.anchor]=e.result)):0===T&&(P=g&&W(e,x))),null!==e.tag&&"!"!==e.tag)if("?"===e.tag){for(y=0,v=e.implicitTypes.length;y<v;y+=1)if((b=e.implicitTypes[y]).resolve(e.result)){e.result=b.construct(e.result),e.tag=b.tag,null!==e.anchor&&(e.anchorMap[e.anchor]=e.result);break}}else l.call(e.typeMap[e.kind||"fallback"],e.tag)?(b=e.typeMap[e.kind||"fallback"][e.tag],null!==e.result&&b.kind!==e.kind&&N(e,"unacceptable node kind for !<"+e.tag+'> tag; it should be "'+b.kind+'", not "'+e.kind+'"'),b.resolve(e.result)?(e.result=b.construct(e.result),null!==e.anchor&&(e.anchorMap[e.anchor]=e.result)):N(e,"cannot resolve a node with !<"+e.tag+"> explicit tag")):N(e,"unknown tag !<"+e.tag+">");return null!==e.listener&&e.listener("close",e),null!==e.tag||null!==e.anchor||P}function G(e){var t,n,r,o,i=e.position,a=!1;for(e.version=null,e.checkLineBreaks=e.legacy,e.tagMap={},e.anchorMap={};0!==(o=e.input.charCodeAt(e.position))&&(B(e,!0,-1),o=e.input.charCodeAt(e.position),!(e.lineIndent>0||37!==o));){for(a=!0,o=e.input.charCodeAt(++e.position),t=e.position;0!==o&&!O(o);)o=e.input.charCodeAt(++e.position);for(r=[],(n=e.input.slice(t,e.position)).length<1&&N(e,"directive name must not be less than one character in length");0!==o;){for(;E(o);)o=e.input.charCodeAt(++e.position);if(35===o){do{o=e.input.charCodeAt(++e.position)}while(0!==o&&!k(o));break}if(k(o))break;for(t=e.position;0!==o&&!O(o);)o=e.input.charCodeAt(++e.position);r.push(e.input.slice(t,e.position))}0!==o&&z(e),l.call(M,n)?M[n](e,n,r):L(e,'unknown document directive "'+n+'"')}B(e,!0,-1),0===e.lineIndent&&45===e.input.charCodeAt(e.position)&&45===e.input.charCodeAt(e.position+1)&&45===e.input.charCodeAt(e.position+2)?(e.position+=3,B(e,!0,-1)):a&&N(e,"directives end mark is expected"),Y(e,e.lineIndent-1,p,!1,!0),B(e,!0,-1),e.checkLineBreaks&&y.test(e.input.slice(i,e.position))&&L(e,"non-ASCII line breaks are interpreted as content"),e.documents.push(e.result),e.position===e.lineStart&&$(e)?46===e.input.charCodeAt(e.position)&&(e.position+=3,B(e,!0,-1)):e.position<e.length-1&&N(e,"end of the stream or a document separator is expected")}function Q(e,t){t=t||{},0!==(e=String(e)).length&&(10!==e.charCodeAt(e.length-1)&&13!==e.charCodeAt(e.length-1)&&(e+="\n"),65279===e.charCodeAt(0)&&(e=e.slice(1)));var n=new P(e,t);for(n.input+="\0";32===n.input.charCodeAt(n.position);)n.lineIndent+=1,n.position+=1;for(;n.position<n.length-1;)G(n);return n.documents}function X(e,t,n){var r,o,i=Q(e,n);if("function"!=typeof t)return i;for(r=0,o=i.length;r<o;r+=1)t(i[r])}function K(e,t){var n=Q(e,t);if(0!==n.length){if(1===n.length)return n[0];throw new o("expected a single document in the stream, but found more")}}e.exports.loadAll=X,e.exports.load=K,e.exports.safeLoadAll=function(e,t,n){if("function"!=typeof t)return X(e,r.extend({schema:a},n));X(e,t,r.extend({schema:a},n))},e.exports.safeLoad=function(e,t){return K(e,r.extend({schema:a},t))}},function(e,t,n){"use strict";var r=n(46);function o(e,t,n,r,o){this.name=e,this.buffer=t,this.position=n,this.line=r,this.column=o}o.prototype.getSnippet=function(e,t){var n,o,i,a,s;if(!this.buffer)return null;for(e=e||4,t=t||75,n="",o=this.position;o>0&&-1==="\0\r\n
\u2028\u2029".indexOf(this.buffer.charAt(o-1));)if(o-=1,this.position-o>t/2-1){n=" ... ",o+=5;break}for(i="",a=this.position;a<this.buffer.length&&-1==="\0\r\n
\u2028\u2029".indexOf(this.buffer.charAt(a));)if((a+=1)-this.position>t/2-1){i=" ... ",a-=5;break}return s=this.buffer.slice(o,a),r.repeat(" ",e)+n+s+i+"\n"+r.repeat(" ",e+this.position-o+n.length)+"^"},o.prototype.toString=function(e){var t,n="";return this.name&&(n+='in "'+this.name+'" '),n+="at line "+(this.line+1)+", column "+(this.column+1),e||(t=this.getSnippet())&&(n+=":\n"+t),n},e.exports=o},function(e,t,n){"use strict";var r=n(5);e.exports=new r("tag:yaml.org,2002:str",{kind:"scalar",construct:function(e){return null!==e?e:""}})},function(e,t,n){"use strict";var r=n(5);e.exports=new r("tag:yaml.org,2002:seq",{kind:"sequence",construct:function(e){return null!==e?e:[]}})},function(e,t,n){"use strict";var r=n(5);e.exports=new r("tag:yaml.org,2002:map",{kind:"mapping",construct:function(e){return null!==e?e:{}}})},function(e,t,n){"use strict";var r=n(5);e.exports=new r("tag:yaml.org,2002:null",{kind:"scalar",resolve:function(e){if(null===e)return!0;var t=e.length;return 1===t&&"~"===e||4===t&&("null"===e||"Null"===e||"NULL"===e)},construct:function(){return null},predicate:function(e){return null===e},represent:{canonical:function(){return"~"},lowercase:function(){return"null"},uppercase:function(){return"NULL"},camelcase:function(){return"Null"}},defaultStyle:"lowercase"})},function(e,t,n){"use strict";var r=n(5);e.exports=new r("tag:yaml.org,2002:bool",{kind:"scalar",resolve:function(e){if(null===e)return!1;var t=e.length;return 4===t&&("true"===e||"True"===e||"TRUE"===e)||5===t&&("false"===e||"False"===e||"FALSE"===e)},construct:function(e){return"true"===e||"True"===e||"TRUE"===e},predicate:function(e){return"[object Boolean]"===Object.prototype.toString.call(e)},represent:{lowercase:function(e){return e?"true":"false"},uppercase:function(e){return e?"TRUE":"FALSE"},camelcase:function(e){return e?"True":"False"}},defaultStyle:"lowercase"})},function(e,t,n){"use strict";var r=n(46),o=n(5);function i(e){return 48<=e&&e<=55}function a(e){return 48<=e&&e<=57}e.exports=new o("tag:yaml.org,2002:int",{kind:"scalar",resolve:function(e){if(null===e)return!1;var t,n,r=e.length,o=0,s=!1;if(!r)return!1;if("-"!==(t=e[o])&&"+"!==t||(t=e[++o]),"0"===t){if(o+1===r)return!0;if("b"===(t=e[++o])){for(o++;o<r;o++)if("_"!==(t=e[o])){if("0"!==t&&"1"!==t)return!1;s=!0}return s&&"_"!==t}if("x"===t){for(o++;o<r;o++)if("_"!==(t=e[o])){if(!(48<=(n=e.charCodeAt(o))&&n<=57||65<=n&&n<=70||97<=n&&n<=102))return!1;s=!0}return s&&"_"!==t}for(;o<r;o++)if("_"!==(t=e[o])){if(!i(e.charCodeAt(o)))return!1;s=!0}return s&&"_"!==t}if("_"===t)return!1;for(;o<r;o++)if("_"!==(t=e[o])){if(":"===t)break;if(!a(e.charCodeAt(o)))return!1;s=!0}return!(!s||"_"===t)&&(":"!==t||/^(:[0-5]?[0-9])+$/.test(e.slice(o)))},construct:function(e){var t,n,r=e,o=1,i=[];return-1!==r.indexOf("_")&&(r=r.replace(/_/g,"")),"-"!==(t=r[0])&&"+"!==t||("-"===t&&(o=-1),t=(r=r.slice(1))[0]),"0"===r?0:"0"===t?"b"===r[1]?o*parseInt(r.slice(2),2):"x"===r[1]?o*parseInt(r,16):o*parseInt(r,8):-1!==r.indexOf(":")?(r.split(":").forEach((function(e){i.unshift(parseInt(e,10))})),r=0,n=1,i.forEach((function(e){r+=e*n,n*=60})),o*r):o*parseInt(r,10)},predicate:function(e){return"[object Number]"===Object.prototype.toString.call(e)&&e%1==0&&!r.isNegativeZero(e)},represent:{binary:function(e){return e>=0?"0b"+e.toString(2):"-0b"+e.toString(2).slice(1)},octal:function(e){return e>=0?"0"+e.toString(8):"-0"+e.toString(8).slice(1)},decimal:function(e){return e.toString(10)},hexadecimal:function(e){return e>=0?"0x"+e.toString(16).toUpperCase():"-0x"+e.toString(16).toUpperCase().slice(1)}},defaultStyle:"decimal",styleAliases:{binary:[2,"bin"],octal:[8,"oct"],decimal:[10,"dec"],hexadecimal:[16,"hex"]}})},function(e,t,n){"use strict";var r=n(46),o=n(5),i=new RegExp("^(?:[-+]?(?:0|[1-9][0-9_]*)(?:\\.[0-9_]*)?(?:[eE][-+]?[0-9]+)?|\\.[0-9_]+(?:[eE][-+]?[0-9]+)?|[-+]?[0-9][0-9_]*(?::[0-5]?[0-9])+\\.[0-9_]*|[-+]?\\.(?:inf|Inf|INF)|\\.(?:nan|NaN|NAN))$");var a=/^[-+]?[0-9]+e/;e.exports=new o("tag:yaml.org,2002:float",{kind:"scalar",resolve:function(e){return null!==e&&!(!i.test(e)||"_"===e[e.length-1])},construct:function(e){var t,n,r,o;return n="-"===(t=e.replace(/_/g,"").toLowerCase())[0]?-1:1,o=[],"+-".indexOf(t[0])>=0&&(t=t.slice(1)),".inf"===t?1===n?Number.POSITIVE_INFINITY:Number.NEGATIVE_INFINITY:".nan"===t?NaN:t.indexOf(":")>=0?(t.split(":").forEach((function(e){o.unshift(parseFloat(e,10))})),t=0,r=1,o.forEach((function(e){t+=e*r,r*=60})),n*t):n*parseFloat(t,10)},predicate:function(e){return"[object Number]"===Object.prototype.toString.call(e)&&(e%1!=0||r.isNegativeZero(e))},represent:function(e,t){var n;if(isNaN(e))switch(t){case"lowercase":return".nan";case"uppercase":return".NAN";case"camelcase":return".NaN"}else if(Number.POSITIVE_INFINITY===e)switch(t){case"lowercase":return".inf";case"uppercase":return".INF";case"camelcase":return".Inf"}else if(Number.NEGATIVE_INFINITY===e)switch(t){case"lowercase":return"-.inf";case"uppercase":return"-.INF";case"camelcase":return"-.Inf"}else if(r.isNegativeZero(e))return"-0.0";return n=e.toString(10),a.test(n)?n.replace("e",".e"):n},defaultStyle:"lowercase"})},function(e,t,n){"use strict";var r=n(5),o=new RegExp("^([0-9][0-9][0-9][0-9])-([0-9][0-9])-([0-9][0-9])$"),i=new RegExp("^([0-9][0-9][0-9][0-9])-([0-9][0-9]?)-([0-9][0-9]?)(?:[Tt]|[ \\t]+)([0-9][0-9]?):([0-9][0-9]):([0-9][0-9])(?:\\.([0-9]*))?(?:[ \\t]*(Z|([-+])([0-9][0-9]?)(?::([0-9][0-9]))?))?$");e.exports=new r("tag:yaml.org,2002:timestamp",{kind:"scalar",resolve:function(e){return null!==e&&(null!==o.exec(e)||null!==i.exec(e))},construct:function(e){var t,n,r,a,s,l,c,u,f=0,p=null;if(null===(t=o.exec(e))&&(t=i.exec(e)),null===t)throw new Error("Date resolve error");if(n=+t[1],r=+t[2]-1,a=+t[3],!t[4])return new Date(Date.UTC(n,r,a));if(s=+t[4],l=+t[5],c=+t[6],t[7]){for(f=t[7].slice(0,3);f.length<3;)f+="0";f=+f}return t[9]&&(p=6e4*(60*+t[10]+ +(t[11]||0)),"-"===t[9]&&(p=-p)),u=new Date(Date.UTC(n,r,a,s,l,c,f)),p&&u.setTime(u.getTime()-p),u},instanceOf:Date,represent:function(e){return e.toISOString()}})},function(e,t,n){"use strict";var r=n(5);e.exports=new r("tag:yaml.org,2002:merge",{kind:"scalar",resolve:function(e){return"<<"===e||null===e}})},function(e,t,n){"use strict";var r;try{r=n(11).Buffer}catch(e){}var o=n(5),i="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=\n\r";e.exports=new o("tag:yaml.org,2002:binary",{kind:"scalar",resolve:function(e){if(null===e)return!1;var t,n,r=0,o=e.length,a=i;for(n=0;n<o;n++)if(!((t=a.indexOf(e.charAt(n)))>64)){if(t<0)return!1;r+=6}return r%8==0},construct:function(e){var t,n,o=e.replace(/[\r\n=]/g,""),a=o.length,s=i,l=0,c=[];for(t=0;t<a;t++)t%4==0&&t&&(c.push(l>>16&255),c.push(l>>8&255),c.push(255&l)),l=l<<6|s.indexOf(o.charAt(t));return 0===(n=a%4*6)?(c.push(l>>16&255),c.push(l>>8&255),c.push(255&l)):18===n?(c.push(l>>10&255),c.push(l>>2&255)):12===n&&c.push(l>>4&255),r?r.from?r.from(c):new r(c):c},predicate:function(e){return r&&r.isBuffer(e)},represent:function(e){var t,n,r="",o=0,a=e.length,s=i;for(t=0;t<a;t++)t%3==0&&t&&(r+=s[o>>18&63],r+=s[o>>12&63],r+=s[o>>6&63],r+=s[63&o]),o=(o<<8)+e[t];return 0===(n=a%3)?(r+=s[o>>18&63],r+=s[o>>12&63],r+=s[o>>6&63],r+=s[63&o]):2===n?(r+=s[o>>10&63],r+=s[o>>4&63],r+=s[o<<2&63],r+=s[64]):1===n&&(r+=s[o>>2&63],r+=s[o<<4&63],r+=s[64],r+=s[64]),r}})},function(e,t,n){"use strict";var r=n(5),o=Object.prototype.hasOwnProperty,i=Object.prototype.toString;e.exports=new r("tag:yaml.org,2002:omap",{kind:"sequence",resolve:function(e){if(null===e)return!0;var t,n,r,a,s,l=[],c=e;for(t=0,n=c.length;t<n;t+=1){if(r=c[t],s=!1,"[object Object]"!==i.call(r))return!1;for(a in r)if(o.call(r,a)){if(s)return!1;s=!0}if(!s)return!1;if(-1!==l.indexOf(a))return!1;l.push(a)}return!0},construct:function(e){return null!==e?e:[]}})},function(e,t,n){"use strict";var r=n(5),o=Object.prototype.toString;e.exports=new r("tag:yaml.org,2002:pairs",{kind:"sequence",resolve:function(e){if(null===e)return!0;var t,n,r,i,a,s=e;for(a=new Array(s.length),t=0,n=s.length;t<n;t+=1){if(r=s[t],"[object Object]"!==o.call(r))return!1;if(1!==(i=Object.keys(r)).length)return!1;a[t]=[i[0],r[i[0]]]}return!0},construct:function(e){if(null===e)return[];var t,n,r,o,i,a=e;for(i=new Array(a.length),t=0,n=a.length;t<n;t+=1)r=a[t],o=Object.keys(r),i[t]=[o[0],r[o[0]]];return i}})},function(e,t,n){"use strict";var r=n(5),o=Object.prototype.hasOwnProperty;e.exports=new r("tag:yaml.org,2002:set",{kind:"mapping",resolve:function(e){if(null===e)return!0;var t,n=e;for(t in n)if(o.call(n,t)&&null!==n[t])return!1;return!0},construct:function(e){return null!==e?e:{}}})},function(e,t,n){"use strict";var r=n(5);e.exports=new r("tag:yaml.org,2002:js/undefined",{kind:"scalar",resolve:function(){return!0},construct:function(){},predicate:function(e){return void 0===e},represent:function(){return""}})},function(e,t,n){"use strict";var r=n(5);e.exports=new r("tag:yaml.org,2002:js/regexp",{kind:"scalar",resolve:function(e){if(null===e)return!1;if(0===e.length)return!1;var t=e,n=/\/([gim]*)$/.exec(e),r="";if("/"===t[0]){if(n&&(r=n[1]),r.length>3)return!1;if("/"!==t[t.length-r.length-1])return!1}return!0},construct:function(e){var t=e,n=/\/([gim]*)$/.exec(e),r="";return"/"===t[0]&&(n&&(r=n[1]),t=t.slice(1,t.length-r.length-1)),new RegExp(t,r)},predicate:function(e){return"[object RegExp]"===Object.prototype.toString.call(e)},represent:function(e){var t="/"+e.source+"/";return e.global&&(t+="g"),e.multiline&&(t+="m"),e.ignoreCase&&(t+="i"),t}})},function(e,t,n){"use strict";var r;try{r=n(259)}catch(e){"undefined"!=typeof window&&(r=window.esprima)}var o=n(5);e.exports=new o("tag:yaml.org,2002:js/function",{kind:"scalar",resolve:function(e){if(null===e)return!1;try{var t="("+e+")",n=r.parse(t,{range:!0});return"Program"===n.type&&1===n.body.length&&"ExpressionStatement"===n.body[0].type&&("ArrowFunctionExpression"===n.body[0].expression.type||"FunctionExpression"===n.body[0].expression.type)}catch(e){return!1}},construct:function(e){var t,n="("+e+")",o=r.parse(n,{range:!0}),i=[];if("Program"!==o.type||1!==o.body.length||"ExpressionStatement"!==o.body[0].type||"ArrowFunctionExpression"!==o.body[0].expression.type&&"FunctionExpression"!==o.body[0].expression.type)throw new Error("Failed to resolve function");return o.body[0].expression.params.forEach((function(e){i.push(e.name)})),t=o.body[0].expression.body.range,"BlockStatement"===o.body[0].expression.body.type?new Function(i,n.slice(t[0]+1,t[1]-1)):new Function(i,"return "+n.slice(t[0],t[1]))},predicate:function(e){return"[object Function]"===Object.prototype.toString.call(e)},represent:function(e){return e.toString()}})},function(e,n){if(void 0===t){var r=new Error("Cannot find module 'esprima'");throw r.code="MODULE_NOT_FOUND",r}e.exports=t},function(e,t){e.exports=function(){}},function(e,t){e.exports=function(e){var t=Array.prototype.slice.call(arguments,1);return t.length&&(e=e.replace(/(%?)(%([jds]))/g,(function(e,n,r,o){var i=t.shift();switch(o){case"s":i=""+i;break;case"d":i=Number(i);break;case"j":i=JSON.stringify(i)}return n?(t.unshift(i),e):i}))),t.length&&(e+=" "+t.join(" ")),""+(e=e.replace(/%{2,2}/g,"%"))}},function(e,t,n){"use strict";(function(t){var n=/\.(txt|htm|html|md|xml|js|min|map|css|scss|less|svg)$/i;e.exports={order:300,allowEmpty:!0,encoding:"utf8",canParse:function(e){return("string"==typeof e.data||t.isBuffer(e.data))&&n.test(e.url)},parse:function(e){if("string"==typeof e.data)return e.data;if(t.isBuffer(e.data))return e.data.toString(this.encoding);throw new Error("data is not text")}}}).call(this,n(11).Buffer)},function(e,t,n){"use strict";(function(t){var n=/\.(jpeg|jpg|gif|png|bmp|ico)$/i;e.exports={order:400,allowEmpty:!0,canParse:function(e){return t.isBuffer(e.data)&&n.test(e.url)},parse:function(e){return t.isBuffer(e.data)?e.data:new t(e.data)}}}).call(this,n(11).Buffer)},function(e,t,n){"use strict";var r=n(265),o=n(28),i=n(24);e.exports={order:100,canRead:function(e){return i.isFileSystemPath(e.url)},read:function(e){return new Promise((function(t,n){var a;try{a=i.toFileSystemPath(e.url)}catch(t){n(o.uri(t,"Malformed URI: %s",e.url))}try{r.readFile(a,(function(e,r){e?n(o(e,'Error opening file "%s"',a)):t(r)}))}catch(e){n(o(e,'Error opening file "%s"',a))}}))}}},function(e,t){},function(e,t,n){"use strict";(function(t,r){var o=n(87),i=n(279),a=n(28),s=n(24);e.exports={order:200,headers:null,timeout:5e3,redirects:5,withCredentials:!1,canRead:function(e){return s.isHttp(e.url)},read:function(e){var n=s.parse(e.url);return t.browser&&!n.protocol&&(n.protocol=s.parse(location.href).protocol),function e(t,n,l){return new Promise((function(c,u){t=s.parse(t),(l=l||[]).push(t.href),function(e,t){return new Promise((function(n,a){var s=("https:"===e.protocol?i:o).get({hostname:e.hostname,port:e.port,path:e.path,auth:e.auth,protocol:e.protocol,headers:t.headers||{},withCredentials:t.withCredentials});"function"==typeof s.setTimeout&&s.setTimeout(t.timeout),s.on("timeout",(function(){s.abort()})),s.on("error",a),s.once("response",(function(e){e.body=new r(0),e.on("data",(function(t){e.body=r.concat([e.body,new r(t)])})),e.on("error",a),e.on("end",(function(){n(e)}))}))}))}(t,n).then((function(o){if(o.statusCode>=400)throw a({status:o.statusCode},"HTTP ERROR %d",o.statusCode);if(o.statusCode>=300)if(l.length>n.redirects)u(a({status:o.statusCode},"Error downloading %s. \nToo many redirects: \n %s",l[0],l.join(" \n ")));else{if(!o.headers.location)throw a({status:o.statusCode},"HTTP %d redirect with no location header",o.statusCode);var i=s.resolve(t,o.headers.location);e(i,n,l).then(c,u)}else c(o.body||new r(0))})).catch((function(e){u(a(e,"Error downloading",t.href))}))}))}(n,this)}}}).call(this,n(13),n(11).Buffer)},function(e,t,n){(function(t,r,o){var i=n(133),a=n(29),s=n(134),l=n(135),c=n(276),u=s.IncomingMessage,f=s.readyStates;var p=e.exports=function(e){var n,r=this;l.Writable.call(r),r._opts=e,r._body=[],r._headers={},e.auth&&r.setHeader("Authorization","Basic "+new t(e.auth).toString("base64")),Object.keys(e.headers).forEach((function(t){r.setHeader(t,e.headers[t])}));var o=!0;if("disable-fetch"===e.mode||"requestTimeout"in e&&!i.abortController)o=!1,n=!0;else if("prefer-streaming"===e.mode)n=!1;else if("allow-wrong-content-type"===e.mode)n=!i.overrideMimeType;else{if(e.mode&&"default"!==e.mode&&"prefer-fast"!==e.mode)throw new Error("Invalid value for opts.mode");n=!0}r._mode=function(e,t){return i.fetch&&t?"fetch":i.mozchunkedarraybuffer?"moz-chunked-arraybuffer":i.msstream?"ms-stream":i.arraybuffer&&e?"arraybuffer":i.vbArray&&e?"text:vbarray":"text"}(n,o),r._fetchTimer=null,r.on("finish",(function(){r._onFinish()}))};a(p,l.Writable),p.prototype.setHeader=function(e,t){var n=e.toLowerCase();-1===d.indexOf(n)&&(this._headers[n]={name:e,value:t})},p.prototype.getHeader=function(e){var t=this._headers[e.toLowerCase()];return t?t.value:null},p.prototype.removeHeader=function(e){delete this._headers[e.toLowerCase()]},p.prototype._onFinish=function(){var e=this;if(!e._destroyed){var n=e._opts,a=e._headers,s=null;"GET"!==n.method&&"HEAD"!==n.method&&(s=i.arraybuffer?c(t.concat(e._body)):i.blobConstructor?new r.Blob(e._body.map((function(e){return c(e)})),{type:(a["content-type"]||{}).value||""}):t.concat(e._body).toString());var l=[];if(Object.keys(a).forEach((function(e){var t=a[e].name,n=a[e].value;Array.isArray(n)?n.forEach((function(e){l.push([t,e])})):l.push([t,n])})),"fetch"===e._mode){var u=null;if(i.abortController){var p=new AbortController;u=p.signal,e._fetchAbortController=p,"requestTimeout"in n&&0!==n.requestTimeout&&(e._fetchTimer=r.setTimeout((function(){e.emit("requestTimeout"),e._fetchAbortController&&e._fetchAbortController.abort()}),n.requestTimeout))}r.fetch(e._opts.url,{method:e._opts.method,headers:l,body:s||void 0,mode:"cors",credentials:n.withCredentials?"include":"same-origin",signal:u}).then((function(t){e._fetchResponse=t,e._connect()}),(function(t){r.clearTimeout(e._fetchTimer),e._destroyed||e.emit("error",t)}))}else{var d=e._xhr=new r.XMLHttpRequest;try{d.open(e._opts.method,e._opts.url,!0)}catch(t){return void o.nextTick((function(){e.emit("error",t)}))}"responseType"in d&&(d.responseType=e._mode.split(":")[0]),"withCredentials"in d&&(d.withCredentials=!!n.withCredentials),"text"===e._mode&&"overrideMimeType"in d&&d.overrideMimeType("text/plain; charset=x-user-defined"),"requestTimeout"in n&&(d.timeout=n.requestTimeout,d.ontimeout=function(){e.emit("requestTimeout")}),l.forEach((function(e){d.setRequestHeader(e[0],e[1])})),e._response=null,d.onreadystatechange=function(){switch(d.readyState){case f.LOADING:case f.DONE:e._onXHRProgress()}},"moz-chunked-arraybuffer"===e._mode&&(d.onprogress=function(){e._onXHRProgress()}),d.onerror=function(){e._destroyed||e.emit("error",new Error("XHR error"))};try{d.send(s)}catch(t){return void o.nextTick((function(){e.emit("error",t)}))}}}},p.prototype._onXHRProgress=function(){(function(e){try{var t=e.status;return null!==t&&0!==t}catch(e){return!1}})(this._xhr)&&!this._destroyed&&(this._response||this._connect(),this._response._onXHRProgress())},p.prototype._connect=function(){var e=this;e._destroyed||(e._response=new u(e._xhr,e._fetchResponse,e._mode,e._fetchTimer),e._response.on("error",(function(t){e.emit("error",t)})),e.emit("response",e._response))},p.prototype._write=function(e,t,n){this._body.push(e),n()},p.prototype.abort=p.prototype.destroy=function(){this._destroyed=!0,r.clearTimeout(this._fetchTimer),this._response&&(this._response._destroyed=!0),this._xhr?this._xhr.abort():this._fetchAbortController&&this._fetchAbortController.abort()},p.prototype.end=function(e,t,n){"function"==typeof e&&(n=e,e=void 0),l.Writable.prototype.end.call(this,e,t,n)},p.prototype.flushHeaders=function(){},p.prototype.setTimeout=function(){},p.prototype.setNoDelay=function(){},p.prototype.setSocketKeepAlive=function(){};var d=["accept-charset","accept-encoding","access-control-request-headers","access-control-request-method","connection","content-length","cookie","cookie2","date","dnt","expect","host","keep-alive","origin","referer","te","trailer","transfer-encoding","upgrade","via"]}).call(this,n(11).Buffer,n(6),n(13))},function(e,t){},function(e,t,n){"use strict";var r=n(88).Buffer,o=n(270);e.exports=function(){function e(){!function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}(this,e),this.head=null,this.tail=null,this.length=0}return e.prototype.push=function(e){var t={data:e,next:null};this.length>0?this.tail.next=t:this.head=t,this.tail=t,++this.length},e.prototype.unshift=function(e){var t={data:e,next:this.head};0===this.length&&(this.tail=t),this.head=t,++this.length},e.prototype.shift=function(){if(0!==this.length){var e=this.head.data;return 1===this.length?this.head=this.tail=null:this.head=this.head.next,--this.length,e}},e.prototype.clear=function(){this.head=this.tail=null,this.length=0},e.prototype.join=function(e){if(0===this.length)return"";for(var t=this.head,n=""+t.data;t=t.next;)n+=e+t.data;return n},e.prototype.concat=function(e){if(0===this.length)return r.alloc(0);if(1===this.length)return this.head.data;for(var t,n,o,i=r.allocUnsafe(e>>>0),a=this.head,s=0;a;)t=a.data,n=i,o=s,t.copy(n,o),s+=a.data.length,a=a.next;return i},e}(),o&&o.inspect&&o.inspect.custom&&(e.exports.prototype[o.inspect.custom]=function(){var e=o.inspect({length:this.length});return this.constructor.name+" "+e})},function(e,t){},function(e,t,n){(function(e){var r=void 0!==e&&e||"undefined"!=typeof self&&self||window,o=Function.prototype.apply;function i(e,t){this._id=e,this._clearFn=t}t.setTimeout=function(){return new i(o.call(setTimeout,r,arguments),clearTimeout)},t.setInterval=function(){return new i(o.call(setInterval,r,arguments),clearInterval)},t.clearTimeout=t.clearInterval=function(e){e&&e.close()},i.prototype.unref=i.prototype.ref=function(){},i.prototype.close=function(){this._clearFn.call(r,this._id)},t.enroll=function(e,t){clearTimeout(e._idleTimeoutId),e._idleTimeout=t},t.unenroll=function(e){clearTimeout(e._idleTimeoutId),e._idleTimeout=-1},t._unrefActive=t.active=function(e){clearTimeout(e._idleTimeoutId);var t=e._idleTimeout;t>=0&&(e._idleTimeoutId=setTimeout((function(){e._onTimeout&&e._onTimeout()}),t))},n(272),t.setImmediate="undefined"!=typeof self&&self.setImmediate||void 0!==e&&e.setImmediate||this&&this.setImmediate,t.clearImmediate="undefined"!=typeof self&&self.clearImmediate||void 0!==e&&e.clearImmediate||this&&this.clearImmediate}).call(this,n(6))},function(e,t,n){(function(e,t){!function(e,n){"use strict";if(!e.setImmediate){var r,o,i,a,s,l=1,c={},u=!1,f=e.document,p=Object.getPrototypeOf&&Object.getPrototypeOf(e);p=p&&p.setTimeout?p:e,"[object process]"==={}.toString.call(e.process)?r=function(e){t.nextTick((function(){h(e)}))}:!function(){if(e.postMessage&&!e.importScripts){var t=!0,n=e.onmessage;return e.onmessage=function(){t=!1},e.postMessage("","*"),e.onmessage=n,t}}()?e.MessageChannel?((i=new MessageChannel).port1.onmessage=function(e){h(e.data)},r=function(e){i.port2.postMessage(e)}):f&&"onreadystatechange"in f.createElement("script")?(o=f.documentElement,r=function(e){var t=f.createElement("script");t.onreadystatechange=function(){h(e),t.onreadystatechange=null,o.removeChild(t),t=null},o.appendChild(t)}):r=function(e){setTimeout(h,0,e)}:(a="setImmediate$"+Math.random()+"$",s=function(t){t.source===e&&"string"==typeof t.data&&0===t.data.indexOf(a)&&h(+t.data.slice(a.length))},e.addEventListener?e.addEventListener("message",s,!1):e.attachEvent("onmessage",s),r=function(t){e.postMessage(a+t,"*")}),p.setImmediate=function(e){"function"!=typeof e&&(e=new Function(""+e));for(var t=new Array(arguments.length-1),n=0;n<t.length;n++)t[n]=arguments[n+1];var o={callback:e,args:t};return c[l]=o,r(l),l++},p.clearImmediate=d}function d(e){delete c[e]}function h(e){if(u)setTimeout(h,0,e);else{var t=c[e];if(t){u=!0;try{!function(e){var t=e.callback,r=e.args;switch(r.length){case 0:t();break;case 1:t(r[0]);break;case 2:t(r[0],r[1]);break;case 3:t(r[0],r[1],r[2]);break;default:t.apply(n,r)}}(t)}finally{d(e),u=!1}}}}}("undefined"==typeof self?void 0===e?this:e:self)}).call(this,n(6),n(13))},function(e,t,n){(function(t){function n(e){try{if(!t.localStorage)return!1}catch(e){return!1}var n=t.localStorage[e];return null!=n&&"true"===String(n).toLowerCase()}e.exports=function(e,t){if(n("noDeprecation"))return e;var r=!1;return function(){if(!r){if(n("throwDeprecation"))throw new Error(t);n("traceDeprecation")?console.trace(t):console.warn(t),r=!0}return e.apply(this,arguments)}}}).call(this,n(6))},function(e,t,n){var r=n(11),o=r.Buffer;function i(e,t){for(var n in e)t[n]=e[n]}function a(e,t,n){return o(e,t,n)}o.from&&o.alloc&&o.allocUnsafe&&o.allocUnsafeSlow?e.exports=r:(i(r,t),t.Buffer=a),a.prototype=Object.create(o.prototype),i(o,a),a.from=function(e,t,n){if("number"==typeof e)throw new TypeError("Argument must not be a number");return o(e,t,n)},a.alloc=function(e,t,n){if("number"!=typeof e)throw new TypeError("Argument must be a number");var r=o(e);return void 0!==t?"string"==typeof n?r.fill(t,n):r.fill(t):r.fill(0),r},a.allocUnsafe=function(e){if("number"!=typeof e)throw new TypeError("Argument must be a number");return o(e)},a.allocUnsafeSlow=function(e){if("number"!=typeof e)throw new TypeError("Argument must be a number");return r.SlowBuffer(e)}},function(e,t,n){"use strict";e.exports=i;var r=n(142),o=n(47);function i(e){if(!(this instanceof i))return new i(e);r.call(this,e)}o.inherits=n(29),o.inherits(i,r),i.prototype._transform=function(e,t,n){n(null,e)}},function(e,t,n){var r=n(11).Buffer;e.exports=function(e){if(e instanceof Uint8Array){if(0===e.byteOffset&&e.byteLength===e.buffer.byteLength)return e.buffer;if("function"==typeof e.buffer.slice)return e.buffer.slice(e.byteOffset,e.byteOffset+e.byteLength)}if(r.isBuffer(e)){for(var t=new Uint8Array(e.length),n=e.length,o=0;o<n;o++)t[o]=e[o];return t.buffer}throw new Error("Argument must be a Buffer")}},function(e,t){e.exports=function(){for(var e={},t=0;t<arguments.length;t++){var r=arguments[t];for(var o in r)n.call(r,o)&&(e[o]=r[o])}return e};var n=Object.prototype.hasOwnProperty},function(e,t){e.exports={100:"Continue",101:"Switching Protocols",102:"Processing",200:"OK",201:"Created",202:"Accepted",203:"Non-Authoritative Information",204:"No Content",205:"Reset Content",206:"Partial Content",207:"Multi-Status",208:"Already Reported",226:"IM Used",300:"Multiple Choices",301:"Moved Permanently",302:"Found",303:"See Other",304:"Not Modified",305:"Use Proxy",307:"Temporary Redirect",308:"Permanent Redirect",400:"Bad Request",401:"Unauthorized",402:"Payment Required",403:"Forbidden",404:"Not Found",405:"Method Not Allowed",406:"Not Acceptable",407:"Proxy Authentication Required",408:"Request Timeout",409:"Conflict",410:"Gone",411:"Length Required",412:"Precondition Failed",413:"Payload Too Large",414:"URI Too Long",415:"Unsupported Media Type",416:"Range Not Satisfiable",417:"Expectation Failed",418:"I'm a teapot",421:"Misdirected Request",422:"Unprocessable Entity",423:"Locked",424:"Failed Dependency",425:"Unordered Collection",426:"Upgrade Required",428:"Precondition Required",429:"Too Many Requests",431:"Request Header Fields Too Large",451:"Unavailable For Legal Reasons",500:"Internal Server Error",501:"Not Implemented",502:"Bad Gateway",503:"Service Unavailable",504:"Gateway Timeout",505:"HTTP Version Not Supported",506:"Variant Also Negotiates",507:"Insufficient Storage",508:"Loop Detected",509:"Bandwidth Limit Exceeded",510:"Not Extended",511:"Network Authentication Required"}},function(e,t,n){var r=n(87),o=n(8),i=e.exports;for(var a in r)r.hasOwnProperty(a)&&(i[a]=r[a]);function s(e){if("string"==typeof e&&(e=o.parse(e)),e.protocol||(e.protocol="https:"),"https:"!==e.protocol)throw new Error('Protocol "'+e.protocol+'" not supported. Expected "https:"');return e}i.request=function(e,t){return e=s(e),r.request.call(this,e,t)},i.get=function(e,t){return e=s(e),r.get.call(this,e,t)}},function(e,t,n){"use strict";var r=n(28),o=n(60),i=n(24);function a(){this.circular=!1,this._$refs={},this._root$Ref=null}function s(e,t){var n=Object.keys(e);return(t=Array.isArray(t[0])?t[0]:Array.prototype.slice.call(t)).length>0&&t[0]&&(n=n.filter((function(n){return-1!==t.indexOf(e[n].pathType)}))),n.map((function(t){return{encoded:t,decoded:"file"===e[t].pathType?i.toFileSystemPath(t,!0):t}}))}e.exports=a,a.prototype.paths=function(e){var t=s(this._$refs,arguments);return t.map((function(e){return e.decoded}))},a.prototype.values=function(e){var t=this._$refs,n=s(t,arguments);return n.reduce((function(e,n){return e[n.decoded]=t[n.encoded].value,e}),{})},a.prototype.toJSON=a.prototype.values,a.prototype.exists=function(e,t){try{return this._resolve(e,t),!0}catch(e){return!1}},a.prototype.get=function(e,t){return this._resolve(e,t).value},a.prototype.set=function(e,t){var n=i.resolve(this._root$Ref.path,e),o=i.stripHash(n),a=this._$refs[o];if(!a)throw r('Error resolving $ref pointer "%s". \n"%s" not found.',e,o);a.set(n,t)},a.prototype._add=function(e){var t=i.stripHash(e),n=new o;return n.path=t,n.$refs=this,this._$refs[t]=n,this._root$Ref=this._root$Ref||n,n},a.prototype._resolve=function(e,t){var n=i.resolve(this._root$Ref.path,e),o=i.stripHash(n),a=this._$refs[o];if(!a)throw r('Error resolving $ref pointer "%s". \n"%s" not found.',e,o);return a.resolve(n,t,e)},a.prototype._get$Ref=function(e){e=i.resolve(this._root$Ref.path,e);var t=i.stripHash(e);return this._$refs[t]}},function(e,t,n){"use strict";function r(e,t,n,r){var o=e[t];if("function"==typeof o)return o.apply(e,[n,r]);if(!r){if(o instanceof RegExp)return o.test(n.url);if("string"==typeof o)return o===n.extension;if(Array.isArray(o))return-1!==o.indexOf(n.extension)}return o}t.all=function(e){return Object.keys(e).filter((function(t){return"object"==typeof e[t]})).map((function(t){return e[t].name=t,e[t]}))},t.filter=function(e,t,n){return e.filter((function(e){return!!r(e,t,n)}))},t.sort=function(e){return e.forEach((function(e){e.order=e.order||Number.MAX_SAFE_INTEGER})),e.sort((function(e,t){return e.order-t.order}))},t.run=function(e,t,n){var o,i,a=0;return new Promise((function(s,l){function c(){if(!(o=e[a++]))return l(i);try{var s=r(o,t,n,u);s&&"function"==typeof s.then?s.then(f,p):void 0!==s&&f(s)}catch(e){p(e)}}function u(e,t){e?p(e):f(t)}function f(e){s({plugin:o,result:e})}function p(e){i=e,c()}c()}))}},function(e,t,n){"use strict";var r=n(129);e.exports=function(e){var t,n,o,i;"function"==typeof(e=Array.prototype.slice.call(e))[e.length-1]&&(i=e.pop());"string"==typeof e[0]?(t=e[0],"object"==typeof e[2]?(n=e[1],o=e[2]):(n=void 0,o=e[1])):(t="",n=e[0],o=e[1]);o instanceof r||(o=new r(o));return{path:t,schema:n,options:o,callback:i}}},function(e,t,n){"use strict";var r=n(60),o=n(89),i=n(143),a=n(24);function s(e,t,n,i){var a=[];return e&&"object"==typeof e&&(r.isExternal$Ref(e)?a.push(l(e,t,n,i)):Object.keys(e).forEach((function(c){var u=o.join(t,c),f=e[c];r.isExternal$Ref(f)?a.push(l(f,u,n,i)):a=a.concat(s(f,u,n,i))}))),a}function l(e,t,n,r){var o=a.resolve(t,e.$ref),l=a.stripHash(o);return(e=n._$refs[l])?Promise.resolve(e.value):i(o,n,r).then((function(e){var t=s(e,l+"#",n,r);return Promise.all(t)}))}e.exports=function(e,t){if(!t.resolve.external)return Promise.resolve();try{var n=s(e.schema,e.$refs._root$Ref.path+"#",e.$refs,t);return Promise.all(n)}catch(e){return Promise.reject(e)}}},function(e,t,n){"use strict";var r=n(60),o=n(89),i=n(24);function a(e,t,n,i,l,c,u,f){var p=null===t?e:e[t];p&&"object"==typeof p&&(r.isAllowed$Ref(p)?s(e,t,n,i,l,c,u,f):Object.keys(p).sort((function(e,t){return"definitions"===e?-1:"definitions"===t?1:e.length-t.length})).forEach((function(e){var t=o.join(n,e),d=o.join(i,e),h=p[e];r.isAllowed$Ref(h)?s(p,e,n,d,l,c,u,f):a(p,e,t,d,l,c,u,f)})))}function s(e,t,n,s,l,c,u,f){var p=null===t?e:e[t],d=i.resolve(n,p.$ref),h=u._resolve(d,f),m=o.parse(s).length,g=i.stripHash(h.path),y=i.getHash(h.path),v=g!==u._root$Ref.path,b=r.isExtended$Ref(p);l+=h.indirections;var w=function(e,t,n){for(var r=0;r<e.length;r++){var o=e[r];if(o.parent===t&&o.key===n)return o}}(c,e,t);if(w){if(!(m<w.depth||l<w.indirections))return;!function(e,t){var n=e.indexOf(t);e.splice(n,1)}(c,w)}c.push({$ref:p,parent:e,key:t,pathFromRoot:s,depth:m,file:g,hash:y,value:h.value,circular:h.circular,extended:b,external:v,indirections:l}),a(h.value,null,h.path,s,l+1,c,u,f)}e.exports=function(e,t){var n=[];a(e,"schema",e.$refs._root$Ref.path+"#","#",0,n,e.$refs,t),function(e){var t,n,i;e.sort((function(e,t){if(e.file!==t.file)return e.file<t.file?-1:1;if(e.hash!==t.hash)return e.hash<t.hash?-1:1;if(e.circular!==t.circular)return e.circular?-1:1;if(e.extended!==t.extended)return e.extended?1:-1;if(e.indirections!==t.indirections)return e.indirections-t.indirections;if(e.depth!==t.depth)return e.depth-t.depth;var n=e.pathFromRoot.lastIndexOf("/definitions"),r=t.pathFromRoot.lastIndexOf("/definitions");return n!==r?r-n:e.pathFromRoot.length-t.pathFromRoot.length})),e.forEach((function(e){e.external?e.file===t&&e.hash===n?e.$ref.$ref=i:e.file===t&&0===e.hash.indexOf(n+"/")?e.$ref.$ref=o.join(i,o.parse(e.hash.replace(n,"#"))):(t=e.file,n=e.hash,i=e.pathFromRoot,e.$ref=e.parent[e.key]=r.dereference(e.$ref,e.value),e.circular&&(e.$ref.$ref=e.pathFromRoot)):e.$ref.$ref=e.hash}))}(n)}},function(e,t){e.exports=function(){}},function(e,t,n){"use strict";var r=n(1),o=n(145),i=n(49),a=n(8),s=n(48),l=n(48),c=n(61).jptr,u=n(91).recurse,f=n(62).clone,p=n(287).dereference,d=n(90).isRef,h=n(146);function m(e,t,n,r,o,i){for(var s=i.externalRefs[n+r].paths[0],l=a.parse(o),p={},m=1;m;)m=0,u(e,{identityDetection:!0},(function(e,n,r){if(d(e,n))if(e[n].startsWith("#"))if(p[e[n]]||e.$fixed){if(!e.$fixed){var u=(s+"/"+p[e[n]]).split("/#/").join("/");r.parent[r.pkey]={$ref:u,"x-miro":e[n],$fixed:!0},i.verbose>1&&console.warn("Replacing with",u),m++}}else{var g=f(c(t,e[n]));if(i.verbose>1&&console.warn((!1===g?h.colour.red:h.colour.green)+"Fragment resolution",e[n],h.colour.normal),!1===g){if(r.parent[r.pkey]={},i.fatal){var y=new Error("Fragment $ref resolution failed "+e[n]);if(!i.promise)throw y;i.promise.reject(y)}}else m++,r.parent[r.pkey]=g,p[e[n]]=r.path.replace("/%24ref","")}else if(l.protocol){u=a.resolve(o,e[n]).toString();i.verbose>1&&console.warn(h.colour.yellow+"Rewriting external url ref",e[n],"as",u,h.colour.normal),e["x-miro"]=e[n],e[n]=u}else if(!e["x-miro"]){u=a.resolve(o,e[n]).toString();i.verbose>1&&console.warn(h.colour.yellow+"Rewriting external ref",e[n],"as",u,h.colour.normal),e["x-miro"]=e[n],e[n]=u}}));return u(e,{},(function(e,t,n){d(e,t)&&void 0!==e.$fixed&&delete e.$fixed})),i.verbose>1&&console.warn("Finished fragment resolution"),e}function g(e,t){if(!t.filters||!t.filters.length)return e;for(var n=0,r=t.filters;n<r.length;n++){e=(0,r[n])(e,t)}return e}function y(e,t,n,r){var u=a.parse(n.source),p=n.source.split("\\").join("/").split("/");p.pop()||p.pop();var d="",h=t.split("#");h.length>1&&(d="#"+h[1],t=h[0]),p=p.join("/");var y,v,b,w,x,k=a.parse(t),E=(y=k.protocol,v=u.protocol,y&&y.length>2?y:v&&v.length>2?v:"file:");if(b="file:"===E?i.resolve(p?p+"/":"",t):a.resolve(p?p+"/":"",t),n.cache[b]){n.verbose&&console.warn("CACHED",b,d);var O=f(n.cache[b]),_=n.externalRef=O;if(d&&!1===(_=c(_,d))&&(_={},n.fatal)){var S=new Error("Cached $ref resolution failed "+b+d);if(!n.promise)throw S;n.promise.reject(S)}return _=g(_=m(_,O,t,d,b,n),n),r(f(_),b,n),Promise.resolve(_)}return n.verbose&&console.warn("GET",b,d),n.handlers&&n.handlers[E]?n.handlers[E](p,t,d,n).then((function(e){return n.externalRef=e,e=g(e,n),n.cache[b]=e,r(e,b,n),e})).catch((function(e){throw n.verbose&&console.warn(e),e})):E&&E.startsWith("http")?s(b,{agent:n.agent}).then((function(e){if(200!==e.status)throw new Error("Received status code "+e.status);return e.text()})).then((function(e){try{var o=l.parse(e,{schema:"core"});if(e=n.externalRef=o,n.cache[b]=f(e),d&&!1===(e=c(e,d))&&(e={},n.fatal)){var i=new Error("Remote $ref resolution failed "+b+d);if(!n.promise)throw i;n.promise.reject(i)}e=g(e=m(e,o,t,d,b,n),n)}catch(i){if(n.verbose&&console.warn(i),!n.promise||!n.fatal)throw i;n.promise.reject(i)}return r(e,b,n),e})).catch((function(e){if(n.verbose&&console.warn(e),n.cache[b]={},!n.promise||!n.fatal)throw e;n.promise.reject(e)})):(w=b,x=n.encoding||"utf8",new Promise((function(e,t){o.readFile(w,x,(function(n,r){n?t(n):e(r)}))}))).then((function(e){try{var o=l.parse(e,{schema:"core"});if(e=n.externalRef=o,n.cache[b]=f(e),d&&!1===(e=c(e,d))&&(e={},n.fatal)){var i=new Error("File $ref resolution failed "+b+d);if(!n.promise)throw i;n.promise.reject(i)}e=g(e=m(e,o,t,d,b,n),n)}catch(i){if(n.verbose&&console.warn(i),!n.promise||!n.fatal)throw i;n.promise.reject(i)}return r(e,b,n),e})).catch((function(e){if(n.verbose&&console.warn(e),!n.promise||!n.fatal)throw e;n.promise.reject(e)}))}function v(e){return new Promise((function(t,n){(function(e){return new Promise((function(t,n){function r(t,n,r){if(t[n]&&d(t[n],"$ref")){var i=t[n].$ref;if(!i.startsWith("#")){var a="";if(!o[i]){var s=Object.keys(o).find((function(e,t,n){return i.startsWith(e+"/")}));s&&(e.verbose&&console.warn("Found potential subschema at",s),a=(a="/"+(i.split("#")[1]||"").replace(s.split("#")[1]||"")).split("/undefined").join(""),i=s)}if(o[i]||(o[i]={resolved:!1,paths:[],extras:{},description:t[n].description}),o[i].resolved)if(e.rewriteRefs){var l=o[i].resolvedAt;e.verbose>1&&console.warn("Rewriting ref",i,l),t[n]["x-miro"]=i,t[n].$ref=l+a}else t[n]=f(o[i].data);else o[i].paths.push(r.path),o[i].extras[r.path]=a}}}var o=e.externalRefs;if(e.resolver.depth>0&&e.source===e.resolver.base)return t(o);u(e.openapi.definitions,{identityDetection:!0,path:"#/definitions"},r),u(e.openapi.components,{identityDetection:!0,path:"#/components"},r),u(e.openapi,{identityDetection:!0},r),t(o)}))})(e).then((function(t){var n=function(n){if(!t[n].resolved){var o=e.resolver.depth;o>0&&o++,e.resolver.actions[o].push((function(){return y(e.openapi,n,e,(function(e,o,i){if(!t[n].resolved){var a={};a.context=t[n],a.$ref=n,a.original=f(e),a.updated=e,a.source=o,i.externals.push(a),t[n].resolved=!0}var s=Object.assign({},i,{source:"",resolver:{actions:i.resolver.actions,depth:i.resolver.actions.length-1,base:i.resolver.base}});i.patch&&t[n].description&&!e.description&&"object"==typeof e&&(e.description=t[n].description),t[n].data=e;for(var l,u=(l=t[n].paths,r.__spreadArrays(new Set(l))),p=0,d=u=u.sort((function(e,t){var n=e.startsWith("#/components/")||e.startsWith("#/definitions/"),r=t.startsWith("#/components/")||t.startsWith("#/definitions/");return n&&!r?-1:r&&!n?1:0}));p<d.length;p++){var h=d[p];if(t[n].resolvedAt&&h!==t[n].resolvedAt&&h.indexOf("x-ms-examples/")<0)i.verbose>1&&console.warn("Creating pointer to data at",h),c(i.openapi,h,{$ref:t[n].resolvedAt+t[n].extras[h],"x-miro":n+t[n].extras[h]});else{t[n].resolvedAt?i.verbose>1&&console.warn("Avoiding circular reference"):(t[n].resolvedAt=h,i.verbose>1&&console.warn("Creating initial clone of data at",h));var m=f(e);c(i.openapi,h,m)}}0===i.resolver.actions[s.resolver.depth].length&&i.resolver.actions[s.resolver.depth].push((function(){return v(s)}))}))}))}};for(var o in t)n(o)})).catch((function(t){e.verbose&&console.warn(t),n(t)}));var o={options:e};o.actions=e.resolver.actions[e.resolver.depth],t(o)}))}var b=function(e){return e.reduce((function(e,t){return e.then((function(e){return t().then(Array.prototype.concat.bind(e))}))}),Promise.resolve([]))};function w(e,t,n){e.resolver.actions.push([]),v(e).then((function(r){b(r.actions).then((function(){if(e.resolver.depth>=e.resolver.actions.length)return console.warn("Ran off the end of resolver actions"),t(!0);e.resolver.depth++,e.resolver.actions[e.resolver.depth].length?setTimeout((function(){w(r.options,t,n)}),0):(e.verbose>1&&console.warn(h.colour.yellow+"Finished external resolution!",h.colour.normal),e.resolveInternal&&(e.verbose>1&&console.warn(h.colour.yellow+"Starting internal resolution!",h.colour.normal),e.openapi=p(e.openapi,e.original,{verbose:e.verbose-1}),e.verbose>1&&console.warn(h.colour.yellow+"Finished internal resolution!",h.colour.normal)),u(e.openapi,{},(function(t,n,r){d(t,n)&&(e.preserveMiro||delete t["x-miro"])})),t(e))})).catch((function(t){e.verbose&&console.warn(t),n(t)}))})).catch((function(t){e.verbose&&console.warn(t),n(t)}))}function x(e){if(e.cache||(e.cache={}),e.source){var t=a.parse(e.source);(!t.protocol||t.protocol.length<=2)&&(e.source=i.resolve(e.source))}e.externals||(e.externals=[]),e.externalRefs||(e.externalRefs=[]),e.rewriteRefs=!0,e.resolver={},e.resolver.depth=0,e.resolver.base=e.source,e.resolver.actions=[[]]}e.exports={optionalResolve:function(e){return x(e),new Promise((function(t,n){e.resolve?w(e,t,n):t(e)}))},resolve:function(e,t,n){return n||(n={}),n.openapi=e,n.source=t,n.resolve=!0,x(n),new Promise((function(e,t){w(n,e,t)}))}}},function(e,t,n){"use strict";var r=n(91).recurse,o=n(62).shallowClone,i=n(61).jptr,a=n(90).isRef,s=function(e){return e&&e.verbose?{warn:function(){var e=Array.prototype.slice.call(arguments);console.warn.apply(console,e)}}:{warn:function(){}}};e.exports={dereference:function e(t,n,l){l||(l={}),l.cache||(l.cache={}),l.state||(l.state={}),l.state.identityDetection=!0,l.depth=l.depth?l.depth+1:1;var c=l.depth>1?t:o(t),u={data:c},f=l.depth>1?n:o(n);l.master||(l.master=c);for(var p=s(l),d=1;d>0;)d=0,r(u,l.state,(function(t,n,r){if(a(t,n)){var o,s=t[n];if(d++,l.cache[s])if((o=l.cache[s]).resolved)p.warn("Patching %s for %s",s,o.path),r.parent[r.pkey]=o.data,l.$ref&&"object"==typeof r.parent[r.pkey]&&(r.parent[r.pkey][l.$ref]=s);else{if(s===o.path)throw new Error("Tight circle at "+o.path);p.warn("Unresolved ref"),r.parent[r.pkey]=i(o.source,o.path),!1===r.parent[r.pkey]&&(r.parent[r.pkey]=i(o.source,o.key)),l.$ref&&"object"==typeof r.parent[r.pkey]&&(r.parent[l.$ref]=s)}else(o={}).path=r.path.split("/$ref")[0],o.key=s,p.warn("Dereffing %s at %s",s,o.path),o.source=f,o.data=i(o.source,o.key),!1===o.data&&(o.data=i(l.master,o.key),o.source=l.master),!1===o.data&&p.warn("Missing $ref target",o.key),l.cache[s]=o,o.data=r.parent[r.pkey]=e(i(o.source,o.key),o.source,l),l.$ref&&"object"==typeof r.parent[r.pkey]&&(r.parent[r.pkey][l.$ref]=s),o.resolved=!0}}));return u.data}}},function(e,t,n){"use strict";function r(){return{depth:0,seen:new WeakMap,top:!0,combine:!1,allowRefSiblings:!1}}e.exports={getDefaultState:r,walkSchema:function e(t,n,o,i){if(void 0===o.depth&&(o=r()),null==t)return t;if(void 0!==t.$ref){var a={$ref:t.$ref};return o.allowRefSiblings&&t.description&&(a.description=t.description),i(a,n,o),a}if(o.combine&&(t.allOf&&Array.isArray(t.allOf)&&1===t.allOf.length&&delete(t=Object.assign({},t.allOf[0],t)).allOf,t.anyOf&&Array.isArray(t.anyOf)&&1===t.anyOf.length&&delete(t=Object.assign({},t.anyOf[0],t)).anyOf,t.oneOf&&Array.isArray(t.oneOf)&&1===t.oneOf.length&&delete(t=Object.assign({},t.oneOf[0],t)).oneOf),i(t,n,o),o.seen.has(t))return t;if("object"==typeof t&&null!==t&&o.seen.set(t,!0),o.top=!1,o.depth++,void 0!==t.items&&(o.property="items",e(t.items,t,o,i)),t.additionalItems&&"object"==typeof t.additionalItems&&(o.property="additionalItems",e(t.additionalItems,t,o,i)),t.additionalProperties&&"object"==typeof t.additionalProperties&&(o.property="additionalProperties",e(t.additionalProperties,t,o,i)),t.properties)for(var s in t.properties){var l=t.properties[s];o.property="properties/"+s,e(l,t,o,i)}if(t.patternProperties)for(var s in t.patternProperties){l=t.patternProperties[s];o.property="patternProperties/"+s,e(l,t,o,i)}if(t.allOf)for(var c in t.allOf){l=t.allOf[c];o.property="allOf/"+c,e(l,t,o,i)}if(t.anyOf)for(var c in t.anyOf){l=t.anyOf[c];o.property="anyOf/"+c,e(l,t,o,i)}if(t.oneOf)for(var c in t.oneOf){l=t.oneOf[c];o.property="oneOf/"+c,e(l,t,o,i)}return t.not&&(o.property="not",e(t.not,t,o,i)),o.depth--,t}}},function(e,t,n){"use strict";var r=n(87);e.exports={statusCodes:Object.assign({},{default:"Default response","1XX":"Informational",103:"Early hints","2XX":"Successful","3XX":"Redirection","4XX":"Client Error","5XX":"Server Error","7XX":"Developer Error"},r.STATUS_CODES)}},function(e){e.exports=JSON.parse('{"name":"swagger2openapi","version":"5.3.1","description":"Convert Swagger 2.0 definitions to OpenApi 3.0 and validate","main":"index.js","bin":{"swagger2openapi":"./swagger2openapi.js","oas-validate":"./oas-validate.js","boast":"./boast.js"},"scripts":{"test":"mocha"},"browserify":{"transform":[["babelify",{"presets":["es2015"]}]]},"repository":{"url":"https://github.com/Mermade/oas-kit.git","type":"git"},"bugs":{"url":"https://github.com/mermade/oas-kit/issues"},"author":"Mike Ralphson <mike.ralphson@gmail.com>","license":"BSD-3-Clause","dependencies":{"better-ajv-errors":"^0.6.1","call-me-maybe":"^1.0.1","node-fetch-h2":"^2.3.0","node-readfiles":"^0.2.0","oas-kit-common":"^1.0.7","oas-resolver":"^2.2.5","oas-schema-walker":"^1.1.2","oas-validator":"^3.3.1","reftools":"^1.0.8","yaml":"^1.3.1","yargs":"^12.0.5"},"keywords":["swagger","openapi","openapi2","openapi3","converter","conversion","validator","validation","resolver","lint","linter"],"gitHead":"bb9737783f5c8e192bdf2cc33edcaec1f7fa5720"}')},function(e,t){var n=Object.prototype.hasOwnProperty,r=Object.prototype.toString;e.exports=function(e,t,o){if("[object Function]"!==r.call(t))throw new TypeError("iterator must be a function");var i=e.length;if(i===+i)for(var a=0;a<i;a++)t.call(o,e[a],a,e);else for(var s in e)n.call(e,s)&&t.call(o,e[s],s,e)}},function(e,t,n){e.exports=function(){function e(){}return e.prototype.encodeReserved=function(e){return e.split(/(%[0-9A-Fa-f]{2})/g).map((function(e){return/%[0-9A-Fa-f]/.test(e)||(e=encodeURI(e).replace(/%5B/g,"[").replace(/%5D/g,"]")),e})).join("")},e.prototype.encodeUnreserved=function(e){return encodeURIComponent(e).replace(/[!'()*]/g,(function(e){return"%"+e.charCodeAt(0).toString(16).toUpperCase()}))},e.prototype.encodeValue=function(e,t,n){return t="+"===e||"#"===e?this.encodeReserved(t):this.encodeUnreserved(t),n?this.encodeUnreserved(n)+"="+t:t},e.prototype.isDefined=function(e){return null!=e},e.prototype.isKeyOperator=function(e){return";"===e||"&"===e||"?"===e},e.prototype.getValues=function(e,t,n,r){var o=e[n],i=[];if(this.isDefined(o)&&""!==o)if("string"==typeof o||"number"==typeof o||"boolean"==typeof o)o=o.toString(),r&&"*"!==r&&(o=o.substring(0,parseInt(r,10))),i.push(this.encodeValue(t,o,this.isKeyOperator(t)?n:null));else if("*"===r)Array.isArray(o)?o.filter(this.isDefined).forEach((function(e){i.push(this.encodeValue(t,e,this.isKeyOperator(t)?n:null))}),this):Object.keys(o).forEach((function(e){this.isDefined(o[e])&&i.push(this.encodeValue(t,o[e],e))}),this);else{var a=[];Array.isArray(o)?o.filter(this.isDefined).forEach((function(e){a.push(this.encodeValue(t,e))}),this):Object.keys(o).forEach((function(e){this.isDefined(o[e])&&(a.push(this.encodeUnreserved(e)),a.push(this.encodeValue(t,o[e].toString())))}),this),this.isKeyOperator(t)?i.push(this.encodeUnreserved(n)+"="+a.join(",")):0!==a.length&&i.push(a.join(","))}else";"===t?this.isDefined(o)&&i.push(this.encodeUnreserved(n)):""!==o||"&"!==t&&"?"!==t?""===o&&i.push(""):i.push(this.encodeUnreserved(n)+"=");return i},e.prototype.parse=function(e){var t=this,n=["+","#",".","/",";","?","&"];return{expand:function(r){return e.replace(/\{([^\{\}]+)\}|([^\{\}]+)/g,(function(e,o,i){if(o){var a=null,s=[];if(-1!==n.indexOf(o.charAt(0))&&(a=o.charAt(0),o=o.substr(1)),o.split(/,/g).forEach((function(e){var n=/([^:\*]*)(?::(\d+)|(\*))?/.exec(e);s.push.apply(s,t.getValues(r,a,n[1],n[2]||n[3]))})),a&&"+"!==a){var l=",";return"?"===a?l="&":"#"!==a&&(l=a),(0!==s.length?a:"")+s.join(l)}return s.join(",")}return t.encodeReserved(i)}))}}},new e}()},function(e,t){!function(e){var t="\\b(?:BASH|BASHOPTS|BASH_ALIASES|BASH_ARGC|BASH_ARGV|BASH_CMDS|BASH_COMPLETION_COMPAT_DIR|BASH_LINENO|BASH_REMATCH|BASH_SOURCE|BASH_VERSINFO|BASH_VERSION|COLORTERM|COLUMNS|COMP_WORDBREAKS|DBUS_SESSION_BUS_ADDRESS|DEFAULTS_PATH|DESKTOP_SESSION|DIRSTACK|DISPLAY|EUID|GDMSESSION|GDM_LANG|GNOME_KEYRING_CONTROL|GNOME_KEYRING_PID|GPG_AGENT_INFO|GROUPS|HISTCONTROL|HISTFILE|HISTFILESIZE|HISTSIZE|HOME|HOSTNAME|HOSTTYPE|IFS|INSTANCE|JOB|LANG|LANGUAGE|LC_ADDRESS|LC_ALL|LC_IDENTIFICATION|LC_MEASUREMENT|LC_MONETARY|LC_NAME|LC_NUMERIC|LC_PAPER|LC_TELEPHONE|LC_TIME|LESSCLOSE|LESSOPEN|LINES|LOGNAME|LS_COLORS|MACHTYPE|MAILCHECK|MANDATORY_PATH|NO_AT_BRIDGE|OLDPWD|OPTERR|OPTIND|ORBIT_SOCKETDIR|OSTYPE|PAPERSIZE|PATH|PIPESTATUS|PPID|PS1|PS2|PS3|PS4|PWD|RANDOM|REPLY|SECONDS|SELINUX_INIT|SESSION|SESSIONTYPE|SESSION_MANAGER|SHELL|SHELLOPTS|SHLVL|SSH_AUTH_SOCK|TERM|UID|UPSTART_EVENTS|UPSTART_INSTANCE|UPSTART_JOB|UPSTART_SESSION|USER|WINDOWID|XAUTHORITY|XDG_CONFIG_DIRS|XDG_CURRENT_DESKTOP|XDG_DATA_DIRS|XDG_GREETER_DATA_DIR|XDG_MENU_PREFIX|XDG_RUNTIME_DIR|XDG_SEAT|XDG_SEAT_PATH|XDG_SESSION_DESKTOP|XDG_SESSION_ID|XDG_SESSION_PATH|XDG_SESSION_TYPE|XDG_VTNR|XMODIFIERS)\\b",n={environment:{pattern:RegExp("\\$"+t),alias:"constant"},variable:[{pattern:/\$?\(\([\s\S]+?\)\)/,greedy:!0,inside:{variable:[{pattern:/(^\$\(\([\s\S]+)\)\)/,lookbehind:!0},/^\$\(\(/],number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+\.?\d*|\B\.\d+)(?:[Ee]-?\d+)?/,operator:/--?|-=|\+\+?|\+=|!=?|~|\*\*?|\*=|\/=?|%=?|<<=?|>>=?|<=?|>=?|==?|&&?|&=|\^=?|\|\|?|\|=|\?|:/,punctuation:/\(\(?|\)\)?|,|;/}},{pattern:/\$\((?:\([^)]+\)|[^()])+\)|`[^`]+`/,greedy:!0,inside:{variable:/^\$\(|^`|\)$|`$/}},{pattern:/\$\{[^}]+\}/,greedy:!0,inside:{operator:/:[-=?+]?|[!\/]|##?|%%?|\^\^?|,,?/,punctuation:/[\[\]]/,environment:{pattern:RegExp("(\\{)"+t),lookbehind:!0,alias:"constant"}}},/\$(?:\w+|[#?*!@$])/],entity:/\\(?:[abceEfnrtv\\"]|O?[0-7]{1,3}|x[0-9a-fA-F]{1,2}|u[0-9a-fA-F]{4}|U[0-9a-fA-F]{8})/};e.languages.bash={shebang:{pattern:/^#!\s*\/.*/,alias:"important"},comment:{pattern:/(^|[^"{\\$])#.*/,lookbehind:!0},"function-name":[{pattern:/(\bfunction\s+)\w+(?=(?:\s*\(?:\s*\))?\s*\{)/,lookbehind:!0,alias:"function"},{pattern:/\b\w+(?=\s*\(\s*\)\s*\{)/,alias:"function"}],"for-or-select":{pattern:/(\b(?:for|select)\s+)\w+(?=\s+in\s)/,alias:"variable",lookbehind:!0},"assign-left":{pattern:/(^|[\s;|&]|[<>]\()\w+(?=\+?=)/,inside:{environment:{pattern:RegExp("(^|[\\s;|&]|[<>]\\()"+t),lookbehind:!0,alias:"constant"}},alias:"variable",lookbehind:!0},string:[{pattern:/((?:^|[^<])<<-?\s*)(\w+?)\s*(?:\r?\n|\r)(?:[\s\S])*?(?:\r?\n|\r)\2/,lookbehind:!0,greedy:!0,inside:n},{pattern:/((?:^|[^<])<<-?\s*)(["'])(\w+)\2\s*(?:\r?\n|\r)(?:[\s\S])*?(?:\r?\n|\r)\3/,lookbehind:!0,greedy:!0},{pattern:/(["'])(?:\\[\s\S]|\$\([^)]+\)|`[^`]+`|(?!\1)[^\\])*\1/,greedy:!0,inside:n}],environment:{pattern:RegExp("\\$?"+t),alias:"constant"},variable:n.variable,function:{pattern:/(^|[\s;|&]|[<>]\()(?:add|apropos|apt|aptitude|apt-cache|apt-get|aspell|automysqlbackup|awk|basename|bash|bc|bconsole|bg|bzip2|cal|cat|cfdisk|chgrp|chkconfig|chmod|chown|chroot|cksum|clear|cmp|column|comm|cp|cron|crontab|csplit|curl|cut|date|dc|dd|ddrescue|debootstrap|df|diff|diff3|dig|dir|dircolors|dirname|dirs|dmesg|du|egrep|eject|env|ethtool|expand|expect|expr|fdformat|fdisk|fg|fgrep|file|find|fmt|fold|format|free|fsck|ftp|fuser|gawk|git|gparted|grep|groupadd|groupdel|groupmod|groups|grub-mkconfig|gzip|halt|head|hg|history|host|hostname|htop|iconv|id|ifconfig|ifdown|ifup|import|install|ip|jobs|join|kill|killall|less|link|ln|locate|logname|logrotate|look|lpc|lpr|lprint|lprintd|lprintq|lprm|ls|lsof|lynx|make|man|mc|mdadm|mkconfig|mkdir|mke2fs|mkfifo|mkfs|mkisofs|mknod|mkswap|mmv|more|most|mount|mtools|mtr|mutt|mv|nano|nc|netstat|nice|nl|nohup|notify-send|npm|nslookup|op|open|parted|passwd|paste|pathchk|ping|pkill|pnpm|popd|pr|printcap|printenv|ps|pushd|pv|quota|quotacheck|quotactl|ram|rar|rcp|reboot|remsync|rename|renice|rev|rm|rmdir|rpm|rsync|scp|screen|sdiff|sed|sendmail|seq|service|sftp|sh|shellcheck|shuf|shutdown|sleep|slocate|sort|split|ssh|stat|strace|su|sudo|sum|suspend|swapon|sync|tac|tail|tar|tee|time|timeout|top|touch|tr|traceroute|tsort|tty|umount|uname|unexpand|uniq|units|unrar|unshar|unzip|update-grub|uptime|useradd|userdel|usermod|users|uudecode|uuencode|v|vdir|vi|vim|virsh|vmstat|wait|watch|wc|wget|whereis|which|who|whoami|write|xargs|xdg-open|yarn|yes|zenity|zip|zsh|zypper)(?=$|[)\s;|&])/,lookbehind:!0},keyword:{pattern:/(^|[\s;|&]|[<>]\()(?:if|then|else|elif|fi|for|while|in|case|esac|function|select|do|done|until)(?=$|[)\s;|&])/,lookbehind:!0},builtin:{pattern:/(^|[\s;|&]|[<>]\()(?:\.|:|break|cd|continue|eval|exec|exit|export|getopts|hash|pwd|readonly|return|shift|test|times|trap|umask|unset|alias|bind|builtin|caller|command|declare|echo|enable|help|let|local|logout|mapfile|printf|read|readarray|source|type|typeset|ulimit|unalias|set|shopt)(?=$|[)\s;|&])/,lookbehind:!0,alias:"class-name"},boolean:{pattern:/(^|[\s;|&]|[<>]\()(?:true|false)(?=$|[)\s;|&])/,lookbehind:!0},"file-descriptor":{pattern:/\B&\d\b/,alias:"important"},operator:{pattern:/\d?<>|>\||\+=|==?|!=?|=~|<<[<-]?|[&\d]?>>|\d?[<>]&?|&[>&]?|\|[&|]?|<=?|>=?/,inside:{"file-descriptor":{pattern:/^\d/,alias:"important"}}},punctuation:/\$?\(\(?|\)\)?|\.\.|[{}[\];\\]/,number:{pattern:/(^|\s)(?:[1-9]\d*|0)(?:[.,]\d+)?\b/,lookbehind:!0}};for(var r=["comment","function-name","for-or-select","assign-left","string","environment","function","keyword","builtin","boolean","file-descriptor","operator","punctuation","number"],o=n.variable[1].inside,i=0;i<r.length;i++)o[r[i]]=e.languages.bash[r[i]];e.languages.shell=e.languages.bash}(Prism)},function(e,t){Prism.languages.c=Prism.languages.extend("clike",{"class-name":{pattern:/(\b(?:enum|struct)\s+)\w+/,lookbehind:!0},keyword:/\b(?:_Alignas|_Alignof|_Atomic|_Bool|_Complex|_Generic|_Imaginary|_Noreturn|_Static_assert|_Thread_local|asm|typeof|inline|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|int|long|register|return|short|signed|sizeof|static|struct|switch|typedef|union|unsigned|void|volatile|while)\b/,operator:/>>=?|<<=?|->|([-+&|:])\1|[?:~]|[-+*/%&|^!=<>]=?/,number:/(?:\b0x(?:[\da-f]+\.?[\da-f]*|\.[\da-f]+)(?:p[+-]?\d+)?|(?:\b\d+\.?\d*|\B\.\d+)(?:e[+-]?\d+)?)[ful]*/i}),Prism.languages.insertBefore("c","string",{macro:{pattern:/(^\s*)#\s*[a-z]+(?:[^\r\n\\]|\\(?:\r\n|[\s\S]))*/im,lookbehind:!0,alias:"property",inside:{string:{pattern:/(#\s*include\s*)(?:<.+?>|("|')(?:\\?.)+?\2)/,lookbehind:!0},directive:{pattern:/(#\s*)\b(?:define|defined|elif|else|endif|error|ifdef|ifndef|if|import|include|line|pragma|undef|using)\b/,lookbehind:!0,alias:"keyword"}}},constant:/\b(?:__FILE__|__LINE__|__DATE__|__TIME__|__TIMESTAMP__|__func__|EOF|NULL|SEEK_CUR|SEEK_END|SEEK_SET|stdin|stdout|stderr)\b/}),delete Prism.languages.c.boolean},function(e,t){Prism.languages.clike={comment:[{pattern:/(^|[^\\])\/\*[\s\S]*?(?:\*\/|$)/,lookbehind:!0},{pattern:/(^|[^\\:])\/\/.*/,lookbehind:!0,greedy:!0}],string:{pattern:/(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0},"class-name":{pattern:/((?:\b(?:class|interface|extends|implements|trait|instanceof|new)\s+)|(?:catch\s+\())[\w.\\]+/i,lookbehind:!0,inside:{punctuation:/[.\\]/}},keyword:/\b(?:if|else|while|do|for|return|in|instanceof|function|new|try|throw|catch|finally|null|break|continue)\b/,boolean:/\b(?:true|false)\b/,function:/\w+(?=\()/,number:/\b0x[\da-f]+\b|(?:\b\d+\.?\d*|\B\.\d+)(?:e[+-]?\d+)?/i,operator:/--?|\+\+?|!=?=?|<=?|>=?|==?=?|&&?|\|\|?|\?|\*|\/|~|\^|%/,punctuation:/[{}[\];(),.:]/}},function(e,t){!function(e){var t=/#(?!\{).+/,n={pattern:/#\{[^}]+\}/,alias:"variable"};e.languages.coffeescript=e.languages.extend("javascript",{comment:t,string:[{pattern:/'(?:\\[\s\S]|[^\\'])*'/,greedy:!0},{pattern:/"(?:\\[\s\S]|[^\\"])*"/,greedy:!0,inside:{interpolation:n}}],keyword:/\b(?:and|break|by|catch|class|continue|debugger|delete|do|each|else|extend|extends|false|finally|for|if|in|instanceof|is|isnt|let|loop|namespace|new|no|not|null|of|off|on|or|own|return|super|switch|then|this|throw|true|try|typeof|undefined|unless|until|when|while|window|with|yes|yield)\b/,"class-member":{pattern:/@(?!\d)\w+/,alias:"variable"}}),e.languages.insertBefore("coffeescript","comment",{"multiline-comment":{pattern:/###[\s\S]+?###/,alias:"comment"},"block-regex":{pattern:/\/{3}[\s\S]*?\/{3}/,alias:"regex",inside:{comment:t,interpolation:n}}}),e.languages.insertBefore("coffeescript","string",{"inline-javascript":{pattern:/`(?:\\[\s\S]|[^\\`])*`/,inside:{delimiter:{pattern:/^`|`$/,alias:"punctuation"},rest:e.languages.javascript}},"multiline-string":[{pattern:/'''[\s\S]*?'''/,greedy:!0,alias:"string"},{pattern:/"""[\s\S]*?"""/,greedy:!0,alias:"string",inside:{interpolation:n}}]}),e.languages.insertBefore("coffeescript","keyword",{property:/(?!\d)\w+(?=\s*:(?!:))/}),delete e.languages.coffeescript["template-string"],e.languages.coffee=e.languages.coffeescript}(Prism)},function(e,t){Prism.languages.cpp=Prism.languages.extend("c",{"class-name":{pattern:/(\b(?:class|enum|struct)\s+)\w+/,lookbehind:!0},keyword:/\b(?:alignas|alignof|asm|auto|bool|break|case|catch|char|char16_t|char32_t|class|compl|const|constexpr|const_cast|continue|decltype|default|delete|do|double|dynamic_cast|else|enum|explicit|export|extern|float|for|friend|goto|if|inline|int|int8_t|int16_t|int32_t|int64_t|uint8_t|uint16_t|uint32_t|uint64_t|long|mutable|namespace|new|noexcept|nullptr|operator|private|protected|public|register|reinterpret_cast|return|short|signed|sizeof|static|static_assert|static_cast|struct|switch|template|this|thread_local|throw|try|typedef|typeid|typename|union|unsigned|using|virtual|void|volatile|wchar_t|while)\b/,number:{pattern:/(?:\b0b[01']+|\b0x(?:[\da-f']+\.?[\da-f']*|\.[\da-f']+)(?:p[+-]?[\d']+)?|(?:\b[\d']+\.?[\d']*|\B\.[\d']+)(?:e[+-]?[\d']+)?)[ful]*/i,greedy:!0},operator:/>>=?|<<=?|->|([-+&|:])\1|[?:~]|[-+*/%&|^!=<>]=?|\b(?:and|and_eq|bitand|bitor|not|not_eq|or|or_eq|xor|xor_eq)\b/,boolean:/\b(?:true|false)\b/}),Prism.languages.insertBefore("cpp","string",{"raw-string":{pattern:/R"([^()\\ ]{0,16})\([\s\S]*?\)\1"/,alias:"string",greedy:!0}})},function(e,t){Prism.languages.csharp=Prism.languages.extend("clike",{keyword:/\b(?:abstract|add|alias|as|ascending|async|await|base|bool|break|byte|case|catch|char|checked|class|const|continue|decimal|default|delegate|descending|do|double|dynamic|else|enum|event|explicit|extern|false|finally|fixed|float|for|foreach|from|get|global|goto|group|if|implicit|in|int|interface|internal|into|is|join|let|lock|long|namespace|new|null|object|operator|orderby|out|override|params|partial|private|protected|public|readonly|ref|remove|return|sbyte|sealed|select|set|short|sizeof|stackalloc|static|string|struct|switch|this|throw|true|try|typeof|uint|ulong|unchecked|unsafe|ushort|using|value|var|virtual|void|volatile|where|while|yield)\b/,string:[{pattern:/@("|')(?:\1\1|\\[\s\S]|(?!\1)[^\\])*\1/,greedy:!0},{pattern:/("|')(?:\\.|(?!\1)[^\\\r\n])*?\1/,greedy:!0}],"class-name":[{pattern:/\b[A-Z]\w*(?:\.\w+)*\b(?=\s+\w+)/,inside:{punctuation:/\./}},{pattern:/(\[)[A-Z]\w*(?:\.\w+)*\b/,lookbehind:!0,inside:{punctuation:/\./}},{pattern:/(\b(?:class|interface)\s+[A-Z]\w*(?:\.\w+)*\s*:\s*)[A-Z]\w*(?:\.\w+)*\b/,lookbehind:!0,inside:{punctuation:/\./}},{pattern:/((?:\b(?:class|interface|new)\s+)|(?:catch\s+\())[A-Z]\w*(?:\.\w+)*\b/,lookbehind:!0,inside:{punctuation:/\./}}],number:/\b0x[\da-f]+\b|(?:\b\d+\.?\d*|\B\.\d+)f?/i,operator:/>>=?|<<=?|[-=]>|([-+&|?])\1|~|[-+*/%&|^!=<>]=?/,punctuation:/\?\.?|::|[{}[\];(),.:]/}),Prism.languages.insertBefore("csharp","class-name",{"generic-method":{pattern:/\w+\s*<[^>\r\n]+?>\s*(?=\()/,inside:{function:/^\w+/,"class-name":{pattern:/\b[A-Z]\w*(?:\.\w+)*\b/,inside:{punctuation:/\./}},keyword:Prism.languages.csharp.keyword,punctuation:/[<>(),.:]/}},preprocessor:{pattern:/(^\s*)#.*/m,lookbehind:!0,alias:"property",inside:{directive:{pattern:/(\s*#)\b(?:define|elif|else|endif|endregion|error|if|line|pragma|region|undef|warning)\b/,lookbehind:!0,alias:"keyword"}}}}),Prism.languages.dotnet=Prism.languages.cs=Prism.languages.csharp},function(e,t){Prism.languages.go=Prism.languages.extend("clike",{keyword:/\b(?:break|case|chan|const|continue|default|defer|else|fallthrough|for|func|go(?:to)?|if|import|interface|map|package|range|return|select|struct|switch|type|var)\b/,builtin:/\b(?:bool|byte|complex(?:64|128)|error|float(?:32|64)|rune|string|u?int(?:8|16|32|64)?|uintptr|append|cap|close|complex|copy|delete|imag|len|make|new|panic|print(?:ln)?|real|recover)\b/,boolean:/\b(?:_|iota|nil|true|false)\b/,operator:/[*\/%^!=]=?|\+[=+]?|-[=-]?|\|[=|]?|&(?:=|&|\^=?)?|>(?:>=?|=)?|<(?:<=?|=|-)?|:=|\.\.\./,number:/(?:\b0x[a-f\d]+|(?:\b\d+\.?\d*|\B\.\d+)(?:e[-+]?\d+)?)i?/i,string:{pattern:/(["'`])(\\[\s\S]|(?!\1)[^\\])*\1/,greedy:!0}}),delete Prism.languages.go["class-name"]},function(e,t){!function(e){e.languages.http={"request-line":{pattern:/^(?:POST|GET|PUT|DELETE|OPTIONS|PATCH|TRACE|CONNECT)\s(?:https?:\/\/|\/)\S+\sHTTP\/[0-9.]+/m,inside:{property:/^(?:POST|GET|PUT|DELETE|OPTIONS|PATCH|TRACE|CONNECT)\b/,"attr-name":/:\w+/}},"response-status":{pattern:/^HTTP\/1.[01] \d+.*/m,inside:{property:{pattern:/(^HTTP\/1.[01] )\d+.*/i,lookbehind:!0}}},"header-name":{pattern:/^[\w-]+:(?=.)/m,alias:"keyword"}};var t,n=e.languages,r={"application/javascript":n.javascript,"application/json":n.json||n.javascript,"application/xml":n.xml,"text/xml":n.xml,"text/html":n.html,"text/css":n.css},o={"application/json":!0,"application/xml":!0};function i(e){var t=e.replace(/^[a-z]+\//,"");return"(?:"+e+"|"+("\\w+/(?:[\\w.-]+\\+)+"+t+"(?![+\\w.-])")+")"}for(var a in r)if(r[a]){t=t||{};var s=o[a]?i(a):a;t[a]={pattern:RegExp("(content-type:\\s*"+s+"[\\s\\S]*?)(?:\\r?\\n|\\r){2}[\\s\\S]*","i"),lookbehind:!0,inside:{rest:r[a]}}}t&&e.languages.insertBefore("http","header-name",t)}(Prism)},function(e,t){!function(e){var t=/\b(?:abstract|continue|for|new|switch|assert|default|goto|package|synchronized|boolean|do|if|private|this|break|double|implements|protected|throw|byte|else|import|public|throws|case|enum|instanceof|return|transient|catch|extends|int|short|try|char|final|interface|static|void|class|finally|long|strictfp|volatile|const|float|native|super|while|var|null|exports|module|open|opens|provides|requires|to|transitive|uses|with)\b/,n=/\b[A-Z](?:\w*[a-z]\w*)?\b/;e.languages.java=e.languages.extend("clike",{"class-name":[n,/\b[A-Z]\w*(?=\s+\w+\s*[;,=())])/],keyword:t,function:[e.languages.clike.function,{pattern:/(\:\:)[a-z_]\w*/,lookbehind:!0}],number:/\b0b[01][01_]*L?\b|\b0x[\da-f_]*\.?[\da-f_p+-]+\b|(?:\b\d[\d_]*\.?[\d_]*|\B\.\d[\d_]*)(?:e[+-]?\d[\d_]*)?[dfl]?/i,operator:{pattern:/(^|[^.])(?:<<=?|>>>?=?|->|([-+&|])\2|[?:~]|[-+*/%&|^!=<>]=?)/m,lookbehind:!0}}),e.languages.insertBefore("java","class-name",{annotation:{alias:"punctuation",pattern:/(^|[^.])@\w+/,lookbehind:!0},namespace:{pattern:/(\b(?:exports|import(?:\s+static)?|module|open|opens|package|provides|requires|to|transitive|uses|with)\s+)[a-z]\w*(\.[a-z]\w*)+/,lookbehind:!0,inside:{punctuation:/\./}},generics:{pattern:/<(?:[\w\s,.&?]|<(?:[\w\s,.&?]|<(?:[\w\s,.&?]|<[\w\s,.&?]*>)*>)*>)*>/,inside:{"class-name":n,keyword:t,punctuation:/[<>(),.:]/,operator:/[?&|]/}}})}(Prism)},function(e,t){Prism.languages.lua={comment:/^#!.+|--(?:\[(=*)\[[\s\S]*?\]\1\]|.*)/m,string:{pattern:/(["'])(?:(?!\1)[^\\\r\n]|\\z(?:\r\n|\s)|\\(?:\r\n|[\s\S]))*\1|\[(=*)\[[\s\S]*?\]\2\]/,greedy:!0},number:/\b0x[a-f\d]+\.?[a-f\d]*(?:p[+-]?\d+)?\b|\b\d+(?:\.\B|\.?\d*(?:e[+-]?\d+)?\b)|\B\.\d+(?:e[+-]?\d+)?\b/i,keyword:/\b(?:and|break|do|else|elseif|end|false|for|function|goto|if|in|local|nil|not|or|repeat|return|then|true|until|while)\b/,function:/(?!\d)\w+(?=\s*(?:[({]))/,operator:[/[-+*%^&|#]|\/\/?|<[<=]?|>[>=]?|[=~]=?/,{pattern:/(^|[^.])\.\.(?!\.)/,lookbehind:!0}],punctuation:/[\[\](){},;]|\.+|:+/}},function(e,t){!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,i){if(n.language===r){var a=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof i&&!i(e))return e;for(var o,s=a.length;-1!==n.code.indexOf(o=t(r,s));)++s;return a[s]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,i=Object.keys(n.tokenStack);!function a(s){for(var l=0;l<s.length&&!(o>=i.length);l++){var c=s[l];if("string"==typeof c||c.content&&"string"==typeof c.content){var u=i[o],f=n.tokenStack[u],p="string"==typeof c?c:c.content,d=t(r,u),h=p.indexOf(d);if(h>-1){++o;var m=p.substring(0,h),g=new e.Token(r,e.tokenize(f,n.grammar),"language-"+r,f),y=p.substring(h+d.length),v=[];m&&v.push.apply(v,a([m])),v.push(g),y&&v.push.apply(v,a([y])),"string"==typeof c?s.splice.apply(s,[l,1].concat(v)):c.content=v}}else c.content&&a(c.content)}return s}(n.tokens)}}}})}(Prism)},function(e,t){Prism.languages.markup={comment:/<!--[\s\S]*?-->/,prolog:/<\?[\s\S]+?\?>/,doctype:/<!DOCTYPE[\s\S]+?>/i,cdata:/<!\[CDATA\[[\s\S]*?]]>/i,tag:{pattern:/<\/?(?!\d)[^\s>\/=$<%]+(?:\s(?:\s*[^\s>\/=]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))|(?=[\s/>])))+)?\s*\/?>/i,greedy:!0,inside:{tag:{pattern:/^<\/?[^\s>\/]+/i,inside:{punctuation:/^<\/?/,namespace:/^[^\s>\/:]+:/}},"attr-value":{pattern:/=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+)/i,inside:{punctuation:[/^=/,{pattern:/^(\s*)["']|["']$/,lookbehind:!0}]}},punctuation:/\/?>/,"attr-name":{pattern:/[^\s>\/]+/,inside:{namespace:/^[^\s>\/:]+:/}}}},entity:/&#?[\da-z]{1,8};/i},Prism.languages.markup.tag.inside["attr-value"].inside.entity=Prism.languages.markup.entity,Prism.hooks.add("wrap",(function(e){"entity"===e.type&&(e.attributes.title=e.content.replace(/&/,"&"))})),Object.defineProperty(Prism.languages.markup.tag,"addInlined",{value:function(e,t){var n={};n["language-"+t]={pattern:/(^<!\[CDATA\[)[\s\S]+?(?=\]\]>$)/i,lookbehind:!0,inside:Prism.languages[t]},n.cdata=/^<!\[CDATA\[|\]\]>$/i;var r={"included-cdata":{pattern:/<!\[CDATA\[[\s\S]*?\]\]>/i,inside:n}};r["language-"+t]={pattern:/[\s\S]+/,inside:Prism.languages[t]};var o={};o[e]={pattern:RegExp(/(<__[\s\S]*?>)(?:<!\[CDATA\[[\s\S]*?\]\]>\s*|[\s\S])*?(?=<\/__>)/.source.replace(/__/g,e),"i"),lookbehind:!0,greedy:!0,inside:r},Prism.languages.insertBefore("markup","cdata",o)}}),Prism.languages.xml=Prism.languages.extend("markup",{}),Prism.languages.html=Prism.languages.markup,Prism.languages.mathml=Prism.languages.markup,Prism.languages.svg=Prism.languages.markup},function(e,t){Prism.languages.objectivec=Prism.languages.extend("c",{keyword:/\b(?:asm|typeof|inline|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|int|long|register|return|short|signed|sizeof|static|struct|switch|typedef|union|unsigned|void|volatile|while|in|self|super)\b|(?:@interface|@end|@implementation|@protocol|@class|@public|@protected|@private|@property|@try|@catch|@finally|@throw|@synthesize|@dynamic|@selector)\b/,string:/("|')(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1|@"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,operator:/-[->]?|\+\+?|!=?|<<?=?|>>?=?|==?|&&?|\|\|?|[~^%?*\/@]/}),delete Prism.languages.objectivec["class-name"]},function(e,t){Prism.languages.perl={comment:[{pattern:/(^\s*)=\w+[\s\S]*?=cut.*/m,lookbehind:!0},{pattern:/(^|[^\\$])#.*/,lookbehind:!0}],string:[{pattern:/\b(?:q|qq|qx|qw)\s*([^a-zA-Z0-9\s{(\[<])(?:(?!\1)[^\\]|\\[\s\S])*\1/,greedy:!0},{pattern:/\b(?:q|qq|qx|qw)\s+([a-zA-Z0-9])(?:(?!\1)[^\\]|\\[\s\S])*\1/,greedy:!0},{pattern:/\b(?:q|qq|qx|qw)\s*\((?:[^()\\]|\\[\s\S])*\)/,greedy:!0},{pattern:/\b(?:q|qq|qx|qw)\s*\{(?:[^{}\\]|\\[\s\S])*\}/,greedy:!0},{pattern:/\b(?:q|qq|qx|qw)\s*\[(?:[^[\]\\]|\\[\s\S])*\]/,greedy:!0},{pattern:/\b(?:q|qq|qx|qw)\s*<(?:[^<>\\]|\\[\s\S])*>/,greedy:!0},{pattern:/("|`)(?:(?!\1)[^\\]|\\[\s\S])*\1/,greedy:!0},{pattern:/'(?:[^'\\\r\n]|\\.)*'/,greedy:!0}],regex:[{pattern:/\b(?:m|qr)\s*([^a-zA-Z0-9\s{(\[<])(?:(?!\1)[^\\]|\\[\s\S])*\1[msixpodualngc]*/,greedy:!0},{pattern:/\b(?:m|qr)\s+([a-zA-Z0-9])(?:(?!\1)[^\\]|\\[\s\S])*\1[msixpodualngc]*/,greedy:!0},{pattern:/\b(?:m|qr)\s*\((?:[^()\\]|\\[\s\S])*\)[msixpodualngc]*/,greedy:!0},{pattern:/\b(?:m|qr)\s*\{(?:[^{}\\]|\\[\s\S])*\}[msixpodualngc]*/,greedy:!0},{pattern:/\b(?:m|qr)\s*\[(?:[^[\]\\]|\\[\s\S])*\][msixpodualngc]*/,greedy:!0},{pattern:/\b(?:m|qr)\s*<(?:[^<>\\]|\\[\s\S])*>[msixpodualngc]*/,greedy:!0},{pattern:/(^|[^-]\b)(?:s|tr|y)\s*([^a-zA-Z0-9\s{(\[<])(?:(?!\2)[^\\]|\\[\s\S])*\2(?:(?!\2)[^\\]|\\[\s\S])*\2[msixpodualngcer]*/,lookbehind:!0,greedy:!0},{pattern:/(^|[^-]\b)(?:s|tr|y)\s+([a-zA-Z0-9])(?:(?!\2)[^\\]|\\[\s\S])*\2(?:(?!\2)[^\\]|\\[\s\S])*\2[msixpodualngcer]*/,lookbehind:!0,greedy:!0},{pattern:/(^|[^-]\b)(?:s|tr|y)\s*\((?:[^()\\]|\\[\s\S])*\)\s*\((?:[^()\\]|\\[\s\S])*\)[msixpodualngcer]*/,lookbehind:!0,greedy:!0},{pattern:/(^|[^-]\b)(?:s|tr|y)\s*\{(?:[^{}\\]|\\[\s\S])*\}\s*\{(?:[^{}\\]|\\[\s\S])*\}[msixpodualngcer]*/,lookbehind:!0,greedy:!0},{pattern:/(^|[^-]\b)(?:s|tr|y)\s*\[(?:[^[\]\\]|\\[\s\S])*\]\s*\[(?:[^[\]\\]|\\[\s\S])*\][msixpodualngcer]*/,lookbehind:!0,greedy:!0},{pattern:/(^|[^-]\b)(?:s|tr|y)\s*<(?:[^<>\\]|\\[\s\S])*>\s*<(?:[^<>\\]|\\[\s\S])*>[msixpodualngcer]*/,lookbehind:!0,greedy:!0},{pattern:/\/(?:[^\/\\\r\n]|\\.)*\/[msixpodualngc]*(?=\s*(?:$|[\r\n,.;})&|\-+*~<>!?^]|(lt|gt|le|ge|eq|ne|cmp|not|and|or|xor|x)\b))/,greedy:!0}],variable:[/[&*$@%]\{\^[A-Z]+\}/,/[&*$@%]\^[A-Z_]/,/[&*$@%]#?(?=\{)/,/[&*$@%]#?(?:(?:::)*'?(?!\d)[\w$]+)+(?:::)*/i,/[&*$@%]\d+/,/(?!%=)[$@%][!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/],filehandle:{pattern:/<(?![<=])\S*>|\b_\b/,alias:"symbol"},vstring:{pattern:/v\d+(?:\.\d+)*|\d+(?:\.\d+){2,}/,alias:"string"},function:{pattern:/sub [a-z0-9_]+/i,inside:{keyword:/sub/}},keyword:/\b(?:any|break|continue|default|delete|die|do|else|elsif|eval|for|foreach|given|goto|if|last|local|my|next|our|package|print|redo|require|return|say|state|sub|switch|undef|unless|until|use|when|while)\b/,number:/\b(?:0x[\dA-Fa-f](?:_?[\dA-Fa-f])*|0b[01](?:_?[01])*|(?:\d(?:_?\d)*)?\.?\d(?:_?\d)*(?:[Ee][+-]?\d+)?)\b/,operator:/-[rwxoRWXOezsfdlpSbctugkTBMAC]\b|\+[+=]?|-[-=>]?|\*\*?=?|\/\/?=?|=[=~>]?|~[~=]?|\|\|?=?|&&?=?|<(?:=>?|<=?)?|>>?=?|![~=]?|[%^]=?|\.(?:=|\.\.?)?|[\\?]|\bx(?:=|\b)|\b(?:lt|gt|le|ge|eq|ne|cmp|not|and|or|xor)\b/,punctuation:/[{}[\];(),:]/}},function(e,t){!function(e){e.languages.php=e.languages.extend("clike",{keyword:/\b(?:__halt_compiler|abstract|and|array|as|break|callable|case|catch|class|clone|const|continue|declare|default|die|do|echo|else|elseif|empty|enddeclare|endfor|endforeach|endif|endswitch|endwhile|eval|exit|extends|final|finally|for|foreach|function|global|goto|if|implements|include|include_once|instanceof|insteadof|interface|isset|list|namespace|new|or|parent|print|private|protected|public|require|require_once|return|static|switch|throw|trait|try|unset|use|var|while|xor|yield)\b/i,boolean:{pattern:/\b(?:false|true)\b/i,alias:"constant"},constant:[/\b[A-Z_][A-Z0-9_]*\b/,/\b(?:null)\b/i],comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0}}),e.languages.insertBefore("php","string",{"shell-comment":{pattern:/(^|[^\\])#.*/,lookbehind:!0,alias:"comment"}}),e.languages.insertBefore("php","comment",{delimiter:{pattern:/\?>$|^<\?(?:php(?=\s)|=)?/i,alias:"important"}}),e.languages.insertBefore("php","keyword",{variable:/\$+(?:\w+\b|(?={))/i,package:{pattern:/(\\|namespace\s+|use\s+)[\w\\]+/,lookbehind:!0,inside:{punctuation:/\\/}}}),e.languages.insertBefore("php","operator",{property:{pattern:/(->)[\w]+/,lookbehind:!0}});var t={pattern:/{\$(?:{(?:{[^{}]+}|[^{}]+)}|[^{}])+}|(^|[^\\{])\$+(?:\w+(?:\[.+?]|->\w+)*)/,lookbehind:!0,inside:{rest:e.languages.php}};e.languages.insertBefore("php","string",{"nowdoc-string":{pattern:/<<<'([^']+)'(?:\r\n?|\n)(?:.*(?:\r\n?|\n))*?\1;/,greedy:!0,alias:"string",inside:{delimiter:{pattern:/^<<<'[^']+'|[a-z_]\w*;$/i,alias:"symbol",inside:{punctuation:/^<<<'?|[';]$/}}}},"heredoc-string":{pattern:/<<<(?:"([^"]+)"(?:\r\n?|\n)(?:.*(?:\r\n?|\n))*?\1;|([a-z_]\w*)(?:\r\n?|\n)(?:.*(?:\r\n?|\n))*?\2;)/i,greedy:!0,alias:"string",inside:{delimiter:{pattern:/^<<<(?:"[^"]+"|[a-z_]\w*)|[a-z_]\w*;$/i,alias:"symbol",inside:{punctuation:/^<<<"?|[";]$/}},interpolation:t}},"single-quoted-string":{pattern:/'(?:\\[\s\S]|[^\\'])*'/,greedy:!0,alias:"string"},"double-quoted-string":{pattern:/"(?:\\[\s\S]|[^\\"])*"/,greedy:!0,alias:"string",inside:{interpolation:t}}}),delete e.languages.php.string,e.hooks.add("before-tokenize",(function(t){if(/<\?/.test(t.code)){e.languages["markup-templating"].buildPlaceholders(t,"php",/<\?(?:[^"'/#]|\/(?![*/])|("|')(?:\\[\s\S]|(?!\1)[^\\])*\1|(?:\/\/|#)(?:[^?\n\r]|\?(?!>))*|\/\*[\s\S]*?(?:\*\/|$))*?(?:\?>|$)/gi)}})),e.hooks.add("after-tokenize",(function(t){e.languages["markup-templating"].tokenizePlaceholders(t,"php")}))}(Prism)},function(e,t){Prism.languages.python={comment:{pattern:/(^|[^\\])#.*/,lookbehind:!0},"string-interpolation":{pattern:/(?:f|rf|fr)(?:("""|''')[\s\S]+?\1|("|')(?:\\.|(?!\2)[^\\\r\n])*\2)/i,greedy:!0,inside:{interpolation:{pattern:/((?:^|[^{])(?:{{)*){(?!{)(?:[^{}]|{(?!{)(?:[^{}]|{(?!{)(?:[^{}])+})+})+}/,lookbehind:!0,inside:{"format-spec":{pattern:/(:)[^:(){}]+(?=}$)/,lookbehind:!0},"conversion-option":{pattern://,alias:"punctuation"},rest:null}},string:/[\s\S]+/}},"triple-quoted-string":{pattern:/(?:[rub]|rb|br)?("""|''')[\s\S]+?\1/i,greedy:!0,alias:"string"},string:{pattern:/(?:[rub]|rb|br)?("|')(?:\\.|(?!\1)[^\\\r\n])*\1/i,greedy:!0},function:{pattern:/((?:^|\s)def[ \t]+)[a-zA-Z_]\w*(?=\s*\()/g,lookbehind:!0},"class-name":{pattern:/(\bclass\s+)\w+/i,lookbehind:!0},decorator:{pattern:/(^\s*)@\w+(?:\.\w+)*/i,lookbehind:!0,alias:["annotation","punctuation"],inside:{punctuation:/\./}},keyword:/\b(?:and|as|assert|async|await|break|class|continue|def|del|elif|else|except|exec|finally|for|from|global|if|import|in|is|lambda|nonlocal|not|or|pass|print|raise|return|try|while|with|yield)\b/,builtin:/\b(?:__import__|abs|all|any|apply|ascii|basestring|bin|bool|buffer|bytearray|bytes|callable|chr|classmethod|cmp|coerce|compile|complex|delattr|dict|dir|divmod|enumerate|eval|execfile|file|filter|float|format|frozenset|getattr|globals|hasattr|hash|help|hex|id|input|int|intern|isinstance|issubclass|iter|len|list|locals|long|map|max|memoryview|min|next|object|oct|open|ord|pow|property|range|raw_input|reduce|reload|repr|reversed|round|set|setattr|slice|sorted|staticmethod|str|sum|super|tuple|type|unichr|unicode|vars|xrange|zip)\b/,boolean:/\b(?:True|False|None)\b/,number:/(?:\b(?=\d)|\B(?=\.))(?:0[bo])?(?:(?:\d|0x[\da-f])[\da-f]*\.?\d*|\.\d+)(?:e[+-]?\d+)?j?\b/i,operator:/[-+%=]=?|!=|\*\*?=?|\/\/?=?|<[<=>]?|>[=>]?|[&|^~]/,punctuation:/[{}[\];(),.:]/},Prism.languages.python["string-interpolation"].inside.interpolation.inside.rest=Prism.languages.python,Prism.languages.py=Prism.languages.python},function(e,t){!function(e){e.languages.ruby=e.languages.extend("clike",{comment:[/#.*/,{pattern:/^=begin\s[\s\S]*?^=end/m,greedy:!0}],keyword:/\b(?:alias|and|BEGIN|begin|break|case|class|def|define_method|defined|do|each|else|elsif|END|end|ensure|false|for|if|in|module|new|next|nil|not|or|protected|private|public|raise|redo|require|rescue|retry|return|self|super|then|throw|true|undef|unless|until|when|while|yield)\b/});var t={pattern:/#\{[^}]+\}/,inside:{delimiter:{pattern:/^#\{|\}$/,alias:"tag"},rest:e.languages.ruby}};delete e.languages.ruby.function,e.languages.insertBefore("ruby","keyword",{regex:[{pattern:/%r([^a-zA-Z0-9\s{(\[<])(?:(?!\1)[^\\]|\\[\s\S])*\1[gim]{0,3}/,greedy:!0,inside:{interpolation:t}},{pattern:/%r\((?:[^()\\]|\\[\s\S])*\)[gim]{0,3}/,greedy:!0,inside:{interpolation:t}},{pattern:/%r\{(?:[^#{}\\]|#(?:\{[^}]+\})?|\\[\s\S])*\}[gim]{0,3}/,greedy:!0,inside:{interpolation:t}},{pattern:/%r\[(?:[^\[\]\\]|\\[\s\S])*\][gim]{0,3}/,greedy:!0,inside:{interpolation:t}},{pattern:/%r<(?:[^<>\\]|\\[\s\S])*>[gim]{0,3}/,greedy:!0,inside:{interpolation:t}},{pattern:/(^|[^/])\/(?!\/)(\[.+?]|\\.|[^/\\\r\n])+\/[gim]{0,3}(?=\s*($|[\r\n,.;})]))/,lookbehind:!0,greedy:!0}],variable:/[@$]+[a-zA-Z_]\w*(?:[?!]|\b)/,symbol:{pattern:/(^|[^:]):[a-zA-Z_]\w*(?:[?!]|\b)/,lookbehind:!0},"method-definition":{pattern:/(\bdef\s+)[\w.]+/,lookbehind:!0,inside:{function:/\w+$/,rest:e.languages.ruby}}}),e.languages.insertBefore("ruby","number",{builtin:/\b(?:Array|Bignum|Binding|Class|Continuation|Dir|Exception|FalseClass|File|Stat|Fixnum|Float|Hash|Integer|IO|MatchData|Method|Module|NilClass|Numeric|Object|Proc|Range|Regexp|String|Struct|TMS|Symbol|ThreadGroup|Thread|Time|TrueClass)\b/,constant:/\b[A-Z]\w*(?:[?!]|\b)/}),e.languages.ruby.string=[{pattern:/%[qQiIwWxs]?([^a-zA-Z0-9\s{(\[<])(?:(?!\1)[^\\]|\\[\s\S])*\1/,greedy:!0,inside:{interpolation:t}},{pattern:/%[qQiIwWxs]?\((?:[^()\\]|\\[\s\S])*\)/,greedy:!0,inside:{interpolation:t}},{pattern:/%[qQiIwWxs]?\{(?:[^#{}\\]|#(?:\{[^}]+\})?|\\[\s\S])*\}/,greedy:!0,inside:{interpolation:t}},{pattern:/%[qQiIwWxs]?\[(?:[^\[\]\\]|\\[\s\S])*\]/,greedy:!0,inside:{interpolation:t}},{pattern:/%[qQiIwWxs]?<(?:[^<>\\]|\\[\s\S])*>/,greedy:!0,inside:{interpolation:t}},{pattern:/("|')(?:#\{[^}]+\}|\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0,inside:{interpolation:t}}],e.languages.rb=e.languages.ruby}(Prism)},function(e,t){Prism.languages.scala=Prism.languages.extend("java",{keyword:/<-|=>|\b(?:abstract|case|catch|class|def|do|else|extends|final|finally|for|forSome|if|implicit|import|lazy|match|new|null|object|override|package|private|protected|return|sealed|self|super|this|throw|trait|try|type|val|var|while|with|yield)\b/,string:[{pattern:/"""[\s\S]*?"""/,greedy:!0},{pattern:/("|')(?:\\.|(?!\1)[^\\\r\n])*\1/,greedy:!0}],builtin:/\b(?:String|Int|Long|Short|Byte|Boolean|Double|Float|Char|Any|AnyRef|AnyVal|Unit|Nothing)\b/,number:/\b0x[\da-f]*\.?[\da-f]+|(?:\b\d+\.?\d*|\B\.\d+)(?:e\d+)?[dfl]?/i,symbol:/'[^\d\s\\]\w*/}),delete Prism.languages.scala["class-name"],delete Prism.languages.scala.function},function(e,t){Prism.languages.sql={comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|(?:--|\/\/|#).*)/,lookbehind:!0},variable:[{pattern:/@(["'`])(?:\\[\s\S]|(?!\1)[^\\])+\1/,greedy:!0},/@[\w.$]+/],string:{pattern:/(^|[^@\\])("|')(?:\\[\s\S]|(?!\2)[^\\]|\2\2)*\2/,greedy:!0,lookbehind:!0},function:/\b(?:AVG|COUNT|FIRST|FORMAT|LAST|LCASE|LEN|MAX|MID|MIN|MOD|NOW|ROUND|SUM|UCASE)(?=\s*\()/i,keyword:/\b(?:ACTION|ADD|AFTER|ALGORITHM|ALL|ALTER|ANALYZE|ANY|APPLY|AS|ASC|AUTHORIZATION|AUTO_INCREMENT|BACKUP|BDB|BEGIN|BERKELEYDB|BIGINT|BINARY|BIT|BLOB|BOOL|BOOLEAN|BREAK|BROWSE|BTREE|BULK|BY|CALL|CASCADED?|CASE|CHAIN|CHAR(?:ACTER|SET)?|CHECK(?:POINT)?|CLOSE|CLUSTERED|COALESCE|COLLATE|COLUMNS?|COMMENT|COMMIT(?:TED)?|COMPUTE|CONNECT|CONSISTENT|CONSTRAINT|CONTAINS(?:TABLE)?|CONTINUE|CONVERT|CREATE|CROSS|CURRENT(?:_DATE|_TIME|_TIMESTAMP|_USER)?|CURSOR|CYCLE|DATA(?:BASES?)?|DATE(?:TIME)?|DAY|DBCC|DEALLOCATE|DEC|DECIMAL|DECLARE|DEFAULT|DEFINER|DELAYED|DELETE|DELIMITERS?|DENY|DESC|DESCRIBE|DETERMINISTIC|DISABLE|DISCARD|DISK|DISTINCT|DISTINCTROW|DISTRIBUTED|DO|DOUBLE|DROP|DUMMY|DUMP(?:FILE)?|DUPLICATE|ELSE(?:IF)?|ENABLE|ENCLOSED|END|ENGINE|ENUM|ERRLVL|ERRORS|ESCAPED?|EXCEPT|EXEC(?:UTE)?|EXISTS|EXIT|EXPLAIN|EXTENDED|FETCH|FIELDS|FILE|FILLFACTOR|FIRST|FIXED|FLOAT|FOLLOWING|FOR(?: EACH ROW)?|FORCE|FOREIGN|FREETEXT(?:TABLE)?|FROM|FULL|FUNCTION|GEOMETRY(?:COLLECTION)?|GLOBAL|GOTO|GRANT|GROUP|HANDLER|HASH|HAVING|HOLDLOCK|HOUR|IDENTITY(?:_INSERT|COL)?|IF|IGNORE|IMPORT|INDEX|INFILE|INNER|INNODB|INOUT|INSERT|INT|INTEGER|INTERSECT|INTERVAL|INTO|INVOKER|ISOLATION|ITERATE|JOIN|KEYS?|KILL|LANGUAGE|LAST|LEAVE|LEFT|LEVEL|LIMIT|LINENO|LINES|LINESTRING|LOAD|LOCAL|LOCK|LONG(?:BLOB|TEXT)|LOOP|MATCH(?:ED)?|MEDIUM(?:BLOB|INT|TEXT)|MERGE|MIDDLEINT|MINUTE|MODE|MODIFIES|MODIFY|MONTH|MULTI(?:LINESTRING|POINT|POLYGON)|NATIONAL|NATURAL|NCHAR|NEXT|NO|NONCLUSTERED|NULLIF|NUMERIC|OFF?|OFFSETS?|ON|OPEN(?:DATASOURCE|QUERY|ROWSET)?|OPTIMIZE|OPTION(?:ALLY)?|ORDER|OUT(?:ER|FILE)?|OVER|PARTIAL|PARTITION|PERCENT|PIVOT|PLAN|POINT|POLYGON|PRECEDING|PRECISION|PREPARE|PREV|PRIMARY|PRINT|PRIVILEGES|PROC(?:EDURE)?|PUBLIC|PURGE|QUICK|RAISERROR|READS?|REAL|RECONFIGURE|REFERENCES|RELEASE|RENAME|REPEAT(?:ABLE)?|REPLACE|REPLICATION|REQUIRE|RESIGNAL|RESTORE|RESTRICT|RETURNS?|REVOKE|RIGHT|ROLLBACK|ROUTINE|ROW(?:COUNT|GUIDCOL|S)?|RTREE|RULE|SAVE(?:POINT)?|SCHEMA|SECOND|SELECT|SERIAL(?:IZABLE)?|SESSION(?:_USER)?|SET(?:USER)?|SHARE|SHOW|SHUTDOWN|SIMPLE|SMALLINT|SNAPSHOT|SOME|SONAME|SQL|START(?:ING)?|STATISTICS|STATUS|STRIPED|SYSTEM_USER|TABLES?|TABLESPACE|TEMP(?:ORARY|TABLE)?|TERMINATED|TEXT(?:SIZE)?|THEN|TIME(?:STAMP)?|TINY(?:BLOB|INT|TEXT)|TOP?|TRAN(?:SACTIONS?)?|TRIGGER|TRUNCATE|TSEQUAL|TYPES?|UNBOUNDED|UNCOMMITTED|UNDEFINED|UNION|UNIQUE|UNLOCK|UNPIVOT|UNSIGNED|UPDATE(?:TEXT)?|USAGE|USE|USER|USING|VALUES?|VAR(?:BINARY|CHAR|CHARACTER|YING)|VIEW|WAITFOR|WARNINGS|WHEN|WHERE|WHILE|WITH(?: ROLLUP|IN)?|WORK|WRITE(?:TEXT)?|YEAR)\b/i,boolean:/\b(?:TRUE|FALSE|NULL)\b/i,number:/\b0x[\da-f]+\b|\b\d+\.?\d*|\B\.\d+\b/i,operator:/[-+*\/=%^~]|&&?|\|\|?|!=?|<(?:=>?|<|>)?|>[>=]?|\b(?:AND|BETWEEN|IN|LIKE|NOT|OR|IS|DIV|REGEXP|RLIKE|SOUNDS LIKE|XOR)\b/i,punctuation:/[;[\]()`,.]/}},function(e,t){Prism.languages.swift=Prism.languages.extend("clike",{string:{pattern:/("|')(\\(?:\((?:[^()]|\([^)]+\))+\)|\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0,inside:{interpolation:{pattern:/\\\((?:[^()]|\([^)]+\))+\)/,inside:{delimiter:{pattern:/^\\\(|\)$/,alias:"variable"}}}}},keyword:/\b(?:as|associativity|break|case|catch|class|continue|convenience|default|defer|deinit|didSet|do|dynamic(?:Type)?|else|enum|extension|fallthrough|final|for|func|get|guard|if|import|in|infix|init|inout|internal|is|lazy|left|let|mutating|new|none|nonmutating|operator|optional|override|postfix|precedence|prefix|private|protocol|public|repeat|required|rethrows|return|right|safe|self|Self|set|static|struct|subscript|super|switch|throws?|try|Type|typealias|unowned|unsafe|var|weak|where|while|willSet|__(?:COLUMN__|FILE__|FUNCTION__|LINE__))\b/,number:/\b(?:[\d_]+(?:\.[\de_]+)?|0x[a-f0-9_]+(?:\.[a-f0-9p_]+)?|0b[01_]+|0o[0-7_]+)\b/i,constant:/\b(?:nil|[A-Z_]{2,}|k[A-Z][A-Za-z_]+)\b/,atrule:/@\b(?:IB(?:Outlet|Designable|Action|Inspectable)|class_protocol|exported|noreturn|NS(?:Copying|Managed)|objc|UIApplicationMain|auto_closure)\b/,builtin:/\b(?:[A-Z]\S+|abs|advance|alignof(?:Value)?|assert|contains|count(?:Elements)?|debugPrint(?:ln)?|distance|drop(?:First|Last)|dump|enumerate|equal|filter|find|first|getVaList|indices|isEmpty|join|last|lexicographicalCompare|map|max(?:Element)?|min(?:Element)?|numericCast|overlaps|partition|print(?:ln)?|reduce|reflect|reverse|sizeof(?:Value)?|sort(?:ed)?|split|startsWith|stride(?:of(?:Value)?)?|suffix|swap|toDebugString|toString|transcode|underestimateCount|unsafeBitCast|with(?:ExtendedLifetime|Unsafe(?:MutablePointers?|Pointers?)|VaList))\b/}),Prism.languages.swift.string.inside.interpolation.inside.rest=Prism.languages.swift},function(e,t,n){var r=n(314),o=["add","done","toJS","load","search"];e.exports=function(){var e=new Worker(URL.createObjectURL(new Blob(['/*!\n * ReDoc - OpenAPI/Swagger-generated API Reference Documentation\n * -------------------------------------------------------------\n * Version: "2.0.0-rc.23"\n * Repo: https://github.com/Redocly/redoc\n */!function(e){var t={};function r(n){if(t[n])return t[n].exports;var i=t[n]={i:n,l:!1,exports:{}};return e[n].call(i.exports,i,i.exports,r),i.l=!0,i.exports}r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var i in e)r.d(n,i,function(t){return e[t]}.bind(null,i));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=97)}([function(e,t,r){(function(t){var r=function(e){return e&&e.Math==Math&&e};e.exports=r("object"==typeof globalThis&&globalThis)||r("object"==typeof window&&window)||r("object"==typeof self&&self)||r("object"==typeof t&&t)||Function("return this")()}).call(this,r(59))},function(e,t,r){var n=r(0),i=r(32),o=r(3),s=r(36),u=r(37),a=r(60),c=i("wks"),l=n.Symbol,f=a?l:s;e.exports=function(e){return o(c,e)||(u&&o(l,e)?c[e]=l[e]:c[e]=f("Symbol."+e)),c[e]}},function(e,t,r){var n=r(7);e.exports=function(e){if(!n(e))throw TypeError(String(e)+" is not an object");return e}},function(e,t){var r={}.hasOwnProperty;e.exports=function(e,t){return r.call(e,t)}},function(e,t,r){var n,i;\n/**\n * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.8\n * Copyright (C) 2019 Oliver Nightingale\n * @license MIT\n */!function(){var o,s,u,a,c,l,f,p,h,d,y,v,m,g,x,w,b,S,P,k,E,O,L,T,Q,j,I=function(e){var t=new I.Builder;return t.pipeline.add(I.trimmer,I.stopWordFilter,I.stemmer),t.searchPipeline.add(I.stemmer),e.call(t,t),t.build()};I.version="2.3.8"\n/*!\n * lunr.utils\n * Copyright (C) 2019 Oliver Nightingale\n */,I.utils={},I.utils.warn=(o=this,function(e){o.console&&console.warn&&console.warn(e)}),I.utils.asString=function(e){return null==e?"":e.toString()},I.utils.clone=function(e){if(null==e)return e;for(var t=Object.create(null),r=Object.keys(e),n=0;n<r.length;n++){var i=r[n],o=e[i];if(Array.isArray(o))t[i]=o.slice();else{if("string"!=typeof o&&"number"!=typeof o&&"boolean"!=typeof o)throw new TypeError("clone is not deep and does not support nested objects");t[i]=o}}return t},I.FieldRef=function(e,t,r){this.docRef=e,this.fieldName=t,this._stringValue=r},I.FieldRef.joiner="/",I.FieldRef.fromString=function(e){var t=e.indexOf(I.FieldRef.joiner);if(-1===t)throw"malformed field ref string";var r=e.slice(0,t),n=e.slice(t+1);return new I.FieldRef(n,r,e)},I.FieldRef.prototype.toString=function(){return null==this._stringValue&&(this._stringValue=this.fieldName+I.FieldRef.joiner+this.docRef),this._stringValue}\n/*!\n * lunr.Set\n * Copyright (C) 2019 Oliver Nightingale\n */,I.Set=function(e){if(this.elements=Object.create(null),e){this.length=e.length;for(var t=0;t<this.length;t++)this.elements[e[t]]=!0}else this.length=0},I.Set.complete={intersect:function(e){return e},union:function(e){return e},contains:function(){return!0}},I.Set.empty={intersect:function(){return this},union:function(e){return e},contains:function(){return!1}},I.Set.prototype.contains=function(e){return!!this.elements[e]},I.Set.prototype.intersect=function(e){var t,r,n,i=[];if(e===I.Set.complete)return this;if(e===I.Set.empty)return e;this.length<e.length?(t=this,r=e):(t=e,r=this),n=Object.keys(t.elements);for(var o=0;o<n.length;o++){var s=n[o];s in r.elements&&i.push(s)}return new I.Set(i)},I.Set.prototype.union=function(e){return e===I.Set.complete?I.Set.complete:e===I.Set.empty?this:new I.Set(Object.keys(this.elements).concat(Object.keys(e.elements)))},I.idf=function(e,t){var r=0;for(var n in e)"_index"!=n&&(r+=Object.keys(e[n]).length);var i=(t-r+.5)/(r+.5);return Math.log(1+Math.abs(i))},I.Token=function(e,t){this.str=e||"",this.metadata=t||{}},I.Token.prototype.toString=function(){return this.str},I.Token.prototype.update=function(e){return this.str=e(this.str,this.metadata),this},I.Token.prototype.clone=function(e){return e=e||function(e){return e},new I.Token(e(this.str,this.metadata),this.metadata)}\n/*!\n * lunr.tokenizer\n * Copyright (C) 2019 Oliver Nightingale\n */,I.tokenizer=function(e,t){if(null==e||null==e)return[];if(Array.isArray(e))return e.map((function(e){return new I.Token(I.utils.asString(e).toLowerCase(),I.utils.clone(t))}));for(var r=e.toString().toLowerCase(),n=r.length,i=[],o=0,s=0;o<=n;o++){var u=o-s;if(r.charAt(o).match(I.tokenizer.separator)||o==n){if(u>0){var a=I.utils.clone(t)||{};a.position=[s,u],a.index=i.length,i.push(new I.Token(r.slice(s,o),a))}s=o+1}}return i},I.tokenizer.separator=/[\\s\\-]+/\n/*!\n * lunr.Pipeline\n * Copyright (C) 2019 Oliver Nightingale\n */,I.Pipeline=function(){this._stack=[]},I.Pipeline.registeredFunctions=Object.create(null),I.Pipeline.registerFunction=function(e,t){t in this.registeredFunctions&&I.utils.warn("Overwriting existing registered function: "+t),e.label=t,I.Pipeline.registeredFunctions[e.label]=e},I.Pipeline.warnIfFunctionNotRegistered=function(e){e.label&&e.label in this.registeredFunctions||I.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\\n",e)},I.Pipeline.load=function(e){var t=new I.Pipeline;return e.forEach((function(e){var r=I.Pipeline.registeredFunctions[e];if(!r)throw new Error("Cannot load unregistered function: "+e);t.add(r)})),t},I.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach((function(e){I.Pipeline.warnIfFunctionNotRegistered(e),this._stack.push(e)}),this)},I.Pipeline.prototype.after=function(e,t){I.Pipeline.warnIfFunctionNotRegistered(t);var r=this._stack.indexOf(e);if(-1==r)throw new Error("Cannot find existingFn");r+=1,this._stack.splice(r,0,t)},I.Pipeline.prototype.before=function(e,t){I.Pipeline.warnIfFunctionNotRegistered(t);var r=this._stack.indexOf(e);if(-1==r)throw new Error("Cannot find existingFn");this._stack.splice(r,0,t)},I.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);-1!=t&&this._stack.splice(t,1)},I.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r<t;r++){for(var n=this._stack[r],i=[],o=0;o<e.length;o++){var s=n(e[o],o,e);if(null!=s&&""!==s)if(Array.isArray(s))for(var u=0;u<s.length;u++)i.push(s[u]);else i.push(s)}e=i}return e},I.Pipeline.prototype.runString=function(e,t){var r=new I.Token(e,t);return this.run([r]).map((function(e){return e.toString()}))},I.Pipeline.prototype.reset=function(){this._stack=[]},I.Pipeline.prototype.toJSON=function(){return this._stack.map((function(e){return I.Pipeline.warnIfFunctionNotRegistered(e),e.label}))}\n/*!\n * lunr.Vector\n * Copyright (C) 2019 Oliver Nightingale\n */,I.Vector=function(e){this._magnitude=0,this.elements=e||[]},I.Vector.prototype.positionForIndex=function(e){if(0==this.elements.length)return 0;for(var t=0,r=this.elements.length/2,n=r-t,i=Math.floor(n/2),o=this.elements[2*i];n>1&&(o<e&&(t=i),o>e&&(r=i),o!=e);)n=r-t,i=t+Math.floor(n/2),o=this.elements[2*i];return o==e?2*i:o>e?2*i:o<e?2*(i+1):void 0},I.Vector.prototype.insert=function(e,t){this.upsert(e,t,(function(){throw"duplicate index"}))},I.Vector.prototype.upsert=function(e,t,r){this._magnitude=0;var n=this.positionForIndex(e);this.elements[n]==e?this.elements[n+1]=r(this.elements[n+1],t):this.elements.splice(n,0,e,t)},I.Vector.prototype.magnitude=function(){if(this._magnitude)return this._magnitude;for(var e=0,t=this.elements.length,r=1;r<t;r+=2){var n=this.elements[r];e+=n*n}return this._magnitude=Math.sqrt(e)},I.Vector.prototype.dot=function(e){for(var t=0,r=this.elements,n=e.elements,i=r.length,o=n.length,s=0,u=0,a=0,c=0;a<i&&c<o;)(s=r[a])<(u=n[c])?a+=2:s>u?c+=2:s==u&&(t+=r[a+1]*n[c+1],a+=2,c+=2);return t},I.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},I.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t<this.elements.length;t+=2,r++)e[r]=this.elements[t];return e},I.Vector.prototype.toJSON=function(){return this.elements}\n/*!\n * lunr.stemmer\n * Copyright (C) 2019 Oliver Nightingale\n * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt\n */,I.stemmer=(s={ational:"ate",tional:"tion",enci:"ence",anci:"ance",izer:"ize",bli:"ble",alli:"al",entli:"ent",eli:"e",ousli:"ous",ization:"ize",ation:"ate",ator:"ate",alism:"al",iveness:"ive",fulness:"ful",ousness:"ous",aliti:"al",iviti:"ive",biliti:"ble",logi:"log"},u={icate:"ic",ative:"",alize:"al",iciti:"ic",ical:"ic",ful:"",ness:""},a="[aeiouy]",c="[^aeiou][^aeiouy]*",l=new RegExp("^([^aeiou][^aeiouy]*)?[aeiouy][aeiou]*[^aeiou][^aeiouy]*"),f=new RegExp("^([^aeiou][^aeiouy]*)?[aeiouy][aeiou]*[^aeiou][^aeiouy]*[aeiouy][aeiou]*[^aeiou][^aeiouy]*"),p=new RegExp("^([^aeiou][^aeiouy]*)?[aeiouy][aeiou]*[^aeiou][^aeiouy]*([aeiouy][aeiou]*)?$"),h=new RegExp("^([^aeiou][^aeiouy]*)?[aeiouy]"),d=/^(.+?)(ss|i)es$/,y=/^(.+?)([^s])s$/,v=/^(.+?)eed$/,m=/^(.+?)(ed|ing)$/,g=/.$/,x=/(at|bl|iz)$/,w=new RegExp("([^aeiouylsz])\\\\1$"),b=new RegExp("^"+c+a+"[^aeiouwxy]$"),S=/^(.+?[^aeiou])y$/,P=/^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/,k=/^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/,E=/^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/,O=/^(.+?)(s|t)(ion)$/,L=/^(.+?)e$/,T=/ll$/,Q=new RegExp("^"+c+a+"[^aeiouwxy]$"),j=function(e){var t,r,n,i,o,a,c;if(e.length<3)return e;if("y"==(n=e.substr(0,1))&&(e=n.toUpperCase()+e.substr(1)),o=y,(i=d).test(e)?e=e.replace(i,"$1$2"):o.test(e)&&(e=e.replace(o,"$1$2")),o=m,(i=v).test(e)){var j=i.exec(e);(i=l).test(j[1])&&(i=g,e=e.replace(i,""))}else o.test(e)&&(t=(j=o.exec(e))[1],(o=h).test(t)&&(a=w,c=b,(o=x).test(e=t)?e+="e":a.test(e)?(i=g,e=e.replace(i,"")):c.test(e)&&(e+="e")));return(i=S).test(e)&&(e=(t=(j=i.exec(e))[1])+"i"),(i=P).test(e)&&(t=(j=i.exec(e))[1],r=j[2],(i=l).test(t)&&(e=t+s[r])),(i=k).test(e)&&(t=(j=i.exec(e))[1],r=j[2],(i=l).test(t)&&(e=t+u[r])),o=O,(i=E).test(e)?(t=(j=i.exec(e))[1],(i=f).test(t)&&(e=t)):o.test(e)&&(t=(j=o.exec(e))[1]+j[2],(o=f).test(t)&&(e=t)),(i=L).test(e)&&(t=(j=i.exec(e))[1],o=p,a=Q,((i=f).test(t)||o.test(t)&&!a.test(t))&&(e=t)),o=f,(i=T).test(e)&&o.test(e)&&(i=g,e=e.replace(i,"")),"y"==n&&(e=n.toLowerCase()+e.substr(1)),e},function(e){return e.update(j)}),I.Pipeline.registerFunction(I.stemmer,"stemmer")\n/*!\n * lunr.stopWordFilter\n * Copyright (C) 2019 Oliver Nightingale\n */,I.generateStopWordFilter=function(e){var t=e.reduce((function(e,t){return e[t]=t,e}),{});return function(e){if(e&&t[e.toString()]!==e.toString())return e}},I.stopWordFilter=I.generateStopWordFilter(["a","able","about","across","after","all","almost","also","am","among","an","and","any","are","as","at","be","because","been","but","by","can","cannot","could","dear","did","do","does","either","else","ever","every","for","from","get","got","had","has","have","he","her","hers","him","his","how","however","i","if","in","into","is","it","its","just","least","let","like","likely","may","me","might","most","must","my","neither","no","nor","not","of","off","often","on","only","or","other","our","own","rather","said","say","says","she","should","since","so","some","than","that","the","their","them","then","there","these","they","this","tis","to","too","twas","us","wants","was","we","were","what","when","where","which","while","who","whom","why","will","with","would","yet","you","your"]),I.Pipeline.registerFunction(I.stopWordFilter,"stopWordFilter")\n/*!\n * lunr.trimmer\n * Copyright (C) 2019 Oliver Nightingale\n */,I.trimmer=function(e){return e.update((function(e){return e.replace(/^\\W+/,"").replace(/\\W+$/,"")}))},I.Pipeline.registerFunction(I.trimmer,"trimmer")\n/*!\n * lunr.TokenSet\n * Copyright (C) 2019 Oliver Nightingale\n */,I.TokenSet=function(){this.final=!1,this.edges={},this.id=I.TokenSet._nextId,I.TokenSet._nextId+=1},I.TokenSet._nextId=1,I.TokenSet.fromArray=function(e){for(var t=new I.TokenSet.Builder,r=0,n=e.length;r<n;r++)t.insert(e[r]);return t.finish(),t.root},I.TokenSet.fromClause=function(e){return"editDistance"in e?I.TokenSet.fromFuzzyString(e.term,e.editDistance):I.TokenSet.fromString(e.term)},I.TokenSet.fromFuzzyString=function(e,t){for(var r=new I.TokenSet,n=[{node:r,editsRemaining:t,str:e}];n.length;){var i=n.pop();if(i.str.length>0){var o,s=i.str.charAt(0);s in i.node.edges?o=i.node.edges[s]:(o=new I.TokenSet,i.node.edges[s]=o),1==i.str.length&&(o.final=!0),n.push({node:o,editsRemaining:i.editsRemaining,str:i.str.slice(1)})}if(0!=i.editsRemaining){if("*"in i.node.edges)var u=i.node.edges["*"];else{u=new I.TokenSet;i.node.edges["*"]=u}if(0==i.str.length&&(u.final=!0),n.push({node:u,editsRemaining:i.editsRemaining-1,str:i.str}),i.str.length>1&&n.push({node:i.node,editsRemaining:i.editsRemaining-1,str:i.str.slice(1)}),1==i.str.length&&(i.node.final=!0),i.str.length>=1){if("*"in i.node.edges)var a=i.node.edges["*"];else{a=new I.TokenSet;i.node.edges["*"]=a}1==i.str.length&&(a.final=!0),n.push({node:a,editsRemaining:i.editsRemaining-1,str:i.str.slice(1)})}if(i.str.length>1){var c,l=i.str.charAt(0),f=i.str.charAt(1);f in i.node.edges?c=i.node.edges[f]:(c=new I.TokenSet,i.node.edges[f]=c),1==i.str.length&&(c.final=!0),n.push({node:c,editsRemaining:i.editsRemaining-1,str:l+i.str.slice(2)})}}}return r},I.TokenSet.fromString=function(e){for(var t=new I.TokenSet,r=t,n=0,i=e.length;n<i;n++){var o=e[n],s=n==i-1;if("*"==o)t.edges[o]=t,t.final=s;else{var u=new I.TokenSet;u.final=s,t.edges[o]=u,t=u}}return r},I.TokenSet.prototype.toArray=function(){for(var e=[],t=[{prefix:"",node:this}];t.length;){var r=t.pop(),n=Object.keys(r.node.edges),i=n.length;r.node.final&&(r.prefix.charAt(0),e.push(r.prefix));for(var o=0;o<i;o++){var s=n[o];t.push({prefix:r.prefix.concat(s),node:r.node.edges[s]})}}return e},I.TokenSet.prototype.toString=function(){if(this._str)return this._str;for(var e=this.final?"1":"0",t=Object.keys(this.edges).sort(),r=t.length,n=0;n<r;n++){var i=t[n];e=e+i+this.edges[i].id}return e},I.TokenSet.prototype.intersect=function(e){for(var t=new I.TokenSet,r=void 0,n=[{qNode:e,output:t,node:this}];n.length;){r=n.pop();for(var i=Object.keys(r.qNode.edges),o=i.length,s=Object.keys(r.node.edges),u=s.length,a=0;a<o;a++)for(var c=i[a],l=0;l<u;l++){var f=s[l];if(f==c||"*"==c){var p=r.node.edges[f],h=r.qNode.edges[c],d=p.final&&h.final,y=void 0;f in r.output.edges?(y=r.output.edges[f]).final=y.final||d:((y=new I.TokenSet).final=d,r.output.edges[f]=y),n.push({qNode:h,output:y,node:p})}}}return t},I.TokenSet.Builder=function(){this.previousWord="",this.root=new I.TokenSet,this.uncheckedNodes=[],this.minimizedNodes={}},I.TokenSet.Builder.prototype.insert=function(e){var t,r=0;if(e<this.previousWord)throw new Error("Out of order word insertion");for(var n=0;n<e.length&&n<this.previousWord.length&&e[n]==this.previousWord[n];n++)r++;this.minimize(r),t=0==this.uncheckedNodes.length?this.root:this.uncheckedNodes[this.uncheckedNodes.length-1].child;for(n=r;n<e.length;n++){var i=new I.TokenSet,o=e[n];t.edges[o]=i,this.uncheckedNodes.push({parent:t,char:o,child:i}),t=i}t.final=!0,this.previousWord=e},I.TokenSet.Builder.prototype.finish=function(){this.minimize(0)},I.TokenSet.Builder.prototype.minimize=function(e){for(var t=this.uncheckedNodes.length-1;t>=e;t--){var r=this.uncheckedNodes[t],n=r.child.toString();n in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[n]:(r.child._str=n,this.minimizedNodes[n]=r.child),this.uncheckedNodes.pop()}}\n/*!\n * lunr.Index\n * Copyright (C) 2019 Oliver Nightingale\n */,I.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},I.Index.prototype.search=function(e){return this.query((function(t){new I.QueryParser(e,t).parse()}))},I.Index.prototype.query=function(e){for(var t=new I.Query(this.fields),r=Object.create(null),n=Object.create(null),i=Object.create(null),o=Object.create(null),s=Object.create(null),u=0;u<this.fields.length;u++)n[this.fields[u]]=new I.Vector;e.call(t,t);for(u=0;u<t.clauses.length;u++){var a=t.clauses[u],c=null,l=I.Set.complete;c=a.usePipeline?this.pipeline.runString(a.term,{fields:a.fields}):[a.term];for(var f=0;f<c.length;f++){var p=c[f];a.term=p;var h=I.TokenSet.fromClause(a),d=this.tokenSet.intersect(h).toArray();if(0===d.length&&a.presence===I.Query.presence.REQUIRED){for(var y=0;y<a.fields.length;y++){o[R=a.fields[y]]=I.Set.empty}break}for(var v=0;v<d.length;v++){var m=d[v],g=this.invertedIndex[m],x=g._index;for(y=0;y<a.fields.length;y++){var w=g[R=a.fields[y]],b=Object.keys(w),S=m+"/"+R,P=new I.Set(b);if(a.presence==I.Query.presence.REQUIRED&&(l=l.union(P),void 0===o[R]&&(o[R]=I.Set.complete)),a.presence!=I.Query.presence.PROHIBITED){if(n[R].upsert(x,a.boost,(function(e,t){return e+t})),!i[S]){for(var k=0;k<b.length;k++){var E,O=b[k],L=new I.FieldRef(O,R),T=w[O];void 0===(E=r[L])?r[L]=new I.MatchData(m,R,T):E.add(m,R,T)}i[S]=!0}}else void 0===s[R]&&(s[R]=I.Set.empty),s[R]=s[R].union(P)}}}if(a.presence===I.Query.presence.REQUIRED)for(y=0;y<a.fields.length;y++){o[R=a.fields[y]]=o[R].intersect(l)}}var Q=I.Set.complete,j=I.Set.empty;for(u=0;u<this.fields.length;u++){var R;o[R=this.fields[u]]&&(Q=Q.intersect(o[R])),s[R]&&(j=j.union(s[R]))}var _=Object.keys(r),F=[],C=Object.create(null);if(t.isNegated()){_=Object.keys(this.fieldVectors);for(u=0;u<_.length;u++){L=_[u];var N=I.FieldRef.fromString(L);r[L]=new I.MatchData}}for(u=0;u<_.length;u++){var A=(N=I.FieldRef.fromString(_[u])).docRef;if(Q.contains(A)&&!j.contains(A)){var D,M=this.fieldVectors[N],B=n[N.fieldName].similarity(M);if(void 0!==(D=C[A]))D.score+=B,D.matchData.combine(r[N]);else{var V={ref:A,score:B,matchData:r[N]};C[A]=V,F.push(V)}}}return F.sort((function(e,t){return t.score-e.score}))},I.Index.prototype.toJSON=function(){var e=Object.keys(this.invertedIndex).sort().map((function(e){return[e,this.invertedIndex[e]]}),this),t=Object.keys(this.fieldVectors).map((function(e){return[e,this.fieldVectors[e].toJSON()]}),this);return{version:I.version,fields:this.fields,fieldVectors:t,invertedIndex:e,pipeline:this.pipeline.toJSON()}},I.Index.load=function(e){var t={},r={},n=e.fieldVectors,i=Object.create(null),o=e.invertedIndex,s=new I.TokenSet.Builder,u=I.Pipeline.load(e.pipeline);e.version!=I.version&&I.utils.warn("Version mismatch when loading serialised index. Current version of lunr \'"+I.version+"\' does not match serialized index \'"+e.version+"\'");for(var a=0;a<n.length;a++){var c=(f=n[a])[0],l=f[1];r[c]=new I.Vector(l)}for(a=0;a<o.length;a++){var f,p=(f=o[a])[0],h=f[1];s.insert(p),i[p]=h}return s.finish(),t.fields=e.fields,t.fieldVectors=r,t.invertedIndex=i,t.tokenSet=s.root,t.pipeline=u,new I.Index(t)}\n/*!\n * lunr.Builder\n * Copyright (C) 2019 Oliver Nightingale\n */,I.Builder=function(){this._ref="id",this._fields=Object.create(null),this._documents=Object.create(null),this.invertedIndex=Object.create(null),this.fieldTermFrequencies={},this.fieldLengths={},this.tokenizer=I.tokenizer,this.pipeline=new I.Pipeline,this.searchPipeline=new I.Pipeline,this.documentCount=0,this._b=.75,this._k1=1.2,this.termIndex=0,this.metadataWhitelist=[]},I.Builder.prototype.ref=function(e){this._ref=e},I.Builder.prototype.field=function(e,t){if(/\\//.test(e))throw new RangeError("Field \'"+e+"\' contains illegal character \'/\'");this._fields[e]=t||{}},I.Builder.prototype.b=function(e){this._b=e<0?0:e>1?1:e},I.Builder.prototype.k1=function(e){this._k1=e},I.Builder.prototype.add=function(e,t){var r=e[this._ref],n=Object.keys(this._fields);this._documents[r]=t||{},this.documentCount+=1;for(var i=0;i<n.length;i++){var o=n[i],s=this._fields[o].extractor,u=s?s(e):e[o],a=this.tokenizer(u,{fields:[o]}),c=this.pipeline.run(a),l=new I.FieldRef(r,o),f=Object.create(null);this.fieldTermFrequencies[l]=f,this.fieldLengths[l]=0,this.fieldLengths[l]+=c.length;for(var p=0;p<c.length;p++){var h=c[p];if(null==f[h]&&(f[h]=0),f[h]+=1,null==this.invertedIndex[h]){var d=Object.create(null);d._index=this.termIndex,this.termIndex+=1;for(var y=0;y<n.length;y++)d[n[y]]=Object.create(null);this.invertedIndex[h]=d}null==this.invertedIndex[h][o][r]&&(this.invertedIndex[h][o][r]=Object.create(null));for(var v=0;v<this.metadataWhitelist.length;v++){var m=this.metadataWhitelist[v],g=h.metadata[m];null==this.invertedIndex[h][o][r][m]&&(this.invertedIndex[h][o][r][m]=[]),this.invertedIndex[h][o][r][m].push(g)}}}},I.Builder.prototype.calculateAverageFieldLengths=function(){for(var e=Object.keys(this.fieldLengths),t=e.length,r={},n={},i=0;i<t;i++){var o=I.FieldRef.fromString(e[i]),s=o.fieldName;n[s]||(n[s]=0),n[s]+=1,r[s]||(r[s]=0),r[s]+=this.fieldLengths[o]}var u=Object.keys(this._fields);for(i=0;i<u.length;i++){var a=u[i];r[a]=r[a]/n[a]}this.averageFieldLength=r},I.Builder.prototype.createFieldVectors=function(){for(var e={},t=Object.keys(this.fieldTermFrequencies),r=t.length,n=Object.create(null),i=0;i<r;i++){for(var o=I.FieldRef.fromString(t[i]),s=o.fieldName,u=this.fieldLengths[o],a=new I.Vector,c=this.fieldTermFrequencies[o],l=Object.keys(c),f=l.length,p=this._fields[s].boost||1,h=this._documents[o.docRef].boost||1,d=0;d<f;d++){var y,v,m,g=l[d],x=c[g],w=this.invertedIndex[g]._index;void 0===n[g]?(y=I.idf(this.invertedIndex[g],this.documentCount),n[g]=y):y=n[g],v=y*((this._k1+1)*x)/(this._k1*(1-this._b+this._b*(u/this.averageFieldLength[s]))+x),v*=p,v*=h,m=Math.round(1e3*v)/1e3,a.insert(w,m)}e[o]=a}this.fieldVectors=e},I.Builder.prototype.createTokenSet=function(){this.tokenSet=I.TokenSet.fromArray(Object.keys(this.invertedIndex).sort())},I.Builder.prototype.build=function(){return this.calculateAverageFieldLengths(),this.createFieldVectors(),this.createTokenSet(),new I.Index({invertedIndex:this.invertedIndex,fieldVectors:this.fieldVectors,tokenSet:this.tokenSet,fields:Object.keys(this._fields),pipeline:this.searchPipeline})},I.Builder.prototype.use=function(e){var t=Array.prototype.slice.call(arguments,1);t.unshift(this),e.apply(this,t)},I.MatchData=function(e,t,r){for(var n=Object.create(null),i=Object.keys(r||{}),o=0;o<i.length;o++){var s=i[o];n[s]=r[s].slice()}this.metadata=Object.create(null),void 0!==e&&(this.metadata[e]=Object.create(null),this.metadata[e][t]=n)},I.MatchData.prototype.combine=function(e){for(var t=Object.keys(e.metadata),r=0;r<t.length;r++){var n=t[r],i=Object.keys(e.metadata[n]);null==this.metadata[n]&&(this.metadata[n]=Object.create(null));for(var o=0;o<i.length;o++){var s=i[o],u=Object.keys(e.metadata[n][s]);null==this.metadata[n][s]&&(this.metadata[n][s]=Object.create(null));for(var a=0;a<u.length;a++){var c=u[a];null==this.metadata[n][s][c]?this.metadata[n][s][c]=e.metadata[n][s][c]:this.metadata[n][s][c]=this.metadata[n][s][c].concat(e.metadata[n][s][c])}}}},I.MatchData.prototype.add=function(e,t,r){if(!(e in this.metadata))return this.metadata[e]=Object.create(null),void(this.metadata[e][t]=r);if(t in this.metadata[e])for(var n=Object.keys(r),i=0;i<n.length;i++){var o=n[i];o in this.metadata[e][t]?this.metadata[e][t][o]=this.metadata[e][t][o].concat(r[o]):this.metadata[e][t][o]=r[o]}else this.metadata[e][t]=r},I.Query=function(e){this.clauses=[],this.allFields=e},I.Query.wildcard=new String("*"),I.Query.wildcard.NONE=0,I.Query.wildcard.LEADING=1,I.Query.wildcard.TRAILING=2,I.Query.presence={OPTIONAL:1,REQUIRED:2,PROHIBITED:3},I.Query.prototype.clause=function(e){return"fields"in e||(e.fields=this.allFields),"boost"in e||(e.boost=1),"usePipeline"in e||(e.usePipeline=!0),"wildcard"in e||(e.wildcard=I.Query.wildcard.NONE),e.wildcard&I.Query.wildcard.LEADING&&e.term.charAt(0)!=I.Query.wildcard&&(e.term="*"+e.term),e.wildcard&I.Query.wildcard.TRAILING&&e.term.slice(-1)!=I.Query.wildcard&&(e.term=e.term+"*"),"presence"in e||(e.presence=I.Query.presence.OPTIONAL),this.clauses.push(e),this},I.Query.prototype.isNegated=function(){for(var e=0;e<this.clauses.length;e++)if(this.clauses[e].presence!=I.Query.presence.PROHIBITED)return!1;return!0},I.Query.prototype.term=function(e,t){if(Array.isArray(e))return e.forEach((function(e){this.term(e,I.utils.clone(t))}),this),this;var r=t||{};return r.term=e.toString(),this.clause(r),this},I.QueryParseError=function(e,t,r){this.name="QueryParseError",this.message=e,this.start=t,this.end=r},I.QueryParseError.prototype=new Error,I.QueryLexer=function(e){this.lexemes=[],this.str=e,this.length=e.length,this.pos=0,this.start=0,this.escapeCharPositions=[]},I.QueryLexer.prototype.run=function(){for(var e=I.QueryLexer.lexText;e;)e=e(this)},I.QueryLexer.prototype.sliceString=function(){for(var e=[],t=this.start,r=this.pos,n=0;n<this.escapeCharPositions.length;n++)r=this.escapeCharPositions[n],e.push(this.str.slice(t,r)),t=r+1;return e.push(this.str.slice(t,this.pos)),this.escapeCharPositions.length=0,e.join("")},I.QueryLexer.prototype.emit=function(e){this.lexemes.push({type:e,str:this.sliceString(),start:this.start,end:this.pos}),this.start=this.pos},I.QueryLexer.prototype.escapeCharacter=function(){this.escapeCharPositions.push(this.pos-1),this.pos+=1},I.QueryLexer.prototype.next=function(){if(this.pos>=this.length)return I.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},I.QueryLexer.prototype.width=function(){return this.pos-this.start},I.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},I.QueryLexer.prototype.backup=function(){this.pos-=1},I.QueryLexer.prototype.acceptDigitRun=function(){var e,t;do{t=(e=this.next()).charCodeAt(0)}while(t>47&&t<58);e!=I.QueryLexer.EOS&&this.backup()},I.QueryLexer.prototype.more=function(){return this.pos<this.length},I.QueryLexer.EOS="EOS",I.QueryLexer.FIELD="FIELD",I.QueryLexer.TERM="TERM",I.QueryLexer.EDIT_DISTANCE="EDIT_DISTANCE",I.QueryLexer.BOOST="BOOST",I.QueryLexer.PRESENCE="PRESENCE",I.QueryLexer.lexField=function(e){return e.backup(),e.emit(I.QueryLexer.FIELD),e.ignore(),I.QueryLexer.lexText},I.QueryLexer.lexTerm=function(e){if(e.width()>1&&(e.backup(),e.emit(I.QueryLexer.TERM)),e.ignore(),e.more())return I.QueryLexer.lexText},I.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(I.QueryLexer.EDIT_DISTANCE),I.QueryLexer.lexText},I.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(I.QueryLexer.BOOST),I.QueryLexer.lexText},I.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(I.QueryLexer.TERM)},I.QueryLexer.termSeparator=I.tokenizer.separator,I.QueryLexer.lexText=function(e){for(;;){var t=e.next();if(t==I.QueryLexer.EOS)return I.QueryLexer.lexEOS;if(92!=t.charCodeAt(0)){if(":"==t)return I.QueryLexer.lexField;if("~"==t)return e.backup(),e.width()>0&&e.emit(I.QueryLexer.TERM),I.QueryLexer.lexEditDistance;if("^"==t)return e.backup(),e.width()>0&&e.emit(I.QueryLexer.TERM),I.QueryLexer.lexBoost;if("+"==t&&1===e.width())return e.emit(I.QueryLexer.PRESENCE),I.QueryLexer.lexText;if("-"==t&&1===e.width())return e.emit(I.QueryLexer.PRESENCE),I.QueryLexer.lexText;if(t.match(I.QueryLexer.termSeparator))return I.QueryLexer.lexTerm}else e.escapeCharacter()}},I.QueryParser=function(e,t){this.lexer=new I.QueryLexer(e),this.query=t,this.currentClause={},this.lexemeIdx=0},I.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=I.QueryParser.parseClause;e;)e=e(this);return this.query},I.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},I.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},I.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},I.QueryParser.parseClause=function(e){var t=e.peekLexeme();if(null!=t)switch(t.type){case I.QueryLexer.PRESENCE:return I.QueryParser.parsePresence;case I.QueryLexer.FIELD:return I.QueryParser.parseField;case I.QueryLexer.TERM:return I.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+t.type;throw t.str.length>=1&&(r+=" with value \'"+t.str+"\'"),new I.QueryParseError(r,t.start,t.end)}},I.QueryParser.parsePresence=function(e){var t=e.consumeLexeme();if(null!=t){switch(t.str){case"-":e.currentClause.presence=I.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=I.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator\'"+t.str+"\'";throw new I.QueryParseError(r,t.start,t.end)}var n=e.peekLexeme();if(null==n){r="expecting term or field, found nothing";throw new I.QueryParseError(r,t.start,t.end)}switch(n.type){case I.QueryLexer.FIELD:return I.QueryParser.parseField;case I.QueryLexer.TERM:return I.QueryParser.parseTerm;default:r="expecting term or field, found \'"+n.type+"\'";throw new I.QueryParseError(r,n.start,n.end)}}},I.QueryParser.parseField=function(e){var t=e.consumeLexeme();if(null!=t){if(-1==e.query.allFields.indexOf(t.str)){var r=e.query.allFields.map((function(e){return"\'"+e+"\'"})).join(", "),n="unrecognised field \'"+t.str+"\', possible fields: "+r;throw new I.QueryParseError(n,t.start,t.end)}e.currentClause.fields=[t.str];var i=e.peekLexeme();if(null==i){n="expecting term, found nothing";throw new I.QueryParseError(n,t.start,t.end)}switch(i.type){case I.QueryLexer.TERM:return I.QueryParser.parseTerm;default:n="expecting term, found \'"+i.type+"\'";throw new I.QueryParseError(n,i.start,i.end)}}},I.QueryParser.parseTerm=function(e){var t=e.consumeLexeme();if(null!=t){e.currentClause.term=t.str.toLowerCase(),-1!=t.str.indexOf("*")&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(null!=r)switch(r.type){case I.QueryLexer.TERM:return e.nextClause(),I.QueryParser.parseTerm;case I.QueryLexer.FIELD:return e.nextClause(),I.QueryParser.parseField;case I.QueryLexer.EDIT_DISTANCE:return I.QueryParser.parseEditDistance;case I.QueryLexer.BOOST:return I.QueryParser.parseBoost;case I.QueryLexer.PRESENCE:return e.nextClause(),I.QueryParser.parsePresence;default:var n="Unexpected lexeme type \'"+r.type+"\'";throw new I.QueryParseError(n,r.start,r.end)}else e.nextClause()}},I.QueryParser.parseEditDistance=function(e){var t=e.consumeLexeme();if(null!=t){var r=parseInt(t.str,10);if(isNaN(r)){var n="edit distance must be numeric";throw new I.QueryParseError(n,t.start,t.end)}e.currentClause.editDistance=r;var i=e.peekLexeme();if(null!=i)switch(i.type){case I.QueryLexer.TERM:return e.nextClause(),I.QueryParser.parseTerm;case I.QueryLexer.FIELD:return e.nextClause(),I.QueryParser.parseField;case I.QueryLexer.EDIT_DISTANCE:return I.QueryParser.parseEditDistance;case I.QueryLexer.BOOST:return I.QueryParser.parseBoost;case I.QueryLexer.PRESENCE:return e.nextClause(),I.QueryParser.parsePresence;default:n="Unexpected lexeme type \'"+i.type+"\'";throw new I.QueryParseError(n,i.start,i.end)}else e.nextClause()}},I.QueryParser.parseBoost=function(e){var t=e.consumeLexeme();if(null!=t){var r=parseInt(t.str,10);if(isNaN(r)){var n="boost must be numeric";throw new I.QueryParseError(n,t.start,t.end)}e.currentClause.boost=r;var i=e.peekLexeme();if(null!=i)switch(i.type){case I.QueryLexer.TERM:return e.nextClause(),I.QueryParser.parseTerm;case I.QueryLexer.FIELD:return e.nextClause(),I.QueryParser.parseField;case I.QueryLexer.EDIT_DISTANCE:return I.QueryParser.parseEditDistance;case I.QueryLexer.BOOST:return I.QueryParser.parseBoost;case I.QueryLexer.PRESENCE:return e.nextClause(),I.QueryParser.parsePresence;default:n="Unexpected lexeme type \'"+i.type+"\'";throw new I.QueryParseError(n,i.start,i.end)}else e.nextClause()}},void 0===(i="function"==typeof(n=function(){return I})?n.call(t,r,t,e):n)||(e.exports=i)}()},function(e,t,r){var n=r(8),i=r(12),o=r(22);e.exports=n?function(e,t,r){return i.f(e,t,o(1,r))}:function(e,t,r){return e[t]=r,e}},function(e,t){e.exports=function(e){try{return!!e()}catch(e){return!0}}},function(e,t){e.exports=function(e){return"object"==typeof e?null!==e:"function"==typeof e}},function(e,t,r){var n=r(6);e.exports=!n((function(){return 7!=Object.defineProperty({},"a",{get:function(){return 7}}).a}))},function(e,t,r){var n=r(0),i=r(5),o=r(3),s=r(20),u=r(23),a=r(16),c=a.get,l=a.enforce,f=String(String).split("String");(e.exports=function(e,t,r,u){var a=!!u&&!!u.unsafe,c=!!u&&!!u.enumerable,p=!!u&&!!u.noTargetGet;"function"==typeof r&&("string"!=typeof t||o(r,"name")||i(r,"name",t),l(r).source=f.join("string"==typeof t?t:"")),e!==n?(a?!p&&e[t]&&(c=!0):delete e[t],c?e[t]=r:i(e,t,r)):c?e[t]=r:s(t,r)})(Function.prototype,"toString",(function(){return"function"==typeof this&&c(this).source||u(this)}))},function(e,t,r){var n=r(40),i=r(0),o=function(e){return"function"==typeof e?e:void 0};e.exports=function(e,t){return arguments.length<2?o(n[e])||o(i[e]):n[e]&&n[e][t]||i[e]&&i[e][t]}},function(e,t){e.exports=!1},function(e,t,r){var n=r(8),i=r(34),o=r(2),s=r(35),u=Object.defineProperty;t.f=n?u:function(e,t,r){if(o(e),t=s(t,!0),o(r),i)try{return u(e,t,r)}catch(e){}if("get"in r||"set"in r)throw TypeError("Accessors not supported");return"value"in r&&(e[t]=r.value),e}},function(e,t){var r={}.toString;e.exports=function(e){return r.call(e).slice(8,-1)}},function(e,t){e.exports={}},function(e,t){e.exports=function(e){if("function"!=typeof e)throw TypeError(String(e)+" is not a function");return e}},function(e,t,r){var n,i,o,s=r(61),u=r(0),a=r(7),c=r(5),l=r(3),f=r(24),p=r(25),h=u.WeakMap;if(s){var d=new h,y=d.get,v=d.has,m=d.set;n=function(e,t){return m.call(d,e,t),t},i=function(e){return y.call(d,e)||{}},o=function(e){return v.call(d,e)}}else{var g=f("state");p[g]=!0,n=function(e,t){return c(e,g,t),t},i=function(e){return l(e,g)?e[g]:{}},o=function(e){return l(e,g)}}e.exports={set:n,get:i,has:o,enforce:function(e){return o(e)?i(e):n(e,{})},getterFor:function(e){return function(t){var r;if(!a(t)||(r=i(t)).type!==e)throw TypeError("Incompatible receiver, "+e+" required");return r}}}},function(e,t,r){var n=r(0),i=r(28).f,o=r(5),s=r(9),u=r(20),a=r(67),c=r(43);e.exports=function(e,t){var r,l,f,p,h,d=e.target,y=e.global,v=e.stat;if(r=y?n:v?n[d]||u(d,{}):(n[d]||{}).prototype)for(l in t){if(p=t[l],f=e.noTargetGet?(h=i(r,l))&&h.value:r[l],!c(y?l:d+(v?".":"#")+l,e.forced)&&void 0!==f){if(typeof p==typeof f)continue;a(p,f)}(e.sham||f&&f.sham)&&o(p,"sham",!0),s(r,l,p,e)}}},function(e,t,r){var n=r(66),i=r(27);e.exports=function(e){return n(i(e))}},function(e,t,r){var n={};n[r(1)("toStringTag")]="z",e.exports="[object z]"===String(n)},function(e,t,r){var n=r(0),i=r(5);e.exports=function(e,t){try{i(n,e,t)}catch(r){n[e]=t}return t}},function(e,t,r){var n=r(0),i=r(7),o=n.document,s=i(o)&&i(o.createElement);e.exports=function(e){return s?o.createElement(e):{}}},function(e,t){e.exports=function(e,t){return{enumerable:!(1&e),configurable:!(2&e),writable:!(4&e),value:t}}},function(e,t,r){var n=r(33),i=Function.toString;"function"!=typeof n.inspectSource&&(n.inspectSource=function(e){return i.call(e)}),e.exports=n.inspectSource},function(e,t,r){var n=r(32),i=r(36),o=n("keys");e.exports=function(e){return o[e]||(o[e]=i(e))}},function(e,t){e.exports={}},function(e,t){var r=Math.ceil,n=Math.floor;e.exports=function(e){return isNaN(e=+e)?0:(e>0?n:r)(e)}},function(e,t){e.exports=function(e){if(null==e)throw TypeError("Can\'t call method on "+e);return e}},function(e,t,r){var n=r(8),i=r(65),o=r(22),s=r(18),u=r(35),a=r(3),c=r(34),l=Object.getOwnPropertyDescriptor;t.f=n?l:function(e,t){if(e=s(e),t=u(t,!0),c)try{return l(e,t)}catch(e){}if(a(e,t))return o(!i.f.call(e,t),e[t])}},function(e,t){e.exports=["constructor","hasOwnProperty","isPrototypeOf","propertyIsEnumerable","toLocaleString","toString","valueOf"]},function(e,t,r){var n=r(12).f,i=r(3),o=r(1)("toStringTag");e.exports=function(e,t,r){e&&!i(e=r?e:e.prototype,o)&&n(e,o,{configurable:!0,value:t})}},function(e,t,r){"use strict";var n=r(15),i=function(e){var t,r;this.promise=new e((function(e,n){if(void 0!==t||void 0!==r)throw TypeError("Bad Promise constructor");t=e,r=n})),this.resolve=n(t),this.reject=n(r)};e.exports.f=function(e){return new i(e)}},function(e,t,r){var n=r(11),i=r(33);(e.exports=function(e,t){return i[e]||(i[e]=void 0!==t?t:{})})("versions",[]).push({version:"3.5.0",mode:n?"pure":"global",copyright:"© 2019 Denis Pushkarev (zloirock.ru)"})},function(e,t,r){var n=r(0),i=r(20),o=n["__core-js_shared__"]||i("__core-js_shared__",{});e.exports=o},function(e,t,r){var n=r(8),i=r(6),o=r(21);e.exports=!n&&!i((function(){return 7!=Object.defineProperty(o("div"),"a",{get:function(){return 7}}).a}))},function(e,t,r){var n=r(7);e.exports=function(e,t){if(!n(e))return e;var r,i;if(t&&"function"==typeof(r=e.toString)&&!n(i=r.call(e)))return i;if("function"==typeof(r=e.valueOf)&&!n(i=r.call(e)))return i;if(!t&&"function"==typeof(r=e.toString)&&!n(i=r.call(e)))return i;throw TypeError("Can\'t convert object to primitive value")}},function(e,t){var r=0,n=Math.random();e.exports=function(e){return"Symbol("+String(void 0===e?"":e)+")_"+(++r+n).toString(36)}},function(e,t,r){var n=r(6);e.exports=!!Object.getOwnPropertySymbols&&!n((function(){return!String(Symbol())}))},function(e,t,r){var n=r(19),i=r(13),o=r(1)("toStringTag"),s="Arguments"==i(function(){return arguments}());e.exports=n?i:function(e){var t,r,n;return void 0===e?"Undefined":null===e?"Null":"string"==typeof(r=function(e,t){try{return e[t]}catch(e){}}(t=Object(e),o))?r:s?i(t):"Object"==(n=i(t))&&"function"==typeof t.callee?"Arguments":n}},function(e,t,r){"use strict";var n=r(17),i=r(73),o=r(45),s=r(78),u=r(30),a=r(5),c=r(9),l=r(1),f=r(11),p=r(14),h=r(44),d=h.IteratorPrototype,y=h.BUGGY_SAFARI_ITERATORS,v=l("iterator"),m=function(){return this};e.exports=function(e,t,r,l,h,g,x){i(r,t,l);var w,b,S,P=function(e){if(e===h&&T)return T;if(!y&&e in O)return O[e];switch(e){case"keys":case"values":case"entries":return function(){return new r(this,e)}}return function(){return new r(this)}},k=t+" Iterator",E=!1,O=e.prototype,L=O[v]||O["@@iterator"]||h&&O[h],T=!y&&L||P(h),Q="Array"==t&&O.entries||L;if(Q&&(w=o(Q.call(new e)),d!==Object.prototype&&w.next&&(f||o(w)===d||(s?s(w,d):"function"!=typeof w[v]&&a(w,v,m)),u(w,k,!0,!0),f&&(p[k]=m))),"values"==h&&L&&"values"!==L.name&&(E=!0,T=function(){return L.call(this)}),f&&!x||O[v]===T||a(O,v,T),p[t]=T,h)if(b={values:P("values"),keys:g?T:P("keys"),entries:P("entries")},x)for(S in b)!y&&!E&&S in O||c(O,S,b[S]);else n({target:t,proto:!0,forced:y||E},b);return b}},function(e,t,r){var n=r(0);e.exports=n},function(e,t,r){var n=r(3),i=r(18),o=r(70).indexOf,s=r(25);e.exports=function(e,t){var r,u=i(e),a=0,c=[];for(r in u)!n(s,r)&&n(u,r)&&c.push(r);for(;t.length>a;)n(u,r=t[a++])&&(~o(c,r)||c.push(r));return c}},function(e,t,r){var n=r(26),i=Math.min;e.exports=function(e){return e>0?i(n(e),9007199254740991):0}},function(e,t,r){var n=r(6),i=/#|\\.prototype\\./,o=function(e,t){var r=u[s(e)];return r==c||r!=a&&("function"==typeof t?n(t):!!t)},s=o.normalize=function(e){return String(e).replace(i,".").toLowerCase()},u=o.data={},a=o.NATIVE="N",c=o.POLYFILL="P";e.exports=o},function(e,t,r){"use strict";var n,i,o,s=r(45),u=r(5),a=r(3),c=r(1),l=r(11),f=c("iterator"),p=!1;[].keys&&("next"in(o=[].keys())?(i=s(s(o)))!==Object.prototype&&(n=i):p=!0),null==n&&(n={}),l||a(n,f)||u(n,f,(function(){return this})),e.exports={IteratorPrototype:n,BUGGY_SAFARI_ITERATORS:p}},function(e,t,r){var n=r(3),i=r(74),o=r(24),s=r(75),u=o("IE_PROTO"),a=Object.prototype;e.exports=s?Object.getPrototypeOf:function(e){return e=i(e),n(e,u)?e[u]:"function"==typeof e.constructor&&e instanceof e.constructor?e.constructor.prototype:e instanceof Object?a:null}},function(e,t,r){var n=r(2),i=r(76),o=r(29),s=r(25),u=r(47),a=r(21),c=r(24)("IE_PROTO"),l=function(){},f=function(){var e,t=a("iframe"),r=o.length;for(t.style.display="none",u.appendChild(t),t.src=String("javascript:"),(e=t.contentWindow.document).open(),e.write("<script>document.F=Object<\\/script>"),e.close(),f=e.F;r--;)delete f.prototype[o[r]];return f()};e.exports=Object.create||function(e,t){var r;return null!==e?(l.prototype=n(e),r=new l,l.prototype=null,r[c]=e):r=f(),void 0===t?r:i(r,t)},s[c]=!0},function(e,t,r){var n=r(10);e.exports=n("document","documentElement")},function(e,t,r){var n=r(0);e.exports=n.Promise},function(e,t,r){var n=r(2),i=r(88),o=r(42),s=r(50),u=r(89),a=r(90),c=function(e,t){this.stopped=e,this.result=t};(e.exports=function(e,t,r,l,f){var p,h,d,y,v,m,g,x=s(t,r,l?2:1);if(f)p=e;else{if("function"!=typeof(h=u(e)))throw TypeError("Target is not iterable");if(i(h)){for(d=0,y=o(e.length);y>d;d++)if((v=l?x(n(g=e[d])[0],g[1]):x(e[d]))&&v instanceof c)return v;return new c(!1)}p=h.call(e)}for(m=p.next;!(g=m.call(p)).done;)if("object"==typeof(v=a(p,x,g.value,l))&&v&&v instanceof c)return v;return new c(!1)}).stop=function(e){return new c(!0,e)}},function(e,t,r){var n=r(15);e.exports=function(e,t,r){if(n(e),void 0===t)return e;switch(r){case 0:return function(){return e.call(t)};case 1:return function(r){return e.call(t,r)};case 2:return function(r,n){return e.call(t,r,n)};case 3:return function(r,n,i){return e.call(t,r,n,i)}}return function(){return e.apply(t,arguments)}}},function(e,t,r){var n=r(2),i=r(15),o=r(1)("species");e.exports=function(e,t){var r,s=n(e).constructor;return void 0===s||null==(r=n(s)[o])?t:i(r)}},function(e,t,r){var n,i,o,s=r(0),u=r(6),a=r(13),c=r(50),l=r(47),f=r(21),p=r(53),h=s.location,d=s.setImmediate,y=s.clearImmediate,v=s.process,m=s.MessageChannel,g=s.Dispatch,x=0,w={},b=function(e){if(w.hasOwnProperty(e)){var t=w[e];delete w[e],t()}},S=function(e){return function(){b(e)}},P=function(e){b(e.data)},k=function(e){s.postMessage(e+"",h.protocol+"//"+h.host)};d&&y||(d=function(e){for(var t=[],r=1;arguments.length>r;)t.push(arguments[r++]);return w[++x]=function(){("function"==typeof e?e:Function(e)).apply(void 0,t)},n(x),x},y=function(e){delete w[e]},"process"==a(v)?n=function(e){v.nextTick(S(e))}:g&&g.now?n=function(e){g.now(S(e))}:m&&!p?(o=(i=new m).port2,i.port1.onmessage=P,n=c(o.postMessage,o,1)):!s.addEventListener||"function"!=typeof postMessage||s.importScripts||u(k)?n="onreadystatechange"in f("script")?function(e){l.appendChild(f("script")).onreadystatechange=function(){l.removeChild(this),b(e)}}:function(e){setTimeout(S(e),0)}:(n=k,s.addEventListener("message",P,!1))),e.exports={set:d,clear:y}},function(e,t,r){var n=r(54);e.exports=/(iphone|ipod|ipad).*applewebkit/i.test(n)},function(e,t,r){var n=r(10);e.exports=n("navigator","userAgent")||""},function(e,t,r){var n=r(2),i=r(7),o=r(31);e.exports=function(e,t){if(n(e),i(t)&&t.constructor===e)return t;var r=o.f(e);return(0,r.resolve)(t),r.promise}},function(e,t){e.exports=function(e){try{return{error:!1,value:e()}}catch(e){return{error:!0,value:e}}}},function(e,t,r){r(58),r(63),r(80),r(84),r(95),r(96);var n=r(40);e.exports=n.Promise},function(e,t,r){var n=r(19),i=r(9),o=r(62);n||i(Object.prototype,"toString",o,{unsafe:!0})},function(e,t){var r;r=function(){return this}();try{r=r||new Function("return this")()}catch(e){"object"==typeof window&&(r=window)}e.exports=r},function(e,t,r){var n=r(37);e.exports=n&&!Symbol.sham&&"symbol"==typeof Symbol()},function(e,t,r){var n=r(0),i=r(23),o=n.WeakMap;e.exports="function"==typeof o&&/native code/.test(i(o))},function(e,t,r){"use strict";var n=r(19),i=r(38);e.exports=n?{}.toString:function(){return"[object "+i(this)+"]"}},function(e,t,r){"use strict";var n=r(64).charAt,i=r(16),o=r(39),s=i.set,u=i.getterFor("String Iterator");o(String,"String",(function(e){s(this,{type:"String Iterator",string:String(e),index:0})}),(function(){var e,t=u(this),r=t.string,i=t.index;return i>=r.length?{value:void 0,done:!0}:(e=n(r,i),t.index+=e.length,{value:e,done:!1})}))},function(e,t,r){var n=r(26),i=r(27),o=function(e){return function(t,r){var o,s,u=String(i(t)),a=n(r),c=u.length;return a<0||a>=c?e?"":void 0:(o=u.charCodeAt(a))<55296||o>56319||a+1===c||(s=u.charCodeAt(a+1))<56320||s>57343?e?u.charAt(a):o:e?u.slice(a,a+2):s-56320+(o-55296<<10)+65536}};e.exports={codeAt:o(!1),charAt:o(!0)}},function(e,t,r){"use strict";var n={}.propertyIsEnumerable,i=Object.getOwnPropertyDescriptor,o=i&&!n.call({1:2},1);t.f=o?function(e){var t=i(this,e);return!!t&&t.enumerable}:n},function(e,t,r){var n=r(6),i=r(13),o="".split;e.exports=n((function(){return!Object("z").propertyIsEnumerable(0)}))?function(e){return"String"==i(e)?o.call(e,""):Object(e)}:Object},function(e,t,r){var n=r(3),i=r(68),o=r(28),s=r(12);e.exports=function(e,t){for(var r=i(t),u=s.f,a=o.f,c=0;c<r.length;c++){var l=r[c];n(e,l)||u(e,l,a(t,l))}}},function(e,t,r){var n=r(10),i=r(69),o=r(72),s=r(2);e.exports=n("Reflect","ownKeys")||function(e){var t=i.f(s(e)),r=o.f;return r?t.concat(r(e)):t}},function(e,t,r){var n=r(41),i=r(29).concat("length","prototype");t.f=Object.getOwnPropertyNames||function(e){return n(e,i)}},function(e,t,r){var n=r(18),i=r(42),o=r(71),s=function(e){return function(t,r,s){var u,a=n(t),c=i(a.length),l=o(s,c);if(e&&r!=r){for(;c>l;)if((u=a[l++])!=u)return!0}else for(;c>l;l++)if((e||l in a)&&a[l]===r)return e||l||0;return!e&&-1}};e.exports={includes:s(!0),indexOf:s(!1)}},function(e,t,r){var n=r(26),i=Math.max,o=Math.min;e.exports=function(e,t){var r=n(e);return r<0?i(r+t,0):o(r,t)}},function(e,t){t.f=Object.getOwnPropertySymbols},function(e,t,r){"use strict";var n=r(44).IteratorPrototype,i=r(46),o=r(22),s=r(30),u=r(14),a=function(){return this};e.exports=function(e,t,r){var c=t+" Iterator";return e.prototype=i(n,{next:o(1,r)}),s(e,c,!1,!0),u[c]=a,e}},function(e,t,r){var n=r(27);e.exports=function(e){return Object(n(e))}},function(e,t,r){var n=r(6);e.exports=!n((function(){function e(){}return e.prototype.constructor=null,Object.getPrototypeOf(new e)!==e.prototype}))},function(e,t,r){var n=r(8),i=r(12),o=r(2),s=r(77);e.exports=n?Object.defineProperties:function(e,t){o(e);for(var r,n=s(t),u=n.length,a=0;u>a;)i.f(e,r=n[a++],t[r]);return e}},function(e,t,r){var n=r(41),i=r(29);e.exports=Object.keys||function(e){return n(e,i)}},function(e,t,r){var n=r(2),i=r(79);e.exports=Object.setPrototypeOf||("__proto__"in{}?function(){var e,t=!1,r={};try{(e=Object.getOwnPropertyDescriptor(Object.prototype,"__proto__").set).call(r,[]),t=r instanceof Array}catch(e){}return function(r,o){return n(r),i(o),t?e.call(r,o):r.__proto__=o,r}}():void 0)},function(e,t,r){var n=r(7);e.exports=function(e){if(!n(e)&&null!==e)throw TypeError("Can\'t set "+String(e)+" as a prototype");return e}},function(e,t,r){var n=r(0),i=r(81),o=r(82),s=r(5),u=r(1),a=u("iterator"),c=u("toStringTag"),l=o.values;for(var f in i){var p=n[f],h=p&&p.prototype;if(h){if(h[a]!==l)try{s(h,a,l)}catch(e){h[a]=l}if(h[c]||s(h,c,f),i[f])for(var d in o)if(h[d]!==o[d])try{s(h,d,o[d])}catch(e){h[d]=o[d]}}}},function(e,t){e.exports={CSSRuleList:0,CSSStyleDeclaration:0,CSSValueList:0,ClientRectList:0,DOMRectList:0,DOMStringList:0,DOMTokenList:1,DataTransferItemList:0,FileList:0,HTMLAllCollection:0,HTMLCollection:0,HTMLFormElement:0,HTMLSelectElement:0,MediaList:0,MimeTypeArray:0,NamedNodeMap:0,NodeList:1,PaintRequestList:0,Plugin:0,PluginArray:0,SVGLengthList:0,SVGNumberList:0,SVGPathSegList:0,SVGPointList:0,SVGStringList:0,SVGTransformList:0,SourceBufferList:0,StyleSheetList:0,TextTrackCueList:0,TextTrackList:0,TouchList:0}},function(e,t,r){"use strict";var n=r(18),i=r(83),o=r(14),s=r(16),u=r(39),a=s.set,c=s.getterFor("Array Iterator");e.exports=u(Array,"Array",(function(e,t){a(this,{type:"Array Iterator",target:n(e),index:0,kind:t})}),(function(){var e=c(this),t=e.target,r=e.kind,n=e.index++;return!t||n>=t.length?(e.target=void 0,{value:void 0,done:!0}):"keys"==r?{value:n,done:!1}:"values"==r?{value:t[n],done:!1}:{value:[n,t[n]],done:!1}}),"values"),o.Arguments=o.Array,i("keys"),i("values"),i("entries")},function(e,t,r){var n=r(1),i=r(46),o=r(5),s=n("unscopables"),u=Array.prototype;null==u[s]&&o(u,s,i(null)),e.exports=function(e){u[s][e]=!0}},function(e,t,r){"use strict";var n,i,o,s,u=r(17),a=r(11),c=r(0),l=r(10),f=r(48),p=r(9),h=r(85),d=r(30),y=r(86),v=r(7),m=r(15),g=r(87),x=r(13),w=r(23),b=r(49),S=r(91),P=r(51),k=r(52).set,E=r(92),O=r(55),L=r(93),T=r(31),Q=r(56),j=r(16),I=r(43),R=r(1),_=r(94),F=R("species"),C="Promise",N=j.get,A=j.set,D=j.getterFor(C),M=f,B=c.TypeError,V=c.document,z=c.process,$=l("fetch"),W=T.f,q=W,G="process"==x(z),U=!!(V&&V.createEvent&&c.dispatchEvent),H=I(C,(function(){if(!(w(M)!==String(M))){if(66===_)return!0;if(!G&&"function"!=typeof PromiseRejectionEvent)return!0}if(a&&!M.prototype.finally)return!0;if(_>=51&&/native code/.test(M))return!1;var e=M.resolve(1),t=function(e){e((function(){}),(function(){}))};return(e.constructor={})[F]=t,!(e.then((function(){}))instanceof t)})),J=H||!S((function(e){M.all(e).catch((function(){}))})),Y=function(e){var t;return!(!v(e)||"function"!=typeof(t=e.then))&&t},K=function(e,t,r){if(!t.notified){t.notified=!0;var n=t.reactions;E((function(){for(var i=t.value,o=1==t.state,s=0;n.length>s;){var u,a,c,l=n[s++],f=o?l.ok:l.fail,p=l.resolve,h=l.reject,d=l.domain;try{f?(o||(2===t.rejection&&te(e,t),t.rejection=1),!0===f?u=i:(d&&d.enter(),u=f(i),d&&(d.exit(),c=!0)),u===l.promise?h(B("Promise-chain cycle")):(a=Y(u))?a.call(u,p,h):p(u)):h(i)}catch(e){d&&!c&&d.exit(),h(e)}}t.reactions=[],t.notified=!1,r&&!t.rejection&&Z(e,t)}))}},X=function(e,t,r){var n,i;U?((n=V.createEvent("Event")).promise=t,n.reason=r,n.initEvent(e,!1,!0),c.dispatchEvent(n)):n={promise:t,reason:r},(i=c["on"+e])?i(n):"unhandledrejection"===e&&L("Unhandled promise rejection",r)},Z=function(e,t){k.call(c,(function(){var r,n=t.value;if(ee(t)&&(r=Q((function(){G?z.emit("unhandledRejection",n,e):X("unhandledrejection",e,n)})),t.rejection=G||ee(t)?2:1,r.error))throw r.value}))},ee=function(e){return 1!==e.rejection&&!e.parent},te=function(e,t){k.call(c,(function(){G?z.emit("rejectionHandled",e):X("rejectionhandled",e,t.value)}))},re=function(e,t,r,n){return function(i){e(t,r,i,n)}},ne=function(e,t,r,n){t.done||(t.done=!0,n&&(t=n),t.value=r,t.state=2,K(e,t,!0))},ie=function(e,t,r,n){if(!t.done){t.done=!0,n&&(t=n);try{if(e===r)throw B("Promise can\'t be resolved itself");var i=Y(r);i?E((function(){var n={done:!1};try{i.call(r,re(ie,e,n,t),re(ne,e,n,t))}catch(r){ne(e,n,r,t)}})):(t.value=r,t.state=1,K(e,t,!1))}catch(r){ne(e,{done:!1},r,t)}}};H&&(M=function(e){g(this,M,C),m(e),n.call(this);var t=N(this);try{e(re(ie,this,t),re(ne,this,t))}catch(e){ne(this,t,e)}},(n=function(e){A(this,{type:C,done:!1,notified:!1,parent:!1,reactions:[],rejection:!1,state:0,value:void 0})}).prototype=h(M.prototype,{then:function(e,t){var r=D(this),n=W(P(this,M));return n.ok="function"!=typeof e||e,n.fail="function"==typeof t&&t,n.domain=G?z.domain:void 0,r.parent=!0,r.reactions.push(n),0!=r.state&&K(this,r,!1),n.promise},catch:function(e){return this.then(void 0,e)}}),i=function(){var e=new n,t=N(e);this.promise=e,this.resolve=re(ie,e,t),this.reject=re(ne,e,t)},T.f=W=function(e){return e===M||e===o?new i(e):q(e)},a||"function"!=typeof f||(s=f.prototype.then,p(f.prototype,"then",(function(e,t){var r=this;return new M((function(e,t){s.call(r,e,t)})).then(e,t)}),{unsafe:!0}),"function"==typeof $&&u({global:!0,enumerable:!0,forced:!0},{fetch:function(e){return O(M,$.apply(c,arguments))}}))),u({global:!0,wrap:!0,forced:H},{Promise:M}),d(M,C,!1,!0),y(C),o=l(C),u({target:C,stat:!0,forced:H},{reject:function(e){var t=W(this);return t.reject.call(void 0,e),t.promise}}),u({target:C,stat:!0,forced:a||H},{resolve:function(e){return O(a&&this===o?M:this,e)}}),u({target:C,stat:!0,forced:J},{all:function(e){var t=this,r=W(t),n=r.resolve,i=r.reject,o=Q((function(){var r=m(t.resolve),o=[],s=0,u=1;b(e,(function(e){var a=s++,c=!1;o.push(void 0),u++,r.call(t,e).then((function(e){c||(c=!0,o[a]=e,--u||n(o))}),i)})),--u||n(o)}));return o.error&&i(o.value),r.promise},race:function(e){var t=this,r=W(t),n=r.reject,i=Q((function(){var i=m(t.resolve);b(e,(function(e){i.call(t,e).then(r.resolve,n)}))}));return i.error&&n(i.value),r.promise}})},function(e,t,r){var n=r(9);e.exports=function(e,t,r){for(var i in t)n(e,i,t[i],r);return e}},function(e,t,r){"use strict";var n=r(10),i=r(12),o=r(1),s=r(8),u=o("species");e.exports=function(e){var t=n(e),r=i.f;s&&t&&!t[u]&&r(t,u,{configurable:!0,get:function(){return this}})}},function(e,t){e.exports=function(e,t,r){if(!(e instanceof t))throw TypeError("Incorrect "+(r?r+" ":"")+"invocation");return e}},function(e,t,r){var n=r(1),i=r(14),o=n("iterator"),s=Array.prototype;e.exports=function(e){return void 0!==e&&(i.Array===e||s[o]===e)}},function(e,t,r){var n=r(38),i=r(14),o=r(1)("iterator");e.exports=function(e){if(null!=e)return e[o]||e["@@iterator"]||i[n(e)]}},function(e,t,r){var n=r(2);e.exports=function(e,t,r,i){try{return i?t(n(r)[0],r[1]):t(r)}catch(t){var o=e.return;throw void 0!==o&&n(o.call(e)),t}}},function(e,t,r){var n=r(1)("iterator"),i=!1;try{var o=0,s={next:function(){return{done:!!o++}},return:function(){i=!0}};s[n]=function(){return this},Array.from(s,(function(){throw 2}))}catch(e){}e.exports=function(e,t){if(!t&&!i)return!1;var r=!1;try{var o={};o[n]=function(){return{next:function(){return{done:r=!0}}}},e(o)}catch(e){}return r}},function(e,t,r){var n,i,o,s,u,a,c,l,f=r(0),p=r(28).f,h=r(13),d=r(52).set,y=r(53),v=f.MutationObserver||f.WebKitMutationObserver,m=f.process,g=f.Promise,x="process"==h(m),w=p(f,"queueMicrotask"),b=w&&w.value;b||(n=function(){var e,t;for(x&&(e=m.domain)&&e.exit();i;){t=i.fn,i=i.next;try{t()}catch(e){throw i?s():o=void 0,e}}o=void 0,e&&e.enter()},x?s=function(){m.nextTick(n)}:v&&!y?(u=!0,a=document.createTextNode(""),new v(n).observe(a,{characterData:!0}),s=function(){a.data=u=!u}):g&&g.resolve?(c=g.resolve(void 0),l=c.then,s=function(){l.call(c,n)}):s=function(){d.call(f,n)}),e.exports=b||function(e){var t={fn:e,next:void 0};o&&(o.next=t),i||(i=t,s()),o=t}},function(e,t,r){var n=r(0);e.exports=function(e,t){var r=n.console;r&&r.error&&(1===arguments.length?r.error(e):r.error(e,t))}},function(e,t,r){var n,i,o=r(0),s=r(54),u=o.process,a=u&&u.versions,c=a&&a.v8;c?i=(n=c.split("."))[0]+n[1]:s&&(!(n=s.match(/Edge\\/(\\d+)/))||n[1]>=74)&&(n=s.match(/Chrome\\/(\\d+)/))&&(i=n[1]),e.exports=i&&+i},function(e,t,r){"use strict";var n=r(17),i=r(15),o=r(31),s=r(56),u=r(49);n({target:"Promise",stat:!0},{allSettled:function(e){var t=this,r=o.f(t),n=r.resolve,a=r.reject,c=s((function(){var r=i(t.resolve),o=[],s=0,a=1;u(e,(function(e){var i=s++,u=!1;o.push(void 0),a++,r.call(t,e).then((function(e){u||(u=!0,o[i]={status:"fulfilled",value:e},--a||n(o))}),(function(e){u||(u=!0,o[i]={status:"rejected",reason:e},--a||n(o))}))})),--a||n(o)}));return c.error&&a(c.value),r.promise}})},function(e,t,r){"use strict";var n=r(17),i=r(11),o=r(48),s=r(6),u=r(10),a=r(51),c=r(55),l=r(9);n({target:"Promise",proto:!0,real:!0,forced:!!o&&s((function(){o.prototype.finally.call({then:function(){}},(function(){}))}))},{finally:function(e){var t=a(this,u("Promise")),r="function"==typeof e;return this.then(r?function(r){return c(t,e()).then((function(){return r}))}:e,r?function(r){return c(t,e()).then((function(){throw r}))}:e)}}),i||"function"!=typeof o||o.prototype.finally||l(o.prototype,"finally",u("Promise").prototype.finally)},function(e,t,r){"use strict";r.r(t);function n(e,t,r,n){return new(r||(r=Promise))((function(i,o){function s(e){try{a(n.next(e))}catch(e){o(e)}}function u(e){try{a(n.throw(e))}catch(e){o(e)}}function a(e){e.done?i(e.value):new r((function(t){t(e.value)})).then(s,u)}a((n=n.apply(e,t||[])).next())}))}function i(e,t){var r,n,i,o,s={label:0,sent:function(){if(1&i[0])throw i[1];return i[1]},trys:[],ops:[]};return o={next:u(0),throw:u(1),return:u(2)},"function"==typeof Symbol&&(o[Symbol.iterator]=function(){return this}),o;function u(o){return function(u){return function(o){if(r)throw new TypeError("Generator is already executing.");for(;s;)try{if(r=1,n&&(i=2&o[0]?n.return:o[0]?n.throw||((i=n.return)&&i.call(n),0):n.next)&&!(i=i.call(n,o[1])).done)return i;switch(n=0,i&&(o=[2&o[0],i.value]),o[0]){case 0:case 1:i=o;break;case 4:return s.label++,{value:o[1],done:!1};case 5:s.label++,n=o[1],o=[0];continue;case 7:o=s.ops.pop(),s.trys.pop();continue;default:if(!(i=(i=s.trys).length>0&&i[i.length-1])&&(6===o[0]||2===o[0])){s=0;continue}if(3===o[0]&&(!i||o[1]>i[0]&&o[1]<i[3])){s.label=o[1];break}if(6===o[0]&&s.label<i[1]){s.label=i[1],i=o;break}if(i&&s.label<i[2]){s.label=i[2],s.ops.push(o);break}i[2]&&s.ops.pop(),s.trys.pop();continue}o=t.call(e,s)}catch(e){o=[6,e],n=0}finally{r=i=0}if(5&o[0])throw o[1];return{value:o[0]?o[1]:void 0,done:!0}}([o,u])}}}var o=r(4);r.d(t,"add",(function(){return p})),r.d(t,"done",(function(){return h})),r.d(t,"toJS",(function(){return d})),r.d(t,"load",(function(){return y})),r.d(t,"search",(function(){return v}));try{r(57)}catch(e){}var s=function(){this.add=p,this.done=h,this.search=v,this.toJS=d,this.load=y},u=(t.default=s,[]),a=function(){throw new Error("Should not be called")},c=new Promise((function(e){a=e}));o.tokenizer.separator=/\\s+/;var l=new o.Builder;l.field("title"),l.field("description"),l.ref("ref"),l.pipeline.add(o.trimmer,o.stopWordFilter,o.stemmer);var f=function(e){return"*"+o.stemmer(new o.Token(e,{}))+"*"};function p(e,t,r){var n=u.push(r)-1,i={title:e.toLowerCase(),description:t.toLowerCase(),ref:n};l.add(i)}function h(){return n(this,void 0,void 0,(function(){return i(this,(function(e){return a(l.build()),[2]}))}))}function d(){return n(this,void 0,void 0,(function(){var e;return i(this,(function(t){switch(t.label){case 0:return e={store:u},[4,c];case 1:return[2,(e.index=t.sent().toJSON(),e)]}}))}))}function y(e){return n(this,void 0,void 0,(function(){return i(this,(function(t){return u=e.store,a(o.Index.load(e.index)),[2]}))}))}function v(e,t){return void 0===t&&(t=0),n(this,void 0,void 0,(function(){var r;return i(this,(function(n){switch(n.label){case 0:return 0===e.trim().length?[2,[]]:[4,c];case 1:return r=n.sent().query((function(t){e.trim().toLowerCase().split(/\\s+/).forEach((function(e){var r=f(e);t.term(r,{})}))})),t>0&&(r=r.slice(0,t)),[2,r.map((function(e){return{meta:u[e.ref],score:e.score}}))]}}))}))}addEventListener("message",(function(e){var r,n=e.data,i=n.type,o=n.method,s=n.id,u=n.params;"RPC"===i&&o&&((r=t[o])?Promise.resolve().then((function(){return r.apply(t,u)})):Promise.reject("No such method")).then((function(e){postMessage({type:"RPC",id:s,result:e})})).catch((function(e){var t={message:e};e.stack&&(t.message=e.message,t.stack=e.stack,t.name=e.name),postMessage({type:"RPC",id:s,error:t})}))})),postMessage({type:"RPC",method:"ready"})}]);\n//# sourceMappingURL=7863b126d2fe2d678e9e.worker.js.map'])),{name:"[hash].worker.js"});return r(e,o),e}},function(e,t){e.exports=function(e,t){var n=0,r={};e.addEventListener("message",(function(t){var n=t.data;if("RPC"===n.type)if(n.id){var o=r[n.id];o&&(delete r[n.id],n.error?o[1](Object.assign(Error(n.error.message),n.error)):o[0](n.result))}else{var i=document.createEvent("Event");i.initEvent(n.method,!1,!1),i.data=n.params,e.dispatchEvent(i)}})),t.forEach((function(t){e[t]=function(){for(var o=[],i=arguments.length;i--;)o[i]=arguments[i];return new Promise((function(i,a){var s=++n;r[s]=[i,a],e.postMessage({type:"RPC",id:s,method:t,params:o})}))}}))}},function(e,t,n){"use strict";e.exports=function(e){var t=[];return t.toString=function(){return this.map((function(t){var n=function(e,t){var n=e[1]||"",r=e[3];if(!r)return n;if(t&&"function"==typeof btoa){var o=(a=r,s=btoa(unescape(encodeURIComponent(JSON.stringify(a)))),l="sourceMappingURL=data:application/json;charset=utf-8;base64,".concat(s),"/*# ".concat(l," */")),i=r.sources.map((function(e){return"/*# sourceURL=".concat(r.sourceRoot).concat(e," */")}));return[n].concat(i).concat([o]).join("\n")}var a,s,l;return[n].join("\n")}(t,e);return t[2]?"@media ".concat(t[2],"{").concat(n,"}"):n})).join("")},t.i=function(e,n){"string"==typeof e&&(e=[[null,e,""]]);for(var r={},o=0;o<this.length;o++){var i=this[o][0];null!=i&&(r[i]=!0)}for(var a=0;a<e.length;a++){var s=e[a];null!=s[0]&&r[s[0]]||(n&&!s[2]?s[2]=n:n&&(s[2]="(".concat(s[2],") and (").concat(n,")")),t.push(s))}},t}},function(e,t){
|
||
/*!
|
||
* Stickyfill -- `position: sticky` polyfill
|
||
* v. 1.1.1 | https://github.com/wilddeer/stickyfill
|
||
* Copyright Oleg Korsunsky | http://wd.dizaina.net/
|
||
*
|
||
* MIT License
|
||
*/
|
||
e.exports=function(e,t){e||(e=document),t||(t=window);var n,r,o=[],i=!1,a=e.documentElement,s=function(){},l="hidden",c="visibilitychange";void 0!==e.webkitHidden&&(l="webkitHidden",c="webkitvisibilitychange"),t.getComputedStyle||d();for(var u=["","-webkit-","-moz-","-ms-"],f=document.createElement("div"),p=u.length-1;p>=0;p--){try{f.style.position=u[p]+"sticky"}catch(e){}""!=f.style.position&&d()}function d(){I=L=A=P=R=N=s}function h(e){return parseFloat(e)||0}function m(){n={top:t.pageYOffset,left:t.pageXOffset}}function g(){if(t.pageXOffset!=n.left)return m(),void A();t.pageYOffset!=n.top&&(m(),v())}function y(e){setTimeout((function(){t.pageYOffset!=n.top&&(n.top=t.pageYOffset,v())}),0)}function v(){for(var e=o.length-1;e>=0;e--)b(o[e])}function b(e){if(e.inited){var t=n.top<=e.limit.start?0:n.top>=e.limit.end?2:1;e.mode!=t&&function(e,t){var n=e.node.style;switch(t){case 0:n.position="absolute",n.left=e.offset.left+"px",n.right=e.offset.right+"px",n.top=e.offset.top+"px",n.bottom="auto",n.width="auto",n.marginLeft=0,n.marginRight=0,n.marginTop=0;break;case 1:n.position="fixed",n.left=e.box.left+"px",n.right=e.box.right+"px",n.top=e.css.top,n.bottom="auto",n.width="auto",n.marginLeft=0,n.marginRight=0,n.marginTop=0;break;case 2:n.position="absolute",n.left=e.offset.left+"px",n.right=e.offset.right+"px",n.top="auto",n.bottom=0,n.width="auto",n.marginLeft=0,n.marginRight=0}e.mode=t}(e,t)}}function w(e){isNaN(parseFloat(e.computed.top))||e.isCell||(e.inited=!0,e.clone||function(e){e.clone=document.createElement("div");var t=e.node.nextSibling||e.node,n=e.clone.style;n.height=e.height+"px",n.width=e.width+"px",n.marginTop=e.computed.marginTop,n.marginBottom=e.computed.marginBottom,n.marginLeft=e.computed.marginLeft,n.marginRight=e.computed.marginRight,n.padding=n.border=n.borderSpacing=0,n.fontSize="1em",n.position="static",n.cssFloat=e.computed.cssFloat,e.node.parentNode.insertBefore(e.clone,t)}(e),"absolute"!=e.parent.computed.position&&"relative"!=e.parent.computed.position&&(e.parent.node.style.position="relative"),b(e),e.parent.height=e.parent.node.offsetHeight,e.docOffsetTop=_(e.clone))}function x(e){var t=!0;e.clone&&function(e){e.clone.parentNode.removeChild(e.clone),e.clone=void 0}(e),function(e,t){for(key in t)t.hasOwnProperty(key)&&(e[key]=t[key])}(e.node.style,e.css);for(var n=o.length-1;n>=0;n--)if(o[n].node!==e.node&&o[n].parent.node===e.parent.node){t=!1;break}t&&(e.parent.node.style.position=e.parent.css.position),e.mode=-1}function k(){for(var e=o.length-1;e>=0;e--)w(o[e])}function E(){for(var e=o.length-1;e>=0;e--)x(o[e])}function O(e){var t=getComputedStyle(e),n=e.parentNode,r=getComputedStyle(n),o=e.style.position;e.style.position="relative";var i={top:t.top,marginTop:t.marginTop,marginBottom:t.marginBottom,marginLeft:t.marginLeft,marginRight:t.marginRight,cssFloat:t.cssFloat},s={top:h(t.top),marginBottom:h(t.marginBottom),paddingLeft:h(t.paddingLeft),paddingRight:h(t.paddingRight),borderLeftWidth:h(t.borderLeftWidth),borderRightWidth:h(t.borderRightWidth)};e.style.position=o;var l={position:e.style.position,top:e.style.top,bottom:e.style.bottom,left:e.style.left,right:e.style.right,width:e.style.width,marginTop:e.style.marginTop,marginLeft:e.style.marginLeft,marginRight:e.style.marginRight},c=S(e),u=S(n),f={node:n,css:{position:n.style.position},computed:{position:r.position},numeric:{borderLeftWidth:h(r.borderLeftWidth),borderRightWidth:h(r.borderRightWidth),borderTopWidth:h(r.borderTopWidth),borderBottomWidth:h(r.borderBottomWidth)}};return{node:e,box:{left:c.win.left,right:a.clientWidth-c.win.right},offset:{top:c.win.top-u.win.top-f.numeric.borderTopWidth,left:c.win.left-u.win.left-f.numeric.borderLeftWidth,right:-c.win.right+u.win.right-f.numeric.borderRightWidth},css:l,isCell:"table-cell"==t.display,computed:i,numeric:s,width:c.win.right-c.win.left,height:c.win.bottom-c.win.top,mode:-1,inited:!1,parent:f,limit:{start:c.doc.top-s.top,end:u.doc.top+n.offsetHeight-f.numeric.borderBottomWidth-e.offsetHeight-s.top-s.marginBottom}}}function _(e){for(var t=0;e;)t+=e.offsetTop,e=e.offsetParent;return t}function S(e){var n=e.getBoundingClientRect();return{doc:{top:n.top+t.pageYOffset,left:n.left+t.pageXOffset},win:n}}function T(){r=setInterval((function(){!function(){for(var e=o.length-1;e>=0;e--)if(o[e].inited){var t=Math.abs(_(o[e].clone)-o[e].docOffsetTop),n=Math.abs(o[e].parent.node.offsetHeight-o[e].parent.height);if(t>=2||n>=2)return!1}return!0}()&&A()}),500)}function j(){clearInterval(r)}function C(){i&&(document[l]?j():T())}function I(){i||(m(),k(),t.addEventListener("scroll",g),t.addEventListener("wheel",y),t.addEventListener("resize",A),t.addEventListener("orientationchange",A),e.addEventListener(c,C),T(),i=!0)}function A(){if(i){E();for(var e=o.length-1;e>=0;e--)o[e]=O(o[e].node);k()}}function P(){t.removeEventListener("scroll",g),t.removeEventListener("wheel",y),t.removeEventListener("resize",A),t.removeEventListener("orientationchange",A),e.removeEventListener(c,C),j(),i=!1}function R(){P(),E()}function N(){for(R();o.length;)o.pop()}function L(e){for(var t=o.length-1;t>=0;t--)if(o[t].node===e)return;var n=O(e);o.push(n),i?w(n):I()}return m(),{stickies:o,add:L,remove:function(e){for(var t=o.length-1;t>=0;t--)o[t].node===e&&(x(o[t]),o.splice(t,1))},init:I,rebuild:A,pause:P,stop:R,kill:N}}},function(e,t,n){"use strict";n.r(t);var r={};n.r(r),n.d(r,"default",(function(){return Uo}));var o=n(1),i=n(0),a=n.n(i),s=n(30),l=n(16);function c(){return(c=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e}).apply(this,arguments)}function u(e){return(u=Object.setPrototypeOf?Object.getPrototypeOf:function(e){return e.__proto__||Object.getPrototypeOf(e)})(e)}function f(e,t){return(f=Object.setPrototypeOf||function(e,t){return e.__proto__=t,e})(e,t)}function p(e,t,n){return(p=function(){if("undefined"==typeof Reflect||!Reflect.construct)return!1;if(Reflect.construct.sham)return!1;if("function"==typeof Proxy)return!0;try{return Date.prototype.toString.call(Reflect.construct(Date,[],(function(){}))),!0}catch(e){return!1}}()?Reflect.construct:function(e,t,n){var r=[null];r.push.apply(r,t);var o=new(Function.bind.apply(e,r));return n&&f(o,n.prototype),o}).apply(null,arguments)}function d(e){var t="function"==typeof Map?new Map:void 0;return(d=function(e){if(null===e||(n=e,-1===Function.toString.call(n).indexOf("[native code]")))return e;var n;if("function"!=typeof e)throw new TypeError("Super expression must either be null or a function");if(void 0!==t){if(t.has(e))return t.get(e);t.set(e,r)}function r(){return p(e,arguments,u(this).constructor)}return r.prototype=Object.create(e.prototype,{constructor:{value:r,enumerable:!1,writable:!0,configurable:!0}}),f(r,e)})(e)}var h=function(e){var t,n;function r(t){return function(e){if(void 0===e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return e}(e.call(this,"An error occurred. See https://github.com/styled-components/polished/blob/master/src/internalHelpers/errors.md#"+t+" for more information.")||this)}return n=e,(t=r).prototype=Object.create(n.prototype),t.prototype.constructor=t,t.__proto__=n,r}(d(Error));function m(e){return Math.round(255*e)}function g(e,t,n){return m(e)+","+m(t)+","+m(n)}function y(e,t,n,r){if(void 0===r&&(r=g),0===t)return r(n,n,n);var o=(e%360+360)%360/60,i=(1-Math.abs(2*n-1))*t,a=i*(1-Math.abs(o%2-1)),s=0,l=0,c=0;o>=0&&o<1?(s=i,l=a):o>=1&&o<2?(s=a,l=i):o>=2&&o<3?(l=i,c=a):o>=3&&o<4?(l=a,c=i):o>=4&&o<5?(s=a,c=i):o>=5&&o<6&&(s=i,c=a);var u=n-i/2;return r(s+u,l+u,c+u)}var v={aliceblue:"f0f8ff",antiquewhite:"faebd7",aqua:"00ffff",aquamarine:"7fffd4",azure:"f0ffff",beige:"f5f5dc",bisque:"ffe4c4",black:"000",blanchedalmond:"ffebcd",blue:"0000ff",blueviolet:"8a2be2",brown:"a52a2a",burlywood:"deb887",cadetblue:"5f9ea0",chartreuse:"7fff00",chocolate:"d2691e",coral:"ff7f50",cornflowerblue:"6495ed",cornsilk:"fff8dc",crimson:"dc143c",cyan:"00ffff",darkblue:"00008b",darkcyan:"008b8b",darkgoldenrod:"b8860b",darkgray:"a9a9a9",darkgreen:"006400",darkgrey:"a9a9a9",darkkhaki:"bdb76b",darkmagenta:"8b008b",darkolivegreen:"556b2f",darkorange:"ff8c00",darkorchid:"9932cc",darkred:"8b0000",darksalmon:"e9967a",darkseagreen:"8fbc8f",darkslateblue:"483d8b",darkslategray:"2f4f4f",darkslategrey:"2f4f4f",darkturquoise:"00ced1",darkviolet:"9400d3",deeppink:"ff1493",deepskyblue:"00bfff",dimgray:"696969",dimgrey:"696969",dodgerblue:"1e90ff",firebrick:"b22222",floralwhite:"fffaf0",forestgreen:"228b22",fuchsia:"ff00ff",gainsboro:"dcdcdc",ghostwhite:"f8f8ff",gold:"ffd700",goldenrod:"daa520",gray:"808080",green:"008000",greenyellow:"adff2f",grey:"808080",honeydew:"f0fff0",hotpink:"ff69b4",indianred:"cd5c5c",indigo:"4b0082",ivory:"fffff0",khaki:"f0e68c",lavender:"e6e6fa",lavenderblush:"fff0f5",lawngreen:"7cfc00",lemonchiffon:"fffacd",lightblue:"add8e6",lightcoral:"f08080",lightcyan:"e0ffff",lightgoldenrodyellow:"fafad2",lightgray:"d3d3d3",lightgreen:"90ee90",lightgrey:"d3d3d3",lightpink:"ffb6c1",lightsalmon:"ffa07a",lightseagreen:"20b2aa",lightskyblue:"87cefa",lightslategray:"789",lightslategrey:"789",lightsteelblue:"b0c4de",lightyellow:"ffffe0",lime:"0f0",limegreen:"32cd32",linen:"faf0e6",magenta:"f0f",maroon:"800000",mediumaquamarine:"66cdaa",mediumblue:"0000cd",mediumorchid:"ba55d3",mediumpurple:"9370db",mediumseagreen:"3cb371",mediumslateblue:"7b68ee",mediumspringgreen:"00fa9a",mediumturquoise:"48d1cc",mediumvioletred:"c71585",midnightblue:"191970",mintcream:"f5fffa",mistyrose:"ffe4e1",moccasin:"ffe4b5",navajowhite:"ffdead",navy:"000080",oldlace:"fdf5e6",olive:"808000",olivedrab:"6b8e23",orange:"ffa500",orangered:"ff4500",orchid:"da70d6",palegoldenrod:"eee8aa",palegreen:"98fb98",paleturquoise:"afeeee",palevioletred:"db7093",papayawhip:"ffefd5",peachpuff:"ffdab9",peru:"cd853f",pink:"ffc0cb",plum:"dda0dd",powderblue:"b0e0e6",purple:"800080",rebeccapurple:"639",red:"f00",rosybrown:"bc8f8f",royalblue:"4169e1",saddlebrown:"8b4513",salmon:"fa8072",sandybrown:"f4a460",seagreen:"2e8b57",seashell:"fff5ee",sienna:"a0522d",silver:"c0c0c0",skyblue:"87ceeb",slateblue:"6a5acd",slategray:"708090",slategrey:"708090",snow:"fffafa",springgreen:"00ff7f",steelblue:"4682b4",tan:"d2b48c",teal:"008080",thistle:"d8bfd8",tomato:"ff6347",turquoise:"40e0d0",violet:"ee82ee",wheat:"f5deb3",white:"fff",whitesmoke:"f5f5f5",yellow:"ff0",yellowgreen:"9acd32"};var b=/^#[a-fA-F0-9]{6}$/,w=/^#[a-fA-F0-9]{8}$/,x=/^#[a-fA-F0-9]{3}$/,k=/^#[a-fA-F0-9]{4}$/,E=/^rgb\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*\)$/i,O=/^rgba\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*([-+]?[0-9]*[.]?[0-9]+)\s*\)$/i,_=/^hsl\(\s*(\d{0,3}[.]?[0-9]+)\s*,\s*(\d{1,3}[.]?[0-9]?)%\s*,\s*(\d{1,3}[.]?[0-9]?)%\s*\)$/i,S=/^hsla\(\s*(\d{0,3}[.]?[0-9]+)\s*,\s*(\d{1,3}[.]?[0-9]?)%\s*,\s*(\d{1,3}[.]?[0-9]?)%\s*,\s*([-+]?[0-9]*[.]?[0-9]+)\s*\)$/i;function T(e){if("string"!=typeof e)throw new h(3);var t=function(e){if("string"!=typeof e)return e;var t=e.toLowerCase();return v[t]?"#"+v[t]:e}(e);if(t.match(b))return{red:parseInt(""+t[1]+t[2],16),green:parseInt(""+t[3]+t[4],16),blue:parseInt(""+t[5]+t[6],16)};if(t.match(w)){var n=parseFloat((parseInt(""+t[7]+t[8],16)/255).toFixed(2));return{red:parseInt(""+t[1]+t[2],16),green:parseInt(""+t[3]+t[4],16),blue:parseInt(""+t[5]+t[6],16),alpha:n}}if(t.match(x))return{red:parseInt(""+t[1]+t[1],16),green:parseInt(""+t[2]+t[2],16),blue:parseInt(""+t[3]+t[3],16)};if(t.match(k)){var r=parseFloat((parseInt(""+t[4]+t[4],16)/255).toFixed(2));return{red:parseInt(""+t[1]+t[1],16),green:parseInt(""+t[2]+t[2],16),blue:parseInt(""+t[3]+t[3],16),alpha:r}}var o=E.exec(t);if(o)return{red:parseInt(""+o[1],10),green:parseInt(""+o[2],10),blue:parseInt(""+o[3],10)};var i=O.exec(t);if(i)return{red:parseInt(""+i[1],10),green:parseInt(""+i[2],10),blue:parseInt(""+i[3],10),alpha:parseFloat(""+i[4])};var a=_.exec(t);if(a){var s="rgb("+y(parseInt(""+a[1],10),parseInt(""+a[2],10)/100,parseInt(""+a[3],10)/100)+")",l=E.exec(s);if(!l)throw new h(4,t,s);return{red:parseInt(""+l[1],10),green:parseInt(""+l[2],10),blue:parseInt(""+l[3],10)}}var c=S.exec(t);if(c){var u="rgb("+y(parseInt(""+c[1],10),parseInt(""+c[2],10)/100,parseInt(""+c[3],10)/100)+")",f=E.exec(u);if(!f)throw new h(4,t,u);return{red:parseInt(""+f[1],10),green:parseInt(""+f[2],10),blue:parseInt(""+f[3],10),alpha:parseFloat(""+c[4])}}throw new h(5)}function j(e){return function(e){var t,n=e.red/255,r=e.green/255,o=e.blue/255,i=Math.max(n,r,o),a=Math.min(n,r,o),s=(i+a)/2;if(i===a)return void 0!==e.alpha?{hue:0,saturation:0,lightness:s,alpha:e.alpha}:{hue:0,saturation:0,lightness:s};var l=i-a,c=s>.5?l/(2-i-a):l/(i+a);switch(i){case n:t=(r-o)/l+(r<o?6:0);break;case r:t=(o-n)/l+2;break;default:t=(n-r)/l+4}return t*=60,void 0!==e.alpha?{hue:t,saturation:c,lightness:s,alpha:e.alpha}:{hue:t,saturation:c,lightness:s}}(T(e))}var C=function(e){return 7===e.length&&e[1]===e[2]&&e[3]===e[4]&&e[5]===e[6]?"#"+e[1]+e[3]+e[5]:e};function I(e){var t=e.toString(16);return 1===t.length?"0"+t:t}function A(e){return I(Math.round(255*e))}function P(e,t,n){return C("#"+A(e)+A(t)+A(n))}function R(e,t,n){return y(e,t,n,P)}function N(e,t,n){if("number"==typeof e&&"number"==typeof t&&"number"==typeof n)return R(e,t,n);if("object"==typeof e&&void 0===t&&void 0===n)return R(e.hue,e.saturation,e.lightness);throw new h(1)}function L(e,t,n,r){if("number"==typeof e&&"number"==typeof t&&"number"==typeof n&&"number"==typeof r)return r>=1?R(e,t,n):"rgba("+y(e,t,n)+","+r+")";if("object"==typeof e&&void 0===t&&void 0===n&&void 0===r)return e.alpha>=1?R(e.hue,e.saturation,e.lightness):"rgba("+y(e.hue,e.saturation,e.lightness)+","+e.alpha+")";throw new h(2)}function M(e,t,n){if("number"==typeof e&&"number"==typeof t&&"number"==typeof n)return C("#"+I(e)+I(t)+I(n));if("object"==typeof e&&void 0===t&&void 0===n)return C("#"+I(e.red)+I(e.green)+I(e.blue));throw new h(6)}function D(e,t,n,r){if("string"==typeof e&&"number"==typeof t){var o=T(e);return"rgba("+o.red+","+o.green+","+o.blue+","+t+")"}if("number"==typeof e&&"number"==typeof t&&"number"==typeof n&&"number"==typeof r)return r>=1?M(e,t,n):"rgba("+e+","+t+","+n+","+r+")";if("object"==typeof e&&void 0===t&&void 0===n&&void 0===r)return e.alpha>=1?M(e.red,e.green,e.blue):"rgba("+e.red+","+e.green+","+e.blue+","+e.alpha+")";throw new h(7)}var F=function(e){return"number"==typeof e.red&&"number"==typeof e.green&&"number"==typeof e.blue&&("number"!=typeof e.alpha||void 0===e.alpha)},U=function(e){return"number"==typeof e.red&&"number"==typeof e.green&&"number"==typeof e.blue&&"number"==typeof e.alpha},z=function(e){return"number"==typeof e.hue&&"number"==typeof e.saturation&&"number"==typeof e.lightness&&("number"!=typeof e.alpha||void 0===e.alpha)},B=function(e){return"number"==typeof e.hue&&"number"==typeof e.saturation&&"number"==typeof e.lightness&&"number"==typeof e.alpha};function $(e){if("object"!=typeof e)throw new h(8);if(U(e))return D(e);if(F(e))return M(e);if(B(e))return L(e);if(z(e))return N(e);throw new h(8)}function q(e){return function e(t,n,r){return function(){var o=r.concat(Array.prototype.slice.call(arguments));return o.length>=n?t.apply(this,o):e(t,n,o)}}(e,e.length,[])}function W(e,t,n){return Math.max(e,Math.min(t,n))}function H(e,t){if("transparent"===t)return t;var n=j(t);return $(c({},n,{lightness:W(0,1,n.lightness-parseFloat(e))}))}var V=q(H);function Y(e,t){if("transparent"===t)return t;var n=j(t);return $(c({},n,{saturation:W(0,1,n.saturation-parseFloat(e))}))}var G=q(Y);function Q(e){if("transparent"===e)return 0;var t=T(e),n=Object.keys(t).map((function(e){var n=t[e]/255;return n<=.03928?n/12.92:Math.pow((n+.055)/1.055,2.4)})),r=n[0],o=n[1],i=n[2];return parseFloat((.2126*r+.7152*o+.0722*i).toFixed(3))}function X(e,t){if("transparent"===t)return t;var n=j(t);return $(c({},n,{lightness:W(0,1,n.lightness+parseFloat(e))}))}var K=q(X);function J(e,t,n){return void 0===t&&(t="#000"),void 0===n&&(n="#fff"),Q(e)>.179?t:n}function Z(e,t){if("transparent"===t)return t;var n=T(t);return D(c({},n,{alpha:W(0,1,(100*("number"==typeof n.alpha?n.alpha:1)-100*parseFloat(e))/100)}))}var ee=q(Z);var te={spacing:{unit:5,sectionHorizontal:function(e){return 8*e.spacing.unit},sectionVertical:function(e){return 8*e.spacing.unit}},breakpoints:{small:"50rem",medium:"85rem",large:"105rem"},colors:{tonalOffset:.3,primary:{main:"#32329f",light:function(e){var t=e.colors;return K(t.tonalOffset,t.primary.main)},dark:function(e){var t=e.colors;return V(t.tonalOffset,t.primary.main)},contrastText:function(e){return J(e.colors.primary.main)}},success:{main:"#00aa13",light:function(e){var t=e.colors;return K(t.tonalOffset,t.success.main)},dark:function(e){var t=e.colors;return V(t.tonalOffset,t.success.main)},contrastText:function(e){return J(e.colors.success.main)}},warning:{main:"#d4ad03",light:function(e){var t=e.colors;return K(t.tonalOffset,t.warning.main)},dark:function(e){var t=e.colors;return V(t.tonalOffset,t.warning.main)},contrastText:"#ffffff"},error:{main:"#e53935",light:function(e){var t=e.colors;return K(t.tonalOffset,t.error.main)},dark:function(e){var t=e.colors;return V(t.tonalOffset,t.error.main)},contrastText:function(e){return J(e.colors.error.main)}},text:{primary:"#333333",secondary:function(e){var t=e.colors;return K(t.tonalOffset,t.text.primary)}},border:{dark:"rgba(0,0,0, 0.1)",light:"#ffffff"},responses:{success:{color:function(e){return e.colors.success.main},backgroundColor:function(e){var t=e.colors;return ee(.9,t.success.main)}},error:{color:function(e){return e.colors.error.main},backgroundColor:function(e){var t=e.colors;return ee(.9,t.error.main)}},redirect:{color:"#ffa500",backgroundColor:function(e){var t=e.colors;return ee(.9,t.responses.redirect.color)}},info:{color:"#87ceeb",backgroundColor:function(e){var t=e.colors;return ee(.9,t.responses.info.color)}}},http:{get:"#6bbd5b",post:"#248fb2",put:"#9b708b",options:"#d3ca12",patch:"#e09d43",delete:"#e27a7a",basic:"#999",link:"#31bbb6",head:"#c167e4"}},schema:{linesColor:function(e){return K(e.colors.tonalOffset,G(e.colors.tonalOffset,e.colors.primary.main))},defaultDetailsWidth:"75%",typeNameColor:function(e){return e.colors.text.secondary},typeTitleColor:function(e){return e.schema.typeNameColor},requireLabelColor:function(e){return e.colors.error.main},labelsTextSize:"0.9em",nestingSpacing:"1em",nestedBackground:"#fafafa",arrow:{size:"1.1em",color:function(e){return e.colors.text.secondary}}},typography:{fontSize:"14px",lineHeight:"1.5em",fontWeightRegular:"400",fontWeightBold:"600",fontWeightLight:"300",fontFamily:"Roboto, sans-serif",smoothing:"antialiased",optimizeSpeed:!0,headings:{fontFamily:"Montserrat, sans-serif",fontWeight:"400",lineHeight:"1.6em"},code:{fontSize:"13px",fontFamily:"Courier, monospace",lineHeight:function(e){return e.typography.lineHeight},fontWeight:function(e){return e.typography.fontWeightRegular},color:"#e53935",backgroundColor:"rgba(38, 50, 56, 0.05)",wrap:!1},links:{color:function(e){return e.colors.primary.main},visited:function(e){return e.typography.links.color},hover:function(e){var t=e.typography;return K(.2,t.links.color)}}},menu:{width:"260px",backgroundColor:"#fafafa",textColor:"#333333",activeTextColor:function(e){return e.menu.textColor!==te.menu.textColor?e.menu.textColor:e.colors.primary.main},groupItems:{textTransform:"uppercase"},level1Items:{textTransform:"none"},arrow:{size:"1.5em",color:function(e){return e.menu.textColor}}},logo:{maxHeight:function(e){return e.menu.width},maxWidth:function(e){return e.menu.width},gutter:"2px"},rightPanel:{backgroundColor:"#263238",width:"40%",textColor:"#ffffff"},codeSample:{backgroundColor:function(e){var t=e.rightPanel;return V(.1,t.backgroundColor)}}},ne=te;var re="undefined"!=typeof window&&"HTMLElement"in window;function oe(e){return"undefined"!=typeof document?document.querySelector(e):null}"undefined"==typeof Element||Element.prototype.scrollIntoViewIfNeeded||(Element.prototype.scrollIntoViewIfNeeded=function(e){e=0===arguments.length||!!e;var t=this.parentNode,n=window.getComputedStyle(t,void 0),r=parseInt(n.getPropertyValue("border-top-width"),10),o=parseInt(n.getPropertyValue("border-left-width"),10),i=this.offsetTop-t.offsetTop<t.scrollTop,a=this.offsetTop-t.offsetTop+this.clientHeight-r>t.scrollTop+t.clientHeight,s=this.offsetLeft-t.offsetLeft<t.scrollLeft,l=this.offsetLeft-t.offsetLeft+this.clientWidth-o>t.scrollLeft+t.clientWidth,c=i&&!a;(i||a)&&e&&(t.scrollTop=this.offsetTop-t.offsetTop-t.clientHeight/2-r+this.clientHeight/2),(s||l)&&e&&(t.scrollLeft=this.offsetLeft-t.offsetLeft-t.clientWidth/2-o+this.clientWidth/2),(i||a||s||l)&&!e&&this.scrollIntoView(c)});var ie=n(148),ae=n.n(ie),se=n(8);function le(e,t){for(var n=[],r=0;r<e.length-1;r++)n.push(t(e[r],!1));return 0!==e.length&&n.push(t(e[e.length-1],!0)),n}function ce(e){return e.endsWith("/")?e.substring(0,e.length-1):e}function ue(e){return!isNaN(parseFloat(e))&&isFinite(e)}var fe=function(e){for(var t=[],n=1;n<arguments.length;n++)t[n-1]=arguments[n];if(!t.length)return e;var r=t.shift();return void 0===r?e:(pe(e)&&pe(r)&&Object.keys(r).forEach((function(t){pe(r[t])?(e[t]||(e[t]={}),fe(e[t],r[t])):e[t]=r[t]})),fe.apply(void 0,Object(o.__spreadArrays)([e],t)))},pe=function(e){return function(e){return null!==e&&"object"==typeof e}(e)&&!Array.isArray(e)};function de(e){return ae()(e)||e.toString().toLowerCase().replace(/\s+/g,"-").replace(/&/g,"-and-").replace(/\--+/g,"-").replace(/^-+/,"").replace(/-+$/,"")}function he(e){return"undefined"==typeof URL?new(n(8).URL)(e):new URL(e)}var me={enum:"Enum",enumSingleValue:"Value",enumArray:"Items",default:"Default",deprecated:"Deprecated",example:"Example",nullable:"Nullable",recursive:"Recursive",arrayOf:"Array of "};function ge(e,t){var n=me[e];return void 0!==t?n[t]:n}function ye(e,t){return void 0===e?t||!1:"string"==typeof e?"false"!==e:e}var ve,be=function(){function e(t,n){void 0===n&&(n={});var r,i,a,s,l,c=(t=Object(o.__assign)(Object(o.__assign)({},n),t)).theme&&t.theme.extensionsHook;this.theme=(r=fe({},ne,Object(o.__assign)(Object(o.__assign)({},t.theme),{extensionsHook:void 0})),i={},a=0,(s=function(e,t){Object.keys(e).forEach((function(n){var o=(t?t+".":"")+n,l=e[n];"function"==typeof l?Object.defineProperty(e,n,{get:function(){if(!i[o]){if(++a>1e3)throw new Error("Theme probably contains circular dependency at "+o+": "+l.toString());i[o]=l(r)}return i[o]},enumerable:!0}):"object"==typeof l&&s(l,o)}))})(r,""),JSON.parse(JSON.stringify(r))),this.theme.extensionsHook=c,l=t.labels,Object.assign(me,l),this.scrollYOffset=e.normalizeScrollYOffset(t.scrollYOffset),this.hideHostname=e.normalizeHideHostname(t.hideHostname),this.expandResponses=e.normalizeExpandResponses(t.expandResponses),this.requiredPropsFirst=ye(t.requiredPropsFirst),this.sortPropsAlphabetically=ye(t.sortPropsAlphabetically),this.noAutoAuth=ye(t.noAutoAuth),this.nativeScrollbars=ye(t.nativeScrollbars),this.pathInMiddlePanel=ye(t.pathInMiddlePanel),this.untrustedSpec=ye(t.untrustedSpec),this.hideDownloadButton=ye(t.hideDownloadButton),this.disableSearch=ye(t.disableSearch),this.onlyRequiredInSamples=ye(t.onlyRequiredInSamples),this.showExtensions=e.normalizeShowExtensions(t.showExtensions),this.hideSingleRequestSampleTab=ye(t.hideSingleRequestSampleTab),this.menuToggle=ye(t.menuToggle,!0),this.jsonSampleExpandLevel=e.normalizeJsonSampleExpandLevel(t.jsonSampleExpandLevel),this.enumSkipQuotes=ye(t.enumSkipQuotes),this.hideSchemaTitles=ye(t.hideSchemaTitles),this.payloadSampleIdx=e.normalizePayloadSampleIdx(t.payloadSampleIdx),this.unstable_ignoreMimeParameters=ye(t.unstable_ignoreMimeParameters),this.allowedMdComponents=t.allowedMdComponents||{},this.expandDefaultServerVariables=ye(t.expandDefaultServerVariables)}return e.normalizeExpandResponses=function(e){if("all"===e)return"all";if("string"==typeof e){var t={};return e.split(",").forEach((function(e){t[e.trim()]=!0})),t}return void 0!==e&&console.warn('expandResponses must be a string but received value "'+e+'" of type '+typeof e),{}},e.normalizeHideHostname=function(e){return!!e},e.normalizeScrollYOffset=function(e){if("string"==typeof e&&!ue(e)){var t=oe(e);t||console.warn("scrollYOffset value is a selector to non-existing element. Using offset 0 by default");var n=t&&t.getBoundingClientRect().bottom||0;return function(){return n}}return"number"==typeof e||ue(e)?function(){return"number"==typeof e?e:parseFloat(e)}:"function"==typeof e?function(){var t=e();return"number"!=typeof t&&console.warn('scrollYOffset should return number but returned value "'+t+'" of type '+typeof t),t}:(void 0!==e&&console.warn("Wrong value for scrollYOffset ReDoc option: should be string, number or function"),function(){return 0})},e.normalizeShowExtensions=function(e){return void 0!==e&&(""===e||("string"==typeof e?e.split(",").map((function(e){return e.trim()})):e))},e.normalizePayloadSampleIdx=function(e){return"number"==typeof e?Math.max(0,e):"string"==typeof e&&isFinite(e)?parseInt(e,10):0},e.normalizeJsonSampleExpandLevel=function(e){return"all"===e?1/0:isNaN(Number(e))?2:Math.ceil(Number(e))},e}(),we=n(149),xe=we.default,ke=we.css,Ee=we.createGlobalStyle,Oe=we.keyframes,_e=we.ThemeProvider,Se=function(e,t){return function(){for(var n=[],r=0;r<arguments.length;r++)n[r]=arguments[r];return ke(ve||(ve=Object(o.__makeTemplateObject)(["\n @media "," screen and (max-width: ",") {\n ",";\n }\n "],["\n @media "," screen and (max-width: ",") {\n ",";\n }\n "])),t?"print, ":"",(function(t){return t.theme.breakpoints[e]}),ke.apply(void 0,n))}},Te=xe;function je(e){return function(t){if(t.theme.extensionsHook)return t.theme.extensionsHook(e,t)}}var Ce,Ie,Ae,Pe,Re=Te.div(Ce||(Ce=Object(o.__makeTemplateObject)(["\n padding: 20px;\n color: red;\n"],["\n padding: 20px;\n color: red;\n"]))),Ne=function(e){function t(t){var n=e.call(this,t)||this;return n.state={error:void 0},n}return Object(o.__extends)(t,e),t.prototype.componentDidCatch=function(e){return this.setState({error:e}),!1},t.prototype.render=function(){return this.state.error?i.createElement(Re,null,i.createElement("h1",null,"Something went wrong..."),i.createElement("small",null," ",this.state.error.message," "),i.createElement("p",null,i.createElement("details",null,i.createElement("summary",null,"Stack trace"),i.createElement("pre",null,this.state.error.stack))),i.createElement("small",null," ReDoc Version: ","2.0.0-rc.23")," ",i.createElement("br",null),i.createElement("small",null," Commit: ","88f8d747")):i.Children.only(this.props.children)},t}(i.Component),Le=Oe(Ie||(Ie=Object(o.__makeTemplateObject)(["\n 0% {\n transform: rotate(0deg); }\n 100% {\n transform: rotate(360deg);\n }\n"],["\n 0% {\n transform: rotate(0deg); }\n 100% {\n transform: rotate(360deg);\n }\n"]))),Me=Te((function(e){return i.createElement("svg",{className:e.className,version:"1.1",width:"512",height:"512",viewBox:"0 0 512 512"},i.createElement("path",{d:"M275.682 147.999c0 10.864-8.837 19.661-19.682 19.661v0c-10.875 0-19.681-8.796-19.681-19.661v-96.635c0-10.885 8.806-19.661 19.681-19.661v0c10.844 0 19.682 8.776 19.682 19.661v96.635z"}),i.createElement("path",{d:"M275.682 460.615c0 10.865-8.837 19.682-19.682 19.682v0c-10.875 0-19.681-8.817-19.681-19.682v-96.604c0-10.885 8.806-19.681 19.681-19.681v0c10.844 0 19.682 8.796 19.682 19.682v96.604z"}),i.createElement("path",{d:"M147.978 236.339c10.885 0 19.681 8.755 19.681 19.641v0c0 10.885-8.796 19.702-19.681 19.702h-96.624c-10.864 0-19.661-8.817-19.661-19.702v0c0-10.885 8.796-19.641 19.661-19.641h96.624z"}),i.createElement("path",{d:"M460.615 236.339c10.865 0 19.682 8.755 19.682 19.641v0c0 10.885-8.817 19.702-19.682 19.702h-96.584c-10.885 0-19.722-8.817-19.722-19.702v0c0-10.885 8.837-19.641 19.722-19.641h96.584z"}),i.createElement("path",{d:"M193.546 165.703c7.69 7.66 7.68 20.142 0 27.822v0c-7.701 7.701-20.162 7.701-27.853 0.020l-68.311-68.322c-7.68-7.701-7.68-20.142 0-27.863v0c7.68-7.68 20.121-7.68 27.822 0l68.342 68.342z"}),i.createElement("path",{d:"M414.597 386.775c7.7 7.68 7.7 20.163 0.021 27.863v0c-7.7 7.659-20.142 7.659-27.843-0.062l-68.311-68.26c-7.68-7.7-7.68-20.204 0-27.863v0c7.68-7.7 20.163-7.7 27.842 0l68.291 68.322z"}),i.createElement("path",{d:"M165.694 318.464c7.69-7.7 20.153-7.7 27.853 0v0c7.68 7.659 7.69 20.163 0 27.863l-68.342 68.322c-7.67 7.659-20.142 7.659-27.822-0.062v0c-7.68-7.68-7.68-20.122 0-27.801l68.311-68.322z"}),i.createElement("path",{d:"M386.775 97.362c7.7-7.68 20.142-7.68 27.822 0v0c7.7 7.68 7.7 20.183 0.021 27.863l-68.322 68.311c-7.68 7.68-20.163 7.68-27.843-0.020v0c-7.68-7.68-7.68-20.162 0-27.822l68.322-68.332z"}))}))(Ae||(Ae=Object(o.__makeTemplateObject)(["\n animation: 2s "," linear infinite;\n width: 50px;\n height: 50px;\n content: '';\n display: inline-block;\n margin-left: -25px;\n\n path {\n fill: ",";\n }\n"],["\n animation: 2s "," linear infinite;\n width: 50px;\n height: 50px;\n content: '';\n display: inline-block;\n margin-left: -25px;\n\n path {\n fill: ",";\n }\n"])),Le,(function(e){return e.color})),De=Te.div(Pe||(Pe=Object(o.__makeTemplateObject)(["\n font-family: helvetica, sans;\n width: 100%;\n text-align: center;\n font-size: 25px;\n margin: 30px 0 20px 0;\n color: ",";\n"],["\n font-family: helvetica, sans;\n width: 100%;\n text-align: center;\n font-size: 25px;\n margin: 30px 0 20px 0;\n color: ",";\n"])),(function(e){return e.color})),Fe=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){return i.createElement("div",{style:{textAlign:"center"}},i.createElement(De,{color:this.props.color},"Loading ..."),i.createElement(Me,{color:this.props.color}))},t}(i.PureComponent),Ue=i.createContext(new be({})),ze=Ue.Provider,Be=Ue.Consumer,$e=n(2),qe=n(152),We=n(153);function He(e){return Object(o.__awaiter)(this,void 0,void 0,(function(){var t;return Object(o.__generator)(this,(function(n){switch(n.label){case 0:return[4,(new qe).bundle(e,{resolve:{http:{withCredentials:!1}}})];case 1:return void 0!==(t=n.sent()).swagger?[2,Ve(t)]:[2,t]}}))}))}function Ve(e){return console.warn("[ReDoc Compatibility mode]: Converting OpenAPI 2.0 to OpenAPI 3.0"),new Promise((function(t,n){return Object(We.convertObj)(e,{patch:!0,warnOnly:!0,text:"{}"},(function(e,r){if(e)return n(e);t(r&&r.openapi)}))}))}var Ye=n(50),Ge=n(63),Qe=n(21),Xe=Qe.parse,Ke=function(){function e(){}return e.baseName=function(t,n){void 0===n&&(n=1);var r=e.parse(t);return r[r.length-n]},e.dirName=function(t,n){void 0===n&&(n=1);var r=e.parse(t);return Qe.compile(r.slice(0,r.length-n))},e.relative=function(t,n){var r=e.parse(t);return e.parse(n).slice(r.length)},e.parse=function(e){var t=e;return"#"===t.charAt(0)&&(t=t.substring(1)),Xe(t)},e.join=function(t,n){var r=e.parse(t).concat(n);return Qe.compile(r)},e.get=function(e,t){return Qe.get(e,t)},e.compile=function(e){return Qe.compile(e)},e.escape=function(e){return Qe.escape(e)},e}();Qe.parse=Ke.parse,Object.assign(Ke,Qe);var Je=n(49),Ze=n(292);function et(e){return"string"==typeof e&&/\dxx/i.test(e)}function tt(e,t){if(void 0===t&&(t=!1),"default"===e)return t?"error":"success";var n="string"==typeof e?parseInt(e,10):e;if(et(e)&&(n*=100),n<100||n>599)throw new Error("invalid HTTP code");var r="success";return n>=300&&n<400?r="redirect":n>=400?r="error":n<200&&(r="info"),r}var nt={get:!0,post:!0,put:!0,head:!0,patch:!0,delete:!0,options:!0};function rt(e){return e in nt}var ot={multipleOf:"number",maximum:"number",exclusiveMaximum:"number",minimum:"number",exclusiveMinimum:"number",maxLength:"string",minLength:"string",pattern:"string",items:"array",maxItems:"array",minItems:"array",uniqueItems:"array",maxProperties:"object",minProperties:"object",required:"object",additionalProperties:"object",properties:"object"};function it(e){return-1!==e.search(/json/i)}function at(e,t,n){return Array.isArray(e)?e.map((function(e){return e.toString()})).join(n):"object"==typeof e?Object.keys(e).map((function(t){return""+t+n+e[t]})).join(n):t+"="+e.toString()}function st(e,t){return Array.isArray(e)?(console.warn("deepObject style cannot be used with array value:"+e.toString()),""):"object"==typeof e?Object.keys(e).map((function(n){return t+"["+n+"]="+e[n]})).join("&"):(console.warn("deepObject style cannot be used with non-object value:"+e.toString()),"")}function lt(e,t,n){var r,o=t?"*":"";return Ze.parse("{?__redoc_param_name__"+o+"}").expand((r={},r.__redoc_param_name__=n,r)).substring(1).replace(/__redoc_param_name__/g,e)}function ct(e,t){return it(t)?JSON.stringify(e):(console.warn("Parameter serialization as "+t+" is not supported"),"")}function ut(e,t){var n=e.name,r=e.style,o=e.explode,i=void 0!==o&&o,a=e.serializationMime;if(a)switch(e.in){case"path":case"header":return ct(t,a);case"cookie":case"query":return n+"="+ct(t,a);default:return console.warn("Unexpected parameter location: "+e.in),""}if(!r)return console.warn("Missing style attribute or content for parameter "+n),"";switch(e.in){case"path":return function(e,t,n,r){var o,i=n?"*":"",a="";return"label"===t?a=".":"matrix"===t&&(a=";"),Ze.parse("{"+a+"__redoc_param_name__"+i+"}").expand((o={},o.__redoc_param_name__=r,o)).replace(/__redoc_param_name__/g,e)}(n,r,i,t);case"query":return function(e,t,n,r){switch(t){case"form":return lt(e,n,r);case"spaceDelimited":return Array.isArray(r)?n?lt(e,n,r):e+"="+r.join("%20"):(console.warn("The style spaceDelimited is only applicable to arrays"),"");case"pipeDelimited":return Array.isArray(r)?n?lt(e,n,r):e+"="+r.join("|"):(console.warn("The style pipeDelimited is only applicable to arrays"),"");case"deepObject":return!n||Array.isArray(r)||"object"!=typeof r?(console.warn("The style deepObject is only applicable for objects with explode=true"),""):st(r,e);default:return console.warn("Unexpected style for query: "+t),""}}(n,r,i,t);case"header":return function(e,t,n){var r;switch(e){case"simple":var o=t?"*":"",i="__redoc_param_name__",a=Ze.parse("{"+i+o+"}");return decodeURIComponent(a.expand(((r={})[i]=n,r)));default:return console.warn("Unexpected style for header: "+e),""}}(r,i,t);case"cookie":return function(e,t,n,r){switch(t){case"form":return lt(e,n,r);default:return console.warn("Unexpected style for cookie: "+t),""}}(n,r,i,t);default:return console.warn("Unexpected parameter location: "+e.in),""}}function ft(e){return/^#\/components\/schemas\/[^\/]+$/.test(e||"")}function pt(e,t,n){var r;return void 0!==t&&void 0!==n?r=t===n?t+" "+e:"[ "+t+" .. "+n+" ] "+e:void 0!==n?r="<= "+n+" "+e:void 0!==t&&(r=1===t?"non-empty":">= "+t+" "+e),r}function dt(e,t){void 0===t&&(t=[]);var n=[],r=[],i=[];return e.forEach((function(e){e.required?t.includes(e.name)?r.push(e):i.push(e):n.push(e)})),r.sort((function(e,n){return t.indexOf(e.name)-t.indexOf(n.name)})),Object(o.__spreadArrays)(r,i,n)}function ht(e,t){return Object(o.__spreadArrays)(e).sort((function(e,n){return e[t].localeCompare(n[t])}))}function mt(e,t){var n=void 0===e?function(e){try{var t=he(e);return t.search="",t.toString()}catch(t){return e}}(function(){if(!re)return"";var e=window.location.href;return e.endsWith(".html")?Object(Je.dirname)(e):e}()):Object(Je.dirname)(e);function r(e){return function(e,t){var n;if(t.startsWith("//"))n=""+(Object(se.parse)(e).protocol||"https:")+t;else if(function(e){return/(?:^[a-z][a-z0-9+.-]*:|\/\/)/i.test(e)}(t))n=t;else if(t.startsWith("/")){var r=Object(se.parse)(e);n=Object(se.format)(Object(o.__assign)(Object(o.__assign)({},r),{pathname:t}))}else n=ce(e)+"/"+t;return ce(n)}(n,e)}return 0===t.length&&(t=[{url:"/"}]),t.map((function(e){return Object(o.__assign)(Object(o.__assign)({},e),{url:r(e.url),description:e.description||""})}))}var gt="section/Authentication/";function yt(e,t){return Object.keys(e).filter((function(e){return!0===t?e.startsWith("x-")&&!function(e){return e in{"x-circular-ref":!0,"x-code-samples":!0,"x-displayName":!0,"x-examples":!0,"x-ignoredHeaderParameters":!0,"x-logo":!0,"x-nullable":!0,"x-servers":!0,"x-tagGroups":!0,"x-traitTag":!0,"x-additionalPropertiesName":!0}}(e):e.startsWith("x-")&&t.indexOf(e)>-1})).reduce((function(t,n){return t[n]=e[n],t}),{})}var vt=n(38),bt=(n(293),n(294),n(295),n(296),n(297),n(298),n(299),n(300),n(301),n(302),n(303),n(304),n(305),n(306),n(307),n(308),n(309),n(310),n(311),n(312),"clike");function wt(e,t){void 0===t&&(t=bt),t=t.toLowerCase();var n=vt.languages[t];return n||(n=vt.languages[function(e){return{json:"js","c++":"cpp","c#":"csharp","objective-c":"objectivec",shell:"bash",viml:"vim"}[e]||bt}(t)]),vt.highlight(e,n,t)}function xt(e){return function(t,n,r){var o,i,a,s,l,c,u,f;r.value=(o=r.value,i=e,c=null,u=0,f=function(){u=(new Date).getTime(),c=null,l=o.apply(a,s),c||(a=s=null)},function(){var e=(new Date).getTime(),t=i-(e-u);return a=this,s=arguments,t<=0||t>i?(c&&(clearTimeout(c),c=null),u=e,l=o.apply(a,s),c||(a=s=null)):c||(c=setTimeout(f,t)),l})}}function kt(e){0}function Et(e){0}vt.languages.insertBefore("javascript","string",{"property string":{pattern:/([{,]\s*)"(?:\\.|[^\\"\r\n])*"(?=\s*:)/i,lookbehind:!0}},void 0),vt.languages.insertBefore("javascript","punctuation",{property:{pattern:/([{,]\s*)[a-z]\w*(?=\s*:)/i,lookbehind:!0}},void 0);var Ot={};function _t(e,t,n){if("function"==typeof n.value)return function(e,t,n){if(!n.value||n.value.length>0)throw new Error("@memoize decorator can only be applied to methods of zero arguments");var r="_memoized_"+t,i=n.value;return e[r]=Ot,Object(o.__assign)(Object(o.__assign)({},n),{value:function(){return this[r]===Ot&&(this[r]=i.call(this)),this[r]}})}(e,t,n);if("function"==typeof n.get)return function(e,t,n){var r="_memoized_"+t,i=n.get;return e[r]=Ot,Object(o.__assign)(Object(o.__assign)({},n),{get:function(){return this[r]===Ot&&(this[r]=i.call(this)),this[r]}})}(e,t,n);throw new Error("@memoize decorator can be applied to methods or getters, got "+String(n.value)+" instead")}var St="hashchange",Tt=new(function(){function e(){var e=this;this.emit=function(){e._emiter.emit(St,e.currentId)},this._emiter=new Ge.EventEmitter,this.bind()}return Object.defineProperty(e.prototype,"currentId",{get:function(){return re?decodeURIComponent(window.location.hash.substring(1)):""},enumerable:!0,configurable:!0}),e.prototype.linkForId=function(e){return e?"#"+e:""},e.prototype.subscribe=function(e){var t=this._emiter.addListener(St,e);return function(){return t.removeListener(St,e)}},e.prototype.bind=function(){re&&window.addEventListener("hashchange",this.emit,!1)},e.prototype.dispose=function(){re&&window.removeEventListener("hashchange",this.emit)},e.prototype.replace=function(e,t){void 0===t&&(t=!1),re&&null!=e&&e!==this.currentId&&(t?window.history.replaceState(null,"",window.location.href.split("#")[0]+this.linkForId(e)):(window.history.pushState(null,"",window.location.href.split("#")[0]+this.linkForId(e)),this.emit()))},Object(o.__decorate)([Ye.bind,Ye.debounce],e.prototype,"replace",null),e}());var jt=n(95),Ct=function(){function e(){this.map=new Map,this.prevTerm=""}return e.prototype.add=function(e){this.map.set(e,new jt(e))},e.prototype.delete=function(e){this.map.delete(e)},e.prototype.addOnly=function(e){var t=this;this.map.forEach((function(n,r){-1===e.indexOf(r)&&(n.unmark(),t.map.delete(r))}));for(var n=0,r=e;n<r.length;n++){var o=r[n];this.map.has(o)||this.map.set(o,new jt(o))}},e.prototype.clearAll=function(){this.unmark(),this.map.clear()},e.prototype.mark=function(e){var t=this;(e||this.prevTerm)&&(this.map.forEach((function(n){n.unmark(),n.mark(e||t.prevTerm)})),this.prevTerm=e||this.prevTerm)},e.prototype.unmark=function(){this.map.forEach((function(e){return e.unmark()})),this.prevTerm=""},e}(),It=n(51),At=new It.Renderer;It.setOptions({renderer:At,highlight:function(e,t){return wt(e,t)}});var Pt="(?:^ {0,3}\x3c!-- ReDoc-Inject:\\s+?<({component}).*?/?>\\s+?--\x3e\\s*$|(?:^ {0,3}<({component})([\\s\\S]*?)>([\\s\\S]*?)</\\2>|^ {0,3}<({component})([\\s\\S]*?)(?:/>|\\n{2,})))";var Rt=function(){function e(e){var t=this;this.options=e,this.headings=[],this.headingRule=function(e,n,r,o){return 1===n?t.currentTopHeading=t.saveHeading(e,n):2===n&&t.saveHeading(e,n,t.currentTopHeading&&t.currentTopHeading.items,t.currentTopHeading&&t.currentTopHeading.id),t.originalHeadingRule(e,n,r,o)},this.headingEnhanceRenderer=new It.Renderer,this.originalHeadingRule=this.headingEnhanceRenderer.heading.bind(this.headingEnhanceRenderer),this.headingEnhanceRenderer.heading=this.headingRule}return e.containsComponent=function(e,t){return new RegExp(Pt.replace(/{component}/g,t),"gmi").test(e)},e.getTextBeforeHading=function(e,t){var n=e.search(new RegExp("^##?\\s+"+t,"m"));return n>-1?e.substring(0,n):e},e.prototype.saveHeading=function(e,t,n,r){void 0===n&&(n=this.headings),e=e.replace(/&#(\d+);/g,(function(e,t){return String.fromCharCode(parseInt(t,10))}));var o={id:r?r+"/"+de(e):"section/"+de(e),name:e,level:t,items:[]};return n.push(o),o},e.prototype.flattenHeadings=function(e){if(void 0===e)return[];for(var t=[],n=0,r=e;n<r.length;n++){var o=r[n];t.push(o),t.push.apply(t,this.flattenHeadings(o.items))}return t},e.prototype.attachHeadingsDescriptions=function(e){var t=function(e){return new RegExp("##?\\s+"+e.name.replace(/[-\/\\^$*+?.()|[\]{}]/g,"\\$&"))},n=this.flattenHeadings(this.headings);if(!(n.length<1)){for(var r=n[0],o=t(r),i=e.search(o),a=1;a<n.length;a++){var s=n[a],l=t(s),c=e.substr(i+1).search(l)+i+1;r.description=e.substring(i,c).replace(o,"").trim(),r=s,o=l,i=c}r.description=e.substring(i).replace(o,"").trim()}},e.prototype.renderMd=function(e,t){void 0===t&&(t=!1);var n=t?{renderer:this.headingEnhanceRenderer}:void 0;return It(e.toString(),n)},e.prototype.extractHeadings=function(e){this.renderMd(e,!0),this.attachHeadingsDescriptions(e);var t=this.headings;return this.headings=[],t},e.prototype.renderMdWithComponents=function(e){var t=this.options&&this.options.allowedMdComponents;if(!t||0===Object.keys(t).length)return[this.renderMd(e)];for(var n=Object.keys(t).join("|"),r=new RegExp(Pt.replace(/{component}/g,n),"mig"),i=[],a=[],s=r.exec(e),l=0;s;){i.push(e.substring(l,s.index)),l=r.lastIndex;var c=t[s[1]||s[2]||s[5]],u=s[3]||s[6],f=s[4];c&&a.push({component:c.component,propsSelector:c.propsSelector,props:Object(o.__assign)(Object(o.__assign)(Object(o.__assign)({},Nt(u)),c.props),{children:f})}),s=r.exec(e)}i.push(e.substring(l));for(var p=[],d=0;d<i.length;d++){var h=i[d];h&&p.push(this.renderMd(h)),a[d]&&p.push(a[d])}return p},e}();function Nt(e){if(!e)return{};for(var t,n=/([\w-]+)\s*=\s*(?:{([^}]+?)}|"([^"]+?)")/gim,r={};null!==(t=n.exec(e));)if(t[3])r[t[1]]=t[3];else if(t[2]){var o=void 0;try{o=JSON.parse(t[2])}catch(e){}r[t[1]]=o}return r}var Lt=function(){function e(e){this.parser=e,Object.assign(this,e.spec.info),this.description=e.spec.info.description||"";var t=this.description.search(/^##?\s+/m);t>-1&&(this.description=this.description.substring(0,t)),this.downloadLink=this.getDownloadLink(),this.downloadFileName=this.getDownloadFileName()}return e.prototype.getDownloadLink=function(){if(this.parser.specUrl)return this.parser.specUrl;if(re&&window.Blob&&window.URL&&window.URL.createObjectURL){var e=new Blob([JSON.stringify(this.parser.spec,null,2)],{type:"application/json"});return window.URL.createObjectURL(e)}},e.prototype.getDownloadFileName=function(){if(!this.parser.specUrl)return"swagger.json"},e}(),Mt=function(e,t,n){var r=e.deref(n);this.id=t,this.sectionId=gt+t,this.type=r.type,this.description=r.description||"","apiKey"===r.type&&(this.apiKey={name:r.name,in:r.in}),"http"===r.type&&(this.http={scheme:r.scheme,bearerFormat:r.bearerFormat}),"openIdConnect"===r.type&&(this.openId={connectUrl:r.openIdConnectUrl}),"oauth2"===r.type&&r.flows&&(this.flows=r.flows)},Dt=function(e){var t=e.spec.components&&e.spec.components.securitySchemes||{};this.schemes=Object.keys(t).map((function(n){return new Mt(e,n,t[n])}))},Ft=function(){function e(){this._counter={}}return e.prototype.reset=function(){this._counter={}},e.prototype.visit=function(e){this._counter[e]=this._counter[e]?this._counter[e]+1:1},e.prototype.exit=function(e){this._counter[e]=this._counter[e]&&this._counter[e]-1},e.prototype.visited=function(e){return!!this._counter[e]},e}(),Ut=function(){function e(e,t,n){var r=this;void 0===n&&(n=new be({})),this.options=n,this._refCounter=new Ft,this.byRef=function(e){var t;if(r.spec){"#"!==e.charAt(0)&&(e="#"+e),e=decodeURIComponent(e);try{t=Ke.get(r.spec,e)}catch(e){}return t||{}}},this.validate(e),this.preprocess(e),this.spec=e,this.mergeRefs=new Set;var o=re?window.location.href:"";"string"==typeof t&&(this.specUrl=Object(se.resolve)(o,t))}return e.prototype.validate=function(e){if(void 0===e.openapi)throw new Error("Document must be valid OpenAPI 3.0.0 definition")},e.prototype.preprocess=function(e){if(!this.options.noAutoAuth&&e.info&&e.components&&e.components.securitySchemes){var t=e.info.description||"";if(!Rt.containsComponent(t,"security-definitions")&&!Rt.containsComponent(t,"SecurityDefinitions")){var n="\x3c!-- ReDoc-Inject: <"+"security-definitions"+"> --\x3e";e.info.description=function(e,t,n){var r=new RegExp("(^|\\n)#\\s?"+t+"\\s*\\n","i"),o=new RegExp("((\\n|^)#\\s*"+t+"\\s*(\\n|$)(?:.|\\n)*?)(\\n#|$)","i");if(r.test(e))return e.replace(o,"$1\n\n"+n+"\n$4");var i=""===e||e.endsWith("\n\n")?"":e.endsWith("\n")?"\n":"\n\n";return""+e+i+"# "+t+"\n\n"+n}(t,"Authentication",n)}}},e.prototype.isRef=function(e){return!!e&&(void 0!==e.$ref&&null!==e.$ref)},e.prototype.resetVisited=function(){this._refCounter=new Ft},e.prototype.exitRef=function(e){this.isRef(e)&&this._refCounter.exit(e.$ref)},e.prototype.deref=function(e,t){if(void 0===t&&(t=!1),this.isRef(e)){var n=this.byRef(e.$ref),r=this._refCounter.visited(e.$ref);if(this._refCounter.visit(e.$ref),r&&!t)return Object.assign({},n,{"x-circular-ref":!0});if(this.isRef(n)){var o=this.deref(n);return this.exitRef(n),o}return n}return e},e.prototype.shalowDeref=function(e){return this.isRef(e)?this.byRef(e.$ref):e},e.prototype.mergeAllOf=function(e,t,n,r){var i=this;if(void 0===n&&(n=!1),void 0===r&&(r=new Set),t&&r.add(t),void 0===(e=this.hoistOneOfs(e)).allOf)return e;var a=Object(o.__assign)(Object(o.__assign)({},e),{allOf:void 0,parentRefs:[],title:e.title||(ft(t)?Ke.baseName(t):void 0)});void 0!==a.properties&&"object"==typeof a.properties&&(a.properties=Object(o.__assign)({},a.properties)),void 0!==a.items&&"object"==typeof a.items&&(a.items=Object(o.__assign)({},a.items));for(var s=0,l=e.allOf.map((function(e){var t;if(!(e&&e.$ref&&r.has(e.$ref))){var o=i.deref(e,n),s=e.$ref||void 0,l=i.mergeAllOf(o,s,n,r);return(t=a.parentRefs).push.apply(t,l.parentRefs||[]),{$ref:s,schema:l}}})).filter((function(e){return void 0!==e}));s<l.length;s++){var c=l[s],u=c.$ref,f=c.schema;if(a.type!==f.type&&void 0!==a.type&&void 0!==f.type)throw new Error('Incompatible types in allOf at "'+t+'"');if(void 0!==f.type&&(a.type=f.type),void 0!==f.properties)for(var p in a.properties=a.properties||{},f.properties)a.properties[p]?a.properties[p]=this.mergeAllOf({allOf:[a.properties[p],f.properties[p]]},t+"/properties/"+p):a.properties[p]=f.properties[p];void 0!==f.items&&(a.items=a.items||{},a.items=this.mergeAllOf({allOf:[a.items,f.items]},t+"/items")),void 0!==f.required&&(a.required=(a.required||[]).concat(f.required)),a=Object(o.__assign)(Object(o.__assign)({},f),a),u&&(a.parentRefs.push(u),void 0===a.title&&ft(u))}return a},e.prototype.findDerived=function(e){var t={},n=this.spec.components&&this.spec.components.schemas||{};for(var r in n){var o=this.deref(n[r]);void 0!==o.allOf&&o.allOf.find((function(t){return void 0!==t.$ref&&e.indexOf(t.$ref)>-1}))&&(t["#/components/schemas/"+r]=[o["x-discriminator-value"]||r])}return t},e.prototype.exitParents=function(e){for(var t=0,n=e.parentRefs||[];t<n.length;t++){var r=n[t];this.exitRef({$ref:r})}},e.prototype.hoistOneOfs=function(e){var t=this;if(void 0===e.allOf)return e;for(var n=e.allOf,r=function(e){var r=n[e];if(Array.isArray(r.oneOf)){var i=n.slice(0,e),a=n.slice(e+1);return{value:{oneOf:r.oneOf.map((function(e){var n=t.mergeAllOf({allOf:Object(o.__spreadArrays)(i,[e],a)});return t.exitParents(n),n}))}}}},i=0;i<n.length;i++){var a=r(i);if("object"==typeof a)return a.value}return e},e}(),zt=function(e,t,n){this.options=n,this.parser=new Ut(e,t,n),this.info=new Lt(this.parser),this.externalDocs=this.parser.spec.externalDocs,this.contentItems=tn.buildStructure(this.parser,this.options),this.securitySchemes=new Dt(this.parser)},Bt=function(){function e(e,t,n){this.items=[],this.active=!1,this.expanded=!1,this.id=t.id||e+"/"+de(t.name),this.type=e,this.name=t["x-displayName"]||t.name,this.level=t.level||1,this.description=t.description||"";var r=t.items;r&&r.length&&(this.description=Rt.getTextBeforeHading(this.description,r[0].name)),this.parent=n,this.externalDocs=t.externalDocs,"group"===this.type&&(this.expanded=!0)}return e.prototype.activate=function(){this.active=!0},e.prototype.expand=function(){this.parent&&this.parent.expand(),this.expanded=!0},e.prototype.collapse=function(){"group"!==this.type&&(this.expanded=!1)},e.prototype.deactivate=function(){this.active=!1},Object(o.__decorate)([$e.l],e.prototype,"active",void 0),Object(o.__decorate)([$e.l],e.prototype,"expanded",void 0),Object(o.__decorate)([$e.d],e.prototype,"activate",null),Object(o.__decorate)([$e.d],e.prototype,"expand",null),Object(o.__decorate)([$e.d],e.prototype,"collapse",null),Object(o.__decorate)([$e.d],e.prototype,"deactivate",null),e}(),$t=function(e,t){var n=t.spec.components&&t.spec.components.securitySchemes||{};this.schemes=Object.keys(e||{}).map((function(r){var i=t.deref(n[r]),a=e[r]||[];if(i)return Object(o.__assign)(Object(o.__assign)({},i),{id:r,sectionId:gt+r,scopes:a});console.warn("Non existing security scheme referenced: "+r+". Skipping")})).filter((function(e){return void 0!==e}))},qt=function(){function e(e,t,n,r,o){void 0===o&&(o=!1),this.options=r,this.typePrefix="",this.isCircular=!1,this.activeOneOf=0,this.pointer=t.$ref||n||"",this.rawSchema=e.deref(t),this.schema=e.mergeAllOf(this.rawSchema,this.pointer,o),this.init(e,o),e.exitRef(t),e.exitParents(this.schema),r.showExtensions&&(this.extensions=yt(this.schema,r.showExtensions))}return e.prototype.activateOneOf=function(e){this.activeOneOf=e},e.prototype.init=function(t,n){var r=this,i=this.schema;if(this.isCircular=i["x-circular-ref"],this.title=i.title||ft(this.pointer)&&Ke.baseName(this.pointer)||"",this.description=i.description||"",this.type=i.type||function(e){if(void 0!==e.type)return e.type;for(var t=0,n=Object.keys(ot);t<n.length;t++){var r=n[t],o=ot[r];if(void 0!==e[r])return o}return"any"}(i),this.format=i.format,this.nullable=!!i.nullable,this.enum=i.enum||[],this.example=i.example,this.deprecated=!!i.deprecated,this.pattern=i.pattern,this.externalDocs=i.externalDocs,this.constraints=function(e){var t=[],n=pt("characters",e.minLength,e.maxLength);void 0!==n&&t.push(n);var r=pt("items",e.minItems,e.maxItems);void 0!==r&&t.push(r);var o,i=function(e){if(void 0!==e){var t=e.toString(10);return/^0\.0*1$/.test(t)?"decimal places <= "+t.split(".")[1].length:"multiple of "+t}}(e.multipleOf);return void 0!==i&&t.push(i),void 0!==e.minimum&&void 0!==e.maximum?(o=e.exclusiveMinimum?"( ":"[ ",o+=e.minimum,o+=" .. ",o+=e.maximum,o+=e.exclusiveMaximum?" )":" ]"):void 0!==e.maximum?(o=e.exclusiveMaximum?"< ":"<= ",o+=e.maximum):void 0!==e.minimum&&(o=e.exclusiveMinimum?"> ":">= ",o+=e.minimum),void 0!==o&&t.push(o),t}(i),this.displayType=this.type,this.displayFormat=this.format,this.isPrimitive=function(e,t){return void 0===t&&(t=e.type),void 0===e.oneOf&&void 0===e.anyOf&&("object"===t?void 0!==e.properties?0===Object.keys(e.properties).length:void 0===e.additionalProperties:"array"!==t||void 0===e.items)}(i,this.type),this.default=i.default,this.readOnly=!!i.readOnly,this.writeOnly=!!i.writeOnly,!this.isCircular){if(n||void 0===Wt(i))return n&&Array.isArray(i.oneOf)&&i.oneOf.find((function(e){return e.$ref===r.pointer}))&&delete i.oneOf,void 0!==i.oneOf?(this.initOneOf(i.oneOf,t),this.oneOfType="One of",void(void 0!==i.anyOf&&console.warn("oneOf and anyOf are not supported on the same level. Skipping anyOf at "+this.pointer))):void 0!==i.anyOf?(this.initOneOf(i.anyOf,t),void(this.oneOfType="Any of")):void("object"===this.type?this.fields=function(e,t,n,r){var i=t.properties||{},a=t.additionalProperties,s=t.default||{},l=Object.keys(i||[]).map((function(a){var l=i[a];l||(console.warn('Field "'+a+'" is invalid, skipping.\n Field must be an object but got '+typeof l+' at "'+n+'"'),l={});var c=void 0!==t.required&&t.required.indexOf(a)>-1;return new Ht(e,{name:a,required:c,schema:Object(o.__assign)(Object(o.__assign)({},l),{default:void 0===l.default?s[a]:l.default})},n+"/properties/"+a,r)}));r.sortPropsAlphabetically&&(l=ht(l,"name"));r.requiredPropsFirst&&(l=dt(l,r.sortPropsAlphabetically?void 0:t.required));"object"!=typeof a&&!0!==a||l.push(new Ht(e,{name:("object"==typeof a&&a["x-additionalPropertiesName"]||"property name").concat("*"),required:!1,schema:!0===a?{}:a,kind:"additionalProperties"},n+"/additionalProperties",r));return l}(t,i,this.pointer,this.options):"array"===this.type&&i.items&&(this.items=new e(t,i.items,this.pointer+"/items",this.options),this.displayType=this.items.displayType.split(" or ").map((function(e){return e.replace(/^(string|object|number|integer|array|boolean)s?( ?.*)/,"$1s$2")})).join(" or "),this.displayFormat=this.items.format,this.typePrefix=this.items.typePrefix+ge("arrayOf"),this.title=this.title||this.items.title,this.isPrimitive=this.items.isPrimitive,void 0===this.example&&void 0!==this.items.example&&(this.example=[this.items.example]),this.items.isPrimitive&&(this.enum=this.items.enum)));this.initDiscriminator(i,t)}},e.prototype.initOneOf=function(t,n){var r=this;this.oneOf=t.map((function(t,i){var a=n.deref(t),s=n.mergeAllOf(a,r.pointer+"/oneOf/"+i),l=ft(t.$ref)&&!s.title?Ke.baseName(t.$ref):s.title,c=new e(n,Object(o.__assign)(Object(o.__assign)({},s),{title:l,allOf:[Object(o.__assign)(Object(o.__assign)({},r.schema),{oneOf:void 0,anyOf:void 0})]}),r.pointer+"/oneOf/"+i,r.options);return n.exitRef(t),n.exitParents(s),c})),this.displayType=this.oneOf.map((function(e){var t=e.typePrefix+(e.title?e.title+" ("+e.displayType+")":e.displayType);return t.indexOf(" or ")>-1&&(t="("+t+")"),t})).join(" or ")},e.prototype.initDiscriminator=function(t,n){var r=this,i=Wt(t);this.discriminatorProp=i.propertyName;var a=n.findDerived(Object(o.__spreadArrays)(t.parentRefs||[],[this.pointer]));if(t.oneOf)for(var s=0,l=t.oneOf;s<l.length;s++){var c=l[s];if(void 0!==c.$ref){var u=Ke.baseName(c.$ref);a[c.$ref]=u}}var f=i.mapping||{},p={};for(var d in f){var h=f[d];Array.isArray(p[h])?p[h].push(d):p[h]=[d]}for(var m=Object(o.__assign)(Object(o.__assign)({},a),p),g=[],y=0,v=Object.keys(m);y<v.length;y++){var b=m[h=v[y]];if(Array.isArray(b))for(var w=0,x=b;w<x.length;w++){var k=x[w];g.push({$ref:h,name:k})}else g.push({$ref:h,name:b})}this.oneOf=g.map((function(t){var o=t.$ref,i=t.name,a=new e(n,n.byRef(o),o,r.options,!0);return a.title=i,a}))},Object(o.__decorate)([$e.l],e.prototype,"activeOneOf",void 0),Object(o.__decorate)([$e.d],e.prototype,"activateOneOf",null),e}();function Wt(e){return e.discriminator||e["x-discriminator"]}var Ht=function(){function e(e,t,n,r){this.expanded=!1;var o=e.deref(t);this.kind=t.kind||"field",this.name=t.name||o.name,this.in=o.in,this.required=!!o.required;var i=o.schema,a="";!i&&o.in&&o.content&&(a=Object.keys(o.content)[0],i=o.content[a]&&o.content[a].schema),this.schema=new qt(e,i||{},n,r),this.description=void 0===o.description?this.schema.description||"":o.description,this.example=o.example||this.schema.example,a?this.serializationMime=a:o.style?this.style=o.style:this.in&&(this.style=function(e){switch(e){case"header":return"simple";case"query":return"form";case"path":return"simple";default:return"form"}}(this.in)),this.explode=!!o.explode,this.deprecated=void 0===o.deprecated?!!this.schema.deprecated:o.deprecated,e.exitRef(t),r.showExtensions&&(this.extensions=yt(o,r.showExtensions))}return e.prototype.toggle=function(){this.expanded=!this.expanded},Object(o.__decorate)([$e.l],e.prototype,"expanded",void 0),Object(o.__decorate)([$e.d],e.prototype,"toggle",null),e}(),Vt=n(96),Yt={},Gt=function(){function e(e,t,n,r){this.mime=n;var o=e.deref(t);this.value=o.value,this.summary=o.summary,this.description=o.description,o.externalValue&&(this.externalValueUrl=Object(se.resolve)(e.specUrl||"",o.externalValue)),e.exitRef(t),"application/x-www-form-urlencoded"===n&&this.value&&"object"==typeof this.value&&(this.value=function(e,t){if(void 0===t&&(t={}),Array.isArray(e))throw new Error("Payload must have fields: "+e.toString());return Object.keys(e).map((function(n){var r=e[n],o=t[n]||{},i=o.style,a=void 0===i?"form":i,s=o.explode,l=void 0===s||s;switch(a){case"form":return lt(n,l,r);case"spaceDelimited":return at(r,n,"%20");case"pipeDelimited":return at(r,n,"|");case"deepObject":return st(r,n);default:return console.warn("Incorrect or unsupported encoding style: "+a),""}})).join("&")}(this.value,r))}return e.prototype.getExternalValue=function(e){return this.externalValueUrl?Yt[this.externalValueUrl]?Yt[this.externalValueUrl]:(Yt[this.externalValueUrl]=fetch(this.externalValueUrl).then((function(t){return t.text().then((function(n){if(!t.ok)return Promise.reject(new Error(n));if(!it(e))return n;try{return JSON.parse(n)}catch(e){return n}}))})),Yt[this.externalValueUrl]):Promise.resolve(void 0)},e}(),Qt=function(){function e(e,t,n,r,o){this.name=t,this.isRequestType=n,this.schema=r.schema&&new qt(e,r.schema,"",o),this.onlyRequiredInSamples=o.onlyRequiredInSamples,void 0!==r.examples?this.examples=function(e,t){var n={};for(var r in e)e.hasOwnProperty(r)&&(n[r]=t(e[r],r,e));return n}(r.examples,(function(n){return new Gt(e,n,t,r.encoding)})):void 0!==r.example?this.examples={default:new Gt(e,{value:e.shalowDeref(r.example)},t,r.encoding)}:it(t)&&this.generateExample(e,r)}return e.prototype.generateExample=function(e,t){var n={skipReadOnly:this.isRequestType,skipNonRequired:this.isRequestType&&this.onlyRequiredInSamples,skipWriteOnly:!this.isRequestType};if(this.schema&&this.schema.oneOf){this.examples={};for(var r=0,o=this.schema.oneOf;r<o.length;r++){var i=o[r],a=Vt.sample(i.rawSchema,n,e.spec);this.schema.discriminatorProp&&"object"==typeof a&&a&&(a[this.schema.discriminatorProp]=i.title),this.examples[i.title]=new Gt(e,{value:a},this.name,t.encoding)}}else this.schema&&(this.examples={default:new Gt(e,{value:Vt.sample(t.schema,n,e.spec)},this.name,t.encoding)})},e}(),Xt=function(){function e(e,t,n,r){var i,a;this.isRequestType=n,this.activeMimeIdx=0,r.unstable_ignoreMimeParameters&&(i=t,a={},Object.keys(i).forEach((function(e){var t=i[e],n=e.split(";")[0].trim();a[n]?a[n]=Object(o.__assign)(Object(o.__assign)({},a[n]),t):a[n]=t})),t=a),this.mediaTypes=Object.keys(t).map((function(o){var i=t[o];return e.resetVisited(),new Qt(e,o,n,i,r)}))}return e.prototype.activate=function(e){this.activeMimeIdx=e},Object.defineProperty(e.prototype,"active",{get:function(){return this.mediaTypes[this.activeMimeIdx]},enumerable:!0,configurable:!0}),Object.defineProperty(e.prototype,"hasSample",{get:function(){return this.mediaTypes.filter((function(e){return!!e.examples})).length>0},enumerable:!0,configurable:!0}),Object(o.__decorate)([$e.l],e.prototype,"activeMimeIdx",void 0),Object(o.__decorate)([$e.d],e.prototype,"activate",null),Object(o.__decorate)([$e.e],e.prototype,"active",null),e}(),Kt=function(e,t,n){var r=e.deref(t);this.description=r.description||"",this.required=!!r.required,e.exitRef(t),void 0!==r.content&&(this.content=new Xt(e,r.content,!0,n))},Jt=function(){function e(e,t,n,r,i){this.headers=[],this.expanded="all"===i.expandResponses||i.expandResponses[t];var a=e.deref(r);e.exitRef(r),this.code=t,void 0!==a.content&&(this.content=new Xt(e,a.content,!1,i)),void 0!==a["x-summary"]?(this.summary=a["x-summary"],this.description=a.description||""):(this.summary=a.description||"",this.description=""),this.type=tt(t,n);var s=a.headers;void 0!==s&&(this.headers=Object.keys(s).map((function(t){var n=s[t];return new Ht(e,Object(o.__assign)(Object(o.__assign)({},n),{name:t}),"",i)})))}return e.prototype.toggle=function(){this.expanded=!this.expanded},Object(o.__decorate)([$e.l],e.prototype,"expanded",void 0),Object(o.__decorate)([$e.d],e.prototype,"toggle",null),e}();var Zt,en=function(){function e(e,t,n,r){var o;this.parser=e,this.operationSpec=t,this.options=r,this.type="operation",this.items=[],this.ready=!0,this.active=!1,this.expanded=!1,this.pointer=Ke.compile(["paths",t.pathName,t.httpVerb]),this.id=void 0!==t.operationId?"operation/"+t.operationId:void 0!==n?n.id+this.pointer:this.pointer,this.name=(o=t).summary||o.operationId||o.description&&o.description.substring(0,50)||"<no summary>",this.description=t.description,this.parent=n,this.externalDocs=t.externalDocs,this.deprecated=!!t.deprecated,this.httpVerb=t.httpVerb,this.deprecated=!!t.deprecated,this.operationId=t.operationId,this.path=t.pathName;var i=e.byRef(Ke.compile(["paths",t.pathName]));this.servers=mt(e.specUrl,t.servers||i&&i.servers||e.spec.servers||[]),this.security=(t.security||e.spec.security||[]).map((function(t){return new $t(t,e)})),r.showExtensions&&(this.extensions=yt(t,r.showExtensions))}return e.prototype.activate=function(){this.active=!0},e.prototype.deactivate=function(){this.active=!1},e.prototype.expand=function(){this.parent&&this.parent.expand()},e.prototype.collapse=function(){},Object.defineProperty(e.prototype,"requestBody",{get:function(){return this.operationSpec.requestBody&&new Kt(this.parser,this.operationSpec.requestBody,this.options)},enumerable:!0,configurable:!0}),Object.defineProperty(e.prototype,"codeSamples",{get:function(){var e=this.operationSpec["x-code-samples"]||[],t=this.requestBody&&this.requestBody.content;if(t&&t.hasSample){var n=Math.min(e.length,this.options.payloadSampleIdx);e=Object(o.__spreadArrays)(e.slice(0,n),[{lang:"payload",label:"Payload",source:"",requestBodyContent:t}],e.slice(n))}return e},enumerable:!0,configurable:!0}),Object.defineProperty(e.prototype,"parameters",{get:function(){var e=this,t=function(e,t,n){void 0===t&&(t=[]),void 0===n&&(n=[]);var r={};return n.forEach((function(t){t=e.shalowDeref(t),r[t.name+"_"+t.in]=!0})),(t=t.filter((function(t){return t=e.shalowDeref(t),!r[t.name+"_"+t.in]}))).concat(n)}(this.parser,this.operationSpec.pathParameters,this.operationSpec.parameters).map((function(t){return new Ht(e.parser,t,e.pointer,e.options)}));return this.options.sortPropsAlphabetically?ht(t,"name"):this.options.requiredPropsFirst?dt(t):t},enumerable:!0,configurable:!0}),Object.defineProperty(e.prototype,"responses",{get:function(){var e=this,t=!1;return Object.keys(this.operationSpec.responses||[]).filter((function(e){return"default"===e||("success"===tt(e)&&(t=!0),"default"===(n=e)||ue(n)||et(n));var n})).map((function(n){return new Jt(e.parser,n,t,e.operationSpec.responses[n],e.options)}))},enumerable:!0,configurable:!0}),Object(o.__decorate)([$e.l],e.prototype,"ready",void 0),Object(o.__decorate)([$e.l],e.prototype,"active",void 0),Object(o.__decorate)([$e.l],e.prototype,"expanded",void 0),Object(o.__decorate)([$e.d],e.prototype,"activate",null),Object(o.__decorate)([$e.d],e.prototype,"deactivate",null),Object(o.__decorate)([_t],e.prototype,"requestBody",null),Object(o.__decorate)([_t],e.prototype,"codeSamples",null),Object(o.__decorate)([_t],e.prototype,"parameters",null),Object(o.__decorate)([_t],e.prototype,"responses",null),e}(),tn=function(){function e(){}return e.buildStructure=function(t,n){var r=t.spec,o=[],i=e.getTagsWithOperations(r);return o.push.apply(o,e.addMarkdownItems(r.info.description||"",void 0,1,n)),r["x-tagGroups"]&&r["x-tagGroups"].length>0?o.push.apply(o,e.getTagGroupsItems(t,void 0,r["x-tagGroups"],i,n)):o.push.apply(o,e.getTagsItems(t,i,void 0,void 0,n)),o},e.addMarkdownItems=function(e,t,n,r){var o=new Rt(r).extractHeadings(e||"");o.length&&t&&t.description&&(t.description=Rt.getTextBeforeHading(t.description,o[0].name));var i=function(e,t,n){return void 0===n&&(n=1),t.map((function(t){var r,o=new Bt("section",t,e);return o.depth=n,t.items&&(o.items=i(o,t.items,n+1)),Rt.containsComponent(o.description||"","security-definitions")&&(r=o.id+"/",gt=r),o}))};return i(t,o,n)},e.getTagGroupsItems=function(t,n,r,o,i){for(var a=[],s=0,l=r;s<l.length;s++){var c=l[s],u=new Bt("group",c,n);u.depth=0,u.items=e.getTagsItems(t,o,u,c,i),a.push(u)}return a},e.getTagsItems=function(t,n,r,i,a){for(var s=[],l=0,c=(void 0===i?Object.keys(n):i.tags).map((function(e){return n[e]?(n[e].used=!0,n[e]):(console.warn('Non-existing tag "'+e+'" is added to the group "'+i.name+'"'),null)}));l<c.length;l++){var u=c[l];if(u){var f=new Bt("tag",u,r);if(f.depth=1,""!==u.name)f.items=Object(o.__spreadArrays)(e.addMarkdownItems(u.description||"",f,f.depth+1,a),this.getOperationsItems(t,f,u,f.depth+1,a)),s.push(f);else{var p=Object(o.__spreadArrays)(e.addMarkdownItems(u.description||"",f,f.depth+1,a),this.getOperationsItems(t,void 0,u,f.depth+1,a));s.push.apply(s,p)}}}return s},e.getOperationsItems=function(e,t,n,r,o){if(0===n.operations.length)return[];for(var i=[],a=0,s=n.operations;a<s.length;a++){var l=s[a],c=new en(e,l,t,o);c.depth=r,i.push(c)}return i},e.getTagsWithOperations=function(e){for(var t={},n=0,r=e.tags||[];n<r.length;n++){t[(y=r[n]).name]=Object(o.__assign)(Object(o.__assign)({},y),{operations:[]})}for(var i=e.paths,a=0,s=Object.keys(i);a<s.length;a++)for(var l=s[a],c=i[l],u=0,f=Object.keys(c).filter(rt);u<f.length;u++){var p=f[u],d=c[p],h=d.tags;h&&h.length||(h=[""]);for(var m=0,g=h;m<g.length;m++){var y,v=g[m];void 0===(y=t[v])&&(y={name:v,operations:[]},t[v]=y),y["x-traitTag"]||y.operations.push(Object(o.__assign)(Object(o.__assign)({},d),{pathName:l,httpVerb:p,pathParameters:c.parameters||[]}))}}return t},e}(),nn="data-section-id",rn=function(){function e(e,t,n){var r,o,i,a,s=this;this.scroll=t,this.history=n,this.activeItemIdx=-1,this.sideBarOpened=!1,this.updateOnScroll=function(e){for(var t=e?1:-1,n=s.activeItemIdx;(-1!==n||e)&&!(n>=s.flatItems.length-1&&e);){if(e){var r=s.getElementAtOrFirstChild(n+1);if(s.scroll.isElementBellow(r))break}else{r=s.getElementAt(n);if(s.scroll.isElementAbove(r))break}n+=t}s.activate(s.flatItems[n],!0,!0)},this.updateOnHistory=function(e){var t;(void 0===e&&(e=s.history.currentId),e)&&((t=s.flatItems.find((function(t){return t.id===e})))?s.activateAndScroll(t,!1):(e.startsWith(gt)&&(t=s.flatItems.find((function(e){return gt.startsWith(e.id)})),s.activate(t)),s.scroll.scrollIntoViewBySelector("["+nn+'="'+e+'"]')))},this.getItemById=function(e){return s.flatItems.find((function(t){return t.id===e}))},this.items=e.contentItems,this.flatItems=(r=this.items||[],o="items",i=[],(a=function(e){for(var t=0,n=e;t<n.length;t++){var r=n[t];i.push(r),r[o]&&a(r[o])}})(r),i),this.flatItems.forEach((function(e,t){return e.absoluteIdx=t})),this.subscribe()}return e.updateOnHistory=function(e,t){void 0===e&&(e=Tt.currentId),e&&t.scrollIntoViewBySelector("["+nn+'="'+e+'"]')},e.prototype.subscribe=function(){this._unsubscribe=this.scroll.subscribe(this.updateOnScroll),this._hashUnsubscribe=this.history.subscribe(this.updateOnHistory)},e.prototype.toggleSidebar=function(){this.sideBarOpened=!this.sideBarOpened},e.prototype.closeSidebar=function(){this.sideBarOpened=!1},e.prototype.getElementAt=function(e){var t=this.flatItems[e];return t&&oe("["+nn+'="'+t.id+'"]')||null},e.prototype.getElementAtOrFirstChild=function(e){var t=this.flatItems[e];return t&&"group"===t.type&&(t=t.items[0]),t&&oe("["+nn+'="'+t.id+'"]')||null},Object.defineProperty(e.prototype,"activeItem",{get:function(){return this.flatItems[this.activeItemIdx]||void 0},enumerable:!0,configurable:!0}),e.prototype.activate=function(e,t,n){void 0===t&&(t=!0),void 0===n&&(n=!1),(this.activeItem&&this.activeItem.id)!==(e&&e.id)&&(e&&"group"===e.type||(this.deactivate(this.activeItem),e?e.depth<=0||(this.activeItemIdx=e.absoluteIdx,t&&this.history.replace(e.id,n),e.activate(),e.expand()):this.history.replace("",n)))},e.prototype.deactivate=function(e){if(void 0!==e)for(e.deactivate();void 0!==e;)e.collapse(),e=e.parent},e.prototype.activateAndScroll=function(e,t,n){var r=e&&this.getItemById(e.id)||e;this.activate(r,t,n),this.scrollToActive(),r&&r.items.length||this.closeSidebar()},e.prototype.scrollToActive=function(){this.scroll.scrollIntoView(this.getElementAt(this.activeItemIdx))},e.prototype.dispose=function(){this._unsubscribe(),this._hashUnsubscribe()},Object(o.__decorate)([$e.l],e.prototype,"activeItemIdx",void 0),Object(o.__decorate)([$e.l],e.prototype,"sideBarOpened",void 0),Object(o.__decorate)([$e.d],e.prototype,"toggleSidebar",null),Object(o.__decorate)([$e.d],e.prototype,"closeSidebar",null),Object(o.__decorate)([$e.d],e.prototype,"activate",null),Object(o.__decorate)([$e.d.bound],e.prototype,"activateAndScroll",null),e}(),on=function(){function e(e){this.options=e,this._prevOffsetY=0,this._scrollParent=re?window:void 0,this._emiter=new Ge,this.bind()}return e.prototype.bind=function(){this._prevOffsetY=this.scrollY(),this._scrollParent&&this._scrollParent.addEventListener("scroll",this.handleScroll)},e.prototype.dispose=function(){this._scrollParent&&this._scrollParent.removeEventListener("scroll",this.handleScroll),this._emiter.removeAllListeners("scroll")},e.prototype.scrollY=function(){return"undefined"!=typeof HTMLElement&&this._scrollParent instanceof HTMLElement?this._scrollParent.scrollTop:void 0!==this._scrollParent?this._scrollParent.pageYOffset:0},e.prototype.isElementBellow=function(e){if(null!==e)return e.getBoundingClientRect().top>this.options.scrollYOffset()},e.prototype.isElementAbove=function(e){if(null!==e){var t=e.getBoundingClientRect().top;return(t>0?Math.floor(t):Math.ceil(t))<=this.options.scrollYOffset()}},e.prototype.subscribe=function(e){var t=this._emiter.addListener("scroll",e);return function(){return t.removeListener("scroll",e)}},e.prototype.scrollIntoView=function(e){null!==e&&(e.scrollIntoView(),this._scrollParent&&this._scrollParent.scrollBy&&this._scrollParent.scrollBy(0,1-this.options.scrollYOffset()))},e.prototype.scrollIntoViewBySelector=function(e){var t=oe(e);this.scrollIntoView(t)},e.prototype.handleScroll=function(){var e=this.scrollY()-this._prevOffsetY>0;this._prevOffsetY=this.scrollY(),this._emiter.emit("scroll",e)},Object(o.__decorate)([Ye.bind,xt(100)],e.prototype,"handleScroll",null),e}();if(re)try{Zt=n(313)}catch(e){Zt=n(147).default}else Zt=n(147).default;var an,sn,ln,cn,un,fn,pn,dn,hn,mn,gn,yn,vn,bn,wn,xn,kn,En=function(){function e(){this.searchWorker=new Zt}return e.prototype.indexItems=function(e){var t=this,n=function(e){e.forEach((function(e){"group"!==e.type&&t.add(e.name,e.description||"",e.id),n(e.items)}))};n(e),this.searchWorker.done()},e.prototype.add=function(e,t,n){this.searchWorker.add(e,t,n)},e.prototype.dispose=function(){this.searchWorker.terminate()},e.prototype.search=function(e){return this.searchWorker.search(e)},e.prototype.toJS=function(){return Object(o.__awaiter)(this,void 0,void 0,(function(){return Object(o.__generator)(this,(function(e){return[2,this.searchWorker.toJS()]}))}))},e.prototype.load=function(e){this.searchWorker.load(e)},e}(),On=Te.div(sn||(sn=Object(o.__makeTemplateObject)(["\n width: calc(100% - ",");\n padding: 0 ","px;\n\n ",";\n"],["\n width: calc(100% - ",");\n padding: 0 ","px;\n\n ",";\n"])),(function(e){return e.theme.rightPanel.width}),(function(e){return e.theme.spacing.sectionHorizontal}),(function(e){var t=e.compact,n=e.theme;return Se("medium",!0)(an||(an=Object(o.__makeTemplateObject)(["\n width: 100%;\n padding: ",";\n "],["\n width: 100%;\n padding: ",";\n "])),(t?0:n.spacing.sectionVertical)+"px "+n.spacing.sectionHorizontal+"px")})),_n=Te.div.attrs((function(e){var t;return(t={})[nn]=e.id,t}))(cn||(cn=Object(o.__makeTemplateObject)(["\n padding: ","px 0;\n\n &:last-child {\n min-height: calc(100vh + 1px);\n }\n\n & > &:last-child {\n min-height: initial;\n }\n\n ","\n ","\n"],["\n padding: ","px 0;\n\n &:last-child {\n min-height: calc(100vh + 1px);\n }\n\n & > &:last-child {\n min-height: initial;\n }\n\n ","\n ","\n"])),(function(e){return e.theme.spacing.sectionVertical}),Se("medium",!0)(ln||(ln=Object(o.__makeTemplateObject)(["\n padding: 0;\n "],["\n padding: 0;\n "]))),(function(e){return e.underlined?"\n position: relative;\n\n &:not(:last-of-type):after {\n position: absolute;\n bottom: 0;\n width: 100%;\n display: block;\n content: '';\n border-bottom: 1px solid rgba(0, 0, 0, 0.2);\n }\n ":""})),Sn=Te.div(fn||(fn=Object(o.__makeTemplateObject)(["\n width: ",";\n color: ",";\n background-color: ",";\n padding: 0 ","px;\n\n ",";\n"],["\n width: ",";\n color: ",";\n background-color: ",";\n padding: 0 ","px;\n\n ",";\n"])),(function(e){return e.theme.rightPanel.width}),(function(e){return e.theme.rightPanel.textColor}),(function(e){return e.theme.rightPanel.backgroundColor}),(function(e){return e.theme.spacing.sectionHorizontal}),Se("medium",!0)(un||(un=Object(o.__makeTemplateObject)(["\n width: 100%;\n padding: ",";\n "],["\n width: 100%;\n padding: ",";\n "])),(function(e){return e.theme.spacing.sectionVertical+"px "+e.theme.spacing.sectionHorizontal+"px"}))),Tn=Te(Sn)(pn||(pn=Object(o.__makeTemplateObject)(["\n background-color: ",";\n"],["\n background-color: ",";\n"])),(function(e){return e.theme.rightPanel.backgroundColor})),jn=Te.div(hn||(hn=Object(o.__makeTemplateObject)(["\n display: flex;\n width: 100%;\n padding: 0;\n\n ",";\n"],["\n display: flex;\n width: 100%;\n padding: 0;\n\n ",";\n"])),Se("medium",!0)(dn||(dn=Object(o.__makeTemplateObject)(["\n flex-direction: column;\n "],["\n flex-direction: column;\n "])))),Cn={1:"1.85714em",2:"1.57143em",3:"1.27em"},In=function(e){return ke(mn||(mn=Object(o.__makeTemplateObject)(["\n font-family: ",";\n font-weight: ",";\n font-size: ",";\n line-height: ",";\n"],["\n font-family: ",";\n font-weight: ",";\n font-size: ",";\n line-height: ",";\n"])),(function(e){return e.theme.typography.headings.fontFamily}),(function(e){return e.theme.typography.headings.fontWeight}),Cn[e],(function(e){return e.theme.typography.headings.lineHeight}))},An=Te.h1(gn||(gn=Object(o.__makeTemplateObject)(["\n ",";\n color: ",";\n\n ",";\n"],["\n ",";\n color: ",";\n\n ",";\n"])),In(1),(function(e){return e.theme.colors.primary.main}),je("H1")),Pn=Te.h2(yn||(yn=Object(o.__makeTemplateObject)(["\n ",";\n color: black;\n\n ",";\n"],["\n ",";\n color: black;\n\n ",";\n"])),In(2),je("H2")),Rn=(Te.h2(vn||(vn=Object(o.__makeTemplateObject)(["\n ",";\n color: black;\n\n ",";\n"],["\n ",";\n color: black;\n\n ",";\n"])),In(3),je("H3")),Te.h3(bn||(bn=Object(o.__makeTemplateObject)(["\n color: ",";\n\n ",";\n"],["\n color: ",";\n\n ",";\n"])),(function(e){return e.theme.rightPanel.textColor}),je("RightPanelHeader"))),Nn=Te.h5(wn||(wn=Object(o.__makeTemplateObject)(["\n border-bottom: 1px solid rgba(38, 50, 56, 0.3);\n margin: 1em 0 1em 0;\n color: rgba(38, 50, 56, 0.5);\n font-weight: normal;\n text-transform: uppercase;\n font-size: 0.929em;\n line-height: 20px;\n\n ",";\n"],["\n border-bottom: 1px solid rgba(38, 50, 56, 0.3);\n margin: 1em 0 1em 0;\n color: rgba(38, 50, 56, 0.5);\n font-weight: normal;\n text-transform: uppercase;\n font-size: 0.929em;\n line-height: 20px;\n\n ",";\n"])),je("UnderlinedHeader")),Ln=n(154),Mn=Object(i.createContext)(void 0),Dn=Mn.Provider,Fn=Mn.Consumer,Un=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.state={loading:!0,resolvedSpec:null},t}return Object(o.__extends)(t,e),t.getDerivedStateFromProps=function(e,t){return e.specUrl!==t.prevSpecUrl||e.spec!==t.prevSpec?{loading:!0,resolvedSpec:null,prevSpec:e.spec,prevSpecUrl:e.specUrl}:null},t.prototype.makeStore=function(e,t,n){if(e)try{return new Ks(e,t,n)}catch(e){throw this.props.onLoaded&&this.props.onLoaded(e),e}},t.prototype.componentDidMount=function(){this.load()},t.prototype.componentDidUpdate=function(){null===this.state.resolvedSpec?this.load():!this.state.loading&&this.props.onLoaded&&this.props.onLoaded()},t.prototype.load=function(){return Object(o.__awaiter)(this,void 0,void 0,(function(){var e,t,n,r,i;return Object(o.__generator)(this,(function(o){switch(o.label){case 0:e=this.props,t=e.specUrl,n=e.spec,o.label=1;case 1:return o.trys.push([1,3,,4]),[4,He(n||t)];case 2:return r=o.sent(),this.setState({resolvedSpec:r,loading:!1}),[3,4];case 3:return i=o.sent(),this.props.onLoaded&&this.props.onLoaded(i),this.setState({error:i}),[3,4];case 4:return[2]}}))}))},t.prototype.render=function(){if(this.state.error)throw this.state.error;var e=this.props,t=e.specUrl,n=e.options,r=this.state,o=r.loading,i=r.resolvedSpec;return this.props.children({loading:o,store:this.makeStore(i,t,n)})},Object(o.__decorate)([Ln],t.prototype,"makeStore",null),t}(i.Component),zn=function(e){return ke(xn||(xn=Object(o.__makeTemplateObject)(["\n "," {\n cursor: pointer;\n margin-left: -20px;\n padding: 0;\n line-height: 1;\n width: 20px;\n display: inline-block;\n }\n ",":before {\n content: '';\n width: 15px;\n height: 15px;\n background-size: contain;\n background-image: url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');\n opacity: 0.5;\n visibility: hidden;\n display: inline-block;\n vertical-align: middle;\n }\n\n h1:hover > ","::before, h2:hover > ","::before, ",":hover::before {\n visibility: visible;\n }\n"],["\n "," {\n cursor: pointer;\n margin-left: -20px;\n padding: 0;\n line-height: 1;\n width: 20px;\n display: inline-block;\n }\n ",":before {\n content: '';\n width: 15px;\n height: 15px;\n background-size: contain;\n background-image: url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');\n opacity: 0.5;\n visibility: hidden;\n display: inline-block;\n vertical-align: middle;\n }\n\n h1:hover > ","::before, h2:hover > ","::before, ",":hover::before {\n visibility: visible;\n }\n"])),e,e,e,e,e)},Bn=function(e){return!!(e.metaKey||e.altKey||e.ctrlKey||e.shiftKey)},$n=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.navigate=function(e,n){n.defaultPrevented||0!==n.button||Bn(n)||(n.preventDefault(),e.replace(t.props.to))},t}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this;return i.createElement(Fn,null,(function(t){return i.createElement("a",{className:e.props.className,href:t.menu.history.linkForId(e.props.to),onClick:e.navigate.bind(e,t.menu.history)},e.props.children)}))},t}(i.Component),qn=Te($n)(kn||(kn=Object(o.__makeTemplateObject)(["\n ",";\n"],["\n ",";\n"])),zn("&"));function Wn(e){return i.createElement(qn,{to:e.to})}var Hn,Vn,Yn,Gn,Qn,Xn,Kn,Jn,Zn,er,tr,nr,rr,or,ir,ar,sr,lr,cr,ur={left:"90deg",right:"-90deg",up:"-180deg",down:"0"},fr=Te(function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){return i.createElement("svg",{className:this.props.className,style:this.props.style,version:"1.1",viewBox:"0 0 24 24",x:"0",xmlns:"http://www.w3.org/2000/svg",y:"0"},i.createElement("polygon",{points:"17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "}))},t}(i.PureComponent))(Hn||(Hn=Object(o.__makeTemplateObject)(["\n height: ",";\n width: ",";\n vertical-align: middle;\n float: ",";\n transition: transform 0.2s ease-out;\n transform: rotateZ(",");\n\n polygon {\n fill: ",";\n }\n"],["\n height: ",";\n width: ",";\n vertical-align: middle;\n float: ",";\n transition: transform 0.2s ease-out;\n transform: rotateZ(",");\n\n polygon {\n fill: ",";\n }\n"])),(function(e){return e.size||"18px"}),(function(e){return e.size||"18px"}),(function(e){return e.float||""}),(function(e){return ur[e.direction||"down"]}),(function(e){return e.color&&e.theme.colors[e.color]&&e.theme.colors[e.color].main||e.color})),pr=Te.span(Vn||(Vn=Object(o.__makeTemplateObject)(["\n display: inline-block;\n padding: 0 5px;\n margin: 0;\n background-color: ",";\n color: ",";\n font-size: ",";\n vertical-align: text-top;\n"],["\n display: inline-block;\n padding: 0 5px;\n margin: 0;\n background-color: ",";\n color: ",";\n font-size: ",";\n vertical-align: text-top;\n"])),(function(e){return e.theme.colors[e.type].main}),(function(e){return e.theme.colors[e.type].contrastText}),(function(e){return e.theme.typography.code.fontSize})),dr=ke(Yn||(Yn=Object(o.__makeTemplateObject)(["\n text-decoration: line-through;\n color: #bdccd3;\n"],["\n text-decoration: line-through;\n color: #bdccd3;\n"]))),hr=Te.caption(Gn||(Gn=Object(o.__makeTemplateObject)(["\n text-align: right;\n font-size: 0.9em;\n font-weight: normal;\n color: ",";\n"],["\n text-align: right;\n font-size: 0.9em;\n font-weight: normal;\n color: ",";\n"])),(function(e){return e.theme.colors.text.secondary})),mr=Te.td(Qn||(Qn=Object(o.__makeTemplateObject)(["\n border-left: 1px solid ",";\n box-sizing: border-box;\n position: relative;\n padding: 10px 10px 10px 0;\n\n tr:first-of-type > &,\n tr.last > & {\n border-left-width: 0;\n background-position: top left;\n background-repeat: no-repeat;\n background-size: 1px 100%;\n }\n\n tr:first-of-type > & {\n background-image: linear-gradient(\n to bottom,\n transparent 0%,\n transparent 22px,\n "," 22px,\n "," 100%\n );\n }\n\n tr.last > & {\n background-image: linear-gradient(\n to bottom,\n "," 0%,\n "," 22px,\n transparent 22px,\n transparent 100%\n );\n }\n\n tr.last + tr > & {\n border-left-color: transparent;\n }\n\n tr.last:first-child > & {\n background: none;\n border-left-color: transparent;\n }\n"],["\n border-left: 1px solid ",";\n box-sizing: border-box;\n position: relative;\n padding: 10px 10px 10px 0;\n\n tr:first-of-type > &,\n tr.last > & {\n border-left-width: 0;\n background-position: top left;\n background-repeat: no-repeat;\n background-size: 1px 100%;\n }\n\n tr:first-of-type > & {\n background-image: linear-gradient(\n to bottom,\n transparent 0%,\n transparent 22px,\n "," 22px,\n "," 100%\n );\n }\n\n tr.last > & {\n background-image: linear-gradient(\n to bottom,\n "," 0%,\n "," 22px,\n transparent 22px,\n transparent 100%\n );\n }\n\n tr.last + tr > & {\n border-left-color: transparent;\n }\n\n tr.last:first-child > & {\n background: none;\n border-left-color: transparent;\n }\n"])),(function(e){return e.theme.schema.linesColor}),(function(e){return e.theme.schema.linesColor}),(function(e){return e.theme.schema.linesColor}),(function(e){return e.theme.schema.linesColor}),(function(e){return e.theme.schema.linesColor})),gr=Te(mr)(Xn||(Xn=Object(o.__makeTemplateObject)(["\n padding: 0;\n"],["\n padding: 0;\n"]))),yr=Te(mr)(Kn||(Kn=Object(o.__makeTemplateObject)(["\n vertical-align: top;\n line-height: 20px;\n white-space: nowrap;\n font-size: 0.929em;\n font-family: ",";\n\n &.deprecated {\n ",";\n }\n\n ",";\n\n ",";\n"],["\n vertical-align: top;\n line-height: 20px;\n white-space: nowrap;\n font-size: 0.929em;\n font-family: ",";\n\n &.deprecated {\n ",";\n }\n\n ",";\n\n ",";\n"])),(function(e){return e.theme.typography.code.fontFamily}),dr,(function(e){return"field"!==e.kind?"font-style: italic":""}),je("PropertyNameCell")),vr=Te.td(Jn||(Jn=Object(o.__makeTemplateObject)(["\n border-bottom: 1px solid #9fb4be;\n padding: 10px 0;\n width: ",";\n box-sizing: border-box;\n\n tr.expanded & {\n border-bottom: none;\n }\n"],["\n border-bottom: 1px solid #9fb4be;\n padding: 10px 0;\n width: ",";\n box-sizing: border-box;\n\n tr.expanded & {\n border-bottom: none;\n }\n"])),(function(e){return e.theme.schema.defaultDetailsWidth})),br=Te.span(Zn||(Zn=Object(o.__makeTemplateObject)(["\n color: ",";\n font-family: ",";\n margin-right: 10px;\n\n &::before {\n content: '';\n display: inline-block;\n vertical-align: middle;\n width: 10px;\n height: 1px;\n background: ",";\n }\n\n &::after {\n content: '';\n display: inline-block;\n vertical-align: middle;\n width: 1px;\n background: ",";\n height: 7px;\n }\n"],["\n color: ",";\n font-family: ",";\n margin-right: 10px;\n\n &::before {\n content: '';\n display: inline-block;\n vertical-align: middle;\n width: 10px;\n height: 1px;\n background: ",";\n }\n\n &::after {\n content: '';\n display: inline-block;\n vertical-align: middle;\n width: 1px;\n background: ",";\n height: 7px;\n }\n"])),(function(e){return e.theme.schema.linesColor}),(function(e){return e.theme.typography.code.fontFamily}),(function(e){return e.theme.schema.linesColor}),(function(e){return e.theme.schema.linesColor})),wr=Te.div(er||(er=Object(o.__makeTemplateObject)(["\n padding: ",";\n"],["\n padding: ",";\n"])),(function(e){return e.theme.schema.nestingSpacing})),xr=Te.table(tr||(tr=Object(o.__makeTemplateObject)(["\n border-collapse: separate;\n border-radius: 3px;\n font-size: ",";\n\n border-spacing: 0;\n width: 100%;\n\n > tr {\n vertical-align: middle;\n }\n\n &\n ",",\n &\n ","\n ","\n ",",\n &\n ","\n ","\n ","\n ","\n "," {\n margin: ",";\n margin-right: 0;\n background: ",";\n }\n\n &\n ","\n ",",\n &\n ","\n ","\n ","\n ",",\n &\n ","\n ","\n ","\n ","\n ","\n "," {\n background: #ffffff;\n }\n"],["\n border-collapse: separate;\n border-radius: 3px;\n font-size: ",";\n\n border-spacing: 0;\n width: 100%;\n\n > tr {\n vertical-align: middle;\n }\n\n &\n ",",\n &\n ","\n ","\n ",",\n &\n ","\n ","\n ","\n ","\n "," {\n margin: ",";\n margin-right: 0;\n background: ",";\n }\n\n &\n ","\n ",",\n &\n ","\n ","\n ","\n ",",\n &\n ","\n ","\n ","\n ","\n ","\n "," {\n background: #ffffff;\n }\n"])),(function(e){return e.theme.typography.fontSize}),wr,wr,wr,wr,wr,wr,wr,wr,wr,(function(e){return e.theme.schema.nestingSpacing}),(function(e){return e.theme.schema.nestedBackground}),wr,wr,wr,wr,wr,wr,wr,wr,wr,wr,wr,wr),kr=Te.ul(nr||(nr=Object(o.__makeTemplateObject)(["\n margin: 0 0 3px 0;\n padding: 0;\n list-style: none;\n display: inline-block;\n"],["\n margin: 0 0 3px 0;\n padding: 0;\n list-style: none;\n display: inline-block;\n"]))),Er=Te.span(rr||(rr=Object(o.__makeTemplateObject)(["\n font-size: 0.9em;\n margin-right: 10px;\n color: ",";\n font-family: ",";\n}\n"],["\n font-size: 0.9em;\n margin-right: 10px;\n color: ",";\n font-family: ",";\n}\n"])),(function(e){return e.theme.colors.primary.main}),(function(e){return e.theme.typography.headings.fontFamily})),Or=Te.li(or||(or=Object(o.__makeTemplateObject)(["\n display: inline-block;\n margin-right: 10px;\n margin-bottom: 5px;\n font-size: 0.8em;\n cursor: pointer;\n border: 1px solid ",";\n padding: 2px 10px;\n\n ","\n"],["\n display: inline-block;\n margin-right: 10px;\n margin-bottom: 5px;\n font-size: 0.8em;\n cursor: pointer;\n border: 1px solid ",";\n padding: 2px 10px;\n\n ","\n"])),(function(e){return e.theme.colors.primary.main}),(function(e){return e.active?"\n color: white;\n background-color: "+e.theme.colors.primary.main+";\n ":"\n color: "+e.theme.colors.primary.main+";\n background-color: white;\n "})),_r=Te.div(ir||(ir=Object(o.__makeTemplateObject)(["\n font-size: 0.9em;\n font-family: ",";\n &::after {\n content: ' [';\n }\n"],["\n font-size: 0.9em;\n font-family: ",";\n &::after {\n content: ' [';\n }\n"])),(function(e){return e.theme.typography.code.fontFamily})),Sr=Te.div(ar||(ar=Object(o.__makeTemplateObject)(["\n font-size: 0.9em;\n font-family: ",";\n &::after {\n content: ']';\n }\n"],["\n font-size: 0.9em;\n font-family: ",";\n &::after {\n content: ']';\n }\n"])),(function(e){return e.theme.typography.code.fontFamily})),Tr=n(155),jr=Te(n.n(Tr).a)(sr||(sr=Object(o.__makeTemplateObject)(["\n min-width: 100px;\n display: inline-block;\n position: relative;\n width: auto;\n font-family: ",";\n\n .Dropdown-control {\n font-family: ",";\n position: relative;\n font-size: 0.929em;\n width: 100%;\n line-height: 1.5em;\n vertical-align: middle;\n cursor: pointer;\n border-color: rgba(38, 50, 56, 0.5);\n color: #263238;\n outline: none;\n padding: 0.15em 1.5em 0.2em 0.5em;\n border-radius: 2px;\n border-width: 1px;\n border-style: solid;\n margin-top: 5px;\n background: white;\n\n box-sizing: border-box;\n\n &:hover {\n border-color: ",";\n color: ",";\n box-shadow: 0px 2px 4px 0px rgba(34, 36, 38, 0.12);\n }\n }\n\n .Dropdown-arrow {\n border-color: "," transparent transparent;\n border-style: solid;\n border-width: 0.35em 0.35em 0;\n content: ' ';\n display: block;\n height: 0;\n position: absolute;\n right: 0.3em;\n top: 50%;\n margin-top: -0.125em;\n width: 0;\n }\n\n .Dropdown-menu {\n position: absolute;\n margin-top: 2px;\n left: 0;\n right: 0;\n\n z-index: 10;\n min-width: 100px;\n\n background: white;\n border: 1px solid rgba(38, 50, 56, 0.2);\n box-shadow: 0px 2px 4px 0px rgba(34, 36, 38, 0.12), 0px 2px 10px 0px rgba(34, 36, 38, 0.08);\n\n max-height: 220px;\n overflow: auto;\n }\n\n .Dropdown-option {\n font-size: 0.9em;\n color: #263238;\n cursor: pointer;\n padding: 0.4em;\n\n &.is-selected {\n background-color: rgba(0, 0, 0, 0.05);\n }\n\n &:hover {\n background-color: rgba(38, 50, 56, 0.12);\n }\n }\n"],["\n min-width: 100px;\n display: inline-block;\n position: relative;\n width: auto;\n font-family: ",";\n\n .Dropdown-control {\n font-family: ",";\n position: relative;\n font-size: 0.929em;\n width: 100%;\n line-height: 1.5em;\n vertical-align: middle;\n cursor: pointer;\n border-color: rgba(38, 50, 56, 0.5);\n color: #263238;\n outline: none;\n padding: 0.15em 1.5em 0.2em 0.5em;\n border-radius: 2px;\n border-width: 1px;\n border-style: solid;\n margin-top: 5px;\n background: white;\n\n box-sizing: border-box;\n\n &:hover {\n border-color: ",";\n color: ",";\n box-shadow: 0px 2px 4px 0px rgba(34, 36, 38, 0.12);\n }\n }\n\n .Dropdown-arrow {\n border-color: "," transparent transparent;\n border-style: solid;\n border-width: 0.35em 0.35em 0;\n content: ' ';\n display: block;\n height: 0;\n position: absolute;\n right: 0.3em;\n top: 50%;\n margin-top: -0.125em;\n width: 0;\n }\n\n .Dropdown-menu {\n position: absolute;\n margin-top: 2px;\n left: 0;\n right: 0;\n\n z-index: 10;\n min-width: 100px;\n\n background: white;\n border: 1px solid rgba(38, 50, 56, 0.2);\n box-shadow: 0px 2px 4px 0px rgba(34, 36, 38, 0.12), 0px 2px 10px 0px rgba(34, 36, 38, 0.08);\n\n max-height: 220px;\n overflow: auto;\n }\n\n .Dropdown-option {\n font-size: 0.9em;\n color: #263238;\n cursor: pointer;\n padding: 0.4em;\n\n &.is-selected {\n background-color: rgba(0, 0, 0, 0.05);\n }\n\n &:hover {\n background-color: rgba(38, 50, 56, 0.12);\n }\n }\n"])),(function(e){return e.theme.typography.headings.fontFamily}),(function(e){return e.theme.typography.headings.fontFamily}),(function(e){return e.theme.colors.primary.main}),(function(e){return e.theme.colors.primary.main}),(function(e){return e.theme.colors.primary.main})),Cr=Te(jr)(lr||(lr=Object(o.__makeTemplateObject)(["\n margin-left: 10px;\n text-transform: none;\n font-size: 0.969em;\n\n .Dropdown-control {\n font-size: 1em;\n border: none;\n padding: 0 1.2em 0 0;\n background: transparent;\n\n &:hover {\n color: ",";\n box-shadow: none;\n }\n }\n"],["\n margin-left: 10px;\n text-transform: none;\n font-size: 0.969em;\n\n .Dropdown-control {\n font-size: 1em;\n border: none;\n padding: 0 1.2em 0 0;\n background: transparent;\n\n &:hover {\n color: ",";\n box-shadow: none;\n }\n }\n"])),(function(e){return e.theme.colors.primary.main})),Ir=Te.span(cr||(cr=Object(o.__makeTemplateObject)(["\n margin-left: 10px;\n text-transform: none;\n font-size: 0.929em;\n color: black;\n"],["\n margin-left: 10px;\n text-transform: none;\n font-size: 0.929em;\n color: black;\n"])));function Ar(e){return e.type&&"Tab"===e.type.tabsRole}function Pr(e){return e.type&&"TabPanel"===e.type.tabsRole}function Rr(e){return e.type&&"TabList"===e.type.tabsRole}function Nr(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function Lr(e,t){return i.Children.map(e,(function(e){return null===e?null:function(e){return Ar(e)||Rr(e)||Pr(e)}(e)?t(e):e.props&&e.props.children&&"object"==typeof e.props.children?Object(i.cloneElement)(e,function(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{},r=Object.keys(n);"function"==typeof Object.getOwnPropertySymbols&&(r=r.concat(Object.getOwnPropertySymbols(n).filter((function(e){return Object.getOwnPropertyDescriptor(n,e).enumerable})))),r.forEach((function(t){Nr(e,t,n[t])}))}return e}({},e.props,{children:Lr(e.props.children,t)})):e}))}function Mr(e,t){return i.Children.forEach(e,(function(e){null!==e&&(Ar(e)||Pr(e)?t(e):e.props&&e.props.children&&"object"==typeof e.props.children&&(Rr(e)&&t(e),Mr(e.props.children,t)))}))}var Dr,Fr=n(17),Ur=n.n(Fr),zr=0;function Br(){return"react-tabs-"+zr++}function $r(e){var t=0;return Mr(e,(function(e){Ar(e)&&t++})),t}function qr(){return(qr=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e}).apply(this,arguments)}function Wr(e){return e&&"getAttribute"in e}function Hr(e){return Wr(e)&&"tab"===e.getAttribute("role")}function Vr(e){return Wr(e)&&"true"===e.getAttribute("aria-disabled")}try{Dr=!("undefined"==typeof window||!window.document||!window.document.activeElement)}catch(e){Dr=!1}var Yr=function(e){var t,n;function r(){for(var t,n=arguments.length,r=new Array(n),o=0;o<n;o++)r[o]=arguments[o];return(t=e.call.apply(e,[this].concat(r))||this).tabNodes=[],t.handleKeyDown=function(e){if(t.isTabFromContainer(e.target)){var n=t.props.selectedIndex,r=!1,o=!1;32!==e.keyCode&&13!==e.keyCode||(r=!0,o=!1,t.handleClick(e)),37===e.keyCode||38===e.keyCode?(n=t.getPrevTab(n),r=!0,o=!0):39===e.keyCode||40===e.keyCode?(n=t.getNextTab(n),r=!0,o=!0):35===e.keyCode?(n=t.getLastTab(),r=!0,o=!0):36===e.keyCode&&(n=t.getFirstTab(),r=!0,o=!0),r&&e.preventDefault(),o&&t.setSelected(n,e)}},t.handleClick=function(e){var n=e.target;do{if(t.isTabFromContainer(n)){if(Vr(n))return;var r=[].slice.call(n.parentNode.children).filter(Hr).indexOf(n);return void t.setSelected(r,e)}}while(null!=(n=n.parentNode))},t}n=e,(t=r).prototype=Object.create(n.prototype),t.prototype.constructor=t,t.__proto__=n;var o=r.prototype;return o.setSelected=function(e,t){if(!(e<0||e>=this.getTabsCount())){var n=this.props;(0,n.onSelect)(e,n.selectedIndex,t)}},o.getNextTab=function(e){for(var t=this.getTabsCount(),n=e+1;n<t;n++)if(!Vr(this.getTab(n)))return n;for(var r=0;r<e;r++)if(!Vr(this.getTab(r)))return r;return e},o.getPrevTab=function(e){for(var t=e;t--;)if(!Vr(this.getTab(t)))return t;for(t=this.getTabsCount();t-- >e;)if(!Vr(this.getTab(t)))return t;return e},o.getFirstTab=function(){for(var e=this.getTabsCount(),t=0;t<e;t++)if(!Vr(this.getTab(t)))return t;return null},o.getLastTab=function(){for(var e=this.getTabsCount();e--;)if(!Vr(this.getTab(e)))return e;return null},o.getTabsCount=function(){return $r(this.props.children)},o.getPanelsCount=function(){return function(e){var t=0;return Mr(e,(function(e){Pr(e)&&t++})),t}(this.props.children)},o.getTab=function(e){return this.tabNodes["tabs-"+e]},o.getChildren=function(){var e=this,t=0,n=this.props,r=n.children,o=n.disabledTabClassName,s=n.focus,l=n.forceRenderTabPanel,c=n.selectedIndex,u=n.selectedTabClassName,f=n.selectedTabPanelClassName;this.tabIds=this.tabIds||[],this.panelIds=this.panelIds||[];for(var p=this.tabIds.length-this.getTabsCount();p++<0;)this.tabIds.push(Br()),this.panelIds.push(Br());return Lr(r,(function(n){var r=n;if(Rr(n)){var p=0,d=!1;Dr&&(d=a.a.Children.toArray(n.props.children).filter(Ar).some((function(t,n){return document.activeElement===e.getTab(n)}))),r=Object(i.cloneElement)(n,{children:Lr(n.props.children,(function(t){var n="tabs-"+p,r=c===p,a={tabRef:function(t){e.tabNodes[n]=t},id:e.tabIds[p],panelId:e.panelIds[p],selected:r,focus:r&&(s||d)};return u&&(a.selectedClassName=u),o&&(a.disabledClassName=o),p++,Object(i.cloneElement)(t,a)}))})}else if(Pr(n)){var h={id:e.panelIds[t],tabId:e.tabIds[t],selected:c===t};l&&(h.forceRender=l),f&&(h.selectedClassName=f),t++,r=Object(i.cloneElement)(n,h)}return r}))},o.isTabFromContainer=function(e){if(!Hr(e))return!1;var t=e.parentElement;do{if(t===this.node)return!0;if(t.getAttribute("data-tabs"))break;t=t.parentElement}while(t);return!1},o.render=function(){var e=this,t=this.props,n=(t.children,t.className),r=(t.disabledTabClassName,t.domRef),o=(t.focus,t.forceRenderTabPanel,t.onSelect,t.selectedIndex,t.selectedTabClassName,t.selectedTabPanelClassName,function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(t,["children","className","disabledTabClassName","domRef","focus","forceRenderTabPanel","onSelect","selectedIndex","selectedTabClassName","selectedTabPanelClassName"]));return a.a.createElement("div",qr({},o,{className:Ur()(n),onClick:this.handleClick,onKeyDown:this.handleKeyDown,ref:function(t){e.node=t,r&&r(t)},"data-tabs":!0}),this.getChildren())},r}(i.Component);Yr.defaultProps={className:"react-tabs",focus:!1},Yr.propTypes={};var Gr=1,Qr=function(e){var t,n;function r(t){var n;return(n=e.call(this,t)||this).handleSelected=function(e,t,r){var o=n.props.onSelect,i=n.state.mode;if("function"!=typeof o||!1!==o(e,t,r)){var a={focus:"keydown"===r.type};i===Gr&&(a.selectedIndex=e),n.setState(a)}},n.state=r.copyPropsToState(n.props,{},t.defaultFocus),n}return n=e,(t=r).prototype=Object.create(n.prototype),t.prototype.constructor=t,t.__proto__=n,r.getDerivedStateFromProps=function(e,t){return r.copyPropsToState(e,t)},r.getModeFromProps=function(e){return null===e.selectedIndex?Gr:0},r.copyPropsToState=function(e,t,n){void 0===n&&(n=!1);var o={focus:n,mode:r.getModeFromProps(e)};if(o.mode===Gr){var i=$r(e.children)-1,a=null;a=null!=t.selectedIndex?Math.min(t.selectedIndex,i):e.defaultIndex||0,o.selectedIndex=a}return o},r.prototype.render=function(){var e=this.props,t=e.children,n=(e.defaultIndex,e.defaultFocus,function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,["children","defaultIndex","defaultFocus"])),r=this.state,o=r.focus,i=r.selectedIndex;return n.focus=o,n.onSelect=this.handleSelected,null!=i&&(n.selectedIndex=i),a.a.createElement(Yr,n,t)},r}(i.Component);function Xr(){return(Xr=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e}).apply(this,arguments)}Qr.defaultProps={defaultFocus:!1,forceRenderTabPanel:!1,selectedIndex:null,defaultIndex:null},Qr.propTypes={},Qr.tabsRole="Tabs";var Kr=function(e){var t,n;function r(){return e.apply(this,arguments)||this}return n=e,(t=r).prototype=Object.create(n.prototype),t.prototype.constructor=t,t.__proto__=n,r.prototype.render=function(){var e=this.props,t=e.children,n=e.className,r=function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,["children","className"]);return a.a.createElement("ul",Xr({},r,{className:Ur()(n),role:"tablist"}),t)},r}(i.Component);function Jr(){return(Jr=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e}).apply(this,arguments)}Kr.defaultProps={className:"react-tabs__tab-list"},Kr.propTypes={},Kr.tabsRole="TabList";var Zr=function(e){var t,n;function r(){return e.apply(this,arguments)||this}n=e,(t=r).prototype=Object.create(n.prototype),t.prototype.constructor=t,t.__proto__=n;var o=r.prototype;return o.componentDidMount=function(){this.checkFocus()},o.componentDidUpdate=function(){this.checkFocus()},o.checkFocus=function(){var e=this.props,t=e.selected,n=e.focus;t&&n&&this.node.focus()},o.render=function(){var e,t=this,n=this.props,r=n.children,o=n.className,i=n.disabled,s=n.disabledClassName,l=(n.focus,n.id),c=n.panelId,u=n.selected,f=n.selectedClassName,p=n.tabIndex,d=n.tabRef,h=function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(n,["children","className","disabled","disabledClassName","focus","id","panelId","selected","selectedClassName","tabIndex","tabRef"]);return a.a.createElement("li",Jr({},h,{className:Ur()(o,(e={},e[f]=u,e[s]=i,e)),ref:function(e){t.node=e,d&&d(e)},role:"tab",id:l,"aria-selected":u?"true":"false","aria-disabled":i?"true":"false","aria-controls":c,tabIndex:p||(u?"0":null)}),r)},r}(i.Component);function eo(){return(eo=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])}return e}).apply(this,arguments)}Zr.defaultProps={className:"react-tabs__tab",disabledClassName:"react-tabs__tab--disabled",focus:!1,id:null,panelId:null,selected:!1,selectedClassName:"react-tabs__tab--selected"},Zr.propTypes={},Zr.tabsRole="Tab";var to=function(e){var t,n;function r(){return e.apply(this,arguments)||this}return n=e,(t=r).prototype=Object.create(n.prototype),t.prototype.constructor=t,t.__proto__=n,r.prototype.render=function(){var e,t=this.props,n=t.children,r=t.className,o=t.forceRender,i=t.id,s=t.selected,l=t.selectedClassName,c=t.tabId,u=function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(t,["children","className","forceRender","id","selected","selectedClassName","tabId"]);return a.a.createElement("div",eo({},u,{className:Ur()(r,(e={},e[l]=s,e)),role:"tabpanel",id:i,"aria-labelledby":c}),o||s?n:null)},r}(i.Component);to.defaultProps={className:"react-tabs__tab-panel",forceRender:!1,selectedClassName:"react-tabs__tab-panel--selected"},to.propTypes={},to.tabsRole="TabPanel";var no,ro,oo,io,ao,so,lo=Te(Qr)(no||(no=Object(o.__makeTemplateObject)(["\n > ul {\n list-style: none;\n padding: 0;\n margin: 0;\n margin: 0 -5px;\n\n > li {\n padding: 5px 10px;\n display: inline-block;\n\n background-color: ",";\n border-bottom: 1px solid rgba(0, 0, 0, 0.5);\n cursor: pointer;\n text-align: center;\n outline: none;\n color: ",";\n margin: 0\n ",";\n border: 1px solid ",";\n border-radius: 5px;\n min-width: 60px;\n font-size: 0.9em;\n font-weight: bold;\n\n &.react-tabs__tab--selected {\n color: ",";\n background: ",";\n }\n\n &:only-child {\n flex: none;\n min-width: 100px;\n }\n\n &.tab-success {\n color: ",";\n }\n\n &.tab-redirect {\n color: ",";\n }\n\n &.tab-info {\n color: ",";\n }\n\n &.tab-error {\n color: ",";\n }\n }\n }\n > .react-tabs__tab-panel {\n background: ",";\n & > div,\n & > pre {\n padding: ","px;\n margin: 0;\n }\n\n & > div > pre {\n padding: 0;\n }\n }\n"],["\n > ul {\n list-style: none;\n padding: 0;\n margin: 0;\n margin: 0 -5px;\n\n > li {\n padding: 5px 10px;\n display: inline-block;\n\n background-color: ",";\n border-bottom: 1px solid rgba(0, 0, 0, 0.5);\n cursor: pointer;\n text-align: center;\n outline: none;\n color: ",";\n margin: 0\n ",";\n border: 1px solid ",";\n border-radius: 5px;\n min-width: 60px;\n font-size: 0.9em;\n font-weight: bold;\n\n &.react-tabs__tab--selected {\n color: ",";\n background: ",";\n }\n\n &:only-child {\n flex: none;\n min-width: 100px;\n }\n\n &.tab-success {\n color: ",";\n }\n\n &.tab-redirect {\n color: ",";\n }\n\n &.tab-info {\n color: ",";\n }\n\n &.tab-error {\n color: ",";\n }\n }\n }\n > .react-tabs__tab-panel {\n background: ",";\n & > div,\n & > pre {\n padding: ","px;\n margin: 0;\n }\n\n & > div > pre {\n padding: 0;\n }\n }\n"])),(function(e){return e.theme.codeSample.backgroundColor}),(function(e){var t=e.theme;return V(t.colors.tonalOffset,t.rightPanel.textColor)}),(function(e){var t=e.theme;return t.spacing.unit+"px "+t.spacing.unit+"px "+t.spacing.unit+"px"}),(function(e){var t=e.theme;return V(.05,t.codeSample.backgroundColor)}),(function(e){return e.theme.colors.text.primary}),(function(e){return e.theme.rightPanel.textColor}),(function(e){return e.theme.colors.responses.success.color}),(function(e){return e.theme.colors.responses.redirect.color}),(function(e){return e.theme.colors.responses.info.color}),(function(e){return e.theme.colors.responses.error.color}),(function(e){return e.theme.codeSample.backgroundColor}),(function(e){return 4*e.theme.spacing.unit})),co=(Te(lo)(ro||(ro=Object(o.__makeTemplateObject)(["\n > ul {\n display: block;\n > li {\n padding: 2px 5px;\n min-width: auto;\n margin: 0 15px 0 0;\n font-size: 13px;\n font-weight: normal;\n border-bottom: 1px dashed;\n color: ",";\n border-radius: 0;\n background: none;\n\n &:last-child {\n margin-right: 0;\n }\n\n &.react-tabs__tab--selected {\n color: ",";\n background: none;\n }\n }\n }\n > .react-tabs__tab-panel {\n & > div,\n & > pre {\n padding: ","px 0;\n }\n }\n"],["\n > ul {\n display: block;\n > li {\n padding: 2px 5px;\n min-width: auto;\n margin: 0 15px 0 0;\n font-size: 13px;\n font-weight: normal;\n border-bottom: 1px dashed;\n color: ",";\n border-radius: 0;\n background: none;\n\n &:last-child {\n margin-right: 0;\n }\n\n &.react-tabs__tab--selected {\n color: ",";\n background: none;\n }\n }\n }\n > .react-tabs__tab-panel {\n & > div,\n & > pre {\n padding: ","px 0;\n }\n }\n"])),(function(e){var t=e.theme;return V(t.colors.tonalOffset,t.rightPanel.textColor)}),(function(e){return e.theme.rightPanel.textColor}),(function(e){return 2*e.theme.spacing.unit})),Te.div(oo||(oo=Object(o.__makeTemplateObject)(["\n /**\n * Based on prism-dark.css\n */\n\n code[class*='language-'],\n pre[class*='language-'] {\n /* color: white;\n background: none; */\n text-shadow: 0 -0.1em 0.2em black;\n text-align: left;\n white-space: pre;\n word-spacing: normal;\n word-break: normal;\n word-wrap: normal;\n line-height: 1.5;\n\n -moz-tab-size: 4;\n -o-tab-size: 4;\n tab-size: 4;\n\n -webkit-hyphens: none;\n -moz-hyphens: none;\n -ms-hyphens: none;\n hyphens: none;\n }\n\n @media print {\n code[class*='language-'],\n pre[class*='language-'] {\n text-shadow: none;\n }\n }\n\n /* Code blocks */\n pre[class*='language-'] {\n padding: 1em;\n margin: 0.5em 0;\n overflow: auto;\n }\n\n .token.comment,\n .token.prolog,\n .token.doctype,\n .token.cdata {\n color: hsl(30, 20%, 50%);\n }\n\n .token.punctuation {\n opacity: 0.7;\n }\n\n .namespace {\n opacity: 0.7;\n }\n\n .token.property,\n .token.tag,\n .token.number,\n .token.constant,\n .token.symbol {\n color: #4a8bb3;\n }\n\n .token.boolean {\n color: firebrick;\n }\n\n .token.selector,\n .token.attr-name,\n .token.string,\n .token.char,\n .token.builtin,\n .token.inserted {\n color: #a0fbaa;\n & + a,\n & + a:visited {\n color: #4ed2ba;\n text-decoration: underline;\n }\n }\n\n /* .property.token.string {\n color: white;\n } */\n\n .token.operator,\n .token.entity,\n .token.url,\n .token.variable {\n color: hsl(40, 90%, 60%);\n }\n\n .token.atrule,\n .token.attr-value,\n .token.keyword {\n color: hsl(350, 40%, 70%);\n }\n\n .token.regex,\n .token.important {\n color: #e90;\n }\n\n .token.important,\n .token.bold {\n font-weight: bold;\n }\n .token.italic {\n font-style: italic;\n }\n\n .token.entity {\n cursor: help;\n }\n\n .token.deleted {\n color: red;\n }\n\n ",";\n"],["\n /**\n * Based on prism-dark.css\n */\n\n code[class*='language-'],\n pre[class*='language-'] {\n /* color: white;\n background: none; */\n text-shadow: 0 -0.1em 0.2em black;\n text-align: left;\n white-space: pre;\n word-spacing: normal;\n word-break: normal;\n word-wrap: normal;\n line-height: 1.5;\n\n -moz-tab-size: 4;\n -o-tab-size: 4;\n tab-size: 4;\n\n -webkit-hyphens: none;\n -moz-hyphens: none;\n -ms-hyphens: none;\n hyphens: none;\n }\n\n @media print {\n code[class*='language-'],\n pre[class*='language-'] {\n text-shadow: none;\n }\n }\n\n /* Code blocks */\n pre[class*='language-'] {\n padding: 1em;\n margin: 0.5em 0;\n overflow: auto;\n }\n\n .token.comment,\n .token.prolog,\n .token.doctype,\n .token.cdata {\n color: hsl(30, 20%, 50%);\n }\n\n .token.punctuation {\n opacity: 0.7;\n }\n\n .namespace {\n opacity: 0.7;\n }\n\n .token.property,\n .token.tag,\n .token.number,\n .token.constant,\n .token.symbol {\n color: #4a8bb3;\n }\n\n .token.boolean {\n color: firebrick;\n }\n\n .token.selector,\n .token.attr-name,\n .token.string,\n .token.char,\n .token.builtin,\n .token.inserted {\n color: #a0fbaa;\n & + a,\n & + a:visited {\n color: #4ed2ba;\n text-decoration: underline;\n }\n }\n\n /* .property.token.string {\n color: white;\n } */\n\n .token.operator,\n .token.entity,\n .token.url,\n .token.variable {\n color: hsl(40, 90%, 60%);\n }\n\n .token.atrule,\n .token.attr-value,\n .token.keyword {\n color: hsl(350, 40%, 70%);\n }\n\n .token.regex,\n .token.important {\n color: #e90;\n }\n\n .token.important,\n .token.bold {\n font-weight: bold;\n }\n .token.italic {\n font-style: italic;\n }\n\n .token.entity {\n cursor: help;\n }\n\n .token.deleted {\n color: red;\n }\n\n ",";\n"])),je("Prism"))),uo=Te.div(io||(io=Object(o.__makeTemplateObject)(["\n opacity: 0.4;\n transition: opacity 0.3s ease;\n text-align: right;\n\n > span {\n display: inline-block;\n padding: 2px 10px;\n cursor: pointer;\n\n :hover {\n background: rgba(255, 255, 255, 0.1);\n }\n }\n"],["\n opacity: 0.4;\n transition: opacity 0.3s ease;\n text-align: right;\n\n > span {\n display: inline-block;\n padding: 2px 10px;\n cursor: pointer;\n\n :hover {\n background: rgba(255, 255, 255, 0.1);\n }\n }\n"]))),fo=Te.div(ao||(ao=Object(o.__makeTemplateObject)(["\n &:hover "," {\n opacity: 1;\n }\n"],["\n &:hover "," {\n opacity: 1;\n }\n"])),uo),po=Te(co.withComponent("pre"))(so||(so=Object(o.__makeTemplateObject)(["\n font-family: ",";\n font-size: ",";\n overflow-x: auto;\n margin: 0;\n\n white-space: ",";\n"],["\n font-family: ",";\n font-size: ",";\n overflow-x: auto;\n margin: 0;\n\n white-space: ",";\n"])),(function(e){return e.theme.typography.code.fontFamily}),(function(e){return e.theme.typography.code.fontSize}),(function(e){return e.theme.typography.code.wrap?"pre-wrap":"pre"}));
|
||
/*!
|
||
* perfect-scrollbar v1.4.0
|
||
* (c) 2018 Hyunje Jun
|
||
* @license MIT
|
||
*/
|
||
function ho(e){return getComputedStyle(e)}function mo(e,t){for(var n in t){var r=t[n];"number"==typeof r&&(r+="px"),e.style[n]=r}return e}function go(e){var t=document.createElement("div");return t.className=e,t}var yo="undefined"!=typeof Element&&(Element.prototype.matches||Element.prototype.webkitMatchesSelector||Element.prototype.mozMatchesSelector||Element.prototype.msMatchesSelector);function vo(e,t){if(!yo)throw new Error("No element matching method supported");return yo.call(e,t)}function bo(e){e.remove?e.remove():e.parentNode&&e.parentNode.removeChild(e)}function wo(e,t){return Array.prototype.filter.call(e.children,(function(e){return vo(e,t)}))}var xo={main:"ps",element:{thumb:function(e){return"ps__thumb-"+e},rail:function(e){return"ps__rail-"+e},consuming:"ps__child--consume"},state:{focus:"ps--focus",clicking:"ps--clicking",active:function(e){return"ps--active-"+e},scrolling:function(e){return"ps--scrolling-"+e}}},ko={x:null,y:null};function Eo(e,t){var n=e.element.classList,r=xo.state.scrolling(t);n.contains(r)?clearTimeout(ko[t]):n.add(r)}function Oo(e,t){ko[t]=setTimeout((function(){return e.isAlive&&e.element.classList.remove(xo.state.scrolling(t))}),e.settings.scrollingThreshold)}var _o=function(e){this.element=e,this.handlers={}},So={isEmpty:{configurable:!0}};_o.prototype.bind=function(e,t){void 0===this.handlers[e]&&(this.handlers[e]=[]),this.handlers[e].push(t),this.element.addEventListener(e,t,!1)},_o.prototype.unbind=function(e,t){var n=this;this.handlers[e]=this.handlers[e].filter((function(r){return!(!t||r===t)||(n.element.removeEventListener(e,r,!1),!1)}))},_o.prototype.unbindAll=function(){for(var e in this.handlers)this.unbind(e)},So.isEmpty.get=function(){var e=this;return Object.keys(this.handlers).every((function(t){return 0===e.handlers[t].length}))},Object.defineProperties(_o.prototype,So);var To=function(){this.eventElements=[]};function jo(e){if("function"==typeof window.CustomEvent)return new CustomEvent(e);var t=document.createEvent("CustomEvent");return t.initCustomEvent(e,!1,!1,void 0),t}To.prototype.eventElement=function(e){var t=this.eventElements.filter((function(t){return t.element===e}))[0];return t||(t=new _o(e),this.eventElements.push(t)),t},To.prototype.bind=function(e,t,n){this.eventElement(e).bind(t,n)},To.prototype.unbind=function(e,t,n){var r=this.eventElement(e);r.unbind(t,n),r.isEmpty&&this.eventElements.splice(this.eventElements.indexOf(r),1)},To.prototype.unbindAll=function(){this.eventElements.forEach((function(e){return e.unbindAll()})),this.eventElements=[]},To.prototype.once=function(e,t,n){var r=this.eventElement(e),o=function(e){r.unbind(t,o),n(e)};r.bind(t,o)};var Co=function(e,t,n,r,o){var i;if(void 0===r&&(r=!0),void 0===o&&(o=!1),"top"===t)i=["contentHeight","containerHeight","scrollTop","y","up","down"];else{if("left"!==t)throw new Error("A proper axis should be provided");i=["contentWidth","containerWidth","scrollLeft","x","left","right"]}!function(e,t,n,r,o){var i=n[0],a=n[1],s=n[2],l=n[3],c=n[4],u=n[5];void 0===r&&(r=!0);void 0===o&&(o=!1);var f=e.element;e.reach[l]=null,f[s]<1&&(e.reach[l]="start");f[s]>e[i]-e[a]-1&&(e.reach[l]="end");t&&(f.dispatchEvent(jo("ps-scroll-"+l)),t<0?f.dispatchEvent(jo("ps-scroll-"+c)):t>0&&f.dispatchEvent(jo("ps-scroll-"+u)),r&&function(e,t){Eo(e,t),Oo(e,t)}(e,l));e.reach[l]&&(t||o)&&f.dispatchEvent(jo("ps-"+l+"-reach-"+e.reach[l]))}(e,n,i,r,o)};function Io(e){return parseInt(e,10)||0}var Ao={isWebKit:"undefined"!=typeof document&&"WebkitAppearance"in document.documentElement.style,supportsTouch:"undefined"!=typeof window&&("ontouchstart"in window||window.DocumentTouch&&document instanceof window.DocumentTouch),supportsIePointer:"undefined"!=typeof navigator&&navigator.msMaxTouchPoints,isChrome:"undefined"!=typeof navigator&&/Chrome/i.test(navigator&&navigator.userAgent)},Po=function(e){var t=e.element,n=Math.floor(t.scrollTop);e.containerWidth=t.clientWidth,e.containerHeight=t.clientHeight,e.contentWidth=t.scrollWidth,e.contentHeight=t.scrollHeight,t.contains(e.scrollbarXRail)||(wo(t,xo.element.rail("x")).forEach((function(e){return bo(e)})),t.appendChild(e.scrollbarXRail)),t.contains(e.scrollbarYRail)||(wo(t,xo.element.rail("y")).forEach((function(e){return bo(e)})),t.appendChild(e.scrollbarYRail)),!e.settings.suppressScrollX&&e.containerWidth+e.settings.scrollXMarginOffset<e.contentWidth?(e.scrollbarXActive=!0,e.railXWidth=e.containerWidth-e.railXMarginWidth,e.railXRatio=e.containerWidth/e.railXWidth,e.scrollbarXWidth=Ro(e,Io(e.railXWidth*e.containerWidth/e.contentWidth)),e.scrollbarXLeft=Io((e.negativeScrollAdjustment+t.scrollLeft)*(e.railXWidth-e.scrollbarXWidth)/(e.contentWidth-e.containerWidth))):e.scrollbarXActive=!1,!e.settings.suppressScrollY&&e.containerHeight+e.settings.scrollYMarginOffset<e.contentHeight?(e.scrollbarYActive=!0,e.railYHeight=e.containerHeight-e.railYMarginHeight,e.railYRatio=e.containerHeight/e.railYHeight,e.scrollbarYHeight=Ro(e,Io(e.railYHeight*e.containerHeight/e.contentHeight)),e.scrollbarYTop=Io(n*(e.railYHeight-e.scrollbarYHeight)/(e.contentHeight-e.containerHeight))):e.scrollbarYActive=!1,e.scrollbarXLeft>=e.railXWidth-e.scrollbarXWidth&&(e.scrollbarXLeft=e.railXWidth-e.scrollbarXWidth),e.scrollbarYTop>=e.railYHeight-e.scrollbarYHeight&&(e.scrollbarYTop=e.railYHeight-e.scrollbarYHeight),function(e,t){var n={width:t.railXWidth},r=Math.floor(e.scrollTop);t.isRtl?n.left=t.negativeScrollAdjustment+e.scrollLeft+t.containerWidth-t.contentWidth:n.left=e.scrollLeft;t.isScrollbarXUsingBottom?n.bottom=t.scrollbarXBottom-r:n.top=t.scrollbarXTop+r;mo(t.scrollbarXRail,n);var o={top:r,height:t.railYHeight};t.isScrollbarYUsingRight?t.isRtl?o.right=t.contentWidth-(t.negativeScrollAdjustment+e.scrollLeft)-t.scrollbarYRight-t.scrollbarYOuterWidth:o.right=t.scrollbarYRight-e.scrollLeft:t.isRtl?o.left=t.negativeScrollAdjustment+e.scrollLeft+2*t.containerWidth-t.contentWidth-t.scrollbarYLeft-t.scrollbarYOuterWidth:o.left=t.scrollbarYLeft+e.scrollLeft;mo(t.scrollbarYRail,o),mo(t.scrollbarX,{left:t.scrollbarXLeft,width:t.scrollbarXWidth-t.railBorderXWidth}),mo(t.scrollbarY,{top:t.scrollbarYTop,height:t.scrollbarYHeight-t.railBorderYWidth})}(t,e),e.scrollbarXActive?t.classList.add(xo.state.active("x")):(t.classList.remove(xo.state.active("x")),e.scrollbarXWidth=0,e.scrollbarXLeft=0,t.scrollLeft=0),e.scrollbarYActive?t.classList.add(xo.state.active("y")):(t.classList.remove(xo.state.active("y")),e.scrollbarYHeight=0,e.scrollbarYTop=0,t.scrollTop=0)};function Ro(e,t){return e.settings.minScrollbarLength&&(t=Math.max(t,e.settings.minScrollbarLength)),e.settings.maxScrollbarLength&&(t=Math.min(t,e.settings.maxScrollbarLength)),t}function No(e,t){var n=t[0],r=t[1],o=t[2],i=t[3],a=t[4],s=t[5],l=t[6],c=t[7],u=t[8],f=e.element,p=null,d=null,h=null;function m(t){f[l]=p+h*(t[o]-d),Eo(e,c),Po(e),t.stopPropagation(),t.preventDefault()}function g(){Oo(e,c),e[u].classList.remove(xo.state.clicking),e.event.unbind(e.ownerDocument,"mousemove",m)}e.event.bind(e[a],"mousedown",(function(t){p=f[l],d=t[o],h=(e[r]-e[n])/(e[i]-e[s]),e.event.bind(e.ownerDocument,"mousemove",m),e.event.once(e.ownerDocument,"mouseup",g),e[u].classList.add(xo.state.clicking),t.stopPropagation(),t.preventDefault()}))}var Lo={"click-rail":function(e){e.event.bind(e.scrollbarY,"mousedown",(function(e){return e.stopPropagation()})),e.event.bind(e.scrollbarYRail,"mousedown",(function(t){var n=t.pageY-window.pageYOffset-e.scrollbarYRail.getBoundingClientRect().top>e.scrollbarYTop?1:-1;e.element.scrollTop+=n*e.containerHeight,Po(e),t.stopPropagation()})),e.event.bind(e.scrollbarX,"mousedown",(function(e){return e.stopPropagation()})),e.event.bind(e.scrollbarXRail,"mousedown",(function(t){var n=t.pageX-window.pageXOffset-e.scrollbarXRail.getBoundingClientRect().left>e.scrollbarXLeft?1:-1;e.element.scrollLeft+=n*e.containerWidth,Po(e),t.stopPropagation()}))},"drag-thumb":function(e){No(e,["containerWidth","contentWidth","pageX","railXWidth","scrollbarX","scrollbarXWidth","scrollLeft","x","scrollbarXRail"]),No(e,["containerHeight","contentHeight","pageY","railYHeight","scrollbarY","scrollbarYHeight","scrollTop","y","scrollbarYRail"])},keyboard:function(e){var t=e.element;e.event.bind(e.ownerDocument,"keydown",(function(n){if(!(n.isDefaultPrevented&&n.isDefaultPrevented()||n.defaultPrevented)&&(vo(t,":hover")||vo(e.scrollbarX,":focus")||vo(e.scrollbarY,":focus"))){var r,o=document.activeElement?document.activeElement:e.ownerDocument.activeElement;if(o){if("IFRAME"===o.tagName)o=o.contentDocument.activeElement;else for(;o.shadowRoot;)o=o.shadowRoot.activeElement;if(vo(r=o,"input,[contenteditable]")||vo(r,"select,[contenteditable]")||vo(r,"textarea,[contenteditable]")||vo(r,"button,[contenteditable]"))return}var i=0,a=0;switch(n.which){case 37:i=n.metaKey?-e.contentWidth:n.altKey?-e.containerWidth:-30;break;case 38:a=n.metaKey?e.contentHeight:n.altKey?e.containerHeight:30;break;case 39:i=n.metaKey?e.contentWidth:n.altKey?e.containerWidth:30;break;case 40:a=n.metaKey?-e.contentHeight:n.altKey?-e.containerHeight:-30;break;case 32:a=n.shiftKey?e.containerHeight:-e.containerHeight;break;case 33:a=e.containerHeight;break;case 34:a=-e.containerHeight;break;case 36:a=e.contentHeight;break;case 35:a=-e.contentHeight;break;default:return}e.settings.suppressScrollX&&0!==i||e.settings.suppressScrollY&&0!==a||(t.scrollTop-=a,t.scrollLeft+=i,Po(e),function(n,r){var o=Math.floor(t.scrollTop);if(0===n){if(!e.scrollbarYActive)return!1;if(0===o&&r>0||o>=e.contentHeight-e.containerHeight&&r<0)return!e.settings.wheelPropagation}var i=t.scrollLeft;if(0===r){if(!e.scrollbarXActive)return!1;if(0===i&&n<0||i>=e.contentWidth-e.containerWidth&&n>0)return!e.settings.wheelPropagation}return!0}(i,a)&&n.preventDefault())}}))},wheel:function(e){var t=e.element;function n(n){var r=function(e){var t=e.deltaX,n=-1*e.deltaY;return void 0!==t&&void 0!==n||(t=-1*e.wheelDeltaX/6,n=e.wheelDeltaY/6),e.deltaMode&&1===e.deltaMode&&(t*=10,n*=10),t!=t&&n!=n&&(t=0,n=e.wheelDelta),e.shiftKey?[-n,-t]:[t,n]}(n),o=r[0],i=r[1];if(!function(e,n,r){if(!Ao.isWebKit&&t.querySelector("select:focus"))return!0;if(!t.contains(e))return!1;for(var o=e;o&&o!==t;){if(o.classList.contains(xo.element.consuming))return!0;var i=ho(o);if([i.overflow,i.overflowX,i.overflowY].join("").match(/(scroll|auto)/)){var a=o.scrollHeight-o.clientHeight;if(a>0&&!(0===o.scrollTop&&r>0||o.scrollTop===a&&r<0))return!0;var s=o.scrollWidth-o.clientWidth;if(s>0&&!(0===o.scrollLeft&&n<0||o.scrollLeft===s&&n>0))return!0}o=o.parentNode}return!1}(n.target,o,i)){var a=!1;e.settings.useBothWheelAxes?e.scrollbarYActive&&!e.scrollbarXActive?(i?t.scrollTop-=i*e.settings.wheelSpeed:t.scrollTop+=o*e.settings.wheelSpeed,a=!0):e.scrollbarXActive&&!e.scrollbarYActive&&(o?t.scrollLeft+=o*e.settings.wheelSpeed:t.scrollLeft-=i*e.settings.wheelSpeed,a=!0):(t.scrollTop-=i*e.settings.wheelSpeed,t.scrollLeft+=o*e.settings.wheelSpeed),Po(e),(a=a||function(n,r){var o=Math.floor(t.scrollTop),i=0===t.scrollTop,a=o+t.offsetHeight===t.scrollHeight,s=0===t.scrollLeft,l=t.scrollLeft+t.offsetWidth===t.scrollWidth;return!(Math.abs(r)>Math.abs(n)?i||a:s||l)||!e.settings.wheelPropagation}(o,i))&&!n.ctrlKey&&(n.stopPropagation(),n.preventDefault())}}void 0!==window.onwheel?e.event.bind(t,"wheel",n):void 0!==window.onmousewheel&&e.event.bind(t,"mousewheel",n)},touch:function(e){if(Ao.supportsTouch||Ao.supportsIePointer){var t=e.element,n={},r=0,o={},i=null;Ao.supportsTouch?(e.event.bind(t,"touchstart",c),e.event.bind(t,"touchmove",u),e.event.bind(t,"touchend",f)):Ao.supportsIePointer&&(window.PointerEvent?(e.event.bind(t,"pointerdown",c),e.event.bind(t,"pointermove",u),e.event.bind(t,"pointerup",f)):window.MSPointerEvent&&(e.event.bind(t,"MSPointerDown",c),e.event.bind(t,"MSPointerMove",u),e.event.bind(t,"MSPointerUp",f)))}function a(n,r){t.scrollTop-=r,t.scrollLeft-=n,Po(e)}function s(e){return e.targetTouches?e.targetTouches[0]:e}function l(e){return(!e.pointerType||"pen"!==e.pointerType||0!==e.buttons)&&(!(!e.targetTouches||1!==e.targetTouches.length)||!(!e.pointerType||"mouse"===e.pointerType||e.pointerType===e.MSPOINTER_TYPE_MOUSE))}function c(e){if(l(e)){var t=s(e);n.pageX=t.pageX,n.pageY=t.pageY,r=(new Date).getTime(),null!==i&&clearInterval(i)}}function u(i){if(l(i)){var c=s(i),u={pageX:c.pageX,pageY:c.pageY},f=u.pageX-n.pageX,p=u.pageY-n.pageY;if(function(e,n,r){if(!t.contains(e))return!1;for(var o=e;o&&o!==t;){if(o.classList.contains(xo.element.consuming))return!0;var i=ho(o);if([i.overflow,i.overflowX,i.overflowY].join("").match(/(scroll|auto)/)){var a=o.scrollHeight-o.clientHeight;if(a>0&&!(0===o.scrollTop&&r>0||o.scrollTop===a&&r<0))return!0;var s=o.scrollLeft-o.clientWidth;if(s>0&&!(0===o.scrollLeft&&n<0||o.scrollLeft===s&&n>0))return!0}o=o.parentNode}return!1}(i.target,f,p))return;a(f,p),n=u;var d=(new Date).getTime(),h=d-r;h>0&&(o.x=f/h,o.y=p/h,r=d),function(n,r){var o=Math.floor(t.scrollTop),i=t.scrollLeft,a=Math.abs(n),s=Math.abs(r);if(s>a){if(r<0&&o===e.contentHeight-e.containerHeight||r>0&&0===o)return 0===window.scrollY&&r>0&&Ao.isChrome}else if(a>s&&(n<0&&i===e.contentWidth-e.containerWidth||n>0&&0===i))return!0;return!0}(f,p)&&i.preventDefault()}}function f(){e.settings.swipeEasing&&(clearInterval(i),i=setInterval((function(){e.isInitialized?clearInterval(i):o.x||o.y?Math.abs(o.x)<.01&&Math.abs(o.y)<.01?clearInterval(i):(a(30*o.x,30*o.y),o.x*=.8,o.y*=.8):clearInterval(i)}),10))}}},Mo=function(e,t){var n=this;if(void 0===t&&(t={}),"string"==typeof e&&(e=document.querySelector(e)),!e||!e.nodeName)throw new Error("no element is specified to initialize PerfectScrollbar");for(var r in this.element=e,e.classList.add(xo.main),this.settings={handlers:["click-rail","drag-thumb","keyboard","wheel","touch"],maxScrollbarLength:null,minScrollbarLength:null,scrollingThreshold:1e3,scrollXMarginOffset:0,scrollYMarginOffset:0,suppressScrollX:!1,suppressScrollY:!1,swipeEasing:!0,useBothWheelAxes:!1,wheelPropagation:!0,wheelSpeed:1},t)n.settings[r]=t[r];this.containerWidth=null,this.containerHeight=null,this.contentWidth=null,this.contentHeight=null;var o,i,a=function(){return e.classList.add(xo.state.focus)},s=function(){return e.classList.remove(xo.state.focus)};this.isRtl="rtl"===ho(e).direction,this.isNegativeScroll=(i=e.scrollLeft,e.scrollLeft=-1,o=e.scrollLeft<0,e.scrollLeft=i,o),this.negativeScrollAdjustment=this.isNegativeScroll?e.scrollWidth-e.clientWidth:0,this.event=new To,this.ownerDocument=e.ownerDocument||document,this.scrollbarXRail=go(xo.element.rail("x")),e.appendChild(this.scrollbarXRail),this.scrollbarX=go(xo.element.thumb("x")),this.scrollbarXRail.appendChild(this.scrollbarX),this.scrollbarX.setAttribute("tabindex",0),this.event.bind(this.scrollbarX,"focus",a),this.event.bind(this.scrollbarX,"blur",s),this.scrollbarXActive=null,this.scrollbarXWidth=null,this.scrollbarXLeft=null;var l=ho(this.scrollbarXRail);this.scrollbarXBottom=parseInt(l.bottom,10),isNaN(this.scrollbarXBottom)?(this.isScrollbarXUsingBottom=!1,this.scrollbarXTop=Io(l.top)):this.isScrollbarXUsingBottom=!0,this.railBorderXWidth=Io(l.borderLeftWidth)+Io(l.borderRightWidth),mo(this.scrollbarXRail,{display:"block"}),this.railXMarginWidth=Io(l.marginLeft)+Io(l.marginRight),mo(this.scrollbarXRail,{display:""}),this.railXWidth=null,this.railXRatio=null,this.scrollbarYRail=go(xo.element.rail("y")),e.appendChild(this.scrollbarYRail),this.scrollbarY=go(xo.element.thumb("y")),this.scrollbarYRail.appendChild(this.scrollbarY),this.scrollbarY.setAttribute("tabindex",0),this.event.bind(this.scrollbarY,"focus",a),this.event.bind(this.scrollbarY,"blur",s),this.scrollbarYActive=null,this.scrollbarYHeight=null,this.scrollbarYTop=null;var c=ho(this.scrollbarYRail);this.scrollbarYRight=parseInt(c.right,10),isNaN(this.scrollbarYRight)?(this.isScrollbarYUsingRight=!1,this.scrollbarYLeft=Io(c.left)):this.isScrollbarYUsingRight=!0,this.scrollbarYOuterWidth=this.isRtl?function(e){var t=ho(e);return Io(t.width)+Io(t.paddingLeft)+Io(t.paddingRight)+Io(t.borderLeftWidth)+Io(t.borderRightWidth)}(this.scrollbarY):null,this.railBorderYWidth=Io(c.borderTopWidth)+Io(c.borderBottomWidth),mo(this.scrollbarYRail,{display:"block"}),this.railYMarginHeight=Io(c.marginTop)+Io(c.marginBottom),mo(this.scrollbarYRail,{display:""}),this.railYHeight=null,this.railYRatio=null,this.reach={x:e.scrollLeft<=0?"start":e.scrollLeft>=this.contentWidth-this.containerWidth?"end":null,y:e.scrollTop<=0?"start":e.scrollTop>=this.contentHeight-this.containerHeight?"end":null},this.isAlive=!0,this.settings.handlers.forEach((function(e){return Lo[e](n)})),this.lastScrollTop=Math.floor(e.scrollTop),this.lastScrollLeft=e.scrollLeft,this.event.bind(this.element,"scroll",(function(e){return n.onScroll(e)})),Po(this)};Mo.prototype.update=function(){this.isAlive&&(this.negativeScrollAdjustment=this.isNegativeScroll?this.element.scrollWidth-this.element.clientWidth:0,mo(this.scrollbarXRail,{display:"block"}),mo(this.scrollbarYRail,{display:"block"}),this.railXMarginWidth=Io(ho(this.scrollbarXRail).marginLeft)+Io(ho(this.scrollbarXRail).marginRight),this.railYMarginHeight=Io(ho(this.scrollbarYRail).marginTop)+Io(ho(this.scrollbarYRail).marginBottom),mo(this.scrollbarXRail,{display:"none"}),mo(this.scrollbarYRail,{display:"none"}),Po(this),Co(this,"top",0,!1,!0),Co(this,"left",0,!1,!0),mo(this.scrollbarXRail,{display:""}),mo(this.scrollbarYRail,{display:""}))},Mo.prototype.onScroll=function(e){this.isAlive&&(Po(this),Co(this,"top",this.element.scrollTop-this.lastScrollTop),Co(this,"left",this.element.scrollLeft-this.lastScrollLeft),this.lastScrollTop=Math.floor(this.element.scrollTop),this.lastScrollLeft=this.element.scrollLeft)},Mo.prototype.destroy=function(){this.isAlive&&(this.event.unbindAll(),bo(this.scrollbarX),bo(this.scrollbarY),bo(this.scrollbarXRail),bo(this.scrollbarYRail),this.removePsClasses(),this.element=null,this.scrollbarX=null,this.scrollbarY=null,this.scrollbarXRail=null,this.scrollbarYRail=null,this.isAlive=!1)},Mo.prototype.removePsClasses=function(){this.element.className=this.element.className.split(" ").filter((function(e){return!e.match(/^ps([-_].+|)$/)})).join(" ")};var Do,Fo,Uo=Mo,zo=n(97),Bo=n.n(zo),$o=Uo||r,qo=Ee(Do||(Do=Object(o.__makeTemplateObject)(["",""],["",""])),Bo.a&&Bo.a.toString()),Wo=Te.div(Fo||(Fo=Object(o.__makeTemplateObject)(["\n position: relative;\n"],["\n position: relative;\n"]))),Ho=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.handleRef=function(e){t._container=e},t}return Object(o.__extends)(t,e),t.prototype.componentDidMount=function(){var e=this._container.parentElement&&this._container.parentElement.scrollTop||0;this.inst=new $o(this._container,this.props.options||{}),this._container.scrollTo&&this._container.scrollTo(0,e)},t.prototype.componentDidUpdate=function(){this.inst.update()},t.prototype.componentWillUnmount=function(){this.inst.destroy()},t.prototype.render=function(){var e=this.props,t=e.children,n=e.className,r=e.updateFn;return r&&r(this.componentDidUpdate.bind(this)),i.createElement(i.Fragment,null,i.createElement(qo,null),i.createElement(Wo,{className:"scrollbar-container "+n,ref:this.handleRef},t))},t}(i.Component);function Vo(e){return i.createElement(Ue.Consumer,null,(function(t){return t.nativeScrollbars?i.createElement("div",{style:{overflow:"auto",msOverflowStyle:"-ms-autohiding-scrollbar"}},e.children):i.createElement(Ho,Object(o.__assign)({},e),e.children)}))}function Yo(e){var t=e.Label,n=void 0===t?Ir:t,r=e.Dropdown,a=void 0===r?Cr:r;return 1===e.options.length?i.createElement(n,null,e.options[0].label):i.createElement(a,Object(o.__assign)({},e))}var Go,Qo,Xo=n(156),Ko=ke(Go||(Go=Object(o.__makeTemplateObject)(["\n a {\n text-decoration: none;\n color: ",";\n\n &:visited {\n color: ",";\n }\n\n &:hover {\n color: ",";\n }\n }\n"],["\n a {\n text-decoration: none;\n color: ",";\n\n &:visited {\n color: ",";\n }\n\n &:hover {\n color: ",";\n }\n }\n"])),(function(e){return e.theme.typography.links.color}),(function(e){return e.theme.typography.links.visited}),(function(e){return e.theme.typography.links.hover})),Jo=Te(co)(Qo||(Qo=Object(o.__makeTemplateObject)(["\n\n font-family: ",";\n font-weight: ",";\n line-height: ",";\n\n p {\n &:last-child {\n margin-bottom: 0;\n }\n }\n\n ","\n\n ","\n\n h1 {\n ",";\n color: ",";\n margin-top: 0;\n }\n\n h2 {\n ",";\n color: ",";\n }\n\n code {\n color: ",";\n background-color: ",";\n\n font-family: ",";\n border-radius: 2px;\n border: 1px solid rgba(38, 50, 56, 0.1);\n padding: 0 ","px;\n font-size: ",";\n font-weight: ",";\n\n word-break: break-word;\n }\n\n pre {\n font-family: ",";\n white-space:",";\n background-color: #263238;\n color: white;\n padding: ","px;\n overflow-x: auto;\n line-height: normal;\n border-radius: 0px\n border: 1px solid rgba(38, 50, 56, 0.1);\n\n code {\n background-color: transparent;\n color: white;\n padding: 0;\n\n &:before,\n &:after {\n content: none;\n }\n }\n }\n\n blockquote {\n margin: 0;\n margin-bottom: 1em;\n padding: 0 15px;\n color: #777;\n border-left: 4px solid #ddd;\n }\n\n img {\n max-width: 100%;\n box-sizing: content-box;\n }\n\n ul,\n ol {\n padding-left: 2em;\n margin: 0;\n margin-bottom: 1em;\n\n ul, ol {\n margin-bottom: 0;\n margin-top: 0;\n }\n }\n\n table {\n display: block;\n width: 100%;\n overflow: auto;\n word-break: normal;\n word-break: keep-all;\n border-collapse: collapse;\n border-spacing: 0;\n margin-top: 1.5em;\n margin-bottom: 1.5em;\n }\n\n table tr {\n background-color: #fff;\n border-top: 1px solid #ccc;\n\n &:nth-child(2n) {\n background-color: ",";\n }\n }\n\n table th,\n table td {\n padding: 6px 13px;\n border: 1px solid #ddd;\n }\n\n table th {\n text-align: left;\n font-weight: bold;\n }\n\n ",";\n\n ","\n\n ",";\n"],["\n\n font-family: ",";\n font-weight: ",";\n line-height: ",";\n\n p {\n &:last-child {\n margin-bottom: 0;\n }\n }\n\n ","\n\n ","\n\n h1 {\n ",";\n color: ",";\n margin-top: 0;\n }\n\n h2 {\n ",";\n color: ",";\n }\n\n code {\n color: ",";\n background-color: ",";\n\n font-family: ",";\n border-radius: 2px;\n border: 1px solid rgba(38, 50, 56, 0.1);\n padding: 0 ","px;\n font-size: ",";\n font-weight: ",";\n\n word-break: break-word;\n }\n\n pre {\n font-family: ",";\n white-space:",";\n background-color: #263238;\n color: white;\n padding: ","px;\n overflow-x: auto;\n line-height: normal;\n border-radius: 0px\n border: 1px solid rgba(38, 50, 56, 0.1);\n\n code {\n background-color: transparent;\n color: white;\n padding: 0;\n\n &:before,\n &:after {\n content: none;\n }\n }\n }\n\n blockquote {\n margin: 0;\n margin-bottom: 1em;\n padding: 0 15px;\n color: #777;\n border-left: 4px solid #ddd;\n }\n\n img {\n max-width: 100%;\n box-sizing: content-box;\n }\n\n ul,\n ol {\n padding-left: 2em;\n margin: 0;\n margin-bottom: 1em;\n\n ul, ol {\n margin-bottom: 0;\n margin-top: 0;\n }\n }\n\n table {\n display: block;\n width: 100%;\n overflow: auto;\n word-break: normal;\n word-break: keep-all;\n border-collapse: collapse;\n border-spacing: 0;\n margin-top: 1.5em;\n margin-bottom: 1.5em;\n }\n\n table tr {\n background-color: #fff;\n border-top: 1px solid #ccc;\n\n &:nth-child(2n) {\n background-color: ",";\n }\n }\n\n table th,\n table td {\n padding: 6px 13px;\n border: 1px solid #ddd;\n }\n\n table th {\n text-align: left;\n font-weight: bold;\n }\n\n ",";\n\n ","\n\n ",";\n"])),(function(e){return e.theme.typography.fontFamily}),(function(e){return e.theme.typography.fontWeightRegular}),(function(e){return e.theme.typography.lineHeight}),(function(e){return e.compact&&"\n p:first-child {\n margin-top: 0;\n }\n p:last-child {\n margin-bottom: 0;\n }\n "}),(function(e){return e.inline&&" p {\n display: inline-block;\n }"}),In(1),(function(e){return e.theme.colors.primary.main}),In(2),(function(e){return e.theme.colors.text.primary}),(function(e){return e.theme.typography.code.color}),(function(e){return e.theme.typography.code.backgroundColor}),(function(e){return e.theme.typography.code.fontFamily}),(function(e){return e.theme.spacing.unit}),(function(e){return e.theme.typography.code.fontSize}),(function(e){return e.theme.typography.code.fontWeight}),(function(e){return e.theme.typography.code.fontFamily}),(function(e){return e.theme.typography.code.wrap?"pre-wrap":"pre"}),(function(e){return 4*e.theme.spacing.unit}),(function(e){return e.theme.schema.nestedBackground}),zn(".share-link"),Ko,je("Markdown")),Zo=Jo.withComponent("span"),ei=function(e,t){return e?Xo.sanitize(t):t};function ti(e){var t=e.inline?Zo:Jo;return i.createElement(Be,null,(function(n){return i.createElement(t,Object(o.__assign)({className:"redoc-markdown "+(e.className||""),dangerouslySetInnerHTML:{__html:ei(n.untrustedSpec,e.html)}},e))}))}var ni,ri,oi,ii,ai,si=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props,t=e.source,n=e.inline,r=e.compact,o=e.className,a=new Rt;return i.createElement(ti,{html:a.renderMd(t),inline:n,compact:r,className:o})},t}(i.Component),li=Te.div(ni||(ni=Object(o.__makeTemplateObject)(["\n position: relative;\n"],["\n position: relative;\n"]))),ci=Te.div(ri||(ri=Object(o.__makeTemplateObject)(["\n position: absolute;\n min-width: 80px;\n max-width: 500px;\n background: #fff;\n bottom: 100%;\n left: 50%;\n margin-bottom: 10px;\n transform: translateX(-50%);\n\n border-radius: 4px;\n padding: 0.3em 0.6em;\n text-align: center;\n box-shadow: 0px 0px 5px 0px rgba(204, 204, 204, 1);\n"],["\n position: absolute;\n min-width: 80px;\n max-width: 500px;\n background: #fff;\n bottom: 100%;\n left: 50%;\n margin-bottom: 10px;\n transform: translateX(-50%);\n\n border-radius: 4px;\n padding: 0.3em 0.6em;\n text-align: center;\n box-shadow: 0px 0px 5px 0px rgba(204, 204, 204, 1);\n"]))),ui=Te.div(oi||(oi=Object(o.__makeTemplateObject)(["\n background: #fff;\n color: #000;\n display: inline;\n font-size: 0.85em;\n white-space: nowrap;\n"],["\n background: #fff;\n color: #000;\n display: inline;\n font-size: 0.85em;\n white-space: nowrap;\n"]))),fi=Te.div(ii||(ii=Object(o.__makeTemplateObject)(["\n position: absolute;\n width: 0;\n height: 0;\n bottom: -5px;\n left: 50%;\n margin-left: -5px;\n border-left: solid transparent 5px;\n border-right: solid transparent 5px;\n border-top: solid #fff 5px;\n"],["\n position: absolute;\n width: 0;\n height: 0;\n bottom: -5px;\n left: 50%;\n margin-left: -5px;\n border-left: solid transparent 5px;\n border-right: solid transparent 5px;\n border-top: solid #fff 5px;\n"]))),pi=Te.div(ai||(ai=Object(o.__makeTemplateObject)(["\n position: absolute;\n width: 100%;\n height: 20px;\n bottom: -20px;\n"],["\n position: absolute;\n width: 100%;\n height: 20px;\n bottom: -20px;\n"]))),di=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props,t=e.open,n=e.title,r=e.children;return i.createElement(li,null,r,t&&i.createElement(ci,null,i.createElement(ui,null,n),i.createElement(fi,null),i.createElement(pi,null)))},t}(i.Component),hi="undefined"!=typeof document&&document.queryCommandSupported&&document.queryCommandSupported("copy"),mi=function(){function e(){}return e.isSupported=function(){return hi},e.selectElement=function(e){var t,n;document.body.createTextRange?((t=document.body.createTextRange()).moveToElementText(e),t.select()):document.createRange&&window.getSelection&&(n=window.getSelection(),(t=document.createRange()).selectNodeContents(e),n.removeAllRanges(),n.addRange(t))},e.deselect=function(){if(document.selection)document.selection.empty();else if(window.getSelection){var e=window.getSelection();e&&e.removeAllRanges()}},e.copySelected=function(){var e;try{e=document.execCommand("copy")}catch(t){e=!1}return e},e.copyElement=function(t){e.selectElement(t);var n=e.copySelected();return n&&e.deselect(),n},e.copyCustom=function(t){var n=document.createElement("textarea");n.style.position="fixed",n.style.top="0",n.style.left="0",n.style.width="2em",n.style.height="2em",n.style.padding="0",n.style.border="none",n.style.outline="none",n.style.boxShadow="none",n.style.background="transparent",n.value=t,document.body.appendChild(n),n.select();var r=e.copySelected();return document.body.removeChild(n),r},e}(),gi=function(e){function t(t){var n=e.call(this,t)||this;return n.copy=function(){var e="string"==typeof n.props.data?n.props.data:JSON.stringify(n.props.data,null,2);mi.copyCustom(e),n.showTooltip()},n.renderCopyButton=function(){return i.createElement("span",{onClick:n.copy},i.createElement(di,{title:mi.isSupported()?"Copied":"Not supported in your browser",open:n.state.tooltipShown},"Copy"))},n.state={tooltipShown:!1},n}return Object(o.__extends)(t,e),t.prototype.render=function(){return this.props.children({renderCopyButton:this.renderCopyButton})},t.prototype.showTooltip=function(){var e=this;this.setState({tooltipShown:!0}),setTimeout((function(){e.setState({tooltipShown:!1})}),1500)},t}(i.PureComponent),yi=1;function vi(e,t){yi=1;var n="";return n+='<div class="redoc-json">',n+="<code>",n+=Ei(e,t),n+="</code>",n+="</div>"}function bi(e){return void 0!==e?e.toString().replace(/&/g,"&").replace(/"/g,""").replace(/</g,"<").replace(/>/g,">"):""}function wi(e){return JSON.stringify(e).slice(1,-1)}function xi(e,t){return'<span class="'+t+'">'+bi(e)+"</span>"}function ki(e){return'<span class="token punctuation">'+e+"</span>"}function Ei(e,t){var n=typeof e,r="";return null==e?r+=xi("null","token keyword"):e&&e.constructor===Array?(yi++,r+=function(e,t){for(var n=yi>t?"collapsed":"",r='<div class="collapser"></div>'+ki("[")+'<span class="ellipsis"></span><ul class="array collapsible">',o=!1,i=e.length,a=0;a<i;a++)o=!0,r+='<li><div class="hoverable '+n+'">',r+=Ei(e[a],t),a<i-1&&(r+=","),r+="</div></li>";r+="</ul>"+ki("]"),o||(r=ki("[ ]"));return r}(e,t),yi--):e&&e.constructor===Date?r+=xi('"'+e.toISOString()+'"',"token string"):"object"===n?(yi++,r+=function(e,t){for(var n=yi>t?"collapsed":"",r=Object.keys(e),o=r.length,i='<div class="collapser"></div>'+ki("{")+'<span class="ellipsis"></span><ul class="obj collapsible">',a=!1,s=0;s<o;s++){var l=r[s];a=!0,i+='<li><div class="hoverable '+n+'">',i+='<span class="property token string">"'+bi(l)+'"</span>: ',i+=Ei(e[l],t),s<o-1&&(i+=ki(",")),i+="</div></li>"}i+="</ul>"+ki("}"),a||(i=ki("{ }"));return i}(e,t),yi--):"number"===n?r+=xi(e,"token number"):"string"===n?/^(http|https):\/\/[^\s]+$/.test(e)?r+=xi('"',"token string")+'<a href="'+e+'">'+bi(wi(e))+"</a>"+xi('"',"token string"):r+=xi('"'+wi(e)+'"',"token string"):"boolean"===n&&(r+=xi(e,"token boolean")),r}var Oi,_i,Si,Ti=ke(Oi||(Oi=Object(o.__makeTemplateObject)(["\n .redoc-json > .collapser {\n display: none;\n }\n\n font-family: ",";\n font-size: ",";\n\n white-space: ",";\n contain: content;\n overflow-x: auto;\n\n .callback-function {\n color: gray;\n }\n\n .collapser:after {\n content: '-';\n cursor: pointer;\n }\n\n .collapsed > .collapser:after {\n content: '+';\n cursor: pointer;\n }\n\n .ellipsis:after {\n content: ' … ';\n }\n\n .collapsible {\n margin-left: 2em;\n }\n\n .hoverable {\n padding-top: 1px;\n padding-bottom: 1px;\n padding-left: 2px;\n padding-right: 2px;\n border-radius: 2px;\n }\n\n .hovered {\n background-color: rgba(235, 238, 249, 1);\n }\n\n .collapser {\n padding-right: 6px;\n padding-left: 6px;\n }\n\n ul {\n list-style-type: none;\n padding: 0px;\n margin: 0px 0px 0px 26px;\n }\n\n li {\n position: relative;\n display: block;\n }\n\n .hoverable {\n display: inline-block;\n }\n\n .selected {\n outline-style: solid;\n outline-width: 1px;\n outline-style: dotted;\n }\n\n .collapsed > .collapsible {\n display: none;\n }\n\n .ellipsis {\n display: none;\n }\n\n .collapsed > .ellipsis {\n display: inherit;\n }\n\n .collapser {\n position: absolute;\n top: 1px;\n left: -1.5em;\n cursor: default;\n user-select: none;\n -webkit-user-select: none;\n }\n"],["\n .redoc-json > .collapser {\n display: none;\n }\n\n font-family: ",";\n font-size: ",";\n\n white-space: ",";\n contain: content;\n overflow-x: auto;\n\n .callback-function {\n color: gray;\n }\n\n .collapser:after {\n content: '-';\n cursor: pointer;\n }\n\n .collapsed > .collapser:after {\n content: '+';\n cursor: pointer;\n }\n\n .ellipsis:after {\n content: ' … ';\n }\n\n .collapsible {\n margin-left: 2em;\n }\n\n .hoverable {\n padding-top: 1px;\n padding-bottom: 1px;\n padding-left: 2px;\n padding-right: 2px;\n border-radius: 2px;\n }\n\n .hovered {\n background-color: rgba(235, 238, 249, 1);\n }\n\n .collapser {\n padding-right: 6px;\n padding-left: 6px;\n }\n\n ul {\n list-style-type: none;\n padding: 0px;\n margin: 0px 0px 0px 26px;\n }\n\n li {\n position: relative;\n display: block;\n }\n\n .hoverable {\n display: inline-block;\n }\n\n .selected {\n outline-style: solid;\n outline-width: 1px;\n outline-style: dotted;\n }\n\n .collapsed > .collapsible {\n display: none;\n }\n\n .ellipsis {\n display: none;\n }\n\n .collapsed > .ellipsis {\n display: inherit;\n }\n\n .collapser {\n position: absolute;\n top: 1px;\n left: -1.5em;\n cursor: default;\n user-select: none;\n -webkit-user-select: none;\n }\n"])),(function(e){return e.theme.typography.code.fontFamily}),(function(e){return e.theme.typography.code.fontSize}),(function(e){return e.theme.typography.code.wrap?"pre-wrap":"pre"})),ji=Te.div(_i||(_i=Object(o.__makeTemplateObject)(["\n &:hover > "," {\n opacity: 1;\n }\n"],["\n &:hover > "," {\n opacity: 1;\n }\n"])),uo),Ci=Te(function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.renderInner=function(e){var n=e.renderCopyButton;return i.createElement(ji,null,i.createElement(uo,null,n(),i.createElement("span",{onClick:t.expandAll}," Expand all "),i.createElement("span",{onClick:t.collapseAll}," Collapse all ")),i.createElement(Ue.Consumer,null,(function(e){return i.createElement(co,{className:t.props.className,ref:function(e){return t.node=e},dangerouslySetInnerHTML:{__html:vi(t.props.data,e.jsonSampleExpandLevel)}})})))},t.expandAll=function(){for(var e=t.node.getElementsByClassName("collapsible"),n=0,r=Array.prototype.slice.call(e);n<r.length;n++){r[n].parentNode.classList.remove("collapsed")}},t.collapseAll=function(){for(var e=t.node.getElementsByClassName("collapsible"),n=0,r=Array.prototype.slice.call(e);n<r.length;n++){var o=r[n];o.parentNode.classList.contains("redoc-json")||o.parentNode.classList.add("collapsed")}},t.clickListener=function(e){var t,n=e.target;"collapser"===n.className&&((t=n.parentElement.getElementsByClassName("collapsible")[0]).parentElement.classList.contains("collapsed")?t.parentElement.classList.remove("collapsed"):t.parentElement.classList.add("collapsed"))},t}return Object(o.__extends)(t,e),t.prototype.render=function(){return i.createElement(gi,{data:this.props.data},this.renderInner)},t.prototype.componentDidMount=function(){this.node.addEventListener("click",this.clickListener)},t.prototype.componentWillUnmount=function(){this.node.removeEventListener("click",this.clickListener)},t}(i.PureComponent))(Si||(Si=Object(o.__makeTemplateObject)(["\n ",";\n"],["\n ",";\n"])),Ti),Ii=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props,t=e.source,n=e.lang;return i.createElement(po,{dangerouslySetInnerHTML:{__html:wt(t,n)}})},t}(i.PureComponent),Ai=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this;return i.createElement(gi,{data:this.props.source},(function(t){var n=t.renderCopyButton;return i.createElement(fo,null,i.createElement(uo,null,n()),i.createElement(Ii,{lang:e.props.lang,source:e.props.source}))}))},t}(i.PureComponent);function Pi(e){var t,n=e.value,r=e.mimeType;return it(r)?i.createElement(Ci,{data:n}):("object"==typeof n&&(n=JSON.stringify(n,null,2)),i.createElement(Ai,{lang:(t=r,-1!==t.search(/xml/i)?"xml":"clike"),source:n}))}function Ri(e){var t=e.example,n=e.mimeType;return void 0===t.value&&t.externalValueUrl?i.createElement(Ni,{example:t,mimeType:n}):i.createElement(Pi,{value:t.value,mimeType:n})}function Ni(e){var t=e.example,n=e.mimeType,r=function(e,t){var n=this,r=Object(i.useState)(!0)[1],a=Object(i.useRef)(void 0),s=Object(i.useRef)(void 0);return s.current!==e&&(a.current=void 0),s.current=e,Object(i.useEffect)((function(){Object(o.__awaiter)(n,void 0,void 0,(function(){var n,i;return Object(o.__generator)(this,(function(o){switch(o.label){case 0:r(!0),o.label=1;case 1:return o.trys.push([1,3,,4]),n=a,[4,e.getExternalValue(t)];case 2:return n.current=o.sent(),[3,4];case 3:return i=o.sent(),a.current=i,[3,4];case 4:return r(!1),[2]}}))}))}),[e,t]),a.current}(t,n);return void 0===r?i.createElement("span",null,"Loading..."):r instanceof Error?i.createElement(po,null,"Error loading external example: ",i.createElement("br",null),i.createElement("a",{className:"token string",href:t.externalValueUrl,target:"_blank"},t.externalValueUrl)):i.createElement(Pi,{value:r,mimeType:n})}var Li,Mi,Di,Fi,Ui,zi,Bi=Te.div(Li||(Li=Object(o.__makeTemplateObject)(["\n padding: 12px;\n background-color: ",";\n margin: 0 0 10px 0;\n display: block;\n"],["\n padding: 12px;\n background-color: ",";\n margin: 0 0 10px 0;\n display: block;\n"])),(function(e){var t=e.theme;return ee(.6,t.rightPanel.backgroundColor)})),$i=Te.span(Mi||(Mi=Object(o.__makeTemplateObject)(["\n font-family: ",";\n font-size: 12px;\n position: absolute;\n z-index: 1;\n top: -11px;\n left: 12px;\n font-weight: ",";\n color: ",";\n"],["\n font-family: ",";\n font-size: 12px;\n position: absolute;\n z-index: 1;\n top: -11px;\n left: 12px;\n font-weight: ",";\n color: ",";\n"])),(function(e){return e.theme.typography.headings.fontFamily}),(function(e){return e.theme.typography.fontWeightBold}),(function(e){var t=e.theme;return ee(.6,t.rightPanel.textColor)})),qi=Te.div(Di||(Di=Object(o.__makeTemplateObject)(["\n position: relative;\n"],["\n position: relative;\n"]))),Wi=Te(jr)(Fi||(Fi=Object(o.__makeTemplateObject)(["\n margin-left: 10px;\n text-transform: none;\n font-size: 0.929em;\n margin: 0 0 10px 0;\n display: block;\n background-color: ",";\n .Dropdown-control {\n margin-top: 0;\n }\n .Dropdown-control,\n .Dropdown-control:hover {\n font-size: 1em;\n border: none;\n padding: 0.9em 1.6em 0.9em 0.9em;\n background: transparent;\n color: ",";\n box-shadow: none;\n\n .Dropdown-arrow {\n border-top-color: ",";\n }\n }\n .Dropdown-menu {\n margin: 0;\n margin-top: 2px;\n }\n"],["\n margin-left: 10px;\n text-transform: none;\n font-size: 0.929em;\n margin: 0 0 10px 0;\n display: block;\n background-color: ",";\n .Dropdown-control {\n margin-top: 0;\n }\n .Dropdown-control,\n .Dropdown-control:hover {\n font-size: 1em;\n border: none;\n padding: 0.9em 1.6em 0.9em 0.9em;\n background: transparent;\n color: ",";\n box-shadow: none;\n\n .Dropdown-arrow {\n border-top-color: ",";\n }\n }\n .Dropdown-menu {\n margin: 0;\n margin-top: 2px;\n }\n"])),(function(e){var t=e.theme;return ee(.6,t.rightPanel.backgroundColor)}),(function(e){return e.theme.rightPanel.textColor}),(function(e){return e.theme.rightPanel.textColor})),Hi=Te.div(Ui||(Ui=Object(o.__makeTemplateObject)(["\n font-family: ",";\n font-size: 12px;\n color: #ee807f;\n"],["\n font-family: ",";\n font-size: 12px;\n color: #ee807f;\n"])),(function(e){return e.theme.typography.code.fontFamily})),Vi=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.state={activeIdx:0},t.switchMedia=function(e){var n=e.value;t.setState({activeIdx:parseInt(n,10)})},t}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.state.activeIdx,t=this.props.mediaType.examples||{},n=this.props.mediaType.name,r=i.createElement(Hi,null,"No sample"),o=Object.keys(t);if(0===o.length)return r;if(o.length>1){var a=o.map((function(e,n){return{label:t[e].summary||e,value:n.toString()}})),s=(l=t[o[e]]).description;return i.createElement(Yi,null,i.createElement(qi,null,i.createElement($i,null,"Example"),this.props.renderDropdown({value:a[e],options:a,onChange:this.switchMedia})),i.createElement("div",null,s&&i.createElement(si,{source:s}),i.createElement(Ri,{example:l,mimeType:n})))}var l=t[o[0]];return i.createElement(Yi,null,l.description&&i.createElement(si,{source:l.description}),i.createElement(Ri,{example:l,mimeType:n}))},t}(i.Component),Yi=Te.div(zi||(zi=Object(o.__makeTemplateObject)(["\n margin-top: 15px;\n"],["\n margin-top: 15px;\n"])));if(!i.useState)throw new Error("mobx-react-lite requires React with Hooks support");if(!$e.o)throw new Error("mobx-react-lite requires mobx at least version 4 to be available");var Gi=!1;function Qi(){return Gi}
|
||
/*! *****************************************************************************
|
||
Copyright (c) Microsoft Corporation. All rights reserved.
|
||
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
|
||
this file except in compliance with the License. You may obtain a copy of the
|
||
License at http://www.apache.org/licenses/LICENSE-2.0
|
||
|
||
THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||
KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
|
||
WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
|
||
MERCHANTABLITY OR NON-INFRINGEMENT.
|
||
|
||
See the Apache Version 2.0 License for specific language governing permissions
|
||
and limitations under the License.
|
||
***************************************************************************** */var Xi=function(){return(Xi=Object.assign||function(e){for(var t,n=1,r=arguments.length;n<r;n++)for(var o in t=arguments[n])Object.prototype.hasOwnProperty.call(t,o)&&(e[o]=t[o]);return e}).apply(this,arguments)};function Ki(e,t){var n="function"==typeof Symbol&&e[Symbol.iterator];if(!n)return e;var r,o,i=n.call(e),a=[];try{for(;(void 0===t||t-- >0)&&!(r=i.next()).done;)a.push(r.value)}catch(e){o={error:e}}finally{try{r&&!r.done&&(n=i.return)&&n.call(i)}finally{if(o)throw o.error}}return a}function Ji(e){return e.current?Object($e.h)(e.current):"<unknown>"}var Zi=[];function ea(){var e=Ki(Object(i.useState)(0),2)[1];return Object(i.useCallback)((function(){e((function(e){return e+1}))}),[])}var ta={};function na(e,t,n){if(void 0===t&&(t="observed"),void 0===n&&(n=ta),Qi())return e();var r=(n.useForceUpdate||ea)(),o=Object(i.useRef)(null);o.current||(o.current=new $e.b("observer("+t+")",(function(){r()})));var a,s,l=function(){o.current&&!o.current.isDisposed&&(o.current.dispose(),o.current=null)};if(Object(i.useDebugValue)(o,Ji),function(e){Object(i.useEffect)((function(){return e}),Zi)}((function(){l()})),o.current.track((function(){try{a=e()}catch(e){s=e}})),s)throw l(),s;return a}function ra(e,t){if(Qi())return e;var n,r,o,a=Xi({forwardRef:!1},t),s=e.displayName||e.name,l=function(t,n){return na((function(){return e(t,n)}),s)};return l.displayName=s,n=a.forwardRef?Object(i.memo)(Object(i.forwardRef)(l)):Object(i.memo)(l),r=e,o=n,Object.keys(r).forEach((function(e){r.hasOwnProperty(e)&&!oa[e]&&Object.defineProperty(o,e,Object.getOwnPropertyDescriptor(r,e))})),n.displayName=s,n}var oa={$$typeof:!0,render:!0,compare:!0,type:!0};function ia(e){var t=e.children,n=e.render,r=t||n;return"function"!=typeof r?null:na(r)}function aa(e,t,n,r,o){var i="children"===t?"render":"children",a="function"==typeof e[t],s="function"==typeof e[i];return a&&s?new Error("MobX Observer: Do not use children and render in the same time in`"+n):a||s?null:new Error("Invalid prop `"+o+"` of type `"+typeof e[t]+"` supplied to `"+n+"`, expected `function`.")}ia.propTypes={children:aa,render:aa},ia.displayName="Observer";var sa=0,la={};function ca(e){return la[e]||(la[e]=function(e){if("function"==typeof Symbol)return Symbol(e);var t="__$mobx-react "+e+" ("+sa+")";return sa++,t}(e)),la[e]}function ua(e,t){if(fa(e,t))return!0;if("object"!=typeof e||null===e||"object"!=typeof t||null===t)return!1;var n=Object.keys(e),r=Object.keys(t);if(n.length!==r.length)return!1;for(var o=0;o<n.length;o++)if(!hasOwnProperty.call(t,n[o])||!fa(e[n[o]],t[n[o]]))return!1;return!0}function fa(e,t){return e===t?0!==e||1/e==1/t:e!=e&&t!=t}function pa(e,t,n){Object.hasOwnProperty.call(e,t)?e[t]=n:Object.defineProperty(e,t,{enumerable:!1,configurable:!0,writable:!0,value:n})}var da=ca("patchMixins"),ha=ca("patchedDefinition");function ma(e,t){for(var n=this,r=[],o=arguments.length-2;o-- >0;)r[o]=arguments[o+2];t.locks++;try{var i;return null!=e&&(i=e.apply(this,r)),i}finally{t.locks--,0===t.locks&&t.methods.forEach((function(e){e.apply(n,r)}))}}function ga(e,t){return function(){for(var n=[],r=arguments.length;r--;)n[r]=arguments[r];ma.call.apply(ma,[this,e,t].concat(n))}}function ya(e,t,n){var r=function(e,t){var n=e[da]=e[da]||{},r=n[t]=n[t]||{};return r.locks=r.locks||0,r.methods=r.methods||[],r}(e,t);r.methods.indexOf(n)<0&&r.methods.push(n);var o=Object.getOwnPropertyDescriptor(e,t);if(!o||!o[ha]){var i=function e(t,n,r,o,i){var a,s=ga(i,o);return(a={})[ha]=!0,a.get=function(){return s},a.set=function(i){if(this===t)s=ga(i,o);else{var a=e(this,n,r,o,i);Object.defineProperty(this,n,a)}},a.configurable=!0,a.enumerable=r,a}(e,t,o?o.enumerable:void 0,r,e[t]);Object.defineProperty(e,t,i)}}var va=$e.a||"$mobx",ba=ca("isUnmounted"),wa=ca("skipRender"),xa=ca("isForcingUpdate");function ka(e,t){return Qi()&&console.warn("[mobx-react] It seems that a re-rendering of a React component is triggered while in static (server-side) mode. Please make sure components are rendered only once server-side."),this.state!==t||!ua(this.props,e)}function Ea(e,t){var n=ca("reactProp_"+t+"_valueHolder"),r=ca("reactProp_"+t+"_atomHolder");function o(){return this[r]||pa(this,r,Object($e.g)("reactive "+t)),this[r]}Object.defineProperty(e,t,{configurable:!0,enumerable:!0,get:function(){return o.call(this).reportObserved(),this[n]},set:function(e){this[xa]||ua(this[n],e)?pa(this,n,e):(pa(this,n,e),pa(this,wa,!0),o.call(this).reportChanged(),pa(this,wa,!1))}})}var Oa="function"==typeof Symbol&&Symbol.for,_a=Oa?Symbol.for("react.forward_ref"):"function"==typeof i.forwardRef&&Object(i.forwardRef)((function(){})).$$typeof,Sa=Oa?Symbol.for("react.memo"):"function"==typeof i.memo&&Object(i.memo)((function(){})).$$typeof;function Ta(e){if(!0===e.isMobxInjector&&console.warn("Mobx observer: You are trying to use 'observer' on a component that already has 'inject'. Please apply 'observer' before applying 'inject'"),Sa&&e.$$typeof===Sa)throw new Error("Mobx observer: You are trying to use 'observer' on function component wrapped to either another observer or 'React.memo'. The observer already applies 'React.memo' for you.");if(_a&&e.$$typeof===_a){var t=e.render;if("function"!=typeof t)throw new Error("render property of ForwardRef was not a function");return Object(i.forwardRef)((function(){var e=arguments;return a.a.createElement(ia,null,(function(){return t.apply(void 0,e)}))}))}return"function"!=typeof e||e.prototype&&e.prototype.render||e.isReactClass||Object.prototype.isPrototypeOf.call(i.Component,e)?function(e){var t=e.prototype;if(t.componentWillReact)throw new Error("The componentWillReact life-cycle event is no longer supported");if(e.__proto__!==i.PureComponent)if(t.shouldComponentUpdate){if(t.shouldComponentUpdate!==ka)throw new Error("It is not allowed to use shouldComponentUpdate in observer based components.")}else t.shouldComponentUpdate=ka;Ea(t,"props"),Ea(t,"state");var n=t.render;return t.render=function(){return function(e){var t=this;if(!0===Qi())return e.call(this);pa(this,wa,!1),pa(this,xa,!1);var n=this.displayName||this.name||this.constructor&&(this.constructor.displayName||this.constructor.name)||"<component>",r=e.bind(this),o=!1,a=new $e.b(n+".render()",(function(){if(!o&&(o=!0,!0!==t[ba])){var e=!0;try{pa(t,xa,!0),t[wa]||i.Component.prototype.forceUpdate.call(t),e=!1}finally{pa(t,xa,!1),e&&a.dispose()}}}));function s(){o=!1;var e=void 0,t=void 0;if(a.track((function(){try{t=Object($e.c)(!1,r)}catch(t){e=t}})),e)throw e;return t}return a.reactComponent=this,s[va]=a,this.render=s,s.call(this)}.call(this,n)},ya(t,"componentWillUnmount",(function(){!0!==Qi()&&(this.render[va]&&this.render[va].dispose(),this[ba]=!0)})),e}(e):ra(e)}a.a.createContext({});ca("disposeOnUnmountProto"),ca("disposeOnUnmountInst");function ja(e){function t(t,n,r,o,i,a){for(var s=[],l=arguments.length-6;l-- >0;)s[l]=arguments[l+6];return Object($e.q)((function(){return o=o||"<<anonymous>>",a=a||r,null==n[r]?t?new Error("The "+i+" `"+a+"` is marked as required in `"+o+"`, but its value is `"+(null===n[r]?"null":"undefined")+"`."):null:e.apply(void 0,[n,r,o,i,a].concat(s))}))}var n=t.bind(null,!1);return n.isRequired=t.bind(null,!0),n}function Ca(e){var t=typeof e;return Array.isArray(e)?"array":e instanceof RegExp?"object":function(e,t){return"symbol"===e||"Symbol"===t["@@toStringTag"]||"function"==typeof Symbol&&t instanceof Symbol}(t,e)?"symbol":t}function Ia(e,t){return ja((function(n,r,o,i,a){return Object($e.q)((function(){if(e&&Ca(n[r])===t.toLowerCase())return null;var i;switch(t){case"Array":i=$e.i;break;case"Object":i=$e.k;break;case"Map":i=$e.j;break;default:throw new Error("Unexpected mobxType: "+t)}var s=n[r];if(!i(s)){var l=function(e){var t=Ca(e);if("object"===t){if(e instanceof Date)return"date";if(e instanceof RegExp)return"regexp"}return t}(s),c=e?" or javascript `"+t.toLowerCase()+"`":"";return new Error("Invalid prop `"+a+"` of type `"+l+"` supplied to `"+o+"`, expected `mobx.Observable"+t+"`"+c+".")}return null}))}))}function Aa(e,t){return ja((function(n,r,o,i,a){for(var s=[],l=arguments.length-5;l-- >0;)s[l]=arguments[l+5];return Object($e.q)((function(){if("function"!=typeof t)return new Error("Property `"+a+"` of component `"+o+"` has invalid PropType notation.");var l=Ia(e,"Array")(n,r,o);if(l instanceof Error)return l;for(var c=n[r],u=0;u<c.length;u++)if((l=t.apply(void 0,[c,u,o,i,a+"["+u+"]"].concat(s)))instanceof Error)return l;return null}))}))}Ia(!1,"Array"),Aa.bind(null,!1),Ia(!1,"Map"),Ia(!1,"Object"),Ia(!0,"Array"),Aa.bind(null,!0),Ia(!0,"Object");if(!i.Component)throw new Error("mobx-react requires React to be available");if(!$e.l)throw new Error("mobx-react requires mobx to be available");"function"==typeof s.unstable_batchedUpdates&&Object($e.f)({reactionScheduler:s.unstable_batchedUpdates});var Pa,Ra,Na,La,Ma,Da,Fa,Ua,za,Ba,$a,qa,Wa,Ha,Va,Ya,Ga,Qa=Te(yr)(Pa||(Pa=Object(o.__makeTemplateObject)(["\n cursor: pointer;\n\n "," {\n height: ",";\n width: ",";\n polygon {\n fill: ",";\n }\n }\n"],["\n cursor: pointer;\n\n "," {\n height: ",";\n width: ",";\n polygon {\n fill: ",";\n }\n }\n"])),fr,(function(e){return e.theme.schema.arrow.size}),(function(e){return e.theme.schema.arrow.size}),(function(e){return e.theme.schema.arrow.color})),Xa=Te.span(Ra||(Ra=Object(o.__makeTemplateObject)(["\n vertical-align: middle;\n font-size: ",";\n line-height: 20px;\n"],["\n vertical-align: middle;\n font-size: ",";\n line-height: 20px;\n"])),(function(e){return e.theme.typography.code.fontSize})),Ka=Te(Xa)(Na||(Na=Object(o.__makeTemplateObject)(["\n color: ",";\n"],["\n color: ",";\n"])),(function(e){return ee(.2,e.theme.schema.typeNameColor)})),Ja=Te(Xa)(La||(La=Object(o.__makeTemplateObject)(["\n color: ",";\n"],["\n color: ",";\n"])),(function(e){return e.theme.schema.typeNameColor})),Za=Te(Xa)(Ma||(Ma=Object(o.__makeTemplateObject)(["\n color: ",";\n word-break: break-word;\n"],["\n color: ",";\n word-break: break-word;\n"])),(function(e){return e.theme.schema.typeTitleColor})),es=Ja,ts=Te(Xa.withComponent("div"))(Da||(Da=Object(o.__makeTemplateObject)(["\n color: ",";\n font-size: ",";\n font-weight: normal;\n margin-left: 20px;\n line-height: 1;\n"],["\n color: ",";\n font-size: ",";\n font-weight: normal;\n margin-left: 20px;\n line-height: 1;\n"])),(function(e){return e.theme.schema.requireLabelColor}),(function(e){return e.theme.schema.labelsTextSize})),ns=Te(Xa)(Fa||(Fa=Object(o.__makeTemplateObject)(["\n color: ",";\n font-size: 13px;\n"],["\n color: ",";\n font-size: 13px;\n"])),(function(e){return e.theme.colors.warning.main})),rs=Te(Xa)(Ua||(Ua=Object(o.__makeTemplateObject)(["\n color: #3195a6;\n font-size: 13px;\n"],["\n color: #3195a6;\n font-size: 13px;\n"]))),os=Te(Xa)(za||(za=Object(o.__makeTemplateObject)(["\n color: #3195a6;\n &::before,\n &::after {\n font-weight: bold;\n }\n"],["\n color: #3195a6;\n &::before,\n &::after {\n font-weight: bold;\n }\n"]))),is=Te(Xa)(Ba||(Ba=Object(o.__makeTemplateObject)(["\n border-radius: 2px;\n ",";\n & + & {\n margin-left: 0;\n }\n ",";\n"],["\n border-radius: 2px;\n ",";\n & + & {\n margin-left: 0;\n }\n ",";\n"])),(function(e){var t=e.theme;return"\n background-color: "+ee(.95,t.colors.text.primary)+";\n color: "+ee(.1,t.colors.text.primary)+";\n\n padding: 0 "+t.spacing.unit+"px;\n border: 1px solid "+ee(.9,t.colors.text.primary)+";\n font-family: "+t.typography.code.fontFamily+";\n}"}),je("ExampleValue")),as=Te(is)($a||($a=Object(o.__makeTemplateObject)([""],[""]))),ss=Te(Xa)(qa||(qa=Object(o.__makeTemplateObject)(["\n border-radius: 2px;\n ",";\n & + & {\n margin-left: 0;\n }\n ",";\n"],["\n border-radius: 2px;\n ",";\n & + & {\n margin-left: 0;\n }\n ",";\n"])),(function(e){var t=e.theme;return"\n background-color: "+ee(.95,t.colors.primary.light)+";\n color: "+ee(.1,t.colors.primary.main)+";\n\n margin: 0 "+t.spacing.unit+"px;\n padding: 0 "+t.spacing.unit+"px;\n border: 1px solid "+ee(.9,t.colors.primary.main)+";\n font-family: "+t.typography.code.fontFamily+";\n}"}),je("ConstraintItem")),ls=Te.div(Wa||(Wa=Object(o.__makeTemplateObject)(["\n ",";\n ","\n"],["\n ",";\n ","\n"])),Ko,(function(e){return e.compact?"":"margin: 1em 0"})),cs=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.externalDocs;return e&&e.url?i.createElement(ls,{compact:this.props.compact},i.createElement("a",{href:e.url},e.description||e.url)):null},t=Object(o.__decorate)([Ta],t)}(i.Component),us=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props,t=e.values,n=e.type,r=this.context.enumSkipQuotes;return t.length?i.createElement("div",null,i.createElement(Xa,null,"array"===n?ge("enumArray"):""," ",1===t.length?ge("enumSingleValue"):ge("enum"),":")," ",t.map((function(e,t){var n=r?e:JSON.stringify(e);return i.createElement(i.Fragment,{key:t},i.createElement(is,null,n)," ")}))):null},t.contextType=Ue,t}(i.PureComponent),fs=Te(Jo)(Ha||(Ha=Object(o.__makeTemplateObject)(["\n margin: 2px 0;\n"],["\n margin: 2px 0;\n"]))),ps=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.extensions;return i.createElement(Ue.Consumer,null,(function(t){return i.createElement(i.Fragment,null,t.showExtensions&&Object.keys(e).map((function(t){return i.createElement(fs,{key:t},i.createElement(Xa,null," ",t.substring(2),": ")," ",i.createElement(as,null,"string"==typeof e[t]?e[t]:JSON.stringify(e[t])))})))}))},t}(i.PureComponent),ds=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){return 0===this.props.constraints.length?null:i.createElement("span",null," ",this.props.constraints.map((function(e){return i.createElement(ss,{key:e}," ",e," ")})))},t}(i.PureComponent),hs=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){if(void 0===this.props.value)return null;var e=this.props.raw?this.props.value:JSON.stringify(this.props.value);return i.createElement("div",null,i.createElement(Xa,null," ",this.props.label," ")," ",i.createElement(is,null,e))},t}(i.PureComponent),ms=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props,t=e.showExamples,n=e.field,r=e.renderDiscriminatorSwitch,a=this.context,s=a.enumSkipQuotes,l=a.hideSchemaTitles,c=n.schema,u=n.description,f=n.example,p=n.deprecated,d=!!s||"header"===n.in,h=null;if(t&&void 0!==f){var m=ge("example")+":";if(n.in&&(n.style||n.serializationMime)){var g=decodeURIComponent(ut(n,f));h=i.createElement(hs,{label:m,value:g,raw:!0})}else h=i.createElement(hs,{label:m,value:f})}return i.createElement("div",null,i.createElement("div",null,i.createElement(Ka,null,c.typePrefix),i.createElement(Ja,null,c.displayType),c.displayFormat&&i.createElement(es,null," ","<",c.displayFormat,">"," "),c.title&&!l&&i.createElement(Za,null," (",c.title,") "),i.createElement(ds,{constraints:c.constraints}),c.nullable&&i.createElement(rs,null," ",ge("nullable")," "),c.pattern&&i.createElement(os,null," ",c.pattern," "),c.isCircular&&i.createElement(ns,null," ",ge("recursive")," ")),p&&i.createElement("div",null,i.createElement(pr,{type:"warning"}," ",ge("deprecated")," ")),i.createElement(hs,{raw:d,label:ge("default")+":",value:c.default}),!r&&i.createElement(us,{type:c.type,values:c.enum})," ",h,i.createElement(ps,{extensions:Object(o.__assign)(Object(o.__assign)({},n.extensions),c.extensions)}),i.createElement("div",null,i.createElement(si,{compact:!0,source:u})),c.externalDocs&&i.createElement(cs,{externalDocs:c.externalDocs,compact:!0}),r&&r(this.props)||null)},t.contextType=Ue,t}(i.PureComponent),gs=Te.div(Va||(Va=Object(o.__makeTemplateObject)(["\n padding-left: ","px;\n"],["\n padding-left: ","px;\n"])),(function(e){return 2*e.theme.spacing.unit})),ys=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.schema.items;return i.createElement("div",null,i.createElement(_r,null," Array "),i.createElement(gs,null,i.createElement(Es,Object(o.__assign)({},this.props,{schema:e}))),i.createElement(Sr,null))},t}(i.PureComponent),vs=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.toggle=function(){t.props.field.toggle()},t}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props,t=e.className,n=e.field,r=e.isLast,a=n.name,s=n.expanded,l=n.deprecated,c=n.required,u=n.kind,f=!n.schema.isPrimitive&&!n.schema.isCircular,p=f?i.createElement(Qa,{onClick:this.toggle,className:l?"deprecated":"",kind:u,title:a},i.createElement(br,null),a,i.createElement(fr,{direction:s?"down":"right"}),c&&i.createElement(ts,null," required ")):i.createElement(yr,{className:l?"deprecated":void 0,kind:u,title:a},i.createElement(br,null),a,c&&i.createElement(ts,null," required "));return i.createElement(i.Fragment,null,i.createElement("tr",{className:r?"last "+t:t},p,i.createElement(vr,null,i.createElement(ms,Object(o.__assign)({},this.props)))),n.expanded&&f&&i.createElement("tr",{key:n.name+"inner"},i.createElement(gr,{colSpan:2},i.createElement(wr,null,i.createElement(Es,{schema:n.schema,skipReadOnly:this.props.skipReadOnly,skipWriteOnly:this.props.skipWriteOnly,showTitle:this.props.showTitle})))))},t=Object(o.__decorate)([Ta],t)}(i.Component),bs=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.changeActiveChild=function(e){var n=e.value,r=parseInt(n,10);t.props.parent.activateOneOf(r)},t}return Object(o.__extends)(t,e),t.prototype.sortOptions=function(e,t){if(0!==t.length){var n={};t.forEach((function(e,t){n[e]=t})),e.sort((function(e,t){return n[e.label]>n[t.label]?1:-1}))}},t.prototype.render=function(){var e=this.props,t=e.parent,n=e.enumValues;if(void 0===t.oneOf)return null;var r=t.oneOf.map((function(e,t){return{value:t.toString(),label:e.title}})),o=r[t.activeOneOf];return this.sortOptions(r,n),i.createElement(jr,{value:o,options:r,onChange:this.changeActiveChild})},t=Object(o.__decorate)([Ta],t)}(i.Component),ws=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),Object.defineProperty(t.prototype,"parentSchema",{get:function(){return this.props.discriminator.parentSchema},enumerable:!0,configurable:!0}),t.prototype.render=function(){var e=this,t=this.props,n=t.schema.fields,r=void 0===n?[]:n,o=t.showTitle,a=t.discriminator,s=this.props.skipReadOnly||this.props.skipWriteOnly?r.filter((function(t){return!(e.props.skipReadOnly&&t.schema.readOnly||e.props.skipWriteOnly&&t.schema.writeOnly)})):r;return i.createElement(xr,null,o&&i.createElement(hr,null,this.props.schema.title),i.createElement("tbody",null,le(s,(function(t,n){return i.createElement(vs,{key:t.name,isLast:n,field:t,renderDiscriminatorSwitch:a&&a.fieldName===t.name&&function(){return i.createElement(bs,{parent:e.parentSchema,enumValues:t.schema.enum})}||void 0,className:t.expanded?"expanded":void 0,showExamples:!1,skipReadOnly:e.props.skipReadOnly,skipWriteOnly:e.props.skipWriteOnly,showTitle:e.props.showTitle})}))))},t=Object(o.__decorate)([Ta],t)}(i.Component),xs=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.activateOneOf=function(){t.props.schema.activateOneOf(t.props.idx)},t}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props,t=e.idx,n=e.schema,r=e.subSchema;return i.createElement(Or,{active:t===n.activeOneOf,onClick:this.activateOneOf},r.title||r.typePrefix+r.displayType)},t=Object(o.__decorate)([Ta],t)}(i.Component),ks=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props,t=e.schema.oneOf,n=e.schema;return void 0===t?null:i.createElement("div",null,i.createElement(Er,null," ",n.oneOfType," "),i.createElement(kr,null,t.map((function(e,t){return i.createElement(xs,{key:e.pointer,schema:n,subSchema:e,idx:t})}))),i.createElement(Es,Object(o.__assign)({},this.props,{schema:t[n.activeOneOf]})))},t=Object(o.__decorate)([Ta],t)}(i.Component),Es=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.schema;if(!e)return i.createElement("em",null," Schema not provided ");var t=e.type,n=e.oneOf,r=e.discriminatorProp;if(e.isCircular)return i.createElement("div",null,i.createElement(Ja,null,e.displayType),e.title&&i.createElement(Za,null," ",e.title," "),i.createElement(ns,null," ",ge("recursive")," "));if(void 0!==r){if(!n||!n.length)throw new Error("Looks like you are using discriminator wrong: you don't have any definition inherited from the "+e.title);return i.createElement(ws,Object(o.__assign)({},Object(o.__assign)(Object(o.__assign)({},this.props),{schema:n[e.activeOneOf]}),{discriminator:{fieldName:r,parentSchema:e}}))}if(void 0!==n)return i.createElement(ks,Object(o.__assign)({schema:e},this.props));switch(t){case"object":return i.createElement(ws,Object(o.__assign)({},this.props));case"array":return i.createElement(ys,Object(o.__assign)({},this.props))}var a={schema:e,name:"",required:!1,description:e.description,externalDocs:e.externalDocs,deprecated:!1,toggle:function(){return null},expanded:!1};return i.createElement("div",null,i.createElement(ms,{field:a}))},t=Object(o.__decorate)([Ta],t)}(i.Component),Os=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.renderDropdown=function(e){return i.createElement(Yo,Object(o.__assign)({Label:Ir,Dropdown:Wi},e))},t}return Object(o.__extends)(t,e),t.getMediaType=function(e,t){if(!e)return{};var n={schema:{$ref:e}};return t&&(n.examples={example:{$ref:t}}),n},Object.defineProperty(t.prototype,"mediaModel",{get:function(){var e=this.props,n=e.parser,r=e.schemaRef,o=e.exampleRef,i=e.options;return this._mediaModel||(this._mediaModel=new Qt(n,"json",!1,t.getMediaType(r,o),i)),this._mediaModel},enumerable:!0,configurable:!0}),t.prototype.render=function(){var e=this.props,t=e.showReadOnly,n=void 0===t||t,r=e.showWriteOnly,o=void 0!==r&&r;return i.createElement(_n,null,i.createElement(jn,null,i.createElement(On,null,i.createElement(Es,{skipWriteOnly:!o,skipReadOnly:!n,schema:this.mediaModel.schema})),i.createElement(Tn,null,i.createElement(_s,null,i.createElement(Vi,{renderDropdown:this.renderDropdown,mediaType:this.mediaModel})))))},t}(i.PureComponent),_s=Te.div(Ya||(Ya=Object(o.__makeTemplateObject)(["\n background: ",";\n & > div,\n & > pre {\n padding: ","px;\n margin: 0;\n }\n\n & > div > pre {\n padding: 0;\n }\n"],["\n background: ",";\n & > div,\n & > pre {\n padding: ","px;\n margin: 0;\n }\n\n & > div > pre {\n padding: 0;\n }\n"])),(function(e){return e.theme.codeSample.backgroundColor}),(function(e){return 4*e.theme.spacing.unit})),Ss={oauth2:"OAuth2",apiKey:"API Key",http:"HTTP",openIdConnect:"Open ID Connect"},Ts=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props,t=e.type,n=e.flow;return i.createElement("tr",null,i.createElement("th",null," ",t," OAuth Flow "),i.createElement("td",null,"implicit"===t||"authorizationCode"===t?i.createElement("div",null,i.createElement("strong",null," Authorization URL: "),n.authorizationUrl):null,"password"===t||"clientCredentials"===t||"authorizationCode"===t?i.createElement("div",null,i.createElement("strong",null," Token URL: "),n.tokenUrl):null,n.refreshUrl&&i.createElement("div",null,i.createElement("strong",null," Refresh URL: "),n.refreshUrl),i.createElement("div",null,i.createElement("strong",null," Scopes: ")),i.createElement("ul",null,Object.keys(n.scopes||{}).map((function(e){return i.createElement("li",{key:e},i.createElement("code",null,e)," - ",i.createElement(si,{inline:!0,source:n.scopes[e]||""}))})))))},t}(i.PureComponent),js=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){return this.props.securitySchemes.schemes.map((function(e){return i.createElement(_n,{id:e.sectionId,key:e.id},i.createElement(jn,null,i.createElement(On,null,i.createElement(Pn,null,i.createElement(Wn,{to:e.sectionId}),e.id),i.createElement(si,{source:e.description||""}),i.createElement(Jo,null,i.createElement("table",{className:"security-details"},i.createElement("tbody",null,i.createElement("tr",null,i.createElement("th",null," Security Scheme Type "),i.createElement("td",null," ",Ss[e.type]||e.type," ")),e.apiKey?i.createElement("tr",null,i.createElement("th",null," ",(t=e.apiKey.in||"").charAt(0).toUpperCase()+t.slice(1)," parameter name:"),i.createElement("td",null," ",e.apiKey.name," ")):e.http?[i.createElement("tr",{key:"scheme"},i.createElement("th",null," HTTP Authorization Scheme "),i.createElement("td",null," ",e.http.scheme," ")),"bearer"===e.http.scheme&&e.http.bearerFormat&&i.createElement("tr",{key:"bearer"},i.createElement("th",null," Bearer format "),i.createElement("td",null,' "',e.http.bearerFormat,'" '))]:e.openId?i.createElement("tr",null,i.createElement("th",null," Connect URL "),i.createElement("td",null,i.createElement("a",{target:"_blank",href:e.openId.connectUrl},e.openId.connectUrl))):e.flows?Object.keys(e.flows).map((function(t){return i.createElement(Ts,{key:t,type:t,flow:e.flows[t]})})):null))))));var t}))},t}(i.PureComponent);var Cs,Is,As,Ps,Rs,Ns,Ls,Ms,Ds,Fs,Us,zs,Bs,$s,qs,Ws,Hs,Vs,Ys,Gs,Qs,Xs,Ks=function(){function e(e,t,n,r){var o=this;void 0===n&&(n={}),void 0===r&&(r=!0),this.marker=new Ct,this.disposer=null,this.rawOptions=n,this.options=new be(n,Js),this.scroll=new on(this.options),rn.updateOnHistory(Tt.currentId,this.scroll),this.spec=new zt(e,t,this.options),this.menu=new rn(this.spec,this.scroll,Tt),this.options.disableSearch||(this.search=new En,r&&this.search.indexItems(this.menu.items),this.disposer=Object($e.m)(this.menu,"activeItemIdx",(function(e){o.updateMarkOnMenu(e.newValue)})))}return e.fromJS=function(t){var n=new e(t.spec.data,t.spec.url,t.options,!1);return n.menu.activeItemIdx=t.menu.activeItemIdx||0,n.menu.activate(n.menu.flatItems[n.menu.activeItemIdx]),n.options.disableSearch||n.search.load(t.searchIndex),n},e.prototype.onDidMount=function(){this.menu.updateOnHistory(),this.updateMarkOnMenu(this.menu.activeItemIdx)},e.prototype.dispose=function(){this.scroll.dispose(),this.menu.dispose(),this.search&&this.search.dispose(),null!=this.disposer&&this.disposer()},e.prototype.toJS=function(){return Object(o.__awaiter)(this,void 0,void 0,(function(){var e,t;return Object(o.__generator)(this,(function(n){switch(n.label){case 0:return e={menu:{activeItemIdx:this.menu.activeItemIdx},spec:{url:this.spec.parser.specUrl,data:this.spec.parser.spec}},this.search?[4,this.search.toJS()]:[3,2];case 1:return t=n.sent(),[3,3];case 2:t=void 0,n.label=3;case 3:return[2,(e.searchIndex=t,e.options=this.rawOptions,e)]}}))}))},e.prototype.updateMarkOnMenu=function(e){for(var t=Math.max(0,e),n=Math.min(this.menu.flatItems.length,t+5),r=[],o=t;o<n;o++){var i=this.menu.getElementAt(o);i&&("section"===this.menu.flatItems[o].type&&(i=i.parentElement.parentElement),i&&r.push(i))}this.marker.addOnly(r),this.marker.mark()},e}(),Js={allowedMdComponents:(Ga={},Ga["security-definitions"]={component:js,propsSelector:function(e){return{securitySchemes:e.spec.securitySchemes}}},Ga.SecurityDefinitions={component:js,propsSelector:function(e){return{securitySchemes:e.spec.securitySchemes}}},Ga.SchemaDefinition={component:Os,propsSelector:function(e){return{parser:e.spec.parser,options:e.options}}},Ga)},Zs=Te(An)(Cs||(Cs=Object(o.__makeTemplateObject)(["\n margin-top: 0;\n margin-bottom: 0.5em;\n\n ",";\n"],["\n margin-top: 0;\n margin-bottom: 0.5em;\n\n ",";\n"])),je("ApiHeader")),el=Te.a(Is||(Is=Object(o.__makeTemplateObject)(["\n border: 1px solid ",";\n color: ",";\n font-weight: normal;\n margin-left: 0.5em;\n padding: 4px 8px 4px;\n display: inline-block;\n text-decoration: none;\n cursor: pointer;\n\n ",";\n"],["\n border: 1px solid ",";\n color: ",";\n font-weight: normal;\n margin-left: 0.5em;\n padding: 4px 8px 4px;\n display: inline-block;\n text-decoration: none;\n cursor: pointer;\n\n ",";\n"])),(function(e){return e.theme.colors.primary.main}),(function(e){return e.theme.colors.primary.main}),je("DownloadButton")),tl=Te.span(As||(As=Object(o.__makeTemplateObject)(["\n &::before {\n content: '|';\n display: inline-block;\n opacity: 0.5;\n width: ","px;\n text-align: center;\n }\n\n &:last-child::after {\n display: none;\n }\n"],["\n &::before {\n content: '|';\n display: inline-block;\n opacity: 0.5;\n width: ","px;\n text-align: center;\n }\n\n &:last-child::after {\n display: none;\n }\n"])),15),nl=Te.div(Ps||(Ps=Object(o.__makeTemplateObject)(["\n overflow: hidden;\n"],["\n overflow: hidden;\n"]))),rl=Te.div(Rs||(Rs=Object(o.__makeTemplateObject)(["\n display: flex;\n flex-wrap: wrap;\n // hide separator on new lines: idea from https://stackoverflow.com/a/31732902/1749888\n margin-left: -","px;\n"],["\n display: flex;\n flex-wrap: wrap;\n // hide separator on new lines: idea from https://stackoverflow.com/a/31732902/1749888\n margin-left: -","px;\n"])),15),ol=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.handleDownloadClick=function(e){e.target.href||(e.target.href=t.props.store.spec.info.downloadLink)},t}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.store,t=e.spec,n=t.info,r=t.externalDocs,o=e.options.hideDownloadButton,a=n.downloadFileName,s=n.downloadLink,l=n.license&&i.createElement(tl,null,"License: ",i.createElement("a",{href:n.license.url},n.license.name))||null,c=n.contact&&n.contact.url&&i.createElement(tl,null,"URL: ",i.createElement("a",{href:n.contact.url},n.contact.url))||null,u=n.contact&&n.contact.email&&i.createElement(tl,null,n.contact.name||"E-mail",":"," ",i.createElement("a",{href:"mailto:"+n.contact.email},n.contact.email))||null,f=n.termsOfService&&i.createElement(tl,null,i.createElement("a",{href:n.termsOfService},"Terms of Service"))||null,p=n.version&&i.createElement("span",null,"(",n.version,")")||null;return i.createElement(_n,null,i.createElement(jn,null,i.createElement(On,{className:"api-info"},i.createElement(Zs,null,n.title," ",p),!o&&i.createElement("p",null,"Download OpenAPI specification:",i.createElement(el,{download:a,target:"_blank",href:s,onClick:this.handleDownloadClick},"Download")),i.createElement(Jo,null,(n.license||n.contact||n.termsOfService)&&i.createElement(nl,null,i.createElement(rl,null,u," ",c," ",l," ",f))||null),i.createElement(si,{source:e.spec.info.description}),r&&i.createElement(cs,{externalDocs:r}))))},t=Object(o.__decorate)([Ta],t)}(i.Component),il=Te.img(Ns||(Ns=Object(o.__makeTemplateObject)(["\n max-height: ",";\n max-width: ",";\n padding: ",";\n width: 100%;\n display: block;\n"],["\n max-height: ",";\n max-width: ",";\n padding: ",";\n width: 100%;\n display: block;\n"])),(function(e){return e.theme.logo.maxHeight}),(function(e){return e.theme.logo.maxWidth}),(function(e){return e.theme.logo.gutter})),al=Te.div(Ls||(Ls=Object(o.__makeTemplateObject)(["\n text-align: center;\n"],["\n text-align: center;\n"]))),sl=Te.a(Ms||(Ms=Object(o.__makeTemplateObject)(["\n display: inline-block;\n"],["\n display: inline-block;\n"]))),ll=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.info,t=e["x-logo"];if(!t||!t.url)return null;var n,r=t.href||e.contact&&e.contact.url,o=t.altText?t.altText:"logo",a=i.createElement(il,{src:t.url,alt:o});return i.createElement(al,{style:{backgroundColor:t.backgroundColor}},r?(n=r,function(e){return i.createElement(sl,{href:n},e)})(a):a)},t=Object(o.__decorate)([Ta],t)}(i.Component),cl=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this;return i.createElement(Be,null,(function(t){return i.createElement(Fn,null,(function(n){return e.renderWithOptionsAndStore(t,n)}))}))},t.prototype.renderWithOptionsAndStore=function(e,t){var n=this.props,r=n.source,a=n.htmlWrap,s=void 0===a?function(e){return e}:a;if(!t)throw new Error("When using components in markdown, store prop must be provided");var l=new Rt(e).renderMdWithComponents(r);return l.length?l.map((function(e,n){return"string"==typeof e?i.cloneElement(s(i.createElement(ti,{html:e,inline:!1,compact:!1})),{key:n}):i.createElement(e.component,Object(o.__assign)({key:n},Object(o.__assign)(Object(o.__assign)({},e.props),e.propsSelector(t))))})):null},t}(i.Component),ul=Te.code(Ds||(Ds=Object(o.__makeTemplateObject)(["\n font-size: ",";\n font-family: ",";\n border: 1px solid ",";\n margin: 0 3px;\n padding: 0.2em;\n display: inline-block;\n line-height: 1;\n\n &:after {\n content: ',';\n }\n &:last-child:after {\n content: none;\n }\n"],["\n font-size: ",";\n font-family: ",";\n border: 1px solid ",";\n margin: 0 3px;\n padding: 0.2em;\n display: inline-block;\n line-height: 1;\n\n &:after {\n content: ',';\n }\n &:last-child:after {\n content: none;\n }\n"])),(function(e){return e.theme.typography.code.fontSize}),(function(e){return e.theme.typography.code.fontFamily}),(function(e){return e.theme.colors.border.dark})),fl=Te.span(Fs||(Fs=Object(o.__makeTemplateObject)(["\n &:after {\n content: ' AND ';\n font-weight: bold;\n }\n\n &:last-child:after {\n content: none;\n }\n\n ",";\n"],["\n &:after {\n content: ' AND ';\n font-weight: bold;\n }\n\n &:last-child:after {\n content: none;\n }\n\n ",";\n"])),Ko),pl=Te.span(Us||(Us=Object(o.__makeTemplateObject)(["\n &:before {\n content: '( ';\n font-weight: bold;\n }\n &:after {\n content: ' ) OR ';\n font-weight: bold;\n }\n &:last-child:after {\n content: ' )';\n }\n\n &:only-child:before,\n &:only-child:after {\n content: none;\n }\n\n ",";\n"],["\n &:before {\n content: '( ';\n font-weight: bold;\n }\n &:after {\n content: ' ) OR ';\n font-weight: bold;\n }\n &:last-child:after {\n content: ' )';\n }\n\n &:only-child:before,\n &:only-child:after {\n content: none;\n }\n\n ",";\n"])),Ko),dl=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.security;return i.createElement(pl,null,e.schemes.map((function(e){return i.createElement(fl,{key:e.id},i.createElement($n,{to:e.sectionId},e.id),e.scopes.length>0&&" (",e.scopes.map((function(e){return i.createElement(ul,{key:e},e)})),e.scopes.length>0&&") ")})))},t}(i.PureComponent),hl=Te.div(zs||(zs=Object(o.__makeTemplateObject)(["\n flex: 1;\n"],["\n flex: 1;\n"]))),ml=Te.div(Bs||(Bs=Object(o.__makeTemplateObject)(["\n width: ",";\n"],["\n width: ",";\n"])),(function(e){return e.theme.schema.defaultDetailsWidth})),gl=Te(Nn)($s||($s=Object(o.__makeTemplateObject)(["\n display: inline-block;\n margin: 0;\n"],["\n display: inline-block;\n margin: 0;\n"]))),yl=Te.div(qs||(qs=Object(o.__makeTemplateObject)(["\n width: 100%;\n display: flex;\n margin: 1em 0;\n"],["\n width: 100%;\n display: flex;\n margin: 1em 0;\n"]))),vl=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.securities;return e.length?i.createElement(yl,null,i.createElement(hl,null,i.createElement(gl,null,"Authorizations: ")),i.createElement(ml,null,e.map((function(e,t){return i.createElement(dl,{key:t,security:e})})))):null},t}(i.PureComponent),bl=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.handleClick=function(){mi.selectElement(t.child)},t}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this,t=this.props.children;return i.createElement("div",{ref:function(t){return e.child=t},onClick:this.handleClick},t)},t}(i.PureComponent),wl=Te.div(Ws||(Ws=Object(o.__makeTemplateObject)(["\n cursor: pointer;\n position: relative;\n margin-bottom: 5px;\n"],["\n cursor: pointer;\n position: relative;\n margin-bottom: 5px;\n"]))),xl=Te.span(Hs||(Hs=Object(o.__makeTemplateObject)(["\n font-family: ",";\n margin-left: 10px;\n flex: 1;\n overflow-x: hidden;\n text-overflow: ellipsis;\n"],["\n font-family: ",";\n margin-left: 10px;\n flex: 1;\n overflow-x: hidden;\n text-overflow: ellipsis;\n"])),(function(e){return e.theme.typography.code.fontFamily})),kl=Te.div(Vs||(Vs=Object(o.__makeTemplateObject)(["\n padding: 10px 30px 10px ",";\n border-radius: ",";\n background-color: ",";\n display: flex;\n white-space: nowrap;\n align-items: center;\n border: ",";\n border-bottom: ",";\n transition: border-color 0.25s ease;\n\n ","\n\n ."," {\n color: ","\n }\n"],["\n padding: 10px 30px 10px ",";\n border-radius: ",";\n background-color: ",";\n display: flex;\n white-space: nowrap;\n align-items: center;\n border: ",";\n border-bottom: ",";\n transition: border-color 0.25s ease;\n\n ","\n\n ."," {\n color: ","\n }\n"])),(function(e){return e.inverted?"10px":"20px"}),(function(e){return e.inverted?"0":"4px 4px 0 0"}),(function(e){return e.inverted?"transparent":e.theme.codeSample.backgroundColor}),(function(e){return e.inverted?"0":"1px solid transparent"}),(function(e){return e.inverted?"1px solid #ccc":"0"}),(function(e){return e.expanded&&!e.inverted&&"border-color: "+e.theme.colors.border.dark+";"||""}),xl,(function(e){return e.inverted?e.theme.colors.text.primary:"#ffffff"})),El=Te.span.attrs((function(e){return{className:"http-verb "+e.type}}))(Ys||(Ys=Object(o.__makeTemplateObject)(["\n font-size: 0.929em;\n line-height: 20px;\n background-color: ",";\n color: #ffffff;\n padding: 3px 10px;\n text-transform: uppercase;\n font-family: ",";\n margin: 0;\n"],["\n font-size: 0.929em;\n line-height: 20px;\n background-color: ",";\n color: #ffffff;\n padding: 3px 10px;\n text-transform: uppercase;\n font-family: ",";\n margin: 0;\n"])),(function(e){return e.theme.colors.http[e.type]||"#999999"}),(function(e){return e.theme.typography.headings.fontFamily})),Ol=Te.div(Gs||(Gs=Object(o.__makeTemplateObject)(["\n position: absolute;\n width: 100%;\n z-index: 100;\n background: #fafafa;\n color: #263238;\n box-sizing: border-box;\n box-shadow: 0px 0px 6px rgba(0, 0, 0, 0.33);\n overflow: hidden;\n border-bottom-left-radius: 4px;\n border-bottom-right-radius: 4px;\n transition: all 0.25s ease;\n\n ","\n"],["\n position: absolute;\n width: 100%;\n z-index: 100;\n background: #fafafa;\n color: #263238;\n box-sizing: border-box;\n box-shadow: 0px 0px 6px rgba(0, 0, 0, 0.33);\n overflow: hidden;\n border-bottom-left-radius: 4px;\n border-bottom-right-radius: 4px;\n transition: all 0.25s ease;\n\n ","\n"])),(function(e){return e.expanded?"":"transform: translateY(-50%) scaleY(0);"})),_l=Te.div(Qs||(Qs=Object(o.__makeTemplateObject)(["\n padding: 10px;\n"],["\n padding: 10px;\n"]))),Sl=Te.div(Xs||(Xs=Object(o.__makeTemplateObject)(["\n padding: 5px;\n border: 1px solid #ccc;\n background: #fff;\n word-break: break-all;\n color: ",";\n > span {\n color: ",";\n }\n"],["\n padding: 5px;\n border: 1px solid #ccc;\n background: #fff;\n word-break: break-all;\n color: ",";\n > span {\n color: ",";\n }\n"])),(function(e){return e.theme.colors.primary.main}),(function(e){return e.theme.colors.text.primary})),Tl=function(e){function t(t){var n=e.call(this,t)||this;return n.toggle=function(){n.setState({expanded:!n.state.expanded})},n.state={expanded:!1},n}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this,t=this.props,n=t.operation,r=t.inverted,o=t.hideHostname,a=this.state.expanded;return i.createElement(Ue.Consumer,null,(function(t){return i.createElement(wl,null,i.createElement(kl,{onClick:e.toggle,expanded:a,inverted:r},i.createElement(El,{type:n.httpVerb}," ",n.httpVerb)," ",i.createElement(xl,null,n.path),i.createElement(fr,{float:"right",color:r?"black":"white",size:"20px",direction:a?"up":"down",style:{marginRight:"-25px"}})),i.createElement(Ol,{expanded:a},n.servers.map((function(e){var r,a,s=t.expandDefaultServerVariables?(r=e.url,void 0===(a=e.variables)&&(a={}),r.replace(/(?:{)(\w+)(?:})/g,(function(e,t){return a[t]&&a[t].default||e}))):e.url;return i.createElement(_l,{key:s},i.createElement(si,{source:e.description||"",compact:!0}),i.createElement(bl,null,i.createElement(Sl,null,i.createElement("span",null,o||t.hideHostname?function(e){try{return he(e).pathname}catch(t){return e}}(s):s),n.path)))}))))}))},t}(i.Component),jl=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props,t=e.place,n=e.parameters;return n&&n.length?i.createElement("div",{key:t},i.createElement(Nn,null,t," Parameters"),i.createElement(xr,null,i.createElement("tbody",null,le(n,(function(e,t){return i.createElement(vs,{key:e.name,isLast:t,field:e,showExamples:!0})}))))):null},t}(i.PureComponent),Cl=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.switchMedia=function(e){var n=e.value;t.props.content&&t.props.content.activate(parseInt(n,10))},t}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this,t=this.props.content;if(!t||!t.mediaTypes||!t.mediaTypes.length)return null;var n=t.activeMimeIdx,r=t.mediaTypes.map((function(e,t){return{label:e.name,value:t.toString()}}));return i.createElement(i.Fragment,null,i.createElement((function(t){var n=t.children;return e.props.withLabel?i.createElement(qi,null,i.createElement($i,null,"Content type"),n):n}),null,this.props.renderDropdown({value:r[n],options:r,onChange:this.switchMedia})),this.props.children(t.active))},t=Object(o.__decorate)([Ta],t)}(i.Component);var Il=["path","query","cookie","header"],Al=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.orderParams=function(e){var t={};return e.forEach((function(e){var n,r,o;n=t,r=e.in,o=e,n[r]||(n[r]=[]),n[r].push(o)})),t},t.prototype.render=function(){var e=this.props,t=e.body,n=e.parameters,r=void 0===n?[]:n;if(void 0===t&&void 0===r)return null;var o=this.orderParams(r),a=r.length>0?Il:[],s=t&&t.content,l=t&&t.description;return i.createElement(i.Fragment,null,a.map((function(e){return i.createElement(jl,{key:e,place:e,parameters:o[e]})})),s&&i.createElement(Rl,{content:s,description:l}))},t}(i.PureComponent);function Pl(e){return i.createElement(Nn,{key:"header"},"Request Body schema: ",i.createElement(Yo,Object(o.__assign)({},e)))}function Rl(e){var t=e.content,n=e.description;return i.createElement(Cl,{content:t,renderDropdown:Pl},(function(e){var t=e.schema;return i.createElement(i.Fragment,null,void 0!==n&&i.createElement(si,{source:n}),i.createElement(Es,{skipReadOnly:!0,key:"schema",schema:t}))}))}var Nl,Ll,Ml,Dl,Fl,Ul,zl=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.renderDropdown=function(e){return i.createElement(Yo,Object(o.__assign)({Label:Bi,Dropdown:Wi},e))},t}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this,t=this.props.content;return void 0===t?null:i.createElement(Cl,{content:t,renderDropdown:this.renderDropdown,withLabel:!0},(function(t){return i.createElement(Vi,{key:"samples",mediaType:t,renderDropdown:e.renderDropdown})}))},t=Object(o.__decorate)([Ta],t)}(i.Component),Bl=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.operation.codeSamples,t=e.length>0,n=1===e.length&&this.context.hideSingleRequestSampleTab;return t&&i.createElement("div",null,i.createElement(Rn,null," Request samples "),i.createElement(lo,{defaultIndex:0},i.createElement(Kr,{hidden:n},e.map((function(e){return i.createElement(Zr,{key:e.lang+"_"+(e.label||"")},void 0!==e.label?e.label:e.lang)}))),e.map((function(e){return i.createElement(to,{key:e.lang+"_"+(e.label||"")},function(e){return"payload"===e.lang&&e.requestBodyContent}(e)?i.createElement("div",null,i.createElement(zl,{content:e.requestBodyContent})):i.createElement(Ai,{lang:e.lang,source:e.source}))}))))||null},t.contextType=Ue,t=Object(o.__decorate)([Ta],t)}(i.Component),$l=Te(function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props,t=e.title,n=e.type,r=e.empty,o=e.code,a=e.opened,s=e.className,l=e.onClick;return i.createElement("div",{className:s,onClick:!r&&l||void 0},!r&&i.createElement(fr,{size:"1.5em",color:n,direction:a?"down":"right",float:"left"}),i.createElement("strong",null,o," "),i.createElement(si,{compact:!0,inline:!0,source:t}))},t}(i.PureComponent))(Nl||(Nl=Object(o.__makeTemplateObject)(["\n padding: 10px;\n border-radius: 2px;\n margin-bottom: 4px;\n line-height: 1.5em;\n background-color: #f2f2f2;\n cursor: pointer;\n\n color: ",";\n background-color: ",";\n\n ",";\n"],["\n padding: 10px;\n border-radius: 2px;\n margin-bottom: 4px;\n line-height: 1.5em;\n background-color: #f2f2f2;\n cursor: pointer;\n\n color: ",";\n background-color: ",";\n\n ",";\n"])),(function(e){return e.theme.colors.responses[e.type].color}),(function(e){return e.theme.colors.responses[e.type].backgroundColor}),(function(e){return e.empty?'\ncursor: default;\n&::before {\n content: "—";\n font-weight: bold;\n width: 1.5em;\n text-align: center;\n display: inline-block;\n}\n':""})),ql=Te.div(Ll||(Ll=Object(o.__makeTemplateObject)(["\n padding: 10px;\n"],["\n padding: 10px;\n"]))),Wl=Te(Nn.withComponent("caption"))(Ml||(Ml=Object(o.__makeTemplateObject)(["\n text-align: left;\n margin-top: 1em;\n caption-side: top;\n"],["\n text-align: left;\n margin-top: 1em;\n caption-side: top;\n"]))),Hl=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.headers;return void 0===e||0===e.length?null:i.createElement(xr,null,i.createElement(Wl,null," Response Headers "),i.createElement("tbody",null,le(e,(function(e,t){return i.createElement(vs,{isLast:t,key:e.name,field:e,showExamples:!0})}))))},t}(i.PureComponent),Vl=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.renderDropdown=function(e){return i.createElement(Nn,{key:"header"},"Response Schema: ",i.createElement(Yo,Object(o.__assign)({},e)))},t}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.response,t=e.description,n=e.headers,r=e.content;return i.createElement(i.Fragment,null,t&&i.createElement(si,{source:t}),i.createElement(Hl,{headers:n}),i.createElement(Cl,{content:r,renderDropdown:this.renderDropdown},(function(e){var t=e.schema;return i.createElement(Es,{skipWriteOnly:!0,key:"schema",schema:t})})))},t}(i.PureComponent),Yl=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.toggle=function(){t.props.response.toggle()},t}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.response,t=e.headers,n=e.type,r=e.summary,o=e.description,a=e.code,s=e.expanded,l=e.content,c=void 0===l?[]:l.mediaTypes.filter((function(e){return void 0!==e.schema})),u=0===t.length&&0===c.length&&!o;return i.createElement("div",null,i.createElement($l,{onClick:this.toggle,type:n,empty:u,title:r||"",code:a,opened:s}),s&&!u&&i.createElement(ql,null,i.createElement(Vl,{response:this.props.response})))},t=Object(o.__decorate)([Ta],t)}(i.Component),Gl=Te.h3(Dl||(Dl=Object(o.__makeTemplateObject)(["\n font-size: 18px;\n padding: 0.2em 0;\n margin: 3em 0 1.1em;\n color: #253137;\n font-weight: normal;\n"],["\n font-size: 18px;\n padding: 0.2em 0;\n margin: 3em 0 1.1em;\n color: #253137;\n font-weight: normal;\n"]))),Ql=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.responses;return e&&0!==e.length?i.createElement("div",null,i.createElement(Gl,null," Responses "),e.map((function(e){return i.createElement(Yl,{key:e.code,response:e})}))):null},t}(i.PureComponent),Xl=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.operation.responses.filter((function(e){return e.content&&e.content.hasSample}));return e.length>0&&i.createElement("div",null,i.createElement(Rn,null," Response samples "),i.createElement(lo,{defaultIndex:0},i.createElement(Kr,null,e.map((function(e){return i.createElement(Zr,{className:"tab-"+e.type,key:e.code},e.code)}))),e.map((function(e){return i.createElement(to,{key:e.code},i.createElement("div",null,i.createElement(zl,{content:e.content})))}))))||null},t=Object(o.__decorate)([Ta],t)}(i.Component),Kl=Te(jn)(Fl||(Fl=Object(o.__makeTemplateObject)(["\n backface-visibility: hidden;\n contain: content;\n\n overflow: hidden;\n"],["\n backface-visibility: hidden;\n contain: content;\n\n overflow: hidden;\n"]))),Jl=Te.div(Ul||(Ul=Object(o.__makeTemplateObject)(["\n margin-bottom: ","px;\n"],["\n margin-bottom: ","px;\n"])),(function(e){return 6*e.theme.spacing.unit})),Zl=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.operation,t=e.name,n=e.description,r=e.deprecated,o=e.externalDocs,a=!(!n&&!o);return i.createElement(Ue.Consumer,null,(function(s){return i.createElement(Kl,null,i.createElement(On,null,i.createElement(Pn,null,i.createElement(Wn,{to:e.id}),t," ",r&&i.createElement(pr,{type:"warning"}," Deprecated ")),s.pathInMiddlePanel&&i.createElement(Tl,{operation:e,inverted:!0}),a&&i.createElement(Jl,null,void 0!==n&&i.createElement(si,{source:n}),o&&i.createElement(cs,{externalDocs:o})),i.createElement(ps,{extensions:e.extensions}),i.createElement(vl,{securities:e.security}),i.createElement(Al,{parameters:e.parameters,body:e.requestBody}),i.createElement(Ql,{responses:e.responses})),i.createElement(Tn,null,!s.pathInMiddlePanel&&i.createElement(Tl,{operation:e}),i.createElement(Bl,{operation:e}),i.createElement(Xl,{operation:e})))}))},t=Object(o.__decorate)([Ta],t)}(i.Component),ec=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.items;return 0===e.length?null:e.map((function(e){return i.createElement(tc,{item:e,key:e.id})}))},t=Object(o.__decorate)([Ta],t)}(i.Component),tc=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e,t=this.props.item;switch(t.type){case"group":e=null;break;case"tag":case"section":e=i.createElement(rc,Object(o.__assign)({},this.props));break;case"operation":e=i.createElement(oc,{item:t});break;default:e=i.createElement(rc,Object(o.__assign)({},this.props))}return i.createElement(i.Fragment,null,e&&i.createElement(_n,{id:t.id,underlined:"operation"===t.type},e),t.items&&i.createElement(ec,{items:t.items}))},t=Object(o.__decorate)([Ta],t)}(i.Component),nc=function(e){return i.createElement(On,{compact:!0},e)},rc=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.item,t=e.name,n=e.description,r=e.externalDocs,o=2===e.level?Pn:An;return i.createElement(i.Fragment,null,i.createElement(jn,null,i.createElement(On,{compact:!1},i.createElement(o,null,i.createElement(Wn,{to:this.props.item.id}),t))),i.createElement(cl,{source:n||"",htmlWrap:nc}),r&&i.createElement(jn,null,i.createElement(On,null,i.createElement(cs,{externalDocs:r}))))},t=Object(o.__decorate)([Ta],t)}(i.Component),oc=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){return i.createElement(Zl,{operation:this.props.item})},t=Object(o.__decorate)([Ta],t)}(i.Component),ic=Te.span.attrs((function(e){return{className:"operation-type "+e.type}}))(sc||(sc=Object(o.__makeTemplateObject)(["\n width: 32px;\n display: inline-block;\n height: ",";\n line-height: ",";\n background-color: #333;\n border-radius: 3px;\n background-repeat: no-repeat;\n background-position: 6px 4px;\n font-size: 7px;\n font-family: Verdana; // web-safe\n color: white;\n text-transform: uppercase;\n text-align: center;\n font-weight: bold;\n vertical-align: middle;\n margin-right: 6px;\n margin-top: 2px;\n\n &.get {\n background-color: ",";\n }\n\n &.post {\n background-color: ",";\n }\n\n &.put {\n background-color: ",";\n }\n\n &.options {\n background-color: ",";\n }\n\n &.patch {\n background-color: ",";\n }\n\n &.delete {\n background-color: ",";\n }\n\n &.basic {\n background-color: ",";\n }\n\n &.link {\n background-color: ",";\n }\n\n &.head {\n background-color: ",";\n }\n"],["\n width: 32px;\n display: inline-block;\n height: ",";\n line-height: ",";\n background-color: #333;\n border-radius: 3px;\n background-repeat: no-repeat;\n background-position: 6px 4px;\n font-size: 7px;\n font-family: Verdana; // web-safe\n color: white;\n text-transform: uppercase;\n text-align: center;\n font-weight: bold;\n vertical-align: middle;\n margin-right: 6px;\n margin-top: 2px;\n\n &.get {\n background-color: ",";\n }\n\n &.post {\n background-color: ",";\n }\n\n &.put {\n background-color: ",";\n }\n\n &.options {\n background-color: ",";\n }\n\n &.patch {\n background-color: ",";\n }\n\n &.delete {\n background-color: ",";\n }\n\n &.basic {\n background-color: ",";\n }\n\n &.link {\n background-color: ",";\n }\n\n &.head {\n background-color: ",";\n }\n"])),(function(e){return e.theme.typography.code.fontSize}),(function(e){return e.theme.typography.code.fontSize}),(function(e){return e.theme.colors.http.get}),(function(e){return e.theme.colors.http.post}),(function(e){return e.theme.colors.http.put}),(function(e){return e.theme.colors.http.options}),(function(e){return e.theme.colors.http.patch}),(function(e){return e.theme.colors.http.delete}),(function(e){return e.theme.colors.http.basic}),(function(e){return e.theme.colors.http.link}),(function(e){return e.theme.colors.http.head}));function ac(e,t){var n=t.theme;return e>1?V(.1,n.menu.backgroundColor):1===e?V(.05,n.menu.backgroundColor):""}var sc,lc,cc,uc,fc,pc,dc,hc,mc,gc,yc,vc=Te.ul(lc||(lc=Object(o.__makeTemplateObject)(["\n margin: 0;\n padding: 0;\n\n & & {\n font-size: 0.929em;\n }\n\n ",";\n"],["\n margin: 0;\n padding: 0;\n\n & & {\n font-size: 0.929em;\n }\n\n ",";\n"])),(function(e){return e.expanded?"":"display: none;"})),bc=Te.li(cc||(cc=Object(o.__makeTemplateObject)(["\n list-style: none inside none;\n overflow: hidden;\n text-overflow: ellipsis;\n padding: 0;\n ",";\n"],["\n list-style: none inside none;\n overflow: hidden;\n text-overflow: ellipsis;\n padding: 0;\n ",";\n"])),(function(e){return 0===e.depth?"margin-top: 15px":""})),wc={0:ke(uc||(uc=Object(o.__makeTemplateObject)(["\n opacity: 0.7;\n text-transform: ",";\n font-size: 0.8em;\n padding-bottom: 0;\n cursor: default;\n color: ",";\n "],["\n opacity: 0.7;\n text-transform: ",";\n font-size: 0.8em;\n padding-bottom: 0;\n cursor: default;\n color: ",";\n "])),(function(e){return e.theme.menu.groupItems.textTransform}),(function(e){return e.theme.menu.textColor})),1:ke(fc||(fc=Object(o.__makeTemplateObject)(["\n font-size: 0.929em;\n text-transform: ",";\n &:hover {\n color: ",";\n }\n "],["\n font-size: 0.929em;\n text-transform: ",";\n &:hover {\n color: ",";\n }\n "])),(function(e){return e.theme.menu.level1Items.textTransform}),(function(e){return e.theme.menu.activeTextColor})),2:ke(pc||(pc=Object(o.__makeTemplateObject)(["\n color: ",";\n "],["\n color: ",";\n "])),(function(e){return e.theme.menu.textColor}))},xc=Te.label.attrs((function(e){return{role:"menuitem",className:Fr("-depth"+e.depth,{active:e.active})}}))(dc||(dc=Object(o.__makeTemplateObject)(["\n cursor: pointer;\n color: ",";\n margin: 0;\n padding: 12.5px ","px;\n ","\n display: flex;\n justify-content: space-between;\n font-family: ",";\n ",";\n background-color: ",";\n\n ",";\n\n &:hover {\n background-color: ",";\n }\n\n "," {\n height: ",";\n width: ",";\n polygon {\n fill: ",";\n }\n }\n"],["\n cursor: pointer;\n color: ",";\n margin: 0;\n padding: 12.5px ","px;\n ","\n display: flex;\n justify-content: space-between;\n font-family: ",";\n ",";\n background-color: ",";\n\n ",";\n\n &:hover {\n background-color: ",";\n }\n\n "," {\n height: ",";\n width: ",";\n polygon {\n fill: ",";\n }\n }\n"])),(function(e){return e.active?e.theme.menu.activeTextColor:e.theme.menu.textColor}),(function(e){return 4*e.theme.spacing.unit}),(function(e){var t=e.depth,n=e.type,r=e.theme;return"section"===n&&t>1&&"padding-left: "+8*r.spacing.unit+"px;"||""}),(function(e){return e.theme.typography.headings.fontFamily}),(function(e){return wc[e.depth]}),(function(e){return e.active?ac(e.depth,e):""}),(function(e){return e.deprecated&&dr||""}),(function(e){return ac(e.depth,e)}),fr,(function(e){return e.theme.menu.arrow.size}),(function(e){return e.theme.menu.arrow.size}),(function(e){return e.theme.menu.arrow.color})),kc=Te.span(hc||(hc=Object(o.__makeTemplateObject)(["\n display: inline-block;\n vertical-align: middle;\n width: ",";\n overflow: hidden;\n text-overflow: ellipsis;\n"],["\n display: inline-block;\n vertical-align: middle;\n width: ",";\n overflow: hidden;\n text-overflow: ellipsis;\n"])),(function(e){return e.width?e.width:"auto"})),Ec=Te.div(mc||(mc=Object(o.__makeTemplateObject)(["\n ",";\n"],["\n ",";\n"])),(function(e){var t=e.theme;return"\n font-size: 0.8em;\n margin-top: "+2*t.spacing.unit+"px;\n padding: 0 "+4*t.spacing.unit+"px;\n text-align: left;\n\n opacity: 0.7;\n\n a,\n a:visited,\n a:hover {\n color: "+t.menu.textColor+" !important;\n border-top: 1px solid "+V(.1,t.menu.backgroundColor)+";\n padding: "+t.spacing.unit+"px 0;\n display: block;\n }\n"})),Oc=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.ref=i.createRef(),t.activate=function(e){t.props.onActivate(t.props.item),e.stopPropagation()},t}return Object(o.__extends)(t,e),t.prototype.componentDidMount=function(){this.scrollIntoViewIfActive()},t.prototype.componentDidUpdate=function(){this.scrollIntoViewIfActive()},t.prototype.scrollIntoViewIfActive=function(){this.props.item.active&&this.ref.current&&this.ref.current.scrollIntoViewIfNeeded()},t.prototype.render=function(){var e=this.props,t=e.item,n=e.withoutChildren;return i.createElement(bc,{onClick:this.activate,depth:t.depth,"data-item-id":t.id},"operation"===t.type?i.createElement(_c,Object(o.__assign)({},this.props,{item:t})):i.createElement(xc,{depth:t.depth,active:t.active,type:t.type,ref:this.ref},i.createElement(kc,{title:t.name},t.name,this.props.children),t.depth>0&&t.items.length>0&&i.createElement(fr,{float:"right",direction:t.expanded?"down":"right"})||null),!n&&t.items&&t.items.length>0&&i.createElement(Sc,{expanded:t.expanded,items:t.items,onActivate:this.props.onActivate}))},t=Object(o.__decorate)([Ta],t)}(i.Component),_c=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.ref=i.createRef(),t}return Object(o.__extends)(t,e),t.prototype.componentDidUpdate=function(){this.props.item.active&&this.ref.current&&this.ref.current.scrollIntoViewIfNeeded()},t.prototype.render=function(){var e,t=this.props.item;return i.createElement(xc,{depth:t.depth,active:t.active,deprecated:t.deprecated,ref:this.ref},i.createElement(ic,{type:t.httpVerb},{delete:"del",options:"opts"}[e=t.httpVerb]||e),i.createElement(kc,{width:"calc(100% - 38px)"},t.name,this.props.children))},t=Object(o.__decorate)([Ta],t)}(i.Component),Sc=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this,t=this.props,n=t.items,r=t.root,a=t.className,s=null==this.props.expanded||this.props.expanded;return i.createElement(vc,Object(o.__assign)({className:a,style:this.props.style,expanded:s},r?{role:"navigation"}:{}),n.map((function(t,n){return i.createElement(Oc,{key:n,item:t,onActivate:e.props.onActivate})})))},t=Object(o.__decorate)([Ta],t)}(i.Component),Tc=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.activate=function(e){if(e&&e.active&&t.context.menuToggle)return e.expanded?e.collapse():e.expand();t.props.menu.activateAndScroll(e,!0),setTimeout((function(){t._updateScroll&&t._updateScroll()}))},t.saveScrollUpdate=function(e){t._updateScroll=e},t}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props.menu;return i.createElement(Vo,{updateFn:this.saveScrollUpdate,className:this.props.className,options:{wheelPropagation:!1}},i.createElement(Sc,{items:e.items,onActivate:this.activate,root:!0}),i.createElement(Ec,null,i.createElement("a",{target:"_blank",href:"https://github.com/Redocly/redoc"},"Documentation Powered by ReDoc")))},t.contextType=Ue,t=Object(o.__decorate)([Ta],t)}(i.Component),jc=function(e){var t=e.open?8:-4;return i.createElement(Ic,null,i.createElement(Cc,{size:15,style:{transform:"translate(2px, "+t+"px) rotate(180deg)",transition:"transform 0.2s ease"}}),i.createElement(Cc,{size:15,style:{transform:"translate(2px, "+(0-t)+"px)",transition:"transform 0.2s ease"}}))},Cc=function(e){var t=e.size,n=void 0===t?10:t,r=e.className,o=void 0===r?"":r,a=e.style;return i.createElement("svg",{className:o,style:a||{},viewBox:"0 0 926.23699 573.74994",version:"1.1",x:"0px",y:"0px",width:n,height:n},i.createElement("g",{transform:"translate(904.92214,-879.1482)"},i.createElement("path",{d:"\n m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,\n -55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,\n 0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,\n -174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,\n -174.68583 0.6895,0 26.281,25.03215 56.8701,\n 55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864\n -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,\n -104.0616 -231.873,-231.248 z\n ",fill:"currentColor"})))},Ic=Te.div(gc||(gc=Object(o.__makeTemplateObject)(["\n user-select: none;\n width: 20px;\n height: 20px;\n align-self: center;\n display: flex;\n flex-direction: column;\n color: ",";\n"],["\n user-select: none;\n width: 20px;\n height: 20px;\n align-self: center;\n display: flex;\n flex-direction: column;\n color: ",";\n"])),(function(e){return e.theme.colors.primary.main}));re&&(yc=n(316));var Ac,Pc,Rc,Nc,Lc,Mc,Dc,Fc,Uc,zc,Bc,$c,qc,Wc,Hc=yc&&yc(),Vc=Te.div(Pc||(Pc=Object(o.__makeTemplateObject)(["\n width: ",";\n background-color: ",";\n overflow: hidden;\n display: flex;\n flex-direction: column;\n\n backface-visibility: hidden;\n /* contain: strict; TODO: breaks layout since Chrome 80*/\n\n height: 100vh;\n position: sticky;\n position: -webkit-sticky;\n top: 0;\n\n ",";\n\n @media print {\n display: none;\n }\n"],["\n width: ",";\n background-color: ",";\n overflow: hidden;\n display: flex;\n flex-direction: column;\n\n backface-visibility: hidden;\n /* contain: strict; TODO: breaks layout since Chrome 80*/\n\n height: 100vh;\n position: sticky;\n position: -webkit-sticky;\n top: 0;\n\n ",";\n\n @media print {\n display: none;\n }\n"])),(function(e){return e.theme.menu.width}),(function(e){return e.theme.menu.backgroundColor}),Se("small")(Ac||(Ac=Object(o.__makeTemplateObject)(["\n position: fixed;\n z-index: 20;\n width: 100%;\n background: ",";\n display: ",";\n "],["\n position: fixed;\n z-index: 20;\n width: 100%;\n background: ",";\n display: ",";\n "])),(function(e){return e.theme.menu.backgroundColor}),(function(e){return e.open?"flex":"none"}))),Yc=Te.div(Nc||(Nc=Object(o.__makeTemplateObject)(["\n outline: none;\n user-select: none;\n background-color: #f2f2f2;\n color: ",";\n display: none;\n cursor: pointer;\n position: fixed;\n right: 20px;\n z-index: 100;\n border-radius: 50%;\n box-shadow: 0 0 20px rgba(0, 0, 0, 0.3);\n ",";\n\n bottom: 44px;\n\n width: 60px;\n height: 60px;\n padding: 0 20px;\n\n @media print {\n display: none;\n }\n"],["\n outline: none;\n user-select: none;\n background-color: #f2f2f2;\n color: ",";\n display: none;\n cursor: pointer;\n position: fixed;\n right: 20px;\n z-index: 100;\n border-radius: 50%;\n box-shadow: 0 0 20px rgba(0, 0, 0, 0.3);\n ",";\n\n bottom: 44px;\n\n width: 60px;\n height: 60px;\n padding: 0 20px;\n\n @media print {\n display: none;\n }\n"])),(function(e){return e.theme.colors.primary.main}),Se("small")(Rc||(Rc=Object(o.__makeTemplateObject)(["\n display: flex;\n "],["\n display: flex;\n "])))),Gc=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.state={offsetTop:"0px"},t.toggleNavMenu=function(){t.props.menu.toggleSidebar()},t}return Object(o.__extends)(t,e),t.prototype.componentDidMount=function(){Hc&&Hc.add(this.stickyElement),this.setState({offsetTop:this.getScrollYOffset(this.context)})},t.prototype.componentWillUnmount=function(){Hc&&Hc.remove(this.stickyElement)},t.prototype.getScrollYOffset=function(e){return(void 0!==this.props.scrollYOffset?be.normalizeScrollYOffset(this.props.scrollYOffset)():e.scrollYOffset())+"px"},t.prototype.render=function(){var e=this,t=this.props.menu.sideBarOpened,n=this.state.offsetTop;return i.createElement(i.Fragment,null,i.createElement(Vc,{open:t,className:this.props.className,style:{top:n,height:"calc(100vh - "+n+")"},ref:function(t){e.stickyElement=t}},this.props.children),i.createElement(Yc,{onClick:this.toggleNavMenu},i.createElement(jc,{open:t})))},t.contextType=Ue,t=Object(o.__decorate)([Ta],t)}(i.Component),Qc=Te.div(Lc||(Lc=Object(o.__makeTemplateObject)(["\n ",";\n"],["\n ",";\n"])),(function(e){var t=e.theme;return"\n font-family: "+t.typography.fontFamily+";\n font-size: "+t.typography.fontSize+";\n font-weight: "+t.typography.fontWeightRegular+";\n line-height: "+t.typography.lineHeight+";\n color: "+t.colors.text.primary+";\n display: flex;\n position: relative;\n text-align: left;\n\n -webkit-font-smoothing: "+t.typography.smoothing+";\n font-smoothing: "+t.typography.smoothing+";\n "+(t.typography.optimizeSpeed?"text-rendering: optimizeSpeed !important":"")+";\n\n tap-highlight-color: rgba(0, 0, 0, 0);\n text-size-adjust: 100%;\n\n * {\n box-sizing: border-box;\n -webkit-tap-highlight-color: rgba(255, 255, 255, 0);\n }\n"})),Xc=Te.div(Dc||(Dc=Object(o.__makeTemplateObject)(["\n z-index: 1;\n position: relative;\n overflow: hidden;\n width: calc(100% - ",");\n ",";\n\n contain: layout;\n"],["\n z-index: 1;\n position: relative;\n overflow: hidden;\n width: calc(100% - ",");\n ",";\n\n contain: layout;\n"])),(function(e){return e.theme.menu.width}),Se("small",!0)(Mc||(Mc=Object(o.__makeTemplateObject)(["\n width: 100%;\n "],["\n width: 100%;\n "])))),Kc=Te.div(Uc||(Uc=Object(o.__makeTemplateObject)(["\n background: ",";\n position: absolute;\n top: 0;\n bottom: 0;\n right: 0;\n width: ",";\n ",";\n"],["\n background: ",";\n position: absolute;\n top: 0;\n bottom: 0;\n right: 0;\n width: ",";\n ",";\n"])),(function(e){return e.theme.rightPanel.backgroundColor}),(function(e){var t=e.theme;if(t.rightPanel.width.endsWith("%")){var n=parseInt(t.rightPanel.width,10);return"calc((100% - "+t.menu.width+") * "+n/100+")"}return t.rightPanel.width}),Se("medium",!0)(Fc||(Fc=Object(o.__makeTemplateObject)(["\n display: none;\n "],["\n display: none;\n "])))),Jc=Te.div(zc||(zc=Object(o.__makeTemplateObject)(["\n padding: 5px 0;\n"],["\n padding: 5px 0;\n"]))),Zc=Te.input.attrs((function(){return{className:"search-input"}}))(Bc||(Bc=Object(o.__makeTemplateObject)(["\n width: calc(100% - ","px);\n box-sizing: border-box;\n margin: 0 ","px;\n padding: 5px ","px 5px\n ","px;\n border: 0;\n border-bottom: 1px solid\n ",";\n font-family: ",";\n font-weight: bold;\n font-size: 13px;\n color: ",";\n background-color: transparent;\n outline: none;\n"],["\n width: calc(100% - ","px);\n box-sizing: border-box;\n margin: 0 ","px;\n padding: 5px ","px 5px\n ","px;\n border: 0;\n border-bottom: 1px solid\n ",";\n font-family: ",";\n font-weight: bold;\n font-size: 13px;\n color: ",";\n background-color: transparent;\n outline: none;\n"])),(function(e){return 8*e.theme.spacing.unit}),(function(e){return 4*e.theme.spacing.unit}),(function(e){return 2*e.theme.spacing.unit}),(function(e){return 4*e.theme.spacing.unit}),(function(e){var t=e.theme;return(Q(t.menu.backgroundColor)>.5?V:K)(.1,t.menu.backgroundColor)}),(function(e){return e.theme.typography.fontFamily}),(function(e){return e.theme.menu.textColor})),eu=Te((function(e){return i.createElement("svg",{className:e.className,version:"1.1",viewBox:"0 0 1000 1000",x:"0px",xmlns:"http://www.w3.org/2000/svg",y:"0px"},i.createElement("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"}))})).attrs({className:"search-icon"})($c||($c=Object(o.__makeTemplateObject)(["\n position: absolute;\n left: ","px;\n height: 1.8em;\n width: 0.9em;\n\n path {\n fill: ",";\n }\n"],["\n position: absolute;\n left: ","px;\n height: 1.8em;\n width: 0.9em;\n\n path {\n fill: ",";\n }\n"])),(function(e){return 4*e.theme.spacing.unit}),(function(e){return e.theme.menu.textColor})),tu=Te.div(qc||(qc=Object(o.__makeTemplateObject)(["\n padding: ","px 0;\n background-color: ","};\n color: ",";\n min-height: 150px;\n max-height: 250px;\n border-top: ","};\n border-bottom: ","};\n margin-top: 10px;\n line-height: 1.4;\n font-size: 0.9em;\n\n "," {\n padding-top: 6px;\n padding-bottom: 6px;\n\n &:hover,\n &.active {\n background-color: ",";\n }\n\n > svg {\n display: none;\n }\n }\n"],["\n padding: ","px 0;\n background-color: ","};\n color: ",";\n min-height: 150px;\n max-height: 250px;\n border-top: ","};\n border-bottom: ","};\n margin-top: 10px;\n line-height: 1.4;\n font-size: 0.9em;\n\n "," {\n padding-top: 6px;\n padding-bottom: 6px;\n\n &:hover,\n &.active {\n background-color: ",";\n }\n\n > svg {\n display: none;\n }\n }\n"])),(function(e){return e.theme.spacing.unit}),(function(e){var t=e.theme;return V(.05,t.menu.backgroundColor)}),(function(e){return e.theme.menu.textColor}),(function(e){var t=e.theme;return V(.1,t.menu.backgroundColor)}),(function(e){var t=e.theme;return V(.1,t.menu.backgroundColor)}),xc,(function(e){var t=e.theme;return V(.1,t.menu.backgroundColor)})),nu=Te.i(Wc||(Wc=Object(o.__makeTemplateObject)(["\n position: absolute;\n display: inline-block;\n width: ","px;\n text-align: center;\n right: ","px;\n line-height: 2em;\n vertical-align: middle;\n margin-right: 2px;\n cursor: pointer;\n font-style: normal;\n color: '#666';\n"],["\n position: absolute;\n display: inline-block;\n width: ","px;\n text-align: center;\n right: ","px;\n line-height: 2em;\n vertical-align: middle;\n margin-right: 2px;\n cursor: pointer;\n font-style: normal;\n color: '#666';\n"])),(function(e){return 2*e.theme.spacing.unit}),(function(e){return 4*e.theme.spacing.unit})),ru=function(e){function t(t){var n=e.call(this,t)||this;return n.activeItemRef=null,n.clear=function(){n.setState({results:[],term:"",activeItemIdx:-1}),n.props.marker.unmark()},n.handleKeyDown=function(e){if(27===e.keyCode&&n.clear(),40===e.keyCode&&(n.setState({activeItemIdx:Math.min(n.state.activeItemIdx+1,n.state.results.length-1)}),e.preventDefault()),38===e.keyCode&&(n.setState({activeItemIdx:Math.max(0,n.state.activeItemIdx-1)}),e.preventDefault()),13===e.keyCode){var t=n.state.results[n.state.activeItemIdx];if(t){var r=n.props.getItemById(t.meta);r&&n.props.onActivate(r)}}},n.search=function(e){var t=e.target.value;t.length<3?n.clearResults(t):(n.setState({term:t}),n.props.search.search(e.target.value).then((function(e){n.setResults(e,t)})))},n.state={results:[],term:"",activeItemIdx:-1},n}return Object(o.__extends)(t,e),t.prototype.clearResults=function(e){this.setState({results:[],term:e}),this.props.marker.unmark()},t.prototype.setResults=function(e,t){this.setState({results:e,term:t}),this.props.marker.mark(t)},t.prototype.render=function(){var e=this,t=this.state.activeItemIdx,n=this.state.results.map((function(t){return{item:e.props.getItemById(t.meta),score:t.score}}));return n.sort((function(e,t){return t.score-e.score})),i.createElement(Jc,{role:"search"},this.state.term&&i.createElement(nu,{onClick:this.clear},"×"),i.createElement(eu,null),i.createElement(Zc,{value:this.state.term,onKeyDown:this.handleKeyDown,placeholder:"Search...",type:"text",onChange:this.search}),n.length>0&&i.createElement(Vo,{options:{wheelPropagation:!1}},i.createElement(tu,{"data-role":"search:results"},n.map((function(n,r){return i.createElement(Oc,{item:Object.create(n.item,{active:{value:r===t}}),onActivate:e.props.onActivate,withoutChildren:!0,key:n.item.id,"data-role":"search:result"})})))))},t}(i.PureComponent),ou=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.componentDidMount=function(){this.props.store.onDidMount()},t.prototype.componentWillUnmount=function(){this.props.store.dispose()},t.prototype.render=function(){var e=this.props.store,t=e.spec,n=e.menu,r=e.options,o=e.search,a=e.marker,s=this.props.store;return i.createElement(_e,{theme:r.theme},i.createElement(Dn,{value:this.props.store},i.createElement(ze,{value:r},i.createElement(Qc,{className:"redoc-wrap"},i.createElement(Gc,{menu:n,className:"menu-content"},i.createElement(ll,{info:t.info}),!r.disableSearch&&i.createElement(ru,{search:o,marker:a,getItemById:n.getItemById,onActivate:n.activateAndScroll})||null,i.createElement(Tc,{menu:n})),i.createElement(Xc,{className:"api-content"},i.createElement(ol,{store:s}),i.createElement(ec,{items:n.items})),i.createElement(Kc,null)))))},t.propTypes={store:l.instanceOf(Ks).isRequired},t}(i.Component),iu=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return Object(o.__extends)(t,e),t.prototype.render=function(){var e=this.props,t=e.spec,n=e.specUrl,r=e.options,o=void 0===r?{}:r,a=e.onLoaded,s=void 0!==o.hideLoading,l=new be(o);return i.createElement(Ne,null,i.createElement(Un,{spec:t,specUrl:n,options:o,onLoaded:a},(function(e){var t=e.loading,n=e.store;return t?s?null:i.createElement(Fe,{color:l.theme.colors.primary.main}):i.createElement(ou,{store:n})})))},t.propTypes={spec:function(e,t,n){return e.spec||e.specUrl?null:new Error("One of props 'spec' or 'specUrl' was not specified in '"+n+"'.")},specUrl:function(e,t,n){return e.spec||e.specUrl?null:new Error("One of props 'spec' or 'specUrl' was not specified in '"+n+"'.")},options:l.any,onLoaded:l.any},t}(i.PureComponent);n.d(t,"version",(function(){return au})),n.d(t,"revision",(function(){return su})),n.d(t,"init",(function(){return cu})),n.d(t,"hydrate",(function(){return uu})),n.d(t,"Redoc",(function(){return ou})),n.d(t,"AppStore",(function(){return Ks}));var au="2.0.0-rc.23",su="88f8d747";function lu(e){var t=function(e){for(var t={},n=e.attributes,r=0;r<n.length;r++){var o=n[r];t[o.name]=o.value}return t}(e),n={};for(var r in t){n[r.replace(/-(.)/g,(function(e,t){return t.toUpperCase()}))]=t[r]}return n}function cu(e,t,n,r){if(void 0===t&&(t={}),void 0===n&&(n=oe("redoc")),null===n)throw new Error('"element" argument is not provided and <redoc> tag is not found on the page');var a,l;"string"==typeof e?a=e:"object"==typeof e&&(l=e),Object(s.render)(i.createElement(iu,{spec:l,onLoaded:r,specUrl:a,options:Object(o.__assign)(Object(o.__assign)({},t),lu(n))},["Loading..."]),n)}function uu(e,t,n){void 0===t&&(t=oe("redoc")),kt();var r=Ks.fromJS(e);Et(),setTimeout((function(){kt(),Object(s.hydrate)(i.createElement(ou,{store:r}),t,n),Et()}),0)}!function(){var e=oe("redoc");if(e){var t=e.getAttribute("spec-url");t&&cu(t,{},e)}}()}])}));
|
||
//# sourceMappingURL=redoc.standalone.js.map</script><style data-styled="bxcHYI jzMYjV YzuTm hZCbNs kKQhLA ibpoCO kzNiFq hclups ghctpd cLEtWf bbViyS bSiQzA iNzLCk lgiBxe gpbcFk fyUykq SmuWE hjRNaf gBhLRG NifDa jjozHG OtKQc cFwMcp nGwee fXybtJ fWqlcz iniCdN dluJDj hiuczA eesUPo cjtbAK kFNigF dTJWQH jIdpVJ flfxUM gDsWLk gtbPCV eKrlKP gEjDMA dzbqSt WxWXp kGvRyb ioYTqA bSFXlp boajtD geWpKA dVvUxe jGRUDj fKHsnH hQBRTt bnFPhO LiUBH eCjbJc bIrgla bcLONg kGwPhO fKyGWc hqYVjx hoUoen jsTAxL iNoDtm edBCth espozG fDvFMp byLrBg hLVzSF evvbxn dtUibw ldTMcP dHLKeu bNYCAJ jBjYbV hOczRB hPskZd iENVAs lkvpfX eftLSo bwgXFh kBWwoV irpqyy ecxnvs dpMbau gzAoUb gwfZGU kZHJcC kwGRVL fCJmC gbTit jCgylq lpeYvY bMfIUD ixmYVs gbsZqp dDdNtD bvBDls cMefLx fLUKgj" data-styled-version="4.4.1">
|
||
/* sc-component-id: sc-bxivhb */
|
||
.cjtbAK{width:calc(100% - 40%);padding:0 40px;} @media print,screen and (max-width:85rem){.cjtbAK{width:100%;padding:40px 40px;}}.kFNigF{width:calc(100% - 40%);padding:0 40px;} @media print,screen and (max-width:85rem){.kFNigF{width:100%;padding:0px 40px;}}
|
||
/* sc-component-id: sc-ifAKCX */
|
||
.dluJDj{padding:40px 0;} .dluJDj:last-child{min-height:calc(100vh + 1px);} .dluJDj > .sc-ifAKCX:last-child{min-height:initial;} @media print,screen and (max-width:85rem){.dluJDj{padding:0;}}.hiuczA{padding:40px 0;position:relative;} .hiuczA:last-child{min-height:calc(100vh + 1px);} .hiuczA > .sc-ifAKCX:last-child{min-height:initial;} @media print,screen and (max-width:85rem){.hiuczA{padding:0;}} .hiuczA: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-component-id: sc-bZQynM */
|
||
.dtUibw{width:40%;color:#ffffff;background-color:#263238;padding:0 40px;background-color:#263238;} @media print,screen and (max-width:85rem){.dtUibw{width:100%;padding:40px 40px;}}
|
||
/* sc-component-id: sc-gzVnrw */
|
||
.eesUPo{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;width:100%;padding:0;} @media print,screen and (max-width:85rem){.eesUPo{-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;}}
|
||
/* sc-component-id: sc-htoDjs */
|
||
.WxWXp{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;}
|
||
/* sc-component-id: sc-dnqmqq */
|
||
.ioYTqA{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:black;}
|
||
/* sc-component-id: sc-gZMcBi */
|
||
.kBWwoV{color:#ffffff;}
|
||
/* sc-component-id: sc-gqjmRU */
|
||
.LiUBH{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-component-id: sc-VigVT */
|
||
.kGvRyb{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;} .kGvRyb: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;} h1:hover > .kGvRyb::before,h2:hover > .kGvRyb::before,.kGvRyb:hover::before{visibility:visible;}
|
||
/* sc-component-id: sc-jTzLTM */
|
||
.hjRNaf{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);}.gBhLRG{height:18px;width:18px;vertical-align:middle;-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);}.NifDa{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);} .NifDa polygon{fill:#00aa13;}.jjozHG{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);} .jjozHG polygon{fill:#e53935;}.OtKQc{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);} .OtKQc polygon{fill:white;}
|
||
/* sc-component-id: sc-chPdSV */
|
||
.bIrgla{border-left:1px solid #a4a4c6;box-sizing:border-box;position:relative;padding:10px 10px 10px 0;vertical-align:top;line-height:20px;white-space:nowrap;font-size:0.929em;font-family:Courier,monospace;} tr:first-of-type > .bIrgla,tr.last > .bIrgla{border-left-width:0;background-position:top left;background-repeat:no-repeat;background-size:1px 100%;} tr:first-of-type > .bIrgla{background-image:linear-gradient( to bottom, transparent 0%, transparent 22px, #a4a4c6 22px, #a4a4c6 100% );} tr.last > .bIrgla{background-image:linear-gradient( to bottom, #a4a4c6 0%, #a4a4c6 22px, transparent 22px, transparent 100% );} tr.last + tr > .bIrgla{border-left-color:transparent;} tr.last:first-child > .bIrgla{background:none;border-left-color:transparent;} .bIrgla.deprecated{-webkit-text-decoration:line-through;text-decoration:line-through;color:#bdccd3;}
|
||
/* sc-component-id: sc-kgoBCf */
|
||
.kGwPhO{border-bottom:1px solid #9fb4be;padding:10px 0;width:75%;box-sizing:border-box;} tr.expanded .kGwPhO{border-bottom:none;}
|
||
/* sc-component-id: sc-kGXeez */
|
||
.bcLONg{color:#a4a4c6;font-family:Courier,monospace;margin-right:10px;} .bcLONg::before{content:'';display:inline-block;vertical-align:middle;width:10px;height:1px;background:#a4a4c6;} .bcLONg::after{content:'';display:inline-block;vertical-align:middle;width:1px;background:#a4a4c6;height:7px;}
|
||
/* sc-component-id: sc-dxgOiQ */
|
||
.eCjbJc{border-collapse:separate;border-radius:3px;font-size:14px;border-spacing:0;width:100%;} .eCjbJc > tr{vertical-align:middle;} .eCjbJc .sc-kpOJdX,.eCjbJc .sc-kpOJdX .sc-kpOJdX .sc-kpOJdX,.eCjbJc .sc-kpOJdX .sc-kpOJdX .sc-kpOJdX .sc-kpOJdX .sc-kpOJdX{margin:1em;margin-right:0;background:#fafafa;} .eCjbJc .sc-kpOJdX .sc-kpOJdX,.eCjbJc .sc-kpOJdX .sc-kpOJdX .sc-kpOJdX .sc-kpOJdX,.eCjbJc .sc-kpOJdX .sc-kpOJdX .sc-kpOJdX .sc-kpOJdX .sc-kpOJdX .sc-kpOJdX{background:#ffffff;}
|
||
/* sc-component-id: sc-hMqMXs */
|
||
.dDdNtD{font-size:0.9em;font-family:Courier,monospace;} .dDdNtD::after{content:' [';}
|
||
/* sc-component-id: sc-kEYyzF */
|
||
.cMefLx{font-size:0.9em;font-family:Courier,monospace;} .cMefLx::after{content:']';}
|
||
/* sc-component-id: sc-hSdWYo */
|
||
.hoUoen{margin-left:10px;text-transform:none;font-size:0.929em;color:black;}
|
||
/* sc-component-id: sc-eHgmQL */
|
||
.irpqyy > ul{list-style:none;padding:0;margin:0;margin:0 -5px;} .irpqyy > 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:#b3b3b3;margin:0 5px 5px 5px;border:1px solid #07090b;border-radius:5px;min-width:60px;font-size:0.9em;font-weight:bold;} .irpqyy > ul > li.react-tabs__tab--selected{color:#333333;background:#ffffff;} .irpqyy > ul > li:only-child{-webkit-flex:none;-ms-flex:none;flex:none;min-width:100px;} .irpqyy > ul > li.tab-success{color:#00aa13;} .irpqyy > ul > li.tab-redirect{color:#ffa500;} .irpqyy > ul > li.tab-info{color:#87ceeb;} .irpqyy > ul > li.tab-error{color:#e53935;} .irpqyy > .react-tabs__tab-panel{background:#11171a;} .irpqyy > .react-tabs__tab-panel > div,.irpqyy > .react-tabs__tab-panel > pre{padding:20px;margin:0;} .irpqyy > .react-tabs__tab-panel > div > pre{padding:0;}
|
||
/* sc-component-id: sc-jWBwVP */
|
||
.jCgylq code[class*='language-'],.jCgylq 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;} @media print{.jCgylq code[class*='language-'],.jCgylq pre[class*='language-']{text-shadow:none;}} .jCgylq pre[class*='language-']{padding:1em;margin:0.5em 0;overflow:auto;} .jCgylq .token.comment,.jCgylq .token.prolog,.jCgylq .token.doctype,.jCgylq .token.cdata{color:hsl(30,20%,50%);} .jCgylq .token.punctuation{opacity:0.7;} .jCgylq .namespace{opacity:0.7;} .jCgylq .token.property,.jCgylq .token.tag,.jCgylq .token.number,.jCgylq .token.constant,.jCgylq .token.symbol{color:#4a8bb3;} .jCgylq .token.boolean{color:firebrick;} .jCgylq .token.selector,.jCgylq .token.attr-name,.jCgylq .token.string,.jCgylq .token.char,.jCgylq .token.builtin,.jCgylq .token.inserted{color:#a0fbaa;} .jCgylq .token.selector + a,.jCgylq .token.attr-name + a,.jCgylq .token.string + a,.jCgylq .token.char + a,.jCgylq .token.builtin + a,.jCgylq .token.inserted + a,.jCgylq .token.selector + a:visited,.jCgylq .token.attr-name + a:visited,.jCgylq .token.string + a:visited,.jCgylq .token.char + a:visited,.jCgylq .token.builtin + a:visited,.jCgylq .token.inserted + a:visited{color:#4ed2ba;-webkit-text-decoration:underline;text-decoration:underline;} .jCgylq .token.operator,.jCgylq .token.entity,.jCgylq .token.url,.jCgylq .token.variable{color:hsl(40,90%,60%);} .jCgylq .token.atrule,.jCgylq .token.attr-value,.jCgylq .token.keyword{color:hsl(350,40%,70%);} .jCgylq .token.regex,.jCgylq .token.important{color:#e90;} .jCgylq .token.important,.jCgylq .token.bold{font-weight:bold;} .jCgylq .token.italic{font-style:italic;} .jCgylq .token.entity{cursor:help;} .jCgylq .token.deleted{color:red;}
|
||
/* sc-component-id: sc-brqgnP */
|
||
.fCJmC{opacity:0.4;-webkit-transition:opacity 0.3s ease;transition:opacity 0.3s ease;text-align:right;} .fCJmC > span{display:inline-block;padding:2px 10px;cursor:pointer;} .fCJmC > span:hover{background:rgba(255,255,255,0.1);}
|
||
/* sc-component-id: sc-cMljjf */
|
||
.ixmYVs:hover .sc-brqgnP{opacity:1;}
|
||
/* sc-component-id: sc-jDwBTQ */
|
||
.gbsZqp{font-family:Courier,monospace;font-size:13px;overflow-x:auto;margin:0;white-space:pre;} .gbsZqp code[class*='language-'],.gbsZqp 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;} @media print{.gbsZqp code[class*='language-'],.gbsZqp pre[class*='language-']{text-shadow:none;}} .gbsZqp pre[class*='language-']{padding:1em;margin:0.5em 0;overflow:auto;} .gbsZqp .token.comment,.gbsZqp .token.prolog,.gbsZqp .token.doctype,.gbsZqp .token.cdata{color:hsl(30,20%,50%);} .gbsZqp .token.punctuation{opacity:0.7;} .gbsZqp .namespace{opacity:0.7;} .gbsZqp .token.property,.gbsZqp .token.tag,.gbsZqp .token.number,.gbsZqp .token.constant,.gbsZqp .token.symbol{color:#4a8bb3;} .gbsZqp .token.boolean{color:firebrick;} .gbsZqp .token.selector,.gbsZqp .token.attr-name,.gbsZqp .token.string,.gbsZqp .token.char,.gbsZqp .token.builtin,.gbsZqp .token.inserted{color:#a0fbaa;} .gbsZqp .token.selector + a,.gbsZqp .token.attr-name + a,.gbsZqp .token.string + a,.gbsZqp .token.char + a,.gbsZqp .token.builtin + a,.gbsZqp .token.inserted + a,.gbsZqp .token.selector + a:visited,.gbsZqp .token.attr-name + a:visited,.gbsZqp .token.string + a:visited,.gbsZqp .token.char + a:visited,.gbsZqp .token.builtin + a:visited,.gbsZqp .token.inserted + a:visited{color:#4ed2ba;-webkit-text-decoration:underline;text-decoration:underline;} .gbsZqp .token.operator,.gbsZqp .token.entity,.gbsZqp .token.url,.gbsZqp .token.variable{color:hsl(40,90%,60%);} .gbsZqp .token.atrule,.gbsZqp .token.attr-value,.gbsZqp .token.keyword{color:hsl(350,40%,70%);} .gbsZqp .token.regex,.gbsZqp .token.important{color:#e90;} .gbsZqp .token.important,.gbsZqp .token.bold{font-weight:bold;} .gbsZqp .token.italic{font-style:italic;} .gbsZqp .token.entity{cursor:help;} .gbsZqp .token.deleted{color:red;}
|
||
/* sc-component-id: sc-global-2362490997 */
|
||
.ps{overflow:hidden !important;overflow-anchor:none;-ms-overflow-style:none;touch-action:auto;-ms-touch-action:auto;} .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;} .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;} .ps--active-x > .ps__rail-x,.ps--active-y > .ps__rail-y{display:block;background-color:transparent;} .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;} .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;} .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;} .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;} .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;} .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;} @supports (-ms-overflow-style:none){.ps{overflow:auto !important;}} @media screen and (-ms-high-contrast:active),(-ms-high-contrast:none){.ps{overflow:auto !important;}}
|
||
/* sc-component-id: sc-gPEVay */
|
||
.hclups{position:relative;}
|
||
/* sc-component-id: sc-iRbamj */
|
||
.flfxUM{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;} .flfxUM code[class*='language-'],.flfxUM 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;} @media print{.flfxUM code[class*='language-'],.flfxUM pre[class*='language-']{text-shadow:none;}} .flfxUM pre[class*='language-']{padding:1em;margin:0.5em 0;overflow:auto;} .flfxUM .token.comment,.flfxUM .token.prolog,.flfxUM .token.doctype,.flfxUM .token.cdata{color:hsl(30,20%,50%);} .flfxUM .token.punctuation{opacity:0.7;} .flfxUM .namespace{opacity:0.7;} .flfxUM .token.property,.flfxUM .token.tag,.flfxUM .token.number,.flfxUM .token.constant,.flfxUM .token.symbol{color:#4a8bb3;} .flfxUM .token.boolean{color:firebrick;} .flfxUM .token.selector,.flfxUM .token.attr-name,.flfxUM .token.string,.flfxUM .token.char,.flfxUM .token.builtin,.flfxUM .token.inserted{color:#a0fbaa;} .flfxUM .token.selector + a,.flfxUM .token.attr-name + a,.flfxUM .token.string + a,.flfxUM .token.char + a,.flfxUM .token.builtin + a,.flfxUM .token.inserted + a,.flfxUM .token.selector + a:visited,.flfxUM .token.attr-name + a:visited,.flfxUM .token.string + a:visited,.flfxUM .token.char + a:visited,.flfxUM .token.builtin + a:visited,.flfxUM .token.inserted + a:visited{color:#4ed2ba;-webkit-text-decoration:underline;text-decoration:underline;} .flfxUM .token.operator,.flfxUM .token.entity,.flfxUM .token.url,.flfxUM .token.variable{color:hsl(40,90%,60%);} .flfxUM .token.atrule,.flfxUM .token.attr-value,.flfxUM .token.keyword{color:hsl(350,40%,70%);} .flfxUM .token.regex,.flfxUM .token.important{color:#e90;} .flfxUM .token.important,.flfxUM .token.bold{font-weight:bold;} .flfxUM .token.italic{font-style:italic;} .flfxUM .token.entity{cursor:help;} .flfxUM .token.deleted{color:red;} .flfxUM p:last-child{margin-bottom:0;} .flfxUM h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;} .flfxUM h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;} .flfxUM 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;} .flfxUM pre{font-family:Courier,monospace;white-space:pre;background-color:#263238;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0px;border:1px solid rgba(38,50,56,0.1);} .flfxUM pre code{background-color:transparent;color:white;padding:0;} .flfxUM pre code:before,.flfxUM pre code:after{content:none;} .flfxUM blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;} .flfxUM img{max-width:100%;box-sizing:content-box;} .flfxUM ul,.flfxUM ol{padding-left:2em;margin:0;margin-bottom:1em;} .flfxUM ul ul,.flfxUM ol ul,.flfxUM ul ol,.flfxUM ol ol{margin-bottom:0;margin-top:0;} .flfxUM 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;} .flfxUM table tr{background-color:#fff;border-top:1px solid #ccc;} .flfxUM table tr:nth-child(2n){background-color:#fafafa;} .flfxUM table th,.flfxUM table td{padding:6px 13px;border:1px solid #ddd;} .flfxUM table th{text-align:left;font-weight:bold;} .flfxUM .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;} .flfxUM .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;} .flfxUM h1:hover > .share-link::before,.flfxUM h2:hover > .share-link::before,.flfxUM .share-link:hover::before{visibility:visible;} .flfxUM a{-webkit-text-decoration:none;text-decoration:none;color:#32329f;} .flfxUM a:visited{color:#32329f;} .flfxUM a:hover{color:#6868cf;}.gDsWLk{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;} .gDsWLk code[class*='language-'],.gDsWLk 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;} @media print{.gDsWLk code[class*='language-'],.gDsWLk pre[class*='language-']{text-shadow:none;}} .gDsWLk pre[class*='language-']{padding:1em;margin:0.5em 0;overflow:auto;} .gDsWLk .token.comment,.gDsWLk .token.prolog,.gDsWLk .token.doctype,.gDsWLk .token.cdata{color:hsl(30,20%,50%);} .gDsWLk .token.punctuation{opacity:0.7;} .gDsWLk .namespace{opacity:0.7;} .gDsWLk .token.property,.gDsWLk .token.tag,.gDsWLk .token.number,.gDsWLk .token.constant,.gDsWLk .token.symbol{color:#4a8bb3;} .gDsWLk .token.boolean{color:firebrick;} .gDsWLk .token.selector,.gDsWLk .token.attr-name,.gDsWLk .token.string,.gDsWLk .token.char,.gDsWLk .token.builtin,.gDsWLk .token.inserted{color:#a0fbaa;} .gDsWLk .token.selector + a,.gDsWLk .token.attr-name + a,.gDsWLk .token.string + a,.gDsWLk .token.char + a,.gDsWLk .token.builtin + a,.gDsWLk .token.inserted + a,.gDsWLk .token.selector + a:visited,.gDsWLk .token.attr-name + a:visited,.gDsWLk .token.string + a:visited,.gDsWLk .token.char + a:visited,.gDsWLk .token.builtin + a:visited,.gDsWLk .token.inserted + a:visited{color:#4ed2ba;-webkit-text-decoration:underline;text-decoration:underline;} .gDsWLk .token.operator,.gDsWLk .token.entity,.gDsWLk .token.url,.gDsWLk .token.variable{color:hsl(40,90%,60%);} .gDsWLk .token.atrule,.gDsWLk .token.attr-value,.gDsWLk .token.keyword{color:hsl(350,40%,70%);} .gDsWLk .token.regex,.gDsWLk .token.important{color:#e90;} .gDsWLk .token.important,.gDsWLk .token.bold{font-weight:bold;} .gDsWLk .token.italic{font-style:italic;} .gDsWLk .token.entity{cursor:help;} .gDsWLk .token.deleted{color:red;} .gDsWLk p:last-child{margin-bottom:0;} .gDsWLk p:first-child{margin-top:0;} .gDsWLk p:last-child{margin-bottom:0;} .gDsWLk h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;} .gDsWLk h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;} .gDsWLk 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;} .gDsWLk pre{font-family:Courier,monospace;white-space:pre;background-color:#263238;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0px;border:1px solid rgba(38,50,56,0.1);} .gDsWLk pre code{background-color:transparent;color:white;padding:0;} .gDsWLk pre code:before,.gDsWLk pre code:after{content:none;} .gDsWLk blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;} .gDsWLk img{max-width:100%;box-sizing:content-box;} .gDsWLk ul,.gDsWLk ol{padding-left:2em;margin:0;margin-bottom:1em;} .gDsWLk ul ul,.gDsWLk ol ul,.gDsWLk ul ol,.gDsWLk ol ol{margin-bottom:0;margin-top:0;} .gDsWLk 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;} .gDsWLk table tr{background-color:#fff;border-top:1px solid #ccc;} .gDsWLk table tr:nth-child(2n){background-color:#fafafa;} .gDsWLk table th,.gDsWLk table td{padding:6px 13px;border:1px solid #ddd;} .gDsWLk table th{text-align:left;font-weight:bold;} .gDsWLk .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;} .gDsWLk .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;} .gDsWLk h1:hover > .share-link::before,.gDsWLk h2:hover > .share-link::before,.gDsWLk .share-link:hover::before{visibility:visible;} .gDsWLk a{-webkit-text-decoration:none;text-decoration:none;color:#32329f;} .gDsWLk a:visited{color:#32329f;} .gDsWLk a:hover{color:#6868cf;}
|
||
/* sc-component-id: sc-jlyJG */
|
||
.evvbxn{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;} .evvbxn p:last-child{margin-bottom:0;} .evvbxn p:first-child{margin-top:0;} .evvbxn p:last-child{margin-bottom:0;} .evvbxn p{display:inline-block;} .evvbxn h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;} .evvbxn h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;} .evvbxn 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;} .evvbxn pre{font-family:Courier,monospace;white-space:pre;background-color:#263238;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0px;border:1px solid rgba(38,50,56,0.1);} .evvbxn pre code{background-color:transparent;color:white;padding:0;} .evvbxn pre code:before,.evvbxn pre code:after{content:none;} .evvbxn blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;} .evvbxn img{max-width:100%;box-sizing:content-box;} .evvbxn ul,.evvbxn ol{padding-left:2em;margin:0;margin-bottom:1em;} .evvbxn ul ul,.evvbxn ol ul,.evvbxn ul ol,.evvbxn ol ol{margin-bottom:0;margin-top:0;} .evvbxn 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;} .evvbxn table tr{background-color:#fff;border-top:1px solid #ccc;} .evvbxn table tr:nth-child(2n){background-color:#fafafa;} .evvbxn table th,.evvbxn table td{padding:6px 13px;border:1px solid #ddd;} .evvbxn table th{text-align:left;font-weight:bold;} .evvbxn .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;} .evvbxn .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;} .evvbxn h1:hover > .share-link::before,.evvbxn h2:hover > .share-link::before,.evvbxn .share-link:hover::before{visibility:visible;} .evvbxn a{-webkit-text-decoration:none;text-decoration:none;color:#32329f;} .evvbxn a:visited{color:#32329f;} .evvbxn a:hover{color:#6868cf;}
|
||
/* sc-component-id: sc-gipzik */
|
||
.gbTit{position:relative;}
|
||
/* sc-component-id: sc-jhAzac */
|
||
.kwGRVL:hover > .sc-brqgnP{opacity:1;}
|
||
/* sc-component-id: sc-fBuWsC */
|
||
.kZHJcC{font-family:Courier,monospace;font-size:13px;white-space:pre;contain:content;overflow-x:auto;} .kZHJcC .redoc-json > .collapser{display:none;} .kZHJcC .callback-function{color:gray;} .kZHJcC .collapser:after{content:'-';cursor:pointer;} .kZHJcC .collapsed > .collapser:after{content:'+';cursor:pointer;} .kZHJcC .ellipsis:after{content:' … ';} .kZHJcC .collapsible{margin-left:2em;} .kZHJcC .hoverable{padding-top:1px;padding-bottom:1px;padding-left:2px;padding-right:2px;border-radius:2px;} .kZHJcC .hovered{background-color:rgba(235,238,249,1);} .kZHJcC .collapser{padding-right:6px;padding-left:6px;} .kZHJcC ul{list-style-type:none;padding:0px;margin:0px 0px 0px 26px;} .kZHJcC li{position:relative;display:block;} .kZHJcC .hoverable{display:inline-block;} .kZHJcC .selected{outline-style:solid;outline-width:1px;outline-style:dotted;} .kZHJcC .collapsed > .collapsible{display:none;} .kZHJcC .ellipsis{display:none;} .kZHJcC .collapsed > .ellipsis{display:inherit;} .kZHJcC .collapser{position:absolute;top:1px;left:-1.5em;cursor:default;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-user-select:none;}
|
||
/* sc-component-id: sc-fMiknA */
|
||
.gzAoUb{padding:12px;background-color:rgba(38,50,56,0.4);margin:0 0 10px 0;display:block;}
|
||
/* sc-component-id: sc-dVhcbM */
|
||
.dpMbau{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.4);}
|
||
/* sc-component-id: sc-eqIVtm */
|
||
.ecxnvs{position:relative;}
|
||
/* sc-component-id: sc-gisBJw */
|
||
.gwfZGU{margin-top:15px;}
|
||
/* sc-component-id: sc-kjoXOD */
|
||
.iNoDtm{border-left:1px solid #a4a4c6;box-sizing:border-box;position:relative;padding:10px 10px 10px 0;vertical-align:top;line-height:20px;white-space:nowrap;font-size:0.929em;font-family:Courier,monospace;cursor:pointer;} tr:first-of-type > .iNoDtm,tr.last > .iNoDtm{border-left-width:0;background-position:top left;background-repeat:no-repeat;background-size:1px 100%;} tr:first-of-type > .iNoDtm{background-image:linear-gradient( to bottom, transparent 0%, transparent 22px, #a4a4c6 22px, #a4a4c6 100% );} tr.last > .iNoDtm{background-image:linear-gradient( to bottom, #a4a4c6 0%, #a4a4c6 22px, transparent 22px, transparent 100% );} tr.last + tr > .iNoDtm{border-left-color:transparent;} tr.last:first-child > .iNoDtm{background:none;border-left-color:transparent;} .iNoDtm.deprecated{-webkit-text-decoration:line-through;text-decoration:line-through;color:#bdccd3;} .iNoDtm .sc-jTzLTM{height:1.1em;width:1.1em;} .iNoDtm .sc-jTzLTM polygon{fill:#808080;}
|
||
/* sc-component-id: sc-cHGsZl */
|
||
.lpeYvY{vertical-align:middle;font-size:13px;line-height:20px;}
|
||
/* sc-component-id: sc-TOsTZ */
|
||
.fKyGWc{vertical-align:middle;font-size:13px;line-height:20px;color:rgba(128,128,128,0.8);}
|
||
/* sc-component-id: sc-kgAjT */
|
||
.hqYVjx{vertical-align:middle;font-size:13px;line-height:20px;color:#808080;}
|
||
/* sc-component-id: sc-cJSrbW */
|
||
.edBCth{vertical-align:middle;font-size:13px;line-height:20px;color:#808080;word-break:break-word;}
|
||
/* sc-component-id: sc-hmzhuo */
|
||
.jsTAxL{vertical-align:middle;font-size:13px;line-height:20px;color:#e53935;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}
|
||
/* sc-component-id: sc-jbKcbu */
|
||
.bMfIUD{vertical-align:middle;font-size:13px;line-height:20px;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;} .bMfIUD + .sc-jbKcbu{margin-left:0;}
|
||
/* sc-component-id: sc-uJMKN */
|
||
.dzbqSt{margin:1em 0;} .dzbqSt a{-webkit-text-decoration:none;text-decoration:none;color:#32329f;} .dzbqSt a:visited{color:#32329f;} .dzbqSt a:hover{color:#6868cf;}
|
||
/* sc-component-id: sc-gGBfsJ */
|
||
.bvBDls{padding-left:10px;}
|
||
/* sc-component-id: sc-fYxtnH */
|
||
.dTJWQH{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;margin-bottom:0.5em;}
|
||
/* sc-component-id: sc-tilXH */
|
||
.jIdpVJ{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-component-id: sc-hEsumM */
|
||
.gEjDMA::before{content:'|';display:inline-block;opacity:0.5;width:15px;text-align:center;} .gEjDMA:last-child::after{display:none;}
|
||
/* sc-component-id: sc-ktHwxA */
|
||
.gtbPCV{overflow:hidden;}
|
||
/* sc-component-id: sc-cIShpX */
|
||
.eKrlKP{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-component-id: sc-kafWEX */
|
||
.hZCbNs{max-height:260px;max-width:260px;padding:2px;width:100%;display:block;}
|
||
/* sc-component-id: sc-feJyhm */
|
||
.YzuTm{text-align:center;}
|
||
/* sc-component-id: sc-jwKygS */
|
||
.bnFPhO:after{content:' AND ';font-weight:bold;} .bnFPhO:last-child:after{content:none;} .bnFPhO a{-webkit-text-decoration:none;text-decoration:none;color:#32329f;} .bnFPhO a:visited{color:#32329f;} .bnFPhO a:hover{color:#6868cf;}
|
||
/* sc-component-id: sc-btzYZH */
|
||
.hQBRTt:before{content:'( ';font-weight:bold;} .hQBRTt:after{content:' ) OR ';font-weight:bold;} .hQBRTt:last-child:after{content:' )';} .hQBRTt:only-child:before,.hQBRTt:only-child:after{content:none;} .hQBRTt a{-webkit-text-decoration:none;text-decoration:none;color:#32329f;} .hQBRTt a:visited{color:#32329f;} .hQBRTt a:hover{color:#6868cf;}
|
||
/* sc-component-id: sc-lhVmIH */
|
||
.dVvUxe{-webkit-flex:1;-ms-flex:1;flex:1;}
|
||
/* sc-component-id: sc-bYSBpT */
|
||
.fKHsnH{width:75%;}
|
||
/* sc-component-id: sc-elJkPf */
|
||
.jGRUDj{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;display:inline-block;margin:0;}
|
||
/* sc-component-id: sc-jtRfpW */
|
||
.geWpKA{width:100%;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;margin:1em 0;}
|
||
/* sc-component-id: sc-kTUwUJ */
|
||
.ldTMcP{cursor:pointer;position:relative;margin-bottom:5px;}
|
||
/* sc-component-id: sc-dqBHgY */
|
||
.iENVAs{font-family:Courier,monospace;margin-left:10px;-webkit-flex:1;-ms-flex:1;flex:1;overflow-x:hidden;text-overflow:ellipsis;}
|
||
/* sc-component-id: sc-gxMtzJ */
|
||
.dHLKeu{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;} .dHLKeu ..sc-dqBHgY{color:#ffffff;}
|
||
/* sc-component-id: sc-dfVpRl */
|
||
.bNYCAJ{font-size:0.929em;line-height:20px;background-color:#248fb2;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}.jBjYbV{font-size:0.929em;line-height:20px;background-color:#6bbd5b;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}.hOczRB{font-size:0.929em;line-height:20px;background-color:#9b708b;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}.hPskZd{font-size:0.929em;line-height:20px;background-color:#e27a7a;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}
|
||
/* sc-component-id: sc-gzOgki */
|
||
.lkvpfX{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;-webkit-transform:translateY(-50%) scaleY(0);-ms-transform:translateY(-50%) scaleY(0);transform:translateY(-50%) scaleY(0);}
|
||
/* sc-component-id: sc-iyvyFf */
|
||
.eftLSo{padding:10px;}
|
||
/* sc-component-id: sc-hwwEjo */
|
||
.bwgXFh{padding:5px;border:1px solid #ccc;background:#fff;word-break:break-all;color:#32329f;} .bwgXFh > span{color:#333333;}
|
||
/* sc-component-id: sc-kPVwWT */
|
||
.fDvFMp{padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;background-color:#f2f2f2;cursor:pointer;color:#00aa13;background-color:rgba(0,170,19,0.1);}.byLrBg{padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;background-color:#f2f2f2;cursor:pointer;color:#e53935;background-color:rgba(229,57,53,0.1);}.hLVzSF{padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;background-color:#f2f2f2;cursor:pointer;color:#00aa13;background-color:rgba(0,170,19,0.1);cursor:default;} .hLVzSF::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;}
|
||
/* sc-component-id: sc-eXEjpC */
|
||
.espozG{font-size:18px;padding:0.2em 0;margin:3em 0 1.1em;color:#253137;font-weight:normal;}
|
||
/* sc-component-id: sc-ibxdXY */
|
||
.bSFXlp{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;width:100%;padding:0;-webkit-backface-visibility:hidden;backface-visibility:hidden;contain:content;overflow:hidden;} @media print,screen and (max-width:85rem){.bSFXlp{-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;}}
|
||
/* sc-component-id: sc-RefOD */
|
||
.boajtD{margin-bottom:30px;}
|
||
/* sc-component-id: sc-iQKALj */
|
||
.cFwMcp{width:32px;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;color:white;text-transform:uppercase;text-align:center;font-weight:bold;vertical-align:middle;margin-right:6px;margin-top:2px;} .cFwMcp.get{background-color:#6bbd5b;} .cFwMcp.post{background-color:#248fb2;} .cFwMcp.put{background-color:#9b708b;} .cFwMcp.options{background-color:#d3ca12;} .cFwMcp.patch{background-color:#e09d43;} .cFwMcp.delete{background-color:#e27a7a;} .cFwMcp.basic{background-color:#999;} .cFwMcp.link{background-color:#31bbb6;} .cFwMcp.head{background-color:#c167e4;}
|
||
/* sc-component-id: sc-bwCtUz */
|
||
.ghctpd{margin:0;padding:0;} .ghctpd .sc-bwCtUz{font-size:0.929em;}.cLEtWf{margin:0;padding:0;display:none;} .cLEtWf .sc-bwCtUz{font-size:0.929em;}
|
||
/* sc-component-id: sc-hrWEMg */
|
||
.bbViyS{list-style:none inside none;overflow:hidden;text-overflow:ellipsis;padding:0;}.bSiQzA{list-style:none inside none;overflow:hidden;text-overflow:ellipsis;padding:0;margin-top:15px;}
|
||
/* sc-component-id: sc-eTuwsz */
|
||
.iNzLCk{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;} .iNzLCk:hover{color:#32329f;} .iNzLCk:hover{background-color:#ededed;} .iNzLCk .sc-jTzLTM{height:1.5em;width:1.5em;} .iNzLCk .sc-jTzLTM polygon{fill:#333333;}.lgiBxe{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;opacity:0.7;text-transform:uppercase;font-size:0.8em;padding-bottom:0;cursor:default;color:#333333;} .lgiBxe .sc-jTzLTM{height:1.5em;width:1.5em;} .lgiBxe .sc-jTzLTM polygon{fill:#333333;}.gpbcFk{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;} .gpbcFk:hover{background-color:#e1e1e1;} .gpbcFk .sc-jTzLTM{height:1.5em;width:1.5em;} .gpbcFk .sc-jTzLTM polygon{fill:#333333;}
|
||
/* sc-component-id: sc-gwVKww */
|
||
.fyUykq{display:inline-block;vertical-align:middle;width:auto;overflow:hidden;text-overflow:ellipsis;}.SmuWE{display:inline-block;vertical-align:middle;width:calc(100% - 38px);overflow:hidden;text-overflow:ellipsis;}
|
||
/* sc-component-id: sc-hXRMBi */
|
||
.nGwee{font-size:0.8em;margin-top:10px;padding:0 20px;text-align:left;opacity:0.7;} .nGwee a,.nGwee a:visited,.nGwee a:hover{color:#333333 !important;border-top:1px solid #e1e1e1;padding:5px 0;display:block;}
|
||
/* sc-component-id: sc-epnACN */
|
||
.fWqlcz{-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-component-id: sc-iQNlJl */
|
||
.jzMYjV{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;} @media screen and (max-width:50rem){.jzMYjV{position:fixed;z-index:20;width:100%;background:#fafafa;display:none;}} @media print{.jzMYjV{display:none;}}
|
||
/* sc-component-id: sc-bsbRJL */
|
||
.fXybtJ{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;} @media screen and (max-width:50rem){.fXybtJ{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;}} @media print{.fXybtJ{display:none;}}
|
||
/* sc-component-id: sc-hZSUBg */
|
||
.bxcHYI{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%;} .bxcHYI *{box-sizing:border-box;-webkit-tap-highlight-color:rgba(255,255,255,0);}
|
||
/* sc-component-id: sc-cMhqgX */
|
||
.iniCdN{z-index:1;position:relative;overflow:hidden;width:calc(100% - 260px);contain:layout;} @media print,screen and (max-width:50rem){.iniCdN{width:100%;}}
|
||
/* sc-component-id: sc-iuJeZd */
|
||
.fLUKgj{background:#263238;position:absolute;top:0;bottom:0;right:0;width:calc((100% - 260px) * 0.4);} @media print,screen and (max-width:85rem){.fLUKgj{display:none;}}
|
||
/* sc-component-id: sc-esOvli */
|
||
.kKQhLA{padding:5px 0;}
|
||
/* sc-component-id: sc-cmthru */
|
||
.kzNiFq{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-component-id: sc-hMFtBS */
|
||
.ibpoCO{position:absolute;left:20px;height:1.8em;width:0.9em;} .ibpoCO path{fill:#333333;}</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-hZSUBg bxcHYI redoc-wrap"><div class="sc-iQNlJl jzMYjV menu-content" style="top:0px;height:calc(100vh - 0px)"><div style="background-color:#FFFFFF" class="sc-feJyhm YzuTm"><img src="https://www.mattermost.org/wp-content/uploads/2016/03/logoHorizontal_WS.png" alt="logo" class="sc-kafWEX hZCbNs"/></div><div role="search" class="sc-esOvli kKQhLA"><svg class="sc-hMFtBS ibpoCO 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..." class="sc-cmthru kzNiFq search-input"/></div><div class="sc-gPEVay hclups scrollbar-container undefined"><ul class="sc-bwCtUz ghctpd" role="navigation"><li data-item-id="section/Authentication" class="sc-hrWEMg bbViyS"><label type="section" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="Authentication" class="sc-gwVKww fyUykq">Authentication</span></label></li><li data-item-id="group/Overview" class="sc-hrWEMg bSiQzA"><label type="group" role="menuitem" class="sc-eTuwsz lgiBxe -depth0"><span title="Overview" class="sc-gwVKww fyUykq">Overview</span></label><ul class="sc-bwCtUz ghctpd"><li data-item-id="tag/introduction" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="introduction" class="sc-gwVKww fyUykq">introduction</span></label></li><li data-item-id="tag/schema" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="schema" class="sc-gwVKww fyUykq">schema</span></label></li><li data-item-id="tag/APIv3-Deprecation" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="APIv3 Deprecation" class="sc-gwVKww fyUykq">APIv3 Deprecation</span></label></li></ul></li><li data-item-id="group/Standard-Features" class="sc-hrWEMg bSiQzA"><label type="group" role="menuitem" class="sc-eTuwsz lgiBxe -depth0"><span title="Standard Features" class="sc-gwVKww fyUykq">Standard Features</span></label><ul class="sc-bwCtUz ghctpd"><li data-item-id="tag/drivers" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="drivers" class="sc-gwVKww fyUykq">drivers</span></label></li><li data-item-id="tag/authentication" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="authentication" class="sc-gwVKww fyUykq">authentication</span></label></li><li data-item-id="tag/errors" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="errors" class="sc-gwVKww fyUykq">errors</span></label></li><li data-item-id="tag/rate-limiting" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="rate limiting" class="sc-gwVKww fyUykq">rate limiting</span></label></li><li data-item-id="tag/WebSocket" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="WebSocket" class="sc-gwVKww fyUykq">WebSocket</span></label></li></ul></li><li data-item-id="group/Endpoints" class="sc-hrWEMg bSiQzA"><label type="group" role="menuitem" class="sc-eTuwsz lgiBxe -depth0"><span title="Endpoints" class="sc-gwVKww fyUykq">Endpoints</span></label><ul class="sc-bwCtUz ghctpd"><li data-item-id="tag/users" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="users" class="sc-gwVKww fyUykq">users</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/users/paths/~1users/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create a user</span></label></li><li data-item-id="tag/users/paths/~1users/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get users</span></label></li><li data-item-id="tag/users/paths/~1users~1ids/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get users by ids</span></label></li><li data-item-id="tag/users/paths/~1users~1group_channels/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get users by group channels ids</span></label></li><li data-item-id="tag/users/paths/~1users~1usernames/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get users by usernames</span></label></li><li data-item-id="tag/users/paths/~1users~1search/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Search users</span></label></li><li data-item-id="tag/users/paths/~1users~1autocomplete/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Autocomplete users</span></label></li><li data-item-id="tag/users/paths/~1users~1stats/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get total count of users in the system</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a user</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update a user</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Deactivate a user account.</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1patch/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Patch a user</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1roles/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update a user's roles</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1active/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update user active status</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1image/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get user's profile image</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1image/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Set user's profile image</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1image/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Delete user's profile image</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1image~1default/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Return user's default (generated) profile image</span></label></li><li data-item-id="tag/users/paths/~1users~1username~1{username}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a user by username</span></label></li><li data-item-id="tag/users/paths/~1users~1password~1reset/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Reset password</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1mfa/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update a user's MFA</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1mfa~1generate/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Generate MFA secret</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1demote/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Demote a user to a guest</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1promote/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Promote a guest to user</span></label></li><li data-item-id="tag/users/paths/~1users~1mfa/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Check MFA</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1password/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update a user's password</span></label></li><li data-item-id="tag/users/paths/~1users~1password~1reset~1send/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Send password reset email</span></label></li><li data-item-id="tag/users/paths/~1users~1email~1{email}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a user by email</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1sessions/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get user's sessions</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1sessions~1revoke/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Revoke a user session</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1sessions~1revoke~1all/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Revoke all active sessions for a user</span></label></li><li data-item-id="tag/users/paths/~1users~1sessions~1device/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Attach mobile device</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1audits/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get user's audits</span></label></li><li data-item-id="tag/users/paths/~1users~1email~1verify/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Verify user email</span></label></li><li data-item-id="tag/users/paths/~1users~1email~1verify~1send/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Send verification email</span></label></li><li data-item-id="tag/users/paths/~1users~1login~1switch/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Switch login method</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1tokens/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create a user access token</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1tokens/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get user access tokens</span></label></li><li data-item-id="tag/users/paths/~1users~1tokens/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get user access tokens</span></label></li><li data-item-id="tag/users/paths/~1users~1tokens~1revoke/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Revoke a user access token</span></label></li><li data-item-id="tag/users/paths/~1users~1tokens~1{token_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a user access token</span></label></li><li data-item-id="tag/users/paths/~1users~1tokens~1disable/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Disable personal access token</span></label></li><li data-item-id="tag/users/paths/~1users~1tokens~1enable/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Enable personal access token</span></label></li><li data-item-id="tag/users/paths/~1users~1tokens~1search/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Search tokens</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1auth/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update a user's authentication method</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1terms_of_service/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Records user action when they accept or decline custom terms of service</span></label></li><li data-item-id="tag/users/paths/~1users~1{user_id}~1terms_of_service/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Fetches user's latest terms of service action if the latest action was for acceptance.</span></label></li><li data-item-id="tag/users/paths/~1users~1sessions~1revoke~1all/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Revoke all sessions from all users.</span></label></li></ul></li><li data-item-id="tag/bots" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="bots" class="sc-gwVKww fyUykq">bots</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/bots/paths/~1bots/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create a bot</span></label></li><li data-item-id="tag/bots/paths/~1bots/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get bots</span></label></li><li data-item-id="tag/bots/paths/~1bots~1{bot_user_id}/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Patch a bot</span></label></li><li data-item-id="tag/bots/paths/~1bots~1{bot_user_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a bot</span></label></li><li data-item-id="tag/bots/paths/~1bots~1{bot_user_id}~1disable/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Disable a bot</span></label></li><li data-item-id="tag/bots/paths/~1bots~1{bot_user_id}~1enable/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Enable a bot</span></label></li><li data-item-id="tag/bots/paths/~1bots~1{bot_user_id}~1assign~1{user_id}/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Assign a bot to a user</span></label></li><li data-item-id="tag/bots/paths/~1bots~1{bot_user_id}~1icon/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get bot's LHS icon</span></label></li><li data-item-id="tag/bots/paths/~1bots~1{bot_user_id}~1icon/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Set bot's LHS icon image</span></label></li><li data-item-id="tag/bots/paths/~1bots~1{bot_user_id}~1icon/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Delete bot's LHS icon image</span></label></li></ul></li><li data-item-id="tag/teams" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="teams" class="sc-gwVKww fyUykq">teams</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/teams/paths/~1teams/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create a team</span></label></li><li data-item-id="tag/teams/paths/~1teams/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get teams</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a team</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update a team</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Delete a team</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1patch/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Patch a team</span></label></li><li data-item-id="tag/teams/paths/~1teams~1name~1{name}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a team by name</span></label></li><li data-item-id="tag/teams/paths/~1teams~1search/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Search teams</span></label></li><li data-item-id="tag/teams/paths/~1teams~1name~1{name}~1exists/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Check if team exists</span></label></li><li data-item-id="tag/teams/paths/~1users~1{user_id}~1teams/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a user's teams</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1members/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get team members</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1members/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Add user to team</span></label></li><li data-item-id="tag/teams/paths/~1teams~1members~1invite/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Add user to team from invite</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1members~1batch/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Add multiple users to team</span></label></li><li data-item-id="tag/teams/paths/~1users~1{user_id}~1teams~1members/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get team members for a user</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a team member</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Remove user from team</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1members~1ids/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get team members by ids</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1stats/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a team stats</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1regenerate_invite_id/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Regenerate the Invite ID from a Team</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1image/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get the team icon</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1image/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Sets the team icon</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1image/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Remove the team icon</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}~1roles/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update a team member roles</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}~1schemeRoles/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update the scheme-derived roles of a team member.</span></label></li><li data-item-id="tag/teams/paths/~1users~1{user_id}~1teams~1unread/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get team unreads for a user</span></label></li><li data-item-id="tag/teams/paths/~1users~1{user_id}~1teams~1{team_id}~1unread/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get unreads for a team</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1invite~1email/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Invite users to the team by email</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1invite-guests~1email/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Invite guests to the team by email</span></label></li><li data-item-id="tag/teams/paths/~1teams~1invites~1email/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Invalidate active email invitations</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1import/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Import a Team from other application</span></label></li><li data-item-id="tag/teams/paths/~1teams~1invite~1{invite_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get invite info for a team</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1scheme/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Set a team's scheme</span></label></li><li data-item-id="tag/teams/paths/~1teams~1{team_id}~1members_minus_group_members/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Team members minus group members.</span></label></li></ul></li><li data-item-id="tag/channels" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="channels" class="sc-gwVKww fyUykq">channels</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/channels/paths/~1channels/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create a channel</span></label></li><li data-item-id="tag/channels/paths/~1channels~1direct/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create a direct message channel</span></label></li><li data-item-id="tag/channels/paths/~1channels~1group/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create a group message channel</span></label></li><li data-item-id="tag/channels/paths/~1channels~1search/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Search all private and open type channels across all teams</span></label></li><li data-item-id="tag/channels/paths/~1group~1search/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Search Group Channels</span></label></li><li data-item-id="tag/channels/paths/~1teams~1{team_id}~1channels~1ids/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a list of channels by ids</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1timezones/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get timezones in a channel</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a channel</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update a channel</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Delete a channel</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1patch/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Patch a channel</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1privacy/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update channel's privacy</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1convert/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Convert a channel from public to private</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1restore/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Restore a channel</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1stats/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get channel statistics</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1pinned/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a channel's pinned posts</span></label></li><li data-item-id="tag/channels/paths/~1teams~1{team_id}~1channels/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get public channels</span></label></li><li data-item-id="tag/channels/paths/~1teams~1{team_id}~1channels~1deleted/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get deleted channels</span></label></li><li data-item-id="tag/channels/paths/~1teams~1{team_id}~1channels~1autocomplete/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Autocomplete channels</span></label></li><li data-item-id="tag/channels/paths/~1teams~1{team_id}~1channels~1search_autocomplete/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Autocomplete channels for search</span></label></li><li data-item-id="tag/channels/paths/~1teams~1{team_id}~1channels~1search/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Search channels</span></label></li><li data-item-id="tag/channels/paths/~1teams~1{team_id}~1channels~1search_archived/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Search archived channels</span></label></li><li data-item-id="tag/channels/paths/~1teams~1{team_id}~1channels~1name~1{channel_name}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a channel by name</span></label></li><li data-item-id="tag/channels/paths/~1teams~1name~1{team_name}~1channels~1name~1{channel_name}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a channel by name and team name</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1members/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get channel members</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1members/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Add user to channel</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1members~1ids/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get channel members by ids</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get channel member</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Remove user from channel</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}~1roles/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update channel roles</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}~1schemeRoles/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update the scheme-derived roles of a channel member.</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}~1notify_props/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update channel notifications</span></label></li><li data-item-id="tag/channels/paths/~1channels~1members~1{user_id}~1view/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">View channel</span></label></li><li data-item-id="tag/channels/paths/~1users~1{user_id}~1teams~1{team_id}~1channels~1members/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get channel memberships and roles for a user</span></label></li><li data-item-id="tag/channels/paths/~1users~1{user_id}~1teams~1{team_id}~1channels/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get channels for user</span></label></li><li data-item-id="tag/channels/paths/~1users~1{user_id}~1channels~1{channel_id}~1unread/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get unread messages</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1scheme/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Set a channel's scheme</span></label></li><li data-item-id="tag/channels/paths/~1channels~1{channel_id}~1members_minus_group_members/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Channel members minus group members.</span></label></li></ul></li><li data-item-id="tag/posts" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="posts" class="sc-gwVKww fyUykq">posts</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/posts/paths/~1posts/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create a post</span></label></li><li data-item-id="tag/posts/paths/~1posts~1ephemeral/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create a ephemeral post</span></label></li><li data-item-id="tag/posts/paths/~1posts~1{post_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a post</span></label></li><li data-item-id="tag/posts/paths/~1posts~1{post_id}/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Delete a post</span></label></li><li data-item-id="tag/posts/paths/~1posts~1{post_id}/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update a post</span></label></li><li data-item-id="tag/posts/paths/~1user~1{user_id}~1posts~1{post_id}~1set_unread/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Mark as unread from a post.</span></label></li><li data-item-id="tag/posts/paths/~1posts~1{post_id}~1patch/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Patch a post</span></label></li><li data-item-id="tag/posts/paths/~1posts~1{post_id}~1thread/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a thread</span></label></li><li data-item-id="tag/posts/paths/~1users~1{user_id}~1posts~1flagged/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a list of flagged posts</span></label></li><li data-item-id="tag/posts/paths/~1posts~1{post_id}~1files~1info/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get file info for post</span></label></li><li data-item-id="tag/posts/paths/~1channels~1{channel_id}~1posts/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get posts for a channel</span></label></li><li data-item-id="tag/posts/paths/~1users~1{user_id}~1channels~1{channel_id}~1posts~1unread/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get posts around last unread</span></label></li><li data-item-id="tag/posts/paths/~1teams~1{team_id}~1posts~1search/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Search for team posts</span></label></li><li data-item-id="tag/posts/paths/~1posts~1{post_id}~1pin/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Pin a post to the channel</span></label></li><li data-item-id="tag/posts/paths/~1posts~1{post_id}~1unpin/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Unpin a post to the channel</span></label></li><li data-item-id="tag/posts/paths/~1posts~1{post_id}~1actions~1{action_id}/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Perform a post action</span></label></li></ul></li><li data-item-id="tag/files" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="files" class="sc-gwVKww fyUykq">files</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/files/paths/~1files/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Upload a file</span></label></li><li data-item-id="tag/files/paths/~1files~1{file_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a file</span></label></li><li data-item-id="tag/files/paths/~1files~1{file_id}~1thumbnail/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a file's thumbnail</span></label></li><li data-item-id="tag/files/paths/~1files~1{file_id}~1preview/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a file's preview</span></label></li><li data-item-id="tag/files/paths/~1files~1{file_id}~1link/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a public file link</span></label></li><li data-item-id="tag/files/paths/~1files~1{file_id}~1info/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get metadata for a file</span></label></li></ul></li><li data-item-id="tag/preferences" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="preferences" class="sc-gwVKww fyUykq">preferences</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/preferences/paths/~1users~1{user_id}~1preferences/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get the user's preferences</span></label></li><li data-item-id="tag/preferences/paths/~1users~1{user_id}~1preferences/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Save the user's preferences</span></label></li><li data-item-id="tag/preferences/paths/~1users~1{user_id}~1preferences~1delete/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Delete user's preferences</span></label></li><li data-item-id="tag/preferences/paths/~1users~1{user_id}~1preferences~1{category}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">List a user's preferences by category</span></label></li><li data-item-id="tag/preferences/paths/~1users~1{user_id}~1preferences~1{category}~1name~1{preference_name}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a specific user preference</span></label></li></ul></li><li data-item-id="tag/status" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="status" class="sc-gwVKww fyUykq">status</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/status/paths/~1users~1{user_id}~1status/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get user status</span></label></li><li data-item-id="tag/status/paths/~1users~1{user_id}~1status/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update user status</span></label></li><li data-item-id="tag/status/paths/~1users~1status~1ids/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get user statuses by id</span></label></li></ul></li><li data-item-id="tag/emoji" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="emoji" class="sc-gwVKww fyUykq">emoji</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/emoji/paths/~1emoji/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create a custom emoji</span></label></li><li data-item-id="tag/emoji/paths/~1emoji/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a list of custom emoji</span></label></li><li data-item-id="tag/emoji/paths/~1emoji~1{emoji_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a custom emoji</span></label></li><li data-item-id="tag/emoji/paths/~1emoji~1{emoji_id}/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Delete a custom emoji</span></label></li><li data-item-id="tag/emoji/paths/~1emoji~1name~1{emoji_name}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a custom emoji by name</span></label></li><li data-item-id="tag/emoji/paths/~1emoji~1{emoji_id}~1image/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get custom emoji image</span></label></li><li data-item-id="tag/emoji/paths/~1emoji~1search/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Search custom emoji</span></label></li><li data-item-id="tag/emoji/paths/~1emoji~1autocomplete/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Autocomplete custom emoji</span></label></li></ul></li><li data-item-id="tag/reactions" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="reactions" class="sc-gwVKww fyUykq">reactions</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/reactions/paths/~1reactions/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create a reaction</span></label></li><li data-item-id="tag/reactions/paths/~1posts~1{post_id}~1reactions/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a list of reactions to a post</span></label></li><li data-item-id="tag/reactions/paths/~1users~1{user_id}~1posts~1{post_id}~1reactions~1{emoji_name}/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Remove a reaction from a post</span></label></li><li data-item-id="tag/reactions/paths/~1posts~1ids~1reactions/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Bulk get the reaction for posts</span></label></li></ul></li><li data-item-id="tag/webhooks" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="webhooks" class="sc-gwVKww fyUykq">webhooks</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/webhooks/paths/~1hooks~1incoming/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create an incoming webhook</span></label></li><li data-item-id="tag/webhooks/paths/~1hooks~1incoming/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">List incoming webhooks</span></label></li><li data-item-id="tag/webhooks/paths/~1hooks~1incoming~1{hook_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get an incoming webhook</span></label></li><li data-item-id="tag/webhooks/paths/~1hooks~1incoming~1{hook_id}/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update an incoming webhook</span></label></li><li data-item-id="tag/webhooks/paths/~1hooks~1outgoing/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create an outgoing webhook</span></label></li><li data-item-id="tag/webhooks/paths/~1hooks~1outgoing/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">List outgoing webhooks</span></label></li><li data-item-id="tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get an outgoing webhook</span></label></li><li data-item-id="tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Delete an outgoing webhook</span></label></li><li data-item-id="tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update an outgoing webhook</span></label></li><li data-item-id="tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}~1regen_token/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Regenerate the token for the outgoing webhook.</span></label></li></ul></li><li data-item-id="tag/commands" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="commands" class="sc-gwVKww fyUykq">commands</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/commands/paths/~1commands/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create a command</span></label></li><li data-item-id="tag/commands/paths/~1commands/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">List commands for a team</span></label></li><li data-item-id="tag/commands/paths/~1teams~1{team_id}~1commands~1autocomplete/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">List autocomplete commands</span></label></li><li data-item-id="tag/commands/paths/~1commands~1{command_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a command</span></label></li><li data-item-id="tag/commands/paths/~1commands~1{command_id}/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update a command</span></label></li><li data-item-id="tag/commands/paths/~1commands~1{command_id}/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Delete a command</span></label></li><li data-item-id="tag/commands/paths/~1commands~1{command_id}~1move/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Move a command</span></label></li><li data-item-id="tag/commands/paths/~1commands~1{command_id}~1regen_token/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Generate a new token</span></label></li><li data-item-id="tag/commands/paths/~1commands~1execute/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Execute a command</span></label></li></ul></li><li data-item-id="tag/OpenGraph" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="OpenGraph" class="sc-gwVKww fyUykq">OpenGraph</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/OpenGraph/paths/~1opengraph/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get open graph metadata for url</span></label></li></ul></li><li data-item-id="tag/system" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="system" class="sc-gwVKww fyUykq">system</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/system/paths/~1system~1ping/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Check system health</span></label></li><li data-item-id="tag/system/paths/~1database~1recycle/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Recycle database connections</span></label></li><li data-item-id="tag/system/paths/~1email~1test/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Send a test email</span></label></li><li data-item-id="tag/system/paths/~1site_url~1test/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Checks the validity of a Site URL</span></label></li><li data-item-id="tag/system/paths/~1file~1s3_test/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Test AWS S3 connection</span></label></li><li data-item-id="tag/system/paths/~1config/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get configuration</span></label></li><li data-item-id="tag/system/paths/~1config/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update configuration</span></label></li><li data-item-id="tag/system/paths/~1config~1reload/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Reload configuration</span></label></li><li data-item-id="tag/system/paths/~1config~1client/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get client configuration</span></label></li><li data-item-id="tag/system/paths/~1config~1environment/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get configuration made through environment variables</span></label></li><li data-item-id="tag/system/paths/~1config~1patch/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Patch configuration</span></label></li><li data-item-id="tag/system/paths/~1license/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Upload license file</span></label></li><li data-item-id="tag/system/paths/~1license/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Remove license file</span></label></li><li data-item-id="tag/system/paths/~1license~1client/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get client license</span></label></li><li data-item-id="tag/system/paths/~1audits/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get audits</span></label></li><li data-item-id="tag/system/paths/~1caches~1invalidate/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Invalidate all the caches</span></label></li><li data-item-id="tag/system/paths/~1logs/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get logs</span></label></li><li data-item-id="tag/system/paths/~1logs/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Add log message</span></label></li><li data-item-id="tag/system/paths/~1analytics~1old/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get analytics</span></label></li><li data-item-id="tag/system/paths/~1server_busy/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Set the server busy (high load) flag</span></label></li><li data-item-id="tag/system/paths/~1server_busy/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get server busy expiry time.</span></label></li><li data-item-id="tag/system/paths/~1server_busy/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Clears the server busy (high load) flag</span></label></li></ul></li><li data-item-id="tag/brand" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="brand" class="sc-gwVKww fyUykq">brand</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/brand/paths/~1brand~1image/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get brand image</span></label></li><li data-item-id="tag/brand/paths/~1brand~1image/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Upload brand image</span></label></li><li data-item-id="tag/brand/paths/~1brand~1image/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Delete current brand image</span></label></li></ul></li><li data-item-id="tag/OAuth" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="OAuth" class="sc-gwVKww fyUykq">OAuth</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/OAuth/paths/~1oauth~1apps/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Register OAuth app</span></label></li><li data-item-id="tag/OAuth/paths/~1oauth~1apps/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get OAuth apps</span></label></li><li data-item-id="tag/OAuth/paths/~1oauth~1apps~1{app_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get an OAuth app</span></label></li><li data-item-id="tag/OAuth/paths/~1oauth~1apps~1{app_id}/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Update an OAuth app</span></label></li><li data-item-id="tag/OAuth/paths/~1oauth~1apps~1{app_id}/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Delete an OAuth app</span></label></li><li data-item-id="tag/OAuth/paths/~1oauth~1apps~1{app_id}~1regen_secret/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Regenerate OAuth app secret</span></label></li><li data-item-id="tag/OAuth/paths/~1oauth~1apps~1{app_id}~1info/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get info on an OAuth app</span></label></li><li data-item-id="tag/OAuth/paths/~1users~1{user_id}~1oauth~1apps~1authorized/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get authorized OAuth apps</span></label></li></ul></li><li data-item-id="tag/SAML" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="SAML" class="sc-gwVKww fyUykq">SAML</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/SAML/paths/~1saml~1metadata/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get metadata</span></label></li><li data-item-id="tag/SAML/paths/~1saml~1certificate~1idp/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Upload IDP certificate</span></label></li><li data-item-id="tag/SAML/paths/~1saml~1certificate~1idp/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Remove IDP certificate</span></label></li><li data-item-id="tag/SAML/paths/~1saml~1certificate~1public/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Upload public certificate</span></label></li><li data-item-id="tag/SAML/paths/~1saml~1certificate~1public/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Remove public certificate</span></label></li><li data-item-id="tag/SAML/paths/~1saml~1certificate~1private/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Upload private key</span></label></li><li data-item-id="tag/SAML/paths/~1saml~1certificate~1private/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Remove private key</span></label></li><li data-item-id="tag/SAML/paths/~1saml~1certificate~1status/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get certificate status</span></label></li></ul></li><li data-item-id="tag/LDAP" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="LDAP" class="sc-gwVKww fyUykq">LDAP</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/LDAP/paths/~1ldap~1sync/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Sync with LDAP</span></label></li><li data-item-id="tag/LDAP/paths/~1ldap~1test/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Test LDAP configuration</span></label></li></ul></li><li data-item-id="tag/groups" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="groups" class="sc-gwVKww fyUykq">groups</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/groups/paths/~1groups/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get groups</span></label></li><li data-item-id="tag/groups/paths/~1groups~1{group_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a group</span></label></li><li data-item-id="tag/groups/paths/~1groups~1{group_id}~1patch/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Patch a group</span></label></li><li data-item-id="tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}~1link/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Link a team to a group</span></label></li><li data-item-id="tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}~1link/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Delete a link from a team to a group</span></label></li><li data-item-id="tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}~1link/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Link a channel to a group</span></label></li><li data-item-id="tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}~1link/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Delete a link from a channel to a group</span></label></li><li data-item-id="tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get GroupSyncable from Team ID</span></label></li><li data-item-id="tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get GroupSyncable from channel ID</span></label></li><li data-item-id="tag/groups/paths/~1groups~1{group_id}~1teams/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get group teams</span></label></li><li data-item-id="tag/groups/paths/~1groups~1{group_id}~1channels/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get group channels</span></label></li><li data-item-id="tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}~1patch/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Patch a GroupSyncable associated to Team</span></label></li><li data-item-id="tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}~1patch/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Patch a GroupSyncable associated to Channel</span></label></li><li data-item-id="tag/groups/paths/~1groups~1{group_id}~1members/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get group users</span></label></li><li data-item-id="tag/groups/paths/~1channels~1{channel_id}~1groups/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get channel groups</span></label></li><li data-item-id="tag/groups/paths/~1teams~1{team_id}~1groups/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get team groups</span></label></li></ul></li><li data-item-id="tag/compliance" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="compliance" class="sc-gwVKww fyUykq">compliance</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/compliance/paths/~1compliance~1reports/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create report</span></label></li><li data-item-id="tag/compliance/paths/~1compliance~1reports/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get reports</span></label></li><li data-item-id="tag/compliance/paths/~1compliance~1reports~1{report_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a report</span></label></li><li data-item-id="tag/compliance/paths/~1compliance~1reports~1{report_id}~1download/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Download a report</span></label></li></ul></li><li data-item-id="tag/cluster" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="cluster" class="sc-gwVKww fyUykq">cluster</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/cluster/paths/~1cluster~1status/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get cluster status</span></label></li></ul></li><li data-item-id="tag/elasticsearch" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="elasticsearch" class="sc-gwVKww fyUykq">elasticsearch</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/elasticsearch/paths/~1elasticsearch~1test/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Test Elasticsearch configuration</span></label></li><li data-item-id="tag/elasticsearch/paths/~1elasticsearch~1purge_indexes/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Purge all Elasticsearch indexes</span></label></li></ul></li><li data-item-id="tag/dataretention" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="dataretention" class="sc-gwVKww fyUykq">dataretention</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/dataretention/paths/~1data_retention~1policy/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get the data retention policy details.</span></label></li></ul></li><li data-item-id="tag/jobs" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="jobs" class="sc-gwVKww fyUykq">jobs</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/jobs/paths/~1jobs/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get the jobs.</span></label></li><li data-item-id="tag/jobs/paths/~1jobs/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create a new job.</span></label></li><li data-item-id="tag/jobs/paths/~1jobs~1{job_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a job.</span></label></li><li data-item-id="tag/jobs/paths/~1jobs~1{job_id}~1cancel/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Cancel a job.</span></label></li><li data-item-id="tag/jobs/paths/~1jobs~1type~1{type}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get the jobs of the given type.</span></label></li></ul></li><li data-item-id="tag/plugins" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="plugins" class="sc-gwVKww fyUykq">plugins</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/plugins/paths/~1plugins/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Upload plugin</span></label></li><li data-item-id="tag/plugins/paths/~1plugins/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get plugins</span></label></li><li data-item-id="tag/plugins/paths/~1plugins~1install_from_url/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Install plugin from url</span></label></li><li data-item-id="tag/plugins/paths/~1plugins~1{plugin_id}/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Remove plugin</span></label></li><li data-item-id="tag/plugins/paths/~1plugins~1{plugin_id}~1enable/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Enable plugin</span></label></li><li data-item-id="tag/plugins/paths/~1plugins~1{plugin_id}~1disable/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Disable plugin</span></label></li><li data-item-id="tag/plugins/paths/~1plugins~1webapp/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get webapp plugins</span></label></li><li data-item-id="tag/plugins/paths/~1plugins~1marketplace/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Installs a marketplace plugin</span></label></li><li data-item-id="tag/plugins/paths/~1plugins~1marketplace/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Gets all the marketplace plugins</span></label></li></ul></li><li data-item-id="tag/roles" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="roles" class="sc-gwVKww fyUykq">roles</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/roles/paths/~1roles~1{role_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a role</span></label></li><li data-item-id="tag/roles/paths/~1roles~1name~1{role_name}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a role</span></label></li><li data-item-id="tag/roles/paths/~1roles~1{role_id}~1patch/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Patch a role</span></label></li><li data-item-id="tag/roles/paths/~1roles~1names/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a list of roles by name</span></label></li></ul></li><li data-item-id="tag/schemes" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="schemes" class="sc-gwVKww fyUykq">schemes</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/schemes/paths/~1schemes/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get the schemes.</span></label></li><li data-item-id="tag/schemes/paths/~1schemes/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Create a scheme</span></label></li><li data-item-id="tag/schemes/paths/~1schemes~1{scheme_id}/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a scheme</span></label></li><li data-item-id="tag/schemes/paths/~1schemes~1{scheme_id}/delete" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="delete" class="sc-iQKALj cFwMcp operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Delete a scheme</span></label></li><li data-item-id="tag/schemes/paths/~1schemes~1{scheme_id}~1patch/put" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="put" class="sc-iQKALj cFwMcp operation-type put">put</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Patch a scheme</span></label></li><li data-item-id="tag/schemes/paths/~1schemes~1{scheme_id}~1teams/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a page of teams which use this scheme.</span></label></li><li data-item-id="tag/schemes/paths/~1schemes~1{scheme_id}~1channels/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Get a page of channels which use this scheme.</span></label></li></ul></li><li data-item-id="tag/integration_actions" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="integration_actions" class="sc-gwVKww fyUykq">integration_actions</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/integration_actions/paths/~1actions~1dialogs~1open/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Open a dialog</span></label></li><li data-item-id="tag/integration_actions/paths/~1actions~1dialogs~1submit/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Submit a dialog</span></label></li></ul></li><li data-item-id="tag/terms-of-service" class="sc-hrWEMg bbViyS"><label type="tag" role="menuitem" class="sc-eTuwsz iNzLCk -depth1"><span title="terms of service" class="sc-gwVKww fyUykq">terms of service</span><svg class="sc-jTzLTM hjRNaf" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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-bwCtUz cLEtWf"><li data-item-id="tag/terms-of-service/paths/~1users~1{user_id}~1terms_of_service/post" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="post" class="sc-iQKALj cFwMcp operation-type post">post</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Records user action when they accept or decline custom terms of service</span></label></li><li data-item-id="tag/terms-of-service/paths/~1users~1{user_id}~1terms_of_service/get" class="sc-hrWEMg bbViyS"><label role="menuitem" class="sc-eTuwsz gpbcFk -depth2"><span type="get" class="sc-iQKALj cFwMcp operation-type get">get</span><span width="calc(100% - 38px)" class="sc-gwVKww SmuWE">Fetches user's latest terms of service action if the latest action was for acceptance.</span></label></li></ul></li></ul></li></ul><div class="sc-hXRMBi nGwee"><a target="_blank" href="https://github.com/Redocly/redoc">Documentation Powered by ReDoc</a></div></div></div><div class="sc-bsbRJL fXybtJ"><div class="sc-epnACN fWqlcz"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);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><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-cMhqgX iniCdN api-content"><div class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK api-info"><h1 class="sc-htoDjs sc-fYxtnH dTJWQH">Mattermost API Reference<!-- --> <span>(<!-- -->4.0.0<!-- -->)</span></h1><p>Download OpenAPI specification:<a download="swagger.json" target="_blank" class="sc-tilXH jIdpVJ">Download</a></p><div class="sc-jWBwVP sc-iRbamj flfxUM"><div class="sc-ktHwxA gtbPCV"><div class="sc-cIShpX eKrlKP"><span class="sc-hEsumM gEjDMA">E-mail<!-- -->:<!-- --> <a href="mailto:feedback@mattermost.com">feedback@mattermost.com</a></span> <!-- --> <!-- --> <span class="sc-hEsumM gEjDMA"><a href="https://about.mattermost.com/default-terms/">Terms of Service</a></span></div></div></div><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>There is also a work-in-progress <a href="https://documenter.getpostman.com/view/4508214/RW8FERUn">Postman API reference</a>.</p>
|
||
</div><div class="sc-uJMKN dzbqSt"><a href="https://mattermost.com">Mattermost</a> is an open source platform for secure collaboration across the entire software development lifecycle. This is the reference documentation for the Mattermost REST API.</div></div></div></div><div id="section/Authentication" data-section-id="section/Authentication" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#section/Authentication"></a>Authentication</h1></div></div><div id="section/Authentication/bearerAuth" data-section-id="section/Authentication/bearerAuth" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#section/Authentication/bearerAuth"></a>bearerAuth</h2><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><div class="sc-jWBwVP sc-iRbamj flfxUM"><table class="security-details"><tbody><tr><th> Security Scheme Type </th><td> <!-- -->HTTP<!-- --> </td></tr><tr><th> HTTP Authorization Scheme </th><td> <!-- -->bearer<!-- --> </td></tr><tr><th> Bearer format </th><td> "<!-- -->Token<!-- -->" </td></tr></tbody></table></div></div></div></div></div><div id="tag/introduction" data-section-id="tag/introduction" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/introduction"></a>introduction</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>The Mattermost Web Services API is used by Mattermost clients and third party applications to interact with the server. <a href="/#tag/drivers">JavaScript and Golang drivers for</a> connecting to the APIs are also available.</p>
|
||
<h3 id="support">Support</h3>
|
||
<p>Mattermost core committers work with the community to keep the API documentation up-to-date.</p>
|
||
<p>If you have questions on API routes not listed in this reference, please <a href="https://pre-release.mattermost.com/signup_user_complete/?id=f1924a8db44ff3bb41c96424cdc20676">join the Mattermost community server</a> to ask questions in the Developers channel, <a href="http://forum.mattermost.org/c/dev">or post questions to our Developer Discussion forum</a>.</p>
|
||
<p><a href="https://github.com/mattermost/mattermost-api-reference/issues">Bug reports</a> in the documentation or the API are also welcome, as are pull requests to fix the issues.</p>
|
||
<h3 id="contributing">Contributing</h3>
|
||
<p>When you have answers to API questions not addressed in our documentation we ask you to consider making a pull request to improve our reference. <a href="https://github.com/mattermost/mattermost-api-reference/commit/d574c0c1e95dc2228dc96663afd562f1305e3ece">Small changes</a> and <a href="https://github.com/mattermost/mattermost-api-reference/commit/1ae3314f0935eebba8c885d8969dcad72f801501">larger changes</a> are all welcome.</p>
|
||
<p>We also have <a href="https://github.com/mattermost/mattermost-api-reference/issues">Help Wanted tickets</a> available for community members who would like to help others more easily use the APIs. We acknowledge everyone's contribution in the <a href="https://docs.mattermost.com/administration/changelog.html#contributors">release notes of our next version</a>.</p>
|
||
<p>The source code for this API reference is hosted at <a href="https://github.com/mattermost/mattermost-api-reference">https://github.com/mattermost/mattermost-api-reference</a>.</p>
|
||
</div></div></div><div id="tag/schema" data-section-id="tag/schema" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/schema"></a>schema</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>All API access is through HTTP(S) requests at <code>your-mattermost-url.com/api/v4</code>. All request and response bodies are <code>application/json</code>.</p>
|
||
<p>When using endpoints that require a user id, the string <code>me</code> can be used in place of the user id to indicate the action is to be taken for the logged in user.</p>
|
||
</div></div></div><div id="tag/APIv3-Deprecation" data-section-id="tag/APIv3-Deprecation" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/APIv3-Deprecation"></a>APIv3 Deprecation</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Since Mattermost 4.6 released on January 16, 2018, API v3 has no longer been supported and it will be removed in Mattermost Server v5.0 on June 16, 2018. Follow these simple steps to migrate your integrations and apps to API v4. Otherwise your integrations may break once you upgrade to Mattermost 5.0</p>
|
||
<ol>
|
||
<li>Set your server's log level to <code>DEBUG</code> in <strong>System Console > General > Logging > File Log Level</strong> to print detailed logs for API requests.</li>
|
||
<li>In <strong>System Console > Logs</strong>, search for requests hitting <code>/api/v3/</code> endpoints. Any requests hitting these endpoints are from integrations that should be migrated to API v4.<ul>
|
||
<li>For in-house or self-built integrations, update them to use v4 with the help of <a href="https://api.mattermost.com">this API reference</a>. Most v3 endpoints have direct counterparts in v4 and should be migrated easily.</li>
|
||
<li>For third-party integrations, visit their homepage (on GitHub, GitLab, etc.). Check if they already have a version that uses the Mattermost v4 API. If they do not, consider opening an issue asking them if support is planned.</li>
|
||
</ul>
|
||
</li>
|
||
<li>Once all integrations have been migrated to API v4, review the server logs with log level set to <code>DEBUG</code>. Confirm no requests hit <code>/api/v3/</code> endpoints.</li>
|
||
<li>Set <strong>Allow use of API v3 endpoints</strong> to <code>false</code> in <strong>System Console > General > Configuration</strong>, or set <code>EnableAPIv3</code> to <code>false</code> in <code>config.json</code>. This setting disables API v3 on your server. Any time a v3 endpoint is used, an error is logged in <strong>System Console > Logs</strong>.</li>
|
||
<li>Set your server's log level back to <code>ERROR</code>. Use the error logs to help track down any remaining uses of API v3.</li>
|
||
</ol>
|
||
<p>Below are the major changes made between v3 and v4:</p>
|
||
<ol>
|
||
<li>Endpoint URLs only require team IDs when necessary. For example, getting a channel by ID no longer requires a team ID in v4.</li>
|
||
<li>Collection endpoints now generally return lists and include paging as part of the query string.</li>
|
||
<li>User ID is now included in most user endpoints. This allows admins to modify other users through v4 endpoints.</li>
|
||
</ol>
|
||
<p>If you have any questions about the API v3 deprecation, or about migrating from v3 to v4, <a href="https://pre-release.mattermost.com/signup_user_complete/?id=f1924a8db44ff3bb41c96424cdc20676">join our daily build server at pre-release.mattermost.com</a> and ask questions in the <a href="https://pre-release.mattermost.com/core/channels/apiv4">APIv4 channel</a>.</p>
|
||
</div></div></div><div id="tag/drivers" data-section-id="tag/drivers" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/drivers"></a>drivers</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>The easiest way to interact with the Mattermost Web Service API is through a language specific driver.</p>
|
||
<h4 id="official-drivers">Official Drivers</h4>
|
||
<ul>
|
||
<li><a href="https://github.com/mattermost/mattermost-redux/blob/master/src/client/client4.ts">Mattermost JavaScript Driver</a></li>
|
||
<li><a href="https://github.com/mattermost/mattermost-server/blob/master/model/client4.go">Mattermost Golang Driver</a></li>
|
||
</ul>
|
||
<h4 id="community-built-drivers">Community-built Drivers</h4>
|
||
<ul>
|
||
<li><a href="https://github.com/gnello/php-mattermost-driver">PHP Driver</a> - built by <a href="https://github.com/gnello">@gnello</a> and <a href="https://github.com/prixone">@prixone</a></li>
|
||
<li><a href="https://github.com/Vaelor/python-mattermost-driver">Python Driver</a> - built by <a href="https://github.com/Vaelor">@Vaelor</a></li>
|
||
</ul>
|
||
<p>For other community-built drivers and API wrappers, see <a href="https://about.mattermost.com/community-applications/#privateApps">our app directory</a>.</p>
|
||
</div></div></div><div id="tag/authentication" data-section-id="tag/authentication" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/authentication"></a>authentication</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>There are multiple ways to authenticate against the Mattermost API.</p>
|
||
<p>All examples assume there is a Mattermost instance running at <a href="http://localhost:8065">http://localhost:8065</a>.</p>
|
||
<h4 id="session-token">Session Token</h4>
|
||
<p>Make an HTTP POST to <code>your-mattermost-url.com/api/v4/users/login</code> with a JSON body indicating the user’s <code>login_id</code>, <code>password</code> and optionally the MFA <code>token</code>. The <code>login_id</code> can be an email, username or an AD/LDAP ID depending on the system's configuration.</p>
|
||
<pre><code>curl <span class="token operator">-</span>i <span class="token operator">-</span>d <span class="token string">'{"login_id":"someone@nowhere.com","password":"thisisabadpassword"}'</span> http<span class="token punctuation">:</span><span class="token operator">/</span><span class="token operator">/</span>localhost<span class="token punctuation">:</span><span class="token number">8065</span><span class="token operator">/</span>api<span class="token operator">/</span>v4<span class="token operator">/</span>users<span class="token operator">/</span>login</code></pre><p>NOTE: If you're running cURL on windows, you will have to change the single quotes to double quotes, and escape the inner double quotes with backslash, like below:</p>
|
||
<pre><code>curl <span class="token operator">-</span>i <span class="token operator">-</span>d <span class="token string">"{\"login_id\":\"someone@nowhere.com\",\"password\":\"thisisabadpassword\"}"</span> http<span class="token punctuation">:</span><span class="token operator">/</span><span class="token operator">/</span>localhost<span class="token punctuation">:</span><span class="token number">8065</span><span class="token operator">/</span>api<span class="token operator">/</span>v4<span class="token operator">/</span>users<span class="token operator">/</span>login</code></pre><p>If successful, the response will contain a <code>Token</code> header and a user object in the body.</p>
|
||
<pre><code>HTTP<span class="token operator">/</span><span class="token number">1.1</span> <span class="token number">200</span> OK
|
||
Set<span class="token operator">-</span>Cookie<span class="token punctuation">:</span> MMSID<span class="token operator">=</span>hyr5dmb1mbb49c44qmx4whniso<span class="token punctuation">;</span> Path<span class="token operator">=</span><span class="token operator">/</span><span class="token punctuation">;</span> Max<span class="token operator">-</span>Age<span class="token operator">=</span><span class="token number">2592000</span><span class="token punctuation">;</span> HttpOnly
|
||
Token<span class="token punctuation">:</span> hyr5dmb1mbb49c44qmx4whniso
|
||
X<span class="token operator">-</span>Ratelimit<span class="token operator">-</span>Limit<span class="token punctuation">:</span> <span class="token number">10</span>
|
||
X<span class="token operator">-</span>Ratelimit<span class="token operator">-</span>Remaining<span class="token punctuation">:</span> <span class="token number">9</span>
|
||
X<span class="token operator">-</span>Ratelimit<span class="token operator">-</span>Reset<span class="token punctuation">:</span> <span class="token number">1</span>
|
||
X<span class="token operator">-</span>Request<span class="token operator">-</span>Id<span class="token punctuation">:</span> smda55ckcfy89b6tia58shk5fh
|
||
X<span class="token operator">-</span>Version<span class="token operator">-</span>Id<span class="token punctuation">:</span> developer
|
||
Date<span class="token punctuation">:</span> Fri<span class="token punctuation">,</span> <span class="token number">11</span> Sep <span class="token number">2015</span> <span class="token number">13</span><span class="token punctuation">:</span><span class="token number">21</span><span class="token punctuation">:</span><span class="token number">14</span> GMT
|
||
Content<span class="token operator">-</span>Length<span class="token punctuation">:</span> <span class="token number">657</span>
|
||
Content<span class="token operator">-</span>Type<span class="token punctuation">:</span> application<span class="token operator">/</span>json<span class="token punctuation">;</span> charset<span class="token operator">=</span>utf<span class="token operator">-</span><span class="token number">8</span>
|
||
|
||
<span class="token punctuation">{</span><span class="token punctuation">{</span>user object as json<span class="token punctuation">}</span><span class="token punctuation">}</span></code></pre><p>Include the <code>Token</code> as part of the <code>Authorization</code> header on your future API requests with the <code>Bearer</code> method.</p>
|
||
<pre><code>curl <span class="token operator">-</span>i <span class="token operator">-</span>H <span class="token string">'Authorization: Bearer hyr5dmb1mbb49c44qmx4whniso'</span> http<span class="token punctuation">:</span><span class="token operator">/</span><span class="token operator">/</span>localhost<span class="token punctuation">:</span><span class="token number">8065</span><span class="token operator">/</span>api<span class="token operator">/</span>v4<span class="token operator">/</span>users<span class="token operator">/</span>me</code></pre><p>You should now be able to access the API as the user you logged in as.</p>
|
||
<h4 id="personal-access-tokens">Personal Access Tokens</h4>
|
||
<p>Using <a href="https://docs.mattermost.com/developer/personal-access-tokens.html">personal access tokens</a> is very similar to using a session token. The only real difference is that session tokens will expire, while personal access tokens will live until they are manually revoked by the user or an admin.</p>
|
||
<p>Just like session tokens, include the personal access token as part of the <code>Authorization</code> header in your requests using the <code>Bearer</code> method. Assuming our personal access token is <code>9xuqwrwgstrb3mzrxb83nb357a</code>, we could use it as shown below.</p>
|
||
<pre><code>curl <span class="token operator">-</span>i <span class="token operator">-</span>H <span class="token string">'Authorization: Bearer 9xuqwrwgstrb3mzrxb83nb357a'</span> http<span class="token punctuation">:</span><span class="token operator">/</span><span class="token operator">/</span>localhost<span class="token punctuation">:</span><span class="token number">8065</span><span class="token operator">/</span>api<span class="token operator">/</span>v4<span class="token operator">/</span>users<span class="token operator">/</span>me</code></pre><h4 id="oauth-20">OAuth 2.0</h4>
|
||
<p>Mattermost has the ability to act as an <a href="https://tools.ietf.org/html/rfc6749">OAuth 2.0</a> service provider.</p>
|
||
<p>The official documentation for <a href="https://docs.mattermost.com/developer/oauth-2-0-applications.html">using your Mattermost server as an OAuth 2.0 service provider can be found here.</a></p>
|
||
<p>For an example on how to register an OAuth 2.0 app with your Mattermost instance, please see the <a href="https://docs.mattermost.com/integrations/zapier.html#register-zapier-as-an-oauth-2-0-application">Mattermost-Zapier integration documentation</a>.</p>
|
||
</div></div></div><div id="tag/errors" data-section-id="tag/errors" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/errors"></a>errors</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>All errors will return an appropriate HTTP response code along with the following JSON body:</p>
|
||
<pre><code><span class="token punctuation">{</span>
|
||
<span class="token string">"id"</span><span class="token punctuation">:</span> <span class="token string">"the.error.id"</span><span class="token punctuation">,</span>
|
||
<span class="token string">"message"</span><span class="token punctuation">:</span> <span class="token string">"Something went wrong"</span><span class="token punctuation">,</span> <span class="token comment">// the reason for the error</span>
|
||
<span class="token string">"request_id"</span><span class="token punctuation">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token comment">// the ID of the request</span>
|
||
<span class="token string">"status_code"</span><span class="token punctuation">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token comment">// the HTTP status code</span>
|
||
<span class="token string">"is_oauth"</span><span class="token punctuation">:</span> <span class="token boolean">false</span> <span class="token comment">// whether the error is OAuth specific</span>
|
||
<span class="token punctuation">}</span></code></pre></div></div></div><div id="tag/rate-limiting" data-section-id="tag/rate-limiting" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/rate-limiting"></a>rate limiting</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Whenever you make an HTTP request to the Mattermost API you might notice the following headers included in the response:</p>
|
||
<pre><code>X<span class="token operator">-</span>Ratelimit<span class="token operator">-</span>Limit<span class="token punctuation">:</span> <span class="token number">10</span>
|
||
X<span class="token operator">-</span>Ratelimit<span class="token operator">-</span>Remaining<span class="token punctuation">:</span> <span class="token number">9</span>
|
||
X<span class="token operator">-</span>Ratelimit<span class="token operator">-</span>Reset<span class="token punctuation">:</span> <span class="token number">1441983590</span></code></pre><p>These headers are telling you your current rate limit status.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Header</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr>
|
||
<td>X-Ratelimit-Limit</td>
|
||
<td>The maximum number of requests you can make per second.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>X-Ratelimit-Remaining</td>
|
||
<td>The number of requests remaining in the current window.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>X-Ratelimit-Reset</td>
|
||
<td>The remaining UTC epoch seconds before the rate limit resets.</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<p>If you exceed your rate limit for a window you will receive the following error in the body of the response:</p>
|
||
<pre><code>HTTP<span class="token operator">/</span><span class="token number">1.1</span> <span class="token number">429</span> Too Many Requests
|
||
Date<span class="token punctuation">:</span> Tue<span class="token punctuation">,</span> <span class="token number">10</span> Sep <span class="token number">2015</span> <span class="token number">11</span><span class="token punctuation">:</span><span class="token number">20</span><span class="token punctuation">:</span><span class="token number">28</span> GMT
|
||
X<span class="token operator">-</span>RateLimit<span class="token operator">-</span>Limit<span class="token punctuation">:</span> <span class="token number">10</span>
|
||
X<span class="token operator">-</span>RateLimit<span class="token operator">-</span>Remaining<span class="token punctuation">:</span> <span class="token number">0</span>
|
||
X<span class="token operator">-</span>RateLimit<span class="token operator">-</span>Reset<span class="token punctuation">:</span> <span class="token number">1</span>
|
||
|
||
limit exceeded</code></pre></div></div></div><div id="tag/WebSocket" data-section-id="tag/WebSocket" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/WebSocket"></a>WebSocket</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>In addition to the HTTP RESTful web service, Mattermost also offers a WebSocket event delivery system and some API functionality.</p>
|
||
<p>To connect to the WebSocket follow the standard opening handshake as <a href="https://tools.ietf.org/html/rfc6455#section-1.3">defined by the RFC specification</a> to the <code>/api/v4/websocket</code> endpoint of Mattermost.</p>
|
||
<h4 id="authentication">Authentication</h4>
|
||
<p>The Mattermost WebSocket can be authenticated by cookie or through an authentication challenge. If you're authenticating from a browser and have logged in with the Mattermost API, your authentication cookie should already be set, this is how the Mattermost webapp authenticates with the WebSocket.</p>
|
||
<p>To authenticate with an authentication challenge, first connect the WebSocket and then send the following JSON over the connection:</p>
|
||
<pre><code><span class="token punctuation">{</span>
|
||
<span class="token string">"seq"</span><span class="token punctuation">:</span> <span class="token number">1</span><span class="token punctuation">,</span>
|
||
<span class="token string">"action"</span><span class="token punctuation">:</span> <span class="token string">"authentication_challenge"</span><span class="token punctuation">,</span>
|
||
<span class="token string">"data"</span><span class="token punctuation">:</span> <span class="token punctuation">{</span>
|
||
<span class="token string">"token"</span><span class="token punctuation">:</span> <span class="token string">"mattermosttokengoeshere"</span>
|
||
<span class="token punctuation">}</span>
|
||
<span class="token punctuation">}</span></code></pre><p>If successful, you will receive a standard OK response over the WebSocket connection:</p>
|
||
<pre><code><span class="token punctuation">{</span>
|
||
<span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"OK"</span><span class="token punctuation">,</span>
|
||
<span class="token string">"seq_reply"</span><span class="token punctuation">:</span> <span class="token number">1</span>
|
||
<span class="token punctuation">}</span></code></pre><p>Once successfully authenticated, the server will pass a <code>hello</code> WebSocket event containing server version over the connection.</p>
|
||
<h4 id="events">Events</h4>
|
||
<p>WebSocket events are primarily used to alert the client to changes in Mattermost, such as delivering new posts or alerting the client that another user is typing in a channel.</p>
|
||
<p>Events on the WebSocket will have the form:</p>
|
||
<pre><code><span class="token punctuation">{</span>
|
||
<span class="token string">"event"</span><span class="token punctuation">:</span> <span class="token string">"hello"</span><span class="token punctuation">,</span>
|
||
<span class="token string">"data"</span><span class="token punctuation">:</span> <span class="token punctuation">{</span>
|
||
<span class="token string">"server_version"</span><span class="token punctuation">:</span> <span class="token string">"3.6.0.1451.1c38da627ebb4e3635677db6939e9195"</span>
|
||
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||
<span class="token string">"broadcast"</span><span class="token punctuation">:</span><span class="token punctuation">{</span>
|
||
<span class="token string">"omit_users"</span><span class="token punctuation">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span>
|
||
<span class="token string">"user_id"</span><span class="token punctuation">:</span> <span class="token string">"ay5sq51sebfh58ktrce5ijtcwy"</span><span class="token punctuation">,</span>
|
||
<span class="token string">"channel_id"</span><span class="token punctuation">:</span> <span class="token string">""</span><span class="token punctuation">,</span>
|
||
<span class="token string">"team_id"</span><span class="token punctuation">:</span> <span class="token string">""</span>
|
||
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||
<span class="token string">"seq"</span><span class="token punctuation">:</span> <span class="token number">0</span>
|
||
<span class="token punctuation">}</span></code></pre><p>The <code>event</code> field indicates the event type, <code>data</code> contains any data relevant to the event and <code>broadcast</code> contains information about who the event was sent to. For example, the above example has <code>user_id</code> set to "ay5sq51sebfh58ktrce5ijtcwy" meaning that only the user with that ID received this event broadcast. The <code>omit_users</code> field can contain an array of user IDs that were specifically omitted from receiving the event.</p>
|
||
<p>The list of Mattermost WebSocket events are:</p>
|
||
<ul>
|
||
<li>added_to_team</li>
|
||
<li>authentication_challenge</li>
|
||
<li>channel_converted</li>
|
||
<li>channel_created</li>
|
||
<li>channel_deleted</li>
|
||
<li>channel_member_updated</li>
|
||
<li>channel_updated</li>
|
||
<li>channel_viewed</li>
|
||
<li>config_changed</li>
|
||
<li>delete_team</li>
|
||
<li>direct_added</li>
|
||
<li>emoji_added</li>
|
||
<li>ephemeral_message</li>
|
||
<li>group_added</li>
|
||
<li>hello</li>
|
||
<li>leave_team</li>
|
||
<li>license_changed</li>
|
||
<li>memberrole_updated</li>
|
||
<li>new_user</li>
|
||
<li>plugin_disabled</li>
|
||
<li>plugin_enabled</li>
|
||
<li>plugin_statuses_changed</li>
|
||
<li>post_deleted</li>
|
||
<li>post_edited</li>
|
||
<li>post_unread</li>
|
||
<li>posted</li>
|
||
<li>preference_changed</li>
|
||
<li>preferences_changed</li>
|
||
<li>preferences_deleted</li>
|
||
<li>reaction_added</li>
|
||
<li>reaction_removed</li>
|
||
<li>response</li>
|
||
<li>role_updated</li>
|
||
<li>status_change</li>
|
||
<li>typing</li>
|
||
<li>update_team</li>
|
||
<li>user_added</li>
|
||
<li>user_removed</li>
|
||
<li>user_role_updated</li>
|
||
<li>user_updated</li>
|
||
<li>dialog_opened</li>
|
||
</ul>
|
||
<h4 id="websocket-api">WebSocket API</h4>
|
||
<p>Mattermost has some basic support for WebSocket APIs. A connected WebSocket can make requests by sending the following over the connection:</p>
|
||
<pre><code><span class="token punctuation">{</span>
|
||
<span class="token string">"action"</span><span class="token punctuation">:</span> <span class="token string">"user_typing"</span><span class="token punctuation">,</span>
|
||
<span class="token string">"seq"</span><span class="token punctuation">:</span> <span class="token number">2</span><span class="token punctuation">,</span>
|
||
<span class="token string">"data"</span><span class="token punctuation">:</span> <span class="token punctuation">{</span>
|
||
<span class="token string">"channel_id"</span><span class="token punctuation">:</span> <span class="token string">"nhze199c4j87ped4wannrjdt9c"</span><span class="token punctuation">,</span>
|
||
<span class="token string">"parent_id"</span><span class="token punctuation">:</span> <span class="token string">""</span>
|
||
<span class="token punctuation">}</span>
|
||
<span class="token punctuation">}</span></code></pre><p>This is an example of making a <code>user_typing</code> request, with the purpose of alerting the server that the connected client has begun typing in a channel or thread. The <code>action</code> field indicates what is being requested, and performs a similar duty as the route in a HTTP API.</p>
|
||
<p>The <code>seq</code> or sequence number is set by the client and should be incremented with every use. It is used to distinguish responses to requests that come down the WebSocket. For example, a standard response to the above request would be:</p>
|
||
<pre><code><span class="token punctuation">{</span>
|
||
<span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"OK"</span><span class="token punctuation">,</span>
|
||
<span class="token string">"seq_reply"</span><span class="token punctuation">:</span> <span class="token number">2</span>
|
||
<span class="token punctuation">}</span></code></pre><p>Notice <code>seq_reply</code> is 2, matching the <code>seq</code> of the original request. Using this a client can distinguish which request the response is meant for.</p>
|
||
<p>If there was any information to respond with, it would be encapsulated in a <code>data</code> field.</p>
|
||
<p>In the case of an error, the response would be:</p>
|
||
<pre><code><span class="token punctuation">{</span>
|
||
<span class="token string">"status"</span><span class="token punctuation">:</span> <span class="token string">"FAIL"</span><span class="token punctuation">,</span>
|
||
<span class="token string">"seq_reply"</span><span class="token punctuation">:</span> <span class="token number">2</span><span class="token punctuation">,</span>
|
||
<span class="token string">"error"</span><span class="token punctuation">:</span> <span class="token punctuation">{</span>
|
||
<span class="token string">"id"</span><span class="token punctuation">:</span> <span class="token string">"some.error.id.here"</span><span class="token punctuation">,</span>
|
||
<span class="token string">"message"</span><span class="token punctuation">:</span> <span class="token string">"Some error message here"</span>
|
||
<span class="token punctuation">}</span>
|
||
<span class="token punctuation">}</span></code></pre><p>The list of WebSocket API actions is:</p>
|
||
<ul>
|
||
<li>user_typing</li>
|
||
<li>get_statuses</li>
|
||
<li>get_statuses_by_ids</li>
|
||
</ul>
|
||
<p>To see how these actions work, please refer to either the <a href="https://github.com/mattermost/mattermost-server/blob/master/model/websocket_client.go">Golang WebSocket driver</a> or our <a href="https://github.com/mattermost/mattermost-redux/blob/master/src/client/websocket_client.js">JavaScript WebSocket driver</a>.</p>
|
||
</div></div></div><div id="tag/users" data-section-id="tag/users" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/users"></a>users</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for creating, getting and interacting with users.</p>
|
||
<p>When using endpoints that require a user id, the string <code>me</code> can be used in place of the user id to indicate the action is to be taken for the logged in user.</p>
|
||
</div></div></div><div id="tag/users/paths/~1users/post" data-section-id="tag/users/paths/~1users/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users/post"></a>Create a user<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Create a new user on the system. Password is required for email login. For other authentication types such as LDAP or SAML, auth_data and auth_service fields are required.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>No permission required but user creation can be controlled by server configuration.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="t"><span class="sc-kGXeez bcLONg"></span>t</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Token id from an email invitation</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="iid"><span class="sc-kGXeez bcLONg"></span>iid</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Token id from an invitation link</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>User object to be created</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="email"><span class="sc-kGXeez bcLONg"></span>email<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="username"><span class="sc-kGXeez bcLONg"></span>username<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="first_name"><span class="sc-kGXeez bcLONg"></span>first_name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="last_name"><span class="sc-kGXeez bcLONg"></span>last_name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="nickname"><span class="sc-kGXeez bcLONg"></span>nickname</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="auth_data"><span class="sc-kGXeez bcLONg"></span>auth_data</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Service-specific authentication data, such as email address.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="auth_service"><span class="sc-kGXeez bcLONg"></span>auth_service</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The authentication service, one of "email", "gitlab", "ldap", "saml", "office365", "google", and "".</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="password"><span class="sc-kGXeez bcLONg"></span>password</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The password used for email authentication.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="locale"><span class="sc-kGXeez bcLONg"></span>locale</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="props"><span class="sc-kGXeez bcLONg"></span>props</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="notify_props"><span class="sc-kGXeez bcLONg"></span>notify_props<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span><span class="sc-cHGsZl sc-cJSrbW edBCth"> (<!-- -->UserNotifyProps<!-- -->) </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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><li class="react-tabs__tab" role="tab" id="react-tabs-2" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-3">Go</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-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_data"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"password"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</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-3" aria-labelledby="react-tabs-2"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" 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">201</li><li class="tab-error" role="tab" id="react-tabs-6" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-7">400</li><li class="tab-error" role="tab" id="react-tabs-8" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-9">403</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-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email_verified"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</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">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_password_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_picture_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed_attempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mfa_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timezone"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"useAutomaticTimezone"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"manualTimezone"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"automaticTimezone"</span>: <span class="token string">"string"</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">"terms_of_service_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"terms_of_service_create_at"</span>: <span class="token number">0</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-7" aria-labelledby="react-tabs-6"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-9" aria-labelledby="react-tabs-8"></div></div></div></div></div></div><div id="tag/users/paths/~1users/get" data-section-id="tag/users/paths/~1users/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users/get"></a>Get users<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of a list of users. Based on query string parameters, select users from a team, channel, or select users not in a specific channel.</p>
|
||
<p>Since server version 4.0, some basic sorting is available using the <code>sort</code> query parameter. Sorting is currently only supported when selecting users on a team.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Requires an active session and (if specified) membership to the channel or team being selected from.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of users per page. There is a maximum limit of 200 users per page.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="in_team"><span class="sc-kGXeez bcLONg"></span>in_team</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the team to get users for.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="not_in_team"><span class="sc-kGXeez bcLONg"></span>not_in_team</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the team to exclude users for. Must not be used with "in_team" query parameter.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="in_channel"><span class="sc-kGXeez bcLONg"></span>in_channel</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the channel to get users for.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="not_in_channel"><span class="sc-kGXeez bcLONg"></span>not_in_channel</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the channel to exclude users for. Must be used with "in_channel" query parameter.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_constrained"><span class="sc-kGXeez bcLONg"></span>group_constrained</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>When used with <code>not_in_channel</code> or <code>not_in_team</code>, returns only the users that are allowed to join the channel or team based on its group constrains.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="without_team"><span class="sc-kGXeez bcLONg"></span>without_team</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Whether or not to list users that are not on any team. This option takes precendence over <code>in_team</code>, <code>in_channel</code>, and <code>not_in_channel</code>.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="sort"><span class="sc-kGXeez bcLONg"></span>sort</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Sort is only available in conjunction with certain options below. The paging parameter is also always available.</p>
|
||
<h5 id="in_team"><code>in_team</code></h5>
|
||
<p>Can be "", "last_activity_at" or "create_at".
|
||
When left blank, sorting is done by username.
|
||
<strong>Minimum server version</strong>: 4.0</p>
|
||
<h5 id="in_channel"><code>in_channel</code></h5>
|
||
<p>Can be "", "status".
|
||
When left blank, sorting is done by username. <code>status</code> will sort by User's current status (Online, Away, DND, Offline), then by Username.
|
||
<strong>Minimum server version</strong>: 4.7</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User page retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-10" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-11" tabindex="0">Go</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 class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
|
||
<span class="token comment">// page, perPage, etag</span>
|
||
users <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetUsers</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">60</span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
users <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">GetUsersInChannel</span><span class="token punctuation">(</span><span class="token string">"channelid"</span><span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">60</span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
users <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">GetUsersNotInChannel</span><span class="token punctuation">(</span><span class="token string">"teamid"</span><span class="token punctuation">,</span> <span class="token string">"channelid"</span><span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">60</span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
users <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">GetUsersInTeam</span><span class="token punctuation">(</span><span class="token string">"teamid"</span><span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">60</span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
users <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">GetUsersNotInTeam</span><span class="token punctuation">(</span><span class="token string">"teamid"</span><span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">60</span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
users <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">GetUsersWithoutTeam</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">60</span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-12" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-13" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-14" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-15">400</li><li class="tab-error" role="tab" id="react-tabs-16" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-17">401</li><li class="tab-error" role="tab" id="react-tabs-18" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-19">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-13" aria-labelledby="react-tabs-12"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email_verified"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_password_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_picture_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed_attempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mfa_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"timezone"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"useAutomaticTimezone"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"manualTimezone"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"automaticTimezone"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"terms_of_service_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"terms_of_service_create_at"</span>: <span class="token number">0</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-15" aria-labelledby="react-tabs-14"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-17" aria-labelledby="react-tabs-16"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-19" aria-labelledby="react-tabs-18"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1ids/post" data-section-id="tag/users/paths/~1users~1ids/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1ids/post"></a>Get users by ids<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of users based on a provided list of user ids.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Requires an active session but no other permissions.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="since"><span class="sc-kGXeez bcLONg"></span>since</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Only return users that have been modified since the given Unix timestamp (in milliseconds).</p>
|
||
<p><strong>Minimum server version</strong>: 5.14</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>List of user ids</p>
|
||
</div><div><div class="sc-hMqMXs dDdNtD"> Array </div><div class="sc-gGBfsJ bvBDls"><div><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></div></div><div class="sc-kEYyzF cMefLx"></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/ids</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/ids</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/ids</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-20" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-21" tabindex="0">Payload</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-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-22" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-23" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-24" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-25">400</li><li class="tab-error" role="tab" id="react-tabs-26" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-27">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-23" aria-labelledby="react-tabs-22"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email_verified"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_password_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_picture_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed_attempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mfa_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"timezone"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"useAutomaticTimezone"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"manualTimezone"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"automaticTimezone"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"terms_of_service_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"terms_of_service_create_at"</span>: <span class="token number">0</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-25" aria-labelledby="react-tabs-24"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-27" aria-labelledby="react-tabs-26"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1group_channels/post" data-section-id="tag/users/paths/~1users~1group_channels/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1group_channels/post"></a>Get users by group channels ids<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get an object containing a key per group channel id in the
|
||
query and its value as a list of users members of that group
|
||
channel.</p>
|
||
<p>The user must be a member of the group ids in the query, or
|
||
they will be omitted from the response.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Requires an active session but no other permissions.</p>
|
||
<p><strong>Minimum server version</strong>: 5.14</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>List of group channel ids</p>
|
||
</div><div><div class="sc-hMqMXs dDdNtD"> Array </div><div class="sc-gGBfsJ bvBDls"><div><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></div></div><div class="sc-kEYyzF cMefLx"></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/group_channels</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/group_channels</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/group_channels</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-28" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-29" tabindex="0">Payload</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-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-30" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-31" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-32" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-33">400</li><li class="tab-error" role="tab" id="react-tabs-34" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-35">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-31" aria-labelledby="react-tabs-30"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"<CHANNEL_ID>"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email_verified"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_password_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_picture_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed_attempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mfa_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"timezone"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"useAutomaticTimezone"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"manualTimezone"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"automaticTimezone"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"terms_of_service_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"terms_of_service_create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</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-33" aria-labelledby="react-tabs-32"></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/users/paths/~1users~1usernames/post" data-section-id="tag/users/paths/~1users~1usernames/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1usernames/post"></a>Get users by usernames<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of users based on a provided list of usernames.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Requires an active session but no other permissions.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>List of usernames</p>
|
||
</div><div><div class="sc-hMqMXs dDdNtD"> Array </div><div class="sc-gGBfsJ bvBDls"><div><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></div></div><div class="sc-kEYyzF cMefLx"></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/usernames</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/usernames</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/usernames</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-36" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-37" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-38" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-39">Go</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-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"string"</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-39" aria-labelledby="react-tabs-38"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" 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">400</li><li class="tab-error" role="tab" id="react-tabs-44" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-45">401</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-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email_verified"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_password_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_picture_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed_attempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mfa_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"timezone"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"useAutomaticTimezone"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"manualTimezone"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"automaticTimezone"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"terms_of_service_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"terms_of_service_create_at"</span>: <span class="token number">0</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-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/users/paths/~1users~1search/post" data-section-id="tag/users/paths/~1users~1search/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1search/post"></a>Search users<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of users based on search criteria provided in the request body. Searches are typically done against username, full name, nickname and email unless otherwise configured by the server.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Requires an active session and <code>read_channel</code> and/or <code>view_team</code> permissions for any channels or teams specified in the request body.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Search criteria</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="term"><span class="sc-kGXeez bcLONg"></span>term<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The term to match against username, full name, nickname and email</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>If provided, only search users on this team</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="not_in_team_id"><span class="sc-kGXeez bcLONg"></span>not_in_team_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>If provided, only search users not on this team</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="in_channel_id"><span class="sc-kGXeez bcLONg"></span>in_channel_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>If provided, only search users in this channel</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="not_in_channel_id"><span class="sc-kGXeez bcLONg"></span>not_in_channel_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>If provided, only search users not in this channel. Must specifiy <code>team_id</code> when using this option</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_constrained"><span class="sc-kGXeez bcLONg"></span>group_constrained</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>When used with <code>not_in_channel_id</code> or <code>not_in_team_id</code>, returns only the users that are allowed to join the channel or team based on its group constrains.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="allow_inactive"><span class="sc-kGXeez bcLONg"></span>allow_inactive</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>When <code>true</code>, include deactivated users in the results</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="without_team"><span class="sc-kGXeez bcLONg"></span>without_team</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set this to <code>true</code> if you would like to search for users that are not on a team. This option takes precendence over <code>team_id</code>, <code>in_channel_id</code>, and <code>not_in_channel_id</code>.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="limit"><span class="sc-kGXeez bcLONg"></span>limit</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">100</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The maximum number of users to return in the results</p>
|
||
<p><strong>Available as of server version 5.6. Defaults to <code>100</code> if not provided or on an earlier server version.</strong></p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/search</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/search</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/search</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-46" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-47" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-48" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-49">Go</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-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"term"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_in_team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"in_channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_in_channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group_constrained"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow_inactive"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"without_team"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">100</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><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" 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">400</li><li class="tab-error" role="tab" id="react-tabs-54" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-55">401</li><li class="tab-error" role="tab" id="react-tabs-56" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-57">403</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-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email_verified"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_password_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_picture_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed_attempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mfa_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"timezone"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"useAutomaticTimezone"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"manualTimezone"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"automaticTimezone"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"terms_of_service_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"terms_of_service_create_at"</span>: <span class="token number">0</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 class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-55" aria-labelledby="react-tabs-54"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-57" aria-labelledby="react-tabs-56"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1autocomplete/get" data-section-id="tag/users/paths/~1users~1autocomplete/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1autocomplete/get"></a>Autocomplete users<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of users for the purpose of autocompleting based on the provided search term. Specify a combination of <code>team_id</code> and <code>channel_id</code> to filter results further.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Requires an active session and <code>view_team</code> and <code>read_channel</code> on any teams or channels used to filter the results further.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team ID</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel ID</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Username, nickname first name or last name</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="limit"><span class="sc-kGXeez bcLONg"></span>limit</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">100</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The maximum number of users to return in each subresult</p>
|
||
<p><strong>Available as of server version 5.6. Defaults to <code>100</code> if not provided or on an earlier server version.</strong></p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User autocomplete successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/autocomplete</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/autocomplete</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/autocomplete</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-58" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-59" tabindex="0">Go</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 class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
teamID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
channelID <span class="token operator">:=</span> <span class="token string">"Ej3SKOHlWIKAblkUTK5Xvkj2cm"</span>
|
||
username <span class="token operator">:=</span> <span class="token string">"testUsername"</span>
|
||
|
||
users<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">AutocompleteUsersInChannel</span><span class="token punctuation">(</span>teamID<span class="token punctuation">,</span> channelID<span class="token punctuation">,</span> username<span class="token punctuation">,</span> <span class="token number">100</span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-60" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-61" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-62" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-63">400</li><li class="tab-error" role="tab" id="react-tabs-64" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-65">401</li><li class="tab-error" role="tab" id="react-tabs-66" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-67">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-61" aria-labelledby="react-tabs-60"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"users"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email_verified"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_password_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_picture_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed_attempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mfa_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"timezone"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"useAutomaticTimezone"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"manualTimezone"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"automaticTimezone"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"terms_of_service_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"terms_of_service_create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</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">"out_of_channel"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email_verified"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_password_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_picture_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed_attempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mfa_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"timezone"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"useAutomaticTimezone"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"manualTimezone"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"automaticTimezone"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"terms_of_service_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"terms_of_service_create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</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-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/users/paths/~1users~1stats/get" data-section-id="tag/users/paths/~1users~1stats/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1stats/get"></a>Get total count of users in the system<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a total count of users in the system.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User stats retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/stats</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/stats</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/stats</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-68" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-69" tabindex="0">Go</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 class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
stats<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetTotalUsersStats</span><span class="token punctuation">(</span><span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-70" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-71" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-72" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-73">400</li><li class="tab-error" role="tab" id="react-tabs-74" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-75">401</li><li class="tab-error" role="tab" id="react-tabs-76" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-77">403</li><li class="tab-error" role="tab" id="react-tabs-78" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-79">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-71" aria-labelledby="react-tabs-70"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"total_users_count"</span>: <span class="token number">0</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-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 class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-77" aria-labelledby="react-tabs-76"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-79" aria-labelledby="react-tabs-78"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}/get" data-section-id="tag/users/paths/~1users~1{user_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}/get"></a>Get a user<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a user a object. Sensitive information will be sanitized out.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Requires an active session but no other permissions.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-80" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-81" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-81" aria-labelledby="react-tabs-80"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
user<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetUser</span><span class="token punctuation">(</span>userID<span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-82" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-83" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-84" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-85">400</li><li class="tab-error" role="tab" id="react-tabs-86" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-87">401</li><li class="tab-error" role="tab" id="react-tabs-88" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-89">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-83" aria-labelledby="react-tabs-82"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email_verified"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</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">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_password_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_picture_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed_attempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mfa_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timezone"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"useAutomaticTimezone"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"manualTimezone"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"automaticTimezone"</span>: <span class="token string">"string"</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">"terms_of_service_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"terms_of_service_create_at"</span>: <span class="token number">0</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-85" aria-labelledby="react-tabs-84"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-87" aria-labelledby="react-tabs-86"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-89" aria-labelledby="react-tabs-88"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}/put" data-section-id="tag/users/paths/~1users~1{user_id}/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}/put"></a>Update a user<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update a user by providing the user object. The fields that can be updated are defined in the request body, all other provided fields will be ignored. Any fields not included in the request body will be set to null or reverted to default values.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being updated or have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>User object that is to be updated</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="id"><span class="sc-kGXeez bcLONg"></span>id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="email"><span class="sc-kGXeez bcLONg"></span>email</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="username"><span class="sc-kGXeez bcLONg"></span>username</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="first_name"><span class="sc-kGXeez bcLONg"></span>first_name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="last_name"><span class="sc-kGXeez bcLONg"></span>last_name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="nickname"><span class="sc-kGXeez bcLONg"></span>nickname</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="locale"><span class="sc-kGXeez bcLONg"></span>locale</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="position"><span class="sc-kGXeez bcLONg"></span>position</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="props"><span class="sc-kGXeez bcLONg"></span>props</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="notify_props"><span class="sc-kGXeez bcLONg"></span>notify_props<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span><span class="sc-cHGsZl sc-cJSrbW edBCth"> (<!-- -->UserNotifyProps<!-- -->) </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-90" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-91" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-92" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-93">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-91" aria-labelledby="react-tabs-90"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"position"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</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-93" aria-labelledby="react-tabs-92"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" 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><li class="tab-error" role="tab" id="react-tabs-96" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-97">400</li><li class="tab-error" role="tab" id="react-tabs-98" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-99">401</li><li class="tab-error" role="tab" id="react-tabs-100" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-101">403</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-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email_verified"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</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">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_password_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_picture_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed_attempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mfa_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timezone"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"useAutomaticTimezone"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"manualTimezone"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"automaticTimezone"</span>: <span class="token string">"string"</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">"terms_of_service_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"terms_of_service_create_at"</span>: <span class="token number">0</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-97" aria-labelledby="react-tabs-96"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-99" aria-labelledby="react-tabs-98"></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 id="tag/users/paths/~1users~1{user_id}/delete" data-section-id="tag/users/paths/~1users~1{user_id}/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}/delete"></a>Deactivate a user account.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Deactivates the user and revokes all its sessions by archiving its user object.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being deactivated or have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User deactivation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-102" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-103" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-103" aria-labelledby="react-tabs-102"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">DeleteUser</span><span class="token punctuation">(</span>userID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-104" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-105" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-106" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-107">400</li><li class="tab-error" role="tab" id="react-tabs-108" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-109">401</li><li class="tab-error" role="tab" id="react-tabs-110" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-111">403</li><li class="tab-error" role="tab" id="react-tabs-112" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-113">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-105" aria-labelledby="react-tabs-104"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-107" aria-labelledby="react-tabs-106"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-109" aria-labelledby="react-tabs-108"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-111" aria-labelledby="react-tabs-110"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-113" aria-labelledby="react-tabs-112"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1patch/put" data-section-id="tag/users/paths/~1users~1{user_id}~1patch/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1patch/put"></a>Patch a user<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Partially update a user by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being updated or have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>User object that is to be updated</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="email"><span class="sc-kGXeez bcLONg"></span>email</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="username"><span class="sc-kGXeez bcLONg"></span>username</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="first_name"><span class="sc-kGXeez bcLONg"></span>first_name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="last_name"><span class="sc-kGXeez bcLONg"></span>last_name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="nickname"><span class="sc-kGXeez bcLONg"></span>nickname</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="locale"><span class="sc-kGXeez bcLONg"></span>locale</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="position"><span class="sc-kGXeez bcLONg"></span>position</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="props"><span class="sc-kGXeez bcLONg"></span>props</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="notify_props"><span class="sc-kGXeez bcLONg"></span>notify_props<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span><span class="sc-cHGsZl sc-cJSrbW edBCth"> (<!-- -->UserNotifyProps<!-- -->) </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User patch successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/patch</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/patch</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/patch</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-114" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-115" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-116" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-117">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-115" aria-labelledby="react-tabs-114"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"position"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</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-117" aria-labelledby="react-tabs-116"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-118" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-119" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-120" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-121">400</li><li class="tab-error" role="tab" id="react-tabs-122" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-123">401</li><li class="tab-error" role="tab" id="react-tabs-124" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-125">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-119" aria-labelledby="react-tabs-118"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email_verified"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</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">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_password_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_picture_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed_attempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mfa_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timezone"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"useAutomaticTimezone"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"manualTimezone"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"automaticTimezone"</span>: <span class="token string">"string"</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">"terms_of_service_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"terms_of_service_create_at"</span>: <span class="token number">0</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-121" aria-labelledby="react-tabs-120"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-123" aria-labelledby="react-tabs-122"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-125" aria-labelledby="react-tabs-124"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1roles/put" data-section-id="tag/users/paths/~1users~1{user_id}~1roles/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1roles/put"></a>Update a user's roles<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update a user's system-level roles. Valid user roles are "system_user", "system_admin" or both of them. Overwrites any previously assigned system-level roles.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have the <code>manage_roles</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Space-delimited system roles to assign to the user</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="roles"><span class="sc-kGXeez bcLONg"></span>roles<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User roles update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/roles</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/roles</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/roles</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-126" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-127" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-128" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-129">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-127" aria-labelledby="react-tabs-126"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"roles"</span>: <span class="token string">"string"</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-129" aria-labelledby="react-tabs-128"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-130" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-131" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-132" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-133">400</li><li class="tab-error" role="tab" id="react-tabs-134" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-135">401</li><li class="tab-error" role="tab" id="react-tabs-136" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-137">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-131" aria-labelledby="react-tabs-130"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-133" aria-labelledby="react-tabs-132"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-135" aria-labelledby="react-tabs-134"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-137" aria-labelledby="react-tabs-136"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1active/put" data-section-id="tag/users/paths/~1users~1{user_id}~1active/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1active/put"></a>Update user active status<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update user active or inactive status.</p>
|
||
<p><strong>Since server version 4.6, users using a SSO provider to login can be activated or deactivated with this endpoint. However, if their activation status in Mattermost does not reflect their status in the SSO provider, the next synchronization or login by that user will reset the activation status to that of their account in the SSO provider. Server versions 4.5 and before do not allow activation or deactivation of SSO users from this endpoint.</strong></p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>User can deactivate themselves.
|
||
User with <code>manage_system</code> permission can activate or deactivate a user.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Use <code>true</code> to set the user active, <code>false</code> for inactive</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="active"><span class="sc-kGXeez bcLONg"></span>active<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User active status update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/active</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/active</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/active</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-138" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-139" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-140" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-141">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-139" aria-labelledby="react-tabs-138"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"active"</span>: <span class="token boolean">true</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-141" aria-labelledby="react-tabs-140"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-142" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-143" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-144" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-145">400</li><li class="tab-error" role="tab" id="react-tabs-146" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-147">401</li><li class="tab-error" role="tab" id="react-tabs-148" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-149">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-143" aria-labelledby="react-tabs-142"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-145" aria-labelledby="react-tabs-144"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-147" aria-labelledby="react-tabs-146"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-149" aria-labelledby="react-tabs-148"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1image/get" data-section-id="tag/users/paths/~1users~1{user_id}~1image/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1image/get"></a>Get user's profile image<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a user's profile image based on user_id string parameter.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT hLVzSF"><strong>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User's profile image</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/image</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/image</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/image</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-150" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-151" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-151" aria-labelledby="react-tabs-150"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
data<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetProfileImage</span><span class="token punctuation">(</span>userID<span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-152" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-153" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-154" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-155">401</li><li class="tab-error" role="tab" id="react-tabs-156" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-157">403</li><li class="tab-error" role="tab" id="react-tabs-158" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-159">404</li><li class="tab-error" role="tab" id="react-tabs-160" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-161">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-153" aria-labelledby="react-tabs-152"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-155" aria-labelledby="react-tabs-154"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-157" aria-labelledby="react-tabs-156"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-159" aria-labelledby="react-tabs-158"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-161" aria-labelledby="react-tabs-160"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1image/post" data-section-id="tag/users/paths/~1users~1{user_id}~1image/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1image/post"></a>Set user's profile image<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Set a user's profile image based on user_id string parameter.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being updated or have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">multipart/form-data</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="image"><span class="sc-kGXeez bcLONg"></span>image<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span><span class="sc-cHGsZl sc-kgAjT hqYVjx"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The image to be uploaded</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Profile image set successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/image</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/image</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/image</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-162" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-163" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-163" aria-labelledby="react-tabs-162"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token punctuation">(</span>
|
||
<span class="token string">"io/ioutil"</span>
|
||
<span class="token string">"log"</span>
|
||
|
||
<span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
<span class="token punctuation">)</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
data<span class="token punctuation">,</span> err <span class="token operator">:=</span> ioutil<span class="token punctuation">.</span><span class="token function">ReadFile</span><span class="token punctuation">(</span><span class="token string">"profile_pic.png"</span><span class="token punctuation">)</span>
|
||
<span class="token keyword">if</span> err <span class="token operator">!=</span> <span class="token boolean">nil</span> <span class="token punctuation">{</span>
|
||
log<span class="token punctuation">.</span><span class="token function">Fatal</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span>
|
||
<span class="token punctuation">}</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">SetProfileImage</span><span class="token punctuation">(</span>userID<span class="token punctuation">,</span> data<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-164" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-165" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-166" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-167">400</li><li class="tab-error" role="tab" id="react-tabs-168" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-169">401</li><li class="tab-error" role="tab" id="react-tabs-170" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-171">403</li><li class="tab-error" role="tab" id="react-tabs-172" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-173">404</li><li class="tab-error" role="tab" id="react-tabs-174" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-175">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-165" aria-labelledby="react-tabs-164"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-167" aria-labelledby="react-tabs-166"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-169" aria-labelledby="react-tabs-168"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-171" aria-labelledby="react-tabs-170"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-173" aria-labelledby="react-tabs-172"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-175" aria-labelledby="react-tabs-174"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1image/delete" data-section-id="tag/users/paths/~1users~1{user_id}~1image/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1image/delete"></a>Delete user's profile image<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Delete user's profile image and reset to default image based on user_id string parameter.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being updated or have the <code>edit_other_users</code> permission.
|
||
<strong>Minimum server version</strong>: 5.5</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Profile image reset successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/image</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/image</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/image</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-176" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-177" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-177" aria-labelledby="react-tabs-176"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
<span class="token comment">// Deleting user's profile image consists on resetting it to default one</span>
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">SetDefaultProfileImage</span><span class="token punctuation">(</span>userID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-178" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-179" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-180" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-181">400</li><li class="tab-error" role="tab" id="react-tabs-182" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-183">401</li><li class="tab-error" role="tab" id="react-tabs-184" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-185">403</li><li class="tab-error" role="tab" id="react-tabs-186" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-187">404</li><li class="tab-error" role="tab" id="react-tabs-188" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-189">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-179" aria-labelledby="react-tabs-178"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-181" aria-labelledby="react-tabs-180"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-183" aria-labelledby="react-tabs-182"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-185" aria-labelledby="react-tabs-184"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-187" aria-labelledby="react-tabs-186"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-189" aria-labelledby="react-tabs-188"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1image~1default/get" data-section-id="tag/users/paths/~1users~1{user_id}~1image~1default/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1image~1default/get"></a>Return user's default (generated) profile image<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Returns the default (generated) user profile image based on user_id string parameter.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in.
|
||
<strong>Minimum server version</strong>: 5.5</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT hLVzSF"><strong>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Default profile image</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/image/default</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/image/default</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/image/default</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-190" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-191" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-191" aria-labelledby="react-tabs-190"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">SetDefaultProfileImage</span><span class="token punctuation">(</span>userID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-192" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-193" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-194" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-195">401</li><li class="tab-error" role="tab" id="react-tabs-196" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-197">403</li><li class="tab-error" role="tab" id="react-tabs-198" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-199">404</li><li class="tab-error" role="tab" id="react-tabs-200" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-201">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-193" aria-labelledby="react-tabs-192"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-195" aria-labelledby="react-tabs-194"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-197" aria-labelledby="react-tabs-196"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-199" aria-labelledby="react-tabs-198"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-201" aria-labelledby="react-tabs-200"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1username~1{username}/get" data-section-id="tag/users/paths/~1users~1username~1{username}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1username~1{username}/get"></a>Get a user by username<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a user object by providing a username. Sensitive information will be sanitized out.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Requires an active session but no other permissions.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="username"><span class="sc-kGXeez bcLONg"></span>username<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Username</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/username/{username}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/username/{username}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/username/{username}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-202" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-203" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-203" aria-labelledby="react-tabs-202"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
user<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetUserByUsername</span><span class="token punctuation">(</span>userID<span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-204" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-205" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-206" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-207">400</li><li class="tab-error" role="tab" id="react-tabs-208" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-209">401</li><li class="tab-error" role="tab" id="react-tabs-210" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-211">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-205" aria-labelledby="react-tabs-204"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email_verified"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</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">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_password_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_picture_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed_attempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mfa_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timezone"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"useAutomaticTimezone"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"manualTimezone"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"automaticTimezone"</span>: <span class="token string">"string"</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">"terms_of_service_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"terms_of_service_create_at"</span>: <span class="token number">0</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-207" aria-labelledby="react-tabs-206"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-209" aria-labelledby="react-tabs-208"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-211" aria-labelledby="react-tabs-210"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1password~1reset/post" data-section-id="tag/users/paths/~1users~1password~1reset/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1password~1reset/post"></a>Reset password<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update the password for a user using a one-use, timed recovery code tied to the user's account. Only works for non-SSO users.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>No permissions required.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="code"><span class="sc-kGXeez bcLONg"></span>code<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The recovery code</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="new_password"><span class="sc-kGXeez bcLONg"></span>new_password<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The new password for the user</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User password update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/password/reset</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/password/reset</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/password/reset</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-212" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-213" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-214" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-215">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-213" aria-labelledby="react-tabs-212"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"new_password"</span>: <span class="token string">"string"</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-215" aria-labelledby="react-tabs-214"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-216" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-217" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-218" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-219">400</li><li class="tab-error" role="tab" id="react-tabs-220" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-221">401</li><li class="tab-error" role="tab" id="react-tabs-222" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-223">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-217" aria-labelledby="react-tabs-216"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-219" aria-labelledby="react-tabs-218"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-221" aria-labelledby="react-tabs-220"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-223" aria-labelledby="react-tabs-222"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1mfa/put" data-section-id="tag/users/paths/~1users~1{user_id}~1mfa/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1mfa/put"></a>Update a user's MFA<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Activates multi-factor authentication for the user if <code>activate</code> is true and a valid <code>code</code> is provided. If activate is false, then <code>code</code> is not required and multi-factor authentication is disabled for the user.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being updated or have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="activate"><span class="sc-kGXeez bcLONg"></span>activate<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Use <code>true</code> to activate, <code>false</code> to deactivate</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="code"><span class="sc-kGXeez bcLONg"></span>code</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The code produced by your MFA client. Required if <code>activate</code> is true</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User MFA update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/mfa</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/mfa</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/mfa</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-224" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-225" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-226" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-227">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-225" aria-labelledby="react-tabs-224"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"activate"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"code"</span>: <span class="token string">"string"</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-227" aria-labelledby="react-tabs-226"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-228" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-229" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-230" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-231">400</li><li class="tab-error" role="tab" id="react-tabs-232" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-233">401</li><li class="tab-error" role="tab" id="react-tabs-234" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-235">403</li><li class="tab-error" role="tab" id="react-tabs-236" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-237">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-229" aria-labelledby="react-tabs-228"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-231" aria-labelledby="react-tabs-230"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-233" aria-labelledby="react-tabs-232"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-235" aria-labelledby="react-tabs-234"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-237" aria-labelledby="react-tabs-236"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1mfa~1generate/post" data-section-id="tag/users/paths/~1users~1{user_id}~1mfa~1generate/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1mfa~1generate/post"></a>Generate MFA secret<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Generates an multi-factor authentication secret for a user and returns it as a string and as base64 encoded QR code image.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user or have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>MFA secret generation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/mfa/generate</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/mfa/generate</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/mfa/generate</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-238" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-239" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-239" aria-labelledby="react-tabs-238"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"BbaYBYDV5IDOZFiJGBSzkw1k5u"</span>
|
||
|
||
mfaSecret<span class="token punctuation">,</span> resp <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">GenerateMfaSecret</span><span class="token punctuation">(</span>userID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-240" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-241" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-242" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-243">400</li><li class="tab-error" role="tab" id="react-tabs-244" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-245">401</li><li class="tab-error" role="tab" id="react-tabs-246" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-247">403</li><li class="tab-error" role="tab" id="react-tabs-248" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-249">404</li><li class="tab-error" role="tab" id="react-tabs-250" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-251">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-241" aria-labelledby="react-tabs-240"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"qr_code"</span>: <span class="token string">"string"</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-243" aria-labelledby="react-tabs-242"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-245" aria-labelledby="react-tabs-244"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-247" aria-labelledby="react-tabs-246"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-249" aria-labelledby="react-tabs-248"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-251" aria-labelledby="react-tabs-250"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1demote/post" data-section-id="tag/users/paths/~1users~1{user_id}~1demote/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1demote/post"></a>Demote a user to a guest<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Convert a regular user into a guest. This will convert the user into a
|
||
guest for the whole system while retaining their existing team and
|
||
channel memberships.</p>
|
||
<p><strong>Minimum server version</strong>: 5.16</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user or have the <code>demote_to_guest</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User successfully demoted</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/demote</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/demote</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/demote</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-252" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-253" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-253" aria-labelledby="react-tabs-252"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"BbaYBYDV5IDOZFiJGBSzkw1k5u"</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">demoteUserToGuest</span><span class="token punctuation">(</span>userID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-254" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-255" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-256" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-257">400</li><li class="tab-error" role="tab" id="react-tabs-258" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-259">401</li><li class="tab-error" role="tab" id="react-tabs-260" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-261">403</li><li class="tab-error" role="tab" id="react-tabs-262" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-263">404</li><li class="tab-error" role="tab" id="react-tabs-264" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-265">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-255" aria-labelledby="react-tabs-254"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-257" aria-labelledby="react-tabs-256"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-259" aria-labelledby="react-tabs-258"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-261" aria-labelledby="react-tabs-260"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-263" aria-labelledby="react-tabs-262"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-265" aria-labelledby="react-tabs-264"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1promote/post" data-section-id="tag/users/paths/~1users~1{user_id}~1promote/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1promote/post"></a>Promote a guest to user<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Convert a guest into a regular user. This will convert the guest into a
|
||
user for the whole system while retaining any team and channel
|
||
memberships and automatically joining them to the default channels.</p>
|
||
<p><strong>Minimum server version</strong>: 5.16</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user or have the <code>promote_guest</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Guest successfully promoted</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/promote</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/promote</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/promote</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-266" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-267" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-267" aria-labelledby="react-tabs-266"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"BbaYBYDV5IDOZFiJGBSzkw1k5u"</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">PromoteGuestToUser</span><span class="token punctuation">(</span>userID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-268" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-269" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-270" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-271">400</li><li class="tab-error" role="tab" id="react-tabs-272" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-273">401</li><li class="tab-error" role="tab" id="react-tabs-274" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-275">403</li><li class="tab-error" role="tab" id="react-tabs-276" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-277">404</li><li class="tab-error" role="tab" id="react-tabs-278" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-279">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-269" aria-labelledby="react-tabs-268"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-271" aria-labelledby="react-tabs-270"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-273" aria-labelledby="react-tabs-272"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-275" aria-labelledby="react-tabs-274"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-277" aria-labelledby="react-tabs-276"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-279" aria-labelledby="react-tabs-278"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1mfa/post" data-section-id="tag/users/paths/~1users~1mfa/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1mfa/post"></a>Check MFA<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Check if a user has multi-factor authentication active on their account by providing a login id. Used to check whether an MFA code needs to be provided when logging in.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>No permission required.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="login_id"><span class="sc-kGXeez bcLONg"></span>login_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The email or username used to login</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>MFA check successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/mfa</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/mfa</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/mfa</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-280" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-281" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-282" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-283">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-281" aria-labelledby="react-tabs-280"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"login_id"</span>: <span class="token string">"string"</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-283" aria-labelledby="react-tabs-282"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-284" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-285" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-286" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-287">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-285" aria-labelledby="react-tabs-284"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"mfa_required"</span>: <span class="token boolean">true</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-287" aria-labelledby="react-tabs-286"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1password/put" data-section-id="tag/users/paths/~1users~1{user_id}~1password/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1password/put"></a>Update a user's password<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update a user's password. New password must meet password policy set by server configuration. Current password is required if you're updating your own password.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user the password is being changed for or have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="current_password"><span class="sc-kGXeez bcLONg"></span>current_password</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The current password for the user</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="new_password"><span class="sc-kGXeez bcLONg"></span>new_password<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The new password for the user</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User password update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/password</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/password</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/password</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-288" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-289" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-290" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-291">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-289" aria-labelledby="react-tabs-288"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"current_password"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"new_password"</span>: <span class="token string">"string"</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-291" aria-labelledby="react-tabs-290"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-292" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-293" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-294" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-295">400</li><li class="tab-error" role="tab" id="react-tabs-296" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-297">401</li><li class="tab-error" role="tab" id="react-tabs-298" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-299">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-293" aria-labelledby="react-tabs-292"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-295" aria-labelledby="react-tabs-294"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-297" aria-labelledby="react-tabs-296"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-299" aria-labelledby="react-tabs-298"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1password~1reset~1send/post" data-section-id="tag/users/paths/~1users~1password~1reset~1send/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1password~1reset~1send/post"></a>Send password reset email<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Send an email containing a link for resetting the user's password. The link will contain a one-use, timed recovery code tied to the user's account. Only works for non-SSO users.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>No permissions required.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="email"><span class="sc-kGXeez bcLONg"></span>email<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The email of the user</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Email sent if account exists</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/password/reset/send</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/password/reset/send</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/password/reset/send</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-300" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-301" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-302" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-303">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-301" aria-labelledby="react-tabs-300"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</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-303" aria-labelledby="react-tabs-302"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-304" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-305" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-306" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-307">400</li><li class="tab-error" role="tab" id="react-tabs-308" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-309">401</li><li class="tab-error" role="tab" id="react-tabs-310" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-311">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-305" aria-labelledby="react-tabs-304"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-307" aria-labelledby="react-tabs-306"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-309" aria-labelledby="react-tabs-308"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-311" aria-labelledby="react-tabs-310"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1email~1{email}/get" data-section-id="tag/users/paths/~1users~1email~1{email}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1email~1{email}/get"></a>Get a user by email<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a user object by providing a user email. Sensitive information will be sanitized out.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Requires an active session and for the current session to be able to view another user's email based on the server's privacy settings.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="email"><span class="sc-kGXeez bcLONg"></span>email<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User Email</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/email/{email}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/email/{email}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/email/{email}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-312" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-313" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-313" aria-labelledby="react-tabs-312"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
email <span class="token operator">:=</span> <span class="token string">"test@domain.com"</span>
|
||
|
||
user<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetUserByEmail</span><span class="token punctuation">(</span>email<span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-314" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-315" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-316" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-317">400</li><li class="tab-error" role="tab" id="react-tabs-318" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-319">401</li><li class="tab-error" role="tab" id="react-tabs-320" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-321">403</li><li class="tab-error" role="tab" id="react-tabs-322" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-323">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-315" aria-labelledby="react-tabs-314"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email_verified"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</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">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_password_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_picture_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed_attempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mfa_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timezone"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"useAutomaticTimezone"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"manualTimezone"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"automaticTimezone"</span>: <span class="token string">"string"</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">"terms_of_service_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"terms_of_service_create_at"</span>: <span class="token number">0</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-317" aria-labelledby="react-tabs-316"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-319" aria-labelledby="react-tabs-318"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-321" aria-labelledby="react-tabs-320"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-323" aria-labelledby="react-tabs-322"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1sessions/get" data-section-id="tag/users/paths/~1users~1{user_id}~1sessions/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1sessions/get"></a>Get user's sessions<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of sessions by providing the user GUID. Sensitive information will be sanitized out.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being updated or have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User session retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/sessions</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/sessions</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/sessions</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-324" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-325" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-325" aria-labelledby="react-tabs-324"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"zWEyrTZ7GZ22aBSfoX60iWryTY"</span>
|
||
|
||
sessions<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetSessions</span><span class="token punctuation">(</span>userID<span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-326" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-327" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-328" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-329">400</li><li class="tab-error" role="tab" id="react-tabs-330" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-331">401</li><li class="tab-error" role="tab" id="react-tabs-332" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-333">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-327" aria-labelledby="react-tabs-326"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"device_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"is_oauth"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_activity_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"team_members"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheme_user"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheme_admin"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"explicit_roles"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</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-329" aria-labelledby="react-tabs-328"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-331" aria-labelledby="react-tabs-330"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-333" aria-labelledby="react-tabs-332"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1sessions~1revoke/post" data-section-id="tag/users/paths/~1users~1{user_id}~1sessions~1revoke/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1sessions~1revoke/post"></a>Revoke a user session<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Revokes a user session from the provided user id and session id strings.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being updated or have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="session_id"><span class="sc-kGXeez bcLONg"></span>session_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The session GUID to revoke.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User session revoked successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/sessions/revoke</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/sessions/revoke</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/sessions/revoke</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-334" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-335" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-336" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-337">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-335" aria-labelledby="react-tabs-334"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"session_id"</span>: <span class="token string">"string"</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-337" aria-labelledby="react-tabs-336"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-338" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-339" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-340" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-341">400</li><li class="tab-error" role="tab" id="react-tabs-342" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-343">401</li><li class="tab-error" role="tab" id="react-tabs-344" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-345">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-339" aria-labelledby="react-tabs-338"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-341" aria-labelledby="react-tabs-340"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-343" aria-labelledby="react-tabs-342"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-345" aria-labelledby="react-tabs-344"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1sessions~1revoke~1all/post" data-section-id="tag/users/paths/~1users~1{user_id}~1sessions~1revoke~1all/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1sessions~1revoke~1all/post"></a>Revoke all active sessions for a user<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Revokes all user sessions from the provided user id and session id strings.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being updated or have the <code>edit_other_users</code> permission.
|
||
<strong>Minimum server version</strong>: 4.4</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User sessions revoked successfully</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/sessions/revoke/all</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/sessions/revoke/all</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/sessions/revoke/all</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-346" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-347" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-347" aria-labelledby="react-tabs-346"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"zWEyrTZ7GZ22aBSfoX60iWryTY"</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">RevokeAllSessions</span><span class="token punctuation">(</span>userID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-348" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-349" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-350" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-351">400</li><li class="tab-error" role="tab" id="react-tabs-352" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-353">401</li><li class="tab-error" role="tab" id="react-tabs-354" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-355">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-349" aria-labelledby="react-tabs-348"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-351" aria-labelledby="react-tabs-350"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-353" aria-labelledby="react-tabs-352"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-355" aria-labelledby="react-tabs-354"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1sessions~1device/put" data-section-id="tag/users/paths/~1users~1sessions~1device/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1sessions~1device/put"></a>Attach mobile device<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Attach a mobile device id to the currently logged in session. This will enable push notifications for a user, if configured by the server.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="device_id"><span class="sc-kGXeez bcLONg"></span>device_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Mobile device id. For Android prefix the id with <code>android:</code> and Apple with <code>apple:</code></p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Device id attach successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/users/sessions/device</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/sessions/device</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/sessions/device</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-356" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-357" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-358" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-359">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-357" aria-labelledby="react-tabs-356"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"device_id"</span>: <span class="token string">"string"</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-359" aria-labelledby="react-tabs-358"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-360" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-361" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-362" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-363">400</li><li class="tab-error" role="tab" id="react-tabs-364" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-365">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-361" aria-labelledby="react-tabs-360"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-363" aria-labelledby="react-tabs-362"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-365" aria-labelledby="react-tabs-364"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1audits/get" data-section-id="tag/users/paths/~1users~1{user_id}~1audits/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1audits/get"></a>Get user's audits<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of audit by providing the user GUID.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user or have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User audits retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/audits</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/audits</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/audits</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-366" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-367" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-367" aria-labelledby="react-tabs-366"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"zWEyrTZ7GZ22aBSfoX60iWryTY"</span>
|
||
|
||
audits<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetUserAudits</span><span class="token punctuation">(</span>userID<span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">100</span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-368" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-369" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-370" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-371">400</li><li class="tab-error" role="tab" id="react-tabs-372" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-373">401</li><li class="tab-error" role="tab" id="react-tabs-374" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-375">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-369" aria-labelledby="react-tabs-368"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"action"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extra_info"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ip_address"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"session_id"</span>: <span class="token string">"string"</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-371" aria-labelledby="react-tabs-370"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-373" aria-labelledby="react-tabs-372"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-375" aria-labelledby="react-tabs-374"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1email~1verify/post" data-section-id="tag/users/paths/~1users~1email~1verify/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1email~1verify/post"></a>Verify user email<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Verify the email used by a user to sign-up their account with.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>No permissions required.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="token"><span class="sc-kGXeez bcLONg"></span>token<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The token given to validate the email</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User email verification successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/email/verify</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/email/verify</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/email/verify</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-376" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-377" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-378" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-379">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-377" aria-labelledby="react-tabs-376"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"token"</span>: <span class="token string">"string"</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-379" aria-labelledby="react-tabs-378"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-380" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-381" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-382" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-383">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-381" aria-labelledby="react-tabs-380"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-383" aria-labelledby="react-tabs-382"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1email~1verify~1send/post" data-section-id="tag/users/paths/~1users~1email~1verify~1send/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1email~1verify~1send/post"></a>Send verification email<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Send an email with a verification link to a user that has an email matching the one in the request body. This endpoint will return success even if the email does not match any users on the system.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>No permissions required.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="email"><span class="sc-kGXeez bcLONg"></span>email<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Email of a user</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Email send successful if email exists</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/email/verify/send</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/email/verify/send</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/email/verify/send</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-384" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-385" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-386" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-387">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-385" aria-labelledby="react-tabs-384"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</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-387" aria-labelledby="react-tabs-386"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-388" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-389" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-390" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-391">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-389" aria-labelledby="react-tabs-388"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-391" aria-labelledby="react-tabs-390"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1login~1switch/post" data-section-id="tag/users/paths/~1users~1login~1switch/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1login~1switch/post"></a>Switch login method<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Switch a user's login method from using email to OAuth2/SAML/LDAP or back to email. When switching to OAuth2/SAML, account switching is not complete until the user follows the returned link and completes any steps on the OAuth2/SAML service provider.</p>
|
||
<p>To switch from email to OAuth2/SAML, specify <code>current_service</code>, <code>new_service</code>, <code>email</code> and <code>password</code>.</p>
|
||
<p>To switch from OAuth2/SAML to email, specify <code>current_service</code>, <code>new_service</code>, <code>email</code> and <code>new_password</code>.</p>
|
||
<p>To switch from email to LDAP/AD, specify <code>current_service</code>, <code>new_service</code>, <code>email</code>, <code>password</code>, <code>ldap_ip</code> and <code>new_password</code> (this is the user's LDAP password).</p>
|
||
<p>To switch from LDAP/AD to email, specify <code>current_service</code>, <code>new_service</code>, <code>ldap_ip</code>, <code>password</code> (this is the user's LDAP password), <code>email</code> and <code>new_password</code>.</p>
|
||
<p>Additionally, specify <code>mfa_code</code> when trying to switch an account on LDAP/AD or email that has MFA activated.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>No current authentication required except when switching from OAuth2/SAML to email.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="current_service"><span class="sc-kGXeez bcLONg"></span>current_service<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The service the user currently uses to login</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="new_service"><span class="sc-kGXeez bcLONg"></span>new_service<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The service the user will use to login</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="email"><span class="sc-kGXeez bcLONg"></span>email</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The email of the user</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="password"><span class="sc-kGXeez bcLONg"></span>password</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The password used with the current service</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="mfa_code"><span class="sc-kGXeez bcLONg"></span>mfa_code</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The MFA code of the current service</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="ldap_id"><span class="sc-kGXeez bcLONg"></span>ldap_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The LDAP/AD id of the user</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Login method switch or request successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/login/switch</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/login/switch</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/login/switch</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-392" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-393" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-394" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-395">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-393" aria-labelledby="react-tabs-392"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"current_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"new_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"password"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mfa_code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ldap_id"</span>: <span class="token string">"string"</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-395" aria-labelledby="react-tabs-394"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-396" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-397" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-398" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-399">400</li><li class="tab-error" role="tab" id="react-tabs-400" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-401">401</li><li class="tab-error" role="tab" id="react-tabs-402" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-403">403</li><li class="tab-error" role="tab" id="react-tabs-404" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-405">404</li><li class="tab-error" role="tab" id="react-tabs-406" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-407">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-397" aria-labelledby="react-tabs-396"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"follow_link"</span>: <span class="token string">"string"</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-399" aria-labelledby="react-tabs-398"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-401" aria-labelledby="react-tabs-400"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-403" aria-labelledby="react-tabs-402"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-405" aria-labelledby="react-tabs-404"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-407" aria-labelledby="react-tabs-406"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1tokens/post" data-section-id="tag/users/paths/~1users~1{user_id}~1tokens/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1tokens/post"></a>Create a user access token<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Generate a user access token that can be used to authenticate with the Mattermost REST API.</p>
|
||
<p><strong>Minimum server version</strong>: 4.1</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>create_user_access_token</code> permission. For non-self requests, must also have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="description"><span class="sc-kGXeez bcLONg"></span>description<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A description of the token usage</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User access token creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/tokens</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/tokens</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/tokens</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-408" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-409" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-410" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-411">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-409" aria-labelledby="react-tabs-408"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</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-411" aria-labelledby="react-tabs-410"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-412" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-413" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-414" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-415">400</li><li class="tab-error" role="tab" id="react-tabs-416" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-417">401</li><li class="tab-error" role="tab" id="react-tabs-418" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-419">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-413" aria-labelledby="react-tabs-412"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</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-415" aria-labelledby="react-tabs-414"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-417" aria-labelledby="react-tabs-416"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-419" aria-labelledby="react-tabs-418"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1tokens/get" data-section-id="tag/users/paths/~1users~1{user_id}~1tokens/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1tokens/get"></a>Get user access tokens<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of user access tokens for a user. Does not include the actual authentication tokens. Use query parameters for paging.</p>
|
||
<p><strong>Minimum server version</strong>: 4.1</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_user_access_token</code> permission. For non-self requests, must also have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of tokens per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User access tokens retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/tokens</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/tokens</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/tokens</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-420" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-421" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-421" aria-labelledby="react-tabs-420"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"adWv1qPZmHdtxk7Lmqh6RtxWxS"</span>
|
||
|
||
tokens<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetUserAccessTokensForUser</span><span class="token punctuation">(</span>userID<span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">100</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-422" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-423" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-424" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-425">400</li><li class="tab-error" role="tab" id="react-tabs-426" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-427">401</li><li class="tab-error" role="tab" id="react-tabs-428" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-429">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-423" aria-labelledby="react-tabs-422"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"is_active"</span>: <span class="token boolean">true</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-425" aria-labelledby="react-tabs-424"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-427" aria-labelledby="react-tabs-426"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-429" aria-labelledby="react-tabs-428"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1tokens/get" data-section-id="tag/users/paths/~1users~1tokens/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1tokens/get"></a>Get user access tokens<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of user access tokens for users on the system. Does not include the actual authentication tokens. Use query parameters for paging.</p>
|
||
<p><strong>Minimum server version</strong>: 4.7</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of tokens per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User access tokens retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/tokens</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/tokens</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/tokens</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-430" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-431" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-431" aria-labelledby="react-tabs-430"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
tokens<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetUserAccessTokens</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">100</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-432" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-433" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-434" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-435">400</li><li class="tab-error" role="tab" id="react-tabs-436" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-437">401</li><li class="tab-error" role="tab" id="react-tabs-438" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-439">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-433" aria-labelledby="react-tabs-432"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"is_active"</span>: <span class="token boolean">true</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-435" aria-labelledby="react-tabs-434"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-437" aria-labelledby="react-tabs-436"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-439" aria-labelledby="react-tabs-438"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1tokens~1revoke/post" data-section-id="tag/users/paths/~1users~1tokens~1revoke/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1tokens~1revoke/post"></a>Revoke a user access token<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Revoke a user access token and delete any sessions using the token.</p>
|
||
<p><strong>Minimum server version</strong>: 4.1</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>revoke_user_access_token</code> permission. For non-self requests, must also have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="token_id"><span class="sc-kGXeez bcLONg"></span>token_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The user access token GUID to revoke</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User access token revoke successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/tokens/revoke</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/tokens/revoke</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/tokens/revoke</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-440" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-441" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-442" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-443">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-441" aria-labelledby="react-tabs-440"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"token_id"</span>: <span class="token string">"string"</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-443" aria-labelledby="react-tabs-442"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-444" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-445" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-446" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-447">400</li><li class="tab-error" role="tab" id="react-tabs-448" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-449">401</li><li class="tab-error" role="tab" id="react-tabs-450" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-451">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-445" aria-labelledby="react-tabs-444"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-447" aria-labelledby="react-tabs-446"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-449" aria-labelledby="react-tabs-448"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-451" aria-labelledby="react-tabs-450"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1tokens~1{token_id}/get" data-section-id="tag/users/paths/~1users~1tokens~1{token_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1tokens~1{token_id}/get"></a>Get a user access token<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a user access token. Does not include the actual authentication token.</p>
|
||
<p><strong>Minimum server version</strong>: 4.1</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_user_access_token</code> permission. For non-self requests, must also have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="token_id"><span class="sc-kGXeez bcLONg"></span>token_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User access token GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User access token retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/tokens/{token_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/tokens/{token_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/tokens/{token_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-452" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-453" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-453" aria-labelledby="react-tabs-452"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
tokenID <span class="token operator">:=</span> <span class="token string">"adWv1qPZmHdtxk7Lmqh6RtxWxS"</span>
|
||
|
||
token<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetUserAccessToken</span><span class="token punctuation">(</span>tokenID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-454" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-455" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-456" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-457">400</li><li class="tab-error" role="tab" id="react-tabs-458" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-459">401</li><li class="tab-error" role="tab" id="react-tabs-460" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-461">403</li><li class="tab-error" role="tab" id="react-tabs-462" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-463">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-455" aria-labelledby="react-tabs-454"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_active"</span>: <span class="token boolean">true</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-457" aria-labelledby="react-tabs-456"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-459" aria-labelledby="react-tabs-458"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-461" aria-labelledby="react-tabs-460"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-463" aria-labelledby="react-tabs-462"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1tokens~1disable/post" data-section-id="tag/users/paths/~1users~1tokens~1disable/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1tokens~1disable/post"></a>Disable personal access token<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Disable a personal access token and delete any sessions using the token. The token can be re-enabled using <code>/users/tokens/enable</code>.</p>
|
||
<p><strong>Minimum server version</strong>: 4.4</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>revoke_user_access_token</code> permission. For non-self requests, must also have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="token_id"><span class="sc-kGXeez bcLONg"></span>token_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The personal access token GUID to disable</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Personal access token disable successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/tokens/disable</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/tokens/disable</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/tokens/disable</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-464" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-465" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-466" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-467">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-465" aria-labelledby="react-tabs-464"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"token_id"</span>: <span class="token string">"string"</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-467" aria-labelledby="react-tabs-466"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-468" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-469" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-470" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-471">400</li><li class="tab-error" role="tab" id="react-tabs-472" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-473">401</li><li class="tab-error" role="tab" id="react-tabs-474" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-475">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-469" aria-labelledby="react-tabs-468"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-471" aria-labelledby="react-tabs-470"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-473" aria-labelledby="react-tabs-472"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-475" aria-labelledby="react-tabs-474"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1tokens~1enable/post" data-section-id="tag/users/paths/~1users~1tokens~1enable/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1tokens~1enable/post"></a>Enable personal access token<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Re-enable a personal access token that has been disabled.</p>
|
||
<p><strong>Minimum server version</strong>: 4.4</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>create_user_access_token</code> permission. For non-self requests, must also have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="token_id"><span class="sc-kGXeez bcLONg"></span>token_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The personal access token GUID to enable</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Personal access token enable successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/tokens/enable</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/tokens/enable</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/tokens/enable</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-476" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-477" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-478" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-479">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-477" aria-labelledby="react-tabs-476"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"token_id"</span>: <span class="token string">"string"</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-479" aria-labelledby="react-tabs-478"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-480" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-481" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-482" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-483">400</li><li class="tab-error" role="tab" id="react-tabs-484" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-485">401</li><li class="tab-error" role="tab" id="react-tabs-486" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-487">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-481" aria-labelledby="react-tabs-480"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-483" aria-labelledby="react-tabs-482"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-485" aria-labelledby="react-tabs-484"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-487" aria-labelledby="react-tabs-486"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1tokens~1search/post" data-section-id="tag/users/paths/~1users~1tokens~1search/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1tokens~1search/post"></a>Search tokens<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of tokens based on search criteria provided in the request body. Searches are done against the token id, user id and username.</p>
|
||
<p><strong>Minimum server version</strong>: 4.7</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Search criteria</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="term"><span class="sc-kGXeez bcLONg"></span>term<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The search term to match against the token id, user id or username.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Personal access token search successful</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/tokens/search</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/tokens/search</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/tokens/search</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-488" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-489" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-490" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-491">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-489" aria-labelledby="react-tabs-488"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"term"</span>: <span class="token string">"string"</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-491" aria-labelledby="react-tabs-490"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-492" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-493" tabindex="0">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-493" aria-labelledby="react-tabs-492"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"is_active"</span>: <span class="token boolean">true</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/users/paths/~1users~1{user_id}~1auth/put" data-section-id="tag/users/paths/~1users~1{user_id}~1auth/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1auth/put"></a>Update a user's authentication method<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Updates a user's authentication method. This can be used to change them to/from LDAP authentication for example.</p>
|
||
<p><strong>Minimum server version</strong>: 4.6</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="auth_data"><span class="sc-kGXeez bcLONg"></span>auth_data</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Service-specific authentication data</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="auth_service"><span class="sc-kGXeez bcLONg"></span>auth_service</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The authentication service such as "email", "gitlab", or "ldap"</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="password"><span class="sc-kGXeez bcLONg"></span>password</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The password used for email authentication</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User auth update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/auth</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/auth</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/auth</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-494" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-495" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-496" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-497">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-495" aria-labelledby="react-tabs-494"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"auth_data"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"password"</span>: <span class="token string">"string"</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-497" aria-labelledby="react-tabs-496"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-498" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-499" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-500" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-501">400</li><li class="tab-error" role="tab" id="react-tabs-502" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-503">401</li><li class="tab-error" role="tab" id="react-tabs-504" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-505">403</li><li class="tab-error" role="tab" id="react-tabs-506" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-507">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-499" aria-labelledby="react-tabs-498"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"auth_data"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"password"</span>: <span class="token string">"string"</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-501" aria-labelledby="react-tabs-500"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-503" aria-labelledby="react-tabs-502"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-505" aria-labelledby="react-tabs-504"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-507" aria-labelledby="react-tabs-506"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1terms_of_service/post" data-section-id="tag/users/paths/~1users~1{user_id}~1terms_of_service/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1terms_of_service/post"></a>Records user action when they accept or decline custom terms of service<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Records user action when they accept or decline custom terms of service. Records the action in audit table.
|
||
Updates user's last accepted terms of service ID if they accepted it.</p>
|
||
<p><strong>Minimum server version</strong>: 5.4</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being acted on.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>terms of service details</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="serviceTermsId"><span class="sc-kGXeez bcLONg"></span>serviceTermsId<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>terms of service ID on which the user is acting on</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="accepted"><span class="sc-kGXeez bcLONg"></span>accepted<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>true or false, indicates whether the user accepted or rejected the terms of service.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Terms of service action recorded successfully</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/terms_of_service</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/terms_of_service</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/terms_of_service</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-508" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-509" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-510" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-511">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-509" aria-labelledby="react-tabs-508"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"serviceTermsId"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"accepted"</span>: <span class="token string">"string"</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-511" aria-labelledby="react-tabs-510"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-512" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-513" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-514" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-515">400</li><li class="tab-error" role="tab" id="react-tabs-516" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-517">401</li><li class="tab-error" role="tab" id="react-tabs-518" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-519">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-513" aria-labelledby="react-tabs-512"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-515" aria-labelledby="react-tabs-514"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-517" aria-labelledby="react-tabs-516"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-519" aria-labelledby="react-tabs-518"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1{user_id}~1terms_of_service/get" data-section-id="tag/users/paths/~1users~1{user_id}~1terms_of_service/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1{user_id}~1terms_of_service/get"></a>Fetches user's latest terms of service action if the latest action was for acceptance.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Will be deprecated in v6.0
|
||
Fetches user's latest terms of service action if the latest action was for acceptance.</p>
|
||
<p><strong>Minimum server version</strong>: 5.6</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being acted on.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User's accepted terms of service action</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User hasn't performed an action or the latest action was a rejection.</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/terms_of_service</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/terms_of_service</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/terms_of_service</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-520" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-521" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-521" aria-labelledby="react-tabs-520"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"adWv1qPZmHdtxk7Lmqh6RtxWxS"</span>
|
||
|
||
userTermsOfService<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetUserTermsOfService</span><span class="token punctuation">(</span>userID<span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-522" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-523" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-524" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-525">400</li><li class="tab-error" role="tab" id="react-tabs-526" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-527">401</li><li class="tab-error" role="tab" id="react-tabs-528" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-529">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-523" aria-labelledby="react-tabs-522"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"terms_of_service_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</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-525" aria-labelledby="react-tabs-524"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-527" aria-labelledby="react-tabs-526"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-529" aria-labelledby="react-tabs-528"></div></div></div></div></div></div><div id="tag/users/paths/~1users~1sessions~1revoke~1all/post" data-section-id="tag/users/paths/~1users~1sessions~1revoke~1all/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/users/paths/~1users~1sessions~1revoke~1all/post"></a>Revoke all sessions from all users.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>For any session currently on the server (including admin) it will be revoked.
|
||
Clients will be notified to log out users.</p>
|
||
<p><strong>Minimum server version</strong>: 5.14</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT hLVzSF"><strong>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Sessions successfully revoked.</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/sessions/revoke/all</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/sessions/revoke/all</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/sessions/revoke/all</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-530" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-531" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-531" aria-labelledby="react-tabs-530"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
response<span class="token punctuation">,</span> err <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">RevokeSessionsFromAllUsers</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-532" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-533" tabindex="0">401</li><li class="tab-error" role="tab" id="react-tabs-534" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-535">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-533" aria-labelledby="react-tabs-532"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-535" aria-labelledby="react-tabs-534"></div></div></div></div></div></div><div id="tag/bots" data-section-id="tag/bots" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/bots"></a>bots</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for creating, getting and updating bot users.</p>
|
||
</div></div></div><div id="tag/bots/paths/~1bots/post" data-section-id="tag/bots/paths/~1bots/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/bots/paths/~1bots/post"></a>Create a bot<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Create a new bot account on the system. Username is required.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>create_bot</code> permission.
|
||
<strong>Minimum server version</strong>: 5.10</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Bot to be created</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="username"><span class="sc-kGXeez bcLONg"></span>username<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="display_name"><span class="sc-kGXeez bcLONg"></span>display_name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="description"><span class="sc-kGXeez bcLONg"></span>description</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Bot creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/bots</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/bots</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/bots</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-536" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-537" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-537" aria-labelledby="react-tabs-536"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-538" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-539" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-540" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-541">400</li><li class="tab-error" role="tab" id="react-tabs-542" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-543">401</li><li class="tab-error" role="tab" id="react-tabs-544" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-545">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-539" aria-labelledby="react-tabs-538"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner_id"</span>: <span class="token string">"string"</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-541" aria-labelledby="react-tabs-540"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-543" aria-labelledby="react-tabs-542"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-545" aria-labelledby="react-tabs-544"></div></div></div></div></div></div><div id="tag/bots/paths/~1bots/get" data-section-id="tag/bots/paths/~1bots/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/bots/paths/~1bots/get"></a>Get bots<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of a list of bots.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_bots</code> permission for bots you are managing, and <code>read_others_bots</code> permission for bots others are managing.
|
||
<strong>Minimum server version</strong>: 5.10</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of users per page. There is a maximum limit of 200 users per page.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="include_deleted"><span class="sc-kGXeez bcLONg"></span>include_deleted</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>If deleted bots should be returned.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="only_orphaned"><span class="sc-kGXeez bcLONg"></span>only_orphaned</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>When true, only orphaned bots will be returned. A bot is consitered orphaned if it's owner has been deactivated.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Bot page retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/bots</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/bots</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/bots</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-546" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-547" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-548" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-549">400</li><li class="tab-error" role="tab" id="react-tabs-550" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-551">401</li><li class="tab-error" role="tab" id="react-tabs-552" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-553">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-547" aria-labelledby="react-tabs-546"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"owner_id"</span>: <span class="token string">"string"</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-549" aria-labelledby="react-tabs-548"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-551" aria-labelledby="react-tabs-550"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-553" aria-labelledby="react-tabs-552"></div></div></div></div></div></div><div id="tag/bots/paths/~1bots~1{bot_user_id}/put" data-section-id="tag/bots/paths/~1bots~1{bot_user_id}/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/bots/paths/~1bots~1{bot_user_id}/put"></a>Patch a bot<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Partially update a bot by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_bots</code> permission.
|
||
<strong>Minimum server version</strong>: 5.10</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="bot_user_id"><span class="sc-kGXeez bcLONg"></span>bot_user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Bot user ID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Bot to be created</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="username"><span class="sc-kGXeez bcLONg"></span>username<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="display_name"><span class="sc-kGXeez bcLONg"></span>display_name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="description"><span class="sc-kGXeez bcLONg"></span>description</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Bot patch successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/bots/{bot_user_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/bots/{bot_user_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/bots/{bot_user_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-554" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-555" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-555" aria-labelledby="react-tabs-554"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-556" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-557" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-558" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-559">400</li><li class="tab-error" role="tab" id="react-tabs-560" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-561">401</li><li class="tab-error" role="tab" id="react-tabs-562" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-563">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-557" aria-labelledby="react-tabs-556"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner_id"</span>: <span class="token string">"string"</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-559" aria-labelledby="react-tabs-558"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-561" aria-labelledby="react-tabs-560"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-563" aria-labelledby="react-tabs-562"></div></div></div></div></div></div><div id="tag/bots/paths/~1bots~1{bot_user_id}/get" data-section-id="tag/bots/paths/~1bots~1{bot_user_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/bots/paths/~1bots~1{bot_user_id}/get"></a>Get a bot<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a bot specified by its bot id.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_bots</code> permission for bots you are managing, and <code>read_others_bots</code> permission for bots others are managing.
|
||
<strong>Minimum server version</strong>: 5.10</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="bot_user_id"><span class="sc-kGXeez bcLONg"></span>bot_user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Bot user ID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="include_deleted"><span class="sc-kGXeez bcLONg"></span>include_deleted</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>If deleted bots should be returned.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Bot successfully retrieved.</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/bots/{bot_user_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/bots/{bot_user_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/bots/{bot_user_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-564" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-565" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-566" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-567">400</li><li class="tab-error" role="tab" id="react-tabs-568" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-569">401</li><li class="tab-error" role="tab" id="react-tabs-570" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-571">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-565" aria-labelledby="react-tabs-564"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner_id"</span>: <span class="token string">"string"</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-567" aria-labelledby="react-tabs-566"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-569" aria-labelledby="react-tabs-568"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-571" aria-labelledby="react-tabs-570"></div></div></div></div></div></div><div id="tag/bots/paths/~1bots~1{bot_user_id}~1disable/post" data-section-id="tag/bots/paths/~1bots~1{bot_user_id}~1disable/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/bots/paths/~1bots~1{bot_user_id}~1disable/post"></a>Disable a bot<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Disable a bot.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_bots</code> permission.
|
||
<strong>Minimum server version</strong>: 5.10</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="bot_user_id"><span class="sc-kGXeez bcLONg"></span>bot_user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Bot user ID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Bot successfully disabled.</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/bots/{bot_user_id}/disable</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/bots/{bot_user_id}/disable</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/bots/{bot_user_id}/disable</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-572" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-573" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-574" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-575">400</li><li class="tab-error" role="tab" id="react-tabs-576" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-577">401</li><li class="tab-error" role="tab" id="react-tabs-578" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-579">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-573" aria-labelledby="react-tabs-572"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner_id"</span>: <span class="token string">"string"</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-575" aria-labelledby="react-tabs-574"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-577" aria-labelledby="react-tabs-576"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-579" aria-labelledby="react-tabs-578"></div></div></div></div></div></div><div id="tag/bots/paths/~1bots~1{bot_user_id}~1enable/post" data-section-id="tag/bots/paths/~1bots~1{bot_user_id}~1enable/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/bots/paths/~1bots~1{bot_user_id}~1enable/post"></a>Enable a bot<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Enable a bot.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_bots</code> permission.
|
||
<strong>Minimum server version</strong>: 5.10</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="bot_user_id"><span class="sc-kGXeez bcLONg"></span>bot_user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Bot user ID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Bot successfully enabled.</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/bots/{bot_user_id}/enable</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/bots/{bot_user_id}/enable</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/bots/{bot_user_id}/enable</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-580" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-581" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-582" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-583">400</li><li class="tab-error" role="tab" id="react-tabs-584" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-585">401</li><li class="tab-error" role="tab" id="react-tabs-586" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-587">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-581" aria-labelledby="react-tabs-580"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner_id"</span>: <span class="token string">"string"</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-583" aria-labelledby="react-tabs-582"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-585" aria-labelledby="react-tabs-584"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-587" aria-labelledby="react-tabs-586"></div></div></div></div></div></div><div id="tag/bots/paths/~1bots~1{bot_user_id}~1assign~1{user_id}/post" data-section-id="tag/bots/paths/~1bots~1{bot_user_id}~1assign~1{user_id}/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/bots/paths/~1bots~1{bot_user_id}~1assign~1{user_id}/post"></a>Assign a bot to a user<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Assign a bot to a specified user.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_bots</code> permission.
|
||
<strong>Minimum server version</strong>: 5.10</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="bot_user_id"><span class="sc-kGXeez bcLONg"></span>bot_user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Bot user ID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The user ID to assign the bot to.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Bot successfully assigned.</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/bots/{bot_user_id}/assign/{user_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/bots/{bot_user_id}/assign/{user_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/bots/{bot_user_id}/assign/{user_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-588" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-589" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-590" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-591">400</li><li class="tab-error" role="tab" id="react-tabs-592" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-593">401</li><li class="tab-error" role="tab" id="react-tabs-594" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-595">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-589" aria-labelledby="react-tabs-588"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner_id"</span>: <span class="token string">"string"</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-591" aria-labelledby="react-tabs-590"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-593" aria-labelledby="react-tabs-592"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-595" aria-labelledby="react-tabs-594"></div></div></div></div></div></div><div id="tag/bots/paths/~1bots~1{bot_user_id}~1icon/get" data-section-id="tag/bots/paths/~1bots~1{bot_user_id}~1icon/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/bots/paths/~1bots~1{bot_user_id}~1icon/get"></a>Get bot's LHS icon<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a bot's LHS icon image based on bot_user_id string parameter.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in.
|
||
<strong>Minimum server version</strong>: 5.14</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="bot_user_id"><span class="sc-kGXeez bcLONg"></span>bot_user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Bot user ID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT hLVzSF"><strong>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Bot's LHS icon image</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/bots/{bot_user_id}/icon</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/bots/{bot_user_id}/icon</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/bots/{bot_user_id}/icon</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-596" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-597" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-597" aria-labelledby="react-tabs-596"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
botUserID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
data<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetBotIconImage</span><span class="token punctuation">(</span>botUserID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-598" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-599" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-600" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-601">401</li><li class="tab-error" role="tab" id="react-tabs-602" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-603">403</li><li class="tab-error" role="tab" id="react-tabs-604" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-605">404</li><li class="tab-error" role="tab" id="react-tabs-606" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-607">500</li><li class="tab-error" role="tab" id="react-tabs-608" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-609">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-599" aria-labelledby="react-tabs-598"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-601" aria-labelledby="react-tabs-600"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-603" aria-labelledby="react-tabs-602"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-605" aria-labelledby="react-tabs-604"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-607" aria-labelledby="react-tabs-606"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-609" aria-labelledby="react-tabs-608"></div></div></div></div></div></div><div id="tag/bots/paths/~1bots~1{bot_user_id}~1icon/post" data-section-id="tag/bots/paths/~1bots~1{bot_user_id}~1icon/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/bots/paths/~1bots~1{bot_user_id}~1icon/post"></a>Set bot's LHS icon image<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Set a bot's LHS icon image based on bot_user_id string parameter. Icon image must be SVG format, all other formats are rejected.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_bots</code> permission.
|
||
<strong>Minimum server version</strong>: 5.14</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="bot_user_id"><span class="sc-kGXeez bcLONg"></span>bot_user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Bot user ID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">multipart/form-data</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="image"><span class="sc-kGXeez bcLONg"></span>image<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span><span class="sc-cHGsZl sc-kgAjT hqYVjx"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>SVG icon image to be uploaded</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>SVG icon image set successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>413<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Content too large</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/bots/{bot_user_id}/icon</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/bots/{bot_user_id}/icon</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/bots/{bot_user_id}/icon</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-610" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-611" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-611" aria-labelledby="react-tabs-610"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token punctuation">(</span>
|
||
<span class="token string">"io/ioutil"</span>
|
||
<span class="token string">"log"</span>
|
||
|
||
<span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
<span class="token punctuation">)</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
data<span class="token punctuation">,</span> err <span class="token operator">:=</span> ioutil<span class="token punctuation">.</span><span class="token function">ReadFile</span><span class="token punctuation">(</span><span class="token string">"icon_image.svg"</span><span class="token punctuation">)</span>
|
||
<span class="token keyword">if</span> err <span class="token operator">!=</span> <span class="token boolean">nil</span> <span class="token punctuation">{</span>
|
||
log<span class="token punctuation">.</span><span class="token function">Fatal</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span>
|
||
<span class="token punctuation">}</span>
|
||
|
||
botUserID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">SetBotIconImage</span><span class="token punctuation">(</span>botUserID<span class="token punctuation">,</span> data<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-612" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-613" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-614" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-615">400</li><li class="tab-error" role="tab" id="react-tabs-616" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-617">401</li><li class="tab-error" role="tab" id="react-tabs-618" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-619">403</li><li class="tab-error" role="tab" id="react-tabs-620" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-621">413</li><li class="tab-error" role="tab" id="react-tabs-622" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-623">500</li><li class="tab-error" role="tab" id="react-tabs-624" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-625">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-613" aria-labelledby="react-tabs-612"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-615" aria-labelledby="react-tabs-614"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-617" aria-labelledby="react-tabs-616"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-619" aria-labelledby="react-tabs-618"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-621" aria-labelledby="react-tabs-620"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-623" aria-labelledby="react-tabs-622"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-625" aria-labelledby="react-tabs-624"></div></div></div></div></div></div><div id="tag/bots/paths/~1bots~1{bot_user_id}~1icon/delete" data-section-id="tag/bots/paths/~1bots~1{bot_user_id}~1icon/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/bots/paths/~1bots~1{bot_user_id}~1icon/delete"></a>Delete bot's LHS icon image<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Delete bot's LHS icon image based on bot_user_id string parameter.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_bots</code> permission.
|
||
<strong>Minimum server version</strong>: 5.14</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="bot_user_id"><span class="sc-kGXeez bcLONg"></span>bot_user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Bot user ID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Icon image deletion successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/bots/{bot_user_id}/icon</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/bots/{bot_user_id}/icon</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/bots/{bot_user_id}/icon</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-626" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-627" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-627" aria-labelledby="react-tabs-626"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
botUserID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">DeleteBotIconImage</span><span class="token punctuation">(</span>botUserID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-628" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-629" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-630" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-631">400</li><li class="tab-error" role="tab" id="react-tabs-632" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-633">401</li><li class="tab-error" role="tab" id="react-tabs-634" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-635">403</li><li class="tab-error" role="tab" id="react-tabs-636" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-637">404</li><li class="tab-error" role="tab" id="react-tabs-638" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-639">500</li><li class="tab-error" role="tab" id="react-tabs-640" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-641">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-629" aria-labelledby="react-tabs-628"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-631" aria-labelledby="react-tabs-630"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-633" aria-labelledby="react-tabs-632"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-635" aria-labelledby="react-tabs-634"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-637" aria-labelledby="react-tabs-636"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-639" aria-labelledby="react-tabs-638"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-641" aria-labelledby="react-tabs-640"></div></div></div></div></div></div><div id="tag/teams" data-section-id="tag/teams" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/teams"></a>teams</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for creating, getting and interacting with teams.</p>
|
||
</div></div></div><div id="tag/teams/paths/~1teams/post" data-section-id="tag/teams/paths/~1teams/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams/post"></a>Create a team<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Create a new team on the system.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and have the <code>create_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Team that is to be created</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Unique handler for a team, will be present in the team URL</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="display_name"><span class="sc-kGXeez bcLONg"></span>display_name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Non-unique UI name for the team</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="type"><span class="sc-kGXeez bcLONg"></span>type<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p><code>'O'</code> for open, <code>'I'</code> for invite only</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/teams</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-642" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-643" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-644" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-645">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-643" aria-labelledby="react-tabs-642"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</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-645" aria-labelledby="react-tabs-644"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-646" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-647" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-648" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-649">400</li><li class="tab-error" role="tab" id="react-tabs-650" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-651">401</li><li class="tab-error" role="tab" id="react-tabs-652" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-653">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-647" aria-labelledby="react-tabs-646"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allowed_domains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow_open_invite"</span>: <span class="token boolean">true</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-649" aria-labelledby="react-tabs-648"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-651" aria-labelledby="react-tabs-650"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-653" aria-labelledby="react-tabs-652"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams/get" data-section-id="tag/teams/paths/~1teams/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams/get"></a>Get teams<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>For regular users only returns open teams. Users with the "manage_system" permission will return teams regardless of type. The result is based on query string parameters - page and per_page.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated. "manage_system" permission is required to show all teams.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of teams per page.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="include_total_count"><span class="sc-kGXeez bcLONg"></span>include_total_count</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">false</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-654" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-655" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-655" aria-labelledby="react-tabs-654"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
teams<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetAllTeams</span><span class="token punctuation">(</span><span class="token string">""</span><span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">100</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-656" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-657" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-658" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-659">400</li><li class="tab-error" role="tab" id="react-tabs-660" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-661">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-657" aria-labelledby="react-tabs-656"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"allowed_domains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"invite_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"allow_open_invite"</span>: <span class="token boolean">true</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-659" aria-labelledby="react-tabs-658"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-661" aria-labelledby="react-tabs-660"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}/get" data-section-id="tag/teams/paths/~1teams~1{team_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}/get"></a>Get a team<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a team on the system.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and have the <code>view_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-662" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-663" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-663" aria-labelledby="react-tabs-662"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
teamID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
t<span class="token punctuation">,</span> err <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetTeam</span><span class="token punctuation">(</span>teamID<span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-664" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-665" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-666" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-667">400</li><li class="tab-error" role="tab" id="react-tabs-668" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-669">401</li><li class="tab-error" role="tab" id="react-tabs-670" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-671">403</li><li class="tab-error" role="tab" id="react-tabs-672" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-673">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-665" aria-labelledby="react-tabs-664"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allowed_domains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow_open_invite"</span>: <span class="token boolean">true</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-667" aria-labelledby="react-tabs-666"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-669" aria-labelledby="react-tabs-668"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-671" aria-labelledby="react-tabs-670"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-673" aria-labelledby="react-tabs-672"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}/put" data-section-id="tag/teams/paths/~1teams~1{team_id}/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}/put"></a>Update a team<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update a team by providing the team object. The fields that can be updated are defined in the request body, all other provided fields will be ignored.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have the <code>manage_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Team to update</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="id"><span class="sc-kGXeez bcLONg"></span>id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="display_name"><span class="sc-kGXeez bcLONg"></span>display_name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="description"><span class="sc-kGXeez bcLONg"></span>description<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="company_name"><span class="sc-kGXeez bcLONg"></span>company_name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="allowed_domains"><span class="sc-kGXeez bcLONg"></span>allowed_domains<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="invite_id"><span class="sc-kGXeez bcLONg"></span>invite_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="allow_open_invite"><span class="sc-kGXeez bcLONg"></span>allow_open_invite<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-674" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-675" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-676" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-677">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-675" aria-labelledby="react-tabs-674"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"company_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allowed_domains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow_open_invite"</span>: <span class="token string">"string"</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-677" aria-labelledby="react-tabs-676"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-678" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-679" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-680" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-681">400</li><li class="tab-error" role="tab" id="react-tabs-682" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-683">401</li><li class="tab-error" role="tab" id="react-tabs-684" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-685">403</li><li class="tab-error" role="tab" id="react-tabs-686" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-687">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-679" aria-labelledby="react-tabs-678"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allowed_domains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow_open_invite"</span>: <span class="token boolean">true</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-681" aria-labelledby="react-tabs-680"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-683" aria-labelledby="react-tabs-682"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-685" aria-labelledby="react-tabs-684"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-687" aria-labelledby="react-tabs-686"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}/delete" data-section-id="tag/teams/paths/~1teams~1{team_id}/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}/delete"></a>Delete a team<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Soft deletes a team, by marking the team as deleted in the database. Soft deleted teams will not be accessible in the user interface.</p>
|
||
<p>Optionally use the permanent query parameter to hard delete the team for compliance reasons. As of server version 5.0, to use this feature <code>ServiceSettings.EnableAPITeamDeletion</code> must be set to <code>true</code> in the server's configuration.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have the <code>manage_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="permanent"><span class="sc-kGXeez bcLONg"></span>permanent</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">false</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Permanently delete the team, to be used for compliance reasons only. As of server version 5.0, <code>ServiceSettings.EnableAPITeamDeletion</code> must be set to <code>true</code> in the server's configuration.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team deletion successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-688" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-689" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-689" aria-labelledby="react-tabs-688"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
teamID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
<span class="token comment">// Non-permanent deletion</span>
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">SoftDeleteTeam</span><span class="token punctuation">(</span><span class="token operator">&</span>model<span class="token punctuation">.</span>Team<span class="token punctuation">{</span>Id<span class="token punctuation">:</span> teamID<span class="token punctuation">}</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// Permanent deletion</span>
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">PermanentDeleteTeam</span><span class="token punctuation">(</span><span class="token operator">&</span>model<span class="token punctuation">.</span>Team<span class="token punctuation">{</span>Id<span class="token punctuation">:</span> teamID<span class="token punctuation">}</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-690" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-691" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-692" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-693">400</li><li class="tab-error" role="tab" id="react-tabs-694" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-695">401</li><li class="tab-error" role="tab" id="react-tabs-696" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-697">403</li><li class="tab-error" role="tab" id="react-tabs-698" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-699">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-691" aria-labelledby="react-tabs-690"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-693" aria-labelledby="react-tabs-692"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-695" aria-labelledby="react-tabs-694"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-697" aria-labelledby="react-tabs-696"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-699" aria-labelledby="react-tabs-698"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1patch/put" data-section-id="tag/teams/paths/~1teams~1{team_id}~1patch/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1patch/put"></a>Patch a team<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Partially update a team by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have the <code>manage_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Team object that is to be updated</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="display_name"><span class="sc-kGXeez bcLONg"></span>display_name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="description"><span class="sc-kGXeez bcLONg"></span>description</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="company_name"><span class="sc-kGXeez bcLONg"></span>company_name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="invite_id"><span class="sc-kGXeez bcLONg"></span>invite_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="allow_open_invite"><span class="sc-kGXeez bcLONg"></span>allow_open_invite</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>team patch successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/patch</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/patch</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/patch</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-700" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-701" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-702" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-703">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-701" aria-labelledby="react-tabs-700"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"company_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow_open_invite"</span>: <span class="token boolean">true</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-703" aria-labelledby="react-tabs-702"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-704" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-705" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-706" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-707">400</li><li class="tab-error" role="tab" id="react-tabs-708" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-709">401</li><li class="tab-error" role="tab" id="react-tabs-710" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-711">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-705" aria-labelledby="react-tabs-704"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allowed_domains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow_open_invite"</span>: <span class="token boolean">true</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-707" aria-labelledby="react-tabs-706"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-709" aria-labelledby="react-tabs-708"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-711" aria-labelledby="react-tabs-710"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1name~1{name}/get" data-section-id="tag/teams/paths/~1teams~1name~1{name}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1name~1{name}/get"></a>Get a team by name<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a team based on provided name string</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated, team type is open and have the <code>view_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team Name</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/name/{name}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/name/{name}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/name/{name}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-712" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-713" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-713" aria-labelledby="react-tabs-712"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
team<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetTeamByName</span><span class="token punctuation">(</span><span class="token string">"teamName"</span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-714" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-715" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-716" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-717">400</li><li class="tab-error" role="tab" id="react-tabs-718" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-719">401</li><li class="tab-error" role="tab" id="react-tabs-720" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-721">403</li><li class="tab-error" role="tab" id="react-tabs-722" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-723">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-715" aria-labelledby="react-tabs-714"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allowed_domains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow_open_invite"</span>: <span class="token boolean">true</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-717" aria-labelledby="react-tabs-716"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-719" aria-labelledby="react-tabs-718"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-721" aria-labelledby="react-tabs-720"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-723" aria-labelledby="react-tabs-722"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1search/post" data-section-id="tag/teams/paths/~1teams~1search/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1search/post"></a>Search teams<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Search teams based on search term provided in the request body.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Logged in user only shows open teams
|
||
Logged in user with "manage_system" permission shows all teams</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Search criteria</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="term"><span class="sc-kGXeez bcLONg"></span>term<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The search term to match against the name or display name of teams</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page number to return, if paginated. If this parameter is not present with the <code>per_page</code> parameter then the results will be returned un-paged.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of entries to return per page, if paginated. If this parameter is not present with the <code>page</code> parameter then the results will be returned un-paged.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Paginated teams response. (Note that the non-paginated response—returned if the request body does not contain both <code>page</code> and <code>per_page</code> fields—is a simple array of teams.)</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/teams/search</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/search</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/search</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-724" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-725" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-726" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-727">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-725" aria-labelledby="react-tabs-724"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"term"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"page"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"per_page"</span>: <span class="token string">"string"</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-727" aria-labelledby="react-tabs-726"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-728" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-729" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-730" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-731">400</li><li class="tab-error" role="tab" id="react-tabs-732" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-733">401</li><li class="tab-error" role="tab" id="react-tabs-734" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-735">403</li><li class="tab-error" role="tab" id="react-tabs-736" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-737">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-729" aria-labelledby="react-tabs-728"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"teams"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"allowed_domains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"invite_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"allow_open_invite"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</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">"total_count"</span>: <span class="token number">0</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-731" aria-labelledby="react-tabs-730"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-733" aria-labelledby="react-tabs-732"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-735" aria-labelledby="react-tabs-734"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-737" aria-labelledby="react-tabs-736"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1name~1{name}~1exists/get" data-section-id="tag/teams/paths/~1teams~1name~1{name}~1exists/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1name~1{name}~1exists/get"></a>Check if team exists<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Check if the team exists based on a team name.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team Name</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/name/{name}/exists</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/name/{name}/exists</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/name/{name}/exists</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-738" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-739" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-739" aria-labelledby="react-tabs-738"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
exists<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">TeamExists</span><span class="token punctuation">(</span><span class="token string">"teamName"</span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-740" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-741" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-742" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-743">400</li><li class="tab-error" role="tab" id="react-tabs-744" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-745">401</li><li class="tab-error" role="tab" id="react-tabs-746" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-747">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-741" aria-labelledby="react-tabs-740"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"exists"</span>: <span class="token boolean">true</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-743" aria-labelledby="react-tabs-742"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-745" aria-labelledby="react-tabs-744"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-747" aria-labelledby="react-tabs-746"></div></div></div></div></div></div><div id="tag/teams/paths/~1users~1{user_id}~1teams/get" data-section-id="tag/teams/paths/~1users~1{user_id}~1teams/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1users~1{user_id}~1teams/get"></a>Get a user's teams<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of teams that a user is on.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated as the user or have the <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/teams</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/teams</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/teams</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-748" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-749" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-749" aria-labelledby="react-tabs-748"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
teams<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetTeamsForUser</span><span class="token punctuation">(</span>userID<span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-750" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-751" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-752" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-753">400</li><li class="tab-error" role="tab" id="react-tabs-754" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-755">401</li><li class="tab-error" role="tab" id="react-tabs-756" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-757">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-751" aria-labelledby="react-tabs-750"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"allowed_domains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"invite_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"allow_open_invite"</span>: <span class="token boolean">true</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-753" aria-labelledby="react-tabs-752"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-755" aria-labelledby="react-tabs-754"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-757" aria-labelledby="react-tabs-756"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1members/get" data-section-id="tag/teams/paths/~1teams~1{team_id}~1members/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1members/get"></a>Get team members<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page team members list based on query string parameters - team id, page and per page.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and have the <code>view_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of users per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team members retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/members</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-758" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-759" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-759" aria-labelledby="react-tabs-758"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
teamID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
members<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetTeamMembers</span><span class="token punctuation">(</span>teamID<span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">100</span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-760" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-761" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-762" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-763">400</li><li class="tab-error" role="tab" id="react-tabs-764" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-765">401</li><li class="tab-error" role="tab" id="react-tabs-766" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-767">403</li><li class="tab-error" role="tab" id="react-tabs-768" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-769">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-761" aria-labelledby="react-tabs-760"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheme_user"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheme_admin"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"explicit_roles"</span>: <span class="token string">"string"</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-763" aria-labelledby="react-tabs-762"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-765" aria-labelledby="react-tabs-764"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-767" aria-labelledby="react-tabs-766"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-769" aria-labelledby="react-tabs-768"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1members/post" data-section-id="tag/teams/paths/~1teams~1{team_id}~1members/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1members/post"></a>Add user to team<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Add user to the team by user_id.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and team be open to add self. For adding another user, authenticated user must have the <code>add_user_to_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team member creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/members</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-770" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-771" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-772" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-773">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-771" aria-labelledby="react-tabs-770"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</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-773" aria-labelledby="react-tabs-772"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-774" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-775" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-776" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-777">400</li><li class="tab-error" role="tab" id="react-tabs-778" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-779">401</li><li class="tab-error" role="tab" id="react-tabs-780" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-781">403</li><li class="tab-error" role="tab" id="react-tabs-782" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-783">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-775" aria-labelledby="react-tabs-774"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scheme_user"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scheme_admin"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"explicit_roles"</span>: <span class="token string">"string"</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-777" aria-labelledby="react-tabs-776"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-779" aria-labelledby="react-tabs-778"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-781" aria-labelledby="react-tabs-780"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-783" aria-labelledby="react-tabs-782"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1members~1invite/post" data-section-id="tag/teams/paths/~1teams~1members~1invite/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1members~1invite/post"></a>Add user to team from invite<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Using either an invite id or hash/data pair from an email invite link, add a user to a team.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="token"><span class="sc-kGXeez bcLONg"></span>token<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Token id from the invitation</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team member creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/teams/members/invite</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/members/invite</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/members/invite</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-784" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-785" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-785" aria-labelledby="react-tabs-784"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
tokenID <span class="token operator">:=</span> <span class="token string">"qjda3stwafbgpqjaxej3k76sga"</span>
|
||
|
||
tm<span class="token punctuation">,</span> resp <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">AddTeamMemberFromInvite</span><span class="token punctuation">(</span>tokenID<span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-786" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-787" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-788" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-789">400</li><li class="tab-error" role="tab" id="react-tabs-790" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-791">401</li><li class="tab-error" role="tab" id="react-tabs-792" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-793">403</li><li class="tab-error" role="tab" id="react-tabs-794" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-795">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-787" aria-labelledby="react-tabs-786"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scheme_user"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scheme_admin"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"explicit_roles"</span>: <span class="token string">"string"</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-789" aria-labelledby="react-tabs-788"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-791" aria-labelledby="react-tabs-790"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-793" aria-labelledby="react-tabs-792"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-795" aria-labelledby="react-tabs-794"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1members~1batch/post" data-section-id="tag/teams/paths/~1teams~1{team_id}~1members~1batch/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1members~1batch/post"></a>Add multiple users to team<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Add a number of users to the team by user_id.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated. Authenticated user must have the <code>add_user_to_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="graceful"><span class="sc-kGXeez bcLONg"></span>graceful</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Instead of aborting the operation if a user cannot be added, return an arrray that will contain both the success and added members and the ones with error, in form of <code>[{"member": {...}, "user_id", "...", "error": {...}}]</code></p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><div><div class="sc-hMqMXs dDdNtD"> Array </div><div class="sc-gGBfsJ bvBDls"><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the team this member belongs to.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the user this member relates to.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="roles"><span class="sc-kGXeez bcLONg"></span>roles</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The complete list of roles assigned to this team member, as a space-separated list of role names, including any roles granted implicitly through permissions schemes.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="delete_at"><span class="sc-kGXeez bcLONg"></span>delete_at</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The time in milliseconds that this team member was deleted.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="scheme_user"><span class="sc-kGXeez bcLONg"></span>scheme_user</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Whether this team member holds the default user role defined by the team's permissions scheme.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="scheme_admin"><span class="sc-kGXeez bcLONg"></span>scheme_admin</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Whether this team member holds the default admin role defined by the team's permissions scheme.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="explicit_roles"><span class="sc-kGXeez bcLONg"></span>explicit_roles</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The list of roles explicitly assigned to this team member, as a space separated list of role names. This list does <em>not</em> include any roles granted implicitly through permissions schemes.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div class="sc-kEYyzF cMefLx"></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team members created successfully.</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/members/batch</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members/batch</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members/batch</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-796" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-797" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-798" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-799">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-797" aria-labelledby="react-tabs-796"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheme_user"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheme_admin"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"explicit_roles"</span>: <span class="token string">"string"</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-799" aria-labelledby="react-tabs-798"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-800" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-801" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-802" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-803">400</li><li class="tab-error" role="tab" id="react-tabs-804" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-805">401</li><li class="tab-error" role="tab" id="react-tabs-806" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-807">403</li><li class="tab-error" role="tab" id="react-tabs-808" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-809">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-801" aria-labelledby="react-tabs-800"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheme_user"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheme_admin"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"explicit_roles"</span>: <span class="token string">"string"</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-803" aria-labelledby="react-tabs-802"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-805" aria-labelledby="react-tabs-804"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-807" aria-labelledby="react-tabs-806"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-809" aria-labelledby="react-tabs-808"></div></div></div></div></div></div><div id="tag/teams/paths/~1users~1{user_id}~1teams~1members/get" data-section-id="tag/teams/paths/~1users~1{user_id}~1teams~1members/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1users~1{user_id}~1teams~1members/get"></a>Get team members for a user<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of team members for a user. Useful for getting the ids of teams the user is on and the roles they have in those teams.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user or have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team members retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/teams/members</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/teams/members</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/teams/members</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-810" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-811" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-811" aria-labelledby="react-tabs-810"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"zWEyrTZ7GZ22aBSfoX60iWryTY"</span>
|
||
|
||
teamMembers<span class="token punctuation">,</span> resp <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">GetTeamMembersForUser</span><span class="token punctuation">(</span>userID<span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-812" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-813" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-814" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-815">400</li><li class="tab-error" role="tab" id="react-tabs-816" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-817">401</li><li class="tab-error" role="tab" id="react-tabs-818" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-819">403</li><li class="tab-error" role="tab" id="react-tabs-820" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-821">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-813" aria-labelledby="react-tabs-812"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheme_user"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheme_admin"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"explicit_roles"</span>: <span class="token string">"string"</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-815" aria-labelledby="react-tabs-814"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-817" aria-labelledby="react-tabs-816"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-819" aria-labelledby="react-tabs-818"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-821" aria-labelledby="react-tabs-820"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}/get" data-section-id="tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}/get"></a>Get a team member<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a team member on the system.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and have the <code>view_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team member retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/members/{user_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members/{user_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members/{user_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-822" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-823" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-823" aria-labelledby="react-tabs-822"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
teamID <span class="token operator">:=</span> <span class="token string">"zWEyrTZ7GZ22aBSfoX60iWryTY"</span>
|
||
userID <span class="token operator">:=</span> <span class="token string">"NqCSr5HMDZjrWS74IEmedvlOYf"</span>
|
||
|
||
teamMember<span class="token punctuation">,</span> resp <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">GetTeamMember</span><span class="token punctuation">(</span>teamID<span class="token punctuation">,</span> userID<span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-824" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-825" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-826" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-827">400</li><li class="tab-error" role="tab" id="react-tabs-828" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-829">401</li><li class="tab-error" role="tab" id="react-tabs-830" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-831">403</li><li class="tab-error" role="tab" id="react-tabs-832" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-833">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-825" aria-labelledby="react-tabs-824"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scheme_user"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scheme_admin"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"explicit_roles"</span>: <span class="token string">"string"</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-827" aria-labelledby="react-tabs-826"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-829" aria-labelledby="react-tabs-828"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-831" aria-labelledby="react-tabs-830"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-833" aria-labelledby="react-tabs-832"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}/delete" data-section-id="tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}/delete"></a>Remove user from team<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Delete the team member object for a user, effectively removing them from a team.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user or have the <code>remove_user_from_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team member deletion successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/members/{user_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members/{user_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members/{user_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-834" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-835" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-835" aria-labelledby="react-tabs-834"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
teamID <span class="token operator">:=</span> <span class="token string">"zWEyrTZ7GZ22aBSfoX60iWryTY"</span>
|
||
userID <span class="token operator">:=</span> <span class="token string">"NqCSr5HMDZjrWS74IEmedvlOYf"</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">RemoveTeamMember</span><span class="token punctuation">(</span>teamID<span class="token punctuation">,</span> userID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-836" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-837" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-838" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-839">400</li><li class="tab-error" role="tab" id="react-tabs-840" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-841">401</li><li class="tab-error" role="tab" id="react-tabs-842" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-843">403</li><li class="tab-error" role="tab" id="react-tabs-844" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-845">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-837" aria-labelledby="react-tabs-836"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-839" aria-labelledby="react-tabs-838"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-841" aria-labelledby="react-tabs-840"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-843" aria-labelledby="react-tabs-842"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-845" aria-labelledby="react-tabs-844"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1members~1ids/post" data-section-id="tag/teams/paths/~1teams~1{team_id}~1members~1ids/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1members~1ids/post"></a>Get team members by ids<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of team members based on a provided array of user ids.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>view_team</code> permission for the team.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>List of user ids</p>
|
||
</div><div><div class="sc-hMqMXs dDdNtD"> Array </div><div class="sc-gGBfsJ bvBDls"><div><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></div></div><div class="sc-kEYyzF cMefLx"></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team members retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/members/ids</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members/ids</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members/ids</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-846" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-847" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-848" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-849">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-847" aria-labelledby="react-tabs-846"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"string"</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-849" aria-labelledby="react-tabs-848"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-850" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-851" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-852" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-853">400</li><li class="tab-error" role="tab" id="react-tabs-854" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-855">401</li><li class="tab-error" role="tab" id="react-tabs-856" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-857">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-851" aria-labelledby="react-tabs-850"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheme_user"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheme_admin"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"explicit_roles"</span>: <span class="token string">"string"</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-853" aria-labelledby="react-tabs-852"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-855" aria-labelledby="react-tabs-854"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-857" aria-labelledby="react-tabs-856"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1stats/get" data-section-id="tag/teams/paths/~1teams~1{team_id}~1stats/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1stats/get"></a>Get a team stats<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a team stats on the system.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and have the <code>view_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team stats retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/stats</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/stats</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/stats</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-858" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-859" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-859" aria-labelledby="react-tabs-858"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
teamID <span class="token operator">:=</span> <span class="token string">"zWEyrTZ7GZ22aBSfoX60iWryTY"</span>
|
||
|
||
stats<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetTeamStats</span><span class="token punctuation">(</span>teamID<span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-860" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-861" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-862" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-863">400</li><li class="tab-error" role="tab" id="react-tabs-864" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-865">401</li><li class="tab-error" role="tab" id="react-tabs-866" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-867">403</li><li class="tab-error" role="tab" id="react-tabs-868" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-869">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-861" aria-labelledby="react-tabs-860"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total_member_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"active_member_count"</span>: <span class="token number">0</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-863" aria-labelledby="react-tabs-862"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-865" aria-labelledby="react-tabs-864"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-867" aria-labelledby="react-tabs-866"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-869" aria-labelledby="react-tabs-868"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1regenerate_invite_id/post" data-section-id="tag/teams/paths/~1teams~1{team_id}~1regenerate_invite_id/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1regenerate_invite_id/post"></a>Regenerate the Invite ID from a Team<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Regenerates the invite ID used in invite links of a team</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and have the <code>manage_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team Invite ID regenerated</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/regenerate_invite_id</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/regenerate_invite_id</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/regenerate_invite_id</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-870" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-871" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-871" aria-labelledby="react-tabs-870"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
teamID <span class="token operator">:=</span> <span class="token string">"zWEyrTZ7GZ22aBSfoX60iWryTY"</span>
|
||
|
||
team<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">RegenerateTeamInviteId</span><span class="token punctuation">(</span>teamID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-872" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-873" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-874" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-875">400</li><li class="tab-error" role="tab" id="react-tabs-876" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-877">401</li><li class="tab-error" role="tab" id="react-tabs-878" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-879">403</li><li class="tab-error" role="tab" id="react-tabs-880" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-881">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-873" aria-labelledby="react-tabs-872"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allowed_domains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow_open_invite"</span>: <span class="token boolean">true</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-875" aria-labelledby="react-tabs-874"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-877" aria-labelledby="react-tabs-876"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-879" aria-labelledby="react-tabs-878"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-881" aria-labelledby="react-tabs-880"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1image/get" data-section-id="tag/teams/paths/~1teams~1{team_id}~1image/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1image/get"></a>Get the team icon<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get the team icon of the team.</p>
|
||
<p><strong>Minimum server version</strong>: 4.9</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>User must be authenticated. In addition, team must be open or the user must have the <code>view_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT hLVzSF"><strong>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team icon retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/image</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/image</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/image</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-882" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-883" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-883" aria-labelledby="react-tabs-882"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
teamID <span class="token operator">:=</span> <span class="token string">"zWEyrTZ7GZ22aBSfoX60iWryTY"</span>
|
||
|
||
icon<span class="token punctuation">,</span> resp <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">GetTeamIcon</span><span class="token punctuation">(</span>teamID<span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-884" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-885" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-886" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-887">401</li><li class="tab-error" role="tab" id="react-tabs-888" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-889">403</li><li class="tab-error" role="tab" id="react-tabs-890" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-891">404</li><li class="tab-error" role="tab" id="react-tabs-892" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-893">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-885" aria-labelledby="react-tabs-884"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-887" aria-labelledby="react-tabs-886"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-889" aria-labelledby="react-tabs-888"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-891" aria-labelledby="react-tabs-890"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-893" aria-labelledby="react-tabs-892"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1image/post" data-section-id="tag/teams/paths/~1teams~1{team_id}~1image/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1image/post"></a>Sets the team icon<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Sets the team icon for the team.</p>
|
||
<p><strong>Minimum server version</strong>: 4.9</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and have the <code>manage_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">multipart/form-data</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="image"><span class="sc-kGXeez bcLONg"></span>image<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span><span class="sc-cHGsZl sc-kgAjT hqYVjx"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The image to be uploaded</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team icon successfully set</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/image</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/image</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/image</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-894" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-895" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-895" aria-labelledby="react-tabs-894"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token punctuation">(</span>
|
||
<span class="token string">"io/ioutil"</span>
|
||
<span class="token string">"log"</span>
|
||
|
||
<span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
<span class="token punctuation">)</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
data<span class="token punctuation">,</span> err <span class="token operator">:=</span> ioutil<span class="token punctuation">.</span><span class="token function">ReadFile</span><span class="token punctuation">(</span><span class="token string">"icon.png"</span><span class="token punctuation">)</span>
|
||
<span class="token keyword">if</span> err <span class="token operator">!=</span> <span class="token boolean">nil</span> <span class="token punctuation">{</span>
|
||
log<span class="token punctuation">.</span><span class="token function">Fatal</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span>
|
||
<span class="token punctuation">}</span>
|
||
|
||
teamID <span class="token operator">:=</span> <span class="token string">"zWEyrTZ7GZ22aBSfoX60iWryTY"</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">SetTeamIcon</span><span class="token punctuation">(</span>teamID<span class="token punctuation">,</span> data<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-896" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-897" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-898" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-899">400</li><li class="tab-error" role="tab" id="react-tabs-900" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-901">401</li><li class="tab-error" role="tab" id="react-tabs-902" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-903">403</li><li class="tab-error" role="tab" id="react-tabs-904" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-905">500</li><li class="tab-error" role="tab" id="react-tabs-906" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-907">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-897" aria-labelledby="react-tabs-896"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-899" aria-labelledby="react-tabs-898"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-901" aria-labelledby="react-tabs-900"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-903" aria-labelledby="react-tabs-902"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-905" aria-labelledby="react-tabs-904"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-907" aria-labelledby="react-tabs-906"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1image/delete" data-section-id="tag/teams/paths/~1teams~1{team_id}~1image/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1image/delete"></a>Remove the team icon<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Remove the team icon for the team.</p>
|
||
<p><strong>Minimum server version</strong>: 4.10</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and have the <code>manage_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team icon successfully remove</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/image</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/image</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/image</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-908" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-909" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-909" aria-labelledby="react-tabs-908"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
teamID <span class="token operator">:=</span> <span class="token string">"zWEyrTZ7GZ22aBSfoX60iWryTY"</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">RemoveTeamIcon</span><span class="token punctuation">(</span>teamID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-910" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-911" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-912" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-913">400</li><li class="tab-error" role="tab" id="react-tabs-914" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-915">401</li><li class="tab-error" role="tab" id="react-tabs-916" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-917">403</li><li class="tab-error" role="tab" id="react-tabs-918" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-919">500</li><li class="tab-error" role="tab" id="react-tabs-920" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-921">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-911" aria-labelledby="react-tabs-910"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-913" aria-labelledby="react-tabs-912"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-915" aria-labelledby="react-tabs-914"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-917" aria-labelledby="react-tabs-916"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-919" aria-labelledby="react-tabs-918"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-921" aria-labelledby="react-tabs-920"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}~1roles/put" data-section-id="tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}~1roles/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}~1roles/put"></a>Update a team member roles<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update a team member roles. Valid team roles are "team_user", "team_admin" or both of them. Overwrites any previously assigned team roles.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and have the <code>manage_team_roles</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Space-delimited team roles to assign to the user</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="roles"><span class="sc-kGXeez bcLONg"></span>roles<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team member roles update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/members/{user_id}/roles</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members/{user_id}/roles</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members/{user_id}/roles</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-922" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-923" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-924" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-925">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-923" aria-labelledby="react-tabs-922"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"roles"</span>: <span class="token string">"string"</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-925" aria-labelledby="react-tabs-924"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-926" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-927" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-928" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-929">400</li><li class="tab-error" role="tab" id="react-tabs-930" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-931">401</li><li class="tab-error" role="tab" id="react-tabs-932" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-933">403</li><li class="tab-error" role="tab" id="react-tabs-934" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-935">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-927" aria-labelledby="react-tabs-926"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-929" aria-labelledby="react-tabs-928"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-931" aria-labelledby="react-tabs-930"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-933" aria-labelledby="react-tabs-932"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-935" aria-labelledby="react-tabs-934"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}~1schemeRoles/put" data-section-id="tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}~1schemeRoles/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}~1schemeRoles/put"></a>Update the scheme-derived roles of a team member.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update a team member's scheme_admin/scheme_user properties. Typically this should either be <code>scheme_admin=false, scheme_user=true</code> for ordinary team member, or <code>scheme_admin=true, scheme_user=true</code> for a team admin.</p>
|
||
<p><strong>Minimum server version</strong>: 5.0</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and have the <code>manage_team_roles</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Scheme properties.</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="scheme_admin"><span class="sc-kGXeez bcLONg"></span>scheme_admin<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="scheme_user"><span class="sc-kGXeez bcLONg"></span>scheme_user<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team member's scheme-derived roles updated successfully.</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/members/{user_id}/schemeRoles</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members/{user_id}/schemeRoles</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members/{user_id}/schemeRoles</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-936" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-937" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-938" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-939">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-937" aria-labelledby="react-tabs-936"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"scheme_admin"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scheme_user"</span>: <span class="token boolean">true</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-939" aria-labelledby="react-tabs-938"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-940" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-941" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-942" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-943">400</li><li class="tab-error" role="tab" id="react-tabs-944" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-945">401</li><li class="tab-error" role="tab" id="react-tabs-946" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-947">403</li><li class="tab-error" role="tab" id="react-tabs-948" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-949">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-941" aria-labelledby="react-tabs-940"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-943" aria-labelledby="react-tabs-942"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-945" aria-labelledby="react-tabs-944"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-947" aria-labelledby="react-tabs-946"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-949" aria-labelledby="react-tabs-948"></div></div></div></div></div></div><div id="tag/teams/paths/~1users~1{user_id}~1teams~1unread/get" data-section-id="tag/teams/paths/~1users~1{user_id}~1teams~1unread/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1users~1{user_id}~1teams~1unread/get"></a>Get team unreads for a user<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get the count for unread messages and mentions in the teams the user is a member of.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="exclude_team"><span class="sc-kGXeez bcLONg"></span>exclude_team<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Optional team id to be excluded from the results</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team unreads retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/teams/unread</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/teams/unread</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/teams/unread</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-950" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-951" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-951" aria-labelledby="react-tabs-950"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"NqCSr5HMDZjrWS74IEmedvlOYf"</span>
|
||
teamID <span class="token operator">:=</span> <span class="token string">"zWEyrTZ7GZ22aBSfoX60iWryTY"</span>
|
||
|
||
teams<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetTeamsUnreadForUser</span><span class="token punctuation">(</span>userID<span class="token punctuation">,</span> teamID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-952" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-953" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-954" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-955">400</li><li class="tab-error" role="tab" id="react-tabs-956" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-957">401</li><li class="tab-error" role="tab" id="react-tabs-958" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-959">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-953" aria-labelledby="react-tabs-952"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"msg_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_count"</span>: <span class="token number">0</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-955" aria-labelledby="react-tabs-954"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-957" aria-labelledby="react-tabs-956"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-959" aria-labelledby="react-tabs-958"></div></div></div></div></div></div><div id="tag/teams/paths/~1users~1{user_id}~1teams~1{team_id}~1unread/get" data-section-id="tag/teams/paths/~1users~1{user_id}~1teams~1{team_id}~1unread/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1users~1{user_id}~1teams~1{team_id}~1unread/get"></a>Get unreads for a team<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get the unread mention and message counts for a team for the specified user.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be the user or have <code>edit_other_users</code> permission and have <code>view_team</code> permission for the team.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team unread count retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/teams/{team_id}/unread</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/teams/{team_id}/unread</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/teams/{team_id}/unread</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-960" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-961" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-961" aria-labelledby="react-tabs-960"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"NqCSr5HMDZjrWS74IEmedvlOYf"</span>
|
||
teamID <span class="token operator">:=</span> <span class="token string">"zWEyrTZ7GZ22aBSfoX60iWryTY"</span>
|
||
|
||
teamUnread<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetTeamUnread</span><span class="token punctuation">(</span>userID<span class="token punctuation">,</span> teamID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-962" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-963" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-964" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-965">400</li><li class="tab-error" role="tab" id="react-tabs-966" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-967">401</li><li class="tab-error" role="tab" id="react-tabs-968" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-969">403</li><li class="tab-error" role="tab" id="react-tabs-970" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-971">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-963" aria-labelledby="react-tabs-962"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mention_count"</span>: <span class="token number">0</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-965" aria-labelledby="react-tabs-964"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-967" aria-labelledby="react-tabs-966"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-969" aria-labelledby="react-tabs-968"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-971" aria-labelledby="react-tabs-970"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1invite~1email/post" data-section-id="tag/teams/paths/~1teams~1{team_id}~1invite~1email/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1invite~1email/post"></a>Invite users to the team by email<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Invite users to the existing team usign the user's email.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>invite_to_team</code> permission for the team.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>List of user's email</p>
|
||
</div><div><div class="sc-hMqMXs dDdNtD"> Array </div><div class="sc-gGBfsJ bvBDls"><div><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></div></div><div class="sc-kEYyzF cMefLx"></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Users invite successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/invite/email</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/invite/email</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/invite/email</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-972" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-973" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-974" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-975">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-973" aria-labelledby="react-tabs-972"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"string"</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-975" aria-labelledby="react-tabs-974"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-976" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-977" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-978" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-979">400</li><li class="tab-error" role="tab" id="react-tabs-980" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-981">401</li><li class="tab-error" role="tab" id="react-tabs-982" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-983">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-977" aria-labelledby="react-tabs-976"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-979" aria-labelledby="react-tabs-978"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-981" aria-labelledby="react-tabs-980"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-983" aria-labelledby="react-tabs-982"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1invite-guests~1email/post" data-section-id="tag/teams/paths/~1teams~1{team_id}~1invite-guests~1email/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1invite-guests~1email/post"></a>Invite guests to the team by email<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Invite guests to existing team channels usign the user's email.</p>
|
||
<p><strong>Minimum server version</strong>: 5.16</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>invite_guest</code> permission for the team.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Guests invite information</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="emails"><span class="sc-kGXeez bcLONg"></span>emails<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc">Array of </span><span class="sc-cHGsZl sc-kgAjT hqYVjx">strings</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>List of emails</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channels"><span class="sc-kGXeez bcLONg"></span>channels<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc">Array of </span><span class="sc-cHGsZl sc-kgAjT hqYVjx">strings</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>List of channel ids</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="message"><span class="sc-kGXeez bcLONg"></span>message</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Message to include in the invite</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Guests invite successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/invite-guests/email</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/invite-guests/email</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/invite-guests/email</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-984" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-985" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-986" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-987">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-985" aria-labelledby="react-tabs-984"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"emails"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"channels"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"message"</span>: <span class="token string">"string"</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-987" aria-labelledby="react-tabs-986"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-988" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-989" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-990" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-991">400</li><li class="tab-error" role="tab" id="react-tabs-992" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-993">401</li><li class="tab-error" role="tab" id="react-tabs-994" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-995">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-989" aria-labelledby="react-tabs-988"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-991" aria-labelledby="react-tabs-990"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-993" aria-labelledby="react-tabs-992"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-995" aria-labelledby="react-tabs-994"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1invites~1email/delete" data-section-id="tag/teams/paths/~1teams~1invites~1email/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1invites~1email/delete"></a>Invalidate active email invitations<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Invalidate active email invitations that have not been accepted by the user.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Email invites successfully revoked</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/teams/invites/email</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/invites/email</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/invites/email</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-996" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-997" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-997" aria-labelledby="react-tabs-996"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">InvalidateEmailInvites</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-998" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-999" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1000" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1001">400</li><li class="tab-error" role="tab" id="react-tabs-1002" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1003">401</li><li class="tab-error" role="tab" id="react-tabs-1004" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1005">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-999" aria-labelledby="react-tabs-998"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-1001" aria-labelledby="react-tabs-1000"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1003" aria-labelledby="react-tabs-1002"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1005" aria-labelledby="react-tabs-1004"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1import/post" data-section-id="tag/teams/paths/~1teams~1{team_id}~1import/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1import/post"></a>Import a Team from other application<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Import a team into a existing team. Import users, channels, posts, hooks.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>permission_import_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">multipart/form-data</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="file"><span class="sc-kGXeez bcLONg"></span>file<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span><span class="sc-cHGsZl sc-kgAjT hqYVjx"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A file to be uploaded in zip format.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="filesize"><span class="sc-kGXeez bcLONg"></span>filesize<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The size of the zip file to be imported.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="importFrom"><span class="sc-kGXeez bcLONg"></span>importFrom<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>String that defines from which application the team was exported to be imported into Mattermost.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>JSON object containing a base64 encoded text file of the import logs in its <code>results</code> property.</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/import</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/import</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/import</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1006" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1007" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1007" aria-labelledby="react-tabs-1006"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token punctuation">(</span>
|
||
<span class="token string">"encoding/binary"</span>
|
||
<span class="token string">"io/ioutil"</span>
|
||
<span class="token string">"log"</span>
|
||
|
||
<span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
<span class="token punctuation">)</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
data<span class="token punctuation">,</span> err <span class="token operator">=</span> ioutil<span class="token punctuation">.</span><span class="token function">ReadFile</span><span class="token punctuation">(</span><span class="token string">"to_import.zip"</span><span class="token punctuation">)</span>
|
||
<span class="token keyword">if</span> err <span class="token operator">!=</span> <span class="token boolean">nil</span> <span class="token operator">&&</span> <span class="token function">len</span><span class="token punctuation">(</span>data<span class="token punctuation">)</span> <span class="token operator">==</span> <span class="token number">0</span> <span class="token punctuation">{</span>
|
||
log<span class="token punctuation">.</span><span class="token function">Fatal</span><span class="token punctuation">(</span><span class="token string">"Error while reading file."</span><span class="token punctuation">)</span>
|
||
<span class="token punctuation">}</span>
|
||
|
||
teamID <span class="token operator">:=</span> <span class="token string">"zWEyrTZ7GZ22aBSfoX60iWryTY"</span>
|
||
|
||
fileResp<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">ImportTeam</span><span class="token punctuation">(</span>data<span class="token punctuation">,</span> binary<span class="token punctuation">.</span><span class="token function">Size</span><span class="token punctuation">(</span>data<span class="token punctuation">)</span><span class="token punctuation">,</span> <span class="token string">"slack"</span><span class="token punctuation">,</span> <span class="token string">"to_import.zip"</span><span class="token punctuation">,</span> teamID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1008" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1009" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1010" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1011">400</li><li class="tab-error" role="tab" id="react-tabs-1012" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1013">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1009" aria-labelledby="react-tabs-1008"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"results"</span>: <span class="token string">"string"</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-1011" aria-labelledby="react-tabs-1010"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1013" aria-labelledby="react-tabs-1012"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1invite~1{invite_id}/get" data-section-id="tag/teams/paths/~1teams~1invite~1{invite_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1invite~1{invite_id}/get"></a>Get invite info for a team<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get the <code>name</code>, <code>display_name</code>, <code>description</code> and <code>id</code> for a team from the invite id.</p>
|
||
<p><strong>Minimum server version</strong>: 4.0</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>No authentication required.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="invite_id"><span class="sc-kGXeez bcLONg"></span>invite_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Invite id for a team</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team invite info retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/invite/{invite_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/invite/{invite_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/invite/{invite_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1014" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1015" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1015" aria-labelledby="react-tabs-1014"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
|
||
inviteID <span class="token operator">:=</span> <span class="token string">"zWEyrTZ7GZ22aBSfoX60iWryTY"</span>
|
||
|
||
team<span class="token punctuation">,</span> resp <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">GetTeamInviteInfo</span><span class="token punctuation">(</span>inviteID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1016" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1017" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1018" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1019">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1017" aria-labelledby="react-tabs-1016"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</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-1019" aria-labelledby="react-tabs-1018"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1scheme/put" data-section-id="tag/teams/paths/~1teams~1{team_id}~1scheme/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1scheme/put"></a>Set a team's scheme<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Set a team's scheme, more specifically sets the scheme_id value of a team record.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.0</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Scheme GUID</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="scheme_id"><span class="sc-kGXeez bcLONg"></span>scheme_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the scheme.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Update team scheme successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/scheme</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/scheme</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/scheme</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1020" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1021" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1022" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1023">Go</li><li class="react-tabs__tab" role="tab" id="react-tabs-1024" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1025">curl</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1021" aria-labelledby="react-tabs-1020"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"scheme_id"</span>: <span class="token string">"string"</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-1023" aria-labelledby="react-tabs-1022"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1025" aria-labelledby="react-tabs-1024"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1026" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1027" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1028" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1029">400</li><li class="tab-error" role="tab" id="react-tabs-1030" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1031">401</li><li class="tab-error" role="tab" id="react-tabs-1032" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1033">403</li><li class="tab-error" role="tab" id="react-tabs-1034" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1035">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1027" aria-labelledby="react-tabs-1026"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-1029" aria-labelledby="react-tabs-1028"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1031" aria-labelledby="react-tabs-1030"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1033" aria-labelledby="react-tabs-1032"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1035" aria-labelledby="react-tabs-1034"></div></div></div></div></div></div><div id="tag/teams/paths/~1teams~1{team_id}~1members_minus_group_members/get" data-section-id="tag/teams/paths/~1teams~1{team_id}~1members_minus_group_members/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/teams/paths/~1teams~1{team_id}~1members_minus_group_members/get"></a>Team members minus group members.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get the set of users who are members of the team minus the set of users who are members of the given groups.
|
||
Each user object contains an array of group objects representing the group memberships for that user.
|
||
Each user object contains the boolean fields <code>scheme_guest</code>, <code>scheme_user</code>, and <code>scheme_admin</code> representing the roles that user has for the given team.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.14</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_ids"><span class="sc-kGXeez bcLONg"></span>group_ids<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">""</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A comma-separated list of group ids.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of users per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT hLVzSF"><strong>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Successfully returns users specified by the pagination, and the total_count.</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/members_minus_group_members</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members_minus_group_members</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/members_minus_group_members</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1036" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1037" tabindex="0">curl</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1037" aria-labelledby="react-tabs-1036"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp">curl <span class="token string">'http://your-mattermost-url.com/api/v4/teams/fcnst115y3y7xmzzp5uq34u8ce/members_minus_group_members?group_ids=eoezijg8zffgjmch8icy5bjd1e,ugaw6wjc3tfxpcr1eq5u5k8dhe&page=0&per_page=100'</span> \
|
||
<span class="token operator">-</span>H <span class="token string">'Authorization: Bearer mq8rrfxpdfyafbnw3qfmhwkx6c'</span> \
|
||
<span class="token operator">-</span>H <span class="token string">'Content-Type: application/json'</span> \
|
||
<span class="token operator">-</span>H <span class="token string">'X-Requested-With: XMLHttpRequest'</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1038" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1039" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1040" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1041">401</li><li class="tab-error" role="tab" id="react-tabs-1042" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1043">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1039" aria-labelledby="react-tabs-1038"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1041" aria-labelledby="react-tabs-1040"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1043" aria-labelledby="react-tabs-1042"></div></div></div></div></div></div><div id="tag/channels" data-section-id="tag/channels" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/channels"></a>channels</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for creating, getting and interacting with channels.</p>
|
||
</div></div></div><div id="tag/channels/paths/~1channels/post" data-section-id="tag/channels/paths/~1channels/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels/post"></a>Create a channel<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Create a new channel.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>If creating a public channel, <code>create_public_channel</code> permission is required. If creating a private channel, <code>create_private_channel</code> permission is required.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Channel object to be created</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The team ID of the team to create the channel on</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The unique handle for the channel, will be present in the channel URL</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="display_name"><span class="sc-kGXeez bcLONg"></span>display_name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The non-unique UI name for the channel</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="purpose"><span class="sc-kGXeez bcLONg"></span>purpose</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A short description of the purpose of the channel</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="header"><span class="sc-kGXeez bcLONg"></span>header</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Markdown-formatted text to display in the header of the channel</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="type"><span class="sc-kGXeez bcLONg"></span>type<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>'O' for a public channel, 'P' for a private channel</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/channels</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1044" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1045" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1046" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1047">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1045" aria-labelledby="react-tabs-1044"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"purpose"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"header"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</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-1047" aria-labelledby="react-tabs-1046"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1048" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1049" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1050" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1051">401</li><li class="tab-error" role="tab" id="react-tabs-1052" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1053">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1049" aria-labelledby="react-tabs-1048"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1051" aria-labelledby="react-tabs-1050"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1053" aria-labelledby="react-tabs-1052"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1direct/post" data-section-id="tag/channels/paths/~1channels~1direct/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1direct/post"></a>Create a direct message channel<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Create a new direct message channel between two users.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be one of the two users and have <code>create_direct_channel</code> permission. Having the <code>manage_system</code> permission voids the previous requirements.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>The two user ids to be in the direct message</p>
|
||
</div><div><div class="sc-hMqMXs dDdNtD"> Array </div><div class="sc-gGBfsJ bvBDls"><div><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></div></div><div class="sc-kEYyzF cMefLx"></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Direct channel creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/channels/direct</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/direct</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/direct</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1054" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1055" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1056" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1057">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1055" aria-labelledby="react-tabs-1054"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"string"</span>,</div></li><li><div class="hoverable "><span class="token string">"string"</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-1057" aria-labelledby="react-tabs-1056"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1058" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1059" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1060" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1061">401</li><li class="tab-error" role="tab" id="react-tabs-1062" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1063">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1059" aria-labelledby="react-tabs-1058"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1061" aria-labelledby="react-tabs-1060"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1063" aria-labelledby="react-tabs-1062"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1group/post" data-section-id="tag/channels/paths/~1channels~1group/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1group/post"></a>Create a group message channel<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Create a new group message channel to group of users. If the logged in user's id is not included in the list, it will be appended to the end.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>create_group_channel</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>User ids to be in the group message channel</p>
|
||
</div><div><div class="sc-hMqMXs dDdNtD"> Array </div><div class="sc-gGBfsJ bvBDls"><div><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></div></div><div class="sc-kEYyzF cMefLx"></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Group channel creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/channels/group</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/group</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/group</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1064" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1065" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1066" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1067">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1065" aria-labelledby="react-tabs-1064"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"string"</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-1067" aria-labelledby="react-tabs-1066"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1068" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1069" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1070" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1071">401</li><li class="tab-error" role="tab" id="react-tabs-1072" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1073">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1069" aria-labelledby="react-tabs-1068"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1071" aria-labelledby="react-tabs-1070"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1073" aria-labelledby="react-tabs-1072"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1search/post" data-section-id="tag/channels/paths/~1channels~1search/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1search/post"></a>Search all private and open type channels across all teams<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Returns all private and open type channels where 'term' matches on the name, display name, or purpose of
|
||
the channel.</p>
|
||
<p>Configured 'default' channels (ex Town Square and Off-Topic) can be excluded from the results
|
||
with the <code>exclude_default_channels</code> boolean parameter.</p>
|
||
<p>Channels that are associated (via GroupChannel records) to a given group can be excluded from the results
|
||
with the <code>not_associated_to_group</code> parameter and a group id string.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>The search terms and logic to use in the search.</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="term"><span class="sc-kGXeez bcLONg"></span>term<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The string to search in the channel name, display name, and purpose.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="not_associated_to_group"><span class="sc-kGXeez bcLONg"></span>not_associated_to_group</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A group id to exclude channels that are associated to that group via GroupChannel records.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="exclude_default_channels"><span class="sc-kGXeez bcLONg"></span>exclude_default_channels</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Exclude default channels from the results by setting this parameter to true.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page number to return, if paginated. If this parameter is not present with the <code>per_page</code> parameter then the results will be returned un-paged.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of entries to return per page, if paginated. If this parameter is not present with the <code>page</code> parameter then the results will be returned un-paged.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Paginated channel response. (Note that the non-paginated response—returned if the request body does not contain both <code>page</code> and <code>per_page</code> fields—is a simple array of channels.)</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/channels/search</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/search</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/search</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1074" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1075" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1075" aria-labelledby="react-tabs-1074"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"term"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_associated_to_group"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exclude_default_channels"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"page"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"per_page"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1076" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1077" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1078" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1079">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1077" aria-labelledby="react-tabs-1076"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1079" aria-labelledby="react-tabs-1078"></div></div></div></div></div></div><div id="tag/channels/paths/~1group~1search/post" data-section-id="tag/channels/paths/~1group~1search/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1group~1search/post"></a>Search Group Channels<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of group channels for a user which members' usernames match the search term.</p>
|
||
<p><strong>Minimum server version</strong>: 5.14</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Search criteria</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="term"><span class="sc-kGXeez bcLONg"></span>term<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The search term to match against the members' usernames of the group channels</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channels search successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/group/search</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/group/search</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/group/search</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1080" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1081" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1082" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1083">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1081" aria-labelledby="react-tabs-1080"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"term"</span>: <span class="token string">"string"</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-1083" aria-labelledby="react-tabs-1082"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1084" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1085" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1086" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1087">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1085" aria-labelledby="react-tabs-1084"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1087" aria-labelledby="react-tabs-1086"></div></div></div></div></div></div><div id="tag/channels/paths/~1teams~1{team_id}~1channels~1ids/post" data-section-id="tag/channels/paths/~1teams~1{team_id}~1channels~1ids/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1teams~1{team_id}~1channels~1ids/post"></a>Get a list of channels by ids<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of public channels on a team by id.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>view_team</code> for the team the channels are on.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>List of channel ids</p>
|
||
</div><div><div class="sc-hMqMXs dDdNtD"> Array </div><div class="sc-gGBfsJ bvBDls"><div><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></div></div><div class="sc-kEYyzF cMefLx"></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/channels/ids</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/channels/ids</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/channels/ids</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1088" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1089" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1090" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1091">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1089" aria-labelledby="react-tabs-1088"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"string"</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-1091" aria-labelledby="react-tabs-1090"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1092" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1093" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1094" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1095">401</li><li class="tab-error" role="tab" id="react-tabs-1096" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1097">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1093" aria-labelledby="react-tabs-1092"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1095" aria-labelledby="react-tabs-1094"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1097" aria-labelledby="react-tabs-1096"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1timezones/get" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1timezones/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1timezones/get"></a>Get timezones in a channel<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of timezones for the users who are in this channel.</p>
|
||
<p><strong>Minimum server version</strong>: 5.6</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have the <code>read_channel</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Timezone retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/timezones</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/timezones</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/timezones</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1098" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1099" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1099" aria-labelledby="react-tabs-1098"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetChannelStats</span>
|
||
stats<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetChannelTimezones</span><span class="token punctuation">(</span><span class="token operator"><</span>CHANNELID<span class="token operator">></span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1100" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1101" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1102" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1103">401</li><li class="tab-error" role="tab" id="react-tabs-1104" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1105">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1101" aria-labelledby="react-tabs-1100"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1103" aria-labelledby="react-tabs-1102"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1105" aria-labelledby="react-tabs-1104"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}/get" data-section-id="tag/channels/paths/~1channels~1{channel_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}/get"></a>Get a channel<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get channel from the provided channel id string.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>read_channel</code> permission for the channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1106" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1107" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1107" aria-labelledby="react-tabs-1106"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetChannel</span>
|
||
channel<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetChannel</span><span class="token punctuation">(</span><span class="token operator"><</span>CHANNELID<span class="token operator">></span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1108" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1109" tabindex="0">401</li><li class="tab-error" role="tab" id="react-tabs-1110" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1111">403</li><li class="tab-error" role="tab" id="react-tabs-1112" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1113">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1109" aria-labelledby="react-tabs-1108"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1111" aria-labelledby="react-tabs-1110"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1113" aria-labelledby="react-tabs-1112"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}/put" data-section-id="tag/channels/paths/~1channels~1{channel_id}/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}/put"></a>Update a channel<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update a channel. The fields that can be updated are listed as parameters. Omitted fields will be treated as blanks.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>If updating a public channel, <code>manage_public_channel_members</code> permission is required. If updating a private channel, <code>manage_private_channel_members</code> permission is required.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Channel object to be updated</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="id"><span class="sc-kGXeez bcLONg"></span>id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The channel's id, not updatable</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The unique handle for the channel, will be present in the channel URL</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="display_name"><span class="sc-kGXeez bcLONg"></span>display_name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The non-unique UI name for the channel</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="purpose"><span class="sc-kGXeez bcLONg"></span>purpose</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A short description of the purpose of the channel</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="header"><span class="sc-kGXeez bcLONg"></span>header</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Markdown-formatted text to display in the header of the channel</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1114" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1115" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1116" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1117">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1115" aria-labelledby="react-tabs-1114"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"purpose"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"header"</span>: <span class="token string">"string"</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-1117" aria-labelledby="react-tabs-1116"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1118" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1119" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1120" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1121">401</li><li class="tab-error" role="tab" id="react-tabs-1122" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1123">403</li><li class="tab-error" role="tab" id="react-tabs-1124" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1125">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1119" aria-labelledby="react-tabs-1118"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1121" aria-labelledby="react-tabs-1120"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1123" aria-labelledby="react-tabs-1122"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1125" aria-labelledby="react-tabs-1124"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}/delete" data-section-id="tag/channels/paths/~1channels~1{channel_id}/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}/delete"></a>Delete a channel<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Soft deletes a channel, by marking the channel as deleted in the database. Soft deleted channels will not be accessible in the user interface. Direct and group message channels cannot be deleted.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>delete_public_channel</code> permission if the channel is public,
|
||
<code>delete_private_channel</code> permission if the channel is private,
|
||
or have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel deletion successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1126" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1127" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1127" aria-labelledby="react-tabs-1126"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// DeleteChannel</span>
|
||
pass<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">DeleteChannel</span><span class="token punctuation">(</span><span class="token operator"><</span>CHANNELID<span class="token operator">></span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1128" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1129" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1130" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1131">401</li><li class="tab-error" role="tab" id="react-tabs-1132" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1133">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1129" aria-labelledby="react-tabs-1128"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1131" aria-labelledby="react-tabs-1130"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1133" aria-labelledby="react-tabs-1132"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1patch/put" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1patch/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1patch/put"></a>Patch a channel<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Partially update a channel by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>If updating a public channel, <code>manage_public_channel_members</code> permission is required. If updating a private channel, <code>manage_private_channel_members</code> permission is required.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Channel object to be updated</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The unique handle for the channel, will be present in the channel URL</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="display_name"><span class="sc-kGXeez bcLONg"></span>display_name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The non-unique UI name for the channel</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="purpose"><span class="sc-kGXeez bcLONg"></span>purpose</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A short description of the purpose of the channel</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="header"><span class="sc-kGXeez bcLONg"></span>header</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Markdown-formatted text to display in the header of the channel</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel patch successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/patch</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/patch</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/patch</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1134" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1135" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1136" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1137">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1135" aria-labelledby="react-tabs-1134"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"purpose"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"header"</span>: <span class="token string">"string"</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-1137" aria-labelledby="react-tabs-1136"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1138" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1139" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1140" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1141">401</li><li class="tab-error" role="tab" id="react-tabs-1142" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1143">403</li><li class="tab-error" role="tab" id="react-tabs-1144" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1145">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1139" aria-labelledby="react-tabs-1138"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1141" aria-labelledby="react-tabs-1140"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1143" aria-labelledby="react-tabs-1142"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1145" aria-labelledby="react-tabs-1144"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1privacy/put" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1privacy/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1privacy/put"></a>Update channel's privacy<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Updates channel's privacy allowing changing a channel from Public to Private and back.</p>
|
||
<p><strong>Minimum server version</strong>: 5.16</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_team</code> permission for the team of the channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="privacy"><span class="sc-kGXeez bcLONg"></span>privacy<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel privacy setting: 'O' for a public channel, 'P' for a private channel</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel conversion successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/privacy</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/privacy</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/privacy</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1146" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1147" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1148" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1149">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1147" aria-labelledby="react-tabs-1146"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"privacy"</span>: <span class="token string">"string"</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-1149" aria-labelledby="react-tabs-1148"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1150" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1151" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1152" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1153">401</li><li class="tab-error" role="tab" id="react-tabs-1154" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1155">403</li><li class="tab-error" role="tab" id="react-tabs-1156" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1157">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1151" aria-labelledby="react-tabs-1150"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1153" aria-labelledby="react-tabs-1152"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1155" aria-labelledby="react-tabs-1154"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1157" aria-labelledby="react-tabs-1156"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1convert/post" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1convert/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1convert/post"></a>Convert a channel from public to private<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Will be deprecated in 6.0</p>
|
||
<p>Convert into private channel from the provided channel id string.</p>
|
||
<p><strong>Minimum server version</strong>: 4.10</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_team</code> permission for the team of the channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel conversion successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/convert</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/convert</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/convert</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1158" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1159" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1159" aria-labelledby="react-tabs-1158"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// ConvertChannelToPrivate</span>
|
||
convertedChannel<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">ConvertChannelToPrivate</span><span class="token punctuation">(</span><span class="token operator"><</span>CHANNELID<span class="token operator">></span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1160" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1161" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1162" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1163">401</li><li class="tab-error" role="tab" id="react-tabs-1164" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1165">403</li><li class="tab-error" role="tab" id="react-tabs-1166" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1167">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1161" aria-labelledby="react-tabs-1160"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1163" aria-labelledby="react-tabs-1162"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1165" aria-labelledby="react-tabs-1164"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1167" aria-labelledby="react-tabs-1166"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1restore/post" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1restore/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1restore/post"></a>Restore a channel<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Restore channel from the provided channel id string.</p>
|
||
<p><strong>Minimum server version</strong>: 3.10</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_team</code> permission for the team of the channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel restore successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/restore</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/restore</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/restore</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1168" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1169" tabindex="0">401</li><li class="tab-error" role="tab" id="react-tabs-1170" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1171">403</li><li class="tab-error" role="tab" id="react-tabs-1172" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1173">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1169" aria-labelledby="react-tabs-1168"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1171" aria-labelledby="react-tabs-1170"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1173" aria-labelledby="react-tabs-1172"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1stats/get" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1stats/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1stats/get"></a>Get channel statistics<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get statistics for a channel.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have the <code>read_channel</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel statistics retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/stats</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/stats</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/stats</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1174" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1175" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1175" aria-labelledby="react-tabs-1174"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetChannelStats</span>
|
||
stats<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetChannelStats</span><span class="token punctuation">(</span><span class="token operator"><</span>CHANNELID<span class="token operator">></span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1176" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1177" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1178" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1179">401</li><li class="tab-error" role="tab" id="react-tabs-1180" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1181">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1177" aria-labelledby="react-tabs-1176"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1179" aria-labelledby="react-tabs-1178"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1181" aria-labelledby="react-tabs-1180"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1pinned/get" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1pinned/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1pinned/get"></a>Get a channel's pinned posts<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of pinned posts for channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>The list of channel pinned posts</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/pinned</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/pinned</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/pinned</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1182" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1183" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1183" aria-labelledby="react-tabs-1182"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetPinnedPosts</span>
|
||
posts<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetPinnedPosts</span><span class="token punctuation">(</span><span class="token operator"><</span>CHANNELID<span class="token operator">></span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1184" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1185" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1186" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1187">401</li><li class="tab-error" role="tab" id="react-tabs-1188" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1189">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1185" aria-labelledby="react-tabs-1184"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1187" aria-labelledby="react-tabs-1186"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1189" aria-labelledby="react-tabs-1188"></div></div></div></div></div></div><div id="tag/channels/paths/~1teams~1{team_id}~1channels/get" data-section-id="tag/channels/paths/~1teams~1{team_id}~1channels/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1teams~1{team_id}~1channels/get"></a>Get public channels<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of public channels on a team based on query string parameters - page and per_page.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and have the <code>list_team_channels</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of public channels per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channels retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/channels</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/channels</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/channels</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1190" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1191" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1191" aria-labelledby="react-tabs-1190"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
<span class="token comment">// GetPublicChannelsForTeam</span>
|
||
channels<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetPublicChannelsForTeam</span><span class="token punctuation">(</span><span class="token operator"><</span>TEAMID<span class="token operator">></span><span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">100</span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1192" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1193" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1194" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1195">401</li><li class="tab-error" role="tab" id="react-tabs-1196" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1197">403</li><li class="tab-error" role="tab" id="react-tabs-1198" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1199">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1193" aria-labelledby="react-tabs-1192"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1195" aria-labelledby="react-tabs-1194"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1197" aria-labelledby="react-tabs-1196"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1199" aria-labelledby="react-tabs-1198"></div></div></div></div></div></div><div id="tag/channels/paths/~1teams~1{team_id}~1channels~1deleted/get" data-section-id="tag/channels/paths/~1teams~1{team_id}~1channels~1deleted/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1teams~1{team_id}~1channels~1deleted/get"></a>Get deleted channels<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of deleted channels on a team based on query string parameters - team_id, page and per_page.</p>
|
||
<p><strong>Minimum server version</strong>: 3.10</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of public channels per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channels retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/channels/deleted</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/channels/deleted</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/channels/deleted</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1200" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1201" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1202" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1203">401</li><li class="tab-error" role="tab" id="react-tabs-1204" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1205">403</li><li class="tab-error" role="tab" id="react-tabs-1206" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1207">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1201" aria-labelledby="react-tabs-1200"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1203" aria-labelledby="react-tabs-1202"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1205" aria-labelledby="react-tabs-1204"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1207" aria-labelledby="react-tabs-1206"></div></div></div></div></div></div><div id="tag/channels/paths/~1teams~1{team_id}~1channels~1autocomplete/get" data-section-id="tag/channels/paths/~1teams~1{team_id}~1channels~1autocomplete/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1teams~1{team_id}~1channels~1autocomplete/get"></a>Autocomplete channels<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Autocomplete public channels on a team based on the search term provided in the request URL.</p>
|
||
<p><strong>Minimum server version</strong>: 4.7</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have the <code>list_team_channels</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Name or display name</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channels autocomplete successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/channels/autocomplete</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/channels/autocomplete</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/channels/autocomplete</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1208" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1209" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1210" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1211">401</li><li class="tab-error" role="tab" id="react-tabs-1212" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1213">403</li><li class="tab-error" role="tab" id="react-tabs-1214" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1215">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1209" aria-labelledby="react-tabs-1208"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1211" aria-labelledby="react-tabs-1210"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1213" aria-labelledby="react-tabs-1212"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1215" aria-labelledby="react-tabs-1214"></div></div></div></div></div></div><div id="tag/channels/paths/~1teams~1{team_id}~1channels~1search_autocomplete/get" data-section-id="tag/channels/paths/~1teams~1{team_id}~1channels~1search_autocomplete/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1teams~1{team_id}~1channels~1search_autocomplete/get"></a>Autocomplete channels for search<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Autocomplete your channels on a team based on the search term provided in the request URL.</p>
|
||
<p><strong>Minimum server version</strong>: 5.4</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have the <code>list_team_channels</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Name or display name</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channels autocomplete successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/channels/search_autocomplete</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/channels/search_autocomplete</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/channels/search_autocomplete</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1216" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1217" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1218" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1219">401</li><li class="tab-error" role="tab" id="react-tabs-1220" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1221">403</li><li class="tab-error" role="tab" id="react-tabs-1222" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1223">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1217" aria-labelledby="react-tabs-1216"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1219" aria-labelledby="react-tabs-1218"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1221" aria-labelledby="react-tabs-1220"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1223" aria-labelledby="react-tabs-1222"></div></div></div></div></div></div><div id="tag/channels/paths/~1teams~1{team_id}~1channels~1search/post" data-section-id="tag/channels/paths/~1teams~1{team_id}~1channels~1search/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1teams~1{team_id}~1channels~1search/post"></a>Search channels<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Search public channels on a team based on the search term provided in the request body.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have the <code>list_team_channels</code> permission.</p>
|
||
<p>In server version 5.16 and later, a user without the <code>list_team_channels</code> permission will be able to use this endpoint, with the search results limited to the channels that the user is a member of.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Search criteria</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="term"><span class="sc-kGXeez bcLONg"></span>term<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The search term to match against the name or display name of channels</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channels search successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/channels/search</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/channels/search</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/channels/search</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1224" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1225" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1226" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1227">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1225" aria-labelledby="react-tabs-1224"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"term"</span>: <span class="token string">"string"</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-1227" aria-labelledby="react-tabs-1226"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1228" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1229" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1230" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1231">401</li><li class="tab-error" role="tab" id="react-tabs-1232" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1233">403</li><li class="tab-error" role="tab" id="react-tabs-1234" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1235">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1229" aria-labelledby="react-tabs-1228"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1231" aria-labelledby="react-tabs-1230"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1233" aria-labelledby="react-tabs-1232"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1235" aria-labelledby="react-tabs-1234"></div></div></div></div></div></div><div id="tag/channels/paths/~1teams~1{team_id}~1channels~1search_archived/post" data-section-id="tag/channels/paths/~1teams~1{team_id}~1channels~1search_archived/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1teams~1{team_id}~1channels~1search_archived/post"></a>Search archived channels<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Search archived channels on a team based on the search term provided in the request body.</p>
|
||
<p><strong>Minimum server version</strong>: 5.18</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have the <code>list_team_channels</code> permission.</p>
|
||
<p>In server version 5.18 and later, a user without the <code>list_team_channels</code> permission will be able to use this endpoint, with the search results limited to the channels that the user is a member of.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Search criteria</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="term"><span class="sc-kGXeez bcLONg"></span>term<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The search term to match against the name or display name of archived channels</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channels search successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/channels/search_archived</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/channels/search_archived</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/channels/search_archived</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1236" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1237" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1238" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1239">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1237" aria-labelledby="react-tabs-1236"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"term"</span>: <span class="token string">"string"</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-1239" aria-labelledby="react-tabs-1238"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1240" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1241" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1242" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1243">401</li><li class="tab-error" role="tab" id="react-tabs-1244" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1245">403</li><li class="tab-error" role="tab" id="react-tabs-1246" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1247">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1241" aria-labelledby="react-tabs-1240"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1243" aria-labelledby="react-tabs-1242"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1245" aria-labelledby="react-tabs-1244"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1247" aria-labelledby="react-tabs-1246"></div></div></div></div></div></div><div id="tag/channels/paths/~1teams~1{team_id}~1channels~1name~1{channel_name}/get" data-section-id="tag/channels/paths/~1teams~1{team_id}~1channels~1name~1{channel_name}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1teams~1{team_id}~1channels~1name~1{channel_name}/get"></a>Get a channel by name<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Gets channel from the provided team id and channel name strings.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>read_channel</code> permission for the channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_name"><span class="sc-kGXeez bcLONg"></span>channel_name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel Name</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="include_deleted"><span class="sc-kGXeez bcLONg"></span>include_deleted</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">false</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Defines if deleted channels should be returned or not</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/channels/name/{channel_name}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/channels/name/{channel_name}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/channels/name/{channel_name}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1248" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1249" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1249" aria-labelledby="react-tabs-1248"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetChannelByName</span>
|
||
channel<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetChannelByName</span><span class="token punctuation">(</span><span class="token operator"><</span>CHANNEL NAME<span class="token operator">></span><span class="token punctuation">,</span> <span class="token operator"><</span>TEAMID<span class="token operator">></span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1250" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1251" tabindex="0">401</li><li class="tab-error" role="tab" id="react-tabs-1252" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1253">403</li><li class="tab-error" role="tab" id="react-tabs-1254" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1255">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1251" aria-labelledby="react-tabs-1250"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1253" aria-labelledby="react-tabs-1252"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1255" aria-labelledby="react-tabs-1254"></div></div></div></div></div></div><div id="tag/channels/paths/~1teams~1name~1{team_name}~1channels~1name~1{channel_name}/get" data-section-id="tag/channels/paths/~1teams~1name~1{team_name}~1channels~1name~1{channel_name}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1teams~1name~1{team_name}~1channels~1name~1{channel_name}/get"></a>Get a channel by name and team name<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Gets a channel from the provided team name and channel name strings.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>read_channel</code> permission for the channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_name"><span class="sc-kGXeez bcLONg"></span>team_name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team Name</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_name"><span class="sc-kGXeez bcLONg"></span>channel_name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel Name</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="include_deleted"><span class="sc-kGXeez bcLONg"></span>include_deleted</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">false</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Defines if deleted channels should be returned or not</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/name/{team_name}/channels/name/{channel_name}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/name/{team_name}/channels/name/{channel_name}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/name/{team_name}/channels/name/{channel_name}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1256" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1257" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1257" aria-labelledby="react-tabs-1256"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetChannelByNameForTeamName</span>
|
||
channel<span class="token punctuation">,</span> resp <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">GetChannelByNameForTeamName</span><span class="token punctuation">(</span><span class="token operator"><</span>CHANNEL NAME<span class="token operator">></span><span class="token punctuation">,</span> <span class="token operator"><</span>TEAM NAME<span class="token operator">></span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1258" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1259" tabindex="0">401</li><li class="tab-error" role="tab" id="react-tabs-1260" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1261">403</li><li class="tab-error" role="tab" id="react-tabs-1262" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1263">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1259" aria-labelledby="react-tabs-1258"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1261" aria-labelledby="react-tabs-1260"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1263" aria-labelledby="react-tabs-1262"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1members/get" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1members/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1members/get"></a>Get channel members<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of members for a channel.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>read_channel</code> permission for the channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of members per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel members retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/members</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1264" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1265" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1265" aria-labelledby="react-tabs-1264"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetChannelMembers</span>
|
||
members<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetChannelMembers</span><span class="token punctuation">(</span>th<span class="token punctuation">.</span>BasicChannel<span class="token punctuation">.</span>Id<span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">60</span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1266" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1267" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1268" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1269">401</li><li class="tab-error" role="tab" id="react-tabs-1270" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1271">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1267" aria-labelledby="react-tabs-1266"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1269" aria-labelledby="react-tabs-1268"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1271" aria-labelledby="react-tabs-1270"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1members/post" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1members/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1members/post"></a>Add user to channel<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Add a user to a channel by creating a channel member object.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The channel ID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of user to add into the channel</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="post_root_id"><span class="sc-kGXeez bcLONg"></span>post_root_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of root post where link to add channel member originates</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel member creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/members</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1272" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1273" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1274" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1275">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1273" aria-labelledby="react-tabs-1272"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"post_root_id"</span>: <span class="token string">"string"</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-1275" aria-labelledby="react-tabs-1274"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1276" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1277" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1278" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1279">401</li><li class="tab-error" role="tab" id="react-tabs-1280" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1281">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1277" aria-labelledby="react-tabs-1276"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1279" aria-labelledby="react-tabs-1278"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1281" aria-labelledby="react-tabs-1280"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1members~1ids/post" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1members~1ids/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1members~1ids/post"></a>Get channel members by ids<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of channel members based on the provided user ids.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have the <code>read_channel</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>List of user ids</p>
|
||
</div><div><div class="sc-hMqMXs dDdNtD"> Array </div><div class="sc-gGBfsJ bvBDls"><div><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></div></div><div class="sc-kEYyzF cMefLx"></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel member list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/members/ids</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members/ids</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members/ids</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1282" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1283" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1284" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1285">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1283" aria-labelledby="react-tabs-1282"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"string"</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-1285" aria-labelledby="react-tabs-1284"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1286" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1287" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1288" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1289">401</li><li class="tab-error" role="tab" id="react-tabs-1290" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1291">403</li><li class="tab-error" role="tab" id="react-tabs-1292" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1293">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1287" aria-labelledby="react-tabs-1286"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1289" aria-labelledby="react-tabs-1288"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1291" aria-labelledby="react-tabs-1290"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1293" aria-labelledby="react-tabs-1292"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}/get" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}/get"></a>Get channel member<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a channel member.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>read_channel</code> permission for the channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel member retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/members/{user_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members/{user_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members/{user_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1294" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1295" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1295" aria-labelledby="react-tabs-1294"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetChannelMember</span>
|
||
member<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetChannelMember</span><span class="token punctuation">(</span><span class="token operator"><</span>CHANNELID<span class="token operator">></span><span class="token punctuation">,</span> <span class="token operator"><</span>USERID<span class="token operator">></span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1296" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1297" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1298" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1299">401</li><li class="tab-error" role="tab" id="react-tabs-1300" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1301">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1297" aria-labelledby="react-tabs-1296"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1299" aria-labelledby="react-tabs-1298"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1301" aria-labelledby="react-tabs-1300"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}/delete" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}/delete"></a>Remove user from channel<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Delete a channel member, effectively removing them from a channel.</p>
|
||
<p>In server version 5.3 and later, channel members can only be deleted from public or private channels.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_public_channel_members</code> permission if the channel is public.
|
||
<code>manage_private_channel_members</code> permission if the channel is private.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel member deletion successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/members/{user_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members/{user_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members/{user_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1302" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1303" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1303" aria-labelledby="react-tabs-1302"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// RemoveUserFromChannel</span>
|
||
pass<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">RemoveUserFromChannel</span><span class="token punctuation">(</span><span class="token operator"><</span>CHANNELID<span class="token operator">></span><span class="token punctuation">,</span> <span class="token operator"><</span>USERID<span class="token operator">></span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1304" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1305" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1306" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1307">401</li><li class="tab-error" role="tab" id="react-tabs-1308" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1309">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1305" aria-labelledby="react-tabs-1304"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1307" aria-labelledby="react-tabs-1306"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1309" aria-labelledby="react-tabs-1308"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}~1roles/put" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}~1roles/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}~1roles/put"></a>Update channel roles<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update a user's roles for a channel.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_channel_roles</code> permission for the channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Space-delimited channel roles to assign to the user</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="roles"><span class="sc-kGXeez bcLONg"></span>roles<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel roles update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/members/{user_id}/roles</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members/{user_id}/roles</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members/{user_id}/roles</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1310" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1311" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1312" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1313">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1311" aria-labelledby="react-tabs-1310"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"roles"</span>: <span class="token string">"string"</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-1313" aria-labelledby="react-tabs-1312"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1314" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1315" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1316" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1317">401</li><li class="tab-error" role="tab" id="react-tabs-1318" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1319">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1315" aria-labelledby="react-tabs-1314"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1317" aria-labelledby="react-tabs-1316"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1319" aria-labelledby="react-tabs-1318"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}~1schemeRoles/put" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}~1schemeRoles/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}~1schemeRoles/put"></a>Update the scheme-derived roles of a channel member.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update a channel member's scheme_admin/scheme_user properties. Typically this should either be <code>scheme_admin=false, scheme_user=true</code> for ordinary channel member, or <code>scheme_admin=true, scheme_user=true</code> for a channel admin.
|
||
<strong>Minimum server version</strong>: 5.0</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and have the <code>manage_channel_roles</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Scheme properties.</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="scheme_admin"><span class="sc-kGXeez bcLONg"></span>scheme_admin<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="scheme_user"><span class="sc-kGXeez bcLONg"></span>scheme_user<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel member's scheme-derived roles updated successfully.</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/members/{user_id}/schemeRoles</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members/{user_id}/schemeRoles</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members/{user_id}/schemeRoles</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1320" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1321" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1321" aria-labelledby="react-tabs-1320"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"scheme_admin"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scheme_user"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1322" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1323" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1324" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1325">401</li><li class="tab-error" role="tab" id="react-tabs-1326" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1327">403</li><li class="tab-error" role="tab" id="react-tabs-1328" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1329">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1323" aria-labelledby="react-tabs-1322"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1325" aria-labelledby="react-tabs-1324"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1327" aria-labelledby="react-tabs-1326"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1329" aria-labelledby="react-tabs-1328"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}~1notify_props/put" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}~1notify_props/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}~1notify_props/put"></a>Update channel notifications<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update a user's notification properties for a channel. Only the provided fields are updated.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user or have <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="email"><span class="sc-kGXeez bcLONg"></span>email</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set to "true" to enable email notifications, "false" to disable, or "default" to use the global user notification setting.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="push"><span class="sc-kGXeez bcLONg"></span>push</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set to "all" to receive push notifications for all activity, "mention" for mentions and direct messages only, "none" to disable, or "default" to use the global user notification setting.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="desktop"><span class="sc-kGXeez bcLONg"></span>desktop</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set to "all" to receive desktop notifications for all activity, "mention" for mentions and direct messages only, "none" to disable, or "default" to use the global user notification setting.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="mark_unread"><span class="sc-kGXeez bcLONg"></span>mark_unread</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set to "all" to mark the channel unread for any new message, "mention" to mark unread for new mentions only. Defaults to "all".</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel notification properties update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/members/{user_id}/notify_props</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members/{user_id}/notify_props</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members/{user_id}/notify_props</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1330" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1331" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1332" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1333">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1331" aria-labelledby="react-tabs-1330"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mark_unread"</span>: <span class="token string">"string"</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-1333" aria-labelledby="react-tabs-1332"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1334" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1335" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1336" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1337">401</li><li class="tab-error" role="tab" id="react-tabs-1338" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1339">403</li><li class="tab-error" role="tab" id="react-tabs-1340" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1341">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1335" aria-labelledby="react-tabs-1334"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1337" aria-labelledby="react-tabs-1336"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1339" aria-labelledby="react-tabs-1338"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1341" aria-labelledby="react-tabs-1340"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1members~1{user_id}~1view/post" data-section-id="tag/channels/paths/~1channels~1members~1{user_id}~1view/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1members~1{user_id}~1view/post"></a>View channel<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Perform all the actions involved in viewing a channel. This includes marking channels as read, clearing push notifications, and updating the active channel.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as user or have <code>edit_other_users</code> permission.</p>
|
||
<p><strong>Response only includes <code>last_viewed_at_times</code> in Mattermost server 4.3 and newer.</strong></p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User ID to perform the view action for</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Paremeters affecting how and which channels to view</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The channel ID that is being viewed. Use a blank string to indicate that all channels have lost focus.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="prev_channel_id"><span class="sc-kGXeez bcLONg"></span>prev_channel_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The channel ID of the previous channel, used when switching channels. Providing this ID will cause push notifications to clear on the channel being switched to.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel view successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/channels/members/{user_id}/view</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/members/{user_id}/view</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/members/{user_id}/view</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1342" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1343" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1344" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1345">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1343" aria-labelledby="react-tabs-1342"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prev_channel_id"</span>: <span class="token string">"string"</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-1345" aria-labelledby="react-tabs-1344"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1346" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1347" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1348" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1349">401</li><li class="tab-error" role="tab" id="react-tabs-1350" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1351">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1347" aria-labelledby="react-tabs-1346"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1349" aria-labelledby="react-tabs-1348"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1351" aria-labelledby="react-tabs-1350"></div></div></div></div></div></div><div id="tag/channels/paths/~1users~1{user_id}~1teams~1{team_id}~1channels~1members/get" data-section-id="tag/channels/paths/~1users~1{user_id}~1teams~1{team_id}~1channels~1members/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1users~1{user_id}~1teams~1{team_id}~1channels~1members/get"></a>Get channel memberships and roles for a user<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get all channel memberships and associated membership roles (i.e. <code>channel_user</code>, <code>channel_admin</code>) for a user on a specific team.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Logged in as the user and <code>view_team</code> permission for the team. Having <code>manage_system</code> permission voids the previous requirements.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel members retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/teams/{team_id}/channels/members</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/teams/{team_id}/channels/members</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/teams/{team_id}/channels/members</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1352" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1353" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1353" aria-labelledby="react-tabs-1352"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetChannelMembersForUser</span>
|
||
members<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetChannelMembersForUser</span><span class="token punctuation">(</span><span class="token operator"><</span>USERID<span class="token operator">></span><span class="token punctuation">,</span> <span class="token operator"><</span>TEAMID<span class="token operator">></span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1354" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1355" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1356" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1357">401</li><li class="tab-error" role="tab" id="react-tabs-1358" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1359">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1355" aria-labelledby="react-tabs-1354"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1357" aria-labelledby="react-tabs-1356"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1359" aria-labelledby="react-tabs-1358"></div></div></div></div></div></div><div id="tag/channels/paths/~1users~1{user_id}~1teams~1{team_id}~1channels/get" data-section-id="tag/channels/paths/~1users~1{user_id}~1teams~1{team_id}~1channels/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1users~1{user_id}~1teams~1{team_id}~1channels/get"></a>Get channels for user<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get all the channels on a team for a user.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Logged in as the user, or have <code>edit_other_users</code> permission, and <code>view_team</code> permission for the team.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channels retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/teams/{team_id}/channels</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/teams/{team_id}/channels</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/teams/{team_id}/channels</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1360" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1361" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1361" aria-labelledby="react-tabs-1360"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetChannelsForTeamForUser</span>
|
||
channels<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetChannelsForTeamForUser</span><span class="token punctuation">(</span><span class="token operator"><</span>TEAMID<span class="token operator">></span><span class="token punctuation">,</span> <span class="token operator"><</span>USERID<span class="token operator">></span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1362" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1363" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1364" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1365">401</li><li class="tab-error" role="tab" id="react-tabs-1366" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1367">403</li><li class="tab-error" role="tab" id="react-tabs-1368" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1369">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1363" aria-labelledby="react-tabs-1362"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1365" aria-labelledby="react-tabs-1364"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1367" aria-labelledby="react-tabs-1366"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1369" aria-labelledby="react-tabs-1368"></div></div></div></div></div></div><div id="tag/channels/paths/~1users~1{user_id}~1channels~1{channel_id}~1unread/get" data-section-id="tag/channels/paths/~1users~1{user_id}~1channels~1{channel_id}~1unread/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1users~1{user_id}~1channels~1{channel_id}~1unread/get"></a>Get unread messages<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get the total unread messages and mentions for a channel for a user.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as user and have the <code>read_channel</code> permission, or have <code>edit_other_usrs</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel unreads retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/channels/{channel_id}/unread</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/channels/{channel_id}/unread</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/channels/{channel_id}/unread</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1370" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1371" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1371" aria-labelledby="react-tabs-1370"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetChannelUnread</span>
|
||
channelUnread<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetChannelUnread</span><span class="token punctuation">(</span><span class="token operator"><</span>CHANNELID<span class="token operator">></span><span class="token punctuation">,</span> <span class="token operator"><</span>USERID<span class="token operator">></span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1372" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1373" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1374" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1375">401</li><li class="tab-error" role="tab" id="react-tabs-1376" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1377">403</li><li class="tab-error" role="tab" id="react-tabs-1378" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1379">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1373" aria-labelledby="react-tabs-1372"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1375" aria-labelledby="react-tabs-1374"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1377" aria-labelledby="react-tabs-1376"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1379" aria-labelledby="react-tabs-1378"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1scheme/put" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1scheme/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1scheme/put"></a>Set a channel's scheme<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Set a channel's scheme, more specifically sets the scheme_id value of a channel record.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 4.10</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Scheme GUID</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="scheme_id"><span class="sc-kGXeez bcLONg"></span>scheme_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the scheme.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Update channel scheme successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/scheme</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/scheme</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/scheme</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1380" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1381" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1382" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1383">Go</li><li class="react-tabs__tab" role="tab" id="react-tabs-1384" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1385">curl</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1381" aria-labelledby="react-tabs-1380"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"scheme_id"</span>: <span class="token string">"string"</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-1383" aria-labelledby="react-tabs-1382"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1385" aria-labelledby="react-tabs-1384"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1386" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1387" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1388" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1389">401</li><li class="tab-error" role="tab" id="react-tabs-1390" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1391">403</li><li class="tab-error" role="tab" id="react-tabs-1392" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1393">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1387" aria-labelledby="react-tabs-1386"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1389" aria-labelledby="react-tabs-1388"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1391" aria-labelledby="react-tabs-1390"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1393" aria-labelledby="react-tabs-1392"></div></div></div></div></div></div><div id="tag/channels/paths/~1channels~1{channel_id}~1members_minus_group_members/get" data-section-id="tag/channels/paths/~1channels~1{channel_id}~1members_minus_group_members/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/channels/paths/~1channels~1{channel_id}~1members_minus_group_members/get"></a>Channel members minus group members.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get the set of users who are members of the channel minus the set of users who are members of the given groups.
|
||
Each user object contains an array of group objects representing the group memberships for that user.
|
||
Each user object contains the boolean fields <code>scheme_guest</code>, <code>scheme_user</code>, and <code>scheme_admin</code> representing the roles that user has for the given channel.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.14</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_ids"><span class="sc-kGXeez bcLONg"></span>group_ids<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">""</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A comma-separated list of group ids.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of users per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT hLVzSF"><strong>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Successfully returns users specified by the pagination, and the total_count.</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/members_minus_group_members</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members_minus_group_members</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/members_minus_group_members</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1394" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1395" tabindex="0">curl</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1395" aria-labelledby="react-tabs-1394"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp">curl <span class="token operator">-</span>X GET \
|
||
<span class="token string">'http://your-mattermost-url.com/api/v4/channels/3wyp678obid8pggjmhmhwpah1r/members_minus_group_members?group_ids=eoezijg8zffgjmch8icy5bjd1e,ugaw6wjc3tfxpcr1eq5u5k8dhe&page=0&per_page=100'</span> \
|
||
<span class="token operator">-</span>H <span class="token string">'Authorization: Bearer kno8tcdotpbx3dj1gzcbx9jrqy'</span> \
|
||
<span class="token operator">-</span>H <span class="token string">'Content-Type: application/json'</span> \
|
||
<span class="token operator">-</span>H <span class="token string">'X-Requested-With: XMLHttpRequest'</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1396" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1397" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1398" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1399">401</li><li class="tab-error" role="tab" id="react-tabs-1400" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1401">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1397" aria-labelledby="react-tabs-1396"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1399" aria-labelledby="react-tabs-1398"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1401" aria-labelledby="react-tabs-1400"></div></div></div></div></div></div><div id="tag/posts" data-section-id="tag/posts" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/posts"></a>posts</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for creating, getting and interacting with posts.</p>
|
||
</div></div></div><div id="tag/posts/paths/~1posts/post" data-section-id="tag/posts/paths/~1posts/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/posts/paths/~1posts/post"></a>Create a post<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Create a new post in a channel. To create the post as a comment on another post, provide <code>root_id</code>.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>create_post</code> permission for the channel the post is being created in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="set_online"><span class="sc-kGXeez bcLONg"></span>set_online</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Whether to set the user status as online or not.</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Post object to create</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The channel ID to post in</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="message"><span class="sc-kGXeez bcLONg"></span>message<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The message contents, can be formatted with Markdown</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="root_id"><span class="sc-kGXeez bcLONg"></span>root_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The post ID to comment on</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="file_ids"><span class="sc-kGXeez bcLONg"></span>file_ids</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc">Array of </span><span class="sc-cHGsZl sc-kgAjT hqYVjx">strings</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A list of file IDs to associate with the post. Note that posts are limited to 5 files maximum. Please use additional posts for more files.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="props"><span class="sc-kGXeez bcLONg"></span>props</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A general JSON property bag to attach to the post</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Post creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/posts</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/posts</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/posts</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1402" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1403" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1403" aria-labelledby="react-tabs-1402"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"root_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"props"</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-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1404" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1405" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-1406" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1407">400</li><li class="tab-error" role="tab" id="react-tabs-1408" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1409">401</li><li class="tab-error" role="tab" id="react-tabs-1410" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1411">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1405" aria-labelledby="react-tabs-1404"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edit_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"root_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"original_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hashtag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filenames"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"pending_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeds"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emojis"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"files"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"images"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reactions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</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-1407" aria-labelledby="react-tabs-1406"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1409" aria-labelledby="react-tabs-1408"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1411" aria-labelledby="react-tabs-1410"></div></div></div></div></div></div><div id="tag/posts/paths/~1posts~1ephemeral/post" data-section-id="tag/posts/paths/~1posts~1ephemeral/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/posts/paths/~1posts~1ephemeral/post"></a>Create a ephemeral post<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Create a new ephemeral post in a channel.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>create_post_ephemeral</code> permission (currently only given to system admin)</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Ephemeral Post object to send</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The target user id for the ephemeral post</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="post"><span class="sc-kGXeez bcLONg"></span>post<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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><div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Post object to create</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Post creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/posts/ephemeral</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/posts/ephemeral</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/posts/ephemeral</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1412" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1413" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1414" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1415">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1413" aria-labelledby="react-tabs-1412"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"post"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</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-1415" aria-labelledby="react-tabs-1414"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1416" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1417" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-1418" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1419">400</li><li class="tab-error" role="tab" id="react-tabs-1420" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1421">401</li><li class="tab-error" role="tab" id="react-tabs-1422" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1423">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1417" aria-labelledby="react-tabs-1416"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edit_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"root_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"original_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hashtag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filenames"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"pending_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeds"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emojis"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"files"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"images"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reactions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</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-1419" aria-labelledby="react-tabs-1418"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1421" aria-labelledby="react-tabs-1420"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1423" aria-labelledby="react-tabs-1422"></div></div></div></div></div></div><div id="tag/posts/paths/~1posts~1{post_id}/get" data-section-id="tag/posts/paths/~1posts~1{post_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/posts/paths/~1posts~1{post_id}/get"></a>Get a post<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a single post.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_channel</code> permission for the channel the post is in or if the channel is public, have the <code>read_public_channels</code> permission for the team.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="post_id"><span class="sc-kGXeez bcLONg"></span>post_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of the post to get</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Post retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/posts/{post_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/posts/{post_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/posts/{post_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1424" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1425" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1426" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1427">400</li><li class="tab-error" role="tab" id="react-tabs-1428" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1429">401</li><li class="tab-error" role="tab" id="react-tabs-1430" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1431">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1425" aria-labelledby="react-tabs-1424"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edit_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"root_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"original_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hashtag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filenames"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"pending_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeds"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emojis"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"files"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"images"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reactions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</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-1427" aria-labelledby="react-tabs-1426"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1429" aria-labelledby="react-tabs-1428"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1431" aria-labelledby="react-tabs-1430"></div></div></div></div></div></div><div id="tag/posts/paths/~1posts~1{post_id}/delete" data-section-id="tag/posts/paths/~1posts~1{post_id}/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/posts/paths/~1posts~1{post_id}/delete"></a>Delete a post<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Soft deletes a post, by marking the post as deleted in the database. Soft deleted posts will not be returned in post queries.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user or have <code>delete_others_posts</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="post_id"><span class="sc-kGXeez bcLONg"></span>post_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of the post to delete</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Post deletion successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/posts/{post_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/posts/{post_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/posts/{post_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1432" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1433" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1434" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1435">400</li><li class="tab-error" role="tab" id="react-tabs-1436" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1437">401</li><li class="tab-error" role="tab" id="react-tabs-1438" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1439">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1433" aria-labelledby="react-tabs-1432"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-1435" aria-labelledby="react-tabs-1434"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1437" aria-labelledby="react-tabs-1436"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1439" aria-labelledby="react-tabs-1438"></div></div></div></div></div></div><div id="tag/posts/paths/~1posts~1{post_id}/put" data-section-id="tag/posts/paths/~1posts~1{post_id}/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/posts/paths/~1posts~1{post_id}/put"></a>Update a post<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update a post. Only the fields listed below are updatable, omitted fields will be treated as blank.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>edit_post</code> permission for the channel the post is in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="post_id"><span class="sc-kGXeez bcLONg"></span>post_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of the post to update</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Post object that is to be updated</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="id"><span class="sc-kGXeez bcLONg"></span>id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of the post to update</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="is_pinned"><span class="sc-kGXeez bcLONg"></span>is_pinned</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set to <code>true</code> to pin the post to the channel it is in</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="message"><span class="sc-kGXeez bcLONg"></span>message</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The message text of the post</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="has_reactions"><span class="sc-kGXeez bcLONg"></span>has_reactions</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set to <code>true</code> if the post has reactions to it</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="props"><span class="sc-kGXeez bcLONg"></span>props</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A general JSON property bag to attach to the post</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Post update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/posts/{post_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/posts/{post_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/posts/{post_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1440" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1441" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1441" aria-labelledby="react-tabs-1440"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_pinned"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_reactions"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"props"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1442" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1443" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1444" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1445">400</li><li class="tab-error" role="tab" id="react-tabs-1446" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1447">401</li><li class="tab-error" role="tab" id="react-tabs-1448" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1449">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1443" aria-labelledby="react-tabs-1442"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edit_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"root_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"original_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hashtag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filenames"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"pending_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeds"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emojis"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"files"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"images"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reactions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</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-1445" aria-labelledby="react-tabs-1444"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1447" aria-labelledby="react-tabs-1446"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1449" aria-labelledby="react-tabs-1448"></div></div></div></div></div></div><div id="tag/posts/paths/~1user~1{user_id}~1posts~1{post_id}~1set_unread/post" data-section-id="tag/posts/paths/~1user~1{user_id}~1posts~1{post_id}~1set_unread/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/posts/paths/~1user~1{user_id}~1posts~1{post_id}~1set_unread/post"></a>Mark as unread from a post.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Mark a channel as being unread from a given post.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_channel</code> permission for the channel the post is in or if the channel is public, have the <code>read_public_channels</code> permission for the team.
|
||
Must have <code>edit_other_users</code> permission if the user is not the one marking the post for himself.</p>
|
||
<p><strong>Minimum server version</strong>: 5.18</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="post_id"><span class="sc-kGXeez bcLONg"></span>post_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Post GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Post marked as unread successfully</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/user/{user_id}/posts/{post_id}/set_unread</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/user/{user_id}/posts/{post_id}/set_unread</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/user/{user_id}/posts/{post_id}/set_unread</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1450" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1451" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1452" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1453">400</li><li class="tab-error" role="tab" id="react-tabs-1454" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1455">401</li><li class="tab-error" role="tab" id="react-tabs-1456" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1457">403</li><li class="tab-error" role="tab" id="react-tabs-1458" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1459">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1451" aria-labelledby="react-tabs-1450"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mention_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_viewed_at"</span>: <span class="token number">0</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-1453" aria-labelledby="react-tabs-1452"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1455" aria-labelledby="react-tabs-1454"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1457" aria-labelledby="react-tabs-1456"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1459" aria-labelledby="react-tabs-1458"></div></div></div></div></div></div><div id="tag/posts/paths/~1posts~1{post_id}~1patch/put" data-section-id="tag/posts/paths/~1posts~1{post_id}~1patch/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/posts/paths/~1posts~1{post_id}~1patch/put"></a>Patch a post<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Partially update a post by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have the <code>edit_post</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="post_id"><span class="sc-kGXeez bcLONg"></span>post_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Post GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Post object that is to be updated</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="is_pinned"><span class="sc-kGXeez bcLONg"></span>is_pinned</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set to <code>true</code> to pin the post to the channel it is in</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="message"><span class="sc-kGXeez bcLONg"></span>message</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The message text of the post</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="file_ids"><span class="sc-kGXeez bcLONg"></span>file_ids</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc">Array of </span><span class="sc-cHGsZl sc-kgAjT hqYVjx">strings</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The list of files attached to this post</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="has_reactions"><span class="sc-kGXeez bcLONg"></span>has_reactions</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set to <code>true</code> if the post has reactions to it</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="props"><span class="sc-kGXeez bcLONg"></span>props</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A general JSON property bag to attach to the post</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Post patch successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/posts/{post_id}/patch</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/posts/{post_id}/patch</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/posts/{post_id}/patch</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1460" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1461" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1461" aria-labelledby="react-tabs-1460"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_pinned"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"has_reactions"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"props"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1462" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1463" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1464" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1465">400</li><li class="tab-error" role="tab" id="react-tabs-1466" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1467">401</li><li class="tab-error" role="tab" id="react-tabs-1468" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1469">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1463" aria-labelledby="react-tabs-1462"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"edit_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"root_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"original_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hashtag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filenames"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"pending_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeds"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emojis"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"files"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"images"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reactions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</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-1465" aria-labelledby="react-tabs-1464"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1467" aria-labelledby="react-tabs-1466"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1469" aria-labelledby="react-tabs-1468"></div></div></div></div></div></div><div id="tag/posts/paths/~1posts~1{post_id}~1thread/get" data-section-id="tag/posts/paths/~1posts~1{post_id}~1thread/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/posts/paths/~1posts~1{post_id}~1thread/get"></a>Get a thread<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a post and the rest of the posts in the same thread.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_channel</code> permission for the channel the post is in or if the channel is public, have the <code>read_public_channels</code> permission for the team.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="post_id"><span class="sc-kGXeez bcLONg"></span>post_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of a post in the thread</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Post list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/posts/{post_id}/thread</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/posts/{post_id}/thread</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/posts/{post_id}/thread</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1470" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1471" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1472" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1473">400</li><li class="tab-error" role="tab" id="react-tabs-1474" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1475">401</li><li class="tab-error" role="tab" id="react-tabs-1476" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1477">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1471" aria-labelledby="react-tabs-1470"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"order"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"post_id1"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"post_id12"</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">"posts"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"edit_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"root_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parent_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"original_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hashtag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filenames"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pending_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeds"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emojis"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"files"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"images"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reactions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"edit_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"root_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parent_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"original_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hashtag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filenames"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pending_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeds"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emojis"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"files"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"images"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reactions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</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">"next_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prev_post_id"</span>: <span class="token string">"string"</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-1473" aria-labelledby="react-tabs-1472"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1475" aria-labelledby="react-tabs-1474"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1477" aria-labelledby="react-tabs-1476"></div></div></div></div></div></div><div id="tag/posts/paths/~1users~1{user_id}~1posts~1flagged/get" data-section-id="tag/posts/paths/~1users~1{user_id}~1posts~1flagged/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/posts/paths/~1users~1{user_id}~1posts~1flagged/get"></a>Get a list of flagged posts<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of flagged posts of a user provided user id string. Selects from a channel, team or all flagged posts by a user.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be user or have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of the user</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team ID</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel ID</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of posts per page</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Post list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/posts/flagged</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/posts/flagged</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/posts/flagged</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1478" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1479" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1480" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1481">400</li><li class="tab-error" role="tab" id="react-tabs-1482" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1483">401</li><li class="tab-error" role="tab" id="react-tabs-1484" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1485">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1479" aria-labelledby="react-tabs-1478"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"order"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"post_id1"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"post_id12"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"posts"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"edit_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"root_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parent_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"original_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hashtag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filenames"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pending_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeds"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emojis"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"files"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"images"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reactions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"edit_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"root_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parent_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"original_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hashtag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filenames"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pending_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeds"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emojis"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"files"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"images"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reactions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"next_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"prev_post_id"</span>: <span class="token string">"string"</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-1481" aria-labelledby="react-tabs-1480"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1483" aria-labelledby="react-tabs-1482"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1485" aria-labelledby="react-tabs-1484"></div></div></div></div></div></div><div id="tag/posts/paths/~1posts~1{post_id}~1files~1info/get" data-section-id="tag/posts/paths/~1posts~1{post_id}~1files~1info/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/posts/paths/~1posts~1{post_id}~1files~1info/get"></a>Get file info for post<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Gets a list of file information objects for the files attached to a post.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_channel</code> permission for the channel the post is in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="post_id"><span class="sc-kGXeez bcLONg"></span>post_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of the post</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>File info retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/posts/{post_id}/files/info</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/posts/{post_id}/files/info</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/posts/{post_id}/files/info</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1486" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1487" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1488" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1489">400</li><li class="tab-error" role="tab" id="react-tabs-1490" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1491">401</li><li class="tab-error" role="tab" id="react-tabs-1492" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1493">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1487" aria-labelledby="react-tabs-1486"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</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-1489" aria-labelledby="react-tabs-1488"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1491" aria-labelledby="react-tabs-1490"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1493" aria-labelledby="react-tabs-1492"></div></div></div></div></div></div><div id="tag/posts/paths/~1channels~1{channel_id}~1posts/get" data-section-id="tag/posts/paths/~1channels~1{channel_id}~1posts/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/posts/paths/~1channels~1{channel_id}~1posts/get"></a>Get posts for a channel<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of posts in a channel. Use the query parameters to modify the behaviour of this endpoint. The parameters <code>since</code>, <code>before</code> and <code>after</code> must not be used together.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_channel</code> permission for the channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The channel ID to get the posts for</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of posts per page</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="since"><span class="sc-kGXeez bcLONg"></span>since</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Provide a non-zero value in Unix time milliseconds to select posts created after that time</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="before"><span class="sc-kGXeez bcLONg"></span>before</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A post id to select the posts that came before this one</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="after"><span class="sc-kGXeez bcLONg"></span>after</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A post id to select the posts that came after this one</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Post list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/posts</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/posts</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/posts</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1494" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1495" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1496" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1497">400</li><li class="tab-error" role="tab" id="react-tabs-1498" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1499">401</li><li class="tab-error" role="tab" id="react-tabs-1500" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1501">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1495" aria-labelledby="react-tabs-1494"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"order"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"post_id1"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"post_id12"</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">"posts"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"edit_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"root_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parent_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"original_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hashtag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filenames"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pending_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeds"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emojis"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"files"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"images"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reactions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"edit_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"root_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parent_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"original_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hashtag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filenames"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pending_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeds"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emojis"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"files"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"images"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reactions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</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">"next_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prev_post_id"</span>: <span class="token string">"string"</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-1497" aria-labelledby="react-tabs-1496"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1499" aria-labelledby="react-tabs-1498"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1501" aria-labelledby="react-tabs-1500"></div></div></div></div></div></div><div id="tag/posts/paths/~1users~1{user_id}~1channels~1{channel_id}~1posts~1unread/get" data-section-id="tag/posts/paths/~1users~1{user_id}~1channels~1{channel_id}~1posts~1unread/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/posts/paths/~1users~1{user_id}~1channels~1{channel_id}~1posts~1unread/get"></a>Get posts around last unread<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get the oldest unread post in the channel for the given user as well as the posts around it.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user or have <code>edit_other_users</code> permission, and must have <code>read_channel</code> permission for the channel.
|
||
<strong>Minimum server version</strong>: 5.14</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of the user</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The channel ID to get the posts for</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="limit_before"><span class="sc-kGXeez bcLONg"></span>limit_before</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Number of posts before the last unread posts. Maximum is 200 posts if limit is set greater than that.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="limit_after"><span class="sc-kGXeez bcLONg"></span>limit_after</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Number of posts after and including the last unread post. Maximum is 200 posts if limit is set greater than that.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Post list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/channels/{channel_id}/posts/unread</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/channels/{channel_id}/posts/unread</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/channels/{channel_id}/posts/unread</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1502" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1503" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1504" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1505">400</li><li class="tab-error" role="tab" id="react-tabs-1506" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1507">401</li><li class="tab-error" role="tab" id="react-tabs-1508" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1509">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1503" aria-labelledby="react-tabs-1502"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"order"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"post_id1"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"post_id12"</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">"posts"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"edit_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"root_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parent_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"original_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hashtag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filenames"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pending_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeds"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emojis"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"files"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"images"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reactions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"edit_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"root_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parent_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"original_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hashtag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filenames"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pending_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeds"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emojis"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"files"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"images"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reactions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</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">"next_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prev_post_id"</span>: <span class="token string">"string"</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-1505" aria-labelledby="react-tabs-1504"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1507" aria-labelledby="react-tabs-1506"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1509" aria-labelledby="react-tabs-1508"></div></div></div></div></div></div><div id="tag/posts/paths/~1teams~1{team_id}~1posts~1search/post" data-section-id="tag/posts/paths/~1teams~1{team_id}~1posts~1search/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/posts/paths/~1teams~1{team_id}~1posts~1search/post"></a>Search for team posts<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Search posts in the team and from the provided terms string.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and have the <code>view_team</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>The search terms and logic to use in the search.</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="terms"><span class="sc-kGXeez bcLONg"></span>terms<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The search terms as inputed by the user. To search for posts from a user include <code>from:someusername</code>, using a user's username. To search in a specific channel include <code>in:somechannel</code>, using the channel name (not the display name).</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="is_or_search"><span class="sc-kGXeez bcLONg"></span>is_or_search<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set to true if an Or search should be performed vs an And search.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="time_zone_offset"><span class="sc-kGXeez bcLONg"></span>time_zone_offset</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Offset from UTC of user timezone for date searches.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="include_deleted_channels"><span class="sc-kGXeez bcLONg"></span>include_deleted_channels</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set to true if deleted channels should be included in the search. (archived channels)</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select. (Only works with Elasticsearch)</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of posts per page. (Only works with Elasticsearch)</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Post list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/posts/search</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/posts/search</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/posts/search</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1510" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1511" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1511" aria-labelledby="react-tabs-1510"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"terms"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_or_search"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"time_zone_offset"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"include_deleted_channels"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"per_page"</span>: <span class="token number">60</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1512" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1513" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1514" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1515">400</li><li class="tab-error" role="tab" id="react-tabs-1516" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1517">401</li><li class="tab-error" role="tab" id="react-tabs-1518" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1519">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1513" aria-labelledby="react-tabs-1512"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"order"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"post_id1"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"post_id12"</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">"posts"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"property1"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"edit_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"root_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parent_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"original_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hashtag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filenames"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pending_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeds"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emojis"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"files"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"images"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reactions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"property2"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"edit_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"root_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"parent_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"original_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hashtag"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filenames"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"file_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pending_post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"embeds"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"image"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emojis"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"files"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"images"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reactions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</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">"matches"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"post_id1"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"search match 1"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"search match 2"</span></div></li></ul><span class="token punctuation">]</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-1515" aria-labelledby="react-tabs-1514"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1517" aria-labelledby="react-tabs-1516"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1519" aria-labelledby="react-tabs-1518"></div></div></div></div></div></div><div id="tag/posts/paths/~1posts~1{post_id}~1pin/post" data-section-id="tag/posts/paths/~1posts~1{post_id}~1pin/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/posts/paths/~1posts~1{post_id}~1pin/post"></a>Pin a post to the channel<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Pin a post to a channel it is in based from the provided post id string.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and have the <code>read_channel</code> permission to the channel the post is in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="post_id"><span class="sc-kGXeez bcLONg"></span>post_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Post GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Pinned post successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/posts/{post_id}/pin</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/posts/{post_id}/pin</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/posts/{post_id}/pin</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1520" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1521" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1522" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1523">400</li><li class="tab-error" role="tab" id="react-tabs-1524" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1525">401</li><li class="tab-error" role="tab" id="react-tabs-1526" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1527">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1521" aria-labelledby="react-tabs-1520"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-1523" aria-labelledby="react-tabs-1522"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1525" aria-labelledby="react-tabs-1524"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1527" aria-labelledby="react-tabs-1526"></div></div></div></div></div></div><div id="tag/posts/paths/~1posts~1{post_id}~1unpin/post" data-section-id="tag/posts/paths/~1posts~1{post_id}~1unpin/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/posts/paths/~1posts~1{post_id}~1unpin/post"></a>Unpin a post to the channel<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Unpin a post to a channel it is in based from the provided post id string.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and have the <code>read_channel</code> permission to the channel the post is in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="post_id"><span class="sc-kGXeez bcLONg"></span>post_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Post GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Unpinned post successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/posts/{post_id}/unpin</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/posts/{post_id}/unpin</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/posts/{post_id}/unpin</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1528" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1529" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1530" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1531">400</li><li class="tab-error" role="tab" id="react-tabs-1532" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1533">401</li><li class="tab-error" role="tab" id="react-tabs-1534" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1535">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1529" aria-labelledby="react-tabs-1528"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-1531" aria-labelledby="react-tabs-1530"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1533" aria-labelledby="react-tabs-1532"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1535" aria-labelledby="react-tabs-1534"></div></div></div></div></div></div><div id="tag/posts/paths/~1posts~1{post_id}~1actions~1{action_id}/post" data-section-id="tag/posts/paths/~1posts~1{post_id}~1actions~1{action_id}/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/posts/paths/~1posts~1{post_id}~1actions~1{action_id}/post"></a>Perform a post action<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Perform a post action, which allows users to interact with integrations through posts.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated and have the <code>read_channel</code> permission to the channel the post is in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="post_id"><span class="sc-kGXeez bcLONg"></span>post_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Post GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="action_id"><span class="sc-kGXeez bcLONg"></span>action_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Action GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Post action successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/posts/{post_id}/actions/{action_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/posts/{post_id}/actions/{action_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/posts/{post_id}/actions/{action_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1536" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1537" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1538" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1539">400</li><li class="tab-error" role="tab" id="react-tabs-1540" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1541">401</li><li class="tab-error" role="tab" id="react-tabs-1542" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1543">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1537" aria-labelledby="react-tabs-1536"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-1539" aria-labelledby="react-tabs-1538"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1541" aria-labelledby="react-tabs-1540"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1543" aria-labelledby="react-tabs-1542"></div></div></div></div></div></div><div id="tag/files" data-section-id="tag/files" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/files"></a>files</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for uploading and interacting with files.</p>
|
||
</div></div></div><div id="tag/files/paths/~1files/post" data-section-id="tag/files/paths/~1files/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/files/paths/~1files/post"></a>Upload a file<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Uploads a file that can later be attached to a post.</p>
|
||
<p>This request can either be a multipart/form-data request with a channel_id, files and optional
|
||
client_ids defined in the FormData, or it can be a request with the channel_id and filename
|
||
defined as query parameters with the contents of a single file in the body of the request.</p>
|
||
<p>Only multipart/form-data requests are supported by server versions up to and including 4.7.
|
||
Server versions 4.8 and higher support both types of requests.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>upload_file</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the channel that this file will be uploaded to</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="filename"><span class="sc-kGXeez bcLONg"></span>filename</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The name of the file to be uploaded</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">multipart/form-data</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="files"><span class="sc-kGXeez bcLONg"></span>files</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span><span class="sc-cHGsZl sc-kgAjT hqYVjx"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A file to be uploaded</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the channel that this file will be uploaded to</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="client_ids"><span class="sc-kGXeez bcLONg"></span>client_ids</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A unique identifier for the file that will be returned in the response</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Corresponding lists of the provided client_ids and the metadata that has been stored in the database for each one</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>413<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Content too large</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/files</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/files</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/files</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1544" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1545" tabindex="0">Go</li><li class="react-tabs__tab" role="tab" id="react-tabs-1546" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1547">Curl</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1545" aria-labelledby="react-tabs-1544"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
file<span class="token punctuation">,</span> err <span class="token operator">:=</span> os<span class="token punctuation">.</span><span class="token function">Open</span><span class="token punctuation">(</span><span class="token string">"file.png"</span><span class="token punctuation">)</span>
|
||
<span class="token keyword">if</span> err <span class="token operator">!=</span> <span class="token boolean">nil</span> <span class="token punctuation">{</span>
|
||
fmt<span class="token punctuation">.</span><span class="token function">Fprintf</span><span class="token punctuation">(</span>os<span class="token punctuation">.</span>Stderr<span class="token punctuation">,</span> <span class="token string">"%v\n"</span><span class="token punctuation">,</span> err<span class="token punctuation">)</span>
|
||
<span class="token punctuation">}</span>
|
||
<span class="token keyword">defer</span> file<span class="token punctuation">.</span><span class="token function">Close</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||
|
||
buf <span class="token operator">:=</span> bytes<span class="token punctuation">.</span><span class="token function">NewBuffer</span><span class="token punctuation">(</span><span class="token boolean">nil</span><span class="token punctuation">)</span>
|
||
io<span class="token punctuation">.</span><span class="token function">Copy</span><span class="token punctuation">(</span>buf<span class="token punctuation">,</span> file<span class="token punctuation">)</span>
|
||
data <span class="token operator">:=</span> buf<span class="token punctuation">.</span><span class="token function">Bytes</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
|
||
channelID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
filename <span class="token operator">:=</span> <span class="token string">"file.png"</span>
|
||
|
||
fileUploadResponse<span class="token punctuation">,</span> response <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">UploadFile</span><span class="token punctuation">(</span>data<span class="token punctuation">,</span> channelID<span class="token punctuation">,</span> filename<span class="token punctuation">)</span>
|
||
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1547" aria-labelledby="react-tabs-1546"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1548" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1549" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-1550" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1551">400</li><li class="tab-error" role="tab" id="react-tabs-1552" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1553">401</li><li class="tab-error" role="tab" id="react-tabs-1554" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1555">403</li><li class="tab-error" role="tab" id="react-tabs-1556" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1557">413</li><li class="tab-error" role="tab" id="react-tabs-1558" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1559">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1549" aria-labelledby="react-tabs-1548"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"file_infos"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</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">"client_ids"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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-1551" aria-labelledby="react-tabs-1550"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1553" aria-labelledby="react-tabs-1552"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1555" aria-labelledby="react-tabs-1554"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1557" aria-labelledby="react-tabs-1556"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1559" aria-labelledby="react-tabs-1558"></div></div></div></div></div></div><div id="tag/files/paths/~1files~1{file_id}/get" data-section-id="tag/files/paths/~1files~1{file_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/files/paths/~1files~1{file_id}/get"></a>Get a file<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Gets a file that has been uploaded previously.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_channel</code> permission or be uploader of the file.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="file_id"><span class="sc-kGXeez bcLONg"></span>file_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the file to get</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/files/{file_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/files/{file_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/files/{file_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1560" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1561" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1561" aria-labelledby="react-tabs-1560"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
fileID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
data<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetFile</span><span class="token punctuation">(</span>fileID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1562" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1563" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1564" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1565">401</li><li class="tab-error" role="tab" id="react-tabs-1566" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1567">403</li><li class="tab-error" role="tab" id="react-tabs-1568" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1569">404</li><li class="tab-error" role="tab" id="react-tabs-1570" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1571">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1563" aria-labelledby="react-tabs-1562"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1565" aria-labelledby="react-tabs-1564"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1567" aria-labelledby="react-tabs-1566"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1569" aria-labelledby="react-tabs-1568"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1571" aria-labelledby="react-tabs-1570"></div></div></div></div></div></div><div id="tag/files/paths/~1files~1{file_id}~1thumbnail/get" data-section-id="tag/files/paths/~1files~1{file_id}~1thumbnail/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/files/paths/~1files~1{file_id}~1thumbnail/get"></a>Get a file's thumbnail<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Gets a file's thumbnail.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_channel</code> permission or be uploader of the file.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="file_id"><span class="sc-kGXeez bcLONg"></span>file_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the file to get</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/files/{file_id}/thumbnail</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/files/{file_id}/thumbnail</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/files/{file_id}/thumbnail</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1572" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1573" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1573" aria-labelledby="react-tabs-1572"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
fileID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
data<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetFileThumbnail</span><span class="token punctuation">(</span>fileID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1574" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1575" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1576" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1577">401</li><li class="tab-error" role="tab" id="react-tabs-1578" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1579">403</li><li class="tab-error" role="tab" id="react-tabs-1580" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1581">404</li><li class="tab-error" role="tab" id="react-tabs-1582" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1583">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1575" aria-labelledby="react-tabs-1574"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1577" aria-labelledby="react-tabs-1576"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1579" aria-labelledby="react-tabs-1578"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1581" aria-labelledby="react-tabs-1580"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1583" aria-labelledby="react-tabs-1582"></div></div></div></div></div></div><div id="tag/files/paths/~1files~1{file_id}~1preview/get" data-section-id="tag/files/paths/~1files~1{file_id}~1preview/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/files/paths/~1files~1{file_id}~1preview/get"></a>Get a file's preview<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Gets a file's preview.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_channel</code> permission or be uploader of the file.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="file_id"><span class="sc-kGXeez bcLONg"></span>file_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the file to get</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/files/{file_id}/preview</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/files/{file_id}/preview</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/files/{file_id}/preview</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1584" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1585" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1585" aria-labelledby="react-tabs-1584"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
fileID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
data<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetFilePreview</span><span class="token punctuation">(</span>fileID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1586" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1587" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-1588" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1589">401</li><li class="tab-error" role="tab" id="react-tabs-1590" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1591">403</li><li class="tab-error" role="tab" id="react-tabs-1592" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1593">404</li><li class="tab-error" role="tab" id="react-tabs-1594" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1595">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1587" aria-labelledby="react-tabs-1586"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1589" aria-labelledby="react-tabs-1588"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1591" aria-labelledby="react-tabs-1590"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1593" aria-labelledby="react-tabs-1592"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1595" aria-labelledby="react-tabs-1594"></div></div></div></div></div></div><div id="tag/files/paths/~1files~1{file_id}~1link/get" data-section-id="tag/files/paths/~1files~1{file_id}~1link/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/files/paths/~1files~1{file_id}~1link/get"></a>Get a public file link<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Gets a public link for a file that can be accessed without logging into Mattermost.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_channel</code> permission or be uploader of the file.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="file_id"><span class="sc-kGXeez bcLONg"></span>file_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the file to get a link for</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>A publicly accessible link to the given file</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/files/{file_id}/link</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/files/{file_id}/link</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/files/{file_id}/link</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1596" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1597" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1597" aria-labelledby="react-tabs-1596"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
fileID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
data<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetFileLink</span><span class="token punctuation">(</span>fileID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1598" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1599" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1600" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1601">400</li><li class="tab-error" role="tab" id="react-tabs-1602" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1603">401</li><li class="tab-error" role="tab" id="react-tabs-1604" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1605">403</li><li class="tab-error" role="tab" id="react-tabs-1606" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1607">404</li><li class="tab-error" role="tab" id="react-tabs-1608" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1609">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1599" aria-labelledby="react-tabs-1598"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"link"</span>: <span class="token string">"string"</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-1601" aria-labelledby="react-tabs-1600"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1603" aria-labelledby="react-tabs-1602"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1605" aria-labelledby="react-tabs-1604"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1607" aria-labelledby="react-tabs-1606"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1609" aria-labelledby="react-tabs-1608"></div></div></div></div></div></div><div id="tag/files/paths/~1files~1{file_id}~1info/get" data-section-id="tag/files/paths/~1files~1{file_id}~1info/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/files/paths/~1files~1{file_id}~1info/get"></a>Get metadata for a file<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Gets a file's info.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_channel</code> permission or be uploader of the file.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="file_id"><span class="sc-kGXeez bcLONg"></span>file_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the file info to get</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>The stored metadata for the given file</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/files/{file_id}/info</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/files/{file_id}/info</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/files/{file_id}/info</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1610" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1611" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1611" aria-labelledby="react-tabs-1610"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
fileID <span class="token operator">:=</span> <span class="token string">"4xp9fdt77pncbef59f4k1qe83o"</span>
|
||
|
||
info<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetFileInfo</span><span class="token punctuation">(</span>fileID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1612" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1613" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1614" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1615">400</li><li class="tab-error" role="tab" id="react-tabs-1616" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1617">401</li><li class="tab-error" role="tab" id="react-tabs-1618" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1619">403</li><li class="tab-error" role="tab" id="react-tabs-1620" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1621">404</li><li class="tab-error" role="tab" id="react-tabs-1622" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1623">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1613" aria-labelledby="react-tabs-1612"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"extension"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mime_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"height"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_preview_image"</span>: <span class="token boolean">true</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-1615" aria-labelledby="react-tabs-1614"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1617" aria-labelledby="react-tabs-1616"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1619" aria-labelledby="react-tabs-1618"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1621" aria-labelledby="react-tabs-1620"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1623" aria-labelledby="react-tabs-1622"></div></div></div></div></div></div><div id="tag/preferences" data-section-id="tag/preferences" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/preferences"></a>preferences</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for saving and modifying user preferences.</p>
|
||
</div></div></div><div id="tag/preferences/paths/~1users~1{user_id}~1preferences/get" data-section-id="tag/preferences/paths/~1users~1{user_id}~1preferences/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/preferences/paths/~1users~1{user_id}~1preferences/get"></a>Get the user's preferences<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of the user's preferences.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being updated or have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User preferences retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/preferences</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/preferences</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/preferences</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1624" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1625" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1626" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1627">400</li><li class="tab-error" role="tab" id="react-tabs-1628" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1629">401</li><li class="tab-error" role="tab" id="react-tabs-1630" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1631">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1625" aria-labelledby="react-tabs-1624"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"category"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"string"</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-1627" aria-labelledby="react-tabs-1626"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1629" aria-labelledby="react-tabs-1628"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1631" aria-labelledby="react-tabs-1630"></div></div></div></div></div></div><div id="tag/preferences/paths/~1users~1{user_id}~1preferences/put" data-section-id="tag/preferences/paths/~1users~1{user_id}~1preferences/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/preferences/paths/~1users~1{user_id}~1preferences/put"></a>Save the user's preferences<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Save a list of the user's preferences.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being updated or have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>List of preference objects</p>
|
||
</div><div><div class="sc-hMqMXs dDdNtD"> Array </div><div class="sc-gGBfsJ bvBDls"><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the user that owns this preference</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="category"><span class="sc-kGXeez bcLONg"></span>category</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="value"><span class="sc-kGXeez bcLONg"></span>value</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table></div><div class="sc-kEYyzF cMefLx"></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User preferences saved successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/preferences</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/preferences</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/preferences</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1632" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1633" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1633" aria-labelledby="react-tabs-1632"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"category"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"string"</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-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1634" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1635" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1636" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1637">400</li><li class="tab-error" role="tab" id="react-tabs-1638" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1639">401</li><li class="tab-error" role="tab" id="react-tabs-1640" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1641">403</li><li class="tab-error" role="tab" id="react-tabs-1642" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1643">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1635" aria-labelledby="react-tabs-1634"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-1637" aria-labelledby="react-tabs-1636"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1639" aria-labelledby="react-tabs-1638"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1641" aria-labelledby="react-tabs-1640"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1643" aria-labelledby="react-tabs-1642"></div></div></div></div></div></div><div id="tag/preferences/paths/~1users~1{user_id}~1preferences~1delete/post" data-section-id="tag/preferences/paths/~1users~1{user_id}~1preferences~1delete/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/preferences/paths/~1users~1{user_id}~1preferences~1delete/post"></a>Delete user's preferences<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Delete a list of the user's preferences.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being updated or have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>List of preference objects</p>
|
||
</div><div><div class="sc-hMqMXs dDdNtD"> Array </div><div class="sc-gGBfsJ bvBDls"><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the user that owns this preference</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="category"><span class="sc-kGXeez bcLONg"></span>category</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="value"><span class="sc-kGXeez bcLONg"></span>value</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table></div><div class="sc-kEYyzF cMefLx"></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User preferences saved successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/preferences/delete</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/preferences/delete</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/preferences/delete</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1644" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1645" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1645" aria-labelledby="react-tabs-1644"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"category"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"string"</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-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1646" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1647" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1648" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1649">400</li><li class="tab-error" role="tab" id="react-tabs-1650" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1651">401</li><li class="tab-error" role="tab" id="react-tabs-1652" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1653">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1647" aria-labelledby="react-tabs-1646"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-1649" aria-labelledby="react-tabs-1648"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1651" aria-labelledby="react-tabs-1650"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1653" aria-labelledby="react-tabs-1652"></div></div></div></div></div></div><div id="tag/preferences/paths/~1users~1{user_id}~1preferences~1{category}/get" data-section-id="tag/preferences/paths/~1users~1{user_id}~1preferences~1{category}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/preferences/paths/~1users~1{user_id}~1preferences~1{category}/get"></a>List a user's preferences by category<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Lists the current user's stored preferences in the given category.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being updated or have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="category"><span class="sc-kGXeez bcLONg"></span>category<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The category of a group of preferences</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>A list of all of the current user's preferences in the given category</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/preferences/{category}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/preferences/{category}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/preferences/{category}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1654" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1655" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1656" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1657">400</li><li class="tab-error" role="tab" id="react-tabs-1658" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1659">401</li><li class="tab-error" role="tab" id="react-tabs-1660" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1661">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1655" aria-labelledby="react-tabs-1654"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"category"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"string"</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-1657" aria-labelledby="react-tabs-1656"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1659" aria-labelledby="react-tabs-1658"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1661" aria-labelledby="react-tabs-1660"></div></div></div></div></div></div><div id="tag/preferences/paths/~1users~1{user_id}~1preferences~1{category}~1name~1{preference_name}/get" data-section-id="tag/preferences/paths/~1users~1{user_id}~1preferences~1{category}~1name~1{preference_name}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/preferences/paths/~1users~1{user_id}~1preferences~1{category}~1name~1{preference_name}/get"></a>Get a specific user preference<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Gets a single preference for the current user with the given category and name.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being updated or have the <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="category"><span class="sc-kGXeez bcLONg"></span>category<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The category of a group of preferences</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="preference_name"><span class="sc-kGXeez bcLONg"></span>preference_name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The name of the preference</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>A single preference for the current user in the current categorylist of all of the current user's preferences in the given category.</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/preferences/{category}/name/{preference_name}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/preferences/{category}/name/{preference_name}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/preferences/{category}/name/{preference_name}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1662" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1663" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1664" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1665">400</li><li class="tab-error" role="tab" id="react-tabs-1666" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1667">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1663" aria-labelledby="react-tabs-1662"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"category"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">"string"</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-1665" aria-labelledby="react-tabs-1664"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1667" aria-labelledby="react-tabs-1666"></div></div></div></div></div></div><div id="tag/status" data-section-id="tag/status" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/status"></a>status</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for getting and updating user statuses.</p>
|
||
</div></div></div><div id="tag/status/paths/~1users~1{user_id}~1status/get" data-section-id="tag/status/paths/~1users~1{user_id}~1status/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/status/paths/~1users~1{user_id}~1status/get"></a>Get user status<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get user status by id from the server.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User ID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User status retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/status</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/status</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/status</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1668" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1669" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1670" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1671">400</li><li class="tab-error" role="tab" id="react-tabs-1672" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1673">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1669" aria-labelledby="react-tabs-1668"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"manual"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_activity_at"</span>: <span class="token number">0</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-1671" aria-labelledby="react-tabs-1670"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1673" aria-labelledby="react-tabs-1672"></div></div></div></div></div></div><div id="tag/status/paths/~1users~1{user_id}~1status/put" data-section-id="tag/status/paths/~1users~1{user_id}~1status/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/status/paths/~1users~1{user_id}~1status/put"></a>Update user status<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Manually set a user's status. When setting a user's status, the status will remain that value until set "online" again, which will return the status to being automatically updated based on user activity.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>edit_other_users</code> permission for the team.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User ID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Status object that is to be updated</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User ID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="status"><span class="sc-kGXeez bcLONg"></span>status<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User status, can be <code>online</code>, <code>away</code>, <code>offline</code> and <code>dnd</code></p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User status update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/status</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/status</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/status</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1674" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1675" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1675" aria-labelledby="react-tabs-1674"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1676" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1677" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1678" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1679">400</li><li class="tab-error" role="tab" id="react-tabs-1680" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1681">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1677" aria-labelledby="react-tabs-1676"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"manual"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_activity_at"</span>: <span class="token number">0</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-1679" aria-labelledby="react-tabs-1678"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1681" aria-labelledby="react-tabs-1680"></div></div></div></div></div></div><div id="tag/status/paths/~1users~1status~1ids/post" data-section-id="tag/status/paths/~1users~1status~1ids/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/status/paths/~1users~1status~1ids/post"></a>Get user statuses by id<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of user statuses by id from the server.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>List of user ids to fetch</p>
|
||
</div><div><div class="sc-hMqMXs dDdNtD"> Array </div><div class="sc-gGBfsJ bvBDls"><div><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></div></div><div class="sc-kEYyzF cMefLx"></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User statuses retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/status/ids</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/status/ids</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/status/ids</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1682" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1683" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1683" aria-labelledby="react-tabs-1682"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1684" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1685" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1686" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1687">400</li><li class="tab-error" role="tab" id="react-tabs-1688" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1689">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1685" aria-labelledby="react-tabs-1684"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"manual"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_activity_at"</span>: <span class="token number">0</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-1687" aria-labelledby="react-tabs-1686"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1689" aria-labelledby="react-tabs-1688"></div></div></div></div></div></div><div id="tag/emoji" data-section-id="tag/emoji" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/emoji"></a>emoji</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for creating, getting and interacting with emojis.</p>
|
||
</div></div></div><div id="tag/emoji/paths/~1emoji/post" data-section-id="tag/emoji/paths/~1emoji/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/emoji/paths/~1emoji/post"></a>Create a custom emoji<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Create a custom emoji for the team.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">multipart/form-data</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="image"><span class="sc-kGXeez bcLONg"></span>image<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span><span class="sc-cHGsZl sc-kgAjT hqYVjx"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A file to be uploaded</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="emoji"><span class="sc-kGXeez bcLONg"></span>emoji<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A JSON object containing a <code>name</code> field with the name of the emoji and a <code>creator_id</code> field with the id of the authenticated user.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Emoji creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>413<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Content too large</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/emoji</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/emoji</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/emoji</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1690" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1691" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-1692" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1693">400</li><li class="tab-error" role="tab" id="react-tabs-1694" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1695">401</li><li class="tab-error" role="tab" id="react-tabs-1696" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1697">403</li><li class="tab-error" role="tab" id="react-tabs-1698" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1699">413</li><li class="tab-error" role="tab" id="react-tabs-1700" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1701">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1691" aria-labelledby="react-tabs-1690"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</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-1693" aria-labelledby="react-tabs-1692"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1695" aria-labelledby="react-tabs-1694"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1697" aria-labelledby="react-tabs-1696"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1699" aria-labelledby="react-tabs-1698"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1701" aria-labelledby="react-tabs-1700"></div></div></div></div></div></div><div id="tag/emoji/paths/~1emoji/get" data-section-id="tag/emoji/paths/~1emoji/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/emoji/paths/~1emoji/get"></a>Get a list of custom emoji<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of metadata for custom emoji on the system. Since server version 4.7, sort using the <code>sort</code> query parameter.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of users per page.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="sort"><span class="sc-kGXeez bcLONg"></span>sort</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">""</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Either blank for no sorting or "name" to sort by emoji names. Minimum server version for sorting is 4.7.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Emoji list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/emoji</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/emoji</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/emoji</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1702" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1703" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1704" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1705">400</li><li class="tab-error" role="tab" id="react-tabs-1706" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1707">401</li><li class="tab-error" role="tab" id="react-tabs-1708" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1709">403</li><li class="tab-error" role="tab" id="react-tabs-1710" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1711">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1703" aria-labelledby="react-tabs-1702"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</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-1705" aria-labelledby="react-tabs-1704"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1707" aria-labelledby="react-tabs-1706"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1709" aria-labelledby="react-tabs-1708"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1711" aria-labelledby="react-tabs-1710"></div></div></div></div></div></div><div id="tag/emoji/paths/~1emoji~1{emoji_id}/get" data-section-id="tag/emoji/paths/~1emoji~1{emoji_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/emoji/paths/~1emoji~1{emoji_id}/get"></a>Get a custom emoji<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get some metadata for a custom emoji.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="emoji_id"><span class="sc-kGXeez bcLONg"></span>emoji_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Emoji GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Emoji retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/emoji/{emoji_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/emoji/{emoji_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/emoji/{emoji_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1712" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1713" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1714" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1715">400</li><li class="tab-error" role="tab" id="react-tabs-1716" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1717">401</li><li class="tab-error" role="tab" id="react-tabs-1718" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1719">404</li><li class="tab-error" role="tab" id="react-tabs-1720" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1721">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1713" aria-labelledby="react-tabs-1712"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</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-1715" aria-labelledby="react-tabs-1714"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1717" aria-labelledby="react-tabs-1716"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1719" aria-labelledby="react-tabs-1718"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1721" aria-labelledby="react-tabs-1720"></div></div></div></div></div></div><div id="tag/emoji/paths/~1emoji~1{emoji_id}/delete" data-section-id="tag/emoji/paths/~1emoji~1{emoji_id}/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/emoji/paths/~1emoji~1{emoji_id}/delete"></a>Delete a custom emoji<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Delete a custom emoji.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have the <code>manage_team</code> or <code>manage_system</code> permissions or be the user who created the emoji.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="emoji_id"><span class="sc-kGXeez bcLONg"></span>emoji_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Emoji GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Emoji delete successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/emoji/{emoji_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/emoji/{emoji_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/emoji/{emoji_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1722" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1723" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1724" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1725">400</li><li class="tab-error" role="tab" id="react-tabs-1726" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1727">401</li><li class="tab-error" role="tab" id="react-tabs-1728" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1729">403</li><li class="tab-error" role="tab" id="react-tabs-1730" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1731">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1723" aria-labelledby="react-tabs-1722"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</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-1725" aria-labelledby="react-tabs-1724"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1727" aria-labelledby="react-tabs-1726"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1729" aria-labelledby="react-tabs-1728"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1731" aria-labelledby="react-tabs-1730"></div></div></div></div></div></div><div id="tag/emoji/paths/~1emoji~1name~1{emoji_name}/get" data-section-id="tag/emoji/paths/~1emoji~1name~1{emoji_name}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/emoji/paths/~1emoji~1name~1{emoji_name}/get"></a>Get a custom emoji by name<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get some metadata for a custom emoji using its name.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated.</p>
|
||
<p><strong>Minimum server version</strong>: 4.7</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="emoji_name"><span class="sc-kGXeez bcLONg"></span>emoji_name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Emoji name</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Emoji retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/emoji/name/{emoji_name}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/emoji/name/{emoji_name}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/emoji/name/{emoji_name}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1732" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1733" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1734" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1735">400</li><li class="tab-error" role="tab" id="react-tabs-1736" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1737">401</li><li class="tab-error" role="tab" id="react-tabs-1738" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1739">404</li><li class="tab-error" role="tab" id="react-tabs-1740" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1741">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1733" aria-labelledby="react-tabs-1732"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</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-1735" aria-labelledby="react-tabs-1734"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1737" aria-labelledby="react-tabs-1736"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1739" aria-labelledby="react-tabs-1738"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1741" aria-labelledby="react-tabs-1740"></div></div></div></div></div></div><div id="tag/emoji/paths/~1emoji~1{emoji_id}~1image/get" data-section-id="tag/emoji/paths/~1emoji~1{emoji_id}~1image/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/emoji/paths/~1emoji~1{emoji_id}~1image/get"></a>Get custom emoji image<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get the image for a custom emoji.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="emoji_id"><span class="sc-kGXeez bcLONg"></span>emoji_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Emoji GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT hLVzSF"><strong>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Emoji image retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/emoji/{emoji_id}/image</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/emoji/{emoji_id}/image</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/emoji/{emoji_id}/image</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-1742" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1743" tabindex="0">401</li><li class="tab-error" role="tab" id="react-tabs-1744" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1745">403</li><li class="tab-error" role="tab" id="react-tabs-1746" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1747">404</li><li class="tab-error" role="tab" id="react-tabs-1748" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1749">500</li><li class="tab-error" role="tab" id="react-tabs-1750" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1751">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1743" aria-labelledby="react-tabs-1742"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-1745" aria-labelledby="react-tabs-1744"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1747" aria-labelledby="react-tabs-1746"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1749" aria-labelledby="react-tabs-1748"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1751" aria-labelledby="react-tabs-1750"></div></div></div></div></div></div><div id="tag/emoji/paths/~1emoji~1search/post" data-section-id="tag/emoji/paths/~1emoji~1search/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/emoji/paths/~1emoji~1search/post"></a>Search custom emoji<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Search for custom emoji by name based on search criteria provided in the request body. A maximum of 200 results are returned.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated.</p>
|
||
<p><strong>Minimum server version</strong>: 4.7</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Search criteria</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="term"><span class="sc-kGXeez bcLONg"></span>term<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The term to match against the emoji name.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="prefix_only"><span class="sc-kGXeez bcLONg"></span>prefix_only</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set to only search for names starting with the search term.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Emoji list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/emoji/search</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/emoji/search</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/emoji/search</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1752" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1753" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1753" aria-labelledby="react-tabs-1752"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"term"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prefix_only"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1754" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1755" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1756" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1757">400</li><li class="tab-error" role="tab" id="react-tabs-1758" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1759">401</li><li class="tab-error" role="tab" id="react-tabs-1760" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1761">403</li><li class="tab-error" role="tab" id="react-tabs-1762" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1763">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1755" aria-labelledby="react-tabs-1754"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</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-1757" aria-labelledby="react-tabs-1756"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1759" aria-labelledby="react-tabs-1758"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1761" aria-labelledby="react-tabs-1760"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1763" aria-labelledby="react-tabs-1762"></div></div></div></div></div></div><div id="tag/emoji/paths/~1emoji~1autocomplete/get" data-section-id="tag/emoji/paths/~1emoji~1autocomplete/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/emoji/paths/~1emoji~1autocomplete/get"></a>Autocomplete custom emoji<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of custom emoji with names starting with or matching the provided name. Returns a maximum of 100 results.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated.</p>
|
||
<p><strong>Minimum server version</strong>: 4.7</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The emoji name to search.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Emoji list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/emoji/autocomplete</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/emoji/autocomplete</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/emoji/autocomplete</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1764" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1765" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1766" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1767">400</li><li class="tab-error" role="tab" id="react-tabs-1768" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1769">401</li><li class="tab-error" role="tab" id="react-tabs-1770" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1771">403</li><li class="tab-error" role="tab" id="react-tabs-1772" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1773">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1765" aria-labelledby="react-tabs-1764"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</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-1767" aria-labelledby="react-tabs-1766"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1769" aria-labelledby="react-tabs-1768"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1771" aria-labelledby="react-tabs-1770"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1773" aria-labelledby="react-tabs-1772"></div></div></div></div></div></div><div id="tag/reactions" data-section-id="tag/reactions" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/reactions"></a>reactions</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for creating, getting and removing emoji reactions.</p>
|
||
</div></div></div><div id="tag/reactions/paths/~1reactions/post" data-section-id="tag/reactions/paths/~1reactions/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/reactions/paths/~1reactions/post"></a>Create a reaction<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Create a reaction.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_channel</code> permission for the channel the post is in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>The user's reaction with its post_id, user_id, and emoji_name fields set</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the user that made this reaction</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="post_id"><span class="sc-kGXeez bcLONg"></span>post_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the post to which this reaction was made</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="emoji_name"><span class="sc-kGXeez bcLONg"></span>emoji_name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The name of the emoji that was used for this reaction</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="create_at"><span class="sc-kGXeez bcLONg"></span>create_at</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span><span class="sc-cHGsZl sc-kgAjT hqYVjx"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The time in milliseconds this reaction was made</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Reaction creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/reactions</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/reactions</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/reactions</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1774" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1775" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1775" aria-labelledby="react-tabs-1774"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1776" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1777" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-1778" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1779">400</li><li class="tab-error" role="tab" id="react-tabs-1780" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1781">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1777" aria-labelledby="react-tabs-1776"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</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-1779" aria-labelledby="react-tabs-1778"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1781" aria-labelledby="react-tabs-1780"></div></div></div></div></div></div><div id="tag/reactions/paths/~1posts~1{post_id}~1reactions/get" data-section-id="tag/reactions/paths/~1posts~1{post_id}~1reactions/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/reactions/paths/~1posts~1{post_id}~1reactions/get"></a>Get a list of reactions to a post<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of reactions made by all users to a given post.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_channel</code> permission for the channel the post is in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="post_id"><span class="sc-kGXeez bcLONg"></span>post_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of a post</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>List reactions retrieve successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/posts/{post_id}/reactions</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/posts/{post_id}/reactions</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/posts/{post_id}/reactions</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1782" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1783" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1784" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1785">400</li><li class="tab-error" role="tab" id="react-tabs-1786" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1787">401</li><li class="tab-error" role="tab" id="react-tabs-1788" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1789">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1783" aria-labelledby="react-tabs-1782"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</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-1785" aria-labelledby="react-tabs-1784"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1787" aria-labelledby="react-tabs-1786"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1789" aria-labelledby="react-tabs-1788"></div></div></div></div></div></div><div id="tag/reactions/paths/~1users~1{user_id}~1posts~1{post_id}~1reactions~1{emoji_name}/delete" data-section-id="tag/reactions/paths/~1users~1{user_id}~1posts~1{post_id}~1reactions~1{emoji_name}/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/reactions/paths/~1users~1{user_id}~1posts~1{post_id}~1reactions~1{emoji_name}/delete"></a>Remove a reaction from a post<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Deletes a reaction made by a user from the given post.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be user or have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of the user</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="post_id"><span class="sc-kGXeez bcLONg"></span>post_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of the post</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="emoji_name"><span class="sc-kGXeez bcLONg"></span>emoji_name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>emoji name</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Reaction deletion successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/posts/{post_id}/reactions/{emoji_name}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/posts/{post_id}/reactions/{emoji_name}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/posts/{post_id}/reactions/{emoji_name}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1790" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1791" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1792" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1793">400</li><li class="tab-error" role="tab" id="react-tabs-1794" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1795">401</li><li class="tab-error" role="tab" id="react-tabs-1796" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1797">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1791" aria-labelledby="react-tabs-1790"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-1793" aria-labelledby="react-tabs-1792"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1795" aria-labelledby="react-tabs-1794"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1797" aria-labelledby="react-tabs-1796"></div></div></div></div></div></div><div id="tag/reactions/paths/~1posts~1ids~1reactions/post" data-section-id="tag/reactions/paths/~1posts~1ids~1reactions/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/reactions/paths/~1posts~1ids~1reactions/post"></a>Bulk get the reaction for posts<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of reactions made by all users to a given post.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>read_channel</code> permission for the channel the post is in.</p>
|
||
<p><strong>Minimum server version</strong>: 5.8</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Array of post IDs</p>
|
||
</div><div><div class="sc-hMqMXs dDdNtD"> Array </div><div class="sc-gGBfsJ bvBDls"><div><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></div></div><div class="sc-kEYyzF cMefLx"></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Reactions retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/posts/ids/reactions</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/posts/ids/reactions</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/posts/ids/reactions</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1798" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1799" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1799" aria-labelledby="react-tabs-1798"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1800" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1801" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1802" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1803">400</li><li class="tab-error" role="tab" id="react-tabs-1804" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1805">401</li><li class="tab-error" role="tab" id="react-tabs-1806" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1807">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1801" aria-labelledby="react-tabs-1800"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"property1"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</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">"property2"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"post_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emoji_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</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-1803" aria-labelledby="react-tabs-1802"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1805" aria-labelledby="react-tabs-1804"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1807" aria-labelledby="react-tabs-1806"></div></div></div></div></div></div><div id="tag/webhooks" data-section-id="tag/webhooks" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/webhooks"></a>webhooks</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for creating, getting and updating webhooks.</p>
|
||
</div></div></div><div id="tag/webhooks/paths/~1hooks~1incoming/post" data-section-id="tag/webhooks/paths/~1hooks~1incoming/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/webhooks/paths/~1hooks~1incoming/post"></a>Create an incoming webhook<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Create an incoming webhook for a channel.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_webhooks</code> for the channel the webhook is in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Incoming webhook to be created</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of a public channel or private group that receives the webhook payloads.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="display_name"><span class="sc-kGXeez bcLONg"></span>display_name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The display name for this incoming webhook</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="description"><span class="sc-kGXeez bcLONg"></span>description</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The description for this incoming webhook</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="username"><span class="sc-kGXeez bcLONg"></span>username</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The username this incoming webhook will post as.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="icon_url"><span class="sc-kGXeez bcLONg"></span>icon_url</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The profile picture this incoming webhook will use when posting.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Incoming webhook creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/hooks/incoming</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/hooks/incoming</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/hooks/incoming</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1808" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1809" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1809" aria-labelledby="react-tabs-1808"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1810" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1811" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-1812" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1813">400</li><li class="tab-error" role="tab" id="react-tabs-1814" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1815">401</li><li class="tab-error" role="tab" id="react-tabs-1816" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1817">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1811" aria-labelledby="react-tabs-1810"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</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-1813" aria-labelledby="react-tabs-1812"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1815" aria-labelledby="react-tabs-1814"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1817" aria-labelledby="react-tabs-1816"></div></div></div></div></div></div><div id="tag/webhooks/paths/~1hooks~1incoming/get" data-section-id="tag/webhooks/paths/~1hooks~1incoming/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/webhooks/paths/~1hooks~1incoming/get"></a>List incoming webhooks<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of a list of incoming webhooks. Optionally filter for a specific team using query parameters.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_webhooks</code> for the system or <code>manage_webhooks</code> for the specific team.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of hooks per page.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the team to get hooks for.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Incoming webhooks retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/hooks/incoming</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/hooks/incoming</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/hooks/incoming</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1818" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1819" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1820" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1821">400</li><li class="tab-error" role="tab" id="react-tabs-1822" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1823">401</li><li class="tab-error" role="tab" id="react-tabs-1824" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1825">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1819" aria-labelledby="react-tabs-1818"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"display_name"</span>: <span class="token string">"string"</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-1821" aria-labelledby="react-tabs-1820"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1823" aria-labelledby="react-tabs-1822"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1825" aria-labelledby="react-tabs-1824"></div></div></div></div></div></div><div id="tag/webhooks/paths/~1hooks~1incoming~1{hook_id}/get" data-section-id="tag/webhooks/paths/~1hooks~1incoming~1{hook_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/webhooks/paths/~1hooks~1incoming~1{hook_id}/get"></a>Get an incoming webhook<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get an incoming webhook given the hook id.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_webhooks</code> for system or <code>manage_webhooks</code> for the specific team or <code>manage_webhooks</code> for the channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="hook_id"><span class="sc-kGXeez bcLONg"></span>hook_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Incoming Webhook GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Webhook retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/hooks/incoming/{hook_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/hooks/incoming/{hook_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/hooks/incoming/{hook_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1826" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1827" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1828" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1829">400</li><li class="tab-error" role="tab" id="react-tabs-1830" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1831">401</li><li class="tab-error" role="tab" id="react-tabs-1832" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1833">403</li><li class="tab-error" role="tab" id="react-tabs-1834" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1835">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1827" aria-labelledby="react-tabs-1826"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</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-1829" aria-labelledby="react-tabs-1828"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1831" aria-labelledby="react-tabs-1830"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1833" aria-labelledby="react-tabs-1832"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1835" aria-labelledby="react-tabs-1834"></div></div></div></div></div></div><div id="tag/webhooks/paths/~1hooks~1incoming~1{hook_id}/put" data-section-id="tag/webhooks/paths/~1hooks~1incoming~1{hook_id}/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/webhooks/paths/~1hooks~1incoming~1{hook_id}/put"></a>Update an incoming webhook<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update an incoming webhook given the hook id.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_webhooks</code> for system or <code>manage_webhooks</code> for the specific team or <code>manage_webhooks</code> for the channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="hook_id"><span class="sc-kGXeez bcLONg"></span>hook_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Incoming Webhook GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Incoming webhook to be updated</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="hook_id"><span class="sc-kGXeez bcLONg"></span>hook_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Incoming webhook GUID</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of a public channel or private group that receives the webhook payloads.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="display_name"><span class="sc-kGXeez bcLONg"></span>display_name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The display name for this incoming webhook</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="description"><span class="sc-kGXeez bcLONg"></span>description<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The description for this incoming webhook</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="username"><span class="sc-kGXeez bcLONg"></span>username</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The username this incoming webhook will post as.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="icon_url"><span class="sc-kGXeez bcLONg"></span>icon_url</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The profile picture this incoming webhook will use when posting.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Webhook update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/hooks/incoming/{hook_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/hooks/incoming/{hook_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/hooks/incoming/{hook_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1836" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1837" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1837" aria-labelledby="react-tabs-1836"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"hook_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1838" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1839" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1840" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1841">400</li><li class="tab-error" role="tab" id="react-tabs-1842" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1843">401</li><li class="tab-error" role="tab" id="react-tabs-1844" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1845">403</li><li class="tab-error" role="tab" id="react-tabs-1846" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1847">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1839" aria-labelledby="react-tabs-1838"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</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-1841" aria-labelledby="react-tabs-1840"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1843" aria-labelledby="react-tabs-1842"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1845" aria-labelledby="react-tabs-1844"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1847" aria-labelledby="react-tabs-1846"></div></div></div></div></div></div><div id="tag/webhooks/paths/~1hooks~1outgoing/post" data-section-id="tag/webhooks/paths/~1hooks~1outgoing/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/webhooks/paths/~1hooks~1outgoing/post"></a>Create an outgoing webhook<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Create an outgoing webhook for a team.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_webhooks</code> for the team the webhook is in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Outgoing webhook to be created</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the team that the webhook watchs</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of a public channel that the webhook watchs</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="description"><span class="sc-kGXeez bcLONg"></span>description</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The description for this outgoing webhook</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="display_name"><span class="sc-kGXeez bcLONg"></span>display_name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The display name for this outgoing webhook</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="trigger_words"><span class="sc-kGXeez bcLONg"></span>trigger_words<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc">Array of </span><span class="sc-cHGsZl sc-kgAjT hqYVjx">strings</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>List of words for the webhook to trigger on</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="trigger_when"><span class="sc-kGXeez bcLONg"></span>trigger_when</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>When to trigger the webhook, <code>0</code> when a trigger word is present at all and <code>1</code> if the message starts with a trigger word</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="callback_urls"><span class="sc-kGXeez bcLONg"></span>callback_urls<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc">Array of </span><span class="sc-cHGsZl sc-kgAjT hqYVjx">strings</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The URLs to POST the payloads to when the webhook is triggered</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="content_type"><span class="sc-kGXeez bcLONg"></span>content_type</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">"application/x-www-form-urlencoded"</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The format to POST the data in, either <code>application/json</code> or <code>application/x-www-form-urlencoded</code></p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Outgoing webhook creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/hooks/outgoing</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/hooks/outgoing</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/hooks/outgoing</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1848" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1849" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1849" aria-labelledby="react-tabs-1848"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trigger_words"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"trigger_when"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"callback_urls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"content_type"</span>: <span class="token string">"application/x-www-form-urlencoded"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1850" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1851" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-1852" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1853">400</li><li class="tab-error" role="tab" id="react-tabs-1854" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1855">401</li><li class="tab-error" role="tab" id="react-tabs-1856" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1857">403</li><li class="tab-error" role="tab" id="react-tabs-1858" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1859">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1851" aria-labelledby="react-tabs-1850"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trigger_words"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"trigger_when"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"callback_urls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"content_type"</span>: <span class="token string">"application/x-www-form-urlencoded"</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-1853" aria-labelledby="react-tabs-1852"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1855" aria-labelledby="react-tabs-1854"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1857" aria-labelledby="react-tabs-1856"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1859" aria-labelledby="react-tabs-1858"></div></div></div></div></div></div><div id="tag/webhooks/paths/~1hooks~1outgoing/get" data-section-id="tag/webhooks/paths/~1hooks~1outgoing/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/webhooks/paths/~1hooks~1outgoing/get"></a>List outgoing webhooks<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of a list of outgoing webhooks. Optionally filter for a specific team or channel using query parameters.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_webhooks</code> for the system or <code>manage_webhooks</code> for the specific team/channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of hooks per page.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the team to get hooks for.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the channel to get hooks for.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Outgoing webhooks retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/hooks/outgoing</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/hooks/outgoing</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/hooks/outgoing</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1860" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1861" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1862" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1863">400</li><li class="tab-error" role="tab" id="react-tabs-1864" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1865">401</li><li class="tab-error" role="tab" id="react-tabs-1866" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1867">403</li><li class="tab-error" role="tab" id="react-tabs-1868" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1869">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1861" aria-labelledby="react-tabs-1860"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"trigger_words"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"trigger_when"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"callback_urls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content_type"</span>: <span class="token string">"application/x-www-form-urlencoded"</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-1863" aria-labelledby="react-tabs-1862"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1865" aria-labelledby="react-tabs-1864"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1867" aria-labelledby="react-tabs-1866"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1869" aria-labelledby="react-tabs-1868"></div></div></div></div></div></div><div id="tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}/get" data-section-id="tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}/get"></a>Get an outgoing webhook<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get an outgoing webhook given the hook id.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_webhooks</code> for system or <code>manage_webhooks</code> for the specific team or <code>manage_webhooks</code> for the channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="hook_id"><span class="sc-kGXeez bcLONg"></span>hook_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Outgoing webhook GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Outgoing webhook retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/hooks/outgoing/{hook_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/hooks/outgoing/{hook_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/hooks/outgoing/{hook_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1870" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1871" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1872" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1873">400</li><li class="tab-error" role="tab" id="react-tabs-1874" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1875">401</li><li class="tab-error" role="tab" id="react-tabs-1876" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1877">403</li><li class="tab-error" role="tab" id="react-tabs-1878" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1879">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1871" aria-labelledby="react-tabs-1870"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trigger_words"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"trigger_when"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"callback_urls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"content_type"</span>: <span class="token string">"application/x-www-form-urlencoded"</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-1873" aria-labelledby="react-tabs-1872"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1875" aria-labelledby="react-tabs-1874"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1877" aria-labelledby="react-tabs-1876"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1879" aria-labelledby="react-tabs-1878"></div></div></div></div></div></div><div id="tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}/delete" data-section-id="tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}/delete"></a>Delete an outgoing webhook<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Delete an outgoing webhook given the hook id.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_webhooks</code> for system or <code>manage_webhooks</code> for the specific team or <code>manage_webhooks</code> for the channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="hook_id"><span class="sc-kGXeez bcLONg"></span>hook_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Outgoing webhook GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Webhook deletion successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/hooks/outgoing/{hook_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/hooks/outgoing/{hook_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/hooks/outgoing/{hook_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1880" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1881" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1882" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1883">400</li><li class="tab-error" role="tab" id="react-tabs-1884" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1885">401</li><li class="tab-error" role="tab" id="react-tabs-1886" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1887">403</li><li class="tab-error" role="tab" id="react-tabs-1888" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1889">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1881" aria-labelledby="react-tabs-1880"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-1883" aria-labelledby="react-tabs-1882"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1885" aria-labelledby="react-tabs-1884"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1887" aria-labelledby="react-tabs-1886"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1889" aria-labelledby="react-tabs-1888"></div></div></div></div></div></div><div id="tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}/put" data-section-id="tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}/put"></a>Update an outgoing webhook<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update an outgoing webhook given the hook id.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_webhooks</code> for system or <code>manage_webhooks</code> for the specific team or <code>manage_webhooks</code> for the channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="hook_id"><span class="sc-kGXeez bcLONg"></span>hook_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>outgoing Webhook GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Outgoing webhook to be updated</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="hook_id"><span class="sc-kGXeez bcLONg"></span>hook_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Outgoing webhook GUID</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of a public channel or private group that receives the webhook payloads.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="display_name"><span class="sc-kGXeez bcLONg"></span>display_name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The display name for this incoming webhook</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="description"><span class="sc-kGXeez bcLONg"></span>description<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The description for this incoming webhook</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Webhook update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/hooks/outgoing/{hook_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/hooks/outgoing/{hook_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/hooks/outgoing/{hook_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1890" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1891" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1891" aria-labelledby="react-tabs-1890"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"hook_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1892" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1893" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1894" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1895">400</li><li class="tab-error" role="tab" id="react-tabs-1896" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1897">401</li><li class="tab-error" role="tab" id="react-tabs-1898" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1899">403</li><li class="tab-error" role="tab" id="react-tabs-1900" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1901">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1893" aria-labelledby="react-tabs-1892"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trigger_words"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"trigger_when"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"callback_urls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"content_type"</span>: <span class="token string">"application/x-www-form-urlencoded"</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-1895" aria-labelledby="react-tabs-1894"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1897" aria-labelledby="react-tabs-1896"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1899" aria-labelledby="react-tabs-1898"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1901" aria-labelledby="react-tabs-1900"></div></div></div></div></div></div><div id="tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}~1regen_token/post" data-section-id="tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}~1regen_token/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}~1regen_token/post"></a>Regenerate the token for the outgoing webhook.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Regenerate the token for the outgoing webhook.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_webhooks</code> for system or <code>manage_webhooks</code> for the specific team or <code>manage_webhooks</code> for the channel.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="hook_id"><span class="sc-kGXeez bcLONg"></span>hook_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Outgoing webhook GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Webhook token regenerate successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/hooks/outgoing/{hook_id}/regen_token</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/hooks/outgoing/{hook_id}/regen_token</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/hooks/outgoing/{hook_id}/regen_token</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1902" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1903" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1904" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1905">400</li><li class="tab-error" role="tab" id="react-tabs-1906" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1907">401</li><li class="tab-error" role="tab" id="react-tabs-1908" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1909">403</li><li class="tab-error" role="tab" id="react-tabs-1910" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1911">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1903" aria-labelledby="react-tabs-1902"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-1905" aria-labelledby="react-tabs-1904"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1907" aria-labelledby="react-tabs-1906"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1909" aria-labelledby="react-tabs-1908"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1911" aria-labelledby="react-tabs-1910"></div></div></div></div></div></div><div id="tag/commands" data-section-id="tag/commands" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/commands"></a>commands</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for creating, getting and updating slash commands.</p>
|
||
</div></div></div><div id="tag/commands/paths/~1commands/post" data-section-id="tag/commands/paths/~1commands/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/commands/paths/~1commands/post"></a>Create a command<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Create a command for a team.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_slash_commands</code> for the team the command is in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>command to be created</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team ID to where the command should be created</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="method"><span class="sc-kGXeez bcLONg"></span>method<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p><code>'P'</code> for post request, <code>'G'</code> for get request</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="trigger"><span class="sc-kGXeez bcLONg"></span>trigger<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Activation word to trigger the command</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="url"><span class="sc-kGXeez bcLONg"></span>url<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The URL that the command will make the request</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Command creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/commands</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/commands</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/commands</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1912" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1913" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1914" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1915">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1913" aria-labelledby="react-tabs-1912"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"method"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trigger"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"string"</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-1915" aria-labelledby="react-tabs-1914"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1916" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1917" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-1918" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1919">400</li><li class="tab-error" role="tab" id="react-tabs-1920" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1921">401</li><li class="tab-error" role="tab" id="react-tabs-1922" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1923">403</li><li class="tab-error" role="tab" id="react-tabs-1924" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1925">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1917" aria-labelledby="react-tabs-1916"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trigger"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"method"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_complete"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_complete_desc"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_complete_hint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"string"</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-1919" aria-labelledby="react-tabs-1918"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1921" aria-labelledby="react-tabs-1920"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1923" aria-labelledby="react-tabs-1922"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1925" aria-labelledby="react-tabs-1924"></div></div></div></div></div></div><div id="tag/commands/paths/~1commands/get" data-section-id="tag/commands/paths/~1commands/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/commands/paths/~1commands/get"></a>List commands for a team<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>List commands for a team.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_slash_commands</code> if need list custom commands.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The team id.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="custom_only"><span class="sc-kGXeez bcLONg"></span>custom_only</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">false</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>To get only the custom commands. If set to false will get the custom
|
||
if the user have access plus the system commands, otherwise just the system commands.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>List Commands retrieve successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/commands</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/commands</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/commands</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1926" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1927" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1927" aria-labelledby="react-tabs-1926"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// ListCommands</span>
|
||
<span class="token comment">// The second parameter is to set if you want only custom commands (true) or defaults commands (false)</span>
|
||
listCommands<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">ListCommands</span><span class="token punctuation">(</span><span class="token operator"><</span>TEAMID<span class="token operator">></span><span class="token punctuation">,</span> <span class="token boolean">true</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1928" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1929" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1930" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1931">400</li><li class="tab-error" role="tab" id="react-tabs-1932" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1933">401</li><li class="tab-error" role="tab" id="react-tabs-1934" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1935">403</li><li class="tab-error" role="tab" id="react-tabs-1936" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1937">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1929" aria-labelledby="react-tabs-1928"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"trigger"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"method"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"auto_complete"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"auto_complete_desc"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"auto_complete_hint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</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-1931" aria-labelledby="react-tabs-1930"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1933" aria-labelledby="react-tabs-1932"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1935" aria-labelledby="react-tabs-1934"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1937" aria-labelledby="react-tabs-1936"></div></div></div></div></div></div><div id="tag/commands/paths/~1teams~1{team_id}~1commands~1autocomplete/get" data-section-id="tag/commands/paths/~1teams~1{team_id}~1commands~1autocomplete/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/commands/paths/~1teams~1{team_id}~1commands~1autocomplete/get"></a>List autocomplete commands<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>List autocomplete commands in the team.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>view_team</code> for the team.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Autocomplete commands retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/commands/autocomplete</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/commands/autocomplete</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/commands/autocomplete</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1938" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1939" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1939" aria-labelledby="react-tabs-1938"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// ListAutocompleteCommands</span>
|
||
listCommands<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">ListAutocompleteCommands</span><span class="token punctuation">(</span><span class="token operator"><</span>TEAMID<span class="token operator">></span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1940" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1941" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1942" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1943">400</li><li class="tab-error" role="tab" id="react-tabs-1944" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1945">401</li><li class="tab-error" role="tab" id="react-tabs-1946" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1947">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1941" aria-labelledby="react-tabs-1940"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deleted_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"trigger"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"method"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"auto_complete"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"auto_complete_desc"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"auto_complete_hint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</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-1943" aria-labelledby="react-tabs-1942"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1945" aria-labelledby="react-tabs-1944"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1947" aria-labelledby="react-tabs-1946"></div></div></div></div></div></div><div id="tag/commands/paths/~1commands~1{command_id}/get" data-section-id="tag/commands/paths/~1commands~1{command_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/commands/paths/~1commands~1{command_id}/get"></a>Get a command<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a command definition based on command id string.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_slash_commands</code> permission for the team the command is in.</p>
|
||
<p><strong>Minimum server version</strong>: 5.22</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="command_id"><span class="sc-kGXeez bcLONg"></span>command_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of the command to get</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Command get successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/commands/{command_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/commands/{command_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/commands/{command_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1948" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1949" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1949" aria-labelledby="react-tabs-1948"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetCommand</span>
|
||
cmd<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetCommand</span><span class="token punctuation">(</span><span class="token operator"><</span>COMMANDID<span class="token operator">></span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1950" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1951" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1952" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1953">400</li><li class="tab-error" role="tab" id="react-tabs-1954" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1955">401</li><li class="tab-error" role="tab" id="react-tabs-1956" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1957">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1951" aria-labelledby="react-tabs-1950"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trigger"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"method"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_complete"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_complete_desc"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_complete_hint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"string"</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-1953" aria-labelledby="react-tabs-1952"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1955" aria-labelledby="react-tabs-1954"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1957" aria-labelledby="react-tabs-1956"></div></div></div></div></div></div><div id="tag/commands/paths/~1commands~1{command_id}/put" data-section-id="tag/commands/paths/~1commands~1{command_id}/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/commands/paths/~1commands~1{command_id}/put"></a>Update a command<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update a single command based on command id string and Command struct.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_slash_commands</code> permission for the team the command is in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="command_id"><span class="sc-kGXeez bcLONg"></span>command_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of the command to update</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="id"><span class="sc-kGXeez bcLONg"></span>id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the slash command</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="token"><span class="sc-kGXeez bcLONg"></span>token</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The token which is used to verify the source of the payload</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="create_at"><span class="sc-kGXeez bcLONg"></span>create_at</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The time in milliseconds the command was created</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="update_at"><span class="sc-kGXeez bcLONg"></span>update_at</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span><span class="sc-cHGsZl sc-kgAjT hqYVjx"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The time in milliseconds the command was last updated</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="deleted_at"><span class="sc-kGXeez bcLONg"></span>deleted_at</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span><span class="sc-cHGsZl sc-kgAjT hqYVjx"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The time in milliseconds the command was deleted, 0 if never deleted</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="creator_id"><span class="sc-kGXeez bcLONg"></span>creator_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The user id for the commands creator</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The team id for which this command is configured</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="trigger"><span class="sc-kGXeez bcLONg"></span>trigger</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The string that triggers this command</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="method"><span class="sc-kGXeez bcLONg"></span>method</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Is the trigger done with HTTP Get ('G') or HTTP Post ('P')</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="username"><span class="sc-kGXeez bcLONg"></span>username</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>What is the username for the response post</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="icon_url"><span class="sc-kGXeez bcLONg"></span>icon_url</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The url to find the icon for this users avatar</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="auto_complete"><span class="sc-kGXeez bcLONg"></span>auto_complete</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Use auto complete for this command</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="auto_complete_desc"><span class="sc-kGXeez bcLONg"></span>auto_complete_desc</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The description for this command shown when selecting the command</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="auto_complete_hint"><span class="sc-kGXeez bcLONg"></span>auto_complete_hint</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The hint for this command</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="display_name"><span class="sc-kGXeez bcLONg"></span>display_name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Display name for the command</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="description"><span class="sc-kGXeez bcLONg"></span>description</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Description for this command</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="url"><span class="sc-kGXeez bcLONg"></span>url</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The URL that is triggered</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Command updated successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/commands/{command_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/commands/{command_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/commands/{command_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1958" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1959" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1960" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1961">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1959" aria-labelledby="react-tabs-1958"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trigger"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"method"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_complete"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_complete_desc"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_complete_hint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"string"</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-1961" aria-labelledby="react-tabs-1960"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1962" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1963" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1964" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1965">400</li><li class="tab-error" role="tab" id="react-tabs-1966" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1967">401</li><li class="tab-error" role="tab" id="react-tabs-1968" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1969">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1963" aria-labelledby="react-tabs-1962"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"token"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"creator_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"trigger"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"method"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_complete"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_complete_desc"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_complete_hint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"string"</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-1965" aria-labelledby="react-tabs-1964"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1967" aria-labelledby="react-tabs-1966"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1969" aria-labelledby="react-tabs-1968"></div></div></div></div></div></div><div id="tag/commands/paths/~1commands~1{command_id}/delete" data-section-id="tag/commands/paths/~1commands~1{command_id}/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/commands/paths/~1commands~1{command_id}/delete"></a>Delete a command<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Delete a command based on command id string.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_slash_commands</code> permission for the team the command is in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="command_id"><span class="sc-kGXeez bcLONg"></span>command_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of the command to delete</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Command deletion successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/commands/{command_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/commands/{command_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/commands/{command_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1970" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1971" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1971" aria-labelledby="react-tabs-1970"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// DeleteCommand</span>
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">DeleteCommand</span><span class="token punctuation">(</span><span class="token operator"><</span>COMMANDID<span class="token operator">></span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1972" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1973" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1974" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1975">400</li><li class="tab-error" role="tab" id="react-tabs-1976" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1977">401</li><li class="tab-error" role="tab" id="react-tabs-1978" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1979">403</li><li class="tab-error" role="tab" id="react-tabs-1980" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1981">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1973" aria-labelledby="react-tabs-1972"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-1975" aria-labelledby="react-tabs-1974"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1977" aria-labelledby="react-tabs-1976"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1979" aria-labelledby="react-tabs-1978"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1981" aria-labelledby="react-tabs-1980"></div></div></div></div></div></div><div id="tag/commands/paths/~1commands~1{command_id}~1move/put" data-section-id="tag/commands/paths/~1commands~1{command_id}~1move/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/commands/paths/~1commands~1{command_id}~1move/put"></a>Move a command<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Move a command to a different team based on command id string.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_slash_commands</code> permission for the team the command is currently in and the destination team.</p>
|
||
<p><strong>Minimum server version</strong>: 5.22</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="command_id"><span class="sc-kGXeez bcLONg"></span>command_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of the command to move</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Destination teamId</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Command move successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/commands/{command_id}/move</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/commands/{command_id}/move</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/commands/{command_id}/move</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1982" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1983" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-1984" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1985">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1983" aria-labelledby="react-tabs-1982"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</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-1985" aria-labelledby="react-tabs-1984"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1986" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1987" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-1988" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1989">400</li><li class="tab-error" role="tab" id="react-tabs-1990" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1991">401</li><li class="tab-error" role="tab" id="react-tabs-1992" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1993">403</li><li class="tab-error" role="tab" id="react-tabs-1994" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-1995">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1987" aria-labelledby="react-tabs-1986"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-1989" aria-labelledby="react-tabs-1988"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1991" aria-labelledby="react-tabs-1990"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1993" aria-labelledby="react-tabs-1992"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-1995" aria-labelledby="react-tabs-1994"></div></div></div></div></div></div><div id="tag/commands/paths/~1commands~1{command_id}~1regen_token/put" data-section-id="tag/commands/paths/~1commands~1{command_id}~1regen_token/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/commands/paths/~1commands~1{command_id}~1regen_token/put"></a>Generate a new token<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Generate a new token for the command based on command id string.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_slash_commands</code> permission for the team the command is in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="command_id"><span class="sc-kGXeez bcLONg"></span>command_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of the command to generate the new token</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Token generation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/commands/{command_id}/regen_token</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/commands/{command_id}/regen_token</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/commands/{command_id}/regen_token</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-1996" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1997" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1997" aria-labelledby="react-tabs-1996"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// RegenCommandToken</span>
|
||
newToken<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">RegenCommandToken</span><span class="token punctuation">(</span><span class="token operator"><</span>COMMANDID<span class="token operator">></span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-1998" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1999" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2000" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2001">400</li><li class="tab-error" role="tab" id="react-tabs-2002" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2003">401</li><li class="tab-error" role="tab" id="react-tabs-2004" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2005">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1999" aria-labelledby="react-tabs-1998"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"token"</span>: <span class="token string">"string"</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-2001" aria-labelledby="react-tabs-2000"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2003" aria-labelledby="react-tabs-2002"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2005" aria-labelledby="react-tabs-2004"></div></div></div></div></div></div><div id="tag/commands/paths/~1commands~1execute/post" data-section-id="tag/commands/paths/~1commands~1execute/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/commands/paths/~1commands~1execute/post"></a>Execute a command<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Execute a command on a team.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>use_slash_commands</code> permission for the team the command is in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>command to be executed</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel Id where the command will execute</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="command"><span class="sc-kGXeez bcLONg"></span>command<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The slash command to execute</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Command execution successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/commands/execute</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/commands/execute</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/commands/execute</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2006" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2007" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2007" aria-labelledby="react-tabs-2006"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"command"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2008" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2009" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2010" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2011">400</li><li class="tab-error" role="tab" id="react-tabs-2012" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2013">401</li><li class="tab-error" role="tab" id="react-tabs-2014" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2015">403</li><li class="tab-error" role="tab" id="react-tabs-2016" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2017">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2009" aria-labelledby="react-tabs-2008"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ResponseType"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Text"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"IconURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"GotoLocation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Attachments"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Fallback"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Color"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Pretext"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthorName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthorLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthorIcon"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TitleLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Text"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Fields"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Value"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Short"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ImageURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Footer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FooterIcon"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Timestamp"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</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-2011" aria-labelledby="react-tabs-2010"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2013" aria-labelledby="react-tabs-2012"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2015" aria-labelledby="react-tabs-2014"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2017" aria-labelledby="react-tabs-2016"></div></div></div></div></div></div><div id="tag/OpenGraph" data-section-id="tag/OpenGraph" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/OpenGraph"></a>OpenGraph</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoint for getting Open Graph metadata.</p>
|
||
</div></div></div><div id="tag/OpenGraph/paths/~1opengraph/post" data-section-id="tag/OpenGraph/paths/~1opengraph/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/OpenGraph/paths/~1opengraph/post"></a>Get open graph metadata for url<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get Open Graph Metadata for a specif URL. Use the Open Graph protocol to get some generic metadata about a URL. Used for creating link previews.</p>
|
||
<p><strong>Minimum server version</strong>: 3.10</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>No permission required but must be logged in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="url"><span class="sc-kGXeez bcLONg"></span>url<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The URL to get Open Graph Metadata.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Open Graph retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/opengraph</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/opengraph</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/opengraph</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2018" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2019" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2019" aria-labelledby="react-tabs-2018"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2020" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2021" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2022" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2023">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2021" aria-labelledby="react-tabs-2020"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"determiner"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locales_alternate"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"images"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"secure_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</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">"videos"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"secure_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"width"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"height"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</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">"audios"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"secure_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</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">"article"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"published_time"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"modified_time"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expiration_time"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"section"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tags"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"authors"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"gender"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</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">"book"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"isbn"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"release_date"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tags"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"authors"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"gender"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</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">"profile"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"gender"</span>: <span class="token string">"string"</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-2023" aria-labelledby="react-tabs-2022"></div></div></div></div></div></div><div id="tag/system" data-section-id="tag/system" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/system"></a>system</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>General endpoints for interacting with the server, such as configuration and logging.</p>
|
||
</div></div></div><div id="tag/system/paths/~1system~1ping/get" data-section-id="tag/system/paths/~1system~1ping/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1system~1ping/get"></a>Check system health<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Check if the server is up and healthy based on the configuration setting <code>GoRoutineHealthThreshold</code>. If <code>GoRoutineHealthThreshold</code> and the number of goroutines on the server exceeds that threshold the server is considered unhealthy. If <code>GoRoutineHealthThreshold</code> is not set or the number of goroutines is below the threshold the server is considered healthy.
|
||
<strong>Minimum server version</strong>: 3.10</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Status of the system</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/system/ping</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/system/ping</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/system/ping</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2024" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2025" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2025" aria-labelledby="react-tabs-2024"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetPing</span>
|
||
status<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetPing</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2026" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2027" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2028" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2029">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2027" aria-labelledby="react-tabs-2026"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2029" aria-labelledby="react-tabs-2028"></div></div></div></div></div></div><div id="tag/system/paths/~1database~1recycle/post" data-section-id="tag/system/paths/~1database~1recycle/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1database~1recycle/post"></a>Recycle database connections<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Recycle database connections by closing and reconnecting all connections to master and read replica databases.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Database recycle successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/database/recycle</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/database/recycle</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/database/recycle</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2030" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2031" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2031" aria-labelledby="react-tabs-2030"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">DatabaseRecycle</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2032" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2033" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2034" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2035">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2033" aria-labelledby="react-tabs-2032"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2035" aria-labelledby="react-tabs-2034"></div></div></div></div></div></div><div id="tag/system/paths/~1email~1test/post" data-section-id="tag/system/paths/~1email~1test/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1email~1test/post"></a>Send a test email<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Send a test email to make sure you have your email settings configured correctly. Optionally provide a configuration in the request body to test. If no valid configuration is present in the request body the current server configuration will be tested.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Mattermost configuration</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="ServiceSettings"><span class="sc-kGXeez bcLONg"></span>ServiceSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="TeamSettings"><span class="sc-kGXeez bcLONg"></span>TeamSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="SqlSettings"><span class="sc-kGXeez bcLONg"></span>SqlSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="LogSettings"><span class="sc-kGXeez bcLONg"></span>LogSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="PasswordSettings"><span class="sc-kGXeez bcLONg"></span>PasswordSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="FileSettings"><span class="sc-kGXeez bcLONg"></span>FileSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="EmailSettings"><span class="sc-kGXeez bcLONg"></span>EmailSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="RateLimitSettings"><span class="sc-kGXeez bcLONg"></span>RateLimitSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="PrivacySettings"><span class="sc-kGXeez bcLONg"></span>PrivacySettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="SupportSettings"><span class="sc-kGXeez bcLONg"></span>SupportSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="GitLabSettings"><span class="sc-kGXeez bcLONg"></span>GitLabSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="GoogleSettings"><span class="sc-kGXeez bcLONg"></span>GoogleSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="Office365Settings"><span class="sc-kGXeez bcLONg"></span>Office365Settings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="LdapSettings"><span class="sc-kGXeez bcLONg"></span>LdapSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="ComplianceSettings"><span class="sc-kGXeez bcLONg"></span>ComplianceSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="LocalizationSettings"><span class="sc-kGXeez bcLONg"></span>LocalizationSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="SamlSettings"><span class="sc-kGXeez bcLONg"></span>SamlSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="NativeAppSettings"><span class="sc-kGXeez bcLONg"></span>NativeAppSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="ClusterSettings"><span class="sc-kGXeez bcLONg"></span>ClusterSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="MetricsSettings"><span class="sc-kGXeez bcLONg"></span>MetricsSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="AnalyticsSettings"><span class="sc-kGXeez bcLONg"></span>AnalyticsSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Email successful sent</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/email/test</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/email/test</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/email/test</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2036" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2037" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-2038" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2039">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2037" aria-labelledby="react-tabs-2036"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ServiceSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"SiteURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ListenAddress"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TLSCertFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TLSKeyFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UseLetsEncrypt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LetsEncryptCertificateCacheFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Forward80To443"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ReadTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WriteTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaximumLoginAttempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SegmentDeveloperKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"GoogleDeveloperKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOAuthServiceProvider"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableIncomingWebhooks"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOutgoingWebhooks"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCommands"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOnlyAdminIntegrations"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePostUsernameOverride"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePostIconOverride"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableTesting"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDeveloper"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSecurityFixAlert"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableInsecureOutgoingConnections"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableMultifactorAuthentication"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnforceMultifactorAuthentication"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AllowCorsFrom"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthWebInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthMobileInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthSSOInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionCacheInMinutes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebsocketSecurePort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebsocketPort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebserverMode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCustomEmoji"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictCustomEmojiCreation"</span>: <span class="token string">"string"</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">"TeamSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"SiteName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxUsersPerTeam"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableTeamCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableUserCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOpenServer"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictCreationToDomains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCustomBrand"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"CustomBrandText"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"CustomDescriptionText"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictDirectMessage"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictTeamInvite"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelManagement"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelManagement"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelCreation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelCreation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelDeletion"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelDeletion"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserStatusAwayTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxChannelsPerTeam"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxNotificationsPerChannel"</span>: <span class="token number">0</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">"SqlSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"DriverName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DataSource"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DataSourceReplicas"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxIdleConns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxOpenConns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Trace"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AtRestEncryptKey"</span>: <span class="token string">"string"</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">"LogSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"EnableConsole"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConsoleLevel"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableFile"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FileLevel"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FileLocation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableWebhookDebugging"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDiagnostics"</span>: <span class="token boolean">true</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">"PasswordSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MinimumLength"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Lowercase"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Number"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Uppercase"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Symbol"</span>: <span class="token boolean">true</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">"FileSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MaxFileSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DriverName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Directory"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePublicLink"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PublicLinkSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbnailWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbnailHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PreviewWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PreviewHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ProfileWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ProfileHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InitialFont"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3AccessKeyId"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3SecretAccessKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Bucket"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Region"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Endpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3SSL"</span>: <span class="token boolean">true</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">"EmailSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"EnableSignUpWithEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSignInWithEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSignInWithUsername"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SendEmailNotifications"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RequireEmailVerification"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackEmail"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackOrganization"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPUsername"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPPassword"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPPort"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InviteSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PasswordResetSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SendPushNotifications"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PushNotificationServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PushNotificationContents"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableEmailBatching"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailBatchingBufferSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailBatchingInterval"</span>: <span class="token number">0</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">"RateLimitSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PerSec"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxBurst"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MemoryStoreSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"VaryByRemoteAddr"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"VaryByHeader"</span>: <span class="token string">"string"</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">"PrivacySettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"ShowEmailAddress"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ShowFullName"</span>: <span class="token boolean">true</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">"SupportSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"TermsOfServiceLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PrivacyPolicyLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AboutLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"HelpLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ReportAProblemLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SupportEmail"</span>: <span class="token string">"string"</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">"GitLabSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"GoogleSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"Office365Settings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"LdapSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LdapServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LdapPort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BaseDN"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BindUsername"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BindPassword"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserFilter"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FirstNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LastNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UsernameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"NicknameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PositionAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SyncIntervalMinutes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SkipCertificateVerification"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"QueryTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxPageSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LoginFieldName"</span>: <span class="token string">"string"</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">"ComplianceSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Directory"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDaily"</span>: <span class="token boolean">true</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">"LocalizationSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"DefaultServerLocale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DefaultClientLocale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AvailableLocales"</span>: <span class="token string">"string"</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">"SamlSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Verify"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Encrypt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpUrl"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpDescriptorUrl"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AssertionConsumerServiceURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpCertificateFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PublicCertificateFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PrivateKeyFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FirstNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LastNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UsernameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"NicknameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LocaleAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PositionAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LoginButtonText"</span>: <span class="token string">"string"</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">"NativeAppSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"AppDownloadLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AndroidAppDownloadLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IosAppDownloadLink"</span>: <span class="token string">"string"</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">"ClusterSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InterNodeListenAddress"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InterNodeUrls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</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">"MetricsSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BlockProfileRate"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ListenAddress"</span>: <span class="token string">"string"</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">"AnalyticsSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MaxUsersForStatistics"</span>: <span class="token number">0</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-2039" aria-labelledby="react-tabs-2038"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2040" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2041" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2042" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2043">403</li><li class="tab-error" role="tab" id="react-tabs-2044" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2045">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2041" aria-labelledby="react-tabs-2040"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2043" aria-labelledby="react-tabs-2042"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2045" aria-labelledby="react-tabs-2044"></div></div></div></div></div></div><div id="tag/system/paths/~1site_url~1test/post" data-section-id="tag/system/paths/~1site_url~1test/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1site_url~1test/post"></a>Checks the validity of a Site URL<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Sends a Ping request to the mattermost server using the specified Site URL.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.16</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="site_url"><span class="sc-kGXeez bcLONg"></span>site_url<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The Site URL to test</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Site URL is valid</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/site_url/test</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/site_url/test</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/site_url/test</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2046" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2047" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-2048" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2049">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2047" aria-labelledby="react-tabs-2046"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"site_url"</span>: <span class="token string">"string"</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-2049" aria-labelledby="react-tabs-2048"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2050" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2051" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2052" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2053">400</li><li class="tab-error" role="tab" id="react-tabs-2054" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2055">403</li><li class="tab-error" role="tab" id="react-tabs-2056" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2057">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2051" aria-labelledby="react-tabs-2050"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2053" aria-labelledby="react-tabs-2052"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2055" aria-labelledby="react-tabs-2054"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2057" aria-labelledby="react-tabs-2056"></div></div></div></div></div></div><div id="tag/system/paths/~1file~1s3_test/post" data-section-id="tag/system/paths/~1file~1s3_test/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1file~1s3_test/post"></a>Test AWS S3 connection<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Send a test to validate if can connect to AWS S3. Optionally provide a configuration in the request body to test. If no valid configuration is present in the request body the current server configuration will be tested.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.
|
||
<strong>Minimum server version</strong>: 4.8</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Mattermost configuration</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="ServiceSettings"><span class="sc-kGXeez bcLONg"></span>ServiceSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="TeamSettings"><span class="sc-kGXeez bcLONg"></span>TeamSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="SqlSettings"><span class="sc-kGXeez bcLONg"></span>SqlSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="LogSettings"><span class="sc-kGXeez bcLONg"></span>LogSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="PasswordSettings"><span class="sc-kGXeez bcLONg"></span>PasswordSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="FileSettings"><span class="sc-kGXeez bcLONg"></span>FileSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="EmailSettings"><span class="sc-kGXeez bcLONg"></span>EmailSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="RateLimitSettings"><span class="sc-kGXeez bcLONg"></span>RateLimitSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="PrivacySettings"><span class="sc-kGXeez bcLONg"></span>PrivacySettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="SupportSettings"><span class="sc-kGXeez bcLONg"></span>SupportSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="GitLabSettings"><span class="sc-kGXeez bcLONg"></span>GitLabSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="GoogleSettings"><span class="sc-kGXeez bcLONg"></span>GoogleSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="Office365Settings"><span class="sc-kGXeez bcLONg"></span>Office365Settings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="LdapSettings"><span class="sc-kGXeez bcLONg"></span>LdapSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="ComplianceSettings"><span class="sc-kGXeez bcLONg"></span>ComplianceSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="LocalizationSettings"><span class="sc-kGXeez bcLONg"></span>LocalizationSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="SamlSettings"><span class="sc-kGXeez bcLONg"></span>SamlSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="NativeAppSettings"><span class="sc-kGXeez bcLONg"></span>NativeAppSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="ClusterSettings"><span class="sc-kGXeez bcLONg"></span>ClusterSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="MetricsSettings"><span class="sc-kGXeez bcLONg"></span>MetricsSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="AnalyticsSettings"><span class="sc-kGXeez bcLONg"></span>AnalyticsSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>S3 Test successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/file/s3_test</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/file/s3_test</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/file/s3_test</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2058" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2059" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-2060" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2061">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2059" aria-labelledby="react-tabs-2058"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ServiceSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"SiteURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ListenAddress"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TLSCertFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TLSKeyFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UseLetsEncrypt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LetsEncryptCertificateCacheFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Forward80To443"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ReadTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WriteTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaximumLoginAttempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SegmentDeveloperKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"GoogleDeveloperKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOAuthServiceProvider"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableIncomingWebhooks"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOutgoingWebhooks"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCommands"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOnlyAdminIntegrations"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePostUsernameOverride"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePostIconOverride"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableTesting"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDeveloper"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSecurityFixAlert"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableInsecureOutgoingConnections"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableMultifactorAuthentication"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnforceMultifactorAuthentication"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AllowCorsFrom"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthWebInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthMobileInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthSSOInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionCacheInMinutes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebsocketSecurePort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebsocketPort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebserverMode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCustomEmoji"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictCustomEmojiCreation"</span>: <span class="token string">"string"</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">"TeamSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"SiteName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxUsersPerTeam"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableTeamCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableUserCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOpenServer"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictCreationToDomains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCustomBrand"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"CustomBrandText"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"CustomDescriptionText"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictDirectMessage"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictTeamInvite"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelManagement"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelManagement"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelCreation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelCreation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelDeletion"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelDeletion"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserStatusAwayTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxChannelsPerTeam"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxNotificationsPerChannel"</span>: <span class="token number">0</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">"SqlSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"DriverName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DataSource"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DataSourceReplicas"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxIdleConns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxOpenConns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Trace"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AtRestEncryptKey"</span>: <span class="token string">"string"</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">"LogSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"EnableConsole"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConsoleLevel"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableFile"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FileLevel"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FileLocation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableWebhookDebugging"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDiagnostics"</span>: <span class="token boolean">true</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">"PasswordSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MinimumLength"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Lowercase"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Number"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Uppercase"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Symbol"</span>: <span class="token boolean">true</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">"FileSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MaxFileSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DriverName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Directory"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePublicLink"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PublicLinkSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbnailWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbnailHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PreviewWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PreviewHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ProfileWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ProfileHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InitialFont"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3AccessKeyId"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3SecretAccessKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Bucket"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Region"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Endpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3SSL"</span>: <span class="token boolean">true</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">"EmailSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"EnableSignUpWithEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSignInWithEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSignInWithUsername"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SendEmailNotifications"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RequireEmailVerification"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackEmail"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackOrganization"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPUsername"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPPassword"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPPort"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InviteSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PasswordResetSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SendPushNotifications"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PushNotificationServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PushNotificationContents"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableEmailBatching"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailBatchingBufferSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailBatchingInterval"</span>: <span class="token number">0</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">"RateLimitSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PerSec"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxBurst"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MemoryStoreSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"VaryByRemoteAddr"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"VaryByHeader"</span>: <span class="token string">"string"</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">"PrivacySettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"ShowEmailAddress"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ShowFullName"</span>: <span class="token boolean">true</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">"SupportSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"TermsOfServiceLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PrivacyPolicyLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AboutLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"HelpLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ReportAProblemLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SupportEmail"</span>: <span class="token string">"string"</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">"GitLabSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"GoogleSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"Office365Settings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"LdapSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LdapServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LdapPort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BaseDN"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BindUsername"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BindPassword"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserFilter"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FirstNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LastNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UsernameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"NicknameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PositionAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SyncIntervalMinutes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SkipCertificateVerification"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"QueryTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxPageSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LoginFieldName"</span>: <span class="token string">"string"</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">"ComplianceSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Directory"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDaily"</span>: <span class="token boolean">true</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">"LocalizationSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"DefaultServerLocale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DefaultClientLocale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AvailableLocales"</span>: <span class="token string">"string"</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">"SamlSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Verify"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Encrypt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpUrl"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpDescriptorUrl"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AssertionConsumerServiceURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpCertificateFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PublicCertificateFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PrivateKeyFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FirstNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LastNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UsernameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"NicknameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LocaleAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PositionAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LoginButtonText"</span>: <span class="token string">"string"</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">"NativeAppSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"AppDownloadLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AndroidAppDownloadLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IosAppDownloadLink"</span>: <span class="token string">"string"</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">"ClusterSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InterNodeListenAddress"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InterNodeUrls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</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">"MetricsSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BlockProfileRate"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ListenAddress"</span>: <span class="token string">"string"</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">"AnalyticsSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MaxUsersForStatistics"</span>: <span class="token number">0</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-2061" aria-labelledby="react-tabs-2060"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2062" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2063" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2064" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2065">403</li><li class="tab-error" role="tab" id="react-tabs-2066" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2067">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2063" aria-labelledby="react-tabs-2062"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2065" aria-labelledby="react-tabs-2064"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2067" aria-labelledby="react-tabs-2066"></div></div></div></div></div></div><div id="tag/system/paths/~1config/get" data-section-id="tag/system/paths/~1config/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1config/get"></a>Get configuration<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Retrieve the current server configuration</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Configuration retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/config</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/config</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/config</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2068" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2069" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2069" aria-labelledby="react-tabs-2068"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetConfig</span>
|
||
config<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetConfig</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2070" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2071" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2072" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2073">400</li><li class="tab-error" role="tab" id="react-tabs-2074" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2075">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2071" aria-labelledby="react-tabs-2070"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ServiceSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"SiteURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ListenAddress"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TLSCertFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TLSKeyFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UseLetsEncrypt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LetsEncryptCertificateCacheFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Forward80To443"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ReadTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WriteTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaximumLoginAttempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SegmentDeveloperKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"GoogleDeveloperKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOAuthServiceProvider"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableIncomingWebhooks"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOutgoingWebhooks"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCommands"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOnlyAdminIntegrations"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePostUsernameOverride"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePostIconOverride"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableTesting"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDeveloper"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSecurityFixAlert"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableInsecureOutgoingConnections"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableMultifactorAuthentication"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnforceMultifactorAuthentication"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AllowCorsFrom"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthWebInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthMobileInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthSSOInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionCacheInMinutes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebsocketSecurePort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebsocketPort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebserverMode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCustomEmoji"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictCustomEmojiCreation"</span>: <span class="token string">"string"</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">"TeamSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"SiteName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxUsersPerTeam"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableTeamCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableUserCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOpenServer"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictCreationToDomains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCustomBrand"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"CustomBrandText"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"CustomDescriptionText"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictDirectMessage"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictTeamInvite"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelManagement"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelManagement"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelCreation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelCreation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelDeletion"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelDeletion"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserStatusAwayTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxChannelsPerTeam"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxNotificationsPerChannel"</span>: <span class="token number">0</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">"SqlSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"DriverName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DataSource"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DataSourceReplicas"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxIdleConns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxOpenConns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Trace"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AtRestEncryptKey"</span>: <span class="token string">"string"</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">"LogSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"EnableConsole"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConsoleLevel"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableFile"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FileLevel"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FileLocation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableWebhookDebugging"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDiagnostics"</span>: <span class="token boolean">true</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">"PasswordSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MinimumLength"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Lowercase"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Number"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Uppercase"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Symbol"</span>: <span class="token boolean">true</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">"FileSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MaxFileSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DriverName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Directory"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePublicLink"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PublicLinkSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbnailWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbnailHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PreviewWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PreviewHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ProfileWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ProfileHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InitialFont"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3AccessKeyId"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3SecretAccessKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Bucket"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Region"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Endpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3SSL"</span>: <span class="token boolean">true</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">"EmailSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"EnableSignUpWithEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSignInWithEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSignInWithUsername"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SendEmailNotifications"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RequireEmailVerification"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackEmail"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackOrganization"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPUsername"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPPassword"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPPort"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InviteSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PasswordResetSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SendPushNotifications"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PushNotificationServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PushNotificationContents"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableEmailBatching"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailBatchingBufferSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailBatchingInterval"</span>: <span class="token number">0</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">"RateLimitSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PerSec"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxBurst"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MemoryStoreSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"VaryByRemoteAddr"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"VaryByHeader"</span>: <span class="token string">"string"</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">"PrivacySettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"ShowEmailAddress"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ShowFullName"</span>: <span class="token boolean">true</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">"SupportSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"TermsOfServiceLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PrivacyPolicyLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AboutLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"HelpLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ReportAProblemLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SupportEmail"</span>: <span class="token string">"string"</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">"GitLabSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"GoogleSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"Office365Settings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"LdapSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LdapServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LdapPort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BaseDN"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BindUsername"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BindPassword"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserFilter"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FirstNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LastNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UsernameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"NicknameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PositionAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SyncIntervalMinutes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SkipCertificateVerification"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"QueryTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxPageSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LoginFieldName"</span>: <span class="token string">"string"</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">"ComplianceSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Directory"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDaily"</span>: <span class="token boolean">true</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">"LocalizationSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"DefaultServerLocale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DefaultClientLocale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AvailableLocales"</span>: <span class="token string">"string"</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">"SamlSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Verify"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Encrypt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpUrl"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpDescriptorUrl"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AssertionConsumerServiceURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpCertificateFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PublicCertificateFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PrivateKeyFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FirstNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LastNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UsernameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"NicknameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LocaleAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PositionAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LoginButtonText"</span>: <span class="token string">"string"</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">"NativeAppSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"AppDownloadLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AndroidAppDownloadLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IosAppDownloadLink"</span>: <span class="token string">"string"</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">"ClusterSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InterNodeListenAddress"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InterNodeUrls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</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">"MetricsSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BlockProfileRate"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ListenAddress"</span>: <span class="token string">"string"</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">"AnalyticsSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MaxUsersForStatistics"</span>: <span class="token number">0</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-2073" aria-labelledby="react-tabs-2072"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2075" aria-labelledby="react-tabs-2074"></div></div></div></div></div></div><div id="tag/system/paths/~1config/put" data-section-id="tag/system/paths/~1config/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1config/put"></a>Update configuration<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Submit a new configuration for the server to use. As of server version 4.8, the <code>PluginSettings.EnableUploads</code> setting cannot be modified by this endpoint.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Mattermost configuration</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="ServiceSettings"><span class="sc-kGXeez bcLONg"></span>ServiceSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="TeamSettings"><span class="sc-kGXeez bcLONg"></span>TeamSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="SqlSettings"><span class="sc-kGXeez bcLONg"></span>SqlSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="LogSettings"><span class="sc-kGXeez bcLONg"></span>LogSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="PasswordSettings"><span class="sc-kGXeez bcLONg"></span>PasswordSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="FileSettings"><span class="sc-kGXeez bcLONg"></span>FileSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="EmailSettings"><span class="sc-kGXeez bcLONg"></span>EmailSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="RateLimitSettings"><span class="sc-kGXeez bcLONg"></span>RateLimitSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="PrivacySettings"><span class="sc-kGXeez bcLONg"></span>PrivacySettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="SupportSettings"><span class="sc-kGXeez bcLONg"></span>SupportSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="GitLabSettings"><span class="sc-kGXeez bcLONg"></span>GitLabSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="GoogleSettings"><span class="sc-kGXeez bcLONg"></span>GoogleSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="Office365Settings"><span class="sc-kGXeez bcLONg"></span>Office365Settings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="LdapSettings"><span class="sc-kGXeez bcLONg"></span>LdapSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="ComplianceSettings"><span class="sc-kGXeez bcLONg"></span>ComplianceSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="LocalizationSettings"><span class="sc-kGXeez bcLONg"></span>LocalizationSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="SamlSettings"><span class="sc-kGXeez bcLONg"></span>SamlSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="NativeAppSettings"><span class="sc-kGXeez bcLONg"></span>NativeAppSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="ClusterSettings"><span class="sc-kGXeez bcLONg"></span>ClusterSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="MetricsSettings"><span class="sc-kGXeez bcLONg"></span>MetricsSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="AnalyticsSettings"><span class="sc-kGXeez bcLONg"></span>AnalyticsSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Configuration update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/config</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/config</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/config</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2076" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2077" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-2078" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2079">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2077" aria-labelledby="react-tabs-2076"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ServiceSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"SiteURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ListenAddress"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TLSCertFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TLSKeyFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UseLetsEncrypt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LetsEncryptCertificateCacheFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Forward80To443"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ReadTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WriteTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaximumLoginAttempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SegmentDeveloperKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"GoogleDeveloperKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOAuthServiceProvider"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableIncomingWebhooks"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOutgoingWebhooks"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCommands"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOnlyAdminIntegrations"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePostUsernameOverride"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePostIconOverride"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableTesting"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDeveloper"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSecurityFixAlert"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableInsecureOutgoingConnections"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableMultifactorAuthentication"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnforceMultifactorAuthentication"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AllowCorsFrom"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthWebInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthMobileInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthSSOInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionCacheInMinutes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebsocketSecurePort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebsocketPort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebserverMode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCustomEmoji"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictCustomEmojiCreation"</span>: <span class="token string">"string"</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">"TeamSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"SiteName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxUsersPerTeam"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableTeamCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableUserCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOpenServer"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictCreationToDomains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCustomBrand"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"CustomBrandText"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"CustomDescriptionText"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictDirectMessage"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictTeamInvite"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelManagement"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelManagement"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelCreation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelCreation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelDeletion"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelDeletion"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserStatusAwayTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxChannelsPerTeam"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxNotificationsPerChannel"</span>: <span class="token number">0</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">"SqlSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"DriverName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DataSource"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DataSourceReplicas"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxIdleConns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxOpenConns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Trace"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AtRestEncryptKey"</span>: <span class="token string">"string"</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">"LogSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"EnableConsole"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConsoleLevel"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableFile"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FileLevel"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FileLocation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableWebhookDebugging"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDiagnostics"</span>: <span class="token boolean">true</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">"PasswordSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MinimumLength"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Lowercase"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Number"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Uppercase"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Symbol"</span>: <span class="token boolean">true</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">"FileSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MaxFileSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DriverName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Directory"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePublicLink"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PublicLinkSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbnailWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbnailHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PreviewWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PreviewHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ProfileWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ProfileHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InitialFont"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3AccessKeyId"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3SecretAccessKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Bucket"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Region"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Endpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3SSL"</span>: <span class="token boolean">true</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">"EmailSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"EnableSignUpWithEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSignInWithEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSignInWithUsername"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SendEmailNotifications"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RequireEmailVerification"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackEmail"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackOrganization"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPUsername"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPPassword"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPPort"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InviteSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PasswordResetSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SendPushNotifications"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PushNotificationServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PushNotificationContents"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableEmailBatching"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailBatchingBufferSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailBatchingInterval"</span>: <span class="token number">0</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">"RateLimitSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PerSec"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxBurst"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MemoryStoreSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"VaryByRemoteAddr"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"VaryByHeader"</span>: <span class="token string">"string"</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">"PrivacySettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"ShowEmailAddress"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ShowFullName"</span>: <span class="token boolean">true</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">"SupportSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"TermsOfServiceLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PrivacyPolicyLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AboutLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"HelpLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ReportAProblemLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SupportEmail"</span>: <span class="token string">"string"</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">"GitLabSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"GoogleSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"Office365Settings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"LdapSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LdapServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LdapPort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BaseDN"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BindUsername"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BindPassword"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserFilter"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FirstNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LastNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UsernameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"NicknameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PositionAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SyncIntervalMinutes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SkipCertificateVerification"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"QueryTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxPageSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LoginFieldName"</span>: <span class="token string">"string"</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">"ComplianceSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Directory"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDaily"</span>: <span class="token boolean">true</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">"LocalizationSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"DefaultServerLocale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DefaultClientLocale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AvailableLocales"</span>: <span class="token string">"string"</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">"SamlSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Verify"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Encrypt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpUrl"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpDescriptorUrl"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AssertionConsumerServiceURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpCertificateFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PublicCertificateFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PrivateKeyFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FirstNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LastNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UsernameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"NicknameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LocaleAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PositionAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LoginButtonText"</span>: <span class="token string">"string"</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">"NativeAppSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"AppDownloadLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AndroidAppDownloadLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IosAppDownloadLink"</span>: <span class="token string">"string"</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">"ClusterSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InterNodeListenAddress"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InterNodeUrls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</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">"MetricsSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BlockProfileRate"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ListenAddress"</span>: <span class="token string">"string"</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">"AnalyticsSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MaxUsersForStatistics"</span>: <span class="token number">0</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-2079" aria-labelledby="react-tabs-2078"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2080" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2081" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2082" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2083">400</li><li class="tab-error" role="tab" id="react-tabs-2084" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2085">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2081" aria-labelledby="react-tabs-2080"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ServiceSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"SiteURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ListenAddress"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TLSCertFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TLSKeyFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UseLetsEncrypt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LetsEncryptCertificateCacheFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Forward80To443"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ReadTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WriteTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaximumLoginAttempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SegmentDeveloperKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"GoogleDeveloperKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOAuthServiceProvider"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableIncomingWebhooks"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOutgoingWebhooks"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCommands"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOnlyAdminIntegrations"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePostUsernameOverride"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePostIconOverride"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableTesting"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDeveloper"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSecurityFixAlert"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableInsecureOutgoingConnections"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableMultifactorAuthentication"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnforceMultifactorAuthentication"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AllowCorsFrom"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthWebInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthMobileInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthSSOInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionCacheInMinutes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebsocketSecurePort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebsocketPort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebserverMode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCustomEmoji"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictCustomEmojiCreation"</span>: <span class="token string">"string"</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">"TeamSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"SiteName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxUsersPerTeam"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableTeamCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableUserCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOpenServer"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictCreationToDomains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCustomBrand"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"CustomBrandText"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"CustomDescriptionText"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictDirectMessage"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictTeamInvite"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelManagement"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelManagement"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelCreation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelCreation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelDeletion"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelDeletion"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserStatusAwayTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxChannelsPerTeam"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxNotificationsPerChannel"</span>: <span class="token number">0</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">"SqlSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"DriverName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DataSource"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DataSourceReplicas"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxIdleConns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxOpenConns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Trace"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AtRestEncryptKey"</span>: <span class="token string">"string"</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">"LogSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"EnableConsole"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConsoleLevel"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableFile"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FileLevel"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FileLocation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableWebhookDebugging"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDiagnostics"</span>: <span class="token boolean">true</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">"PasswordSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MinimumLength"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Lowercase"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Number"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Uppercase"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Symbol"</span>: <span class="token boolean">true</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">"FileSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MaxFileSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DriverName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Directory"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePublicLink"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PublicLinkSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbnailWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbnailHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PreviewWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PreviewHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ProfileWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ProfileHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InitialFont"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3AccessKeyId"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3SecretAccessKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Bucket"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Region"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Endpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3SSL"</span>: <span class="token boolean">true</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">"EmailSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"EnableSignUpWithEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSignInWithEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSignInWithUsername"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SendEmailNotifications"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RequireEmailVerification"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackEmail"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackOrganization"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPUsername"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPPassword"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPPort"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InviteSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PasswordResetSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SendPushNotifications"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PushNotificationServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PushNotificationContents"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableEmailBatching"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailBatchingBufferSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailBatchingInterval"</span>: <span class="token number">0</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">"RateLimitSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PerSec"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxBurst"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MemoryStoreSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"VaryByRemoteAddr"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"VaryByHeader"</span>: <span class="token string">"string"</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">"PrivacySettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"ShowEmailAddress"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ShowFullName"</span>: <span class="token boolean">true</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">"SupportSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"TermsOfServiceLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PrivacyPolicyLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AboutLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"HelpLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ReportAProblemLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SupportEmail"</span>: <span class="token string">"string"</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">"GitLabSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"GoogleSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"Office365Settings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"LdapSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LdapServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LdapPort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BaseDN"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BindUsername"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BindPassword"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserFilter"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FirstNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LastNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UsernameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"NicknameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PositionAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SyncIntervalMinutes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SkipCertificateVerification"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"QueryTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxPageSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LoginFieldName"</span>: <span class="token string">"string"</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">"ComplianceSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Directory"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDaily"</span>: <span class="token boolean">true</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">"LocalizationSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"DefaultServerLocale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DefaultClientLocale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AvailableLocales"</span>: <span class="token string">"string"</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">"SamlSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Verify"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Encrypt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpUrl"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpDescriptorUrl"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AssertionConsumerServiceURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpCertificateFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PublicCertificateFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PrivateKeyFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FirstNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LastNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UsernameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"NicknameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LocaleAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PositionAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LoginButtonText"</span>: <span class="token string">"string"</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">"NativeAppSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"AppDownloadLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AndroidAppDownloadLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IosAppDownloadLink"</span>: <span class="token string">"string"</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">"ClusterSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InterNodeListenAddress"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InterNodeUrls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</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">"MetricsSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BlockProfileRate"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ListenAddress"</span>: <span class="token string">"string"</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">"AnalyticsSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MaxUsersForStatistics"</span>: <span class="token number">0</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-2083" aria-labelledby="react-tabs-2082"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2085" aria-labelledby="react-tabs-2084"></div></div></div></div></div></div><div id="tag/system/paths/~1config~1reload/post" data-section-id="tag/system/paths/~1config~1reload/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1config~1reload/post"></a>Reload configuration<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Reload the configuration file to pick up on any changes made to it.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Configuration reload successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/config/reload</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/config/reload</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/config/reload</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2086" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2087" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2087" aria-labelledby="react-tabs-2086"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// ReloadConfig</span>
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">ReloadConfig</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2088" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2089" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2090" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2091">400</li><li class="tab-error" role="tab" id="react-tabs-2092" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2093">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2089" aria-labelledby="react-tabs-2088"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2091" aria-labelledby="react-tabs-2090"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2093" aria-labelledby="react-tabs-2092"></div></div></div></div></div></div><div id="tag/system/paths/~1config~1client/get" data-section-id="tag/system/paths/~1config~1client/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1config~1client/get"></a>Get client configuration<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a subset of the server configuration needed by the client.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>No permission required.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="format"><span class="sc-kGXeez bcLONg"></span>format<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Must be <code>old</code>, other formats not implemented yet</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT hLVzSF"><strong>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Configuration retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/config/client</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/config/client</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/config/client</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2094" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2095" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2095" aria-labelledby="react-tabs-2094"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetOldClientConfig</span>
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetOldClientConfig</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-2096" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2097" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-2098" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2099">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2097" aria-labelledby="react-tabs-2096"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-2099" aria-labelledby="react-tabs-2098"></div></div></div></div></div></div><div id="tag/system/paths/~1config~1environment/get" data-section-id="tag/system/paths/~1config~1environment/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1config~1environment/get"></a>Get configuration made through environment variables<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Retrieve a json object mirroring the server configuration where fields are set to true
|
||
if the corresponding config setting is set through an environment variable. Settings
|
||
that haven't been set through environment variables will be missing from the object.</p>
|
||
<p><strong>Minimum server version</strong>: 4.10</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Configuration retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/config/environment</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/config/environment</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/config/environment</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2100" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2101" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2102" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2103">400</li><li class="tab-error" role="tab" id="react-tabs-2104" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2105">401</li><li class="tab-error" role="tab" id="react-tabs-2106" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2107">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2101" aria-labelledby="react-tabs-2100"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ServiceSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"SiteURL"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ListenAddress"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TLSCertFile"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TLSKeyFile"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UseLetsEncrypt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LetsEncryptCertificateCacheFile"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Forward80To443"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ReadTimeout"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WriteTimeout"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaximumLoginAttempts"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SegmentDeveloperKey"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"GoogleDeveloperKey"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOAuthServiceProvider"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableIncomingWebhooks"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOutgoingWebhooks"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCommands"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOnlyAdminIntegrations"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePostUsernameOverride"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePostIconOverride"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableTesting"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDeveloper"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSecurityFixAlert"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableInsecureOutgoingConnections"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableMultifactorAuthentication"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnforceMultifactorAuthentication"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AllowCorsFrom"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthWebInDays"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthMobileInDays"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthSSOInDays"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionCacheInMinutes"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebsocketSecurePort"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebsocketPort"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebserverMode"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCustomEmoji"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictCustomEmojiCreation"</span>: <span class="token boolean">true</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">"TeamSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"SiteName"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxUsersPerTeam"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableTeamCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableUserCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOpenServer"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictCreationToDomains"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCustomBrand"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"CustomBrandText"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"CustomDescriptionText"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictDirectMessage"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictTeamInvite"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelManagement"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelManagement"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelDeletion"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelDeletion"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserStatusAwayTimeout"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxChannelsPerTeam"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxNotificationsPerChannel"</span>: <span class="token boolean">true</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">"SqlSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"DriverName"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DataSource"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DataSourceReplicas"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxIdleConns"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxOpenConns"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Trace"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AtRestEncryptKey"</span>: <span class="token boolean">true</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">"LogSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"EnableConsole"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConsoleLevel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableFile"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FileLevel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FileLocation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableWebhookDebugging"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDiagnostics"</span>: <span class="token boolean">true</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">"PasswordSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MinimumLength"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Lowercase"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Number"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Uppercase"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Symbol"</span>: <span class="token boolean">true</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">"FileSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MaxFileSize"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DriverName"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Directory"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePublicLink"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PublicLinkSalt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbnailWidth"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbnailHeight"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PreviewWidth"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PreviewHeight"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ProfileWidth"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ProfileHeight"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InitialFont"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3AccessKeyId"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3SecretAccessKey"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Bucket"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Region"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Endpoint"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3SSL"</span>: <span class="token boolean">true</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">"EmailSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"EnableSignUpWithEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSignInWithEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSignInWithUsername"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SendEmailNotifications"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RequireEmailVerification"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackName"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackOrganization"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPUsername"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPPassword"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPServer"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPPort"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InviteSalt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PasswordResetSalt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SendPushNotifications"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PushNotificationServer"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PushNotificationContents"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableEmailBatching"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailBatchingBufferSize"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailBatchingInterval"</span>: <span class="token boolean">true</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">"RateLimitSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PerSec"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxBurst"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MemoryStoreSize"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"VaryByRemoteAddr"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"VaryByHeader"</span>: <span class="token boolean">true</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">"PrivacySettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"ShowEmailAddress"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ShowFullName"</span>: <span class="token boolean">true</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">"SupportSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"TermsOfServiceLink"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PrivacyPolicyLink"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AboutLink"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"HelpLink"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ReportAProblemLink"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SupportEmail"</span>: <span class="token boolean">true</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">"GitLabSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token boolean">true</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">"GoogleSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token boolean">true</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">"Office365Settings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token boolean">true</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">"LdapSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LdapServer"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LdapPort"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BaseDN"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BindUsername"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BindPassword"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserFilter"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FirstNameAttribute"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LastNameAttribute"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailAttribute"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UsernameAttribute"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"NicknameAttribute"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdAttribute"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PositionAttribute"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SyncIntervalMinutes"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SkipCertificateVerification"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"QueryTimeout"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxPageSize"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LoginFieldName"</span>: <span class="token boolean">true</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">"ComplianceSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Directory"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDaily"</span>: <span class="token boolean">true</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">"LocalizationSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"DefaultServerLocale"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DefaultClientLocale"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AvailableLocales"</span>: <span class="token boolean">true</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">"SamlSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Verify"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Encrypt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpUrl"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpDescriptorUrl"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AssertionConsumerServiceURL"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpCertificateFile"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PublicCertificateFile"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PrivateKeyFile"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FirstNameAttribute"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LastNameAttribute"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailAttribute"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UsernameAttribute"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"NicknameAttribute"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LocaleAttribute"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PositionAttribute"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LoginButtonText"</span>: <span class="token boolean">true</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">"NativeAppSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"AppDownloadLink"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AndroidAppDownloadLink"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IosAppDownloadLink"</span>: <span class="token boolean">true</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">"ClusterSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InterNodeListenAddress"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InterNodeUrls"</span>: <span class="token boolean">true</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">"MetricsSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BlockProfileRate"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ListenAddress"</span>: <span class="token boolean">true</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">"AnalyticsSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MaxUsersForStatistics"</span>: <span class="token boolean">true</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-2103" aria-labelledby="react-tabs-2102"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2105" aria-labelledby="react-tabs-2104"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2107" aria-labelledby="react-tabs-2106"></div></div></div></div></div></div><div id="tag/system/paths/~1config~1patch/put" data-section-id="tag/system/paths/~1config~1patch/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1config~1patch/put"></a>Patch configuration<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Submit configuration to patch. As of server version 4.8, the <code>PluginSettings.EnableUploads</code> setting cannot be modified by this endpoint.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.
|
||
<strong>Minimum server version</strong>: 5.20</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Mattermost configuration</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="ServiceSettings"><span class="sc-kGXeez bcLONg"></span>ServiceSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="TeamSettings"><span class="sc-kGXeez bcLONg"></span>TeamSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="SqlSettings"><span class="sc-kGXeez bcLONg"></span>SqlSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="LogSettings"><span class="sc-kGXeez bcLONg"></span>LogSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="PasswordSettings"><span class="sc-kGXeez bcLONg"></span>PasswordSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="FileSettings"><span class="sc-kGXeez bcLONg"></span>FileSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="EmailSettings"><span class="sc-kGXeez bcLONg"></span>EmailSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="RateLimitSettings"><span class="sc-kGXeez bcLONg"></span>RateLimitSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="PrivacySettings"><span class="sc-kGXeez bcLONg"></span>PrivacySettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="SupportSettings"><span class="sc-kGXeez bcLONg"></span>SupportSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="GitLabSettings"><span class="sc-kGXeez bcLONg"></span>GitLabSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="GoogleSettings"><span class="sc-kGXeez bcLONg"></span>GoogleSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="Office365Settings"><span class="sc-kGXeez bcLONg"></span>Office365Settings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="LdapSettings"><span class="sc-kGXeez bcLONg"></span>LdapSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="ComplianceSettings"><span class="sc-kGXeez bcLONg"></span>ComplianceSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="LocalizationSettings"><span class="sc-kGXeez bcLONg"></span>LocalizationSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="SamlSettings"><span class="sc-kGXeez bcLONg"></span>SamlSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="NativeAppSettings"><span class="sc-kGXeez bcLONg"></span>NativeAppSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="ClusterSettings"><span class="sc-kGXeez bcLONg"></span>ClusterSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="MetricsSettings"><span class="sc-kGXeez bcLONg"></span>MetricsSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="AnalyticsSettings"><span class="sc-kGXeez bcLONg"></span>AnalyticsSettings<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Configuration update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/config/patch</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/config/patch</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/config/patch</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2108" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2109" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-2110" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2111">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2109" aria-labelledby="react-tabs-2108"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ServiceSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"SiteURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ListenAddress"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TLSCertFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TLSKeyFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UseLetsEncrypt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LetsEncryptCertificateCacheFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Forward80To443"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ReadTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WriteTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaximumLoginAttempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SegmentDeveloperKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"GoogleDeveloperKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOAuthServiceProvider"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableIncomingWebhooks"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOutgoingWebhooks"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCommands"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOnlyAdminIntegrations"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePostUsernameOverride"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePostIconOverride"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableTesting"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDeveloper"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSecurityFixAlert"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableInsecureOutgoingConnections"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableMultifactorAuthentication"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnforceMultifactorAuthentication"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AllowCorsFrom"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthWebInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthMobileInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthSSOInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionCacheInMinutes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebsocketSecurePort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebsocketPort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebserverMode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCustomEmoji"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictCustomEmojiCreation"</span>: <span class="token string">"string"</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">"TeamSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"SiteName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxUsersPerTeam"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableTeamCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableUserCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOpenServer"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictCreationToDomains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCustomBrand"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"CustomBrandText"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"CustomDescriptionText"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictDirectMessage"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictTeamInvite"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelManagement"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelManagement"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelCreation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelCreation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelDeletion"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelDeletion"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserStatusAwayTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxChannelsPerTeam"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxNotificationsPerChannel"</span>: <span class="token number">0</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">"SqlSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"DriverName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DataSource"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DataSourceReplicas"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxIdleConns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxOpenConns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Trace"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AtRestEncryptKey"</span>: <span class="token string">"string"</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">"LogSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"EnableConsole"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConsoleLevel"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableFile"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FileLevel"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FileLocation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableWebhookDebugging"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDiagnostics"</span>: <span class="token boolean">true</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">"PasswordSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MinimumLength"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Lowercase"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Number"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Uppercase"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Symbol"</span>: <span class="token boolean">true</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">"FileSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MaxFileSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DriverName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Directory"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePublicLink"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PublicLinkSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbnailWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbnailHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PreviewWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PreviewHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ProfileWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ProfileHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InitialFont"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3AccessKeyId"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3SecretAccessKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Bucket"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Region"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Endpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3SSL"</span>: <span class="token boolean">true</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">"EmailSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"EnableSignUpWithEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSignInWithEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSignInWithUsername"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SendEmailNotifications"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RequireEmailVerification"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackEmail"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackOrganization"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPUsername"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPPassword"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPPort"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InviteSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PasswordResetSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SendPushNotifications"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PushNotificationServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PushNotificationContents"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableEmailBatching"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailBatchingBufferSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailBatchingInterval"</span>: <span class="token number">0</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">"RateLimitSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PerSec"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxBurst"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MemoryStoreSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"VaryByRemoteAddr"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"VaryByHeader"</span>: <span class="token string">"string"</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">"PrivacySettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"ShowEmailAddress"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ShowFullName"</span>: <span class="token boolean">true</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">"SupportSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"TermsOfServiceLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PrivacyPolicyLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AboutLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"HelpLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ReportAProblemLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SupportEmail"</span>: <span class="token string">"string"</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">"GitLabSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"GoogleSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"Office365Settings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"LdapSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LdapServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LdapPort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BaseDN"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BindUsername"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BindPassword"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserFilter"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FirstNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LastNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UsernameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"NicknameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PositionAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SyncIntervalMinutes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SkipCertificateVerification"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"QueryTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxPageSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LoginFieldName"</span>: <span class="token string">"string"</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">"ComplianceSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Directory"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDaily"</span>: <span class="token boolean">true</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">"LocalizationSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"DefaultServerLocale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DefaultClientLocale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AvailableLocales"</span>: <span class="token string">"string"</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">"SamlSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Verify"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Encrypt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpUrl"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpDescriptorUrl"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AssertionConsumerServiceURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpCertificateFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PublicCertificateFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PrivateKeyFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FirstNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LastNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UsernameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"NicknameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LocaleAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PositionAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LoginButtonText"</span>: <span class="token string">"string"</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">"NativeAppSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"AppDownloadLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AndroidAppDownloadLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IosAppDownloadLink"</span>: <span class="token string">"string"</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">"ClusterSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InterNodeListenAddress"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InterNodeUrls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</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">"MetricsSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BlockProfileRate"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ListenAddress"</span>: <span class="token string">"string"</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">"AnalyticsSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MaxUsersForStatistics"</span>: <span class="token number">0</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-2111" aria-labelledby="react-tabs-2110"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2112" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2113" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2114" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2115">400</li><li class="tab-error" role="tab" id="react-tabs-2116" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2117">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2113" aria-labelledby="react-tabs-2112"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ServiceSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"SiteURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ListenAddress"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TLSCertFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TLSKeyFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UseLetsEncrypt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LetsEncryptCertificateCacheFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Forward80To443"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ReadTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WriteTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaximumLoginAttempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SegmentDeveloperKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"GoogleDeveloperKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOAuthServiceProvider"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableIncomingWebhooks"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOutgoingWebhooks"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCommands"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOnlyAdminIntegrations"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePostUsernameOverride"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePostIconOverride"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableTesting"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDeveloper"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSecurityFixAlert"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableInsecureOutgoingConnections"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableMultifactorAuthentication"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnforceMultifactorAuthentication"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AllowCorsFrom"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthWebInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthMobileInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionLengthSSOInDays"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SessionCacheInMinutes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebsocketSecurePort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebsocketPort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"WebserverMode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCustomEmoji"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictCustomEmojiCreation"</span>: <span class="token string">"string"</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">"TeamSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"SiteName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxUsersPerTeam"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableTeamCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableUserCreation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableOpenServer"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictCreationToDomains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableCustomBrand"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"CustomBrandText"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"CustomDescriptionText"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictDirectMessage"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictTeamInvite"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelManagement"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelManagement"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelCreation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelCreation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPublicChannelDeletion"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RestrictPrivateChannelDeletion"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserStatusAwayTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxChannelsPerTeam"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxNotificationsPerChannel"</span>: <span class="token number">0</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">"SqlSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"DriverName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DataSource"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DataSourceReplicas"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxIdleConns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxOpenConns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Trace"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AtRestEncryptKey"</span>: <span class="token string">"string"</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">"LogSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"EnableConsole"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConsoleLevel"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableFile"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FileLevel"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FileLocation"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableWebhookDebugging"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDiagnostics"</span>: <span class="token boolean">true</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">"PasswordSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MinimumLength"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Lowercase"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Number"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Uppercase"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Symbol"</span>: <span class="token boolean">true</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">"FileSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MaxFileSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DriverName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Directory"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnablePublicLink"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PublicLinkSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbnailWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ThumbnailHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PreviewWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PreviewHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ProfileWidth"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ProfileHeight"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InitialFont"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3AccessKeyId"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3SecretAccessKey"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Bucket"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Region"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3Endpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AmazonS3SSL"</span>: <span class="token boolean">true</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">"EmailSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"EnableSignUpWithEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSignInWithEmail"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableSignInWithUsername"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SendEmailNotifications"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"RequireEmailVerification"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackName"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackEmail"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FeedbackOrganization"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPUsername"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPPassword"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SMTPPort"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InviteSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PasswordResetSalt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SendPushNotifications"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PushNotificationServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PushNotificationContents"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableEmailBatching"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailBatchingBufferSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailBatchingInterval"</span>: <span class="token number">0</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">"RateLimitSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PerSec"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxBurst"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MemoryStoreSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"VaryByRemoteAddr"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"VaryByHeader"</span>: <span class="token string">"string"</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">"PrivacySettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"ShowEmailAddress"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ShowFullName"</span>: <span class="token boolean">true</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">"SupportSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"TermsOfServiceLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PrivacyPolicyLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AboutLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"HelpLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ReportAProblemLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SupportEmail"</span>: <span class="token string">"string"</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">"GitLabSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"GoogleSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"Office365Settings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AuthEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"TokenEndpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserApiEndpoint"</span>: <span class="token string">"string"</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">"LdapSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LdapServer"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LdapPort"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ConnectionSecurity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BaseDN"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BindUsername"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BindPassword"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UserFilter"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FirstNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LastNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UsernameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"NicknameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PositionAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SyncIntervalMinutes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"SkipCertificateVerification"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"QueryTimeout"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"MaxPageSize"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LoginFieldName"</span>: <span class="token string">"string"</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">"ComplianceSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Directory"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EnableDaily"</span>: <span class="token boolean">true</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">"LocalizationSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"DefaultServerLocale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"DefaultClientLocale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AvailableLocales"</span>: <span class="token string">"string"</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">"SamlSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Verify"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"Encrypt"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpUrl"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpDescriptorUrl"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AssertionConsumerServiceURL"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IdpCertificateFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PublicCertificateFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PrivateKeyFile"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"FirstNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LastNameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"EmailAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"UsernameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"NicknameAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LocaleAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"PositionAttribute"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"LoginButtonText"</span>: <span class="token string">"string"</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">"NativeAppSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"AppDownloadLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"AndroidAppDownloadLink"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"IosAppDownloadLink"</span>: <span class="token string">"string"</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">"ClusterSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InterNodeListenAddress"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"InterNodeUrls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</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">"MetricsSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"Enable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"BlockProfileRate"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ListenAddress"</span>: <span class="token string">"string"</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">"AnalyticsSettings"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"MaxUsersForStatistics"</span>: <span class="token number">0</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-2115" aria-labelledby="react-tabs-2114"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2117" aria-labelledby="react-tabs-2116"></div></div></div></div></div></div><div id="tag/system/paths/~1license/post" data-section-id="tag/system/paths/~1license/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1license/post"></a>Upload license file<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Upload a license to enable enterprise features.</p>
|
||
<p><strong>Minimum server version</strong>: 4.0</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">multipart/form-data</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="license"><span class="sc-kGXeez bcLONg"></span>license<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span><span class="sc-cHGsZl sc-kgAjT hqYVjx"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The license to be uploaded</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>License file upload successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>413<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Content too large</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/license</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/license</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/license</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2118" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2119" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2119" aria-labelledby="react-tabs-2118"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
file<span class="token punctuation">,</span> err <span class="token operator">:=</span> os<span class="token punctuation">.</span><span class="token function">Open</span><span class="token punctuation">(</span><span class="token string">"<Your license file>"</span><span class="token punctuation">)</span>
|
||
<span class="token keyword">if</span> err <span class="token operator">!=</span> <span class="token boolean">nil</span> <span class="token punctuation">{</span>
|
||
<span class="token keyword">return</span> err
|
||
<span class="token punctuation">}</span>
|
||
<span class="token keyword">defer</span> file<span class="token punctuation">.</span><span class="token function">Close</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
|
||
data <span class="token operator">:=</span> <span class="token operator">&</span>bytes<span class="token punctuation">.</span>Buffer<span class="token punctuation">{</span><span class="token punctuation">}</span>
|
||
<span class="token keyword">if</span> <span class="token boolean">_</span><span class="token punctuation">,</span> err <span class="token operator">:=</span> io<span class="token punctuation">.</span><span class="token function">Copy</span><span class="token punctuation">(</span>data<span class="token punctuation">,</span> file<span class="token punctuation">)</span><span class="token punctuation">;</span> err <span class="token operator">!=</span> <span class="token boolean">nil</span> <span class="token punctuation">{</span>
|
||
<span class="token keyword">return</span> err
|
||
<span class="token punctuation">}</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">UploadLicenseFile</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span><span class="token function">Bytes</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2120" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2121" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-2122" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2123">400</li><li class="tab-error" role="tab" id="react-tabs-2124" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2125">401</li><li class="tab-error" role="tab" id="react-tabs-2126" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2127">403</li><li class="tab-error" role="tab" id="react-tabs-2128" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2129">413</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2121" aria-labelledby="react-tabs-2120"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2123" aria-labelledby="react-tabs-2122"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2125" aria-labelledby="react-tabs-2124"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2127" aria-labelledby="react-tabs-2126"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2129" aria-labelledby="react-tabs-2128"></div></div></div></div></div></div><div id="tag/system/paths/~1license/delete" data-section-id="tag/system/paths/~1license/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1license/delete"></a>Remove license file<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Remove the license file from the server. This will disable all enterprise features.</p>
|
||
<p><strong>Minimum server version</strong>: 4.0</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT hLVzSF"><strong>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>License removal successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/license</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/license</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/license</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-2130" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2131" tabindex="0">401</li><li class="tab-error" role="tab" id="react-tabs-2132" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2133">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2131" aria-labelledby="react-tabs-2130"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-2133" aria-labelledby="react-tabs-2132"></div></div></div></div></div></div><div id="tag/system/paths/~1license~1client/get" data-section-id="tag/system/paths/~1license~1client/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1license~1client/get"></a>Get client license<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a subset of the server license needed by the client.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>No permission required but having the <code>manage_system</code> permission returns more information.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="format"><span class="sc-kGXeez bcLONg"></span>format<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Must be <code>old</code>, other formats not implemented yet</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT hLVzSF"><strong>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>License retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/license/client</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/license/client</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/license/client</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2134" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2135" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2135" aria-labelledby="react-tabs-2134"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetOldClientLicense</span>
|
||
license<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetOldClientLicense</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-2136" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2137" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-2138" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2139">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2137" aria-labelledby="react-tabs-2136"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-2139" aria-labelledby="react-tabs-2138"></div></div></div></div></div></div><div id="tag/system/paths/~1audits/get" data-section-id="tag/system/paths/~1audits/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1audits/get"></a>Get audits<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of audits for all users on the system, selected with <code>page</code> and <code>per_page</code> query parameters.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of audits per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Audits retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/audits</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/audits</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/audits</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2140" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2141" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2141" aria-labelledby="react-tabs-2140"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetAudits</span>
|
||
audits<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetAudits</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">100</span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2142" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2143" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2144" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2145">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2143" aria-labelledby="react-tabs-2142"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"action"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extra_info"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ip_address"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"session_id"</span>: <span class="token string">"string"</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-2145" aria-labelledby="react-tabs-2144"></div></div></div></div></div></div><div id="tag/system/paths/~1caches~1invalidate/post" data-section-id="tag/system/paths/~1caches~1invalidate/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1caches~1invalidate/post"></a>Invalidate all the caches<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Purge all the in-memory caches for the Mattermost server. This can have a temporary negative effect on performance while the caches are re-populated.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Caches invalidate successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/caches/invalidate</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/caches/invalidate</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/caches/invalidate</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2146" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2147" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2147" aria-labelledby="react-tabs-2146"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// InvalidateCaches</span>
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">InvalidateCaches</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2148" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2149" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2150" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2151">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2149" aria-labelledby="react-tabs-2148"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2151" aria-labelledby="react-tabs-2150"></div></div></div></div></div></div><div id="tag/system/paths/~1logs/get" data-section-id="tag/system/paths/~1logs/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1logs/get"></a>Get logs<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of server logs, selected with <code>page</code> and <code>logs_per_page</code> query parameters.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="logs_per_page"><span class="sc-kGXeez bcLONg"></span>logs_per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">"10000"</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of logs per page. There is a maximum limit of 10000 logs per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Logs retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/logs</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/logs</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/logs</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2152" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2153" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2153" aria-labelledby="react-tabs-2152"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetLogs</span>
|
||
logs<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetLogs</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">10</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2154" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2155" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2156" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2157">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2155" aria-labelledby="react-tabs-2154"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"string"</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-2157" aria-labelledby="react-tabs-2156"></div></div></div></div></div></div><div id="tag/system/paths/~1logs/post" data-section-id="tag/system/paths/~1logs/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1logs/post"></a>Add log message<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Add log messages to the server logs.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Users with <code>manage_system</code> permission can log ERROR or DEBUG messages.
|
||
Logged in users can log ERROR or DEBUG messages when <code>ServiceSettings.EnableDeveloper</code> is <code>true</code> or just DEBUG messages when <code>false</code>.
|
||
Non-logged in users can log ERROR or DEBUG messages when <code>ServiceSettings.EnableDeveloper</code> is <code>true</code> and cannot log when <code>false</code>.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="level"><span class="sc-kGXeez bcLONg"></span>level<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The error level, ERROR or DEBUG</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="message"><span class="sc-kGXeez bcLONg"></span>message<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Message to send to the server logs</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Logs sent successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/logs</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/logs</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/logs</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2158" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2159" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-2160" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2161">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2159" aria-labelledby="react-tabs-2158"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"level"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</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-2161" aria-labelledby="react-tabs-2160"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2162" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2163" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2164" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2165">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2163" aria-labelledby="react-tabs-2162"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><span class="token punctuation">{ }</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2165" aria-labelledby="react-tabs-2164"></div></div></div></div></div></div><div id="tag/system/paths/~1analytics~1old/get" data-section-id="tag/system/paths/~1analytics~1old/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1analytics~1old/get"></a>Get analytics<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get some analytics data about the system. This endpoint uses the old format, the <code>/analytics</code> route is reserved for the new format when it gets implemented.</p>
|
||
<p>The returned JSON changes based on the <code>name</code> query parameter but is always key/value pairs.</p>
|
||
<p><strong>Minimum server version</strong>: 4.0</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">"standard"</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Possible values are "standard", "post_counts_day", "user_counts_with_posts_day" or "extra_counts"</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The team ID to filter the data by</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT hLVzSF"><strong>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Analytics retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/analytics/old</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/analytics/old</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/analytics/old</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-2166" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2167" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-2168" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2169">401</li><li class="tab-error" role="tab" id="react-tabs-2170" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2171">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2167" aria-labelledby="react-tabs-2166"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-2169" aria-labelledby="react-tabs-2168"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2171" aria-labelledby="react-tabs-2170"></div></div></div></div></div></div><div id="tag/system/paths/~1server_busy/post" data-section-id="tag/system/paths/~1server_busy/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1server_busy/post"></a>Set the server busy (high load) flag<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Marks the server as currently having high load which disables non-critical services such as search, statuses and typing notifications.</p>
|
||
<p><strong>Minimum server version</strong>: 5.20</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="seconds"><span class="sc-kGXeez bcLONg"></span>seconds</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">"3600"</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Number of seconds until server is automatically marked as not busy.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Server busy flag set successfully</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/server_busy</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/server_busy</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/server_busy</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2172" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2173" tabindex="0">Go</li><li class="react-tabs__tab" role="tab" id="react-tabs-2174" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2175">curl</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2173" aria-labelledby="react-tabs-2172"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">SetServerBusy</span><span class="token punctuation">(</span><span class="token number">300</span><span class="token punctuation">)</span>
|
||
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2175" aria-labelledby="react-tabs-2174"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2176" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2177" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2178" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2179">400</li><li class="tab-error" role="tab" id="react-tabs-2180" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2181">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2177" aria-labelledby="react-tabs-2176"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2179" aria-labelledby="react-tabs-2178"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2181" aria-labelledby="react-tabs-2180"></div></div></div></div></div></div><div id="tag/system/paths/~1server_busy/get" data-section-id="tag/system/paths/~1server_busy/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1server_busy/get"></a>Get server busy expiry time.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Gets the timestamp corresponding to when the server busy flag will be automatically cleared. </p>
|
||
<p><strong>Minimum server version</strong>: 5.20</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Server busy expires timestamp retrieved successfully</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/server_busy</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/server_busy</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/server_busy</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2182" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2183" tabindex="0">Go</li><li class="react-tabs__tab" role="tab" id="react-tabs-2184" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2185">curl</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2183" aria-labelledby="react-tabs-2182"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// expires is a time.Time</span>
|
||
expires<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetServerBusyExpires</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2185" aria-labelledby="react-tabs-2184"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2186" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2187" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2188" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2189">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2187" aria-labelledby="react-tabs-2186"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"busy"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires"</span>: <span class="token number">0</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-2189" aria-labelledby="react-tabs-2188"></div></div></div></div></div></div><div id="tag/system/paths/~1server_busy/delete" data-section-id="tag/system/paths/~1server_busy/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/system/paths/~1server_busy/delete"></a>Clears the server busy (high load) flag<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Marks the server as not having high load which re-enables non-critical services such as search, statuses and typing notifications.</p>
|
||
<p><strong>Minimum server version</strong>: 5.20</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Server busy flag cleared successfully</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/server_busy</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/server_busy</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/server_busy</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2190" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2191" tabindex="0">Go</li><li class="react-tabs__tab" role="tab" id="react-tabs-2192" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2193">curl</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2191" aria-labelledby="react-tabs-2190"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">ClearServerBusy</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2193" aria-labelledby="react-tabs-2192"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2194" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2195" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2196" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2197">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2195" aria-labelledby="react-tabs-2194"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2197" aria-labelledby="react-tabs-2196"></div></div></div></div></div></div><div id="tag/brand" data-section-id="tag/brand" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/brand"></a>brand</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints related to custom branding and white-labeling. See <a href="https://docs.mattermost.com/administration/branding.html">our branding documentation</a> for more information.</p>
|
||
</div></div></div><div id="tag/brand/paths/~1brand~1image/get" data-section-id="tag/brand/paths/~1brand~1image/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/brand/paths/~1brand~1image/get"></a>Get brand image<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get the previously uploaded brand image. Returns 404 if no brand image has been uploaded.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>No permission required.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Brand image retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/brand/image</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/brand/image</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/brand/image</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2198" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2199" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2199" aria-labelledby="react-tabs-2198"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// GetBrandImage</span>
|
||
img<span class="token punctuation">,</span> err <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetBrandImage</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2200" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2201" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2202" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2203">404</li><li class="tab-error" role="tab" id="react-tabs-2204" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2205">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2201" aria-labelledby="react-tabs-2200"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><span class="token string">"string"</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2203" aria-labelledby="react-tabs-2202"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2205" aria-labelledby="react-tabs-2204"></div></div></div></div></div></div><div id="tag/brand/paths/~1brand~1image/post" data-section-id="tag/brand/paths/~1brand~1image/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/brand/paths/~1brand~1image/post"></a>Upload brand image<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Uploads a brand image.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">multipart/form-data</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="image"><span class="sc-kGXeez bcLONg"></span>image<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span><span class="sc-cHGsZl sc-kgAjT hqYVjx"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The image to be uploaded</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Brand image upload successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>413<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Content too large</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/brand/image</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/brand/image</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/brand/image</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2206" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2207" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2207" aria-labelledby="react-tabs-2206"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
file<span class="token punctuation">,</span> err <span class="token operator">:=</span> os<span class="token punctuation">.</span><span class="token function">Open</span><span class="token punctuation">(</span><span class="token string">"<Your image>"</span><span class="token punctuation">)</span>
|
||
<span class="token keyword">if</span> err <span class="token operator">!=</span> <span class="token boolean">nil</span> <span class="token punctuation">{</span>
|
||
<span class="token keyword">return</span> err
|
||
<span class="token punctuation">}</span>
|
||
<span class="token keyword">defer</span> file<span class="token punctuation">.</span><span class="token function">Close</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
|
||
data <span class="token operator">:=</span> <span class="token operator">&</span>bytes<span class="token punctuation">.</span>Buffer<span class="token punctuation">{</span><span class="token punctuation">}</span>
|
||
<span class="token keyword">if</span> <span class="token boolean">_</span><span class="token punctuation">,</span> err <span class="token operator">:=</span> io<span class="token punctuation">.</span><span class="token function">Copy</span><span class="token punctuation">(</span>data<span class="token punctuation">,</span> file<span class="token punctuation">)</span><span class="token punctuation">;</span> err <span class="token operator">!=</span> <span class="token boolean">nil</span> <span class="token punctuation">{</span>
|
||
<span class="token keyword">return</span> err
|
||
<span class="token punctuation">}</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">UploadBrandImage</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span><span class="token function">Bytes</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2208" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2209" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-2210" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2211">400</li><li class="tab-error" role="tab" id="react-tabs-2212" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2213">401</li><li class="tab-error" role="tab" id="react-tabs-2214" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2215">403</li><li class="tab-error" role="tab" id="react-tabs-2216" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2217">413</li><li class="tab-error" role="tab" id="react-tabs-2218" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2219">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2209" aria-labelledby="react-tabs-2208"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2211" aria-labelledby="react-tabs-2210"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2213" aria-labelledby="react-tabs-2212"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2215" aria-labelledby="react-tabs-2214"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2217" aria-labelledby="react-tabs-2216"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2219" aria-labelledby="react-tabs-2218"></div></div></div></div></div></div><div id="tag/brand/paths/~1brand~1image/delete" data-section-id="tag/brand/paths/~1brand~1image/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/brand/paths/~1brand~1image/delete"></a>Delete current brand image<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Deletes the previously uploaded brand image. Returns 404 if no brand image has been uploaded.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.
|
||
<strong>Minimum server version: 5.6</strong></p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Brand image succesfully deleted</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/brand/image</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/brand/image</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/brand/image</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2220" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2221" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2221" aria-labelledby="react-tabs-2220"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// Delete brand image</span>
|
||
resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">DeleteBrandImage</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2222" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2223" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2224" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2225">401</li><li class="tab-error" role="tab" id="react-tabs-2226" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2227">403</li><li class="tab-error" role="tab" id="react-tabs-2228" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2229">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2223" aria-labelledby="react-tabs-2222"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2225" aria-labelledby="react-tabs-2224"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2227" aria-labelledby="react-tabs-2226"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2229" aria-labelledby="react-tabs-2228"></div></div></div></div></div></div><div id="tag/OAuth" data-section-id="tag/OAuth" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/OAuth"></a>OAuth</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for configuring and interacting with Mattermost as an OAuth 2.0 service provider.</p>
|
||
</div></div></div><div id="tag/OAuth/paths/~1oauth~1apps/post" data-section-id="tag/OAuth/paths/~1oauth~1apps/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/OAuth/paths/~1oauth~1apps/post"></a>Register OAuth app<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Register an OAuth 2.0 client application with Mattermost as the service provider.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_oauth</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>OAuth application to register</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The name of the client application</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="description"><span class="sc-kGXeez bcLONg"></span>description<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A short description of the application</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="icon_url"><span class="sc-kGXeez bcLONg"></span>icon_url</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A URL to an icon to display with the application</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="callback_urls"><span class="sc-kGXeez bcLONg"></span>callback_urls<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc">Array of </span><span class="sc-cHGsZl sc-kgAjT hqYVjx">strings</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A list of callback URLs for the appliation</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="homepage"><span class="sc-kGXeez bcLONg"></span>homepage<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A link to the website of the application</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="is_trusted"><span class="sc-kGXeez bcLONg"></span>is_trusted</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set this to <code>true</code> to skip asking users for permission</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>App registration successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/oauth/apps</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/oauth/apps</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/oauth/apps</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2230" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2231" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2231" aria-labelledby="react-tabs-2230"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"callback_urls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"homepage"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_trusted"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2232" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2233" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-2234" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2235">400</li><li class="tab-error" role="tab" id="react-tabs-2236" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2237">401</li><li class="tab-error" role="tab" id="react-tabs-2238" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2239">403</li><li class="tab-error" role="tab" id="react-tabs-2240" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2241">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2233" aria-labelledby="react-tabs-2232"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"client_secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"callback_urls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"homepage"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_trusted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</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-2235" aria-labelledby="react-tabs-2234"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2237" aria-labelledby="react-tabs-2236"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2239" aria-labelledby="react-tabs-2238"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2241" aria-labelledby="react-tabs-2240"></div></div></div></div></div></div><div id="tag/OAuth/paths/~1oauth~1apps/get" data-section-id="tag/OAuth/paths/~1oauth~1apps/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/OAuth/paths/~1oauth~1apps/get"></a>Get OAuth apps<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of OAuth 2.0 client applications registered with Mattermost.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>With <code>manage_oauth</code> permission, the apps registered by the logged in user are returned. With <code>manage_system_wide_oauth</code> permission, all apps regardless of creator are returned.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of apps per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>OAuthApp list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/oauth/apps</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/oauth/apps</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/oauth/apps</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2242" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2243" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2244" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2245">400</li><li class="tab-error" role="tab" id="react-tabs-2246" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2247">401</li><li class="tab-error" role="tab" id="react-tabs-2248" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2249">403</li><li class="tab-error" role="tab" id="react-tabs-2250" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2251">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2243" aria-labelledby="react-tabs-2242"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"client_secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"callback_urls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"homepage"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"is_trusted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</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-2245" aria-labelledby="react-tabs-2244"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2247" aria-labelledby="react-tabs-2246"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2249" aria-labelledby="react-tabs-2248"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2251" aria-labelledby="react-tabs-2250"></div></div></div></div></div></div><div id="tag/OAuth/paths/~1oauth~1apps~1{app_id}/get" data-section-id="tag/OAuth/paths/~1oauth~1apps~1{app_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/OAuth/paths/~1oauth~1apps~1{app_id}/get"></a>Get an OAuth app<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get an OAuth 2.0 client application registered with Mattermost.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>If app creator, must have <code>mange_oauth</code> permission otherwise <code>manage_system_wide_oauth</code> permission is required.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="app_id"><span class="sc-kGXeez bcLONg"></span>app_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Application client id</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>App retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/oauth/apps/{app_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/oauth/apps/{app_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/oauth/apps/{app_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2252" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2253" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2254" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2255">400</li><li class="tab-error" role="tab" id="react-tabs-2256" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2257">401</li><li class="tab-error" role="tab" id="react-tabs-2258" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2259">403</li><li class="tab-error" role="tab" id="react-tabs-2260" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2261">404</li><li class="tab-error" role="tab" id="react-tabs-2262" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2263">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2253" aria-labelledby="react-tabs-2252"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"client_secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"callback_urls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"homepage"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_trusted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</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-2255" aria-labelledby="react-tabs-2254"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2257" aria-labelledby="react-tabs-2256"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2259" aria-labelledby="react-tabs-2258"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2261" aria-labelledby="react-tabs-2260"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2263" aria-labelledby="react-tabs-2262"></div></div></div></div></div></div><div id="tag/OAuth/paths/~1oauth~1apps~1{app_id}/put" data-section-id="tag/OAuth/paths/~1oauth~1apps~1{app_id}/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/OAuth/paths/~1oauth~1apps~1{app_id}/put"></a>Update an OAuth app<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Update an OAuth 2.0 client application based on OAuth struct.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>If app creator, must have <code>mange_oauth</code> permission otherwise <code>manage_system_wide_oauth</code> permission is required.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="app_id"><span class="sc-kGXeez bcLONg"></span>app_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Application client id</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>OAuth application to update</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="id"><span class="sc-kGXeez bcLONg"></span>id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The id of the client application</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The name of the client application</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="description"><span class="sc-kGXeez bcLONg"></span>description<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A short description of the application</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="icon_url"><span class="sc-kGXeez bcLONg"></span>icon_url</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A URL to an icon to display with the application</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="callback_urls"><span class="sc-kGXeez bcLONg"></span>callback_urls<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc">Array of </span><span class="sc-cHGsZl sc-kgAjT hqYVjx">strings</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A list of callback URLs for the appliation</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="homepage"><span class="sc-kGXeez bcLONg"></span>homepage<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>A link to the website of the application</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="is_trusted"><span class="sc-kGXeez bcLONg"></span>is_trusted</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set this to <code>true</code> to skip asking users for permission. It will be set to false if value is not provided.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>App update successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/oauth/apps/{app_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/oauth/apps/{app_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/oauth/apps/{app_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2264" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2265" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-2266" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2267">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2265" aria-labelledby="react-tabs-2264"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"callback_urls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"homepage"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_trusted"</span>: <span class="token boolean">true</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-2267" aria-labelledby="react-tabs-2266"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2268" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2269" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2270" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2271">400</li><li class="tab-error" role="tab" id="react-tabs-2272" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2273">401</li><li class="tab-error" role="tab" id="react-tabs-2274" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2275">403</li><li class="tab-error" role="tab" id="react-tabs-2276" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2277">404</li><li class="tab-error" role="tab" id="react-tabs-2278" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2279">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2269" aria-labelledby="react-tabs-2268"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"client_secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"callback_urls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"homepage"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_trusted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</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-2271" aria-labelledby="react-tabs-2270"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2273" aria-labelledby="react-tabs-2272"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2275" aria-labelledby="react-tabs-2274"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2277" aria-labelledby="react-tabs-2276"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2279" aria-labelledby="react-tabs-2278"></div></div></div></div></div></div><div id="tag/OAuth/paths/~1oauth~1apps~1{app_id}/delete" data-section-id="tag/OAuth/paths/~1oauth~1apps~1{app_id}/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/OAuth/paths/~1oauth~1apps~1{app_id}/delete"></a>Delete an OAuth app<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Delete and unregister an OAuth 2.0 client application </p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>If app creator, must have <code>mange_oauth</code> permission otherwise <code>manage_system_wide_oauth</code> permission is required.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="app_id"><span class="sc-kGXeez bcLONg"></span>app_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Application client id</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>App deletion successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/oauth/apps/{app_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/oauth/apps/{app_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/oauth/apps/{app_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2280" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2281" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2282" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2283">400</li><li class="tab-error" role="tab" id="react-tabs-2284" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2285">401</li><li class="tab-error" role="tab" id="react-tabs-2286" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2287">403</li><li class="tab-error" role="tab" id="react-tabs-2288" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2289">404</li><li class="tab-error" role="tab" id="react-tabs-2290" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2291">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2281" aria-labelledby="react-tabs-2280"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2283" aria-labelledby="react-tabs-2282"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2285" aria-labelledby="react-tabs-2284"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2287" aria-labelledby="react-tabs-2286"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2289" aria-labelledby="react-tabs-2288"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2291" aria-labelledby="react-tabs-2290"></div></div></div></div></div></div><div id="tag/OAuth/paths/~1oauth~1apps~1{app_id}~1regen_secret/post" data-section-id="tag/OAuth/paths/~1oauth~1apps~1{app_id}~1regen_secret/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/OAuth/paths/~1oauth~1apps~1{app_id}~1regen_secret/post"></a>Regenerate OAuth app secret<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Regenerate the client secret for an OAuth 2.0 client application registered with Mattermost.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>If app creator, must have <code>mange_oauth</code> permission otherwise <code>manage_system_wide_oauth</code> permission is required.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="app_id"><span class="sc-kGXeez bcLONg"></span>app_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Application client id</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Secret regeneration successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/oauth/apps/{app_id}/regen_secret</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/oauth/apps/{app_id}/regen_secret</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/oauth/apps/{app_id}/regen_secret</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2292" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2293" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2294" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2295">400</li><li class="tab-error" role="tab" id="react-tabs-2296" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2297">401</li><li class="tab-error" role="tab" id="react-tabs-2298" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2299">403</li><li class="tab-error" role="tab" id="react-tabs-2300" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2301">404</li><li class="tab-error" role="tab" id="react-tabs-2302" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2303">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2293" aria-labelledby="react-tabs-2292"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"client_secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"callback_urls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"homepage"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_trusted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</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-2295" aria-labelledby="react-tabs-2294"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2297" aria-labelledby="react-tabs-2296"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2299" aria-labelledby="react-tabs-2298"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2301" aria-labelledby="react-tabs-2300"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2303" aria-labelledby="react-tabs-2302"></div></div></div></div></div></div><div id="tag/OAuth/paths/~1oauth~1apps~1{app_id}~1info/get" data-section-id="tag/OAuth/paths/~1oauth~1apps~1{app_id}~1info/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/OAuth/paths/~1oauth~1apps~1{app_id}~1info/get"></a>Get info on an OAuth app<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get public information about an OAuth 2.0 client application registered with Mattermost. The application's client secret will be blanked out.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="app_id"><span class="sc-kGXeez bcLONg"></span>app_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Application client id</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>App retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/oauth/apps/{app_id}/info</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/oauth/apps/{app_id}/info</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/oauth/apps/{app_id}/info</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2304" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2305" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2306" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2307">400</li><li class="tab-error" role="tab" id="react-tabs-2308" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2309">401</li><li class="tab-error" role="tab" id="react-tabs-2310" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2311">404</li><li class="tab-error" role="tab" id="react-tabs-2312" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2313">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2305" aria-labelledby="react-tabs-2304"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"client_secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"callback_urls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"homepage"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_trusted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</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-2307" aria-labelledby="react-tabs-2306"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2309" aria-labelledby="react-tabs-2308"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2311" aria-labelledby="react-tabs-2310"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2313" aria-labelledby="react-tabs-2312"></div></div></div></div></div></div><div id="tag/OAuth/paths/~1users~1{user_id}~1oauth~1apps~1authorized/get" data-section-id="tag/OAuth/paths/~1users~1{user_id}~1oauth~1apps~1authorized/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/OAuth/paths/~1users~1{user_id}~1oauth~1apps~1authorized/get"></a>Get authorized OAuth apps<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of OAuth 2.0 client applications authorized to access a user's account.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be authenticated as the user or have <code>edit_other_users</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of apps per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>OAuthApp list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/oauth/apps/authorized</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/oauth/apps/authorized</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/oauth/apps/authorized</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2314" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2315" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2316" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2317">400</li><li class="tab-error" role="tab" id="react-tabs-2318" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2319">401</li><li class="tab-error" role="tab" id="react-tabs-2320" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2321">403</li><li class="tab-error" role="tab" id="react-tabs-2322" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2323">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2315" aria-labelledby="react-tabs-2314"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"client_secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"icon_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"callback_urls"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"homepage"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"is_trusted"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</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-2317" aria-labelledby="react-tabs-2316"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2319" aria-labelledby="react-tabs-2318"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2321" aria-labelledby="react-tabs-2320"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2323" aria-labelledby="react-tabs-2322"></div></div></div></div></div></div><div id="tag/SAML" data-section-id="tag/SAML" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/SAML"></a>SAML</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for configuring and interacting with SAML.</p>
|
||
</div></div></div><div id="tag/SAML/paths/~1saml~1metadata/get" data-section-id="tag/SAML/paths/~1saml~1metadata/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/SAML/paths/~1saml~1metadata/get"></a>Get metadata<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get SAML metadata from the server. SAML must be configured properly.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>No permission required.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>SAML metadata retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/saml/metadata</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/saml/metadata</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/saml/metadata</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2324" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2325" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2326" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2327">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2325" aria-labelledby="react-tabs-2324"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><span class="token string">"string"</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2327" aria-labelledby="react-tabs-2326"></div></div></div></div></div></div><div id="tag/SAML/paths/~1saml~1certificate~1idp/post" data-section-id="tag/SAML/paths/~1saml~1certificate~1idp/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/SAML/paths/~1saml~1certificate~1idp/post"></a>Upload IDP certificate<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Upload the IDP certificate to be used with your SAML configuration. The server will pick a hard-coded filename for the IdpCertificateFile setting in your <code>config.json</code>.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">multipart/form-data</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="certificate"><span class="sc-kGXeez bcLONg"></span>certificate<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span><span class="sc-cHGsZl sc-kgAjT hqYVjx"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The IDP certificate file</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>SAML certificate upload successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/saml/certificate/idp</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/saml/certificate/idp</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/saml/certificate/idp</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2328" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2329" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2330" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2331">400</li><li class="tab-error" role="tab" id="react-tabs-2332" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2333">401</li><li class="tab-error" role="tab" id="react-tabs-2334" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2335">403</li><li class="tab-error" role="tab" id="react-tabs-2336" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2337">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2329" aria-labelledby="react-tabs-2328"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2331" aria-labelledby="react-tabs-2330"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2333" aria-labelledby="react-tabs-2332"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2335" aria-labelledby="react-tabs-2334"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2337" aria-labelledby="react-tabs-2336"></div></div></div></div></div></div><div id="tag/SAML/paths/~1saml~1certificate~1idp/delete" data-section-id="tag/SAML/paths/~1saml~1certificate~1idp/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/SAML/paths/~1saml~1certificate~1idp/delete"></a>Remove IDP certificate<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Delete the current IDP certificate being used with your SAML configuration. This will also disable SAML on your system as this certificate is required for SAML.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>SAML certificate delete successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/saml/certificate/idp</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/saml/certificate/idp</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/saml/certificate/idp</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2338" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2339" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2340" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2341">401</li><li class="tab-error" role="tab" id="react-tabs-2342" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2343">403</li><li class="tab-error" role="tab" id="react-tabs-2344" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2345">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2339" aria-labelledby="react-tabs-2338"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2341" aria-labelledby="react-tabs-2340"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2343" aria-labelledby="react-tabs-2342"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2345" aria-labelledby="react-tabs-2344"></div></div></div></div></div></div><div id="tag/SAML/paths/~1saml~1certificate~1public/post" data-section-id="tag/SAML/paths/~1saml~1certificate~1public/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/SAML/paths/~1saml~1certificate~1public/post"></a>Upload public certificate<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Upload the public certificate to be used for encryption with your SAML configuration. The server will pick a hard-coded filename for the PublicCertificateFile setting in your <code>config.json</code>.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">multipart/form-data</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="certificate"><span class="sc-kGXeez bcLONg"></span>certificate<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span><span class="sc-cHGsZl sc-kgAjT hqYVjx"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The public certificate file</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>SAML certificate upload successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/saml/certificate/public</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/saml/certificate/public</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/saml/certificate/public</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2346" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2347" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2348" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2349">400</li><li class="tab-error" role="tab" id="react-tabs-2350" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2351">401</li><li class="tab-error" role="tab" id="react-tabs-2352" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2353">403</li><li class="tab-error" role="tab" id="react-tabs-2354" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2355">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2347" aria-labelledby="react-tabs-2346"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2349" aria-labelledby="react-tabs-2348"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2351" aria-labelledby="react-tabs-2350"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2353" aria-labelledby="react-tabs-2352"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2355" aria-labelledby="react-tabs-2354"></div></div></div></div></div></div><div id="tag/SAML/paths/~1saml~1certificate~1public/delete" data-section-id="tag/SAML/paths/~1saml~1certificate~1public/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/SAML/paths/~1saml~1certificate~1public/delete"></a>Remove public certificate<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Delete the current public certificate being used with your SAML configuration. This will also disable encryption for SAML on your system as this certificate is required for that.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>SAML certificate delete successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/saml/certificate/public</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/saml/certificate/public</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/saml/certificate/public</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2356" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2357" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2358" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2359">401</li><li class="tab-error" role="tab" id="react-tabs-2360" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2361">403</li><li class="tab-error" role="tab" id="react-tabs-2362" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2363">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2357" aria-labelledby="react-tabs-2356"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2359" aria-labelledby="react-tabs-2358"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2361" aria-labelledby="react-tabs-2360"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2363" aria-labelledby="react-tabs-2362"></div></div></div></div></div></div><div id="tag/SAML/paths/~1saml~1certificate~1private/post" data-section-id="tag/SAML/paths/~1saml~1certificate~1private/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/SAML/paths/~1saml~1certificate~1private/post"></a>Upload private key<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Upload the private key to be used for encryption with your SAML configuration. The server will pick a hard-coded filename for the PrivateKeyFile setting in your <code>config.json</code>.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">multipart/form-data</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="certificate"><span class="sc-kGXeez bcLONg"></span>certificate<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span><span class="sc-cHGsZl sc-kgAjT hqYVjx"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The private key file</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>SAML certificate upload successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/saml/certificate/private</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/saml/certificate/private</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/saml/certificate/private</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2364" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2365" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2366" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2367">400</li><li class="tab-error" role="tab" id="react-tabs-2368" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2369">401</li><li class="tab-error" role="tab" id="react-tabs-2370" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2371">403</li><li class="tab-error" role="tab" id="react-tabs-2372" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2373">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2365" aria-labelledby="react-tabs-2364"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2367" aria-labelledby="react-tabs-2366"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2369" aria-labelledby="react-tabs-2368"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2371" aria-labelledby="react-tabs-2370"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2373" aria-labelledby="react-tabs-2372"></div></div></div></div></div></div><div id="tag/SAML/paths/~1saml~1certificate~1private/delete" data-section-id="tag/SAML/paths/~1saml~1certificate~1private/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/SAML/paths/~1saml~1certificate~1private/delete"></a>Remove private key<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Delete the current private key being used with your SAML configuration. This will also disable encryption for SAML on your system as this key is required for that.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>SAML certificate delete successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/saml/certificate/private</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/saml/certificate/private</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/saml/certificate/private</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2374" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2375" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2376" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2377">401</li><li class="tab-error" role="tab" id="react-tabs-2378" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2379">403</li><li class="tab-error" role="tab" id="react-tabs-2380" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2381">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2375" aria-labelledby="react-tabs-2374"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2377" aria-labelledby="react-tabs-2376"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2379" aria-labelledby="react-tabs-2378"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2381" aria-labelledby="react-tabs-2380"></div></div></div></div></div></div><div id="tag/SAML/paths/~1saml~1certificate~1status/get" data-section-id="tag/SAML/paths/~1saml~1certificate~1status/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/SAML/paths/~1saml~1certificate~1status/get"></a>Get certificate status<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get the status of the uploaded certificates and keys in use by your SAML configuration.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>SAML certificate status retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/saml/certificate/status</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/saml/certificate/status</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/saml/certificate/status</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2382" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2383" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2384" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2385">403</li><li class="tab-error" role="tab" id="react-tabs-2386" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2387">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2383" aria-labelledby="react-tabs-2382"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"idp_certificate_file"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"public_certificate_file"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private_key_file"</span>: <span class="token boolean">true</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-2385" aria-labelledby="react-tabs-2384"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2387" aria-labelledby="react-tabs-2386"></div></div></div></div></div></div><div id="tag/LDAP" data-section-id="tag/LDAP" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/LDAP"></a>LDAP</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for configuring and interacting with LDAP.</p>
|
||
</div></div></div><div id="tag/LDAP/paths/~1ldap~1sync/post" data-section-id="tag/LDAP/paths/~1ldap~1sync/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/LDAP/paths/~1ldap~1sync/post"></a>Sync with LDAP<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Synchronize any user attribute changes in the configured AD/LDAP server with Mattermost.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>LDAP sync successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/ldap/sync</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/ldap/sync</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/ldap/sync</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2388" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2389" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2390" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2391">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2389" aria-labelledby="react-tabs-2388"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2391" aria-labelledby="react-tabs-2390"></div></div></div></div></div></div><div id="tag/LDAP/paths/~1ldap~1test/post" data-section-id="tag/LDAP/paths/~1ldap~1test/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/LDAP/paths/~1ldap~1test/post"></a>Test LDAP configuration<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Test the current AD/LDAP configuration to see if the AD/LDAP server can be contacted successfully.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>LDAP test successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/ldap/test</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/ldap/test</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/ldap/test</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2392" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2393" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2394" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2395">500</li><li class="tab-error" role="tab" id="react-tabs-2396" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2397">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2393" aria-labelledby="react-tabs-2392"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2395" aria-labelledby="react-tabs-2394"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2397" aria-labelledby="react-tabs-2396"></div></div></div></div></div></div><div id="tag/groups" data-section-id="tag/groups" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/groups"></a>groups</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints related to LDAP groups.</p>
|
||
</div></div></div><div id="tag/groups/paths/~1groups/get" data-section-id="tag/groups/paths/~1groups/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/groups/paths/~1groups/get"></a>Get groups<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Retrieve a list of all groups not associated to a particular channel or team. </p>
|
||
<p><code>not_associated_to_team</code> <strong>OR</strong> <code>not_associated_to_channel</code> is required. </p>
|
||
<p>If you use <code>not_associated_to_team</code>, you must be a team admin for that particular team (permission to manage that team). </p>
|
||
<p>If you use <code>not_associated_to_channel</code>, you must be a channel admin for that particular channel (permission to manage that channel). </p>
|
||
<p><strong>Minimum server version</strong>: 5.11</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of groups per page.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="q"><span class="sc-kGXeez bcLONg"></span>q</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>String to pattern match the <code>name</code> and <code>display_name</code> field. Will return all groups whose <code>name</code> and <code>display_name</code> field match any of the text.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="include_member_count"><span class="sc-kGXeez bcLONg"></span>include_member_count</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Boolean which adds the <code>member_count</code> attribute to each group JSON object</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="not_associated_to_team"><span class="sc-kGXeez bcLONg"></span>not_associated_to_team<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID which is used to return all the groups not associated to this team</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="not_associated_to_channel"><span class="sc-kGXeez bcLONg"></span>not_associated_to_channel<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Group GUID which is used to return all the groups not associated to this channel</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Group list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/groups</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/groups</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/groups</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2398" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2399" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2400" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2401">400</li><li class="tab-error" role="tab" id="react-tabs-2402" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2403">401</li><li class="tab-error" role="tab" id="react-tabs-2404" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2405">403</li><li class="tab-error" role="tab" id="react-tabs-2406" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2407">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2399" aria-labelledby="react-tabs-2398"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"remote_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_syncables"</span>: <span class="token boolean">true</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-2401" aria-labelledby="react-tabs-2400"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2403" aria-labelledby="react-tabs-2402"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2405" aria-labelledby="react-tabs-2404"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2407" aria-labelledby="react-tabs-2406"></div></div></div></div></div></div><div id="tag/groups/paths/~1groups~1{group_id}/get" data-section-id="tag/groups/paths/~1groups~1{group_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/groups/paths/~1groups~1{group_id}/get"></a>Get a group<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get group from the provided group id string</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.11</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_id"><span class="sc-kGXeez bcLONg"></span>group_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Group GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Group retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/groups/{group_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/groups/{group_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/groups/{group_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2408" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2409" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2410" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2411">400</li><li class="tab-error" role="tab" id="react-tabs-2412" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2413">401</li><li class="tab-error" role="tab" id="react-tabs-2414" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2415">403</li><li class="tab-error" role="tab" id="react-tabs-2416" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2417">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2409" aria-labelledby="react-tabs-2408"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"source"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remote_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_syncables"</span>: <span class="token boolean">true</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-2411" aria-labelledby="react-tabs-2410"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2413" aria-labelledby="react-tabs-2412"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2415" aria-labelledby="react-tabs-2414"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2417" aria-labelledby="react-tabs-2416"></div></div></div></div></div></div><div id="tag/groups/paths/~1groups~1{group_id}~1patch/put" data-section-id="tag/groups/paths/~1groups~1{group_id}~1patch/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/groups/paths/~1groups~1{group_id}~1patch/put"></a>Patch a group<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Partially update a group by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.11</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_id"><span class="sc-kGXeez bcLONg"></span>group_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Group GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Group object that is to be updated</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="display_name"><span class="sc-kGXeez bcLONg"></span>display_name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="description"><span class="sc-kGXeez bcLONg"></span>description</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Group patch successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/groups/{group_id}/patch</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/groups/{group_id}/patch</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/groups/{group_id}/patch</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2418" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2419" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2419" aria-labelledby="react-tabs-2418"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2420" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2421" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2422" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2423">400</li><li class="tab-error" role="tab" id="react-tabs-2424" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2425">401</li><li class="tab-error" role="tab" id="react-tabs-2426" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2427">403</li><li class="tab-error" role="tab" id="react-tabs-2428" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2429">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2421" aria-labelledby="react-tabs-2420"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"source"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remote_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_syncables"</span>: <span class="token boolean">true</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-2423" aria-labelledby="react-tabs-2422"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2425" aria-labelledby="react-tabs-2424"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2427" aria-labelledby="react-tabs-2426"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2429" aria-labelledby="react-tabs-2428"></div></div></div></div></div></div><div id="tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}~1link/post" data-section-id="tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}~1link/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}~1link/post"></a>Link a team to a group<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Link a team to a group</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_team</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.11</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_id"><span class="sc-kGXeez bcLONg"></span>group_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Group GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team successfully linked to group</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/groups/{group_id}/teams/{team_id}/link</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/groups/{group_id}/teams/{team_id}/link</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/groups/{group_id}/teams/{team_id}/link</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2430" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2431" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-2432" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2433">400</li><li class="tab-error" role="tab" id="react-tabs-2434" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2435">401</li><li class="tab-error" role="tab" id="react-tabs-2436" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2437">403</li><li class="tab-error" role="tab" id="react-tabs-2438" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2439">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2431" aria-labelledby="react-tabs-2430"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_add"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</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-2433" aria-labelledby="react-tabs-2432"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2435" aria-labelledby="react-tabs-2434"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2437" aria-labelledby="react-tabs-2436"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2439" aria-labelledby="react-tabs-2438"></div></div></div></div></div></div><div id="tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}~1link/delete" data-section-id="tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}~1link/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}~1link/delete"></a>Delete a link from a team to a group<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Delete a link from a team to a group</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_team</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.11</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_id"><span class="sc-kGXeez bcLONg"></span>group_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Group GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Successfully deleted link between team and group</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/groups/{group_id}/teams/{team_id}/link</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/groups/{group_id}/teams/{team_id}/link</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/groups/{group_id}/teams/{team_id}/link</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2440" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2441" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2442" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2443">400</li><li class="tab-error" role="tab" id="react-tabs-2444" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2445">401</li><li class="tab-error" role="tab" id="react-tabs-2446" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2447">403</li><li class="tab-error" role="tab" id="react-tabs-2448" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2449">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2441" aria-labelledby="react-tabs-2440"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2443" aria-labelledby="react-tabs-2442"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2445" aria-labelledby="react-tabs-2444"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2447" aria-labelledby="react-tabs-2446"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2449" aria-labelledby="react-tabs-2448"></div></div></div></div></div></div><div id="tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}~1link/post" data-section-id="tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}~1link/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}~1link/post"></a>Link a channel to a group<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Link a channel to a group</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>If the channel is private, you must have <code>manage_private_channel_members</code> permission.
|
||
Otherwise, you must have the <code>manage_public_channel_members</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.11</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_id"><span class="sc-kGXeez bcLONg"></span>group_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Group GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel successfully linked to group</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/groups/{group_id}/channels/{channel_id}/link</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/groups/{group_id}/channels/{channel_id}/link</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/groups/{group_id}/channels/{channel_id}/link</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2450" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2451" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-2452" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2453">400</li><li class="tab-error" role="tab" id="react-tabs-2454" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2455">401</li><li class="tab-error" role="tab" id="react-tabs-2456" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2457">403</li><li class="tab-error" role="tab" id="react-tabs-2458" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2459">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2451" aria-labelledby="react-tabs-2450"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_add"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</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-2453" aria-labelledby="react-tabs-2452"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2455" aria-labelledby="react-tabs-2454"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2457" aria-labelledby="react-tabs-2456"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2459" aria-labelledby="react-tabs-2458"></div></div></div></div></div></div><div id="tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}~1link/delete" data-section-id="tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}~1link/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}~1link/delete"></a>Delete a link from a channel to a group<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Delete a link from a channel to a group</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>If the channel is private, you must have <code>manage_private_channel_members</code> permission.
|
||
Otherwise, you must have the <code>manage_public_channel_members</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.11</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_id"><span class="sc-kGXeez bcLONg"></span>group_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Group GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Successfully deleted link between channel and group</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/groups/{group_id}/channels/{channel_id}/link</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/groups/{group_id}/channels/{channel_id}/link</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/groups/{group_id}/channels/{channel_id}/link</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2460" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2461" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2462" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2463">400</li><li class="tab-error" role="tab" id="react-tabs-2464" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2465">401</li><li class="tab-error" role="tab" id="react-tabs-2466" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2467">403</li><li class="tab-error" role="tab" id="react-tabs-2468" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2469">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2461" aria-labelledby="react-tabs-2460"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2463" aria-labelledby="react-tabs-2462"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2465" aria-labelledby="react-tabs-2464"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2467" aria-labelledby="react-tabs-2466"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2469" aria-labelledby="react-tabs-2468"></div></div></div></div></div></div><div id="tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}/get" data-section-id="tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}/get"></a>Get GroupSyncable from Team ID<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get the GroupSyncable object with group_id and team_id from params</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.11</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_id"><span class="sc-kGXeez bcLONg"></span>group_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Group GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>GroupSyncable object retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/groups/{group_id}/teams/{team_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/groups/{group_id}/teams/{team_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/groups/{group_id}/teams/{team_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2470" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2471" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2472" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2473">400</li><li class="tab-error" role="tab" id="react-tabs-2474" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2475">401</li><li class="tab-error" role="tab" id="react-tabs-2476" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2477">403</li><li class="tab-error" role="tab" id="react-tabs-2478" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2479">500</li><li class="tab-error" role="tab" id="react-tabs-2480" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2481">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2471" aria-labelledby="react-tabs-2470"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_add"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</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-2473" aria-labelledby="react-tabs-2472"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2475" aria-labelledby="react-tabs-2474"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2477" aria-labelledby="react-tabs-2476"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2479" aria-labelledby="react-tabs-2478"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2481" aria-labelledby="react-tabs-2480"></div></div></div></div></div></div><div id="tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}/get" data-section-id="tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}/get"></a>Get GroupSyncable from channel ID<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get the GroupSyncable object with group_id and channel_id from params</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.11</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_id"><span class="sc-kGXeez bcLONg"></span>group_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Group GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>GroupSyncable object retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/groups/{group_id}/channels/{channel_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/groups/{group_id}/channels/{channel_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/groups/{group_id}/channels/{channel_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2482" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2483" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2484" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2485">400</li><li class="tab-error" role="tab" id="react-tabs-2486" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2487">401</li><li class="tab-error" role="tab" id="react-tabs-2488" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2489">403</li><li class="tab-error" role="tab" id="react-tabs-2490" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2491">500</li><li class="tab-error" role="tab" id="react-tabs-2492" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2493">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2483" aria-labelledby="react-tabs-2482"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_add"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</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-2485" aria-labelledby="react-tabs-2484"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2487" aria-labelledby="react-tabs-2486"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2489" aria-labelledby="react-tabs-2488"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2491" aria-labelledby="react-tabs-2490"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2493" aria-labelledby="react-tabs-2492"></div></div></div></div></div></div><div id="tag/groups/paths/~1groups~1{group_id}~1teams/get" data-section-id="tag/groups/paths/~1groups~1{group_id}~1teams/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/groups/paths/~1groups~1{group_id}~1teams/get"></a>Get group teams<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Retrieve the list of teams associated to the group</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.11</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_id"><span class="sc-kGXeez bcLONg"></span>group_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Group GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Teams list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/groups/{group_id}/teams</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/groups/{group_id}/teams</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/groups/{group_id}/teams</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2494" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2495" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2496" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2497">400</li><li class="tab-error" role="tab" id="react-tabs-2498" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2499">401</li><li class="tab-error" role="tab" id="react-tabs-2500" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2501">403</li><li class="tab-error" role="tab" id="react-tabs-2502" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2503">500</li><li class="tab-error" role="tab" id="react-tabs-2504" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2505">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2495" aria-labelledby="react-tabs-2494"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"team_display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"team_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"group_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"auto_add"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</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-2497" aria-labelledby="react-tabs-2496"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2499" aria-labelledby="react-tabs-2498"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2501" aria-labelledby="react-tabs-2500"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2503" aria-labelledby="react-tabs-2502"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2505" aria-labelledby="react-tabs-2504"></div></div></div></div></div></div><div id="tag/groups/paths/~1groups~1{group_id}~1channels/get" data-section-id="tag/groups/paths/~1groups~1{group_id}~1channels/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/groups/paths/~1groups~1{group_id}~1channels/get"></a>Get group channels<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Retrieve the list of channels associated to the group</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.11</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_id"><span class="sc-kGXeez bcLONg"></span>group_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Group GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/groups/{group_id}/channels</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/groups/{group_id}/channels</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/groups/{group_id}/channels</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2506" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2507" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2508" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2509">400</li><li class="tab-error" role="tab" id="react-tabs-2510" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2511">401</li><li class="tab-error" role="tab" id="react-tabs-2512" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2513">403</li><li class="tab-error" role="tab" id="react-tabs-2514" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2515">500</li><li class="tab-error" role="tab" id="react-tabs-2516" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2517">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2507" aria-labelledby="react-tabs-2506"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel_display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"team_display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"team_type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"group_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"auto_add"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</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-2509" aria-labelledby="react-tabs-2508"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2511" aria-labelledby="react-tabs-2510"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2513" aria-labelledby="react-tabs-2512"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2515" aria-labelledby="react-tabs-2514"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2517" aria-labelledby="react-tabs-2516"></div></div></div></div></div></div><div id="tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}~1patch/put" data-section-id="tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}~1patch/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}~1patch/put"></a>Patch a GroupSyncable associated to Team<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Partially update a GroupSyncable by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.11</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_id"><span class="sc-kGXeez bcLONg"></span>group_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Group GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>GroupSyncable object that is to be updated</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="auto_add"><span class="sc-kGXeez bcLONg"></span>auto_add</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>GroupSyncable patch successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/groups/{group_id}/teams/{team_id}/patch</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/groups/{group_id}/teams/{team_id}/patch</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/groups/{group_id}/teams/{team_id}/patch</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2518" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2519" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2519" aria-labelledby="react-tabs-2518"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"auto_add"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2520" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2521" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2522" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2523">400</li><li class="tab-error" role="tab" id="react-tabs-2524" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2525">401</li><li class="tab-error" role="tab" id="react-tabs-2526" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2527">403</li><li class="tab-error" role="tab" id="react-tabs-2528" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2529">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2521" aria-labelledby="react-tabs-2520"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_add"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</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-2523" aria-labelledby="react-tabs-2522"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2525" aria-labelledby="react-tabs-2524"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2527" aria-labelledby="react-tabs-2526"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2529" aria-labelledby="react-tabs-2528"></div></div></div></div></div></div><div id="tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}~1patch/put" data-section-id="tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}~1patch/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}~1patch/put"></a>Patch a GroupSyncable associated to Channel<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Partially update a GroupSyncable by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.11</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_id"><span class="sc-kGXeez bcLONg"></span>group_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Group GUID</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>GroupSyncable object that is to be updated</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="auto_add"><span class="sc-kGXeez bcLONg"></span>auto_add</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>GroupSyncable patch successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/groups/{group_id}/channels/{channel_id}/patch</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/groups/{group_id}/channels/{channel_id}/patch</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/groups/{group_id}/channels/{channel_id}/patch</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2530" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2531" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2531" aria-labelledby="react-tabs-2530"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"auto_add"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2532" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2533" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2534" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2535">400</li><li class="tab-error" role="tab" id="react-tabs-2536" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2537">401</li><li class="tab-error" role="tab" id="react-tabs-2538" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2539">403</li><li class="tab-error" role="tab" id="react-tabs-2540" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2541">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2533" aria-labelledby="react-tabs-2532"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_add"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</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-2535" aria-labelledby="react-tabs-2534"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2537" aria-labelledby="react-tabs-2536"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2539" aria-labelledby="react-tabs-2538"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2541" aria-labelledby="react-tabs-2540"></div></div></div></div></div></div><div id="tag/groups/paths/~1groups~1{group_id}~1members/get" data-section-id="tag/groups/paths/~1groups~1{group_id}~1members/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/groups/paths/~1groups~1{group_id}~1members/get"></a>Get group users<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Retrieve the list of users associated with a given group.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.11</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="group_id"><span class="sc-kGXeez bcLONg"></span>group_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Group GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of groups per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/groups/{group_id}/members</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/groups/{group_id}/members</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/groups/{group_id}/members</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2542" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2543" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2544" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2545">400</li><li class="tab-error" role="tab" id="react-tabs-2546" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2547">401</li><li class="tab-error" role="tab" id="react-tabs-2548" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2549">403</li><li class="tab-error" role="tab" id="react-tabs-2550" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2551">500</li><li class="tab-error" role="tab" id="react-tabs-2552" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2553">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2543" aria-labelledby="react-tabs-2542"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"members"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"username"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"nickname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email_verified"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"auth_service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roles"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"notify_props"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"push"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desktop_sound"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mention_keys"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_name"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"props"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_password_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_picture_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failed_attempts"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mfa_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"timezone"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"useAutomaticTimezone"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"manualTimezone"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"automaticTimezone"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"terms_of_service_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"terms_of_service_create_at"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</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">"total_member_count"</span>: <span class="token number">0</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-2545" aria-labelledby="react-tabs-2544"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2547" aria-labelledby="react-tabs-2546"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2549" aria-labelledby="react-tabs-2548"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2551" aria-labelledby="react-tabs-2550"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2553" aria-labelledby="react-tabs-2552"></div></div></div></div></div></div><div id="tag/groups/paths/~1channels~1{channel_id}~1groups/get" data-section-id="tag/groups/paths/~1channels~1{channel_id}~1groups/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/groups/paths/~1channels~1{channel_id}~1groups/get"></a>Get channel groups<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Retrieve the list of groups associated with a given channel.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.11</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of groups per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Group list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/channels/{channel_id}/groups</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/groups</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/channels/{channel_id}/groups</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2554" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2555" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2556" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2557">400</li><li class="tab-error" role="tab" id="react-tabs-2558" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2559">401</li><li class="tab-error" role="tab" id="react-tabs-2560" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2561">403</li><li class="tab-error" role="tab" id="react-tabs-2562" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2563">500</li><li class="tab-error" role="tab" id="react-tabs-2564" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2565">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2555" aria-labelledby="react-tabs-2554"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"remote_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_syncables"</span>: <span class="token boolean">true</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-2557" aria-labelledby="react-tabs-2556"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2559" aria-labelledby="react-tabs-2558"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2561" aria-labelledby="react-tabs-2560"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2563" aria-labelledby="react-tabs-2562"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2565" aria-labelledby="react-tabs-2564"></div></div></div></div></div></div><div id="tag/groups/paths/~1teams~1{team_id}~1groups/get" data-section-id="tag/groups/paths/~1teams~1{team_id}~1groups/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/groups/paths/~1teams~1{team_id}~1groups/get"></a>Get team groups<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Retrieve the list of groups associated with a given team.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.11</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of groups per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Group list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/teams/{team_id}/groups</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/teams/{team_id}/groups</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/teams/{team_id}/groups</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2566" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2567" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2568" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2569">400</li><li class="tab-error" role="tab" id="react-tabs-2570" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2571">401</li><li class="tab-error" role="tab" id="react-tabs-2572" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2573">403</li><li class="tab-error" role="tab" id="react-tabs-2574" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2575">500</li><li class="tab-error" role="tab" id="react-tabs-2576" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2577">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2567" aria-labelledby="react-tabs-2566"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"remote_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_syncables"</span>: <span class="token boolean">true</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-2569" aria-labelledby="react-tabs-2568"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2571" aria-labelledby="react-tabs-2570"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2573" aria-labelledby="react-tabs-2572"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2575" aria-labelledby="react-tabs-2574"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2577" aria-labelledby="react-tabs-2576"></div></div></div></div></div></div><div id="tag/compliance" data-section-id="tag/compliance" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/compliance"></a>compliance</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for creating, getting and downloading compliance reports.</p>
|
||
</div></div></div><div id="tag/compliance/paths/~1compliance~1reports/post" data-section-id="tag/compliance/paths/~1compliance~1reports/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/compliance/paths/~1compliance~1reports/post"></a>Create report<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Create and save a compliance report.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Compliance report creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/compliance/reports</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/compliance/reports</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/compliance/reports</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2578" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2579" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-2580" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2581">400</li><li class="tab-error" role="tab" id="react-tabs-2582" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2583">401</li><li class="tab-error" role="tab" id="react-tabs-2584" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2585">403</li><li class="tab-error" role="tab" id="react-tabs-2586" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2587">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2579" aria-labelledby="react-tabs-2578"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"desc"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"end_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"keywords"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"emails"</span>: <span class="token string">"string"</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-2581" aria-labelledby="react-tabs-2580"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2583" aria-labelledby="react-tabs-2582"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2585" aria-labelledby="react-tabs-2584"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2587" aria-labelledby="react-tabs-2586"></div></div></div></div></div></div><div id="tag/compliance/paths/~1compliance~1reports/get" data-section-id="tag/compliance/paths/~1compliance~1reports/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/compliance/paths/~1compliance~1reports/get"></a>Get reports<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of compliance reports previously created by page, selected with <code>page</code> and <code>per_page</code> query parameters.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of reports per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Compliance reports retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/compliance/reports</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/compliance/reports</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/compliance/reports</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2588" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2589" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2590" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2591">400</li><li class="tab-error" role="tab" id="react-tabs-2592" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2593">401</li><li class="tab-error" role="tab" id="react-tabs-2594" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2595">403</li><li class="tab-error" role="tab" id="react-tabs-2596" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2597">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2589" aria-labelledby="react-tabs-2588"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"desc"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"end_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"keywords"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"emails"</span>: <span class="token string">"string"</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-2591" aria-labelledby="react-tabs-2590"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2593" aria-labelledby="react-tabs-2592"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2595" aria-labelledby="react-tabs-2594"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2597" aria-labelledby="react-tabs-2596"></div></div></div></div></div></div><div id="tag/compliance/paths/~1compliance~1reports~1{report_id}/get" data-section-id="tag/compliance/paths/~1compliance~1reports~1{report_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/compliance/paths/~1compliance~1reports~1{report_id}/get"></a>Get a report<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a compliance reports previously created.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="report_id"><span class="sc-kGXeez bcLONg"></span>report_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Compliance report GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Compliance report retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/compliance/reports/{report_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/compliance/reports/{report_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/compliance/reports/{report_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2598" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2599" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2600" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2601">400</li><li class="tab-error" role="tab" id="react-tabs-2602" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2603">401</li><li class="tab-error" role="tab" id="react-tabs-2604" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2605">403</li><li class="tab-error" role="tab" id="react-tabs-2606" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2607">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2599" aria-labelledby="react-tabs-2598"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"desc"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"end_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"keywords"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"emails"</span>: <span class="token string">"string"</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-2601" aria-labelledby="react-tabs-2600"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2603" aria-labelledby="react-tabs-2602"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2605" aria-labelledby="react-tabs-2604"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2607" aria-labelledby="react-tabs-2606"></div></div></div></div></div></div><div id="tag/compliance/paths/~1compliance~1reports~1{report_id}~1download/get" data-section-id="tag/compliance/paths/~1compliance~1reports~1{report_id}~1download/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/compliance/paths/~1compliance~1reports~1{report_id}~1download/get"></a>Download a report<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Download the full contents of a report as a file.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="report_id"><span class="sc-kGXeez bcLONg"></span>report_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Compliance report GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT hLVzSF"><strong>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>The compliance report file</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/compliance/reports/{report_id}/download</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/compliance/reports/{report_id}/download</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/compliance/reports/{report_id}/download</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-2608" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2609" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-2610" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2611">401</li><li class="tab-error" role="tab" id="react-tabs-2612" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2613">403</li><li class="tab-error" role="tab" id="react-tabs-2614" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2615">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2609" aria-labelledby="react-tabs-2608"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-2611" aria-labelledby="react-tabs-2610"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2613" aria-labelledby="react-tabs-2612"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2615" aria-labelledby="react-tabs-2614"></div></div></div></div></div></div><div id="tag/cluster" data-section-id="tag/cluster" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/cluster"></a>cluster</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for configuring and interacting with high availability clusters.</p>
|
||
</div></div></div><div id="tag/cluster/paths/~1cluster~1status/get" data-section-id="tag/cluster/paths/~1cluster~1status/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/cluster/paths/~1cluster~1status/get"></a>Get cluster status<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a set of information for each node in the cluster, useful for checking the status and health of each node.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Cluster status retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/cluster/status</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/cluster/status</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/cluster/status</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2616" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2617" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2618" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2619">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2617" aria-labelledby="react-tabs-2616"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"config_hash"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"internode_url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"hostname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_ping"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"is_alive"</span>: <span class="token boolean">true</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-2619" aria-labelledby="react-tabs-2618"></div></div></div></div></div></div><div id="tag/elasticsearch" data-section-id="tag/elasticsearch" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/elasticsearch"></a>elasticsearch</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for configuring and interacting with Elasticsearch.</p>
|
||
</div></div></div><div id="tag/elasticsearch/paths/~1elasticsearch~1test/post" data-section-id="tag/elasticsearch/paths/~1elasticsearch~1test/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/elasticsearch/paths/~1elasticsearch~1test/post"></a>Test Elasticsearch configuration<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Test the current Elasticsearch configuration to see if the Elasticsearch server can be contacted successfully.
|
||
Optionally provide a configuration in the request body to test. If no valid configuration is present in the
|
||
request body the current server configuration will be tested.</p>
|
||
<p><strong>Minimum server version</strong>: 4.1</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Elasticsearch test successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/elasticsearch/test</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/elasticsearch/test</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/elasticsearch/test</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2620" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2621" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2622" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2623">400</li><li class="tab-error" role="tab" id="react-tabs-2624" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2625">500</li><li class="tab-error" role="tab" id="react-tabs-2626" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2627">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2621" aria-labelledby="react-tabs-2620"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2623" aria-labelledby="react-tabs-2622"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2625" aria-labelledby="react-tabs-2624"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2627" aria-labelledby="react-tabs-2626"></div></div></div></div></div></div><div id="tag/elasticsearch/paths/~1elasticsearch~1purge_indexes/post" data-section-id="tag/elasticsearch/paths/~1elasticsearch~1purge_indexes/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/elasticsearch/paths/~1elasticsearch~1purge_indexes/post"></a>Purge all Elasticsearch indexes<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Deletes all Elasticsearch indexes and their contents. After calling this endpoint, it is
|
||
necessary to schedule a new Elasticsearch indexing job to repopulate the indexes.
|
||
<strong>Minimum server version</strong>: 4.1</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Indexes purged successfully.</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/elasticsearch/purge_indexes</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/elasticsearch/purge_indexes</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/elasticsearch/purge_indexes</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2628" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2629" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2630" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2631">500</li><li class="tab-error" role="tab" id="react-tabs-2632" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2633">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2629" aria-labelledby="react-tabs-2628"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2631" aria-labelledby="react-tabs-2630"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2633" aria-labelledby="react-tabs-2632"></div></div></div></div></div></div><div id="tag/dataretention" data-section-id="tag/dataretention" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/dataretention"></a>dataretention</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoint for getting data retention policy settings.</p>
|
||
</div></div></div><div id="tag/dataretention/paths/~1data_retention~1policy/get" data-section-id="tag/dataretention/paths/~1data_retention~1policy/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/dataretention/paths/~1data_retention~1policy/get"></a>Get the data retention policy details.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Gets the current data retention policy details from the server, including what data should be purged and the cutoff times for each data type that should be purged.
|
||
<strong>Minimum server version</strong>: 4.3</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Requires an active session but no other permissions.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Data retention policy details retrieved successfully.</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>500<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Something went wrong with the server</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/data_retention/policy</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/data_retention/policy</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/data_retention/policy</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2634" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2635" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2636" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2637">500</li><li class="tab-error" role="tab" id="react-tabs-2638" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2639">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2635" aria-labelledby="react-tabs-2634"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message_deletion_enabled"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file_deletion_enabled"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message_retention_cutoff"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file_retention_cutoff"</span>: <span class="token number">0</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-2637" aria-labelledby="react-tabs-2636"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2639" aria-labelledby="react-tabs-2638"></div></div></div></div></div></div><div id="tag/jobs" data-section-id="tag/jobs" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/jobs"></a>jobs</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints related to various background jobs that can be run by the server or separately by job servers.</p>
|
||
</div></div></div><div id="tag/jobs/paths/~1jobs/get" data-section-id="tag/jobs/paths/~1jobs/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/jobs/paths/~1jobs/get"></a>Get the jobs.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of jobs. Use the query parameters to modify the behaviour of this endpoint.
|
||
<strong>Minimum server version: 4.1</strong></p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_jobs</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of jobs per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Job list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/jobs</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/jobs</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/jobs</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2640" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2641" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2642" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2643">400</li><li class="tab-error" role="tab" id="react-tabs-2644" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2645">401</li><li class="tab-error" role="tab" id="react-tabs-2646" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2647">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2641" aria-labelledby="react-tabs-2640"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_activity_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</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-2643" aria-labelledby="react-tabs-2642"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2645" aria-labelledby="react-tabs-2644"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2647" aria-labelledby="react-tabs-2646"></div></div></div></div></div></div><div id="tag/jobs/paths/~1jobs/post" data-section-id="tag/jobs/paths/~1jobs/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/jobs/paths/~1jobs/post"></a>Create a new job.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Create a new job.
|
||
<strong>Minimum server version: 4.1</strong></p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_jobs</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Job object to be created</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="type"><span class="sc-kGXeez bcLONg"></span>type<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The type of job to create</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="data"><span class="sc-kGXeez bcLONg"></span>data</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>An object containing any additional data required for this job type</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Job creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/jobs</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/jobs</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/jobs</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2648" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2649" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2649" aria-labelledby="react-tabs-2648"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</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-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2650" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2651" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-2652" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2653">400</li><li class="tab-error" role="tab" id="react-tabs-2654" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2655">401</li><li class="tab-error" role="tab" id="react-tabs-2656" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2657">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2651" aria-labelledby="react-tabs-2650"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_activity_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <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-2653" aria-labelledby="react-tabs-2652"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2655" aria-labelledby="react-tabs-2654"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2657" aria-labelledby="react-tabs-2656"></div></div></div></div></div></div><div id="tag/jobs/paths/~1jobs~1{job_id}/get" data-section-id="tag/jobs/paths/~1jobs~1{job_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/jobs/paths/~1jobs~1{job_id}/get"></a>Get a job.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Gets a single job.
|
||
<strong>Minimum server version: 4.1</strong></p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_jobs</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="job_id"><span class="sc-kGXeez bcLONg"></span>job_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Job GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Job retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/jobs/{job_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/jobs/{job_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/jobs/{job_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2658" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2659" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2660" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2661">400</li><li class="tab-error" role="tab" id="react-tabs-2662" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2663">401</li><li class="tab-error" role="tab" id="react-tabs-2664" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2665">403</li><li class="tab-error" role="tab" id="react-tabs-2666" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2667">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2659" aria-labelledby="react-tabs-2658"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_activity_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <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-2661" aria-labelledby="react-tabs-2660"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2663" aria-labelledby="react-tabs-2662"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2665" aria-labelledby="react-tabs-2664"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2667" aria-labelledby="react-tabs-2666"></div></div></div></div></div></div><div id="tag/jobs/paths/~1jobs~1{job_id}~1cancel/post" data-section-id="tag/jobs/paths/~1jobs~1{job_id}~1cancel/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/jobs/paths/~1jobs~1{job_id}~1cancel/post"></a>Cancel a job.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Cancel a job.
|
||
<strong>Minimum server version: 4.1</strong></p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_jobs</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="job_id"><span class="sc-kGXeez bcLONg"></span>job_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Job GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Job canceled successfully</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/jobs/{job_id}/cancel</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/jobs/{job_id}/cancel</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/jobs/{job_id}/cancel</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2668" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2669" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2670" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2671">400</li><li class="tab-error" role="tab" id="react-tabs-2672" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2673">401</li><li class="tab-error" role="tab" id="react-tabs-2674" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2675">403</li><li class="tab-error" role="tab" id="react-tabs-2676" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2677">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2669" aria-labelledby="react-tabs-2668"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2671" aria-labelledby="react-tabs-2670"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2673" aria-labelledby="react-tabs-2672"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2675" aria-labelledby="react-tabs-2674"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2677" aria-labelledby="react-tabs-2676"></div></div></div></div></div></div><div id="tag/jobs/paths/~1jobs~1type~1{type}/get" data-section-id="tag/jobs/paths/~1jobs~1type~1{type}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/jobs/paths/~1jobs~1type~1{type}/get"></a>Get the jobs of the given type.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of jobs of the given type. Use the query parameters to modify the behaviour of this endpoint.
|
||
<strong>Minimum server version: 4.1</strong></p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_jobs</code> permission.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="type"><span class="sc-kGXeez bcLONg"></span>type<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Job type</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of jobs per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Job list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/jobs/type/{type}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/jobs/type/{type}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/jobs/type/{type}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2678" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2679" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2680" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2681">400</li><li class="tab-error" role="tab" id="react-tabs-2682" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2683">401</li><li class="tab-error" role="tab" id="react-tabs-2684" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2685">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2679" aria-labelledby="react-tabs-2678"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_activity_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"progress"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token punctuation">{ }</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-2681" aria-labelledby="react-tabs-2680"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2683" aria-labelledby="react-tabs-2682"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2685" aria-labelledby="react-tabs-2684"></div></div></div></div></div></div><div id="tag/plugins" data-section-id="tag/plugins" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/plugins"></a>plugins</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints related to uploading and managing plugins.</p>
|
||
</div></div></div><div id="tag/plugins/paths/~1plugins/post" data-section-id="tag/plugins/paths/~1plugins/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/plugins/paths/~1plugins/post"></a>Upload plugin<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Upload a plugin that is contained within a compressed .tar.gz file. Plugins and plugin uploads must be enabled in the server's config settings.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 4.4</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">multipart/form-data</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"></div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="plugin"><span class="sc-kGXeez bcLONg"></span>plugin<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span><span class="sc-cHGsZl sc-kgAjT hqYVjx"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The plugin image to be uploaded</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="force"><span class="sc-kGXeez bcLONg"></span>force</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set to 'true' to overwrite a previously installed plugin with the same ID, if any</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Plugin upload successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>413<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Content too large</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/plugins</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/plugins</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/plugins</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2686" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2687" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2687" aria-labelledby="react-tabs-2686"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token punctuation">(</span>
|
||
<span class="token string">"bytes"</span>
|
||
<span class="token string">"io/ioutil"</span>
|
||
<span class="token string">"log"</span>
|
||
|
||
<span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
<span class="token punctuation">)</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
tarData<span class="token punctuation">,</span> err <span class="token operator">:=</span> ioutil<span class="token punctuation">.</span><span class="token function">ReadFile</span><span class="token punctuation">(</span><span class="token string">"plugin.tar.gz"</span><span class="token punctuation">)</span>
|
||
<span class="token keyword">if</span> err <span class="token operator">!=</span> <span class="token boolean">nil</span> <span class="token punctuation">{</span>
|
||
log<span class="token punctuation">.</span><span class="token function">Fatal</span><span class="token punctuation">(</span><span class="token string">"error while reading file"</span><span class="token punctuation">)</span>
|
||
<span class="token punctuation">}</span>
|
||
|
||
<span class="token comment">// Not forced</span>
|
||
manifest<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">UploadPlugin</span><span class="token punctuation">(</span>bytes<span class="token punctuation">.</span><span class="token function">NewReader</span><span class="token punctuation">(</span>tarData<span class="token punctuation">)</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// Forced</span>
|
||
manifest<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">UploadPluginForced</span><span class="token punctuation">(</span>bytes<span class="token punctuation">.</span><span class="token function">NewReader</span><span class="token punctuation">(</span>tarData<span class="token punctuation">)</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2688" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2689" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-2690" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2691">400</li><li class="tab-error" role="tab" id="react-tabs-2692" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2693">401</li><li class="tab-error" role="tab" id="react-tabs-2694" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2695">403</li><li class="tab-error" role="tab" id="react-tabs-2696" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2697">413</li><li class="tab-error" role="tab" id="react-tabs-2698" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2699">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2689" aria-labelledby="react-tabs-2688"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2691" aria-labelledby="react-tabs-2690"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2693" aria-labelledby="react-tabs-2692"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2695" aria-labelledby="react-tabs-2694"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2697" aria-labelledby="react-tabs-2696"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2699" aria-labelledby="react-tabs-2698"></div></div></div></div></div></div><div id="tag/plugins/paths/~1plugins/get" data-section-id="tag/plugins/paths/~1plugins/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/plugins/paths/~1plugins/get"></a>Get plugins<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of inactive and a list of active plugin manifests. Plugins must be enabled in the server's config settings.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 4.4</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Plugins retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/plugins</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/plugins</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/plugins</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2700" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2701" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2701" aria-labelledby="react-tabs-2700"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
pluginsResp<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetPlugins</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2702" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2703" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2704" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2705">400</li><li class="tab-error" role="tab" id="react-tabs-2706" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2707">401</li><li class="tab-error" role="tab" id="react-tabs-2708" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2709">403</li><li class="tab-error" role="tab" id="react-tabs-2710" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2711">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2703" aria-labelledby="react-tabs-2702"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"active"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"min_server_version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"backend"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"executable"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"server"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"executables"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"linux-amd64"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"darwin-amd64"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"windows-amd64"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"executable"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"webapp"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"bundle_path"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"settings_schema"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</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">"inactive"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"min_server_version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"backend"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"executable"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"server"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"executables"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"linux-amd64"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"darwin-amd64"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"windows-amd64"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"executable"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"webapp"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"bundle_path"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"settings_schema"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</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-2705" aria-labelledby="react-tabs-2704"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2707" aria-labelledby="react-tabs-2706"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2709" aria-labelledby="react-tabs-2708"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2711" aria-labelledby="react-tabs-2710"></div></div></div></div></div></div><div id="tag/plugins/paths/~1plugins~1install_from_url/post" data-section-id="tag/plugins/paths/~1plugins~1install_from_url/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/plugins/paths/~1plugins~1install_from_url/post"></a>Install plugin from url<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Supply a URL to a plugin compressed in a .tar.gz file. Plugins must be enabled in the server's config settings.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.14</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="plugin_download_url"><span class="sc-kGXeez bcLONg"></span>plugin_download_url<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>URL used to download the plugin</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="force"><span class="sc-kGXeez bcLONg"></span>force</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set to 'true' to overwrite a previously installed plugin with the same ID, if any</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Plugin install successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/plugins/install_from_url</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/plugins/install_from_url</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/plugins/install_from_url</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2712" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2713" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2713" aria-labelledby="react-tabs-2712"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token punctuation">(</span>
|
||
<span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
<span class="token punctuation">)</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
url <span class="token operator">:=</span> <span class="token string">"https://mysite.com/my-plugin.tar.gz"</span>
|
||
|
||
<span class="token comment">// Not forced</span>
|
||
manifest<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">InstallPluginFromUrl</span><span class="token punctuation">(</span>url<span class="token punctuation">,</span> <span class="token boolean">false</span><span class="token punctuation">)</span>
|
||
|
||
<span class="token comment">// Forced</span>
|
||
manifest<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">InstallPluginFromUrl</span><span class="token punctuation">(</span>url<span class="token punctuation">,</span> <span class="token boolean">true</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2714" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2715" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-2716" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2717">400</li><li class="tab-error" role="tab" id="react-tabs-2718" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2719">403</li><li class="tab-error" role="tab" id="react-tabs-2720" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2721">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2715" aria-labelledby="react-tabs-2714"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2717" aria-labelledby="react-tabs-2716"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2719" aria-labelledby="react-tabs-2718"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2721" aria-labelledby="react-tabs-2720"></div></div></div></div></div></div><div id="tag/plugins/paths/~1plugins~1{plugin_id}/delete" data-section-id="tag/plugins/paths/~1plugins~1{plugin_id}/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/plugins/paths/~1plugins~1{plugin_id}/delete"></a>Remove plugin<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Remove the plugin with the provided ID from the server. All plugin files are deleted. Plugins must be enabled in the server's config settings.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 4.4</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="plugin_id"><span class="sc-kGXeez bcLONg"></span>plugin_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Plugin removed successfully</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/plugins/{plugin_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/plugins/{plugin_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/plugins/{plugin_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2722" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2723" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2723" aria-labelledby="react-tabs-2722"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
pluginID <span class="token operator">:=</span> <span class="token string">"com.mattermost.demo-plugin"</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">RemovePlugin</span><span class="token punctuation">(</span>pluginID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2724" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2725" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2726" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2727">400</li><li class="tab-error" role="tab" id="react-tabs-2728" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2729">401</li><li class="tab-error" role="tab" id="react-tabs-2730" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2731">403</li><li class="tab-error" role="tab" id="react-tabs-2732" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2733">404</li><li class="tab-error" role="tab" id="react-tabs-2734" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2735">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2725" aria-labelledby="react-tabs-2724"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2727" aria-labelledby="react-tabs-2726"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2729" aria-labelledby="react-tabs-2728"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2731" aria-labelledby="react-tabs-2730"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2733" aria-labelledby="react-tabs-2732"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2735" aria-labelledby="react-tabs-2734"></div></div></div></div></div></div><div id="tag/plugins/paths/~1plugins~1{plugin_id}~1enable/post" data-section-id="tag/plugins/paths/~1plugins~1{plugin_id}~1enable/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/plugins/paths/~1plugins~1{plugin_id}~1enable/post"></a>Enable plugin<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Enable a previously uploaded plugin. Plugins must be enabled in the server's config settings.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 4.4</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="plugin_id"><span class="sc-kGXeez bcLONg"></span>plugin_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Plugin enabled successfully</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/plugins/{plugin_id}/enable</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/plugins/{plugin_id}/enable</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/plugins/{plugin_id}/enable</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2736" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2737" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2737" aria-labelledby="react-tabs-2736"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
pluginID <span class="token operator">:=</span> <span class="token string">"com.mattermost.demo-plugin"</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">EnablePlugin</span><span class="token punctuation">(</span>pluginID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2738" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2739" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2740" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2741">400</li><li class="tab-error" role="tab" id="react-tabs-2742" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2743">401</li><li class="tab-error" role="tab" id="react-tabs-2744" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2745">403</li><li class="tab-error" role="tab" id="react-tabs-2746" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2747">404</li><li class="tab-error" role="tab" id="react-tabs-2748" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2749">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2739" aria-labelledby="react-tabs-2738"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2741" aria-labelledby="react-tabs-2740"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2743" aria-labelledby="react-tabs-2742"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2745" aria-labelledby="react-tabs-2744"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2747" aria-labelledby="react-tabs-2746"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2749" aria-labelledby="react-tabs-2748"></div></div></div></div></div></div><div id="tag/plugins/paths/~1plugins~1{plugin_id}~1disable/post" data-section-id="tag/plugins/paths/~1plugins~1{plugin_id}~1disable/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/plugins/paths/~1plugins~1{plugin_id}~1disable/post"></a>Disable plugin<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Disable a previously enabled plugin. Plugins must be enabled in the server's config settings.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 4.4</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="plugin_id"><span class="sc-kGXeez bcLONg"></span>plugin_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Plugin disabled successfully</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/plugins/{plugin_id}/disable</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/plugins/{plugin_id}/disable</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/plugins/{plugin_id}/disable</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2750" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2751" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2751" aria-labelledby="react-tabs-2750"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
pluginID <span class="token operator">:=</span> <span class="token string">"com.mattermost.demo-plugin"</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">DisablePlugin</span><span class="token punctuation">(</span>pluginID<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2752" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2753" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2754" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2755">400</li><li class="tab-error" role="tab" id="react-tabs-2756" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2757">401</li><li class="tab-error" role="tab" id="react-tabs-2758" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2759">403</li><li class="tab-error" role="tab" id="react-tabs-2760" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2761">404</li><li class="tab-error" role="tab" id="react-tabs-2762" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2763">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2753" aria-labelledby="react-tabs-2752"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2755" aria-labelledby="react-tabs-2754"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2757" aria-labelledby="react-tabs-2756"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2759" aria-labelledby="react-tabs-2758"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2761" aria-labelledby="react-tabs-2760"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2763" aria-labelledby="react-tabs-2762"></div></div></div></div></div></div><div id="tag/plugins/paths/~1plugins~1webapp/get" data-section-id="tag/plugins/paths/~1plugins~1webapp/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/plugins/paths/~1plugins~1webapp/get"></a>Get webapp plugins<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of web app plugins installed and activated on the server.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>No permissions required.</p>
|
||
<p><strong>Minimum server version</strong>: 4.4</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Plugin deactivated successfully</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/plugins/webapp</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/plugins/webapp</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/plugins/webapp</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2764" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2765" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2765" aria-labelledby="react-tabs-2764"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
|
||
manifests<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetWebappPlugins</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2766" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2767" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2768" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2769">400</li><li class="tab-error" role="tab" id="react-tabs-2770" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2771">401</li><li class="tab-error" role="tab" id="react-tabs-2772" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2773">403</li><li class="tab-error" role="tab" id="react-tabs-2774" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2775">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2767" aria-labelledby="react-tabs-2766"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"webapp"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"bundle_path"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</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-2769" aria-labelledby="react-tabs-2768"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2771" aria-labelledby="react-tabs-2770"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2773" aria-labelledby="react-tabs-2772"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2775" aria-labelledby="react-tabs-2774"></div></div></div></div></div></div><div id="tag/plugins/paths/~1plugins~1marketplace/post" data-section-id="tag/plugins/paths/~1plugins~1marketplace/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/plugins/paths/~1plugins~1marketplace/post"></a>Installs a marketplace plugin<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Installs a plugin listed in the marketplace server.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.16</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>The metadata identifying the plugin to install.</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="id"><span class="sc-kGXeez bcLONg"></span>id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The ID of the plugin to install.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="version"><span class="sc-kGXeez bcLONg"></span>version<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The version of the plugin to install.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Plugin installed successfully</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/plugins/marketplace</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/plugins/marketplace</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/plugins/marketplace</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2776" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2777" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-2778" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2779">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2777" aria-labelledby="react-tabs-2776"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"string"</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-2779" aria-labelledby="react-tabs-2778"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-2780" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2781" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-2782" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2783">401</li><li class="tab-error" role="tab" id="react-tabs-2784" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2785">403</li><li class="tab-error" role="tab" id="react-tabs-2786" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2787">404</li><li class="tab-error" role="tab" id="react-tabs-2788" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2789">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2781" aria-labelledby="react-tabs-2780"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-2783" aria-labelledby="react-tabs-2782"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2785" aria-labelledby="react-tabs-2784"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2787" aria-labelledby="react-tabs-2786"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2789" aria-labelledby="react-tabs-2788"></div></div></div></div></div></div><div id="tag/plugins/paths/~1plugins~1marketplace/get" data-section-id="tag/plugins/paths/~1plugins~1marketplace/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/plugins/paths/~1plugins~1marketplace/get"></a>Gets all the marketplace plugins<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Gets all plugins from the marketplace server, merging data from locally installed plugins as well as prepackaged plugins shipped with the server.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.16</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Page number to be fetched. (not yet implemented)</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Number of item per page. (not yet implemented)</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="filter"><span class="sc-kGXeez bcLONg"></span>filter</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set to filter plugins by ID, name, or description.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="server_version"><span class="sc-kGXeez bcLONg"></span>server_version</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set to filter minimum plugin server version. (not yet implemented)</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="local_only"><span class="sc-kGXeez bcLONg"></span>local_only</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set true to only retrieve local plugins.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Plugins retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/plugins/marketplace</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/plugins/marketplace</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/plugins/marketplace</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2790" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2791" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2791" aria-labelledby="react-tabs-2790"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
filter <span class="token operator">:=</span> <span class="token operator">&</span>model<span class="token punctuation">.</span>MarketplacePluginFilter<span class="token punctuation">{</span>
|
||
Page<span class="token punctuation">:</span> <span class="token number">1</span><span class="token punctuation">,</span>
|
||
PerPage<span class="token punctuation">:</span> <span class="token number">10</span><span class="token punctuation">,</span>
|
||
Filter<span class="token punctuation">:</span> <span class="token string">"antivirus"</span><span class="token punctuation">,</span>
|
||
ServerVersion<span class="token punctuation">:</span> <span class="token string">"0.1.2"</span><span class="token punctuation">,</span>
|
||
LocalOnly<span class="token punctuation">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span>
|
||
<span class="token punctuation">}</span>
|
||
|
||
ok<span class="token punctuation">,</span> resp <span class="token operator">=</span> Client<span class="token punctuation">.</span><span class="token function">GetMarketplacePlugins</span><span class="token punctuation">(</span>filter<span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="react-tabs-2792" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2793" tabindex="0">400</li><li class="tab-error" role="tab" id="react-tabs-2794" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2795">401</li><li class="tab-error" role="tab" id="react-tabs-2796" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2797">403</li><li class="tab-error" role="tab" id="react-tabs-2798" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2799">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2793" aria-labelledby="react-tabs-2792"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"request_id"</span>: <span class="token string">"string"</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-2795" aria-labelledby="react-tabs-2794"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2797" aria-labelledby="react-tabs-2796"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2799" aria-labelledby="react-tabs-2798"></div></div></div></div></div></div><div id="tag/roles" data-section-id="tag/roles" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/roles"></a>roles</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for creating, getting and updating roles.</p>
|
||
</div></div></div><div id="tag/roles/paths/~1roles~1{role_id}/get" data-section-id="tag/roles/paths/~1roles~1{role_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/roles/paths/~1roles~1{role_id}/get"></a>Get a role<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a role from the provided role id.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Requires an active session but no other permissions.</p>
|
||
<p><strong>Minimum server version</strong>: 4.9</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="role_id"><span class="sc-kGXeez bcLONg"></span>role_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Role GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Role retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/roles/{role_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/roles/{role_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/roles/{role_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2800" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2801" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2801" aria-labelledby="react-tabs-2800"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
role<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetRole</span><span class="token punctuation">(</span><span class="token operator"><</span>ROLEID<span class="token operator">></span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2802" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2803" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2804" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2805">401</li><li class="tab-error" role="tab" id="react-tabs-2806" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2807">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2803" aria-labelledby="react-tabs-2802"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"permissions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"scheme_managed"</span>: <span class="token boolean">true</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-2805" aria-labelledby="react-tabs-2804"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2807" aria-labelledby="react-tabs-2806"></div></div></div></div></div></div><div id="tag/roles/paths/~1roles~1name~1{role_name}/get" data-section-id="tag/roles/paths/~1roles~1name~1{role_name}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/roles/paths/~1roles~1name~1{role_name}/get"></a>Get a role<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a role from the provided role name.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Requires an active session but no other permissions.</p>
|
||
<p><strong>Minimum server version</strong>: 4.9</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="role_name"><span class="sc-kGXeez bcLONg"></span>role_name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Role Name</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Role retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/roles/name/{role_name}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/roles/name/{role_name}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/roles/name/{role_name}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2808" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2809" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2809" aria-labelledby="react-tabs-2808"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
role<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetRoleByName</span><span class="token punctuation">(</span><span class="token operator"><</span>ROLENAME<span class="token operator">></span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2810" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2811" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2812" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2813">401</li><li class="tab-error" role="tab" id="react-tabs-2814" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2815">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2811" aria-labelledby="react-tabs-2810"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"permissions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"scheme_managed"</span>: <span class="token boolean">true</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-2813" aria-labelledby="react-tabs-2812"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2815" aria-labelledby="react-tabs-2814"></div></div></div></div></div></div><div id="tag/roles/paths/~1roles~1{role_id}~1patch/put" data-section-id="tag/roles/paths/~1roles~1{role_id}~1patch/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/roles/paths/~1roles~1{role_id}~1patch/put"></a>Patch a role<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Partially update a role by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_system</code> permission is required.</p>
|
||
<p><strong>Minimum server version</strong>: 4.9</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="role_id"><span class="sc-kGXeez bcLONg"></span>role_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Role GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Role object to be updated</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="permissions"><span class="sc-kGXeez bcLONg"></span>permissions</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc">Array of </span><span class="sc-cHGsZl sc-kgAjT hqYVjx">strings</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The permissions the role should grant.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Role patch successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/roles/{role_id}/patch</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/roles/{role_id}/patch</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/roles/{role_id}/patch</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2816" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2817" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2817" aria-labelledby="react-tabs-2816"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"permissions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2818" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2819" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2820" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2821">400</li><li class="tab-error" role="tab" id="react-tabs-2822" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2823">401</li><li class="tab-error" role="tab" id="react-tabs-2824" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2825">403</li><li class="tab-error" role="tab" id="react-tabs-2826" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2827">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2819" aria-labelledby="react-tabs-2818"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"permissions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</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">"scheme_managed"</span>: <span class="token boolean">true</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-2821" aria-labelledby="react-tabs-2820"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2823" aria-labelledby="react-tabs-2822"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2825" aria-labelledby="react-tabs-2824"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2827" aria-labelledby="react-tabs-2826"></div></div></div></div></div></div><div id="tag/roles/paths/~1roles~1names/post" data-section-id="tag/roles/paths/~1roles~1names/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/roles/paths/~1roles~1names/post"></a>Get a list of roles by name<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a list of roles from their names.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Requires an active session but no other permissions.</p>
|
||
<p><strong>Minimum server version</strong>: 4.9</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>List of role names</p>
|
||
</div><div><div class="sc-hMqMXs dDdNtD"> Array </div><div class="sc-gGBfsJ bvBDls"><div><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div></div></div></div></div><div class="sc-kEYyzF cMefLx"></div></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Role list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/roles/names</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/roles/names</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/roles/names</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2828" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2829" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-2830" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2831">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2829" aria-labelledby="react-tabs-2828"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">"string"</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-2831" aria-labelledby="react-tabs-2830"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2832" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2833" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2834" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2835">400</li><li class="tab-error" role="tab" id="react-tabs-2836" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2837">401</li><li class="tab-error" role="tab" id="react-tabs-2838" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2839">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2833" aria-labelledby="react-tabs-2832"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"permissions"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scheme_managed"</span>: <span class="token boolean">true</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-2835" aria-labelledby="react-tabs-2834"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2837" aria-labelledby="react-tabs-2836"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2839" aria-labelledby="react-tabs-2838"></div></div></div></div></div></div><div id="tag/schemes" data-section-id="tag/schemes" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/schemes"></a>schemes</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for creating, getting and updating and deleting schemes.</p>
|
||
</div></div></div><div id="tag/schemes/paths/~1schemes/get" data-section-id="tag/schemes/paths/~1schemes/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/schemes/paths/~1schemes/get"></a>Get the schemes.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of schemes. Use the query parameters to modify the behaviour of this endpoint.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.0</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="scope"><span class="sc-kGXeez bcLONg"></span>scope</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">""</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Limit the results returned to the provided scope, either <code>team</code> or <code>channel</code>.</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of schemes per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Scheme list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/schemes</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/schemes</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/schemes</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2840" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2841" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2842" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2843">400</li><li class="tab-error" role="tab" id="react-tabs-2844" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2845">401</li><li class="tab-error" role="tab" id="react-tabs-2846" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2847">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2841" aria-labelledby="react-tabs-2840"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"default_team_admin_role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"default_team_user_role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"default_channel_admin_role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"default_channel_user_role"</span>: <span class="token string">"string"</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-2843" aria-labelledby="react-tabs-2842"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2845" aria-labelledby="react-tabs-2844"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2847" aria-labelledby="react-tabs-2846"></div></div></div></div></div></div><div id="tag/schemes/paths/~1schemes/post" data-section-id="tag/schemes/paths/~1schemes/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/schemes/paths/~1schemes/post"></a>Create a scheme<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Create a new scheme.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.0</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Scheme object to create</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The name of the scheme</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="description"><span class="sc-kGXeez bcLONg"></span>description</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The description of the scheme</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="scope"><span class="sc-kGXeez bcLONg"></span>scope<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The scope of the scheme ("team" or "channel")</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>201<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Scheme creation successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/schemes</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/schemes</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/schemes</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2848" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2849" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2849" aria-labelledby="react-tabs-2848"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scope"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2850" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2851" tabindex="0">201</li><li class="tab-error" role="tab" id="react-tabs-2852" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2853">400</li><li class="tab-error" role="tab" id="react-tabs-2854" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2855">401</li><li class="tab-error" role="tab" id="react-tabs-2856" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2857">403</li><li class="tab-error" role="tab" id="react-tabs-2858" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2859">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2851" aria-labelledby="react-tabs-2850"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_team_admin_role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_team_user_role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_channel_admin_role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_channel_user_role"</span>: <span class="token string">"string"</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-2853" aria-labelledby="react-tabs-2852"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2855" aria-labelledby="react-tabs-2854"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2857" aria-labelledby="react-tabs-2856"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2859" aria-labelledby="react-tabs-2858"></div></div></div></div></div></div><div id="tag/schemes/paths/~1schemes~1{scheme_id}/get" data-section-id="tag/schemes/paths/~1schemes~1{scheme_id}/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/schemes/paths/~1schemes~1{scheme_id}/get"></a>Get a scheme<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a scheme from the provided scheme id.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.0</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="scheme_id"><span class="sc-kGXeez bcLONg"></span>scheme_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Scheme GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Scheme retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/schemes/{scheme_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/schemes/{scheme_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/schemes/{scheme_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2860" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2861" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2861" aria-labelledby="react-tabs-2860"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
scheme<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetScheme</span><span class="token punctuation">(</span><span class="token operator"><</span>SCHEMEID<span class="token operator">></span><span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2862" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2863" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2864" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2865">401</li><li class="tab-error" role="tab" id="react-tabs-2866" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2867">404</li><li class="tab-error" role="tab" id="react-tabs-2868" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2869">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2863" aria-labelledby="react-tabs-2862"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_team_admin_role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_team_user_role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_channel_admin_role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_channel_user_role"</span>: <span class="token string">"string"</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-2865" aria-labelledby="react-tabs-2864"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2867" aria-labelledby="react-tabs-2866"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2869" aria-labelledby="react-tabs-2868"></div></div></div></div></div></div><div id="tag/schemes/paths/~1schemes~1{scheme_id}/delete" data-section-id="tag/schemes/paths/~1schemes~1{scheme_id}/delete" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/schemes/paths/~1schemes~1{scheme_id}/delete"></a>Delete a scheme<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Soft deletes a scheme, by marking the scheme as deleted in the database.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must have <code>manage_system</code> permission.</p>
|
||
<p><strong>Minimum server version</strong>: 5.0</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="scheme_id"><span class="sc-kGXeez bcLONg"></span>scheme_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>ID of the scheme to delete</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Scheme deletion successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="delete" class="sc-dfVpRl hPskZd http-verb delete"> <!-- -->delete</span> <span class="sc-dqBHgY iENVAs">/schemes/{scheme_id}</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/schemes/{scheme_id}</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/schemes/{scheme_id}</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2870" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2871" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2872" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2873">400</li><li class="tab-error" role="tab" id="react-tabs-2874" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2875">401</li><li class="tab-error" role="tab" id="react-tabs-2876" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2877">403</li><li class="tab-error" role="tab" id="react-tabs-2878" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2879">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2871" aria-labelledby="react-tabs-2870"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2873" aria-labelledby="react-tabs-2872"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2875" aria-labelledby="react-tabs-2874"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2877" aria-labelledby="react-tabs-2876"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2879" aria-labelledby="react-tabs-2878"></div></div></div></div></div></div><div id="tag/schemes/paths/~1schemes~1{scheme_id}~1patch/put" data-section-id="tag/schemes/paths/~1schemes~1{scheme_id}~1patch/put" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/schemes/paths/~1schemes~1{scheme_id}~1patch/put"></a>Patch a scheme<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Partially update a scheme by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_system</code> permission is required.</p>
|
||
<p><strong>Minimum server version</strong>: 5.0</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="scheme_id"><span class="sc-kGXeez bcLONg"></span>scheme_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Scheme GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Scheme object to be updated</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="name"><span class="sc-kGXeez bcLONg"></span>name</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The human readable name of the scheme</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="description"><span class="sc-kGXeez bcLONg"></span>description</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The description of the scheme</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Scheme patch successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>501<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Feature is disabled</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="put" class="sc-dfVpRl hOczRB http-verb put"> <!-- -->put</span> <span class="sc-dqBHgY iENVAs">/schemes/{scheme_id}/patch</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/schemes/{scheme_id}/patch</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/schemes/{scheme_id}/patch</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2880" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2881" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2881" aria-labelledby="react-tabs-2880"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2882" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2883" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2884" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2885">400</li><li class="tab-error" role="tab" id="react-tabs-2886" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2887">401</li><li class="tab-error" role="tab" id="react-tabs-2888" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2889">403</li><li class="tab-error" role="tab" id="react-tabs-2890" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2891">404</li><li class="tab-error" role="tab" id="react-tabs-2892" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2893">501</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2883" aria-labelledby="react-tabs-2882"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scope"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_team_admin_role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_team_user_role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_channel_admin_role"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_channel_user_role"</span>: <span class="token string">"string"</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-2885" aria-labelledby="react-tabs-2884"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2887" aria-labelledby="react-tabs-2886"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2889" aria-labelledby="react-tabs-2888"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2891" aria-labelledby="react-tabs-2890"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2893" aria-labelledby="react-tabs-2892"></div></div></div></div></div></div><div id="tag/schemes/paths/~1schemes~1{scheme_id}~1teams/get" data-section-id="tag/schemes/paths/~1schemes~1{scheme_id}~1teams/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/schemes/paths/~1schemes~1{scheme_id}~1teams/get"></a>Get a page of teams which use this scheme.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of teams which use this scheme. The provided Scheme ID should be for a Team-scoped Scheme.
|
||
Use the query parameters to modify the behaviour of this endpoint.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_system</code> permission is required.</p>
|
||
<p><strong>Minimum server version</strong>: 5.0</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="scheme_id"><span class="sc-kGXeez bcLONg"></span>scheme_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Scheme GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of teams per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Team list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/schemes/{scheme_id}/teams</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/schemes/{scheme_id}/teams</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/schemes/{scheme_id}/teams</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2894" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2895" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2896" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2897">400</li><li class="tab-error" role="tab" id="react-tabs-2898" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2899">401</li><li class="tab-error" role="tab" id="react-tabs-2900" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2901">403</li><li class="tab-error" role="tab" id="react-tabs-2902" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2903">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2895" aria-labelledby="react-tabs-2894"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"allowed_domains"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"invite_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"allow_open_invite"</span>: <span class="token boolean">true</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-2897" aria-labelledby="react-tabs-2896"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2899" aria-labelledby="react-tabs-2898"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2901" aria-labelledby="react-tabs-2900"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2903" aria-labelledby="react-tabs-2902"></div></div></div></div></div></div><div id="tag/schemes/paths/~1schemes~1{scheme_id}~1channels/get" data-section-id="tag/schemes/paths/~1schemes~1{scheme_id}~1channels/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/schemes/paths/~1schemes~1{scheme_id}~1channels/get"></a>Get a page of channels which use this scheme.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Get a page of channels which use this scheme. The provided Scheme ID should be for a Channel-scoped Scheme.
|
||
Use the query parameters to modify the behaviour of this endpoint.</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p><code>manage_system</code> permission is required.</p>
|
||
<p><strong>Minimum server version</strong>: 5.0</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="scheme_id"><span class="sc-kGXeez bcLONg"></span>scheme_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Scheme GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-gqjmRU LiUBH">query<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="page"><span class="sc-kGXeez bcLONg"></span>page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">0</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The page to select.</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="per_page"><span class="sc-kGXeez bcLONg"></span>per_page</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">integer</span></div><div><span class="sc-cHGsZl lpeYvY"> <!-- -->Default:<!-- --> </span> <span class="sc-cHGsZl sc-jbKcbu bMfIUD">60</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The number of channels per page.</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Channel list retrieval successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Resource not found</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/schemes/{scheme_id}/channels</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/schemes/{scheme_id}/channels</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/schemes/{scheme_id}/channels</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2904" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2905" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2906" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2907">400</li><li class="tab-error" role="tab" id="react-tabs-2908" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2909">401</li><li class="tab-error" role="tab" id="react-tabs-2910" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2911">403</li><li class="tab-error" role="tab" id="react-tabs-2912" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2913">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2905" aria-labelledby="react-tabs-2904"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"create_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"delete_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"display_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"header"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"purpose"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_post_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_msg_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"extra_update_at"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"creator_id"</span>: <span class="token string">"string"</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-2907" aria-labelledby="react-tabs-2906"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2909" aria-labelledby="react-tabs-2908"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2911" aria-labelledby="react-tabs-2910"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2913" aria-labelledby="react-tabs-2912"></div></div></div></div></div></div><div id="tag/integration_actions" data-section-id="tag/integration_actions" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/integration_actions"></a>integration_actions</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for interactive actions for use by integrations.</p>
|
||
</div></div></div><div id="tag/integration_actions/paths/~1actions~1dialogs~1open/post" data-section-id="tag/integration_actions/paths/~1actions~1dialogs~1open/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/integration_actions/paths/~1actions~1dialogs~1open/post"></a>Open a dialog<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Open an interactive dialog using a trigger ID provided by a slash command, or some other action payload. See <a href="https://docs.mattermost.com/developer/interactive-dialogs.html">https://docs.mattermost.com/developer/interactive-dialogs.html</a> for more information on interactive dialogs.
|
||
<strong>Minimum server version: 5.6</strong></p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Metadata for the dialog to be opened</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="trigger_id"><span class="sc-kGXeez bcLONg"></span>trigger_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Trigger ID provided by other action</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="url"><span class="sc-kGXeez bcLONg"></span>url<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The URL to send the submitted dialog payload to</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV sc-kjoXOD iNoDtm" kind="field" title="dialog"><span class="sc-kGXeez bcLONg"></span>dialog<svg class="sc-jTzLTM gBhLRG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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><div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Post object to create</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Dialog open successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/actions/dialogs/open</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/actions/dialogs/open</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/actions/dialogs/open</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2914" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2915" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2915" aria-labelledby="react-tabs-2914"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"trigger_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dialog"</span>: <div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"callback_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"introduction_text"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"elements"</span>: <div class="collapser"></div><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"submit_label"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"notify_on_cancel"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"state"</span>: <span class="token string">"string"</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-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2916" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2917" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2918" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2919">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2917" aria-labelledby="react-tabs-2916"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2919" aria-labelledby="react-tabs-2918"></div></div></div></div></div></div><div id="tag/integration_actions/paths/~1actions~1dialogs~1submit/post" data-section-id="tag/integration_actions/paths/~1actions~1dialogs~1submit/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/integration_actions/paths/~1actions~1dialogs~1submit/post"></a>Submit a dialog<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Endpoint used by the Mattermost clients to submit a dialog. See <a href="https://docs.mattermost.com/developer/interactive-dialogs.html">https://docs.mattermost.com/developer/interactive-dialogs.html</a> for more information on interactive dialogs.
|
||
<strong>Minimum server version: 5.6</strong></p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Dialog submission data</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="url"><span class="sc-kGXeez bcLONg"></span>url<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>The URL to send the submitted dialog payload to</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="channel_id"><span class="sc-kGXeez bcLONg"></span>channel_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Channel ID the user submitted the dialog from</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="team_id"><span class="sc-kGXeez bcLONg"></span>team_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Team ID the user submitted the dialog from</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="submission"><span class="sc-kGXeez bcLONg"></span>submission<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">object</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>String map where keys are element names and values are the element input values</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="callback_id"><span class="sc-kGXeez bcLONg"></span>callback_id</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Callback ID sent when the dialog was opened</p>
|
||
</div></div></div></td></tr><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="state"><span class="sc-kGXeez bcLONg"></span>state</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>State sent when the dialog was opened</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="cancelled"><span class="sc-kGXeez bcLONg"></span>cancelled</td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">boolean</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>Set to true if the dialog was cancelled</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Dialog submission successful</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/actions/dialogs/submit</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/actions/dialogs/submit</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/actions/dialogs/submit</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2920" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2921" tabindex="0">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2921" aria-labelledby="react-tabs-2920"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"channel_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"team_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"submission"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"callback_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cancelled"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2922" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2923" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2924" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2925">400</li><li class="tab-error" role="tab" id="react-tabs-2926" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2927">401</li><li class="tab-error" role="tab" id="react-tabs-2928" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2929">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2923" aria-labelledby="react-tabs-2922"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2925" aria-labelledby="react-tabs-2924"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2927" aria-labelledby="react-tabs-2926"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2929" aria-labelledby="react-tabs-2928"></div></div></div></div></div></div><div id="tag/terms-of-service" data-section-id="tag/terms-of-service" class="sc-ifAKCX dluJDj"><div class="sc-gzVnrw eesUPo"><div class="sc-bxivhb cjtbAK"><h1 class="sc-htoDjs WxWXp"><a class="sc-VigVT kGvRyb" href="#tag/terms-of-service"></a>terms of service</h1></div></div><div class="sc-bxivhb kFNigF"><div class="sc-jWBwVP sc-iRbamj flfxUM redoc-markdown "><p>Endpoints for getting and updating custom terms of service.</p>
|
||
</div></div></div><div id="tag/terms-of-service/paths/~1users~1{user_id}~1terms_of_service/post" data-section-id="tag/terms-of-service/paths/~1users~1{user_id}~1terms_of_service/post" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/terms-of-service/paths/~1users~1{user_id}~1terms_of_service/post"></a>Records user action when they accept or decline custom terms of service<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Records user action when they accept or decline custom terms of service. Records the action in audit table.
|
||
Updates user's last accepted terms of service ID if they accepted it.</p>
|
||
<p><strong>Minimum server version</strong>: 5.4</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being acted on.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><h5 class="sc-gqjmRU LiUBH">Request Body schema: <span class="sc-hSdWYo hoUoen">application/json</span></h5><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>terms of service details</p>
|
||
</div><table class="sc-dxgOiQ eCjbJc"><tbody><tr><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="serviceTermsId"><span class="sc-kGXeez bcLONg"></span>serviceTermsId<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>terms of service ID on which the user is acting on</p>
|
||
</div></div></div></td></tr><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="accepted"><span class="sc-kGXeez bcLONg"></span>accepted<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>true or false, indicates whether the user accepted or rejected the terms of service.</p>
|
||
</div></div></div></td></tr></tbody></table><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Terms of service action recorded successfully</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>403<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Do not have appropriate permissions</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="post" class="sc-dfVpRl bNYCAJ http-verb post"> <!-- -->post</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/terms_of_service</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/terms_of_service</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/terms_of_service</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2930" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2931" tabindex="0">Payload</li><li class="react-tabs__tab" role="tab" id="react-tabs-2932" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2933">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2931" aria-labelledby="react-tabs-2930"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"serviceTermsId"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"accepted"</span>: <span class="token string">"string"</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-2933" aria-labelledby="react-tabs-2932"></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2934" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2935" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2936" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2937">400</li><li class="tab-error" role="tab" id="react-tabs-2938" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2939">401</li><li class="tab-error" role="tab" id="react-tabs-2940" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2941">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2935" aria-labelledby="react-tabs-2934"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</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-2937" aria-labelledby="react-tabs-2936"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2939" aria-labelledby="react-tabs-2938"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2941" aria-labelledby="react-tabs-2940"></div></div></div></div></div></div><div id="tag/terms-of-service/paths/~1users~1{user_id}~1terms_of_service/get" data-section-id="tag/terms-of-service/paths/~1users~1{user_id}~1terms_of_service/get" class="sc-ifAKCX hiuczA"><div class="sc-gzVnrw sc-ibxdXY bSFXlp"><div class="sc-bxivhb cjtbAK"><h2 class="sc-dnqmqq ioYTqA"><a class="sc-VigVT kGvRyb" href="#tag/terms-of-service/paths/~1users~1{user_id}~1terms_of_service/get"></a>Fetches user's latest terms of service action if the latest action was for acceptance.<!-- --> </h2><div class="sc-RefOD boajtD"><div class="sc-jWBwVP sc-iRbamj flfxUM"><p>Will be deprecated in v6.0
|
||
Fetches user's latest terms of service action if the latest action was for acceptance.</p>
|
||
<p><strong>Minimum server version</strong>: 5.6</p>
|
||
<h5 id="permissions">Permissions</h5>
|
||
<p>Must be logged in as the user being acted on.</p>
|
||
</div></div><div class="sc-jtRfpW geWpKA"><div class="sc-lhVmIH dVvUxe"><h5 class="sc-gqjmRU sc-elJkPf jGRUDj">Authorizations: </h5></div><div class="sc-bYSBpT fKHsnH"><span class="sc-btzYZH hQBRTt"><span class="sc-jwKygS bnFPhO"><a href="#section/Authentication/bearerAuth">bearerAuth</a></span></span></div></div><div><h5 class="sc-gqjmRU LiUBH">path<!-- --> Parameters</h5><table class="sc-dxgOiQ eCjbJc"><tbody><tr class="last undefined"><td class="sc-cSHVUG sc-chPdSV bIrgla" kind="field" title="user_id"><span class="sc-kGXeez bcLONg"></span>user_id<div class="sc-ksYbfQ sc-hmzhuo jsTAxL"> required </div></td><td class="sc-kgoBCf kGwPhO"><div><div><span class="sc-cHGsZl sc-TOsTZ fKyGWc"></span><span class="sc-cHGsZl sc-kgAjT hqYVjx">string</span></div> <div><div class="sc-jWBwVP sc-iRbamj gDsWLk"><p>User GUID</p>
|
||
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-eXEjpC espozG"> Responses </h3><div><div class="sc-kPVwWT fDvFMp"><svg class="sc-jTzLTM NifDa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>200<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User's accepted terms of service action</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>400<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>Invalid or missing parameters in URL or request body</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>401<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>No access token provided</p>
|
||
</span></div></div><div><div class="sc-kPVwWT byLrBg"><svg class="sc-jTzLTM jjozHG" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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>404<!-- --> </strong><span class="sc-jlyJG evvbxn"><p>User hasn't performed an action or the latest action was a rejection.</p>
|
||
</span></div></div></div></div><div class="sc-EHOje sc-bZQynM dtUibw"><div class="sc-kTUwUJ ldTMcP"><div class="sc-gxMtzJ dHLKeu"><span type="get" class="sc-dfVpRl jBjYbV http-verb get"> <!-- -->get</span> <span class="sc-dqBHgY iENVAs">/users/{user_id}/terms_of_service</span><svg class="sc-jTzLTM OtKQc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0"><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></div><div class="sc-gzOgki lkvpfX"><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>http://your-mattermost-url.com/api/v4</span>/users/{user_id}/terms_of_service</div></div></div><div class="sc-iyvyFf eftLSo"><div class="sc-jWBwVP sc-iRbamj gDsWLk"></div><div><div class="sc-hwwEjo bwgXFh"><span>https://your-mattermost-url.com/api/v4</span>/users/{user_id}/terms_of_service</div></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Request samples </h3><div class="sc-eHgmQL irpqyy" 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-2942" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2943" tabindex="0">Go</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2943" aria-labelledby="react-tabs-2942"><div class="sc-cMljjf ixmYVs"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span></div><pre class="sc-jAaTju sc-jDwBTQ gbsZqp"><span class="token keyword">import</span> <span class="token string">"github.com/mattermost/mattermost-server/model"</span>
|
||
|
||
Client <span class="token operator">:=</span> model<span class="token punctuation">.</span><span class="token function">NewAPIv4Client</span><span class="token punctuation">(</span><span class="token string">"https://your-mattermost-url.com"</span><span class="token punctuation">)</span>
|
||
Client<span class="token punctuation">.</span><span class="token function">Login</span><span class="token punctuation">(</span><span class="token string">"email@domain.com"</span><span class="token punctuation">,</span> <span class="token string">"Password1"</span><span class="token punctuation">)</span>
|
||
|
||
userID <span class="token operator">:=</span> <span class="token string">"adWv1qPZmHdtxk7Lmqh6RtxWxS"</span>
|
||
|
||
userTermsOfService<span class="token punctuation">,</span> resp <span class="token operator">:=</span> Client<span class="token punctuation">.</span><span class="token function">GetUserTermsOfService</span><span class="token punctuation">(</span>userID<span class="token punctuation">,</span> <span class="token string">""</span><span class="token punctuation">)</span>
|
||
</pre></div></div></div></div><div><h3 class="sc-gZMcBi kBWwoV"> Response samples </h3><div class="sc-eHgmQL irpqyy" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2944" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-2945" tabindex="0">200</li><li class="tab-error" role="tab" id="react-tabs-2946" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2947">400</li><li class="tab-error" role="tab" id="react-tabs-2948" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2949">401</li><li class="tab-error" role="tab" id="react-tabs-2950" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-2951">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-2945" aria-labelledby="react-tabs-2944"><div><div class="sc-eqIVtm ecxnvs"><span class="sc-dVhcbM dpMbau">Content type</span><div class="sc-fMiknA gzAoUb">application/json</div></div><div class="sc-gisBJw gwfZGU"><div class="sc-jhAzac kwGRVL"><div class="sc-brqgnP fCJmC"><span><div class="sc-gipzik gbTit">Copy</div></span><span> Expand all </span><span> Collapse all </span></div><div class="sc-jWBwVP jCgylq sc-fBuWsC kZHJcC"><div class="redoc-json"><code><div class="collapser"></div><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"terms_of_service_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"create_at"</span>: <span class="token number">0</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-2947" aria-labelledby="react-tabs-2946"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2949" aria-labelledby="react-tabs-2948"></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-2951" aria-labelledby="react-tabs-2950"></div></div></div></div></div></div></div><div class="sc-iuJeZd fLUKgj"></div></div></div>
|
||
<script>
|
||
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"description":"There is also a work-in-progress [Postman API reference](https://documenter.getpostman.com/view/4508214/RW8FERUn).\n\n# Authentication\n\n<!-- ReDoc-Inject: <security-definitions> -->","version":"4.0.0","title":"Mattermost API Reference","termsOfService":"https://about.mattermost.com/default-terms/","contact":{"email":"feedback@mattermost.com"},"x-logo":{"url":"https://www.mattermost.org/wp-content/uploads/2016/03/logoHorizontal_WS.png","backgroundColor":"#FFFFFF"}},"tags":[{"name":"introduction","description":"The Mattermost Web Services API is used by Mattermost clients and third party applications to interact with the server. [JavaScript and Golang drivers for](/#tag/drivers) connecting to the APIs are also available.\n\n### Support\n\nMattermost core committers work with the community to keep the API documentation up-to-date.\n\nIf you have questions on API routes not listed in this reference, please [join the Mattermost community server](https://pre-release.mattermost.com/signup_user_complete/?id=f1924a8db44ff3bb41c96424cdc20676) to ask questions in the Developers channel, [or post questions to our Developer Discussion forum](http://forum.mattermost.org/c/dev).\n\n[Bug reports](https://github.com/mattermost/mattermost-api-reference/issues) in the documentation or the API are also welcome, as are pull requests to fix the issues.\n\n### Contributing\n\nWhen you have answers to API questions not addressed in our documentation we ask you to consider making a pull request to improve our reference. [Small changes](https://github.com/mattermost/mattermost-api-reference/commit/d574c0c1e95dc2228dc96663afd562f1305e3ece) and [larger changes](https://github.com/mattermost/mattermost-api-reference/commit/1ae3314f0935eebba8c885d8969dcad72f801501) are all welcome.\n\nWe also have [Help Wanted tickets](https://github.com/mattermost/mattermost-api-reference/issues) available for community members who would like to help others more easily use the APIs. We acknowledge everyone's contribution in the [release notes of our next version](https://docs.mattermost.com/administration/changelog.html#contributors).\n\nThe source code for this API reference is hosted at https://github.com/mattermost/mattermost-api-reference.\n"},{"name":"schema","description":"All API access is through HTTP(S) requests at `your-mattermost-url.com/api/v4`. All request and response bodies are `application/json`.\n\nWhen using endpoints that require a user id, the string `me` can be used in place of the user id to indicate the action is to be taken for the logged in user.\n"},{"name":"drivers","description":"The easiest way to interact with the Mattermost Web Service API is through a language specific driver.\n\n#### Official Drivers\n* [Mattermost JavaScript Driver](https://github.com/mattermost/mattermost-redux/blob/master/src/client/client4.ts)\n* [Mattermost Golang Driver](https://github.com/mattermost/mattermost-server/blob/master/model/client4.go)\n\n#### Community-built Drivers\n* [PHP Driver](https://github.com/gnello/php-mattermost-driver) - built by [@gnello](https://github.com/gnello) and [@prixone](https://github.com/prixone)\n* [Python Driver](https://github.com/Vaelor/python-mattermost-driver) - built by [@Vaelor](https://github.com/Vaelor)\n\nFor other community-built drivers and API wrappers, see [our app directory](https://about.mattermost.com/community-applications/#privateApps).\n"},{"name":"authentication","description":"There are multiple ways to authenticate against the Mattermost API.\n\nAll examples assume there is a Mattermost instance running at http://localhost:8065.\n\n#### Session Token\n\nMake an HTTP POST to `your-mattermost-url.com/api/v4/users/login` with a JSON body indicating the user’s `login_id`, `password` and optionally the MFA `token`. The `login_id` can be an email, username or an AD/LDAP ID depending on the system's configuration.\n\n```\ncurl -i -d '{\"login_id\":\"someone@nowhere.com\",\"password\":\"thisisabadpassword\"}' http://localhost:8065/api/v4/users/login\n```\n\nNOTE: If you're running cURL on windows, you will have to change the single quotes to double quotes, and escape the inner double quotes with backslash, like below:\n\n```\ncurl -i -d \"{\\\"login_id\\\":\\\"someone@nowhere.com\\\",\\\"password\\\":\\\"thisisabadpassword\\\"}\" http://localhost:8065/api/v4/users/login\n```\n\nIf successful, the response will contain a `Token` header and a user object in the body.\n\n```\nHTTP/1.1 200 OK\nSet-Cookie: MMSID=hyr5dmb1mbb49c44qmx4whniso; Path=/; Max-Age=2592000; HttpOnly\nToken: hyr5dmb1mbb49c44qmx4whniso\nX-Ratelimit-Limit: 10\nX-Ratelimit-Remaining: 9\nX-Ratelimit-Reset: 1\nX-Request-Id: smda55ckcfy89b6tia58shk5fh\nX-Version-Id: developer\nDate: Fri, 11 Sep 2015 13:21:14 GMT\nContent-Length: 657\nContent-Type: application/json; charset=utf-8\n\n{{user object as json}}\n```\n\nInclude the `Token` as part of the `Authorization` header on your future API requests with the `Bearer` method.\n\n```\ncurl -i -H 'Authorization: Bearer hyr5dmb1mbb49c44qmx4whniso' http://localhost:8065/api/v4/users/me\n```\n\nYou should now be able to access the API as the user you logged in as.\n\n#### Personal Access Tokens\n\nUsing [personal access tokens](https://docs.mattermost.com/developer/personal-access-tokens.html) is very similar to using a session token. The only real difference is that session tokens will expire, while personal access tokens will live until they are manually revoked by the user or an admin.\n\nJust like session tokens, include the personal access token as part of the `Authorization` header in your requests using the `Bearer` method. Assuming our personal access token is `9xuqwrwgstrb3mzrxb83nb357a`, we could use it as shown below.\n\n```\ncurl -i -H 'Authorization: Bearer 9xuqwrwgstrb3mzrxb83nb357a' http://localhost:8065/api/v4/users/me\n```\n\n#### OAuth 2.0\n\nMattermost has the ability to act as an [OAuth 2.0](https://tools.ietf.org/html/rfc6749) service provider.\n\nThe official documentation for [using your Mattermost server as an OAuth 2.0 service provider can be found here.](https://docs.mattermost.com/developer/oauth-2-0-applications.html)\n\nFor an example on how to register an OAuth 2.0 app with your Mattermost instance, please see the [Mattermost-Zapier integration documentation](https://docs.mattermost.com/integrations/zapier.html#register-zapier-as-an-oauth-2-0-application).\n"},{"name":"errors","description":"All errors will return an appropriate HTTP response code along with the following JSON body:\n```\n{\n \"id\": \"the.error.id\",\n \"message\": \"Something went wrong\", // the reason for the error\n \"request_id\": \"\", // the ID of the request\n \"status_code\": 0, // the HTTP status code\n \"is_oauth\": false // whether the error is OAuth specific\n}\n```\n"},{"name":"rate limiting","description":"Whenever you make an HTTP request to the Mattermost API you might notice the following headers included in the response:\n```\nX-Ratelimit-Limit: 10\nX-Ratelimit-Remaining: 9\nX-Ratelimit-Reset: 1441983590\n```\n\nThese headers are telling you your current rate limit status.\n\n| Header | Description |\n| ------ | ----------- |\n| X-Ratelimit-Limit | The maximum number of requests you can make per second. |\n| X-Ratelimit-Remaining | The number of requests remaining in the current window. |\n| X-Ratelimit-Reset | The remaining UTC epoch seconds before the rate limit resets. |\n\nIf you exceed your rate limit for a window you will receive the following error in the body of the response:\n\n```\nHTTP/1.1 429 Too Many Requests\nDate: Tue, 10 Sep 2015 11:20:28 GMT\nX-RateLimit-Limit: 10\nX-RateLimit-Remaining: 0\nX-RateLimit-Reset: 1\n\nlimit exceeded\n```\n"},{"name":"WebSocket","description":"In addition to the HTTP RESTful web service, Mattermost also offers a WebSocket event delivery system and some API functionality.\n\nTo connect to the WebSocket follow the standard opening handshake as [defined by the RFC specification](https://tools.ietf.org/html/rfc6455#section-1.3) to the `/api/v4/websocket` endpoint of Mattermost.\n\n#### Authentication\n\nThe Mattermost WebSocket can be authenticated by cookie or through an authentication challenge. If you're authenticating from a browser and have logged in with the Mattermost API, your authentication cookie should already be set, this is how the Mattermost webapp authenticates with the WebSocket.\n\nTo authenticate with an authentication challenge, first connect the WebSocket and then send the following JSON over the connection:\n\n```\n{\n \"seq\": 1,\n \"action\": \"authentication_challenge\",\n \"data\": {\n \"token\": \"mattermosttokengoeshere\"\n }\n}\n```\n\nIf successful, you will receive a standard OK response over the WebSocket connection:\n\n```\n{\n \"status\": \"OK\",\n \"seq_reply\": 1\n}\n```\n\nOnce successfully authenticated, the server will pass a `hello` WebSocket event containing server version over the connection.\n\n#### Events\n\nWebSocket events are primarily used to alert the client to changes in Mattermost, such as delivering new posts or alerting the client that another user is typing in a channel.\n\nEvents on the WebSocket will have the form:\n\n```\n{\n \"event\": \"hello\",\n \"data\": {\n \"server_version\": \"3.6.0.1451.1c38da627ebb4e3635677db6939e9195\"\n },\n \"broadcast\":{\n \"omit_users\": null,\n \"user_id\": \"ay5sq51sebfh58ktrce5ijtcwy\",\n \"channel_id\": \"\",\n \"team_id\": \"\"\n },\n \"seq\": 0\n}\n```\n\nThe `event` field indicates the event type, `data` contains any data relevant to the event and `broadcast` contains information about who the event was sent to. For example, the above example has `user_id` set to \"ay5sq51sebfh58ktrce5ijtcwy\" meaning that only the user with that ID received this event broadcast. The `omit_users` field can contain an array of user IDs that were specifically omitted from receiving the event.\n\nThe list of Mattermost WebSocket events are:\n- added_to_team\n- authentication_challenge\n- channel_converted\n- channel_created\n- channel_deleted\n- channel_member_updated\n- channel_updated\n- channel_viewed\n- config_changed\n- delete_team\n- direct_added\n- emoji_added\n- ephemeral_message\n- group_added\n- hello\n- leave_team\n- license_changed\n- memberrole_updated\n- new_user\n- plugin_disabled\n- plugin_enabled\n- plugin_statuses_changed\n- post_deleted\n- post_edited\n- post_unread\n- posted\n- preference_changed\n- preferences_changed\n- preferences_deleted\n- reaction_added\n- reaction_removed\n- response\n- role_updated\n- status_change\n- typing\n- update_team\n- user_added\n- user_removed\n- user_role_updated\n- user_updated\n- dialog_opened\n\n#### WebSocket API\n\nMattermost has some basic support for WebSocket APIs. A connected WebSocket can make requests by sending the following over the connection:\n\n```\n{\n \"action\": \"user_typing\",\n \"seq\": 2,\n \"data\": {\n \"channel_id\": \"nhze199c4j87ped4wannrjdt9c\",\n \"parent_id\": \"\"\n }\n}\n```\n\nThis is an example of making a `user_typing` request, with the purpose of alerting the server that the connected client has begun typing in a channel or thread. The `action` field indicates what is being requested, and performs a similar duty as the route in a HTTP API.\n\nThe `seq` or sequence number is set by the client and should be incremented with every use. It is used to distinguish responses to requests that come down the WebSocket. For example, a standard response to the above request would be:\n\n```\n{\n \"status\": \"OK\",\n \"seq_reply\": 2\n}\n```\n\nNotice `seq_reply` is 2, matching the `seq` of the original request. Using this a client can distinguish which request the response is meant for.\n\nIf there was any information to respond with, it would be encapsulated in a `data` field.\n\nIn the case of an error, the response would be:\n\n```\n{\n \"status\": \"FAIL\",\n \"seq_reply\": 2,\n \"error\": {\n \"id\": \"some.error.id.here\",\n \"message\": \"Some error message here\"\n }\n}\n```\n\nThe list of WebSocket API actions is:\n- user_typing\n- get_statuses\n- get_statuses_by_ids\n\nTo see how these actions work, please refer to either the [Golang WebSocket driver](https://github.com/mattermost/mattermost-server/blob/master/model/websocket_client.go) or our [JavaScript WebSocket driver](https://github.com/mattermost/mattermost-redux/blob/master/src/client/websocket_client.js).\n"},{"name":"APIv3 Deprecation","description":"Since Mattermost 4.6 released on January 16, 2018, API v3 has no longer been supported and it will be removed in Mattermost Server v5.0 on June 16, 2018. Follow these simple steps to migrate your integrations and apps to API v4. Otherwise your integrations may break once you upgrade to Mattermost 5.0\n\n1. Set your server's log level to `DEBUG` in **System Console > General > Logging > File Log Level** to print detailed logs for API requests.\n2. In **System Console > Logs**, search for requests hitting `/api/v3/` endpoints. Any requests hitting these endpoints are from integrations that should be migrated to API v4.\n - For in-house or self-built integrations, update them to use v4 with the help of [this API reference](https://api.mattermost.com). Most v3 endpoints have direct counterparts in v4 and should be migrated easily.\n - For third-party integrations, visit their homepage (on GitHub, GitLab, etc.). Check if they already have a version that uses the Mattermost v4 API. If they do not, consider opening an issue asking them if support is planned.\n3. Once all integrations have been migrated to API v4, review the server logs with log level set to `DEBUG`. Confirm no requests hit `/api/v3/` endpoints.\n4. Set **Allow use of API v3 endpoints** to `false` in **System Console > General > Configuration**, or set `EnableAPIv3` to `false` in `config.json`. This setting disables API v3 on your server. Any time a v3 endpoint is used, an error is logged in **System Console > Logs**.\n5. Set your server's log level back to `ERROR`. Use the error logs to help track down any remaining uses of API v3.\n\nBelow are the major changes made between v3 and v4:\n\n1. Endpoint URLs only require team IDs when necessary. For example, getting a channel by ID no longer requires a team ID in v4.\n2. Collection endpoints now generally return lists and include paging as part of the query string.\n3. User ID is now included in most user endpoints. This allows admins to modify other users through v4 endpoints.\n\nIf you have any questions about the API v3 deprecation, or about migrating from v3 to v4, [join our daily build server at pre-release.mattermost.com](https://pre-release.mattermost.com/signup_user_complete/?id=f1924a8db44ff3bb41c96424cdc20676) and ask questions in the [APIv4 channel](https://pre-release.mattermost.com/core/channels/apiv4).\n"},{"name":"users","description":"Endpoints for creating, getting and interacting with users.\n\nWhen using endpoints that require a user id, the string `me` can be used in place of the user id to indicate the action is to be taken for the logged in user.\n"},{"name":"bots","description":"Endpoints for creating, getting and updating bot users."},{"name":"teams","description":"Endpoints for creating, getting and interacting with teams."},{"name":"channels","description":"Endpoints for creating, getting and interacting with channels."},{"name":"posts","description":"Endpoints for creating, getting and interacting with posts."},{"name":"files","description":"Endpoints for uploading and interacting with files."},{"name":"preferences","description":"Endpoints for saving and modifying user preferences."},{"name":"status","description":"Endpoints for getting and updating user statuses."},{"name":"emoji","description":"Endpoints for creating, getting and interacting with emojis."},{"name":"reactions","description":"Endpoints for creating, getting and removing emoji reactions."},{"name":"webhooks","description":"Endpoints for creating, getting and updating webhooks."},{"name":"commands","description":"Endpoints for creating, getting and updating slash commands."},{"name":"OpenGraph","description":"Endpoint for getting Open Graph metadata."},{"name":"system","description":"General endpoints for interacting with the server, such as configuration and logging."},{"name":"brand","description":"Endpoints related to custom branding and white-labeling. See [our branding documentation](https://docs.mattermost.com/administration/branding.html) for more information."},{"name":"OAuth","description":"Endpoints for configuring and interacting with Mattermost as an OAuth 2.0 service provider."},{"name":"SAML","description":"Endpoints for configuring and interacting with SAML."},{"name":"LDAP","description":"Endpoints for configuring and interacting with LDAP."},{"name":"groups","description":"Endpoints related to LDAP groups."},{"name":"compliance","description":"Endpoints for creating, getting and downloading compliance reports."},{"name":"cluster","description":"Endpoints for configuring and interacting with high availability clusters."},{"name":"elasticsearch","description":"Endpoints for configuring and interacting with Elasticsearch."},{"name":"dataretention","description":"Endpoint for getting data retention policy settings."},{"name":"jobs","description":"Endpoints related to various background jobs that can be run by the server or separately by job servers."},{"name":"plugins","description":"Endpoints related to uploading and managing plugins."},{"name":"roles","description":"Endpoints for creating, getting and updating roles."},{"name":"schemes","description":"Endpoints for creating, getting and updating and deleting schemes."},{"name":"integration_actions","description":"Endpoints for interactive actions for use by integrations."},{"name":"terms of service","description":"Endpoints for getting and updating custom terms of service."}],"x-tagGroups":[{"name":"Overview","tags":["introduction","schema","APIv3 Deprecation"]},{"name":"Standard Features","tags":["drivers","authentication","errors","rate limiting","WebSocket"]},{"name":"Endpoints","tags":["users","bots","teams","channels","posts","files","preferences","status","emoji","reactions","webhooks","commands","OpenGraph","system","brand","OAuth","SAML","LDAP","groups","compliance","cluster","elasticsearch","dataretention","jobs","plugins","roles","schemes","integration_actions","terms of service"]}],"servers":[{"url":"http://your-mattermost-url.com/api/v4"},{"url":"https://your-mattermost-url.com/api/v4"}],"paths":{"/users":{"post":{"tags":["users"],"summary":"Create a user","description":"Create a new user on the system. Password is required for email login. For other authentication types such as LDAP or SAML, auth_data and auth_service fields are required.\n##### Permissions\nNo permission required but user creation can be controlled by server configuration.\n","parameters":[{"name":"t","in":"query","description":"Token id from an email invitation","required":false,"schema":{"type":"string"}},{"name":"iid","in":"query","description":"Token id from an invitation link","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email","username"],"properties":{"email":{"type":"string"},"username":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"nickname":{"type":"string"},"auth_data":{"description":"Service-specific authentication data, such as email address.","type":"string"},"auth_service":{"description":"The authentication service, one of \"email\", \"gitlab\", \"ldap\", \"saml\", \"office365\", \"google\", and \"\".","type":"string"},"password":{"description":"The password used for email authentication.","type":"string"},"locale":{"type":"string"},"props":{"type":"object"},"notify_props":{"$ref":"#/components/schemas/UserNotifyProps"}}}}},"description":"User object to be created","required":true},"responses":{"201":{"description":"User creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\n\nuser := &model.User{\n Username: \"username\",\n Email: \"email@domain.com\",\n Password: \"Password1\",\n}\n\ncreatedUser, response := Client.CreateUser(user)\n"}]},"get":{"tags":["users"],"summary":"Get users","description":"Get a page of a list of users. Based on query string parameters, select users from a team, channel, or select users not in a specific channel.\n\nSince server version 4.0, some basic sorting is available using the `sort` query parameter. Sorting is currently only supported when selecting users on a team.\n##### Permissions\nRequires an active session and (if specified) membership to the channel or team being selected from.\n","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of users per page. There is a maximum limit of 200 users per page.","schema":{"type":"integer","default":60}},{"name":"in_team","in":"query","description":"The ID of the team to get users for.","schema":{"type":"string"}},{"name":"not_in_team","in":"query","description":"The ID of the team to exclude users for. Must not be used with \"in_team\" query parameter.","schema":{"type":"string"}},{"name":"in_channel","in":"query","description":"The ID of the channel to get users for.","schema":{"type":"string"}},{"name":"not_in_channel","in":"query","description":"The ID of the channel to exclude users for. Must be used with \"in_channel\" query parameter.","schema":{"type":"string"}},{"name":"group_constrained","in":"query","description":"When used with `not_in_channel` or `not_in_team`, returns only the users that are allowed to join the channel or team based on its group constrains.","schema":{"type":"boolean"}},{"name":"without_team","in":"query","description":"Whether or not to list users that are not on any team. This option takes precendence over `in_team`, `in_channel`, and `not_in_channel`.","schema":{"type":"boolean"}},{"name":"sort","in":"query","description":"Sort is only available in conjunction with certain options below. The paging parameter is also always available.\n\n##### `in_team`\nCan be \"\", \"last_activity_at\" or \"create_at\".\nWhen left blank, sorting is done by username.\n__Minimum server version__: 4.0\n##### `in_channel`\nCan be \"\", \"status\".\nWhen left blank, sorting is done by username. `status` will sort by User's current status (Online, Away, DND, Offline), then by Username.\n__Minimum server version__: 4.7\n","schema":{"type":"string"}}],"responses":{"200":{"description":"User page retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n\n// page, perPage, etag\nusers := Client.GetUsers(0, 60, \"\")\nusers = Client.GetUsersInChannel(\"channelid\", 0, 60, \"\")\nusers = Client.GetUsersNotInChannel(\"teamid\", \"channelid\", 0, 60, \"\")\nusers = Client.GetUsersInTeam(\"teamid\", 0, 60, \"\")\nusers = Client.GetUsersNotInTeam(\"teamid\", 0, 60, \"\")\nusers = Client.GetUsersWithoutTeam(0, 60, \"\")\n"}]}},"/users/ids":{"post":{"tags":["users"],"summary":"Get users by ids","description":"Get a list of users based on a provided list of user ids.\n##### Permissions\nRequires an active session but no other permissions.\n","parameters":[{"name":"since","in":"query","description":"Only return users that have been modified since the given Unix timestamp (in milliseconds).\n\n__Minimum server version__: 5.14\n","schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of user ids","required":true},"responses":{"200":{"description":"User list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/users/group_channels":{"post":{"tags":["users"],"summary":"Get users by group channels ids","description":"Get an object containing a key per group channel id in the\nquery and its value as a list of users members of that group\nchannel.\n\nThe user must be a member of the group ids in the query, or\nthey will be omitted from the response.\n##### Permissions\nRequires an active session but no other permissions.\n\n__Minimum server version__: 5.14\n","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of group channel ids","required":true},"responses":{"200":{"description":"User list retrieval successful","content":{"application/json":{"schema":{"type":"object","properties":{"<CHANNEL_ID>":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/users/usernames":{"post":{"tags":["users"],"summary":"Get users by usernames","description":"Get a list of users based on a provided list of usernames.\n##### Permissions\nRequires an active session but no other permissions.\n","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of usernames","required":true},"responses":{"200":{"description":"User list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nusers, resp := Client.GetUsersByUsernames([]string{\"username1\", \"username2\"})\n"}]}},"/users/search":{"post":{"tags":["users"],"summary":"Search users","description":"Get a list of users based on search criteria provided in the request body. Searches are typically done against username, full name, nickname and email unless otherwise configured by the server.\n##### Permissions\nRequires an active session and `read_channel` and/or `view_team` permissions for any channels or teams specified in the request body.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["term"],"properties":{"term":{"description":"The term to match against username, full name, nickname and email","type":"string"},"team_id":{"description":"If provided, only search users on this team","type":"string"},"not_in_team_id":{"description":"If provided, only search users not on this team","type":"string"},"in_channel_id":{"description":"If provided, only search users in this channel","type":"string"},"not_in_channel_id":{"description":"If provided, only search users not in this channel. Must specifiy `team_id` when using this option","type":"string"},"group_constrained":{"description":"When used with `not_in_channel_id` or `not_in_team_id`, returns only the users that are allowed to join the channel or team based on its group constrains.","type":"boolean"},"allow_inactive":{"description":"When `true`, include deactivated users in the results","type":"boolean"},"without_team":{"type":"boolean","description":"Set this to `true` if you would like to search for users that are not on a team. This option takes precendence over `team_id`, `in_channel_id`, and `not_in_channel_id`."},"limit":{"description":"The maximum number of users to return in the results\n\n__Available as of server version 5.6. Defaults to `100` if not provided or on an earlier server version.__\n","type":"integer","default":100}}}}},"description":"Search criteria","required":true},"responses":{"200":{"description":"User list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"4xp9fdt77pncbef59f4k1qe83o\"\nteamID2 := \"JhMjDX9rAlCdBf0l9oyq4eGhxw\"\nchannelID := \"Ej3SKOHlWIKAblkUTK5Xvkj2cm\"\nchannelID2 := \"dWdfrUSdjJ7kyBvyBCgCav67Kz\"\n\nusers, resp := Client.SearchUsers(&model.UserSearch{\n Term: \"searchTerm\",\n TeamId: teamID,\n NotInTeamId: teamID2,\n InChannelId: channelID,\n NotInChannelId: channelID2,\n AllowInactive: true,\n WithoutTeam: true,\n Limit: 100,\n Role: \"admin\",\n})\n"}]}},"/users/autocomplete":{"get":{"tags":["users"],"summary":"Autocomplete users","description":"Get a list of users for the purpose of autocompleting based on the provided search term. Specify a combination of `team_id` and `channel_id` to filter results further.\n##### Permissions\nRequires an active session and `view_team` and `read_channel` on any teams or channels used to filter the results further.\n","parameters":[{"name":"team_id","in":"query","description":"Team ID","schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID","schema":{"type":"string"}},{"name":"name","in":"query","description":"Username, nickname first name or last name","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The maximum number of users to return in each subresult\n\n__Available as of server version 5.6. Defaults to `100` if not provided or on an earlier server version.__\n","schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"User autocomplete successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAutocomplete"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"4xp9fdt77pncbef59f4k1qe83o\"\nchannelID := \"Ej3SKOHlWIKAblkUTK5Xvkj2cm\"\nusername := \"testUsername\"\n\nusers, resp := Client.AutocompleteUsersInChannel(teamID, channelID, username, 100, \"\")\n"}]}},"/users/stats":{"get":{"tags":["users"],"summary":"Get total count of users in the system","description":"Get a total count of users in the system.\n##### Permissions\nMust be authenticated.\n","responses":{"200":{"description":"User stats retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersStats"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nstats, resp := Client.GetTotalUsersStats(\"\")\n"}]}},"/users/{user_id}":{"get":{"tags":["users"],"summary":"Get a user","description":"Get a user a object. Sensitive information will be sanitized out.\n##### Permissions\nRequires an active session but no other permissions.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\nuser, resp := Client.GetUser(userID, \"\")\n"}]},"put":{"tags":["users"],"summary":"Update a user","description":"Update a user by providing the user object. The fields that can be updated are defined in the request body, all other provided fields will be ignored. Any fields not included in the request body will be set to null or reverted to default values.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"email":{"type":"string"},"username":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"nickname":{"type":"string"},"locale":{"type":"string"},"position":{"type":"string"},"props":{"type":"object"},"notify_props":{"$ref":"#/components/schemas/UserNotifyProps"}}}}},"description":"User object that is to be updated","required":true},"responses":{"200":{"description":"User update successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"4xp9fdt77pncbef59f4k1qe83o\"\nemail := \"test@domain.com\"\nusername := \"testUsername\"\nfirstName := \"testFirstname\"\nlastName := \"testLastname\"\nnickname := \"testNickname\"\nlocale := \"en\"\nposition := \"testPosition\"\nprops := model.StringMap{}\nprops[\"testPropKey\"] = \"testPropValue\"\nnotifyProps := model.StringMap{}\nnotifyProps[\"comment\"] = \"somethingrandom\"\n\nuser, resp := Client.UpdateUser(&model.User{\n Id: userID,\n Email: email,\n Username: username,\n FirstName: firstName,\n LastName: lastName,\n Nickname: nickname,\n Locale: locale,\n Position: position,\n Props: props,\n NotifyProps: notifyProps,\n})\n"}]},"delete":{"tags":["users"],"summary":"Deactivate a user account.","description":"Deactivates the user and revokes all its sessions by archiving its user object.\n##### Permissions\nMust be logged in as the user being deactivated or have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User deactivation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\nok, resp := Client.DeleteUser(userID)\n"}]}},"/users/{user_id}/patch":{"put":{"tags":["users"],"summary":"Patch a user","description":"Partially update a user by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"username":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"nickname":{"type":"string"},"locale":{"type":"string"},"position":{"type":"string"},"props":{"type":"object"},"notify_props":{"$ref":"#/components/schemas/UserNotifyProps"}}}}},"description":"User object that is to be updated","required":true},"responses":{"200":{"description":"User patch successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\npatch := &model.UserPatch{}\npatch.Email = model.NewString(\"test@domain.com\")\npatch.Username = model.NewString(\"testUsername\")\npatch.FirstName = model.NewString(\"testFirstname\")\npatch.LastName = model.NewString(\"testLastname\")\npatch.Nickname = model.NewString(\"testNickname\")\npatch.Locale = model.NewString(\"en\")\npatch.Position = model.NewString(\"testPosition\")\npatch.Props = model.StringMap{}\npatch.Props[\"testPropKey\"] = \"testPropValue\"\npatch.NotifyProps = model.StringMap{}\npatch.NotifyProps[\"comment\"] = \"somethingrandom\"\n\nuser, resp := Client.PatchUser(userID, patch)\n"}]}},"/users/{user_id}/roles":{"put":{"tags":["users"],"summary":"Update a user's roles","description":"Update a user's system-level roles. Valid user roles are \"system_user\", \"system_admin\" or both of them. Overwrites any previously assigned system-level roles.\n##### Permissions\nMust have the `manage_roles` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["roles"],"properties":{"roles":{"type":"string"}}}}},"description":"Space-delimited system roles to assign to the user","required":true},"responses":{"200":{"description":"User roles update successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"4xp9fdt77pncbef59f4k1qe83o\"\nroles := \"team_user team_admin\"\n\nok, resp = Client.UpdateUserRoles(userID, roles)\n"}]}},"/users/{user_id}/active":{"put":{"tags":["users"],"summary":"Update user active status","description":"Update user active or inactive status.\n\n__Since server version 4.6, users using a SSO provider to login can be activated or deactivated with this endpoint. However, if their activation status in Mattermost does not reflect their status in the SSO provider, the next synchronization or login by that user will reset the activation status to that of their account in the SSO provider. Server versions 4.5 and before do not allow activation or deactivation of SSO users from this endpoint.__\n##### Permissions\nUser can deactivate themselves.\nUser with `manage_system` permission can activate or deactivate a user.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["active"],"properties":{"active":{"type":"boolean"}}}}},"description":"Use `true` to set the user active, `false` for inactive","required":true},"responses":{"200":{"description":"User active status update successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\nok, resp := Client.UpdateUserActive(userID, true)\n"}]}},"/users/{user_id}/image":{"get":{"tags":["users"],"summary":"Get user's profile image","description":"Get a user's profile image based on user_id string parameter.\n##### Permissions\nMust be logged in.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User's profile image"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\ndata, resp := Client.GetProfileImage(userID, \"\")\n"}]},"post":{"tags":["users"],"summary":"Set user's profile image","description":"Set a user's profile image based on user_id string parameter.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"description":"The image to be uploaded","type":"string","format":"binary"}},"required":["image"]}}}},"responses":{"200":{"description":"Profile image set successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import (\n \"io/ioutil\"\n \"log\"\n\n \"github.com/mattermost/mattermost-server/model\"\n)\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\ndata, err := ioutil.ReadFile(\"profile_pic.png\")\nif err != nil {\n log.Fatal(err)\n}\n\nuserID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\nok, resp := Client.SetProfileImage(userID, data)\n"}]},"delete":{"tags":["users"],"summary":"Delete user's profile image","description":"Delete user's profile image and reset to default image based on user_id string parameter.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n__Minimum server version__: 5.5\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Profile image reset successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\n// Deleting user's profile image consists on resetting it to default one\nok, resp := Client.SetDefaultProfileImage(userID)\n"}]}},"/users/{user_id}/image/default":{"get":{"tags":["users"],"summary":"Return user's default (generated) profile image","description":"Returns the default (generated) user profile image based on user_id string parameter.\n##### Permissions\nMust be logged in.\n__Minimum server version__: 5.5\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Default profile image"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\nok, resp := Client.SetDefaultProfileImage(userID)\n"}]}},"/users/username/{username}":{"get":{"tags":["users"],"summary":"Get a user by username","description":"Get a user object by providing a username. Sensitive information will be sanitized out.\n##### Permissions\nRequires an active session but no other permissions.\n","parameters":[{"name":"username","in":"path","description":"Username","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\nuser, resp := Client.GetUserByUsername(userID, \"\")\n"}]}},"/users/password/reset":{"post":{"tags":["users"],"summary":"Reset password","description":"Update the password for a user using a one-use, timed recovery code tied to the user's account. Only works for non-SSO users.\n##### Permissions\nNo permissions required.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["code","new_password"],"properties":{"code":{"description":"The recovery code","type":"string"},"new_password":{"description":"The new password for the user","type":"string"}}}}},"required":true},"responses":{"200":{"description":"User password update successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\ncode := \"4xp9fdt77pncbef59f4k1qe83o\"\nnewPassword := \"awesomePassword\"\n\nsuccess, resp = Client.ResetPassword(code, newPassword)\n"}]}},"/users/{user_id}/mfa":{"put":{"tags":["users"],"summary":"Update a user's MFA","description":"Activates multi-factor authentication for the user if `activate` is true and a valid `code` is provided. If activate is false, then `code` is not required and multi-factor authentication is disabled for the user.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["activate"],"properties":{"activate":{"description":"Use `true` to activate, `false` to deactivate","type":"boolean"},"code":{"description":"The code produced by your MFA client. Required if `activate` is true","type":"string"}}}}},"required":true},"responses":{"200":{"description":"User MFA update successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"BbaYBYDV5IDOZFiJGBSzkw1k5u\"\ncode := \"4xp9fdt77pncbef59f4k1qe83o\"\n\nok, resp := Client.UpdateUserMfa(userID, code, true)\n"}]}},"/users/{user_id}/mfa/generate":{"post":{"tags":["users"],"summary":"Generate MFA secret","description":"Generates an multi-factor authentication secret for a user and returns it as a string and as base64 encoded QR code image.\n##### Permissions\nMust be logged in as the user or have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"MFA secret generation successful","content":{"application/json":{"schema":{"type":"object","properties":{"secret":{"description":"The MFA secret as a string","type":"string"},"qr_code":{"description":"A base64 encoded QR code image","type":"string"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"BbaYBYDV5IDOZFiJGBSzkw1k5u\"\n\nmfaSecret, resp = Client.GenerateMfaSecret(userID)\n"}]}},"/users/{user_id}/demote":{"post":{"tags":["users"],"summary":"Demote a user to a guest","description":"Convert a regular user into a guest. This will convert the user into a\nguest for the whole system while retaining their existing team and\nchannel memberships.\n\n__Minimum server version__: 5.16\n\n##### Permissions\nMust be logged in as the user or have the `demote_to_guest` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User successfully demoted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"BbaYBYDV5IDOZFiJGBSzkw1k5u\"\n\nok, resp = Client.demoteUserToGuest(userID)\n"}]}},"/users/{user_id}/promote":{"post":{"tags":["users"],"summary":"Promote a guest to user","description":"Convert a guest into a regular user. This will convert the guest into a\nuser for the whole system while retaining any team and channel\nmemberships and automatically joining them to the default channels.\n\n__Minimum server version__: 5.16\n\n##### Permissions\nMust be logged in as the user or have the `promote_guest` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Guest successfully promoted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"BbaYBYDV5IDOZFiJGBSzkw1k5u\"\n\nok, resp = Client.PromoteGuestToUser(userID)\n"}]}},"/users/mfa":{"post":{"tags":["users"],"summary":"Check MFA","description":"Check if a user has multi-factor authentication active on their account by providing a login id. Used to check whether an MFA code needs to be provided when logging in.\n##### Permissions\nNo permission required.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["login_id"],"properties":{"login_id":{"description":"The email or username used to login","type":"string"}}}}},"required":true},"responses":{"200":{"description":"MFA check successful","content":{"application/json":{"schema":{"type":"object","properties":{"mfa_required":{"description":"Value will `true` if MFA is active, `false` otherwise","type":"boolean"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\n\nloginID := \"test@domain.com\"\n\nrequired, resp := Client.CheckUserMfa(loginID)\n"}]}},"/users/{user_id}/password":{"put":{"tags":["users"],"summary":"Update a user's password","description":"Update a user's password. New password must meet password policy set by server configuration. Current password is required if you're updating your own password.\n##### Permissions\nMust be logged in as the user the password is being changed for or have `manage_system` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["new_password"],"properties":{"current_password":{"description":"The current password for the user","type":"string"},"new_password":{"description":"The new password for the user","type":"string"}}}}},"required":true},"responses":{"200":{"description":"User password update successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"BbaYBYDV5IDOZFiJGBSzkw1k5u\"\ncurrentPassword := \"badPassword\"\nnewPassword := \"awesomePassword\"\n\nok, resp := Client.UpdateUserPassword(userID, currentPassword, newPassword)\n"}]}},"/users/password/reset/send":{"post":{"tags":["users"],"summary":"Send password reset email","description":"Send an email containing a link for resetting the user's password. The link will contain a one-use, timed recovery code tied to the user's account. Only works for non-SSO users.\n##### Permissions\nNo permissions required.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"description":"The email of the user","type":"string"}}}}},"required":true},"responses":{"200":{"description":"Email sent if account exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\n\nemail := \"test@domain.com\"\n\npass, resp := Client.SendVerificationEmail(email)\n"}]}},"/users/email/{email}":{"get":{"tags":["users"],"summary":"Get a user by email","description":"Get a user object by providing a user email. Sensitive information will be sanitized out.\n##### Permissions\nRequires an active session and for the current session to be able to view another user's email based on the server's privacy settings.\n","parameters":[{"name":"email","in":"path","description":"User Email","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nemail := \"test@domain.com\"\n\nuser, resp := Client.GetUserByEmail(email, \"\")\n"}]}},"/users/{user_id}/sessions":{"get":{"tags":["users"],"summary":"Get user's sessions","description":"Get a list of sessions by providing the user GUID. Sensitive information will be sanitized out.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User session retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Session"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\n\nsessions, resp := Client.GetSessions(userID, \"\")\n"}]}},"/users/{user_id}/sessions/revoke":{"post":{"tags":["users"],"summary":"Revoke a user session","description":"Revokes a user session from the provided user id and session id strings.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["session_id"],"properties":{"session_id":{"description":"The session GUID to revoke.","type":"string"}}}}},"required":true},"responses":{"200":{"description":"User session revoked successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\nsessionID := \"adWv1qPZmHdtxk7Lmqh6RtxWxS\"\n\nok, resp = Client.RevokeSession(userID, sessionID)\n"}]}},"/users/{user_id}/sessions/revoke/all":{"post":{"tags":["users"],"summary":"Revoke all active sessions for a user","description":"Revokes all user sessions from the provided user id and session id strings.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n__Minimum server version__: 4.4\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User sessions revoked successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\n\nok, resp := Client.RevokeAllSessions(userID)\n"}]}},"/users/sessions/device":{"put":{"tags":["users"],"summary":"Attach mobile device","description":"Attach a mobile device id to the currently logged in session. This will enable push notifications for a user, if configured by the server.\n##### Permissions\nMust be authenticated.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["device_id"],"properties":{"device_id":{"description":"Mobile device id. For Android prefix the id with `android:` and Apple with `apple:`","type":"string"}}}}},"required":true},"responses":{"200":{"description":"Device id attach successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\ndeviceID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\n\npass, resp := Client.AttachDeviceId(deviceID)\n"}]}},"/users/{user_id}/audits":{"get":{"tags":["users"],"summary":"Get user's audits","description":"Get a list of audit by providing the user GUID.\n##### Permissions\nMust be logged in as the user or have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User audits retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Audit"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\n\naudits, resp := Client.GetUserAudits(userID, 0, 100, \"\")\n"}]}},"/users/email/verify":{"post":{"tags":["users"],"summary":"Verify user email","description":"Verify the email used by a user to sign-up their account with.\n##### Permissions\nNo permissions required.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["token"],"properties":{"token":{"description":"The token given to validate the email","type":"string"}}}}},"required":true},"responses":{"200":{"description":"User email verification successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\n\ntoken := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\n\nok, resp := Client.VerifyUserEmail(token)\n"}]}},"/users/email/verify/send":{"post":{"tags":["users"],"summary":"Send verification email","description":"Send an email with a verification link to a user that has an email matching the one in the request body. This endpoint will return success even if the email does not match any users on the system.\n##### Permissions\nNo permissions required.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"description":"Email of a user","type":"string"}}}}},"required":true},"responses":{"200":{"description":"Email send successful if email exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\n\nemail := \"test@domain.com\"\n\npass, resp := Client.SendVerificationEmail(email)\n"}]}},"/users/login/switch":{"post":{"tags":["users"],"summary":"Switch login method","description":"Switch a user's login method from using email to OAuth2/SAML/LDAP or back to email. When switching to OAuth2/SAML, account switching is not complete until the user follows the returned link and completes any steps on the OAuth2/SAML service provider.\n\nTo switch from email to OAuth2/SAML, specify `current_service`, `new_service`, `email` and `password`.\n\nTo switch from OAuth2/SAML to email, specify `current_service`, `new_service`, `email` and `new_password`.\n\nTo switch from email to LDAP/AD, specify `current_service`, `new_service`, `email`, `password`, `ldap_ip` and `new_password` (this is the user's LDAP password).\n\nTo switch from LDAP/AD to email, specify `current_service`, `new_service`, `ldap_ip`, `password` (this is the user's LDAP password), `email` and `new_password`.\n\nAdditionally, specify `mfa_code` when trying to switch an account on LDAP/AD or email that has MFA activated.\n\n##### Permissions\nNo current authentication required except when switching from OAuth2/SAML to email.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["current_service","new_service"],"properties":{"current_service":{"description":"The service the user currently uses to login","type":"string"},"new_service":{"description":"The service the user will use to login","type":"string"},"email":{"description":"The email of the user","type":"string"},"password":{"description":"The password used with the current service","type":"string"},"mfa_code":{"description":"The MFA code of the current service","type":"string"},"ldap_id":{"description":"The LDAP/AD id of the user","type":"string"}}}}},"required":true},"responses":{"200":{"description":"Login method switch or request successful","content":{"application/json":{"schema":{"type":"object","properties":{"follow_link":{"description":"The link for the user to follow to login or to complete the account switching when the current service is OAuth2/SAML","type":"string"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\n\ncurrentService := \"email\"\nnewService := \"gitlab\"\nemail := \"test@domain.com\"\npassword := \"awesomePassword\"\nmfaCode := \"adWv1qPZmHdtxk7Lmqh6RtxWxS\"\nldapLoginID := \"RdDjEDlkWgt7ndjyVLwWGvnX8c\"\n\n\nlink, resp := Client.SwitchAccountType(&model.SwitchRequest{\n CurrentService: currentService,\n NewService: newService,\n Email: email,\n Password: password,\n MfaCode: mfaCode,\n LdapLoginId: ldapLoginID,\n})\n"}]}},"/users/{user_id}/tokens":{"post":{"tags":["users"],"summary":"Create a user access token","description":"Generate a user access token that can be used to authenticate with the Mattermost REST API.\n\n__Minimum server version__: 4.1\n\n##### Permissions\nMust have `create_user_access_token` permission. For non-self requests, must also have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["description"],"properties":{"description":{"description":"A description of the token usage","type":"string"}}}}},"required":true},"responses":{"201":{"description":"User access token creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccessToken"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"adWv1qPZmHdtxk7Lmqh6RtxWxS\"\n\nuserAccessToken, resp := Client.CreateUserAccessToken(userID, \"test token\")\n"}]},"get":{"tags":["users"],"summary":"Get user access tokens","description":"Get a list of user access tokens for a user. Does not include the actual authentication tokens. Use query parameters for paging.\n\n__Minimum server version__: 4.1\n\n##### Permissions\nMust have `read_user_access_token` permission. For non-self requests, must also have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of tokens per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"User access tokens retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserAccessTokenSanitized"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"adWv1qPZmHdtxk7Lmqh6RtxWxS\"\n\ntokens, resp := Client.GetUserAccessTokensForUser(userID, 0, 100)\n"}]}},"/users/tokens":{"get":{"tags":["users"],"summary":"Get user access tokens","description":"Get a page of user access tokens for users on the system. Does not include the actual authentication tokens. Use query parameters for paging.\n\n__Minimum server version__: 4.7\n\n##### Permissions\nMust have `manage_system` permission.\n","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of tokens per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"User access tokens retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserAccessTokenSanitized"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\ntokens, resp := Client.GetUserAccessTokens(0, 100)\n"}]}},"/users/tokens/revoke":{"post":{"tags":["users"],"summary":"Revoke a user access token","description":"Revoke a user access token and delete any sessions using the token.\n\n__Minimum server version__: 4.1\n\n##### Permissions\nMust have `revoke_user_access_token` permission. For non-self requests, must also have the `edit_other_users` permission.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["token_id"],"properties":{"token_id":{"description":"The user access token GUID to revoke","type":"string"}}}}},"required":true},"responses":{"200":{"description":"User access token revoke successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\ntokenID := \"adWv1qPZmHdtxk7Lmqh6RtxWxS\"\n\nok, resp := Client.RevokeUserAccessToken(tokenID)\n"}]}},"/users/tokens/{token_id}":{"get":{"tags":["users"],"summary":"Get a user access token","description":"Get a user access token. Does not include the actual authentication token.\n\n__Minimum server version__: 4.1\n\n##### Permissions\nMust have `read_user_access_token` permission. For non-self requests, must also have the `edit_other_users` permission.\n","parameters":[{"name":"token_id","in":"path","description":"User access token GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User access token retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccessTokenSanitized"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\ntokenID := \"adWv1qPZmHdtxk7Lmqh6RtxWxS\"\n\ntoken, resp := Client.GetUserAccessToken(tokenID)\n"}]}},"/users/tokens/disable":{"post":{"tags":["users"],"summary":"Disable personal access token","description":"Disable a personal access token and delete any sessions using the token. The token can be re-enabled using `/users/tokens/enable`.\n\n__Minimum server version__: 4.4\n\n##### Permissions\nMust have `revoke_user_access_token` permission. For non-self requests, must also have the `edit_other_users` permission.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["token_id"],"properties":{"token_id":{"description":"The personal access token GUID to disable","type":"string"}}}}},"required":true},"responses":{"200":{"description":"Personal access token disable successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\ntokenID := \"adWv1qPZmHdtxk7Lmqh6RtxWxS\"\n\nok, resp := Client.DisableUserAccessToken(tokenID)\n"}]}},"/users/tokens/enable":{"post":{"tags":["users"],"summary":"Enable personal access token","description":"Re-enable a personal access token that has been disabled.\n\n__Minimum server version__: 4.4\n\n##### Permissions\nMust have `create_user_access_token` permission. For non-self requests, must also have the `edit_other_users` permission.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["token_id"],"properties":{"token_id":{"description":"The personal access token GUID to enable","type":"string"}}}}},"required":true},"responses":{"200":{"description":"Personal access token enable successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\ntokenID := \"adWv1qPZmHdtxk7Lmqh6RtxWxS\"\n\nok, resp := Client.EnableUserAccessToken(tokenID)\n"}]}},"/users/tokens/search":{"post":{"tags":["users"],"summary":"Search tokens","description":"Get a list of tokens based on search criteria provided in the request body. Searches are done against the token id, user id and username.\n\n__Minimum server version__: 4.7\n\n##### Permissions\nMust have `manage_system` permission.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["term"],"properties":{"term":{"description":"The search term to match against the token id, user id or username.","type":"string"}}}}},"description":"Search criteria","required":true},"responses":{"200":{"description":"Personal access token search successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserAccessTokenSanitized"}}}}}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\ntokenID := \"adWv1qPZmHdtxk7Lmqh6RtxWxS\"\n\nuserAccessTokens, resp = Client.SearchUserAccessTokens(&model.UserAccessTokenSearch{Term: tokenID})\n"}]}},"/users/{user_id}/auth":{"put":{"tags":["users"],"summary":"Update a user's authentication method","description":"Updates a user's authentication method. This can be used to change them to/from LDAP authentication for example.\n\n__Minimum server version__: 4.6\n##### Permissions\nMust have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAuthData"}}},"required":true},"responses":{"200":{"description":"User auth update successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAuthData"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"adWv1qPZmHdtxk7Lmqh6RtxWxS\"\nuser, resp := Client.GetUser(userID, \"\")\nuserAuth := &model.UserAuth{}\nuserAuth.AuthData = user.AuthData\nuserAuth.AuthService = user.AuthService\nuserAuth.Password = user.Password\n\nuser, resp := Client.UpdateUserAuth(userID, userAuth)\n"}]}},"/users/{user_id}/terms_of_service":{"post":{"tags":["users","terms of service"],"summary":"Records user action when they accept or decline custom terms of service","description":"Records user action when they accept or decline custom terms of service. Records the action in audit table.\nUpdates user's last accepted terms of service ID if they accepted it.\n\n__Minimum server version__: 5.4\n##### Permissions\nMust be logged in as the user being acted on.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["serviceTermsId","accepted"],"properties":{"serviceTermsId":{"description":"terms of service ID on which the user is acting on","type":"string"},"accepted":{"description":"true or false, indicates whether the user accepted or rejected the terms of service.","type":"string"}}}}},"description":"terms of service details","required":true},"responses":{"200":{"description":"Terms of service action recorded successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"adWv1qPZmHdtxk7Lmqh6RtxWxS\"\nserviceTermsID := \"RdDjEDlkWgt7ndjyVLwWGvnX8c\"\n\nsuccess, resp = Client.RegisterTermsOfServiceAction(userID, serviceTermsID, true)\n"}]},"get":{"tags":["users","terms of service"],"summary":"Fetches user's latest terms of service action if the latest action was for acceptance.","description":"Will be deprecated in v6.0\nFetches user's latest terms of service action if the latest action was for acceptance.\n\n__Minimum server version__: 5.6\n##### Permissions\nMust be logged in as the user being acted on.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User's accepted terms of service action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTermsOfService"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"User hasn't performed an action or the latest action was a rejection.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppError"}}}}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"adWv1qPZmHdtxk7Lmqh6RtxWxS\"\n\nuserTermsOfService, resp := Client.GetUserTermsOfService(userID, \"\")\n"}]}},"/users/sessions/revoke/all":{"post":{"tags":["users"],"summary":"Revoke all sessions from all users.","description":"For any session currently on the server (including admin) it will be revoked.\nClients will be notified to log out users.\n\n__Minimum server version__: 5.14\n\n##### Permissions\n\nMust have `manage_system` permission.\n","responses":{"200":{"description":"Sessions successfully revoked."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nresponse, err := Client.RevokeSessionsFromAllUsers()\n"}]}},"/users/{user_id}/status":{"get":{"tags":["status"],"summary":"Get user status","description":"Get user status by id from the server.\n##### Permissions\nMust be authenticated.\n","parameters":[{"name":"user_id","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User status retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Status"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}},"put":{"tags":["status"],"summary":"Update user status","description":"Manually set a user's status. When setting a user's status, the status will remain that value until set \"online\" again, which will return the status to being automatically updated based on user activity.\n##### Permissions\nMust have `edit_other_users` permission for the team.\n","parameters":[{"name":"user_id","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["status","user_id"],"properties":{"user_id":{"type":"string","description":"User ID"},"status":{"type":"string","description":"User status, can be `online`, `away`, `offline` and `dnd`"}}}}},"description":"Status object that is to be updated","required":true},"responses":{"200":{"description":"User status update successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Status"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/users/status/ids":{"post":{"tags":["status"],"summary":"Get user statuses by id","description":"Get a list of user statuses by id from the server.\n##### Permissions\nMust be authenticated.\n","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of user ids to fetch","required":true},"responses":{"200":{"description":"User statuses retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Status"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/teams":{"post":{"tags":["teams"],"summary":"Create a team","description":"Create a new team on the system.\n##### Permissions\nMust be authenticated and have the `create_team` permission.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","display_name","type"],"properties":{"name":{"type":"string","description":"Unique handler for a team, will be present in the team URL"},"display_name":{"type":"string","description":"Non-unique UI name for the team"},"type":{"type":"string","description":"`'O'` for open, `'I'` for invite only"}}}}},"description":"Team that is to be created","required":true},"responses":{"201":{"description":"Team creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nnewTeam, err := Client.CreateTeam(&model.Team{\n Name: \"teamName\",\n DisplayName: \"TeamDisplayName\",\n Type: \"O\",\n})\n"}]},"get":{"tags":["teams"],"summary":"Get teams","description":"For regular users only returns open teams. Users with the \"manage_system\" permission will return teams regardless of type. The result is based on query string parameters - page and per_page.\n##### Permissions\nMust be authenticated. \"manage_system\" permission is required to show all teams.\n","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of teams per page.","schema":{"type":"integer","default":60}},{"name":"include_total_count","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Team list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Team"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteams, resp := Client.GetAllTeams(\"\", 0, 100)\n"}]}},"/teams/{team_id}":{"get":{"tags":["teams"],"summary":"Get a team","description":"Get a team on the system.\n##### Permissions\nMust be authenticated and have the `view_team` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\nt, err := Client.GetTeam(teamID, \"\")\n"}]},"put":{"tags":["teams"],"summary":"Update a team","description":"Update a team by providing the team object. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n##### Permissions\nMust have the `manage_team` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","display_name","description","company_name","allowed_domains","invite_id","allow_open_invite"],"properties":{"id":{"type":"string"},"display_name":{"type":"string"},"description":{"type":"string"},"company_name":{"type":"string"},"allowed_domains":{"type":"string"},"invite_id":{"type":"string"},"allow_open_invite":{"type":"string"}}}}},"description":"Team to update","required":true},"responses":{"200":{"description":"Team update successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"4xp9fdt77pncbef59f4k1qe83o\"\ninviteID := \"qjda3stwafbgpqjaxej3k76sga\"\n\nuteam, resp := Client.UpdateTeam(&model.Team{\n Id: teamID,\n DisplayName: \"displayName\",\n Description: \"description\",\n CompanyName: \"companyName\",\n AllowedDomains: \"allowedDomains\",\n InviteId: inviteID,\n AllowOpenInvite: false,\n})\n"}]},"delete":{"tags":["teams"],"summary":"Delete a team","description":"Soft deletes a team, by marking the team as deleted in the database. Soft deleted teams will not be accessible in the user interface.\n\nOptionally use the permanent query parameter to hard delete the team for compliance reasons. As of server version 5.0, to use this feature `ServiceSettings.EnableAPITeamDeletion` must be set to `true` in the server's configuration.\n##### Permissions\nMust have the `manage_team` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"permanent","in":"query","description":"Permanently delete the team, to be used for compliance reasons only. As of server version 5.0, `ServiceSettings.EnableAPITeamDeletion` must be set to `true` in the server's configuration.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Team deletion successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\n// Non-permanent deletion\nok, resp := Client.SoftDeleteTeam(&model.Team{Id: teamID})\n\n// Permanent deletion\nok, resp := Client.PermanentDeleteTeam(&model.Team{Id: teamID})\n"}]}},"/teams/{team_id}/patch":{"put":{"tags":["teams"],"summary":"Patch a team","description":"Partially update a team by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n##### Permissions\nMust have the `manage_team` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"display_name":{"type":"string"},"description":{"type":"string"},"company_name":{"type":"string"},"invite_id":{"type":"string"},"allow_open_invite":{"type":"boolean"}}}}},"description":"Team object that is to be updated","required":true},"responses":{"200":{"description":"team patch successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\npatch := &model.TeamPatch{}\npatch.DisplayName = model.NewString(\"Other name\")\npatch.Description = model.NewString(\"Other description\")\npatch.CompanyName = model.NewString(\"Other company name\")\npatch.AllowOpenInvite = model.NewBool(true)\n\nteamID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\nteam, resp := Client.PatchTeam(teamID, patch)\n"}]}},"/teams/name/{name}":{"get":{"tags":["teams"],"summary":"Get a team by name","description":"Get a team based on provided name string\n##### Permissions\nMust be authenticated, team type is open and have the `view_team` permission.\n","parameters":[{"name":"name","in":"path","description":"Team Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteam, resp := Client.GetTeamByName(\"teamName\", \"\")\n"}]}},"/teams/search":{"post":{"tags":["teams"],"summary":"Search teams","description":"Search teams based on search term provided in the request body.\n##### Permissions\nLogged in user only shows open teams\nLogged in user with \"manage_system\" permission shows all teams\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["term"],"properties":{"term":{"description":"The search term to match against the name or display name of teams","type":"string"},"page":{"type":"string","description":"The page number to return, if paginated. If this parameter is not present with the `per_page` parameter then the results will be returned un-paged."},"per_page":{"type":"string","description":"The number of entries to return per page, if paginated. If this parameter is not present with the `page` parameter then the results will be returned un-paged."}}}}},"description":"Search criteria","required":true},"responses":{"200":{"description":"Paginated teams response. (Note that the non-paginated response—returned if the request body does not contain both `page` and `per_page` fields—is a simple array of teams.)","content":{"application/json":{"schema":{"type":"object","properties":{"teams":{"type":"array","description":"The teams that matched the query.","items":{"$ref":"#/components/schemas/Team"}},"total_count":{"type":"number","description":"The total number of results, regardless of page and per_page requested."}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteams, resp := Client.SearchTeams(&model.TeamSearch{Term: \"searchTerm\"})\n"}]}},"/teams/name/{name}/exists":{"get":{"tags":["teams"],"summary":"Check if team exists","description":"Check if the team exists based on a team name.\n##### Permissions\nMust be authenticated.\n","parameters":[{"name":"name","in":"path","description":"Team Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamExists"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nexists, resp := Client.TeamExists(\"teamName\", \"\")\n"}]}},"/users/{user_id}/teams":{"get":{"tags":["teams"],"summary":"Get a user's teams","description":"Get a list of teams that a user is on.\n##### Permissions\nMust be authenticated as the user or have the `manage_system` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Team"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\nteams, resp := Client.GetTeamsForUser(userID, \"\")\n"}]}},"/teams/{team_id}/members":{"get":{"tags":["teams"],"summary":"Get team members","description":"Get a page team members list based on query string parameters - team id, page and per page.\n##### Permissions\nMust be authenticated and have the `view_team` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of users per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Team members retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TeamMember"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\nmembers, resp := Client.GetTeamMembers(teamID, 0, 100, \"\")\n"}]},"post":{"tags":["teams"],"summary":"Add user to team","description":"Add user to the team by user_id.\n##### Permissions\nMust be authenticated and team be open to add self. For adding another user, authenticated user must have the `add_user_to_team` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"team_id":{"type":"string"},"user_id":{"type":"string"}}}}},"required":true},"responses":{"201":{"description":"Team member creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamMember"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"4xp9fdt77pncbef59f4k1qe83o\"\nuserID := \"qjda3stwafbgpqjaxej3k76sga\"\n\nteamMember, resp := Client.AddTeamMember(teamID, userID)\n"}]}},"/teams/members/invite":{"post":{"tags":["teams"],"summary":"Add user to team from invite","description":"Using either an invite id or hash/data pair from an email invite link, add a user to a team.\n##### Permissions\nMust be authenticated.\n","parameters":[{"name":"token","in":"query","description":"Token id from the invitation","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Team member creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamMember"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\ntokenID := \"qjda3stwafbgpqjaxej3k76sga\"\n\ntm, resp = Client.AddTeamMemberFromInvite(tokenID, \"\")\n"}]}},"/teams/{team_id}/members/batch":{"post":{"tags":["teams"],"summary":"Add multiple users to team","description":"Add a number of users to the team by user_id.\n##### Permissions\nMust be authenticated. Authenticated user must have the `add_user_to_team` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"graceful","in":"query","description":"Instead of aborting the operation if a user cannot be added, return an arrray that will contain both the success and added members and the ones with error, in form of `[{\"member\": {...}, \"user_id\", \"...\", \"error\": {...}}]`","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TeamMember"}}}},"required":true},"responses":{"201":{"description":"Team members created successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TeamMember"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"IJyUQLwh1CO9ahbzaQwWwc0ZnV\"\n\nuserID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\nuserID2 := \"NqCSr5HMDZjrWS74IEmedvlOYf\"\n\ntm, resp := Client.AddTeamMembers(teamID, []string{userID, userID2})\n"}]}},"/users/{user_id}/teams/members":{"get":{"tags":["teams"],"summary":"Get team members for a user","description":"Get a list of team members for a user. Useful for getting the ids of teams the user is on and the roles they have in those teams.\n##### Permissions\nMust be logged in as the user or have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team members retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TeamMember"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\n\nteamMembers, resp = Client.GetTeamMembersForUser(userID, \"\")\n"}]}},"/teams/{team_id}/members/{user_id}":{"get":{"tags":["teams"],"summary":"Get a team member","description":"Get a team member on the system.\n##### Permissions\nMust be authenticated and have the `view_team` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team member retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamMember"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\nuserID := \"NqCSr5HMDZjrWS74IEmedvlOYf\"\n\nteamMember, resp = Client.GetTeamMember(teamID, userID, \"\")\n"}]},"delete":{"tags":["teams"],"summary":"Remove user from team","description":"Delete the team member object for a user, effectively removing them from a team.\n##### Permissions\nMust be logged in as the user or have the `remove_user_from_team` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team member deletion successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\nuserID := \"NqCSr5HMDZjrWS74IEmedvlOYf\"\n\nok, resp = Client.RemoveTeamMember(teamID, userID)\n"}]}},"/teams/{team_id}/members/ids":{"post":{"tags":["teams"],"summary":"Get team members by ids","description":"Get a list of team members based on a provided array of user ids.\n##### Permissions\nMust have `view_team` permission for the team.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of user ids","required":true},"responses":{"200":{"description":"Team members retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TeamMember"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := zWEyrTZ7GZ22aBSfoX60iWryTY\n\nuserID := \"NqCSr5HMDZjrWS74IEmedvlOYf\"\nuserID2 := \"UAFalLvtKwNKABAnmwR7uGB5md\"\n\ntm, resp := Client.GetTeamMembersByIds(teamID, []string{userID, userID2})\n"}]}},"/teams/{team_id}/stats":{"get":{"tags":["teams"],"summary":"Get a team stats","description":"Get a team stats on the system.\n##### Permissions\nMust be authenticated and have the `view_team` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team stats retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamStats"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\n\nstats, resp := Client.GetTeamStats(teamID, \"\")\n"}]}},"/teams/{team_id}/regenerate_invite_id":{"post":{"tags":["teams"],"summary":"Regenerate the Invite ID from a Team","description":"Regenerates the invite ID used in invite links of a team\n##### Permissions\nMust be authenticated and have the `manage_team` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team Invite ID regenerated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\n\nteam, resp := Client.RegenerateTeamInviteId(teamID)\n"}]}},"/teams/{team_id}/image":{"get":{"tags":["teams"],"summary":"Get the team icon","description":"Get the team icon of the team.\n\n__Minimum server version__: 4.9\n\n##### Permissions\nUser must be authenticated. In addition, team must be open or the user must have the `view_team` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team icon retrieval successful"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\n\nicon, resp = Client.GetTeamIcon(teamID, \"\")\n"}]},"post":{"tags":["teams"],"summary":"Sets the team icon","description":"Sets the team icon for the team.\n\n__Minimum server version__: 4.9\n\n##### Permissions\nMust be authenticated and have the `manage_team` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"description":"The image to be uploaded","type":"string","format":"binary"}},"required":["image"]}}}},"responses":{"200":{"description":"Team icon successfully set","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import (\n \"io/ioutil\"\n \"log\"\n\n \"github.com/mattermost/mattermost-server/model\"\n)\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\ndata, err := ioutil.ReadFile(\"icon.png\")\nif err != nil {\n log.Fatal(err)\n}\n\nteamID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\n\nok, resp := Client.SetTeamIcon(teamID, data)\n"}]},"delete":{"tags":["teams"],"summary":"Remove the team icon","description":"Remove the team icon for the team.\n\n__Minimum server version__: 4.10\n\n##### Permissions\nMust be authenticated and have the `manage_team` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team icon successfully remove","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\n\nok, resp = Client.RemoveTeamIcon(teamID)\n"}]}},"/teams/{team_id}/members/{user_id}/roles":{"put":{"tags":["teams"],"summary":"Update a team member roles","description":"Update a team member roles. Valid team roles are \"team_user\", \"team_admin\" or both of them. Overwrites any previously assigned team roles.\n##### Permissions\nMust be authenticated and have the `manage_team_roles` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["roles"],"properties":{"roles":{"type":"string"}}}}},"description":"Space-delimited team roles to assign to the user","required":true},"responses":{"200":{"description":"Team member roles update successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\nuserID := \"NqCSr5HMDZjrWS74IEmedvlOYf\"\n\nok, resp := Client.UpdateTeamMemberRoles(teamID, userID, \"team_user team_admin\")\n"}]}},"/teams/{team_id}/members/{user_id}/schemeRoles":{"put":{"tags":["teams"],"summary":"Update the scheme-derived roles of a team member.","description":"Update a team member's scheme_admin/scheme_user properties. Typically this should either be `scheme_admin=false, scheme_user=true` for ordinary team member, or `scheme_admin=true, scheme_user=true` for a team admin.\n\n__Minimum server version__: 5.0\n\n##### Permissions\nMust be authenticated and have the `manage_team_roles` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["scheme_admin","scheme_user"],"properties":{"scheme_admin":{"type":"boolean"},"scheme_user":{"type":"boolean"}}}}},"description":"Scheme properties.","required":true},"responses":{"200":{"description":"Team member's scheme-derived roles updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\nuserID := \"NqCSr5HMDZjrWS74IEmedvlOYf\"\n\nok, resp := Client.UpdateTeamMemberSchemeRoles(teamID, userID, &model.SchemeRoles{\n SchemeAdmin: true,\n SchemeUser: true,\n})\n"}]}},"/users/{user_id}/teams/unread":{"get":{"tags":["teams"],"summary":"Get team unreads for a user","description":"Get the count for unread messages and mentions in the teams the user is a member of.\n##### Permissions\nMust be logged in.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"exclude_team","in":"query","description":"Optional team id to be excluded from the results","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team unreads retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TeamUnread"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"NqCSr5HMDZjrWS74IEmedvlOYf\"\nteamID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\n\nteams, resp := Client.GetTeamsUnreadForUser(userID, teamID)\n"}]}},"/users/{user_id}/teams/{team_id}/unread":{"get":{"tags":["teams"],"summary":"Get unreads for a team","description":"Get the unread mention and message counts for a team for the specified user.\n##### Permissions\nMust be the user or have `edit_other_users` permission and have `view_team` permission for the team.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team unread count retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamUnread"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserID := \"NqCSr5HMDZjrWS74IEmedvlOYf\"\nteamID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\n\nteamUnread, resp := Client.GetTeamUnread(userID, teamID)\n"}]}},"/teams/{team_id}/invite/email":{"post":{"tags":["teams"],"summary":"Invite users to the team by email","description":"Invite users to the existing team usign the user's email.\n##### Permissions\nMust have `invite_to_team` permission for the team.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of user's email","required":true},"responses":{"200":{"description":"Users invite successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\n\nok, resp := Client.InviteUsersToTeam(teamID, []string{\"test@domain.com\", \"test2@domain.com\"})\n"}]}},"/teams/{team_id}/invite-guests/email":{"post":{"tags":["teams"],"summary":"Invite guests to the team by email","description":"Invite guests to existing team channels usign the user's email.\n\n__Minimum server version__: 5.16\n\n##### Permissions\nMust have `invite_guest` permission for the team.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["emails","channels"],"properties":{"emails":{"type":"array","items":{"type":"string"},"description":"List of emails"},"channels":{"type":"array","items":{"type":"string"},"description":"List of channel ids"},"message":{"type":"string","description":"Message to include in the invite"}}}}},"description":"Guests invite information","required":true},"responses":{"200":{"description":"Guests invite successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\nchannel1ID := \"wu6wyxm9spgwtjaycjrcihnqtr\"\nchannel2ID := \"ymzsgjw1tprniqtzyb7g3cmuuc\"\n\nok, resp := Client.InviteGuestsToTeam(teamID, []string{\"test@domain.com\", \"test2@domain.com\"}, []string{channel1ID, channel2ID}, \"Please join to our mattermost team to keep working in the project\")\n"}]}},"/teams/invites/email":{"delete":{"tags":["teams"],"summary":"Invalidate active email invitations","description":"Invalidate active email invitations that have not been accepted by the user.\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"Email invites successfully revoked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nok, resp := Client.InvalidateEmailInvites()\n"}]}},"/teams/{team_id}/import":{"post":{"tags":["teams"],"summary":"Import a Team from other application","description":"Import a team into a existing team. Import users, channels, posts, hooks.\n##### Permissions\nMust have `permission_import_team` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"A file to be uploaded in zip format.","type":"string","format":"binary"},"filesize":{"description":"The size of the zip file to be imported.","type":"integer"},"importFrom":{"description":"String that defines from which application the team was exported to be imported into Mattermost.","type":"string"}},"required":["file","filesize","importFrom"]}}}},"responses":{"200":{"description":"JSON object containing a base64 encoded text file of the import logs in its `results` property.","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"string"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import (\n \"encoding/binary\"\n \"io/ioutil\"\n \"log\"\n\n \"github.com/mattermost/mattermost-server/model\"\n)\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\ndata, err = ioutil.ReadFile(\"to_import.zip\")\nif err != nil && len(data) == 0 {\n log.Fatal(\"Error while reading file.\")\n}\n\nteamID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\n\nfileResp, resp := Client.ImportTeam(data, binary.Size(data), \"slack\", \"to_import.zip\", teamID)\n"}]}},"/teams/invite/{invite_id}":{"get":{"tags":["teams"],"summary":"Get invite info for a team","description":"Get the `name`, `display_name`, `description` and `id` for a team from the invite id.\n\n__Minimum server version__: 4.0\n\n##### Permissions\nNo authentication required.\n","parameters":[{"name":"invite_id","in":"path","description":"Invite id for a team","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team invite info retrieval successful","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"display_name":{"type":"string"},"description":{"type":"string"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\n\ninviteID := \"zWEyrTZ7GZ22aBSfoX60iWryTY\"\n\nteam, resp = Client.GetTeamInviteInfo(inviteID)\n"}]}},"/teams/{team_id}/scheme":{"put":{"tags":["teams"],"summary":"Set a team's scheme","description":"Set a team's scheme, more specifically sets the scheme_id value of a team record.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.0\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["scheme_id"],"properties":{"scheme_id":{"type":"string","description":"The ID of the scheme."}}}}},"description":"Scheme GUID","required":true},"responses":{"200":{"description":"Update team scheme successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nteamID := \"4xp9fdt77pncbef59f4k1qe83o\"\nschemeID := \"qjda3stwafbgpqjaxej3k76sga\"\n\nok, resp := UpdateTeamScheme(teamID, schemeID)\n"},{"lang":"curl","source":"curl -X PUT \\\n https://your-mattermost-url.com/api/v4/teams/4xp9fdt77pncbef59f4k1qe83o/scheme \\\n -H 'Authorization: Bearer frn8fu5rtpyc5m4xy6q3oj4yur' \\\n -H 'Content-Type: application/json' \\\n -d '{\"scheme_id\": \"qjda3stwafbgpqjaxej3k76sga\"}'\n"}]}},"/teams/{team_id}/members_minus_group_members":{"get":{"tags":["teams"],"summary":"Team members minus group members.","description":"Get the set of users who are members of the team minus the set of users who are members of the given groups.\nEach user object contains an array of group objects representing the group memberships for that user.\nEach user object contains the boolean fields `scheme_guest`, `scheme_user`, and `scheme_admin` representing the roles that user has for the given team.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.14\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"group_ids","in":"query","description":"A comma-separated list of group ids.","required":true,"schema":{"type":"string","default":""}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of users per page.","schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successfully returns users specified by the pagination, and the total_count."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"curl","source":"curl 'http://your-mattermost-url.com/api/v4/teams/fcnst115y3y7xmzzp5uq34u8ce/members_minus_group_members?group_ids=eoezijg8zffgjmch8icy5bjd1e,ugaw6wjc3tfxpcr1eq5u5k8dhe&page=0&per_page=100' \\\n -H 'Authorization: Bearer mq8rrfxpdfyafbnw3qfmhwkx6c' \\\n -H 'Content-Type: application/json' \\\n -H 'X-Requested-With: XMLHttpRequest'\n"}]}},"/channels":{"post":{"tags":["channels"],"summary":"Create a channel","description":"Create a new channel.\n##### Permissions\nIf creating a public channel, `create_public_channel` permission is required. If creating a private channel, `create_private_channel` permission is required.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","display_name","type","team_id"],"properties":{"team_id":{"type":"string","description":"The team ID of the team to create the channel on"},"name":{"type":"string","description":"The unique handle for the channel, will be present in the channel URL"},"display_name":{"type":"string","description":"The non-unique UI name for the channel"},"purpose":{"type":"string","description":"A short description of the purpose of the channel"},"header":{"type":"string","description":"Markdown-formatted text to display in the header of the channel"},"type":{"type":"string","description":"'O' for a public channel, 'P' for a private channel"}}}}},"description":"Channel object to be created","required":true},"responses":{"201":{"description":"Channel creation successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Channel"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nchannel := &model.Channel{DisplayName: <YOUR CHANNEL DISPLAYNAME>, Name: <YOUR CHANNEL NAME>, Type: <CHANNEL TYPE OPEN/PRIVATE>, TeamId: <YOUR TEAM ID>}\n\n// CreateChannel\nrchannel, resp := Client.CreateChannel(channel)\n"}]}},"/channels/direct":{"post":{"tags":["channels"],"summary":"Create a direct message channel","description":"Create a new direct message channel between two users.\n##### Permissions\nMust be one of the two users and have `create_direct_channel` permission. Having the `manage_system` permission voids the previous requirements.\n","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"minItems":2,"maxItems":2}}},"description":"The two user ids to be in the direct message","required":true},"responses":{"201":{"description":"Direct channel creation successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Channel"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// CreateDirectChannel\ndm, resp := Client.CreateDirectChannel(<ID OF User1>, <ID OF User2>)\n"}]}},"/channels/group":{"post":{"tags":["channels"],"summary":"Create a group message channel","description":"Create a new group message channel to group of users. If the logged in user's id is not included in the list, it will be appended to the end.\n##### Permissions\nMust have `create_group_channel` permission.\n","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"User ids to be in the group message channel","required":true},"responses":{"201":{"description":"Group channel creation successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Channel"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nuserIds := []string{<ID OF User1>, <ID OF User2>, <ID OF User3> ...}\n\n// CreateGroupChannel\nrgc, resp := Client.CreateGroupChannel(userIds)\n"}]}},"/channels/search":{"post":{"tags":["channels"],"summary":"Search all private and open type channels across all teams","description":"Returns all private and open type channels where 'term' matches on the name, display name, or purpose of\nthe channel.\n\nConfigured 'default' channels (ex Town Square and Off-Topic) can be excluded from the results\nwith the `exclude_default_channels` boolean parameter.\n\nChannels that are associated (via GroupChannel records) to a given group can be excluded from the results\nwith the `not_associated_to_group` parameter and a group id string.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["term"],"properties":{"term":{"type":"string","description":"The string to search in the channel name, display name, and purpose."},"not_associated_to_group":{"type":"string","description":"A group id to exclude channels that are associated to that group via GroupChannel records."},"exclude_default_channels":{"type":"boolean","description":"Exclude default channels from the results by setting this parameter to true."},"page":{"type":"string","description":"The page number to return, if paginated. If this parameter is not present with the `per_page` parameter then the results will be returned un-paged."},"per_page":{"type":"string","description":"The number of entries to return per page, if paginated. If this parameter is not present with the `page` parameter then the results will be returned un-paged."}}}}},"description":"The search terms and logic to use in the search.","required":true},"responses":{"200":{"description":"Paginated channel response. (Note that the non-paginated response—returned if the request body does not contain both `page` and `per_page` fields—is a simple array of channels.)","content":{"*/*":{"schema":{"type":"object","properties":{"channels":{"type":"array","description":"The channels that matched the query.","items":{"$ref":"#/components/schemas/Channel"}},"total_count":{"type":"number","description":"The total number of results, regardless of page and per_page requested."}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/group/search":{"post":{"tags":["channels"],"summary":"Search Group Channels","description":"Get a list of group channels for a user which members' usernames match the search term.\n\n__Minimum server version__: 5.14\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["term"],"properties":{"term":{"description":"The search term to match against the members' usernames of the group channels","type":"string"}}}}},"description":"Search criteria","required":true},"responses":{"200":{"description":"Channels search successful","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nsearch := &model.ChannelSearch{Term: <MEMBER USERNAME>}\n\n// SearchGroupChannels\nchannels, resp := Client.SearchGroupChannels(search)\n"}]}},"/teams/{team_id}/channels/ids":{"post":{"tags":["channels"],"summary":"Get a list of channels by ids","description":"Get a list of public channels on a team by id.\n##### Permissions\n`view_team` for the team the channels are on.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of channel ids","required":true},"responses":{"200":{"description":"Channel list retrieval successful","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nchannelIds := []string{<ID OF CHANNEL1>, <ID OF CHANNEL2>, ...}\n\n// GetPublicChannelsByIdsForTeam\nchannels, resp := Client.GetPublicChannelsByIdsForTeam(<TEAMID>, channelIds)\n"}]}},"/channels/{channel_id}/timezones":{"get":{"tags":["channels"],"summary":"Get timezones in a channel","description":"Get a list of timezones for the users who are in this channel.\n\n__Minimum server version__: 5.6\n\n##### Permissions\nMust have the `read_channel` permission.\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Timezone retrieval successful","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetChannelStats\nstats, resp := Client.GetChannelTimezones(<CHANNELID>)\n"}]}},"/channels/{channel_id}":{"get":{"tags":["channels"],"summary":"Get a channel","description":"Get channel from the provided channel id string.\n##### Permissions\n`read_channel` permission for the channel.\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel retrieval successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Channel"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetChannel\nchannel, resp := Client.GetChannel(<CHANNELID>, \"\")\n"}]},"put":{"tags":["channels"],"summary":"Update a channel","description":"Update a channel. The fields that can be updated are listed as parameters. Omitted fields will be treated as blanks.\n##### Permissions\nIf updating a public channel, `manage_public_channel_members` permission is required. If updating a private channel, `manage_private_channel_members` permission is required.\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The channel's id, not updatable"},"name":{"type":"string","description":"The unique handle for the channel, will be present in the channel URL"},"display_name":{"type":"string","description":"The non-unique UI name for the channel"},"purpose":{"type":"string","description":"A short description of the purpose of the channel"},"header":{"type":"string","description":"Markdown-formatted text to display in the header of the channel"}}}}},"description":"Channel object to be updated","required":true},"responses":{"200":{"description":"Channel update successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Channel"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nchannel := &model.Channel{DisplayName: <YOUR CHANNEL NEW DISPLAYNAME>, ChannelId: <CHANNELID>, TeamId: <YOUR TEAM ID>}\n\n// UpdateChannel\nupdatedChannel, resp := Client.UpdateChannel(channel)\n"}]},"delete":{"tags":["channels"],"summary":"Delete a channel","description":"Soft deletes a channel, by marking the channel as deleted in the database. Soft deleted channels will not be accessible in the user interface. Direct and group message channels cannot be deleted.\n##### Permissions\n`delete_public_channel` permission if the channel is public,\n`delete_private_channel` permission if the channel is private,\nor have `manage_system` permission.\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel deletion successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// DeleteChannel\npass, resp := Client.DeleteChannel(<CHANNELID>)\n"}]}},"/channels/{channel_id}/patch":{"put":{"tags":["channels"],"summary":"Patch a channel","description":"Partially update a channel by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n##### Permissions\nIf updating a public channel, `manage_public_channel_members` permission is required. If updating a private channel, `manage_private_channel_members` permission is required.\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The unique handle for the channel, will be present in the channel URL"},"display_name":{"type":"string","description":"The non-unique UI name for the channel"},"purpose":{"type":"string","description":"A short description of the purpose of the channel"},"header":{"type":"string","description":"Markdown-formatted text to display in the header of the channel"}}}}},"description":"Channel object to be updated","required":true},"responses":{"200":{"description":"Channel patch successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Channel"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\npatch := &model.ChannelPatch{\n Name: new(string),\n DisplayName: new(string),\n Header: new(string),\n Purpose: new(string),\n}\n*patch.Name = \"<SOME_NEW_NAME>\"\n*patch.DisplayName = \"<SOME_NEW_DISPLAYNAME>\"\n*patch.Header = \"<SOME_NEW_HEADER>\"\n*patch.Purpose = \"<SOME_NEW_PURPOSE>\"\n\n// PatchChannel\nchannel, resp := Client.PatchChannel(<CHANNELID>, patch)\n"}]}},"/channels/{channel_id}/privacy":{"put":{"tags":["channels"],"summary":"Update channel's privacy","description":"Updates channel's privacy allowing changing a channel from Public to Private and back.\n\n__Minimum server version__: 5.16\n\n##### Permissions\n`manage_team` permission for the team of the channel.\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["privacy"],"properties":{"privacy":{"type":"string","description":"Channel privacy setting: 'O' for a public channel, 'P' for a private channel"}}}}},"required":true},"responses":{"200":{"description":"Channel conversion successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Channel"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// Update channel's privacy to Public\nupdatedChannel, resp := Client.UpdateChannelPrivacy(<CHANNELID>, model.CHANNEL_OPEN)\n\n// Update channel's privacy to Private\nupdatedChannel, resp := Client.UpdateChannelPrivacy(<CHANNELID>, model.CHANNEL_PRIVATE)\n"}]}},"/channels/{channel_id}/convert":{"post":{"tags":["channels"],"summary":"Convert a channel from public to private","description":"Will be deprecated in 6.0\n\nConvert into private channel from the provided channel id string.\n\n__Minimum server version__: 4.10\n\n##### Permissions\n`manage_team` permission for the team of the channel.\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel conversion successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Channel"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// ConvertChannelToPrivate\nconvertedChannel, resp := Client.ConvertChannelToPrivate(<CHANNELID>)\n"}]}},"/channels/{channel_id}/restore":{"post":{"tags":["channels"],"summary":"Restore a channel","description":"Restore channel from the provided channel id string.\n\n__Minimum server version__: 3.10\n\n##### Permissions\n`manage_team` permission for the team of the channel.\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel restore successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Channel"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/channels/{channel_id}/stats":{"get":{"tags":["channels"],"summary":"Get channel statistics","description":"Get statistics for a channel.\n##### Permissions\nMust have the `read_channel` permission.\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel statistics retrieval successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ChannelStats"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetChannelStats\nstats, resp := Client.GetChannelStats(<CHANNELID>)\n"}]}},"/channels/{channel_id}/pinned":{"get":{"tags":["channels"],"summary":"Get a channel's pinned posts","description":"Get a list of pinned posts for channel.","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The list of channel pinned posts","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PostList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetPinnedPosts\nposts, resp := Client.GetPinnedPosts(<CHANNELID>, \"\")\n"}]}},"/teams/{team_id}/channels":{"get":{"tags":["channels"],"summary":"Get public channels","description":"Get a page of public channels on a team based on query string parameters - page and per_page.\n##### Permissions\nMust be authenticated and have the `list_team_channels` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of public channels per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Channels retrieval successful","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n// GetPublicChannelsForTeam\nchannels, resp := Client.GetPublicChannelsForTeam(<TEAMID>, 0, 100, \"\")\n"}]}},"/teams/{team_id}/channels/deleted":{"get":{"tags":["channels"],"summary":"Get deleted channels","description":"Get a page of deleted channels on a team based on query string parameters - team_id, page and per_page.\n\n__Minimum server version__: 3.10\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of public channels per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Channels retrieval successful","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/teams/{team_id}/channels/autocomplete":{"get":{"tags":["channels"],"summary":"Autocomplete channels","description":"Autocomplete public channels on a team based on the search term provided in the request URL.\n\n__Minimum server version__: 4.7\n\n##### Permissions\nMust have the `list_team_channels` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Name or display name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channels autocomplete successful","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/teams/{team_id}/channels/search_autocomplete":{"get":{"tags":["channels"],"summary":"Autocomplete channels for search","description":"Autocomplete your channels on a team based on the search term provided in the request URL.\n\n__Minimum server version__: 5.4\n\n##### Permissions\nMust have the `list_team_channels` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Name or display name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channels autocomplete successful","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/teams/{team_id}/channels/search":{"post":{"tags":["channels"],"summary":"Search channels","description":"Search public channels on a team based on the search term provided in the request body.\n##### Permissions\nMust have the `list_team_channels` permission.\n\nIn server version 5.16 and later, a user without the `list_team_channels` permission will be able to use this endpoint, with the search results limited to the channels that the user is a member of.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["term"],"properties":{"term":{"description":"The search term to match against the name or display name of channels","type":"string"}}}}},"description":"Search criteria","required":true},"responses":{"201":{"description":"Channels search successful","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nsearch := &model.ChannelSearch{Term: <CHANNEL DISPLAYNAME>}\n\n// SearchChannels\nchannels, resp := Client.SearchChannels(<TEAMID>, search)\n"}]}},"/teams/{team_id}/channels/search_archived":{"post":{"tags":["channels"],"summary":"Search archived channels","description":"Search archived channels on a team based on the search term provided in the request body.\n\n__Minimum server version__: 5.18\n\n##### Permissions\nMust have the `list_team_channels` permission.\n\nIn server version 5.18 and later, a user without the `list_team_channels` permission will be able to use this endpoint, with the search results limited to the channels that the user is a member of.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["term"],"properties":{"term":{"description":"The search term to match against the name or display name of archived channels","type":"string"}}}}},"description":"Search criteria","required":true},"responses":{"201":{"description":"Channels search successful","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nsearch := &model.ChannelSearch{Term: <CHANNEL DISPLAYNAME>}\n\n// SearchChannels\nchannels, resp := Client.SearchArchivedChannels(<TEAMID>, search)\n"}]}},"/teams/{team_id}/channels/name/{channel_name}":{"get":{"tags":["channels"],"summary":"Get a channel by name","description":"Gets channel from the provided team id and channel name strings.\n##### Permissions\n`read_channel` permission for the channel.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"channel_name","in":"path","description":"Channel Name","required":true,"schema":{"type":"string"}},{"name":"include_deleted","in":"query","description":"Defines if deleted channels should be returned or not","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Channel retrieval successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Channel"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetChannelByName\nchannel, resp := Client.GetChannelByName(<CHANNEL NAME>, <TEAMID>, \"\")\n"}]}},"/teams/name/{team_name}/channels/name/{channel_name}":{"get":{"tags":["channels"],"summary":"Get a channel by name and team name","description":"Gets a channel from the provided team name and channel name strings.\n##### Permissions\n`read_channel` permission for the channel.\n","parameters":[{"name":"team_name","in":"path","description":"Team Name","required":true,"schema":{"type":"string"}},{"name":"channel_name","in":"path","description":"Channel Name","required":true,"schema":{"type":"string"}},{"name":"include_deleted","in":"query","description":"Defines if deleted channels should be returned or not","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Channel retrieval successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Channel"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetChannelByNameForTeamName\nchannel, resp = Client.GetChannelByNameForTeamName(<CHANNEL NAME>, <TEAM NAME>, \"\")\n"}]}},"/channels/{channel_id}/members":{"get":{"tags":["channels"],"summary":"Get channel members","description":"Get a page of members for a channel.\n##### Permissions\n`read_channel` permission for the channel.\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of members per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Channel members retrieval successful","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChannelMember"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetChannelMembers\nmembers, resp := Client.GetChannelMembers(th.BasicChannel.Id, 0, 60, \"\")\n"}]},"post":{"tags":["channels"],"summary":"Add user to channel","description":"Add a user to a channel by creating a channel member object.","parameters":[{"name":"channel_id","in":"path","description":"The channel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The ID of user to add into the channel"},"post_root_id":{"type":"string","description":"The ID of root post where link to add channel member originates"}}}}},"required":true},"responses":{"201":{"description":"Channel member creation successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ChannelMember"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// AddChannelMember\ncm, resp := Client.AddChannelMember(<CHANNEL ID>, <ID OF USER TO ADD>)\n\n// AddChannelMemberWithRootId\ncm, resp := Client.AddChannelMemberWithRootId(<CHANNEL ID>, <ID OF USER TO ADD>, <POST ROOT ID>)\n"}]}},"/channels/{channel_id}/members/ids":{"post":{"tags":["channels"],"summary":"Get channel members by ids","description":"Get a list of channel members based on the provided user ids.\n##### Permissions\nMust have the `read_channel` permission.\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of user ids","required":true},"responses":{"200":{"description":"Channel member list retrieval successful","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChannelMember"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nusersIds := []string{<Id of User1>, <Id of User2>, ...}\n\n// GetChannelMembersByIds\ncm, resp := Client.GetChannelMembersByIds(<CHANNELID>, usersIds)\n"}]}},"/channels/{channel_id}/members/{user_id}":{"get":{"tags":["channels"],"summary":"Get channel member","description":"Get a channel member.\n##### Permissions\n`read_channel` permission for the channel.\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel member retrieval successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ChannelMember"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetChannelMember\nmember, resp := Client.GetChannelMember(<CHANNELID>, <USERID>, \"\")\n"}]},"delete":{"tags":["channels"],"summary":"Remove user from channel","description":"Delete a channel member, effectively removing them from a channel.\n\nIn server version 5.3 and later, channel members can only be deleted from public or private channels.\n##### Permissions\n`manage_public_channel_members` permission if the channel is public.\n`manage_private_channel_members` permission if the channel is private.\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel member deletion successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// RemoveUserFromChannel\npass, resp := Client.RemoveUserFromChannel(<CHANNELID>, <USERID>)\n"}]}},"/channels/{channel_id}/members/{user_id}/roles":{"put":{"tags":["channels"],"summary":"Update channel roles","description":"Update a user's roles for a channel.\n##### Permissions\nMust have `manage_channel_roles` permission for the channel.\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["roles"],"properties":{"roles":{"type":"string"}}}}},"description":"Space-delimited channel roles to assign to the user","required":true},"responses":{"200":{"description":"Channel roles update successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// UpdateChannelRoles\npass, resp := Client.UpdateChannelRoles(<CHANNELID>, <USERIDTOPROMOTE>, \"channel_admin channel_user\")\n"}]}},"/channels/{channel_id}/members/{user_id}/schemeRoles":{"put":{"tags":["channels"],"summary":"Update the scheme-derived roles of a channel member.","description":"Update a channel member's scheme_admin/scheme_user properties. Typically this should either be `scheme_admin=false, scheme_user=true` for ordinary channel member, or `scheme_admin=true, scheme_user=true` for a channel admin.\n__Minimum server version__: 5.0\n##### Permissions\nMust be authenticated and have the `manage_channel_roles` permission.\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["scheme_admin","scheme_user"],"properties":{"scheme_admin":{"type":"boolean"},"scheme_user":{"type":"boolean"}}}}},"description":"Scheme properties.","required":true},"responses":{"200":{"description":"Channel member's scheme-derived roles updated successfully.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/channels/{channel_id}/members/{user_id}/notify_props":{"put":{"tags":["channels"],"summary":"Update channel notifications","description":"Update a user's notification properties for a channel. Only the provided fields are updated.\n##### Permissions\nMust be logged in as the user or have `edit_other_users` permission.\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelNotifyProps"}}},"required":true},"responses":{"200":{"description":"Channel notification properties update successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nprops := map[string]string{}\nprops[model.DESKTOP_NOTIFY_PROP] = model.CHANNEL_NOTIFY_MENTION\nprops[model.MARK_UNREAD_NOTIFY_PROP] = model.CHANNEL_MARK_UNREAD_MENTION\n\n// UpdateChannelNotifyProps\npass, resp := Client.UpdateChannelNotifyProps(<CHANNELID>, <USERID>, props)\n"}]}},"/channels/members/{user_id}/view":{"post":{"tags":["channels"],"summary":"View channel","description":"Perform all the actions involved in viewing a channel. This includes marking channels as read, clearing push notifications, and updating the active channel.\n##### Permissions\nMust be logged in as user or have `edit_other_users` permission.\n\n__Response only includes `last_viewed_at_times` in Mattermost server 4.3 and newer.__\n","parameters":[{"in":"path","name":"user_id","description":"User ID to perform the view action for","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["channel_id"],"properties":{"channel_id":{"type":"string","description":"The channel ID that is being viewed. Use a blank string to indicate that all channels have lost focus."},"prev_channel_id":{"type":"string","description":"The channel ID of the previous channel, used when switching channels. Providing this ID will cause push notifications to clear on the channel being switched to."}}}}},"description":"Paremeters affecting how and which channels to view","required":true},"responses":{"200":{"description":"Channel view successful","content":{"*/*":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Value should be \"OK\" if successful"},"last_viewed_at_times":{"type":"object","description":"A JSON object mapping channel IDs to the channel view times"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nview := &model.ChannelView{\n ChannelId: <CHANNELID>,\n}\n// ViewChannel\npass, resp := Client.ViewChannel(<USERID>, view)\n"}]}},"/users/{user_id}/teams/{team_id}/channels/members":{"get":{"tags":["channels"],"summary":"Get channel memberships and roles for a user","description":"Get all channel memberships and associated membership roles (i.e. `channel_user`, `channel_admin`) for a user on a specific team.\n##### Permissions\nLogged in as the user and `view_team` permission for the team. Having `manage_system` permission voids the previous requirements.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel members retrieval successful","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChannelMember"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetChannelMembersForUser\nmembers, resp := Client.GetChannelMembersForUser(<USERID>, <TEAMID>, \"\")\n"}]}},"/users/{user_id}/teams/{team_id}/channels":{"get":{"tags":["channels"],"summary":"Get channels for user","description":"Get all the channels on a team for a user.\n##### Permissions\nLogged in as the user, or have `edit_other_users` permission, and `view_team` permission for the team.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channels retrieval successful","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetChannelsForTeamForUser\nchannels, resp := Client.GetChannelsForTeamForUser(<TEAMID>, <USERID>, \"\")\n"}]}},"/users/{user_id}/channels/{channel_id}/unread":{"get":{"tags":["channels"],"summary":"Get unread messages","description":"Get the total unread messages and mentions for a channel for a user.\n##### Permissions\nMust be logged in as user and have the `read_channel` permission, or have `edit_other_usrs` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel unreads retrieval successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ChannelUnread"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetChannelUnread\nchannelUnread, resp := Client.GetChannelUnread(<CHANNELID>, <USERID>)\n"}]}},"/channels/{channel_id}/scheme":{"put":{"tags":["channels"],"summary":"Set a channel's scheme","description":"Set a channel's scheme, more specifically sets the scheme_id value of a channel record.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 4.10\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["scheme_id"],"properties":{"scheme_id":{"type":"string","description":"The ID of the scheme."}}}}},"description":"Scheme GUID","required":true},"responses":{"200":{"description":"Update channel scheme successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nchannelID := \"4xp9fdt77pncbef59f4k1qe83o\"\nschemeID := \"qjda3stwafbgpqjaxej3k76sga\"\nok, resp := UpdateChannelScheme(channelID, schemeID)\n"},{"lang":"curl","source":"curl -X PUT \\\n https://your-mattermost-url.com/api/v4/channels/4xp9fdt77pncbef59f4k1qe83o/scheme \\\n -H 'Authorization: Bearer frn8fu5rtpyc5m4xy6q3oj4yur' \\\n -H 'Content-Type: application/json' \\\n -d '{\"scheme_id\": \"qjda3stwafbgpqjaxej3k76sga\"}'\n"}]}},"/channels/{channel_id}/members_minus_group_members":{"get":{"tags":["channels"],"summary":"Channel members minus group members.","description":"Get the set of users who are members of the channel minus the set of users who are members of the given groups.\nEach user object contains an array of group objects representing the group memberships for that user.\nEach user object contains the boolean fields `scheme_guest`, `scheme_user`, and `scheme_admin` representing the roles that user has for the given channel.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.14\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}},{"name":"group_ids","in":"query","description":"A comma-separated list of group ids.","required":true,"schema":{"type":"string","default":""}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of users per page.","schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successfully returns users specified by the pagination, and the total_count."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"curl","source":"curl -X GET \\\n 'http://your-mattermost-url.com/api/v4/channels/3wyp678obid8pggjmhmhwpah1r/members_minus_group_members?group_ids=eoezijg8zffgjmch8icy5bjd1e,ugaw6wjc3tfxpcr1eq5u5k8dhe&page=0&per_page=100' \\\n -H 'Authorization: Bearer kno8tcdotpbx3dj1gzcbx9jrqy' \\\n -H 'Content-Type: application/json' \\\n -H 'X-Requested-With: XMLHttpRequest'\n"}]}},"/posts":{"post":{"tags":["posts"],"summary":"Create a post","description":"Create a new post in a channel. To create the post as a comment on another post, provide `root_id`.\n##### Permissions\nMust have `create_post` permission for the channel the post is being created in.\n","parameters":[{"name":"set_online","in":"query","description":"Whether to set the user status as online or not.","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["channel_id","message"],"properties":{"channel_id":{"type":"string","description":"The channel ID to post in"},"message":{"type":"string","description":"The message contents, can be formatted with Markdown"},"root_id":{"type":"string","description":"The post ID to comment on"},"file_ids":{"type":"array","description":"A list of file IDs to associate with the post. Note that posts are limited to 5 files maximum. Please use additional posts for more files.","items":{"type":"string"}},"props":{"description":"A general JSON property bag to attach to the post","type":"object"}}}}},"description":"Post object to create","required":true},"responses":{"201":{"description":"Post creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/posts/ephemeral":{"post":{"tags":["posts"],"summary":"Create a ephemeral post","description":"Create a new ephemeral post in a channel.\n##### Permissions\nMust have `create_post_ephemeral` permission (currently only given to system admin)\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["user_id","post"],"properties":{"user_id":{"type":"string","description":"The target user id for the ephemeral post"},"post":{"type":"object","required":["channel_id","message"],"description":"Post object to create","properties":{"channel_id":{"type":"string","description":"The channel ID to post in"},"message":{"type":"string","description":"The message contents, can be formatted with Markdown"}}}}}}},"description":"Ephemeral Post object to send","required":true},"responses":{"201":{"description":"Post creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"client := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nclient.Login(\"email@domain.com\", \"Password1\")\n\nephemeralPost := &model.PostEphemeral{\n UserID: \"<ID OF THE USER THAT WOULD RECEIVE THE POST>\",\n Post: &model.Post{\n ChannelId: \"<ID OF CHANNEL>\",\n Message: \"<YOUR MESSAGE>\",\n },\n}\n\ncreatedPost, response := client.CreatePostEphemeral(ephemeralPost)\n"}]}},"/posts/{post_id}":{"get":{"tags":["posts"],"summary":"Get a post","description":"Get a single post.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in or if the channel is public, have the `read_public_channels` permission for the team.\n","parameters":[{"name":"post_id","in":"path","description":"ID of the post to get","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Post retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}},"delete":{"tags":["posts"],"summary":"Delete a post","description":"Soft deletes a post, by marking the post as deleted in the database. Soft deleted posts will not be returned in post queries.\n##### Permissions\nMust be logged in as the user or have `delete_others_posts` permission.\n","parameters":[{"name":"post_id","in":"path","description":"ID of the post to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Post deletion successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}},"put":{"tags":["posts"],"summary":"Update a post","description":"Update a post. Only the fields listed below are updatable, omitted fields will be treated as blank.\n##### Permissions\nMust have `edit_post` permission for the channel the post is in.\n","parameters":[{"name":"post_id","in":"path","description":"ID of the post to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"description":"ID of the post to update","type":"string"},"is_pinned":{"description":"Set to `true` to pin the post to the channel it is in","type":"boolean"},"message":{"description":"The message text of the post","type":"string"},"has_reactions":{"description":"Set to `true` if the post has reactions to it","type":"boolean"},"props":{"description":"A general JSON property bag to attach to the post","type":"string"}}}}},"description":"Post object that is to be updated","required":true},"responses":{"200":{"description":"Post update successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/user/{user_id}/posts/{post_id}/set_unread":{"post":{"tags":["posts"],"summary":"Mark as unread from a post.","description":"Mark a channel as being unread from a given post.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in or if the channel is public, have the `read_public_channels` permission for the team.\nMust have `edit_other_users` permission if the user is not the one marking the post for himself.\n\n__Minimum server version__: 5.18\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"post_id","in":"path","description":"Post GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Post marked as unread successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelUnreadAt"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/posts/{post_id}/patch":{"put":{"tags":["posts"],"summary":"Patch a post","description":"Partially update a post by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n##### Permissions\nMust have the `edit_post` permission.\n","parameters":[{"name":"post_id","in":"path","description":"Post GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"is_pinned":{"description":"Set to `true` to pin the post to the channel it is in","type":"boolean"},"message":{"description":"The message text of the post","type":"string"},"file_ids":{"description":"The list of files attached to this post","type":"array","items":{"type":"string"}},"has_reactions":{"description":"Set to `true` if the post has reactions to it","type":"boolean"},"props":{"description":"A general JSON property bag to attach to the post","type":"string"}}}}},"description":"Post object that is to be updated","required":true},"responses":{"200":{"description":"Post patch successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/posts/{post_id}/thread":{"get":{"tags":["posts"],"summary":"Get a thread","description":"Get a post and the rest of the posts in the same thread.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in or if the channel is public, have the `read_public_channels` permission for the team.\n","parameters":[{"name":"post_id","in":"path","description":"ID of a post in the thread","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Post list retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/users/{user_id}/posts/flagged":{"get":{"tags":["posts"],"summary":"Get a list of flagged posts","description":"Get a page of flagged posts of a user provided user id string. Selects from a channel, team or all flagged posts by a user.\n##### Permissions\nMust be user or have `manage_system` permission.\n","parameters":[{"name":"user_id","in":"path","description":"ID of the user","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"query","description":"Team ID","schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"Channel ID","schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of posts per page","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Post list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PostList"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/posts/{post_id}/files/info":{"get":{"tags":["posts"],"summary":"Get file info for post","description":"Gets a list of file information objects for the files attached to a post.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in.\n","parameters":[{"name":"post_id","in":"path","description":"ID of the post","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"File info retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FileInfo"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/channels/{channel_id}/posts":{"get":{"tags":["posts"],"summary":"Get posts for a channel","description":"Get a page of posts in a channel. Use the query parameters to modify the behaviour of this endpoint. The parameters `since`, `before` and `after` must not be used together.\n##### Permissions\nMust have `read_channel` permission for the channel.\n","parameters":[{"name":"channel_id","in":"path","description":"The channel ID to get the posts for","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of posts per page","schema":{"type":"integer","default":60}},{"name":"since","in":"query","description":"Provide a non-zero value in Unix time milliseconds to select posts created after that time","schema":{"type":"integer"}},{"name":"before","in":"query","description":"A post id to select the posts that came before this one","schema":{"type":"string"}},{"name":"after","in":"query","description":"A post id to select the posts that came after this one","schema":{"type":"string"}}],"responses":{"200":{"description":"Post list retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/users/{user_id}/channels/{channel_id}/posts/unread":{"get":{"tags":["posts"],"summary":"Get posts around last unread","description":"Get the oldest unread post in the channel for the given user as well as the posts around it.\n##### Permissions\nMust be logged in as the user or have `edit_other_users` permission, and must have `read_channel` permission for the channel.\n__Minimum server version__: 5.14\n","parameters":[{"name":"user_id","in":"path","description":"ID of the user","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"path","description":"The channel ID to get the posts for","required":true,"schema":{"type":"string"}},{"name":"limit_before","in":"query","description":"Number of posts before the last unread posts. Maximum is 200 posts if limit is set greater than that.","schema":{"type":"integer","default":60}},{"name":"limit_after","in":"query","description":"Number of posts after and including the last unread post. Maximum is 200 posts if limit is set greater than that.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Post list retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/teams/{team_id}/posts/search":{"post":{"tags":["posts"],"summary":"Search for team posts","description":"Search posts in the team and from the provided terms string.\n##### Permissions\nMust be authenticated and have the `view_team` permission.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["terms","is_or_search"],"properties":{"terms":{"type":"string","description":"The search terms as inputed by the user. To search for posts from a user include `from:someusername`, using a user's username. To search in a specific channel include `in:somechannel`, using the channel name (not the display name)."},"is_or_search":{"type":"boolean","description":"Set to true if an Or search should be performed vs an And search."},"time_zone_offset":{"type":"integer","default":0,"description":"Offset from UTC of user timezone for date searches."},"include_deleted_channels":{"type":"boolean","description":"Set to true if deleted channels should be included in the search. (archived channels)"},"page":{"type":"integer","default":0,"description":"The page to select. (Only works with Elasticsearch)"},"per_page":{"type":"integer","default":60,"description":"The number of posts per page. (Only works with Elasticsearch)"}}}}},"description":"The search terms and logic to use in the search.","required":true},"responses":{"200":{"description":"Post list retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostListWithSearchMatches"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/posts/{post_id}/pin":{"post":{"tags":["posts"],"summary":"Pin a post to the channel","description":"Pin a post to a channel it is in based from the provided post id string.\n##### Permissions\nMust be authenticated and have the `read_channel` permission to the channel the post is in.\n","parameters":[{"name":"post_id","in":"path","description":"Post GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Pinned post successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/posts/{post_id}/unpin":{"post":{"tags":["posts"],"summary":"Unpin a post to the channel","description":"Unpin a post to a channel it is in based from the provided post id string.\n##### Permissions\nMust be authenticated and have the `read_channel` permission to the channel the post is in.\n","parameters":[{"name":"post_id","in":"path","description":"Post GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Unpinned post successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/posts/{post_id}/actions/{action_id}":{"post":{"tags":["posts"],"summary":"Perform a post action","description":"Perform a post action, which allows users to interact with integrations through posts.\n##### Permissions\nMust be authenticated and have the `read_channel` permission to the channel the post is in.\n","parameters":[{"name":"post_id","in":"path","description":"Post GUID","required":true,"schema":{"type":"string"}},{"name":"action_id","in":"path","description":"Action GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Post action successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/users/{user_id}/preferences":{"get":{"tags":["preferences"],"summary":"Get the user's preferences","description":"Get a list of the user's preferences.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User preferences retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Preference"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}},"put":{"tags":["preferences"],"summary":"Save the user's preferences","description":"Save a list of the user's preferences.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"List of preference objects","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Preference"}}}}},"responses":{"200":{"description":"User preferences saved successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/users/{user_id}/preferences/delete":{"post":{"tags":["preferences"],"summary":"Delete user's preferences","description":"Delete a list of the user's preferences.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"List of preference objects","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Preference"}}}}},"responses":{"200":{"description":"User preferences saved successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/users/{user_id}/preferences/{category}":{"get":{"tags":["preferences"],"summary":"List a user's preferences by category","description":"Lists the current user's stored preferences in the given category.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"category","in":"path","description":"The category of a group of preferences","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of all of the current user's preferences in the given category","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Preference"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/users/{user_id}/preferences/{category}/name/{preference_name}":{"get":{"tags":["preferences"],"summary":"Get a specific user preference","description":"Gets a single preference for the current user with the given category and name.\n##### Permissions\nMust be logged in as the user being updated or have the `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"category","in":"path","description":"The category of a group of preferences","required":true,"schema":{"type":"string"}},{"name":"preference_name","in":"path","description":"The name of the preference","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A single preference for the current user in the current categorylist of all of the current user's preferences in the given category.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Preference"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/files":{"post":{"tags":["files"],"summary":"Upload a file","description":"Uploads a file that can later be attached to a post.\n\nThis request can either be a multipart/form-data request with a channel_id, files and optional\nclient_ids defined in the FormData, or it can be a request with the channel_id and filename\ndefined as query parameters with the contents of a single file in the body of the request.\n\nOnly multipart/form-data requests are supported by server versions up to and including 4.7.\nServer versions 4.8 and higher support both types of requests.\n\n##### Permissions\nMust have `upload_file` permission.\n","parameters":[{"name":"channel_id","in":"query","description":"The ID of the channel that this file will be uploaded to","required":false,"schema":{"type":"string"}},{"name":"filename","in":"query","description":"The name of the file to be uploaded","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"files":{"description":"A file to be uploaded","type":"string","format":"binary"},"channel_id":{"description":"The ID of the channel that this file will be uploaded to","type":"string"},"client_ids":{"description":"A unique identifier for the file that will be returned in the response","type":"string"}}}}}},"responses":{"201":{"description":"Corresponding lists of the provided client_ids and the metadata that has been stored in the database for each one","content":{"application/json":{"schema":{"type":"object","properties":{"file_infos":{"description":"A list of file metadata that has been stored in the database","type":"array","items":{"$ref":"#/components/schemas/FileInfo"}},"client_ids":{"description":"A list of the client_ids that were provided in the request","type":"array","items":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"413":{"$ref":"#/components/responses/TooLarge"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nfile, err := os.Open(\"file.png\")\nif err != nil {\n fmt.Fprintf(os.Stderr, \"%v\\n\", err)\n}\ndefer file.Close();\n\nbuf := bytes.NewBuffer(nil)\nio.Copy(buf, file)\ndata := buf.Bytes()\n\nchannelID := \"4xp9fdt77pncbef59f4k1qe83o\"\nfilename := \"file.png\"\n\nfileUploadResponse, response := Client.UploadFile(data, channelID, filename)\n"},{"lang":"Curl","source":"curl -F 'files=@PATH/TO/LOCAL/FILE' \\\n-F 'channel_id=CHANNEL_ID' \\\n--header 'authorization: Bearer c49adc55z3f53ck7xtp8ebq1ir'\nhttps://your-mattermost-url.com/api/v4/files\n"}]}},"/files/{file_id}":{"get":{"tags":["files"],"summary":"Get a file","description":"Gets a file that has been uploaded previously.\n##### Permissions\nMust have `read_channel` permission or be uploader of the file.\n","parameters":[{"name":"file_id","in":"path","description":"The ID of the file to get","required":true,"schema":{"type":"string"}}],"responses":{"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nfileID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\ndata, resp := Client.GetFile(fileID)\n"}]}},"/files/{file_id}/thumbnail":{"get":{"tags":["files"],"summary":"Get a file's thumbnail","description":"Gets a file's thumbnail.\n##### Permissions\nMust have `read_channel` permission or be uploader of the file.\n","parameters":[{"name":"file_id","in":"path","description":"The ID of the file to get","required":true,"schema":{"type":"string"}}],"responses":{"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nfileID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\ndata, resp := Client.GetFileThumbnail(fileID)\n"}]}},"/files/{file_id}/preview":{"get":{"tags":["files"],"summary":"Get a file's preview","description":"Gets a file's preview.\n##### Permissions\nMust have `read_channel` permission or be uploader of the file.\n","parameters":[{"name":"file_id","in":"path","description":"The ID of the file to get","required":true,"schema":{"type":"string"}}],"responses":{"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nfileID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\ndata, resp := Client.GetFilePreview(fileID)\n"}]}},"/files/{file_id}/link":{"get":{"tags":["files"],"summary":"Get a public file link","description":"Gets a public link for a file that can be accessed without logging into Mattermost.\n##### Permissions\nMust have `read_channel` permission or be uploader of the file.\n","parameters":[{"name":"file_id","in":"path","description":"The ID of the file to get a link for","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A publicly accessible link to the given file","content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"string"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nfileID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\ndata, resp := Client.GetFileLink(fileID)\n"}]}},"/files/{file_id}/info":{"get":{"tags":["files"],"summary":"Get metadata for a file","description":"Gets a file's info.\n##### Permissions\nMust have `read_channel` permission or be uploader of the file.\n","parameters":[{"name":"file_id","in":"path","description":"The ID of the file info to get","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The stored metadata for the given file","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileInfo"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nfileID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\ninfo, resp := Client.GetFileInfo(fileID)\n"}]}},"/jobs":{"get":{"tags":["jobs"],"summary":"Get the jobs.","description":"Get a page of jobs. Use the query parameters to modify the behaviour of this endpoint.\n__Minimum server version: 4.1__\n##### Permissions\nMust have `manage_jobs` permission.\n","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of jobs per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Job list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Job"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}},"post":{"tags":["jobs"],"summary":"Create a new job.","description":"Create a new job.\n__Minimum server version: 4.1__\n##### Permissions\nMust have `manage_jobs` permission.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of job to create"},"data":{"type":"object","description":"An object containing any additional data required for this job type"}}}}},"description":"Job object to be created","required":true},"responses":{"201":{"description":"Job creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/jobs/{job_id}":{"get":{"tags":["jobs"],"summary":"Get a job.","description":"Gets a single job.\n__Minimum server version: 4.1__\n##### Permissions\nMust have `manage_jobs` permission.\n","parameters":[{"name":"job_id","in":"path","description":"Job GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Job retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/jobs/{job_id}/cancel":{"post":{"tags":["jobs"],"summary":"Cancel a job.","description":"Cancel a job.\n__Minimum server version: 4.1__\n##### Permissions\nMust have `manage_jobs` permission.\n","parameters":[{"name":"job_id","in":"path","description":"Job GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Job canceled successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/jobs/type/{type}":{"get":{"tags":["jobs"],"summary":"Get the jobs of the given type.","description":"Get a page of jobs of the given type. Use the query parameters to modify the behaviour of this endpoint.\n__Minimum server version: 4.1__\n##### Permissions\nMust have `manage_jobs` permission.\n","parameters":[{"name":"type","in":"path","description":"Job type","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of jobs per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Job list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Job"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/system/ping":{"get":{"tags":["system"],"summary":"Check system health","description":"Check if the server is up and healthy based on the configuration setting `GoRoutineHealthThreshold`. If `GoRoutineHealthThreshold` and the number of goroutines on the server exceeds that threshold the server is considered unhealthy. If `GoRoutineHealthThreshold` is not set or the number of goroutines is below the threshold the server is considered healthy.\n__Minimum server version__: 3.10\n##### Permissions\nMust be logged in.\n","responses":{"200":{"description":"Status of the system","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetPing\nstatus, resp := Client.GetPing()\n"}]}},"/database/recycle":{"post":{"tags":["system"],"summary":"Recycle database connections","description":"Recycle database connections by closing and reconnecting all connections to master and read replica databases.\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"Database recycle successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nok, resp := Client.DatabaseRecycle()\n"}]}},"/email/test":{"post":{"tags":["system"],"summary":"Send a test email","description":"Send a test email to make sure you have your email settings configured correctly. Optionally provide a configuration in the request body to test. If no valid configuration is present in the request body the current server configuration will be tested.\n##### Permissions\nMust have `manage_system` permission.\n","requestBody":{"description":"Mattermost configuration","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Config"}}}},"responses":{"200":{"description":"Email successful sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nconfig := model.Config{\n EmailSettings: model.EmailSettings{\n SMTPServer: <SMTPServer>,\n SMTPPort: <SMTPPort>,\n SMTPUsername: <SMTPUsername>,\n SMTPPassword: <SMTPPassword>,\n },\n}\n\n// TestEmail\nok, resp := Client.TestEmail(&config)\n"}]}},"/site_url/test":{"post":{"tags":["system"],"summary":"Checks the validity of a Site URL","description":"Sends a Ping request to the mattermost server using the specified Site URL.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.16\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["site_url"],"properties":{"site_url":{"type":"string","description":"The Site URL to test"}}}}},"required":true},"responses":{"200":{"description":"Site URL is valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nsiteURL := \"https://your-new-mattermost-url.com\"\n\n// TestSiteURL\nok, resp := Client.TestSiteURL(siteUrl)\n"}]}},"/file/s3_test":{"post":{"tags":["system"],"summary":"Test AWS S3 connection","description":"Send a test to validate if can connect to AWS S3. Optionally provide a configuration in the request body to test. If no valid configuration is present in the request body the current server configuration will be tested.\n##### Permissions\nMust have `manage_system` permission.\n__Minimum server version__: 4.8\n","requestBody":{"description":"Mattermost configuration","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Config"}}}},"responses":{"200":{"description":"S3 Test successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nconfig := model.Config{\n FileSettings: model.FileSettings{\n DriverName: model.NewString(model.IMAGE_DRIVER_S3),\n AmazonS3AccessKeyId: <AmazonS3AccessKeyId>,\n AmazonS3SecretAccessKey: <AmazonS3SecretAccessKey>,\n AmazonS3Bucket: <AmazonS3Bucket>,\n AmazonS3Endpoint: <AmazonS3Endpoint>\n },\n}\n\n// TestS3Connection\nok, resp := Client.TestS3Connection(&config)\n"}]}},"/config":{"get":{"tags":["system"],"summary":"Get configuration","description":"Retrieve the current server configuration\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"Configuration retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Config"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetConfig\nconfig, resp := Client.GetConfig()\n"}]},"put":{"tags":["system"],"summary":"Update configuration","description":"Submit a new configuration for the server to use. As of server version 4.8, the `PluginSettings.EnableUploads` setting cannot be modified by this endpoint.\n##### Permissions\nMust have `manage_system` permission.\n","requestBody":{"description":"Mattermost configuration","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Config"}}}},"responses":{"200":{"description":"Configuration update successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Config"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetConfig\nconfig, resp := Client.GetConfig()\n\nconfig.TeamSettings.SiteName = \"MyFancyName\"\n\n// UpdateConfig\nupdatedConfig, resp := Client.UpdateConfig(config)\n"}]}},"/config/reload":{"post":{"tags":["system"],"summary":"Reload configuration","description":"Reload the configuration file to pick up on any changes made to it.\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"Configuration reload successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// ReloadConfig\nok, resp := Client.ReloadConfig()\n"}]}},"/config/client":{"get":{"tags":["system"],"summary":"Get client configuration","description":"Get a subset of the server configuration needed by the client.\n##### Permissions\nNo permission required.\n","parameters":[{"name":"format","in":"query","required":true,"description":"Must be `old`, other formats not implemented yet","schema":{"type":"string"}}],"responses":{"200":{"description":"Configuration retrieval successful"},"400":{"$ref":"#/components/responses/BadRequest"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetOldClientConfig\nok, resp := Client.GetOldClientConfig()\n"}]}},"/config/environment":{"get":{"tags":["system"],"summary":"Get configuration made through environment variables","description":"Retrieve a json object mirroring the server configuration where fields are set to true\nif the corresponding config setting is set through an environment variable. Settings\nthat haven't been set through environment variables will be missing from the object.\n\n__Minimum server version__: 4.10\n\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"Configuration retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentConfig"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/config/patch":{"put":{"tags":["system"],"summary":"Patch configuration","description":"Submit configuration to patch. As of server version 4.8, the `PluginSettings.EnableUploads` setting cannot be modified by this endpoint.\n##### Permissions\nMust have `manage_system` permission.\n__Minimum server version__: 5.20\n","requestBody":{"description":"Mattermost configuration","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Config"}}}},"responses":{"200":{"description":"Configuration update successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Config"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetConfig\nconfig, resp := Client.GetConfig()\n\nconfig.TeamSettings.SiteName = \"MyFancyName\"\n\n// UpdateConfig\nupdatedConfig, resp := Client.PatchConfig(config)\n"}]}},"/license":{"post":{"tags":["system"],"summary":"Upload license file","description":"Upload a license to enable enterprise features.\n\n__Minimum server version__: 4.0\n\n##### Permissions\nMust have `manage_system` permission.\n","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"license":{"description":"The license to be uploaded","type":"string","format":"binary"}},"required":["license"]}}}},"responses":{"201":{"description":"License file upload successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"413":{"$ref":"#/components/responses/TooLarge"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nfile, err := os.Open(\"<Your license file>\")\nif err != nil {\n return err\n}\ndefer file.Close()\n\ndata := &bytes.Buffer{}\nif _, err := io.Copy(data, file); err != nil {\n return err\n}\n\nok, resp := Client.UploadLicenseFile(data.Bytes())\n"}]},"delete":{"tags":["system"],"summary":"Remove license file","description":"Remove the license file from the server. This will disable all enterprise features.\n\n__Minimum server version__: 4.0\n\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"License removal successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/license/client":{"get":{"tags":["system"],"summary":"Get client license","description":"Get a subset of the server license needed by the client.\n##### Permissions\nNo permission required but having the `manage_system` permission returns more information.\n","parameters":[{"name":"format","in":"query","required":true,"description":"Must be `old`, other formats not implemented yet","schema":{"type":"string"}}],"responses":{"200":{"description":"License retrieval successful"},"400":{"$ref":"#/components/responses/BadRequest"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetOldClientLicense\nlicense, resp := Client.GetOldClientLicense()\n"}]}},"/audits":{"get":{"tags":["system"],"summary":"Get audits","description":"Get a page of audits for all users on the system, selected with `page` and `per_page` query parameters.\n##### Permissions\nMust have `manage_system` permission.\n","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of audits per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Audits retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Audit"}}}}},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetAudits\naudits, resp := Client.GetAudits(0, 100, \"\")\n"}]}},"/caches/invalidate":{"post":{"tags":["system"],"summary":"Invalidate all the caches","description":"Purge all the in-memory caches for the Mattermost server. This can have a temporary negative effect on performance while the caches are re-populated.\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"Caches invalidate successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// InvalidateCaches\nok, resp := Client.InvalidateCaches()\n"}]}},"/logs":{"get":{"tags":["system"],"summary":"Get logs","description":"Get a page of server logs, selected with `page` and `logs_per_page` query parameters.\n##### Permissions\nMust have `manage_system` permission.\n","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"logs_per_page","in":"query","description":"The number of logs per page. There is a maximum limit of 10000 logs per page.","schema":{"type":"string","default":"10000"}}],"responses":{"200":{"description":"Logs retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetLogs\nlogs, resp := Client.GetLogs(0, 10)\n"}]},"post":{"tags":["system"],"summary":"Add log message","description":"Add log messages to the server logs.\n##### Permissions\nUsers with `manage_system` permission can log ERROR or DEBUG messages.\nLogged in users can log ERROR or DEBUG messages when `ServiceSettings.EnableDeveloper` is `true` or just DEBUG messages when `false`.\nNon-logged in users can log ERROR or DEBUG messages when `ServiceSettings.EnableDeveloper` is `true` and cannot log when `false`.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["level","message"],"properties":{"level":{"type":"string","description":"The error level, ERROR or DEBUG"},"message":{"type":"string","description":"Message to send to the server logs"}}}}},"required":true},"responses":{"200":{"description":"Logs sent successful","content":{"application/json":{"schema":{"type":"object","items":{"type":"string"}}}}},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nmessage := make(map[string]string)\nmessage[\"level\"] = \"ERROR\"\nmessage[\"message\"] = \"this is a test\"\n\n// PostLog\n_, resp := Client.PostLog(message)\n"}]}},"/analytics/old":{"get":{"tags":["system"],"summary":"Get analytics","description":"Get some analytics data about the system. This endpoint uses the old format, the `/analytics` route is reserved for the new format when it gets implemented.\n\nThe returned JSON changes based on the `name` query parameter but is always key/value pairs.\n\n__Minimum server version__: 4.0\n\n##### Permissions\nMust have `manage_system` permission.\n","parameters":[{"name":"name","in":"query","required":false,"description":"Possible values are \"standard\", \"post_counts_day\", \"user_counts_with_posts_day\" or \"extra_counts\"","schema":{"type":"string","default":"standard"}},{"name":"team_id","in":"query","required":false,"description":"The team ID to filter the data by","schema":{"type":"string"}}],"responses":{"200":{"description":"Analytics retrieval successful"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/server_busy":{"post":{"tags":["system"],"summary":"Set the server busy (high load) flag","description":"Marks the server as currently having high load which disables non-critical services such as search, statuses and typing notifications.\n\n__Minimum server version__: 5.20\n\n##### Permissions\nMust have `manage_system` permission.\n","parameters":[{"name":"seconds","in":"query","required":false,"description":"Number of seconds until server is automatically marked as not busy.","schema":{"type":"string","default":"3600"}}],"responses":{"200":{"description":"Server busy flag set successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nok, resp := Client.SetServerBusy(300)\n"},{"lang":"curl","source":"curl -X POST \\\n 'http://your-mattermost-url.com/api/v4/server_busy?seconds=3600' \\\n -H 'Authorization: Bearer kno8tcdotpbx3dj1gzcbx9jrqy'\n"}]},"get":{"tags":["system"],"summary":"Get server busy expiry time.","description":"Gets the timestamp corresponding to when the server busy flag will be automatically cleared. \n\n__Minimum server version__: 5.20\n\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"Server busy expires timestamp retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Server_Busy"}}}},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// expires is a time.Time\nexpires, resp := Client.GetServerBusyExpires()\n"},{"lang":"curl","source":"curl -X GET \\\n 'http://your-mattermost-url.com/api/v4/server_busy' \\\n -H 'Authorization: Bearer kno8tcdotpbx3dj1gzcbx9jrqy' \\\n -H 'Content-Type: application/json'\n"}]},"delete":{"tags":["system"],"summary":"Clears the server busy (high load) flag","description":"Marks the server as not having high load which re-enables non-critical services such as search, statuses and typing notifications.\n\n__Minimum server version__: 5.20\n\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"Server busy flag cleared successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nok, resp := Client.ClearServerBusy()\n"},{"lang":"curl","source":"curl -X DELETE \\\n 'http://your-mattermost-url.com/api/v4/server_busy' \\\n -H 'Authorization: Bearer kno8tcdotpbx3dj1gzcbx9jrqy'\n"}]}},"/emoji":{"post":{"tags":["emoji"],"summary":"Create a custom emoji","description":"Create a custom emoji for the team.\n##### Permissions\nMust be authenticated.\n","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"description":"A file to be uploaded","type":"string","format":"binary"},"emoji":{"description":"A JSON object containing a `name` field with the name of the emoji and a `creator_id` field with the id of the authenticated user.","type":"string"}},"required":["image","emoji"]}}}},"responses":{"201":{"description":"Emoji creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Emoji"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"413":{"$ref":"#/components/responses/TooLarge"},"501":{"$ref":"#/components/responses/NotImplemented"}}},"get":{"tags":["emoji"],"summary":"Get a list of custom emoji","description":"Get a page of metadata for custom emoji on the system. Since server version 4.7, sort using the `sort` query parameter.\n##### Permissions\nMust be authenticated.\n","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of users per page.","schema":{"type":"integer","default":60}},{"name":"sort","in":"query","description":"Either blank for no sorting or \"name\" to sort by emoji names. Minimum server version for sorting is 4.7.","schema":{"type":"string","default":""}}],"responses":{"200":{"description":"Emoji list retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Emoji"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/emoji/{emoji_id}":{"get":{"tags":["emoji"],"summary":"Get a custom emoji","description":"Get some metadata for a custom emoji.\n##### Permissions\nMust be authenticated.\n","parameters":[{"name":"emoji_id","in":"path","description":"Emoji GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Emoji retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Emoji"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}}},"delete":{"tags":["emoji"],"summary":"Delete a custom emoji","description":"Delete a custom emoji.\n##### Permissions\nMust have the `manage_team` or `manage_system` permissions or be the user who created the emoji.\n","parameters":[{"name":"emoji_id","in":"path","description":"Emoji GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Emoji delete successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Emoji"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/emoji/name/{emoji_name}":{"get":{"tags":["emoji"],"summary":"Get a custom emoji by name","description":"Get some metadata for a custom emoji using its name.\n##### Permissions\nMust be authenticated.\n\n__Minimum server version__: 4.7\n","parameters":[{"name":"emoji_name","in":"path","description":"Emoji name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Emoji retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Emoji"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/emoji/{emoji_id}/image":{"get":{"tags":["emoji"],"summary":"Get custom emoji image","description":"Get the image for a custom emoji.\n##### Permissions\nMust be authenticated.\n","parameters":[{"name":"emoji_id","in":"path","description":"Emoji GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Emoji image retrieval successful"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/emoji/search":{"post":{"tags":["emoji"],"summary":"Search custom emoji","description":"Search for custom emoji by name based on search criteria provided in the request body. A maximum of 200 results are returned.\n##### Permissions\nMust be authenticated.\n\n__Minimum server version__: 4.7\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["term"],"properties":{"term":{"description":"The term to match against the emoji name.","type":"string"},"prefix_only":{"description":"Set to only search for names starting with the search term.","type":"string"}}}}},"description":"Search criteria","required":true},"responses":{"200":{"description":"Emoji list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Emoji"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/emoji/autocomplete":{"get":{"tags":["emoji"],"summary":"Autocomplete custom emoji","description":"Get a list of custom emoji with names starting with or matching the provided name. Returns a maximum of 100 results.\n##### Permissions\nMust be authenticated.\n\n__Minimum server version__: 4.7\n","parameters":[{"name":"name","in":"query","description":"The emoji name to search.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Emoji list retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Emoji"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/hooks/incoming":{"post":{"tags":["webhooks"],"summary":"Create an incoming webhook","description":"Create an incoming webhook for a channel.\n##### Permissions\n`manage_webhooks` for the channel the webhook is in.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["channel_id"],"properties":{"channel_id":{"type":"string","description":"The ID of a public channel or private group that receives the webhook payloads."},"display_name":{"type":"string","description":"The display name for this incoming webhook"},"description":{"type":"string","description":"The description for this incoming webhook"},"username":{"type":"string","description":"The username this incoming webhook will post as."},"icon_url":{"type":"string","description":"The profile picture this incoming webhook will use when posting."}}}}},"description":"Incoming webhook to be created","required":true},"responses":{"201":{"description":"Incoming webhook creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingWebhook"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}},"get":{"tags":["webhooks"],"summary":"List incoming webhooks","description":"Get a page of a list of incoming webhooks. Optionally filter for a specific team using query parameters.\n##### Permissions\n`manage_webhooks` for the system or `manage_webhooks` for the specific team.\n","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of hooks per page.","schema":{"type":"integer","default":60}},{"name":"team_id","in":"query","description":"The ID of the team to get hooks for.","schema":{"type":"string"}}],"responses":{"200":{"description":"Incoming webhooks retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IncomingWebhook"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/hooks/incoming/{hook_id}":{"get":{"tags":["webhooks"],"summary":"Get an incoming webhook","description":"Get an incoming webhook given the hook id.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.\n","parameters":[{"name":"hook_id","in":"path","description":"Incoming Webhook GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingWebhook"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["webhooks"],"summary":"Update an incoming webhook","description":"Update an incoming webhook given the hook id.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.\n","parameters":[{"name":"hook_id","in":"path","description":"Incoming Webhook GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","channel_id","display_name","description"],"properties":{"hook_id":{"type":"string","description":"Incoming webhook GUID"},"channel_id":{"type":"string","description":"The ID of a public channel or private group that receives the webhook payloads."},"display_name":{"type":"string","description":"The display name for this incoming webhook"},"description":{"type":"string","description":"The description for this incoming webhook"},"username":{"type":"string","description":"The username this incoming webhook will post as."},"icon_url":{"type":"string","description":"The profile picture this incoming webhook will use when posting."}}}}},"description":"Incoming webhook to be updated","required":true},"responses":{"200":{"description":"Webhook update successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingWebhook"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/hooks/outgoing":{"post":{"tags":["webhooks"],"summary":"Create an outgoing webhook","description":"Create an outgoing webhook for a team.\n##### Permissions\n`manage_webhooks` for the team the webhook is in.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["team_id","display_name","trigger_words","callback_urls"],"properties":{"team_id":{"description":"The ID of the team that the webhook watchs","type":"string"},"channel_id":{"description":"The ID of a public channel that the webhook watchs","type":"string"},"description":{"description":"The description for this outgoing webhook","type":"string"},"display_name":{"description":"The display name for this outgoing webhook","type":"string"},"trigger_words":{"description":"List of words for the webhook to trigger on","type":"array","items":{"type":"string"}},"trigger_when":{"description":"When to trigger the webhook, `0` when a trigger word is present at all and `1` if the message starts with a trigger word","type":"integer"},"callback_urls":{"description":"The URLs to POST the payloads to when the webhook is triggered","type":"array","items":{"type":"string"}},"content_type":{"description":"The format to POST the data in, either `application/json` or `application/x-www-form-urlencoded`","default":"application/x-www-form-urlencoded","type":"string"}}}}},"description":"Outgoing webhook to be created","required":true},"responses":{"201":{"description":"Outgoing webhook creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingWebhook"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"get":{"tags":["webhooks"],"summary":"List outgoing webhooks","description":"Get a page of a list of outgoing webhooks. Optionally filter for a specific team or channel using query parameters.\n##### Permissions\n`manage_webhooks` for the system or `manage_webhooks` for the specific team/channel.\n","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of hooks per page.","schema":{"type":"integer","default":60}},{"name":"team_id","in":"query","description":"The ID of the team to get hooks for.","schema":{"type":"string"}},{"name":"channel_id","in":"query","description":"The ID of the channel to get hooks for.","schema":{"type":"string"}}],"responses":{"200":{"description":"Outgoing webhooks retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OutgoingWebhook"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/hooks/outgoing/{hook_id}":{"get":{"tags":["webhooks"],"summary":"Get an outgoing webhook","description":"Get an outgoing webhook given the hook id.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.\n","parameters":[{"name":"hook_id","in":"path","description":"Outgoing webhook GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Outgoing webhook retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingWebhook"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"delete":{"tags":["webhooks"],"summary":"Delete an outgoing webhook","description":"Delete an outgoing webhook given the hook id.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.\n","parameters":[{"name":"hook_id","in":"path","description":"Outgoing webhook GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook deletion successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"tags":["webhooks"],"summary":"Update an outgoing webhook","description":"Update an outgoing webhook given the hook id.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.\n","parameters":[{"name":"hook_id","in":"path","description":"outgoing Webhook GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","channel_id","display_name","description"],"properties":{"hook_id":{"type":"string","description":"Outgoing webhook GUID"},"channel_id":{"type":"string","description":"The ID of a public channel or private group that receives the webhook payloads."},"display_name":{"type":"string","description":"The display name for this incoming webhook"},"description":{"type":"string","description":"The description for this incoming webhook"}}}}},"description":"Outgoing webhook to be updated","required":true},"responses":{"200":{"description":"Webhook update successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingWebhook"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/hooks/outgoing/{hook_id}/regen_token":{"post":{"tags":["webhooks"],"summary":"Regenerate the token for the outgoing webhook.","description":"Regenerate the token for the outgoing webhook.\n##### Permissions\n`manage_webhooks` for system or `manage_webhooks` for the specific team or `manage_webhooks` for the channel.\n","parameters":[{"name":"hook_id","in":"path","description":"Outgoing webhook GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook token regenerate successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/saml/metadata":{"get":{"tags":["SAML"],"summary":"Get metadata","description":"Get SAML metadata from the server. SAML must be configured properly.\n##### Permissions\nNo permission required.\n","responses":{"200":{"description":"SAML metadata retrieval successful","content":{"application/json":{"schema":{"type":"string"}}}},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/saml/certificate/idp":{"post":{"tags":["SAML"],"summary":"Upload IDP certificate","description":"Upload the IDP certificate to be used with your SAML configuration. The server will pick a hard-coded filename for the IdpCertificateFile setting in your `config.json`.\n##### Permissions\nMust have `manage_system` permission.\n","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"certificate":{"description":"The IDP certificate file","type":"string","format":"binary"}},"required":["certificate"]}}}},"responses":{"200":{"description":"SAML certificate upload successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}},"delete":{"tags":["SAML"],"summary":"Remove IDP certificate","description":"Delete the current IDP certificate being used with your SAML configuration. This will also disable SAML on your system as this certificate is required for SAML.\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"SAML certificate delete successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/saml/certificate/public":{"post":{"tags":["SAML"],"summary":"Upload public certificate","description":"Upload the public certificate to be used for encryption with your SAML configuration. The server will pick a hard-coded filename for the PublicCertificateFile setting in your `config.json`.\n##### Permissions\nMust have `manage_system` permission.\n","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"certificate":{"description":"The public certificate file","type":"string","format":"binary"}},"required":["certificate"]}}}},"responses":{"200":{"description":"SAML certificate upload successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}},"delete":{"tags":["SAML"],"summary":"Remove public certificate","description":"Delete the current public certificate being used with your SAML configuration. This will also disable encryption for SAML on your system as this certificate is required for that.\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"SAML certificate delete successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/saml/certificate/private":{"post":{"tags":["SAML"],"summary":"Upload private key","description":"Upload the private key to be used for encryption with your SAML configuration. The server will pick a hard-coded filename for the PrivateKeyFile setting in your `config.json`.\n##### Permissions\nMust have `manage_system` permission.\n","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"certificate":{"description":"The private key file","type":"string","format":"binary"}},"required":["certificate"]}}}},"responses":{"200":{"description":"SAML certificate upload successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}},"delete":{"tags":["SAML"],"summary":"Remove private key","description":"Delete the current private key being used with your SAML configuration. This will also disable encryption for SAML on your system as this key is required for that.\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"SAML certificate delete successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/saml/certificate/status":{"get":{"tags":["SAML"],"summary":"Get certificate status","description":"Get the status of the uploaded certificates and keys in use by your SAML configuration.\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"SAML certificate status retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SamlCertificateStatus"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/compliance/reports":{"post":{"tags":["compliance"],"summary":"Create report","description":"Create and save a compliance report.\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"201":{"description":"Compliance report creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Compliance"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}},"get":{"tags":["compliance"],"summary":"Get reports","description":"Get a list of compliance reports previously created by page, selected with `page` and `per_page` query parameters.\n##### Permissions\nMust have `manage_system` permission.\n","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of reports per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Compliance reports retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Compliance"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/compliance/reports/{report_id}":{"get":{"tags":["compliance"],"summary":"Get a report","description":"Get a compliance reports previously created.\n##### Permissions\nMust have `manage_system` permission.\n","parameters":[{"name":"report_id","in":"path","description":"Compliance report GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Compliance report retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Compliance"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/compliance/reports/{report_id}/download":{"get":{"tags":["compliance"],"summary":"Download a report","description":"Download the full contents of a report as a file.\n##### Permissions\nMust have `manage_system` permission.\n","parameters":[{"name":"report_id","in":"path","description":"Compliance report GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The compliance report file"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/ldap/sync":{"post":{"tags":["LDAP"],"summary":"Sync with LDAP","description":"Synchronize any user attribute changes in the configured AD/LDAP server with Mattermost.\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"LDAP sync successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/ldap/test":{"post":{"tags":["LDAP"],"summary":"Test LDAP configuration","description":"Test the current AD/LDAP configuration to see if the AD/LDAP server can be contacted successfully.\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"LDAP test successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/groups":{"get":{"tags":["groups"],"summary":"Get groups","description":"Retrieve a list of all groups not associated to a particular channel or team. \n\n`not_associated_to_team` **OR** `not_associated_to_channel` is required. \n\nIf you use `not_associated_to_team`, you must be a team admin for that particular team (permission to manage that team). \n\nIf you use `not_associated_to_channel`, you must be a channel admin for that particular channel (permission to manage that channel). \n\n__Minimum server version__: 5.11\n","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of groups per page.","schema":{"type":"integer","default":60}},{"name":"q","in":"query","description":"String to pattern match the `name` and `display_name` field. Will return all groups whose `name` and `display_name` field match any of the text.","schema":{"type":"string"}},{"name":"include_member_count","in":"query","description":"Boolean which adds the `member_count` attribute to each group JSON object","schema":{"type":"boolean"}},{"name":"not_associated_to_team","in":"query","description":"Team GUID which is used to return all the groups not associated to this team","required":true,"schema":{"type":"string"}},{"name":"not_associated_to_channel","in":"query","description":"Group GUID which is used to return all the groups not associated to this channel","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Group list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/groups/{group_id}":{"get":{"tags":["groups"],"summary":"Get a group","description":"Get group from the provided group id string\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.11\n","parameters":[{"name":"group_id","in":"path","description":"Group GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Group retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/groups/{group_id}/patch":{"put":{"tags":["groups"],"summary":"Patch a group","description":"Partially update a group by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.11\n","parameters":[{"name":"group_id","in":"path","description":"Group GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"description":{"type":"string"}}}}},"description":"Group object that is to be updated","required":true},"responses":{"200":{"description":"Group patch successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/groups/{group_id}/teams/{team_id}/link":{"post":{"tags":["groups"],"summary":"Link a team to a group","description":"Link a team to a group\n##### Permissions\nMust have `manage_team` permission.\n\n__Minimum server version__: 5.11\n","parameters":[{"name":"group_id","in":"path","description":"Group GUID","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Team successfully linked to group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupSyncableTeam"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}},"delete":{"tags":["groups"],"summary":"Delete a link from a team to a group","description":"Delete a link from a team to a group\n##### Permissions\nMust have `manage_team` permission.\n\n__Minimum server version__: 5.11\n","parameters":[{"name":"group_id","in":"path","description":"Group GUID","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully deleted link between team and group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/groups/{group_id}/channels/{channel_id}/link":{"post":{"tags":["groups"],"summary":"Link a channel to a group","description":"Link a channel to a group\n##### Permissions\nIf the channel is private, you must have `manage_private_channel_members` permission.\nOtherwise, you must have the `manage_public_channel_members` permission.\n\n__Minimum server version__: 5.11\n","parameters":[{"name":"group_id","in":"path","description":"Group GUID","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Channel successfully linked to group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupSyncableChannel"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}},"delete":{"tags":["groups"],"summary":"Delete a link from a channel to a group","description":"Delete a link from a channel to a group\n##### Permissions\nIf the channel is private, you must have `manage_private_channel_members` permission.\nOtherwise, you must have the `manage_public_channel_members` permission.\n\n__Minimum server version__: 5.11\n","parameters":[{"name":"group_id","in":"path","description":"Group GUID","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully deleted link between channel and group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/groups/{group_id}/teams/{team_id}":{"get":{"tags":["groups"],"summary":"Get GroupSyncable from Team ID","description":"Get the GroupSyncable object with group_id and team_id from params\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.11\n","parameters":[{"name":"group_id","in":"path","description":"Group GUID","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"GroupSyncable object retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupSyncableTeam"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/groups/{group_id}/channels/{channel_id}":{"get":{"tags":["groups"],"summary":"Get GroupSyncable from channel ID","description":"Get the GroupSyncable object with group_id and channel_id from params\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.11\n","parameters":[{"name":"group_id","in":"path","description":"Group GUID","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"GroupSyncable object retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupSyncableChannel"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/groups/{group_id}/teams":{"get":{"tags":["groups"],"summary":"Get group teams","description":"Retrieve the list of teams associated to the group\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.11\n","parameters":[{"name":"group_id","in":"path","description":"Group GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Teams list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupSyncableTeams"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/groups/{group_id}/channels":{"get":{"tags":["groups"],"summary":"Get group channels","description":"Retrieve the list of channels associated to the group\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.11\n","parameters":[{"name":"group_id","in":"path","description":"Group GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Channel list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupSyncableChannels"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/groups/{group_id}/teams/{team_id}/patch":{"put":{"tags":["groups"],"summary":"Patch a GroupSyncable associated to Team","description":"Partially update a GroupSyncable by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.11\n","parameters":[{"name":"group_id","in":"path","description":"Group GUID","required":true,"schema":{"type":"string"}},{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"GroupSyncable object that is to be updated","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"auto_add":{"type":"boolean"}}}}}},"responses":{"200":{"description":"GroupSyncable patch successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupSyncableTeam"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/groups/{group_id}/channels/{channel_id}/patch":{"put":{"tags":["groups"],"summary":"Patch a GroupSyncable associated to Channel","description":"Partially update a GroupSyncable by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.11\n","parameters":[{"name":"group_id","in":"path","description":"Group GUID","required":true,"schema":{"type":"string"}},{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"GroupSyncable object that is to be updated","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"auto_add":{"type":"boolean"}}}}}},"responses":{"200":{"description":"GroupSyncable patch successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupSyncableChannel"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/groups/{group_id}/members":{"get":{"tags":["groups"],"summary":"Get group users","description":"Retrieve the list of users associated with a given group.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.11\n","parameters":[{"name":"group_id","in":"path","description":"Group GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of groups per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"User list retrieval successful","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"total_member_count":{"type":"integer"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/channels/{channel_id}/groups":{"get":{"tags":["groups"],"summary":"Get channel groups","description":"Retrieve the list of groups associated with a given channel.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.11\n","parameters":[{"name":"channel_id","in":"path","description":"Channel GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of groups per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Group list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/teams/{team_id}/groups":{"get":{"tags":["groups"],"summary":"Get team groups","description":"Retrieve the list of groups associated with a given team.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.11\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of groups per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Group list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/cluster/status":{"get":{"tags":["cluster"],"summary":"Get cluster status","description":"Get a set of information for each node in the cluster, useful for checking the status and health of each node.\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"Cluster status retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClusterInfo"}}}}},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/brand/image":{"get":{"tags":["brand"],"summary":"Get brand image","description":"Get the previously uploaded brand image. Returns 404 if no brand image has been uploaded.\n##### Permissions\nNo permission required.\n","responses":{"200":{"description":"Brand image retrieval successful","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetBrandImage\nimg, err := Client.GetBrandImage()\n"}]},"post":{"tags":["brand"],"summary":"Upload brand image","description":"Uploads a brand image.\n##### Permissions\nMust have `manage_system` permission.\n","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"description":"The image to be uploaded","type":"string","format":"binary"}},"required":["image"]}}}},"responses":{"201":{"description":"Brand image upload successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"413":{"$ref":"#/components/responses/TooLarge"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nfile, err := os.Open(\"<Your image>\")\nif err != nil {\n return err\n}\ndefer file.Close()\n\ndata := &bytes.Buffer{}\nif _, err := io.Copy(data, file); err != nil {\n return err\n}\n\nok, resp := Client.UploadBrandImage(data.Bytes())\n"}]},"delete":{"tags":["brand"],"summary":"Delete current brand image","description":"Deletes the previously uploaded brand image. Returns 404 if no brand image has been uploaded.\n##### Permissions\nMust have `manage_system` permission.\n__Minimum server version: 5.6__\n","responses":{"200":{"description":"Brand image succesfully deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// Delete brand image\nresp := Client.DeleteBrandImage()\n"}]}},"/commands":{"post":{"tags":["commands"],"summary":"Create a command","description":"Create a command for a team.\n##### Permissions\n`manage_slash_commands` for the team the command is in.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["team_id","method","trigger","url"],"properties":{"team_id":{"type":"string","description":"Team ID to where the command should be created"},"method":{"type":"string","description":"`'P'` for post request, `'G'` for get request"},"trigger":{"type":"string","description":"Activation word to trigger the command"},"url":{"type":"string","description":"The URL that the command will make the request"}}}}},"description":"command to be created","required":true},"responses":{"201":{"description":"Command creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Command"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nnewCmd := &model.Command {\n TeamId: <TEAMID>,\n URL: \"http://nowhere.com\",\n Method: model.COMMAND_METHOD_POST,\n Trigger: \"trigger\",\n AutoComplete: false,\n Description: \"Description\",\n DisplayName: \"Display name\",\n IconURL: \"IconURL\",\n Username: \"Username\"\n}\n\n// CreateCommand\ncreatedCmd, resp := Client.CreateCommand(newCmd)\n"}]},"get":{"tags":["commands"],"summary":"List commands for a team","description":"List commands for a team.\n##### Permissions\n`manage_slash_commands` if need list custom commands.\n","parameters":[{"name":"team_id","in":"query","description":"The team id.","schema":{"type":"string"}},{"name":"custom_only","in":"query","description":"To get only the custom commands. If set to false will get the custom\nif the user have access plus the system commands, otherwise just the system commands.\n","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"List Commands retrieve successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Command"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// ListCommands\n// The second parameter is to set if you want only custom commands (true) or defaults commands (false)\nlistCommands, resp := Client.ListCommands(<TEAMID>, true)\n"}]}},"/teams/{team_id}/commands/autocomplete":{"get":{"tags":["commands"],"summary":"List autocomplete commands","description":"List autocomplete commands in the team.\n##### Permissions\n`view_team` for the team.\n","parameters":[{"name":"team_id","in":"path","description":"Team GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Autocomplete commands retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Command"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// ListAutocompleteCommands\nlistCommands, resp := Client.ListAutocompleteCommands(<TEAMID>)\n"}]}},"/commands/{command_id}":{"get":{"tags":["commands"],"summary":"Get a command","description":"Get a command definition based on command id string.\n##### Permissions\nMust have `manage_slash_commands` permission for the team the command is in.\n\n__Minimum server version__: 5.22\n","parameters":[{"in":"path","name":"command_id","description":"ID of the command to get","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Command get successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Command"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// GetCommand\ncmd, resp := Client.GetCommand(<COMMANDID>)\n"}]},"put":{"tags":["commands"],"summary":"Update a command","description":"Update a single command based on command id string and Command struct.\n##### Permissions\nMust have `manage_slash_commands` permission for the team the command is in.\n","parameters":[{"in":"path","name":"command_id","description":"ID of the command to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Command"}}},"required":true},"responses":{"200":{"description":"Command updated successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Command"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\ncmdToUpdate := &model.Command{\n CreatorId: <USERID>,\n TeamId: <TEAMID>,\n URL: \"<http://nowhere.com/change>\",\n Trigger: <NEWTRIGGERNAME>,\n Id: <COMMANDID>,\n}\n\n// UpdateCommand\nlistCommands, resp := Client.UpdateCommand(cmdToUpdate)\n"}]},"delete":{"tags":["commands"],"summary":"Delete a command","description":"Delete a command based on command id string.\n##### Permissions\nMust have `manage_slash_commands` permission for the team the command is in.\n","parameters":[{"in":"path","name":"command_id","description":"ID of the command to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Command deletion successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// DeleteCommand\nok, resp := Client.DeleteCommand(<COMMANDID>)\n"}]}},"/commands/{command_id}/move":{"put":{"tags":["commands"],"summary":"Move a command","description":"Move a command to a different team based on command id string.\n##### Permissions\nMust have `manage_slash_commands` permission for the team the command is currently in and the destination team.\n\n__Minimum server version__: 5.22\n","parameters":[{"in":"path","name":"command_id","description":"ID of the command to move","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"team_id":{"type":"string","description":"Destination teamId"}}}}},"required":true},"responses":{"200":{"description":"Command move successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// MoveCommand\nok, resp := Client.MoveCommand(<TEAMID>,<COMMANDID>)\n"}]}},"/commands/{command_id}/regen_token":{"put":{"tags":["commands"],"summary":"Generate a new token","description":"Generate a new token for the command based on command id string.\n##### Permissions\nMust have `manage_slash_commands` permission for the team the command is in.\n","parameters":[{"in":"path","name":"command_id","description":"ID of the command to generate the new token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Token generation successful","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"description":"The new token","type":"string"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\n// RegenCommandToken\nnewToken, resp := Client.RegenCommandToken(<COMMANDID>)\n"}]}},"/commands/execute":{"post":{"tags":["commands"],"summary":"Execute a command","description":"Execute a command on a team.\n##### Permissions\nMust have `use_slash_commands` permission for the team the command is in.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["channel_id","command"],"properties":{"channel_id":{"type":"string","description":"Channel Id where the command will execute"},"command":{"type":"string","description":"The slash command to execute"}}}}},"description":"command to be executed","required":true},"responses":{"200":{"description":"Command execution successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/oauth/apps":{"post":{"tags":["OAuth"],"summary":"Register OAuth app","description":"Register an OAuth 2.0 client application with Mattermost as the service provider.\n##### Permissions\nMust have `manage_oauth` permission.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","description","callback_urls","homepage"],"properties":{"name":{"type":"string","description":"The name of the client application"},"description":{"type":"string","description":"A short description of the application"},"icon_url":{"type":"string","description":"A URL to an icon to display with the application"},"callback_urls":{"type":"array","items":{"type":"string"},"description":"A list of callback URLs for the appliation"},"homepage":{"type":"string","description":"A link to the website of the application"},"is_trusted":{"type":"boolean","description":"Set this to `true` to skip asking users for permission"}}}}},"description":"OAuth application to register","required":true},"responses":{"201":{"description":"App registration successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApp"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}},"get":{"tags":["OAuth"],"summary":"Get OAuth apps","description":"Get a page of OAuth 2.0 client applications registered with Mattermost.\n##### Permissions\nWith `manage_oauth` permission, the apps registered by the logged in user are returned. With `manage_system_wide_oauth` permission, all apps regardless of creator are returned.\n","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of apps per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"OAuthApp list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OAuthApp"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/oauth/apps/{app_id}":{"get":{"tags":["OAuth"],"summary":"Get an OAuth app","description":"Get an OAuth 2.0 client application registered with Mattermost.\n##### Permissions\nIf app creator, must have `mange_oauth` permission otherwise `manage_system_wide_oauth` permission is required.\n","parameters":[{"name":"app_id","in":"path","description":"Application client id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"App retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApp"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}}},"put":{"tags":["OAuth"],"summary":"Update an OAuth app","description":"Update an OAuth 2.0 client application based on OAuth struct.\n##### Permissions\nIf app creator, must have `mange_oauth` permission otherwise `manage_system_wide_oauth` permission is required.\n","parameters":[{"name":"app_id","in":"path","description":"Application client id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","description","callback_urls","homepage"],"properties":{"id":{"type":"string","description":"The id of the client application"},"name":{"type":"string","description":"The name of the client application"},"description":{"type":"string","description":"A short description of the application"},"icon_url":{"type":"string","description":"A URL to an icon to display with the application"},"callback_urls":{"type":"array","items":{"type":"string"},"description":"A list of callback URLs for the appliation"},"homepage":{"type":"string","description":"A link to the website of the application"},"is_trusted":{"type":"boolean","description":"Set this to `true` to skip asking users for permission. It will be set to false if value is not provided."}}}}},"description":"OAuth application to update","required":true},"responses":{"200":{"description":"App update successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApp"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nappToUpdate := &model.OAuthApp{\n Id: <APP ID>,\n Name: <APP NAME>,\n Description: <APP DESCRIPTION>,\n IconURL: <URL TO APP ICON>,\n CallbackUrls: [<CALLBACK URL1>, <CALLBACK URL2>],\n Homepage: <URL TO APP HOMEPAGE>,\n IsTrusted: <BOOLEAN>\n}\n\n// UpdateOAuthApp\nupdatedApp, resp := Client.UpdateOAuthApp(appToUpdate)\n"}]},"delete":{"tags":["OAuth"],"summary":"Delete an OAuth app","description":"Delete and unregister an OAuth 2.0 client application \n##### Permissions\nIf app creator, must have `mange_oauth` permission otherwise `manage_system_wide_oauth` permission is required.\n","parameters":[{"name":"app_id","in":"path","description":"Application client id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"App deletion successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/oauth/apps/{app_id}/regen_secret":{"post":{"tags":["OAuth"],"summary":"Regenerate OAuth app secret","description":"Regenerate the client secret for an OAuth 2.0 client application registered with Mattermost.\n##### Permissions\nIf app creator, must have `mange_oauth` permission otherwise `manage_system_wide_oauth` permission is required.\n","parameters":[{"name":"app_id","in":"path","description":"Application client id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Secret regeneration successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApp"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/oauth/apps/{app_id}/info":{"get":{"tags":["OAuth"],"summary":"Get info on an OAuth app","description":"Get public information about an OAuth 2.0 client application registered with Mattermost. The application's client secret will be blanked out.\n##### Permissions\nMust be authenticated.\n","parameters":[{"name":"app_id","in":"path","description":"Application client id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"App retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApp"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/users/{user_id}/oauth/apps/authorized":{"get":{"tags":["OAuth"],"summary":"Get authorized OAuth apps","description":"Get a page of OAuth 2.0 client applications authorized to access a user's account.\n##### Permissions\nMust be authenticated as the user or have `edit_other_users` permission.\n","parameters":[{"name":"user_id","in":"path","description":"User GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of apps per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"OAuthApp list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OAuthApp"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/elasticsearch/test":{"post":{"tags":["elasticsearch"],"summary":"Test Elasticsearch configuration","description":"Test the current Elasticsearch configuration to see if the Elasticsearch server can be contacted successfully.\nOptionally provide a configuration in the request body to test. If no valid configuration is present in the\nrequest body the current server configuration will be tested.\n\n__Minimum server version__: 4.1\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"Elasticsearch test successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/elasticsearch/purge_indexes":{"post":{"tags":["elasticsearch"],"summary":"Purge all Elasticsearch indexes","description":"Deletes all Elasticsearch indexes and their contents. After calling this endpoint, it is\nnecessary to schedule a new Elasticsearch indexing job to repopulate the indexes.\n__Minimum server version__: 4.1\n##### Permissions\nMust have `manage_system` permission.\n","responses":{"200":{"description":"Indexes purged successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/data_retention/policy":{"get":{"tags":["dataretention"],"summary":"Get the data retention policy details.","description":"Gets the current data retention policy details from the server, including what data should be purged and the cutoff times for each data type that should be purged.\n__Minimum server version__: 4.3\n##### Permissions\nRequires an active session but no other permissions.\n","responses":{"200":{"description":"Data retention policy details retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataRetentionPolicy"}}}},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/plugins":{"post":{"tags":["plugins"],"summary":"Upload plugin","description":"Upload a plugin that is contained within a compressed .tar.gz file. Plugins and plugin uploads must be enabled in the server's config settings.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 4.4\n","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"plugin":{"description":"The plugin image to be uploaded","type":"string","format":"binary"},"force":{"description":"Set to 'true' to overwrite a previously installed plugin with the same ID, if any","type":"string"}},"required":["plugin"]}}}},"responses":{"201":{"description":"Plugin upload successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"413":{"$ref":"#/components/responses/TooLarge"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import (\n \"bytes\"\n \"io/ioutil\"\n \"log\"\n\n \"github.com/mattermost/mattermost-server/model\"\n)\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\ntarData, err := ioutil.ReadFile(\"plugin.tar.gz\")\nif err != nil {\n log.Fatal(\"error while reading file\")\n}\n\n// Not forced\nmanifest, resp := Client.UploadPlugin(bytes.NewReader(tarData))\n\n// Forced\nmanifest, resp := Client.UploadPluginForced(bytes.NewReader(tarData))\n"}]},"get":{"tags":["plugins"],"summary":"Get plugins","description":"Get a list of inactive and a list of active plugin manifests. Plugins must be enabled in the server's config settings.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 4.4\n","responses":{"200":{"description":"Plugins retrieval successful","content":{"application/json":{"schema":{"type":"object","properties":{"active":{"type":"array","items":{"$ref":"#/components/schemas/PluginManifest"}},"inactive":{"type":"array","items":{"$ref":"#/components/schemas/PluginManifest"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\npluginsResp, resp := Client.GetPlugins()\n"}]}},"/plugins/install_from_url":{"post":{"tags":["plugins"],"summary":"Install plugin from url","description":"Supply a URL to a plugin compressed in a .tar.gz file. Plugins must be enabled in the server's config settings.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.14\n","parameters":[{"name":"plugin_download_url","in":"query","description":"URL used to download the plugin","required":true,"schema":{"type":"string"}},{"name":"force","in":"query","description":"Set to 'true' to overwrite a previously installed plugin with the same ID, if any","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Plugin install successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import (\n \"github.com/mattermost/mattermost-server/model\"\n)\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nurl := \"https://mysite.com/my-plugin.tar.gz\"\n\n// Not forced\nmanifest, resp := Client.InstallPluginFromUrl(url, false)\n\n// Forced\nmanifest, resp := Client.InstallPluginFromUrl(url, true)\n"}]}},"/plugins/{plugin_id}":{"delete":{"tags":["plugins"],"summary":"Remove plugin","description":"Remove the plugin with the provided ID from the server. All plugin files are deleted. Plugins must be enabled in the server's config settings.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 4.4\n","parameters":[{"name":"plugin_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Plugin removed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\npluginID := \"com.mattermost.demo-plugin\"\n\nok, resp = Client.RemovePlugin(pluginID)\n"}]}},"/plugins/{plugin_id}/enable":{"post":{"tags":["plugins"],"summary":"Enable plugin","description":"Enable a previously uploaded plugin. Plugins must be enabled in the server's config settings.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 4.4\n","parameters":[{"name":"plugin_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Plugin enabled successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\npluginID := \"com.mattermost.demo-plugin\"\n\nok, resp = Client.EnablePlugin(pluginID)\n"}]}},"/plugins/{plugin_id}/disable":{"post":{"tags":["plugins"],"summary":"Disable plugin","description":"Disable a previously enabled plugin. Plugins must be enabled in the server's config settings.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 4.4\n","parameters":[{"name":"plugin_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Plugin disabled successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\npluginID := \"com.mattermost.demo-plugin\"\n\nok, resp = Client.DisablePlugin(pluginID)\n"}]}},"/plugins/webapp":{"get":{"tags":["plugins"],"summary":"Get webapp plugins","description":"Get a list of web app plugins installed and activated on the server.\n\n##### Permissions\nNo permissions required.\n\n__Minimum server version__: 4.4\n","responses":{"200":{"description":"Plugin deactivated successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PluginManifestWebapp"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\n\nmanifests, resp := Client.GetWebappPlugins()\n"}]}},"/plugins/marketplace":{"post":{"tags":["plugins"],"summary":"Installs a marketplace plugin","description":"Installs a plugin listed in the marketplace server.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.16\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","version"],"properties":{"id":{"type":"string","description":"The ID of the plugin to install."},"version":{"type":"string","description":"The version of the plugin to install."}}}}},"description":"The metadata identifying the plugin to install.","required":true},"responses":{"200":{"description":"Plugin installed successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PluginManifest"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nplugin := &model.InstallMarketplacePluginRequest{\n Id: \"antivirus\",\n Version: \"0.1.2\",\n}\n\nok, resp = Client.InstallMarketplacePlugin(plugin)\n"}]},"get":{"tags":["plugins"],"summary":"Gets all the marketplace plugins","description":"Gets all plugins from the marketplace server, merging data from locally installed plugins as well as prepackaged plugins shipped with the server.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.16\n","parameters":[{"name":"page","in":"query","description":"Page number to be fetched. (not yet implemented)","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"Number of item per page. (not yet implemented)","required":false,"schema":{"type":"integer"}},{"name":"filter","in":"query","description":"Set to filter plugins by ID, name, or description.","required":false,"schema":{"type":"string"}},{"name":"server_version","in":"query","description":"Set to filter minimum plugin server version. (not yet implemented)","required":false,"schema":{"type":"string"}},{"name":"local_only","in":"query","description":"Set true to only retrieve local plugins.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Plugins retrieval successful","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MarketplacePlugin"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nfilter := &model.MarketplacePluginFilter{\n Page: 1,\n PerPage: 10,\n Filter: \"antivirus\",\n ServerVersion: \"0.1.2\",\n LocalOnly: true,\n}\n\nok, resp = Client.GetMarketplacePlugins(filter)\n"}]}},"/roles/{role_id}":{"get":{"tags":["roles"],"summary":"Get a role","description":"Get a role from the provided role id.\n\n##### Permissions\nRequires an active session but no other permissions.\n\n__Minimum server version__: 4.9\n","parameters":[{"name":"role_id","in":"path","description":"Role GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Role retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nrole, resp := Client.GetRole(<ROLEID>, \"\")\n"}]}},"/roles/name/{role_name}":{"get":{"tags":["roles"],"summary":"Get a role","description":"Get a role from the provided role name.\n\n##### Permissions\nRequires an active session but no other permissions.\n\n__Minimum server version__: 4.9\n","parameters":[{"name":"role_name","in":"path","description":"Role Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Role retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nrole, resp := Client.GetRoleByName(<ROLENAME>, \"\")\n"}]}},"/roles/{role_id}/patch":{"put":{"tags":["roles"],"summary":"Patch a role","description":"Partially update a role by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n\n##### Permissions\n`manage_system` permission is required.\n\n__Minimum server version__: 4.9\n","parameters":[{"name":"role_id","in":"path","description":"Role GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"permissions":{"type":"array","items":{"type":"string"},"description":"The permissions the role should grant."}}}}},"description":"Role object to be updated","required":true},"responses":{"200":{"description":"Role patch successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/roles/names":{"post":{"tags":["roles"],"summary":"Get a list of roles by name","description":"Get a list of roles from their names.\n\n##### Permissions\nRequires an active session but no other permissions.\n\n__Minimum server version__: 4.9\n","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"List of role names","required":true},"responses":{"200":{"description":"Role list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Role"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nroleNames := []string{<NAME OF ROLE1>, <NAME OF ROLE2>, ...}\n\nroles, resp := Client.GetRolesByNames(roleNames)\n"}]}},"/schemes":{"get":{"tags":["schemes"],"summary":"Get the schemes.","description":"Get a page of schemes. Use the query parameters to modify the behaviour of this endpoint.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.0\n","parameters":[{"name":"scope","in":"query","description":"Limit the results returned to the provided scope, either `team` or `channel`.","schema":{"type":"string","default":""}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of schemes per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Scheme list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Scheme"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}},"post":{"tags":["schemes"],"summary":"Create a scheme","description":"Create a new scheme.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.0\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","scope"],"properties":{"name":{"type":"string","description":"The name of the scheme"},"description":{"type":"string","description":"The description of the scheme"},"scope":{"type":"string","description":"The scope of the scheme (\"team\" or \"channel\")"}}}}},"description":"Scheme object to create","required":true},"responses":{"201":{"description":"Scheme creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Scheme"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/schemes/{scheme_id}":{"get":{"tags":["schemes"],"summary":"Get a scheme","description":"Get a scheme from the provided scheme id.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.0\n","parameters":[{"name":"scheme_id","in":"path","description":"Scheme GUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Scheme retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Scheme"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nscheme, resp := Client.GetScheme(<SCHEMEID>, \"\")\n"}]},"delete":{"tags":["schemes"],"summary":"Delete a scheme","description":"Soft deletes a scheme, by marking the scheme as deleted in the database.\n\n##### Permissions\nMust have `manage_system` permission.\n\n__Minimum server version__: 5.0\n","parameters":[{"name":"scheme_id","in":"path","description":"ID of the scheme to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Scheme deletion successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/schemes/{scheme_id}/patch":{"put":{"tags":["schemes"],"summary":"Patch a scheme","description":"Partially update a scheme by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n\n##### Permissions\n`manage_system` permission is required.\n\n__Minimum server version__: 5.0\n","parameters":[{"name":"scheme_id","in":"path","description":"Scheme GUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The human readable name of the scheme"},"description":{"type":"string","description":"The description of the scheme"}}}}},"description":"Scheme object to be updated","required":true},"responses":{"200":{"description":"Scheme patch successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Scheme"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/schemes/{scheme_id}/teams":{"get":{"tags":["schemes"],"summary":"Get a page of teams which use this scheme.","description":"Get a page of teams which use this scheme. The provided Scheme ID should be for a Team-scoped Scheme.\nUse the query parameters to modify the behaviour of this endpoint.\n\n##### Permissions\n`manage_system` permission is required.\n\n__Minimum server version__: 5.0\n","parameters":[{"name":"scheme_id","in":"path","description":"Scheme GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of teams per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Team list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Team"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/schemes/{scheme_id}/channels":{"get":{"tags":["schemes"],"summary":"Get a page of channels which use this scheme.","description":"Get a page of channels which use this scheme. The provided Scheme ID should be for a Channel-scoped Scheme.\nUse the query parameters to modify the behaviour of this endpoint.\n\n##### Permissions\n`manage_system` permission is required.\n\n__Minimum server version__: 5.0\n","parameters":[{"name":"scheme_id","in":"path","description":"Scheme GUID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of channels per page.","schema":{"type":"integer","default":60}}],"responses":{"200":{"description":"Channel list retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/opengraph":{"post":{"tags":["OpenGraph"],"summary":"Get open graph metadata for url","description":"Get Open Graph Metadata for a specif URL. Use the Open Graph protocol to get some generic metadata about a URL. Used for creating link previews.\n\n__Minimum server version__: 3.10\n\n##### Permissions\nNo permission required but must be logged in.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"The URL to get Open Graph Metadata."}}}}},"required":true},"responses":{"200":{"description":"Open Graph retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenGraph"}}}},"501":{"$ref":"#/components/responses/NotImplemented"}}}},"/reactions":{"post":{"tags":["reactions"],"summary":"Create a reaction","description":"Create a reaction.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reaction"}}},"description":"The user's reaction with its post_id, user_id, and emoji_name fields set","required":true},"responses":{"201":{"description":"Reaction creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reaction"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/posts/{post_id}/reactions":{"get":{"tags":["reactions"],"summary":"Get a list of reactions to a post","description":"Get a list of reactions made by all users to a given post.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in.\n","parameters":[{"name":"post_id","in":"path","description":"ID of a post","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List reactions retrieve successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Reaction"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/users/{user_id}/posts/{post_id}/reactions/{emoji_name}":{"delete":{"tags":["reactions"],"summary":"Remove a reaction from a post","description":"Deletes a reaction made by a user from the given post.\n##### Permissions\nMust be user or have `manage_system` permission.\n","parameters":[{"name":"user_id","in":"path","description":"ID of the user","required":true,"schema":{"type":"string"}},{"name":"post_id","in":"path","description":"ID of the post","required":true,"schema":{"type":"string"}},{"name":"emoji_name","in":"path","description":"emoji name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Reaction deletion successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/posts/ids/reactions":{"post":{"tags":["reactions"],"summary":"Bulk get the reaction for posts","description":"Get a list of reactions made by all users to a given post.\n##### Permissions\nMust have `read_channel` permission for the channel the post is in.\n\n__Minimum server version__: 5.8\n","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"description":"Array of post IDs","required":true},"responses":{"200":{"description":"Reactions retrieval successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostIdToReactionsMap"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/actions/dialogs/open":{"post":{"tags":["integration_actions"],"summary":"Open a dialog","description":"Open an interactive dialog using a trigger ID provided by a slash command, or some other action payload. See https://docs.mattermost.com/developer/interactive-dialogs.html for more information on interactive dialogs.\n__Minimum server version: 5.6__\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["trigger_id","url","dialog"],"properties":{"trigger_id":{"type":"string","description":"Trigger ID provided by other action"},"url":{"type":"string","description":"The URL to send the submitted dialog payload to"},"dialog":{"type":"object","required":["title","elements"],"description":"Post object to create","properties":{"callback_id":{"type":"string","description":"Set an ID that will be included when the dialog is submitted"},"title":{"type":"string","description":"Title of the dialog"},"introduction_text":{"type":"string","description":"Markdown formatted introductory paragraph"},"elements":{"type":"array","description":"Input elements, see https://docs.mattermost.com/developer/interactive-dialogs.html#elements","items":{"type":"object"}},"submit_label":{"type":"string","description":"Label on the submit button"},"notify_on_cancel":{"type":"boolean","description":"Set true to receive payloads when user cancels a dialog"},"state":{"type":"string","description":"Set some state to be echoed back with the dialog submission"}}}}}}},"description":"Metadata for the dialog to be opened","required":true},"responses":{"200":{"description":"Dialog open successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/actions/dialogs/submit":{"post":{"tags":["integration_actions"],"summary":"Submit a dialog","description":"Endpoint used by the Mattermost clients to submit a dialog. See https://docs.mattermost.com/developer/interactive-dialogs.html for more information on interactive dialogs.\n__Minimum server version: 5.6__\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["url","submission","channel_id","team_id"],"properties":{"url":{"type":"string","description":"The URL to send the submitted dialog payload to"},"channel_id":{"type":"string","description":"Channel ID the user submitted the dialog from"},"team_id":{"type":"string","description":"Team ID the user submitted the dialog from"},"submission":{"type":"object","description":"String map where keys are element names and values are the element input values"},"callback_id":{"type":"string","description":"Callback ID sent when the dialog was opened"},"state":{"type":"string","description":"State sent when the dialog was opened"},"cancelled":{"type":"boolean","description":"Set to true if the dialog was cancelled"}}}}},"description":"Dialog submission data","required":true},"responses":{"200":{"description":"Dialog submission successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/bots":{"post":{"tags":["bots"],"summary":"Create a bot","description":"Create a new bot account on the system. Username is required.\n##### Permissions\nMust have `create_bot` permission.\n__Minimum server version__: 5.10\n","requestBody":{"description":"Bot to be created","required":true,"content":{"application/json":{"schema":{"type":"object","required":["username"],"properties":{"username":{"type":"string"},"display_name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"Bot creation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bot"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}},"get":{"tags":["bots"],"summary":"Get bots","description":"Get a page of a list of bots.\n##### Permissions\nMust have `read_bots` permission for bots you are managing, and `read_others_bots` permission for bots others are managing.\n__Minimum server version__: 5.10\n","parameters":[{"name":"page","in":"query","description":"The page to select.","schema":{"type":"integer","default":0}},{"name":"per_page","in":"query","description":"The number of users per page. There is a maximum limit of 200 users per page.","schema":{"type":"integer","default":60}},{"name":"include_deleted","in":"query","description":"If deleted bots should be returned.","schema":{"type":"boolean"}},{"name":"only_orphaned","in":"query","description":"When true, only orphaned bots will be returned. A bot is consitered orphaned if it's owner has been deactivated.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Bot page retrieval successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Bot"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/bots/{bot_user_id}":{"put":{"tags":["bots"],"summary":"Patch a bot","description":"Partially update a bot by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.\n##### Permissions\nMust have `manage_bots` permission. \n__Minimum server version__: 5.10\n","parameters":[{"name":"bot_user_id","in":"path","description":"Bot user ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Bot to be created","required":true,"content":{"application/json":{"schema":{"type":"object","required":["username"],"properties":{"username":{"type":"string"},"display_name":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"200":{"description":"Bot patch successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bot"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}},"get":{"tags":["bots"],"summary":"Get a bot","description":"Get a bot specified by its bot id.\n##### Permissions\nMust have `read_bots` permission for bots you are managing, and `read_others_bots` permission for bots others are managing.\n__Minimum server version__: 5.10\n","parameters":[{"name":"bot_user_id","in":"path","description":"Bot user ID","required":true,"schema":{"type":"string"}},{"name":"include_deleted","in":"query","description":"If deleted bots should be returned.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Bot successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bot"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/bots/{bot_user_id}/disable":{"post":{"tags":["bots"],"summary":"Disable a bot","description":"Disable a bot.\n##### Permissions\nMust have `manage_bots` permission. \n__Minimum server version__: 5.10\n","parameters":[{"name":"bot_user_id","in":"path","description":"Bot user ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Bot successfully disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bot"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/bots/{bot_user_id}/enable":{"post":{"tags":["bots"],"summary":"Enable a bot","description":"Enable a bot.\n##### Permissions\nMust have `manage_bots` permission. \n__Minimum server version__: 5.10\n","parameters":[{"name":"bot_user_id","in":"path","description":"Bot user ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Bot successfully enabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bot"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/bots/{bot_user_id}/assign/{user_id}":{"post":{"tags":["bots"],"summary":"Assign a bot to a user","description":"Assign a bot to a specified user.\n##### Permissions\nMust have `manage_bots` permission. \n__Minimum server version__: 5.10\n","parameters":[{"name":"bot_user_id","in":"path","description":"Bot user ID","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","description":"The user ID to assign the bot to.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Bot successfully assigned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bot"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/bots/{bot_user_id}/icon":{"get":{"tags":["bots"],"summary":"Get bot's LHS icon","description":"Get a bot's LHS icon image based on bot_user_id string parameter.\n##### Permissions\nMust be logged in.\n__Minimum server version__: 5.14\n","parameters":[{"name":"bot_user_id","in":"path","description":"Bot user ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Bot's LHS icon image"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nbotUserID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\ndata, resp := Client.GetBotIconImage(botUserID)\n"}]},"post":{"tags":["bots"],"summary":"Set bot's LHS icon image","description":"Set a bot's LHS icon image based on bot_user_id string parameter. Icon image must be SVG format, all other formats are rejected.\n##### Permissions\nMust have `manage_bots` permission.\n__Minimum server version__: 5.14\n","parameters":[{"name":"bot_user_id","in":"path","description":"Bot user ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"description":"SVG icon image to be uploaded","type":"string","format":"binary"}},"required":["image"]}}}},"responses":{"200":{"description":"SVG icon image set successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"413":{"$ref":"#/components/responses/TooLarge"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import (\n \"io/ioutil\"\n \"log\"\n\n \"github.com/mattermost/mattermost-server/model\"\n)\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\ndata, err := ioutil.ReadFile(\"icon_image.svg\")\nif err != nil {\n log.Fatal(err)\n}\n\nbotUserID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\nok, resp := Client.SetBotIconImage(botUserID, data)\n"}]},"delete":{"tags":["bots"],"summary":"Delete bot's LHS icon image","description":"Delete bot's LHS icon image based on bot_user_id string parameter.\n##### Permissions\nMust have `manage_bots` permission.\n__Minimum server version__: 5.14\n","parameters":[{"name":"bot_user_id","in":"path","description":"Bot user ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Icon image deletion successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusOK"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"}},"x-code-samples":[{"lang":"Go","source":"import \"github.com/mattermost/mattermost-server/model\"\n\nClient := model.NewAPIv4Client(\"https://your-mattermost-url.com\")\nClient.Login(\"email@domain.com\", \"Password1\")\n\nbotUserID := \"4xp9fdt77pncbef59f4k1qe83o\"\n\nok, resp := Client.DeleteBotIconImage(botUserID)\n"}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"Token"}},"responses":{"Forbidden":{"description":"Do not have appropriate permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppError"}}}},"Unauthorized":{"description":"No access token provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppError"}}}},"BadRequest":{"description":"Invalid or missing parameters in URL or request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppError"}}}},"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppError"}}}},"TooLarge":{"description":"Content too large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppError"}}}},"NotImplemented":{"description":"Feature is disabled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppError"}}}},"InternalServerError":{"description":"Something went wrong with the server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppError"}}}}},"schemas":{"User":{"type":"object","properties":{"id":{"type":"string"},"create_at":{"description":"The time in milliseconds a user was created","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds a user was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds a user was deleted","type":"integer","format":"int64"},"username":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"nickname":{"type":"string"},"email":{"type":"string"},"email_verified":{"type":"boolean"},"auth_service":{"type":"string"},"roles":{"type":"string"},"locale":{"type":"string"},"notify_props":{"$ref":"#/components/schemas/UserNotifyProps"},"props":{"type":"object"},"last_password_update":{"type":"integer"},"last_picture_update":{"type":"integer"},"failed_attempts":{"type":"integer"},"mfa_active":{"type":"boolean"},"timezone":{"$ref":"#/components/schemas/Timezone"},"terms_of_service_id":{"description":"ID of accepted terms of service, if any. This field is not present if empty.","type":"string"},"terms_of_service_create_at":{"description":"The time in milliseconds the user accepted the terms of service","type":"integer","format":"int64"}}},"UsersStats":{"type":"object","properties":{"total_users_count":{"type":"integer"}}},"Team":{"type":"object","properties":{"id":{"type":"string"},"create_at":{"description":"The time in milliseconds a team was created","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds a team was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds a team was deleted","type":"integer","format":"int64"},"display_name":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"email":{"type":"string"},"type":{"type":"string"},"allowed_domains":{"type":"string"},"invite_id":{"type":"string"},"allow_open_invite":{"type":"boolean"}}},"TeamStats":{"type":"object","properties":{"team_id":{"type":"string"},"total_member_count":{"type":"integer"},"active_member_count":{"type":"integer"}}},"TeamExists":{"type":"object","properties":{"exists":{"type":"boolean"}}},"Channel":{"type":"object","properties":{"id":{"type":"string"},"create_at":{"description":"The time in milliseconds a channel was created","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds a channel was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds a channel was deleted","type":"integer","format":"int64"},"team_id":{"type":"string"},"type":{"type":"string"},"display_name":{"type":"string"},"name":{"type":"string"},"header":{"type":"string"},"purpose":{"type":"string"},"last_post_at":{"description":"The time in milliseconds of the last post of a channel","type":"integer"},"total_msg_count":{"type":"integer"},"extra_update_at":{"description":"Deprecated in Mattermost 5.0 release","type":"integer","format":"int64"},"creator_id":{"type":"string"}}},"ChannelStats":{"type":"object","properties":{"channel_id":{"type":"string"},"member_count":{"type":"integer"}}},"ChannelMember":{"type":"object","properties":{"channel_id":{"type":"string"},"user_id":{"type":"string"},"roles":{"type":"string"},"last_viewed_at":{"description":"The time in milliseconds the channel was last viewed by the user","type":"integer","format":"int64"},"msg_count":{"type":"integer"},"mention_count":{"type":"integer"},"notify_props":{"$ref":"#/components/schemas/ChannelNotifyProps"},"last_update_at":{"description":"The time in milliseconds the channel member was last updated","type":"integer","format":"int64"}}},"ChannelData":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"member":{"$ref":"#/components/schemas/ChannelMember"}}},"Post":{"type":"object","properties":{"id":{"type":"string"},"create_at":{"description":"The time in milliseconds a post was created","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds a post was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds a post was deleted","type":"integer","format":"int64"},"edit_at":{"type":"integer","format":"int64"},"user_id":{"type":"string"},"channel_id":{"type":"string"},"root_id":{"type":"string"},"parent_id":{"type":"string"},"original_id":{"type":"string"},"message":{"type":"string"},"type":{"type":"string"},"props":{"type":"object"},"hashtag":{"type":"string"},"filenames":{"description":"This field will only appear on some posts created before Mattermost 3.5 and has since been deprecated.","type":"array","items":{"type":"string"}},"file_ids":{"type":"array","items":{"type":"string"}},"pending_post_id":{"type":"string"},"metadata":{"$ref":"#/components/schemas/PostMetadata"}}},"PostList":{"type":"object","properties":{"order":{"type":"array","items":{"type":"string"},"example":["post_id1","post_id12"]},"posts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Post"}},"next_post_id":{"type":"string","description":"The ID of next post. Not omitted when empty or not relevant."},"prev_post_id":{"type":"string","description":"The ID of previous post. Not omitted when empty or not relevant."}}},"PostListWithSearchMatches":{"type":"object","properties":{"order":{"type":"array","items":{"type":"string"},"example":["post_id1","post_id12"]},"posts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Post"}},"matches":{"description":"A mapping of post IDs to a list of matched terms within the post. This field will only be populated on servers running version 5.1 or greater with Elasticsearch enabled.","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"example":{"post_id1":["search match 1","search match 2"]}}}},"PostMetadata":{"type":"object","description":"Additional information used to display a post.","properties":{"embeds":{"type":"array","description":"Information about content embedded in the post including OpenGraph previews, image link previews, and message attachments. This field will be null if the post does not contain embedded content.\n","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of content that is embedded in this point.","enum":["image","message_attachment","opengraph","link"]},"url":{"type":"string","description":"The URL of the embedded content, if one exists."},"data":{"type":"object","description":"Any additional information about the embedded content. Only used at this time to store OpenGraph metadata.\nThis field will be null for non-OpenGraph embeds.\n"}}}},"emojis":{"type":"array","description":"The custom emojis that appear in this point or have been used in reactions to this post. This field will be null if the post does not contain custom emojis.\n","items":{"$ref":"#/components/schemas/Emoji"}},"files":{"type":"array","description":"The FileInfo objects for any files attached to the post. This field will be null if the post does not have any file attachments.\n","items":{"$ref":"#/components/schemas/FileInfo"}},"images":{"type":"object","description":"An object mapping the URL of an external image to an object containing the dimensions of that image. This field will be null if the post or its embedded content does not reference any external images.\n","items":{"type":"object","properties":{"height":{"type":"integer"},"width":{"type":"integer"}}}},"reactions":{"type":"array","description":"Any reactions made to this point. This field will be null if no reactions have been made to this post.\n","items":{"$ref":"#/components/schemas/Reaction"}}}},"TeamMap":{"type":"object","description":"A mapping of teamIds to teams.","properties":{"team_id":{"$ref":"#/components/schemas/Team"}}},"TeamMember":{"type":"object","properties":{"team_id":{"description":"The ID of the team this member belongs to.","type":"string"},"user_id":{"description":"The ID of the user this member relates to.","type":"string"},"roles":{"description":"The complete list of roles assigned to this team member, as a space-separated list of role names, including any roles granted implicitly through permissions schemes.","type":"string"},"delete_at":{"description":"The time in milliseconds that this team member was deleted.","type":"integer"},"scheme_user":{"description":"Whether this team member holds the default user role defined by the team's permissions scheme.","type":"boolean"},"scheme_admin":{"description":"Whether this team member holds the default admin role defined by the team's permissions scheme.","type":"boolean"},"explicit_roles":{"description":"The list of roles explicitly assigned to this team member, as a space separated list of role names. This list does *not* include any roles granted implicitly through permissions schemes.","type":"string"}}},"TeamUnread":{"type":"object","properties":{"team_id":{"type":"string"},"msg_count":{"type":"integer"},"mention_count":{"type":"integer"}}},"ChannelUnread":{"type":"object","properties":{"team_id":{"type":"string"},"channel_id":{"type":"string"},"msg_count":{"type":"integer"},"mention_count":{"type":"integer"}}},"ChannelUnreadAt":{"type":"object","properties":{"team_id":{"description":"The ID of the team the channel belongs to.","type":"string"},"channel_id":{"description":"The ID of the channel the user has access to..","type":"string"},"msg_count":{"description":"No. of messages the user has already read.","type":"integer"},"mention_count":{"description":"No. of mentions the user has within the unread posts of the channel.","type":"integer"},"last_viewed_at":{"description":"time in milliseconds when the user last viewed the channel.","type":"integer"}}},"Session":{"type":"object","properties":{"create_at":{"description":"The time in milliseconds a session was created","type":"integer","format":"int64"},"device_id":{"type":"string"},"expires_at":{"description":"The time in milliseconds a session will expire","type":"integer","format":"int64"},"id":{"type":"string"},"is_oauth":{"type":"boolean"},"last_activity_at":{"description":"The time in milliseconds of the last activity of a session","type":"integer","format":"int64"},"props":{"type":"object"},"roles":{"type":"string"},"team_members":{"type":"array","items":{"$ref":"#/components/schemas/TeamMember"}},"token":{"type":"string"},"user_id":{"type":"string"}}},"FileInfo":{"type":"object","properties":{"id":{"description":"The unique identifier for this file","type":"string"},"user_id":{"description":"The ID of the user that uploaded this file","type":"string"},"post_id":{"description":"If this file is attached to a post, the ID of that post","type":"string"},"create_at":{"description":"The time in milliseconds a file was created","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds a file was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds a file was deleted","type":"integer","format":"int64"},"name":{"description":"The name of the file","type":"string"},"extension":{"description":"The extension at the end of the file name","type":"string"},"size":{"description":"The size of the file in bytes","type":"integer"},"mime_type":{"description":"The MIME type of the file","type":"string"},"width":{"description":"If this file is an image, the width of the file","type":"integer"},"height":{"description":"If this file is an image, the height of the file","type":"integer"},"has_preview_image":{"description":"If this file is an image, whether or not it has a preview-sized version","type":"boolean"}}},"Preference":{"type":"object","properties":{"user_id":{"description":"The ID of the user that owns this preference","type":"string"},"category":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}},"UserAuthData":{"type":"object","properties":{"auth_data":{"description":"Service-specific authentication data","type":"string"},"auth_service":{"description":"The authentication service such as \"email\", \"gitlab\", or \"ldap\"","type":"string"},"password":{"description":"The password used for email authentication","type":"string"}}},"UserAutocomplete":{"type":"object","properties":{"users":{"description":"A list of users that are the main result of the query","type":"array","items":{"$ref":"#/components/schemas/User"}},"out_of_channel":{"description":"A special case list of users returned when autocompleting in a specific channel. Omitted when empty or not relevant","type":"array","items":{"$ref":"#/components/schemas/User"}}}},"UserAutocompleteInTeam":{"type":"object","properties":{"in_team":{"description":"A list of user objects in the team","type":"array","items":{"$ref":"#/components/schemas/User"}}}},"UserAutocompleteInChannel":{"type":"object","properties":{"in_channel":{"description":"A list of user objects in the channel","type":"array","items":{"$ref":"#/components/schemas/User"}},"out_of_channel":{"description":"A list of user objects not in the channel","type":"array","items":{"$ref":"#/components/schemas/User"}}}},"IncomingWebhook":{"type":"object","properties":{"id":{"description":"The unique identifier for this incoming webhook","type":"string"},"create_at":{"description":"The time in milliseconds a incoming webhook was created","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds a incoming webhook was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds a incoming webhook was deleted","type":"integer","format":"int64"},"channel_id":{"description":"The ID of a public channel or private group that receives the webhook payloads","type":"string"},"description":{"description":"The description for this incoming webhook","type":"string"},"display_name":{"description":"The display name for this incoming webhook","type":"string"}}},"OutgoingWebhook":{"type":"object","properties":{"id":{"description":"The unique identifier for this outgoing webhook","type":"string"},"create_at":{"description":"The time in milliseconds a outgoing webhook was created","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds a outgoing webhook was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds a outgoing webhook was deleted","type":"integer","format":"int64"},"creator_id":{"description":"The Id of the user who created the webhook","type":"string"},"team_id":{"description":"The ID of the team that the webhook watchs","type":"string"},"channel_id":{"description":"The ID of a public channel that the webhook watchs","type":"string"},"description":{"description":"The description for this outgoing webhook","type":"string"},"display_name":{"description":"The display name for this outgoing webhook","type":"string"},"trigger_words":{"description":"List of words for the webhook to trigger on","type":"array","items":{"type":"string"}},"trigger_when":{"description":"When to trigger the webhook, `0` when a trigger word is present at all and `1` if the message starts with a trigger word","type":"integer"},"callback_urls":{"description":"The URLs to POST the payloads to when the webhook is triggered","type":"array","items":{"type":"string"}},"content_type":{"description":"The format to POST the data in, either `application/json` or `application/x-www-form-urlencoded`","default":"application/x-www-form-urlencoded","type":"string"}}},"Reaction":{"type":"object","properties":{"user_id":{"description":"The ID of the user that made this reaction","type":"string"},"post_id":{"description":"The ID of the post to which this reaction was made","type":"string"},"emoji_name":{"description":"The name of the emoji that was used for this reaction","type":"string"},"create_at":{"description":"The time in milliseconds this reaction was made","type":"integer","format":"int64"}}},"Emoji":{"type":"object","properties":{"id":{"description":"The ID of the emoji","type":"string"},"creator_id":{"description":"The ID of the user that made the emoji","type":"string"},"name":{"description":"The name of the emoji","type":"string"},"create_at":{"description":"The time in milliseconds the emoji was made","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds the emoji was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds the emoji was deleted","type":"integer","format":"int64"}}},"Command":{"type":"object","properties":{"id":{"description":"The ID of the slash command","type":"string"},"token":{"description":"The token which is used to verify the source of the payload","type":"string"},"create_at":{"description":"The time in milliseconds the command was created","type":"integer"},"update_at":{"description":"The time in milliseconds the command was last updated","type":"integer","format":"int64"},"deleted_at":{"description":"The time in milliseconds the command was deleted, 0 if never deleted","type":"integer","format":"int64"},"creator_id":{"description":"The user id for the commands creator","type":"string"},"team_id":{"description":"The team id for which this command is configured","type":"string"},"trigger":{"description":"The string that triggers this command","type":"string"},"method":{"description":"Is the trigger done with HTTP Get ('G') or HTTP Post ('P')","type":"string"},"username":{"description":"What is the username for the response post","type":"string"},"icon_url":{"description":"The url to find the icon for this users avatar","type":"string"},"auto_complete":{"description":"Use auto complete for this command","type":"boolean"},"auto_complete_desc":{"description":"The description for this command shown when selecting the command","type":"string"},"auto_complete_hint":{"description":"The hint for this command","type":"string"},"display_name":{"description":"Display name for the command","type":"string"},"description":{"description":"Description for this command","type":"string"},"url":{"description":"The URL that is triggered","type":"string"}}},"CommandResponse":{"type":"object","properties":{"ResponseType":{"description":"The response type either in_channel or ephemeral","type":"string"},"Text":{"type":"string"},"Username":{"type":"string"},"IconURL":{"type":"string"},"GotoLocation":{"type":"string"},"Attachments":{"type":"array","items":{"$ref":"#/components/schemas/SlackAttachment"}}}},"SlackAttachment":{"type":"object","properties":{"Id":{"type":"string"},"Fallback":{"type":"string"},"Color":{"type":"string"},"Pretext":{"type":"string"},"AuthorName":{"type":"string"},"AuthorLink":{"type":"string"},"AuthorIcon":{"type":"string"},"Title":{"type":"string"},"TitleLink":{"type":"string"},"Text":{"type":"string"},"Fields":{"type":"array","items":{"$ref":"#/components/schemas/SlackAttachmentField"}},"ImageURL":{"type":"string"},"ThumbURL":{"type":"string"},"Footer":{"type":"string"},"FooterIcon":{"type":"string"},"Timestamp":{"description":"The timestamp of the slack attachment, either type of string or integer","type":"string"}}},"SlackAttachmentField":{"type":"object","properties":{"Title":{"type":"string"},"Value":{"description":"The value of the attachment, set as string but capable with golang interface","type":"string"},"Short":{"type":"boolean"}}},"StatusOK":{"type":"object","properties":{"status":{"description":"Will contain \"ok\" if the request was successful and there was nothing else to return","type":"string"}}},"OpenGraph":{"type":"object","description":"OpenGraph metadata of a webpage","properties":{"type":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"determiner":{"type":"string"},"site_name":{"type":"string"},"locale":{"type":"string"},"locales_alternate":{"type":"array","items":{"type":"string"}},"images":{"type":"array","items":{"type":"object","description":"Image object used in OpenGraph metadata of a webpage","properties":{"url":{"type":"string"},"secure_url":{"type":"string"},"type":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}}}},"videos":{"type":"array","items":{"type":"object","description":"Video object used in OpenGraph metadata of a webpage","properties":{"url":{"type":"string"},"secure_url":{"type":"string"},"type":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}}}},"audios":{"type":"array","items":{"type":"object","description":"Audio object used in OpenGraph metadata of a webpage","properties":{"url":{"type":"string"},"secure_url":{"type":"string"},"type":{"type":"string"}}}},"article":{"type":"object","description":"Article object used in OpenGraph metadata of a webpage, if type is article","properties":{"published_time":{"type":"string"},"modified_time":{"type":"string"},"expiration_time":{"type":"string"},"section":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"authors":{"type":"array","items":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"type":"string"},"gender":{"type":"string"}}}}}},"book":{"type":"object","description":"Book object used in OpenGraph metadata of a webpage, if type is book","properties":{"isbn":{"type":"string"},"release_date":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"authors":{"type":"array","items":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"type":"string"},"gender":{"type":"string"}}}}}},"profile":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"type":"string"},"gender":{"type":"string"}}}}},"Audit":{"type":"object","properties":{"id":{"type":"string"},"create_at":{"description":"The time in milliseconds a audit was created","type":"integer","format":"int64"},"user_id":{"type":"string"},"action":{"type":"string"},"extra_info":{"type":"string"},"ip_address":{"type":"string"},"session_id":{"type":"string"}}},"Config":{"type":"object","properties":{"ServiceSettings":{"type":"object","properties":{"SiteURL":{"type":"string"},"ListenAddress":{"type":"string"},"ConnectionSecurity":{"type":"string"},"TLSCertFile":{"type":"string"},"TLSKeyFile":{"type":"string"},"UseLetsEncrypt":{"type":"boolean"},"LetsEncryptCertificateCacheFile":{"type":"string"},"Forward80To443":{"type":"boolean"},"ReadTimeout":{"type":"integer"},"WriteTimeout":{"type":"integer"},"MaximumLoginAttempts":{"type":"integer"},"SegmentDeveloperKey":{"type":"string"},"GoogleDeveloperKey":{"type":"string"},"EnableOAuthServiceProvider":{"type":"boolean"},"EnableIncomingWebhooks":{"type":"boolean"},"EnableOutgoingWebhooks":{"type":"boolean"},"EnableCommands":{"type":"boolean"},"EnableOnlyAdminIntegrations":{"type":"boolean"},"EnablePostUsernameOverride":{"type":"boolean"},"EnablePostIconOverride":{"type":"boolean"},"EnableTesting":{"type":"boolean"},"EnableDeveloper":{"type":"boolean"},"EnableSecurityFixAlert":{"type":"boolean"},"EnableInsecureOutgoingConnections":{"type":"boolean"},"EnableMultifactorAuthentication":{"type":"boolean"},"EnforceMultifactorAuthentication":{"type":"boolean"},"AllowCorsFrom":{"type":"string"},"SessionLengthWebInDays":{"type":"integer"},"SessionLengthMobileInDays":{"type":"integer"},"SessionLengthSSOInDays":{"type":"integer"},"SessionCacheInMinutes":{"type":"integer"},"WebsocketSecurePort":{"type":"integer"},"WebsocketPort":{"type":"integer"},"WebserverMode":{"type":"string"},"EnableCustomEmoji":{"type":"boolean"},"RestrictCustomEmojiCreation":{"type":"string"}}},"TeamSettings":{"type":"object","properties":{"SiteName":{"type":"string"},"MaxUsersPerTeam":{"type":"integer"},"EnableTeamCreation":{"type":"boolean"},"EnableUserCreation":{"type":"boolean"},"EnableOpenServer":{"type":"boolean"},"RestrictCreationToDomains":{"type":"string"},"EnableCustomBrand":{"type":"boolean"},"CustomBrandText":{"type":"string"},"CustomDescriptionText":{"type":"string"},"RestrictDirectMessage":{"type":"string"},"RestrictTeamInvite":{"type":"string"},"RestrictPublicChannelManagement":{"type":"string"},"RestrictPrivateChannelManagement":{"type":"string"},"RestrictPublicChannelCreation":{"type":"string"},"RestrictPrivateChannelCreation":{"type":"string"},"RestrictPublicChannelDeletion":{"type":"string"},"RestrictPrivateChannelDeletion":{"type":"string"},"UserStatusAwayTimeout":{"type":"integer"},"MaxChannelsPerTeam":{"type":"integer"},"MaxNotificationsPerChannel":{"type":"integer"}}},"SqlSettings":{"type":"object","properties":{"DriverName":{"type":"string"},"DataSource":{"type":"string"},"DataSourceReplicas":{"type":"array","items":{"type":"string"}},"MaxIdleConns":{"type":"integer"},"MaxOpenConns":{"type":"integer"},"Trace":{"type":"boolean"},"AtRestEncryptKey":{"type":"string"}}},"LogSettings":{"type":"object","properties":{"EnableConsole":{"type":"boolean"},"ConsoleLevel":{"type":"string"},"EnableFile":{"type":"boolean"},"FileLevel":{"type":"string"},"FileLocation":{"type":"string"},"EnableWebhookDebugging":{"type":"boolean"},"EnableDiagnostics":{"type":"boolean"}}},"PasswordSettings":{"type":"object","properties":{"MinimumLength":{"type":"integer"},"Lowercase":{"type":"boolean"},"Number":{"type":"boolean"},"Uppercase":{"type":"boolean"},"Symbol":{"type":"boolean"}}},"FileSettings":{"type":"object","properties":{"MaxFileSize":{"type":"integer"},"DriverName":{"type":"string"},"Directory":{"type":"string"},"EnablePublicLink":{"type":"boolean"},"PublicLinkSalt":{"type":"string"},"ThumbnailWidth":{"type":"integer"},"ThumbnailHeight":{"type":"integer"},"PreviewWidth":{"type":"integer"},"PreviewHeight":{"type":"integer"},"ProfileWidth":{"type":"integer"},"ProfileHeight":{"type":"integer"},"InitialFont":{"type":"string"},"AmazonS3AccessKeyId":{"type":"string"},"AmazonS3SecretAccessKey":{"type":"string"},"AmazonS3Bucket":{"type":"string"},"AmazonS3Region":{"type":"string"},"AmazonS3Endpoint":{"type":"string"},"AmazonS3SSL":{"type":"boolean"}}},"EmailSettings":{"type":"object","properties":{"EnableSignUpWithEmail":{"type":"boolean"},"EnableSignInWithEmail":{"type":"boolean"},"EnableSignInWithUsername":{"type":"boolean"},"SendEmailNotifications":{"type":"boolean"},"RequireEmailVerification":{"type":"boolean"},"FeedbackName":{"type":"string"},"FeedbackEmail":{"type":"string"},"FeedbackOrganization":{"type":"string"},"SMTPUsername":{"type":"string"},"SMTPPassword":{"type":"string"},"SMTPServer":{"type":"string"},"SMTPPort":{"type":"string"},"ConnectionSecurity":{"type":"string"},"InviteSalt":{"type":"string"},"PasswordResetSalt":{"type":"string"},"SendPushNotifications":{"type":"boolean"},"PushNotificationServer":{"type":"string"},"PushNotificationContents":{"type":"string"},"EnableEmailBatching":{"type":"boolean"},"EmailBatchingBufferSize":{"type":"integer"},"EmailBatchingInterval":{"type":"integer"}}},"RateLimitSettings":{"type":"object","properties":{"Enable":{"type":"boolean"},"PerSec":{"type":"integer"},"MaxBurst":{"type":"integer"},"MemoryStoreSize":{"type":"integer"},"VaryByRemoteAddr":{"type":"boolean"},"VaryByHeader":{"type":"string"}}},"PrivacySettings":{"type":"object","properties":{"ShowEmailAddress":{"type":"boolean"},"ShowFullName":{"type":"boolean"}}},"SupportSettings":{"type":"object","properties":{"TermsOfServiceLink":{"type":"string"},"PrivacyPolicyLink":{"type":"string"},"AboutLink":{"type":"string"},"HelpLink":{"type":"string"},"ReportAProblemLink":{"type":"string"},"SupportEmail":{"type":"string"}}},"GitLabSettings":{"type":"object","properties":{"Enable":{"type":"boolean"},"Secret":{"type":"string"},"Id":{"type":"string"},"Scope":{"type":"string"},"AuthEndpoint":{"type":"string"},"TokenEndpoint":{"type":"string"},"UserApiEndpoint":{"type":"string"}}},"GoogleSettings":{"type":"object","properties":{"Enable":{"type":"boolean"},"Secret":{"type":"string"},"Id":{"type":"string"},"Scope":{"type":"string"},"AuthEndpoint":{"type":"string"},"TokenEndpoint":{"type":"string"},"UserApiEndpoint":{"type":"string"}}},"Office365Settings":{"type":"object","properties":{"Enable":{"type":"boolean"},"Secret":{"type":"string"},"Id":{"type":"string"},"Scope":{"type":"string"},"AuthEndpoint":{"type":"string"},"TokenEndpoint":{"type":"string"},"UserApiEndpoint":{"type":"string"}}},"LdapSettings":{"type":"object","properties":{"Enable":{"type":"boolean"},"LdapServer":{"type":"string"},"LdapPort":{"type":"integer"},"ConnectionSecurity":{"type":"string"},"BaseDN":{"type":"string"},"BindUsername":{"type":"string"},"BindPassword":{"type":"string"},"UserFilter":{"type":"string"},"FirstNameAttribute":{"type":"string"},"LastNameAttribute":{"type":"string"},"EmailAttribute":{"type":"string"},"UsernameAttribute":{"type":"string"},"NicknameAttribute":{"type":"string"},"IdAttribute":{"type":"string"},"PositionAttribute":{"type":"string"},"SyncIntervalMinutes":{"type":"integer"},"SkipCertificateVerification":{"type":"boolean"},"QueryTimeout":{"type":"integer"},"MaxPageSize":{"type":"integer"},"LoginFieldName":{"type":"string"}}},"ComplianceSettings":{"type":"object","properties":{"Enable":{"type":"boolean"},"Directory":{"type":"string"},"EnableDaily":{"type":"boolean"}}},"LocalizationSettings":{"type":"object","properties":{"DefaultServerLocale":{"type":"string"},"DefaultClientLocale":{"type":"string"},"AvailableLocales":{"type":"string"}}},"SamlSettings":{"type":"object","properties":{"Enable":{"type":"boolean"},"Verify":{"type":"boolean"},"Encrypt":{"type":"boolean"},"IdpUrl":{"type":"string"},"IdpDescriptorUrl":{"type":"string"},"AssertionConsumerServiceURL":{"type":"string"},"IdpCertificateFile":{"type":"string"},"PublicCertificateFile":{"type":"string"},"PrivateKeyFile":{"type":"string"},"FirstNameAttribute":{"type":"string"},"LastNameAttribute":{"type":"string"},"EmailAttribute":{"type":"string"},"UsernameAttribute":{"type":"string"},"NicknameAttribute":{"type":"string"},"LocaleAttribute":{"type":"string"},"PositionAttribute":{"type":"string"},"LoginButtonText":{"type":"string"}}},"NativeAppSettings":{"type":"object","properties":{"AppDownloadLink":{"type":"string"},"AndroidAppDownloadLink":{"type":"string"},"IosAppDownloadLink":{"type":"string"}}},"ClusterSettings":{"type":"object","properties":{"Enable":{"type":"boolean"},"InterNodeListenAddress":{"type":"string"},"InterNodeUrls":{"type":"array","items":{"type":"string"}}}},"MetricsSettings":{"type":"object","properties":{"Enable":{"type":"boolean"},"BlockProfileRate":{"type":"integer"},"ListenAddress":{"type":"string"}}},"AnalyticsSettings":{"type":"object","properties":{"MaxUsersForStatistics":{"type":"integer"}}}}},"EnvironmentConfig":{"type":"object","properties":{"ServiceSettings":{"type":"object","properties":{"SiteURL":{"type":"boolean"},"ListenAddress":{"type":"boolean"},"ConnectionSecurity":{"type":"boolean"},"TLSCertFile":{"type":"boolean"},"TLSKeyFile":{"type":"boolean"},"UseLetsEncrypt":{"type":"boolean"},"LetsEncryptCertificateCacheFile":{"type":"boolean"},"Forward80To443":{"type":"boolean"},"ReadTimeout":{"type":"boolean"},"WriteTimeout":{"type":"boolean"},"MaximumLoginAttempts":{"type":"boolean"},"SegmentDeveloperKey":{"type":"boolean"},"GoogleDeveloperKey":{"type":"boolean"},"EnableOAuthServiceProvider":{"type":"boolean"},"EnableIncomingWebhooks":{"type":"boolean"},"EnableOutgoingWebhooks":{"type":"boolean"},"EnableCommands":{"type":"boolean"},"EnableOnlyAdminIntegrations":{"type":"boolean"},"EnablePostUsernameOverride":{"type":"boolean"},"EnablePostIconOverride":{"type":"boolean"},"EnableTesting":{"type":"boolean"},"EnableDeveloper":{"type":"boolean"},"EnableSecurityFixAlert":{"type":"boolean"},"EnableInsecureOutgoingConnections":{"type":"boolean"},"EnableMultifactorAuthentication":{"type":"boolean"},"EnforceMultifactorAuthentication":{"type":"boolean"},"AllowCorsFrom":{"type":"boolean"},"SessionLengthWebInDays":{"type":"boolean"},"SessionLengthMobileInDays":{"type":"boolean"},"SessionLengthSSOInDays":{"type":"boolean"},"SessionCacheInMinutes":{"type":"boolean"},"WebsocketSecurePort":{"type":"boolean"},"WebsocketPort":{"type":"boolean"},"WebserverMode":{"type":"boolean"},"EnableCustomEmoji":{"type":"boolean"},"RestrictCustomEmojiCreation":{"type":"boolean"}}},"TeamSettings":{"type":"object","properties":{"SiteName":{"type":"boolean"},"MaxUsersPerTeam":{"type":"boolean"},"EnableTeamCreation":{"type":"boolean"},"EnableUserCreation":{"type":"boolean"},"EnableOpenServer":{"type":"boolean"},"RestrictCreationToDomains":{"type":"boolean"},"EnableCustomBrand":{"type":"boolean"},"CustomBrandText":{"type":"boolean"},"CustomDescriptionText":{"type":"boolean"},"RestrictDirectMessage":{"type":"boolean"},"RestrictTeamInvite":{"type":"boolean"},"RestrictPublicChannelManagement":{"type":"boolean"},"RestrictPrivateChannelManagement":{"type":"boolean"},"RestrictPublicChannelCreation":{"type":"boolean"},"RestrictPrivateChannelCreation":{"type":"boolean"},"RestrictPublicChannelDeletion":{"type":"boolean"},"RestrictPrivateChannelDeletion":{"type":"boolean"},"UserStatusAwayTimeout":{"type":"boolean"},"MaxChannelsPerTeam":{"type":"boolean"},"MaxNotificationsPerChannel":{"type":"boolean"}}},"SqlSettings":{"type":"object","properties":{"DriverName":{"type":"boolean"},"DataSource":{"type":"boolean"},"DataSourceReplicas":{"type":"boolean"},"MaxIdleConns":{"type":"boolean"},"MaxOpenConns":{"type":"boolean"},"Trace":{"type":"boolean"},"AtRestEncryptKey":{"type":"boolean"}}},"LogSettings":{"type":"object","properties":{"EnableConsole":{"type":"boolean"},"ConsoleLevel":{"type":"boolean"},"EnableFile":{"type":"boolean"},"FileLevel":{"type":"boolean"},"FileLocation":{"type":"boolean"},"EnableWebhookDebugging":{"type":"boolean"},"EnableDiagnostics":{"type":"boolean"}}},"PasswordSettings":{"type":"object","properties":{"MinimumLength":{"type":"boolean"},"Lowercase":{"type":"boolean"},"Number":{"type":"boolean"},"Uppercase":{"type":"boolean"},"Symbol":{"type":"boolean"}}},"FileSettings":{"type":"object","properties":{"MaxFileSize":{"type":"boolean"},"DriverName":{"type":"boolean"},"Directory":{"type":"boolean"},"EnablePublicLink":{"type":"boolean"},"PublicLinkSalt":{"type":"boolean"},"ThumbnailWidth":{"type":"boolean"},"ThumbnailHeight":{"type":"boolean"},"PreviewWidth":{"type":"boolean"},"PreviewHeight":{"type":"boolean"},"ProfileWidth":{"type":"boolean"},"ProfileHeight":{"type":"boolean"},"InitialFont":{"type":"boolean"},"AmazonS3AccessKeyId":{"type":"boolean"},"AmazonS3SecretAccessKey":{"type":"boolean"},"AmazonS3Bucket":{"type":"boolean"},"AmazonS3Region":{"type":"boolean"},"AmazonS3Endpoint":{"type":"boolean"},"AmazonS3SSL":{"type":"boolean"}}},"EmailSettings":{"type":"object","properties":{"EnableSignUpWithEmail":{"type":"boolean"},"EnableSignInWithEmail":{"type":"boolean"},"EnableSignInWithUsername":{"type":"boolean"},"SendEmailNotifications":{"type":"boolean"},"RequireEmailVerification":{"type":"boolean"},"FeedbackName":{"type":"boolean"},"FeedbackEmail":{"type":"boolean"},"FeedbackOrganization":{"type":"boolean"},"SMTPUsername":{"type":"boolean"},"SMTPPassword":{"type":"boolean"},"SMTPServer":{"type":"boolean"},"SMTPPort":{"type":"boolean"},"ConnectionSecurity":{"type":"boolean"},"InviteSalt":{"type":"boolean"},"PasswordResetSalt":{"type":"boolean"},"SendPushNotifications":{"type":"boolean"},"PushNotificationServer":{"type":"boolean"},"PushNotificationContents":{"type":"boolean"},"EnableEmailBatching":{"type":"boolean"},"EmailBatchingBufferSize":{"type":"boolean"},"EmailBatchingInterval":{"type":"boolean"}}},"RateLimitSettings":{"type":"object","properties":{"Enable":{"type":"boolean"},"PerSec":{"type":"boolean"},"MaxBurst":{"type":"boolean"},"MemoryStoreSize":{"type":"boolean"},"VaryByRemoteAddr":{"type":"boolean"},"VaryByHeader":{"type":"boolean"}}},"PrivacySettings":{"type":"object","properties":{"ShowEmailAddress":{"type":"boolean"},"ShowFullName":{"type":"boolean"}}},"SupportSettings":{"type":"object","properties":{"TermsOfServiceLink":{"type":"boolean"},"PrivacyPolicyLink":{"type":"boolean"},"AboutLink":{"type":"boolean"},"HelpLink":{"type":"boolean"},"ReportAProblemLink":{"type":"boolean"},"SupportEmail":{"type":"boolean"}}},"GitLabSettings":{"type":"object","properties":{"Enable":{"type":"boolean"},"Secret":{"type":"boolean"},"Id":{"type":"boolean"},"Scope":{"type":"boolean"},"AuthEndpoint":{"type":"boolean"},"TokenEndpoint":{"type":"boolean"},"UserApiEndpoint":{"type":"boolean"}}},"GoogleSettings":{"type":"object","properties":{"Enable":{"type":"boolean"},"Secret":{"type":"boolean"},"Id":{"type":"boolean"},"Scope":{"type":"boolean"},"AuthEndpoint":{"type":"boolean"},"TokenEndpoint":{"type":"boolean"},"UserApiEndpoint":{"type":"boolean"}}},"Office365Settings":{"type":"object","properties":{"Enable":{"type":"boolean"},"Secret":{"type":"boolean"},"Id":{"type":"boolean"},"Scope":{"type":"boolean"},"AuthEndpoint":{"type":"boolean"},"TokenEndpoint":{"type":"boolean"},"UserApiEndpoint":{"type":"boolean"}}},"LdapSettings":{"type":"object","properties":{"Enable":{"type":"boolean"},"LdapServer":{"type":"boolean"},"LdapPort":{"type":"boolean"},"ConnectionSecurity":{"type":"boolean"},"BaseDN":{"type":"boolean"},"BindUsername":{"type":"boolean"},"BindPassword":{"type":"boolean"},"UserFilter":{"type":"boolean"},"FirstNameAttribute":{"type":"boolean"},"LastNameAttribute":{"type":"boolean"},"EmailAttribute":{"type":"boolean"},"UsernameAttribute":{"type":"boolean"},"NicknameAttribute":{"type":"boolean"},"IdAttribute":{"type":"boolean"},"PositionAttribute":{"type":"boolean"},"SyncIntervalMinutes":{"type":"boolean"},"SkipCertificateVerification":{"type":"boolean"},"QueryTimeout":{"type":"boolean"},"MaxPageSize":{"type":"boolean"},"LoginFieldName":{"type":"boolean"}}},"ComplianceSettings":{"type":"object","properties":{"Enable":{"type":"boolean"},"Directory":{"type":"boolean"},"EnableDaily":{"type":"boolean"}}},"LocalizationSettings":{"type":"object","properties":{"DefaultServerLocale":{"type":"boolean"},"DefaultClientLocale":{"type":"boolean"},"AvailableLocales":{"type":"boolean"}}},"SamlSettings":{"type":"object","properties":{"Enable":{"type":"boolean"},"Verify":{"type":"boolean"},"Encrypt":{"type":"boolean"},"IdpUrl":{"type":"boolean"},"IdpDescriptorUrl":{"type":"boolean"},"AssertionConsumerServiceURL":{"type":"boolean"},"IdpCertificateFile":{"type":"boolean"},"PublicCertificateFile":{"type":"boolean"},"PrivateKeyFile":{"type":"boolean"},"FirstNameAttribute":{"type":"boolean"},"LastNameAttribute":{"type":"boolean"},"EmailAttribute":{"type":"boolean"},"UsernameAttribute":{"type":"boolean"},"NicknameAttribute":{"type":"boolean"},"LocaleAttribute":{"type":"boolean"},"PositionAttribute":{"type":"boolean"},"LoginButtonText":{"type":"boolean"}}},"NativeAppSettings":{"type":"object","properties":{"AppDownloadLink":{"type":"boolean"},"AndroidAppDownloadLink":{"type":"boolean"},"IosAppDownloadLink":{"type":"boolean"}}},"ClusterSettings":{"type":"object","properties":{"Enable":{"type":"boolean"},"InterNodeListenAddress":{"type":"boolean"},"InterNodeUrls":{"type":"boolean"}}},"MetricsSettings":{"type":"object","properties":{"Enable":{"type":"boolean"},"BlockProfileRate":{"type":"boolean"},"ListenAddress":{"type":"boolean"}}},"AnalyticsSettings":{"type":"object","properties":{"MaxUsersForStatistics":{"type":"boolean"}}}}},"SamlCertificateStatus":{"type":"object","properties":{"idp_certificate_file":{"description":"Status is good when `true`","type":"boolean"},"public_certificate_file":{"description":"Status is good when `true`","type":"boolean"},"private_key_file":{"description":"Status is good when `true`","type":"boolean"}}},"Compliance":{"type":"object","properties":{"id":{"type":"string"},"create_at":{"type":"integer","format":"int64"},"user_id":{"type":"string"},"status":{"type":"string"},"count":{"type":"integer"},"desc":{"type":"string"},"type":{"type":"string"},"start_at":{"type":"integer","format":"int64"},"end_at":{"type":"integer","format":"int64"},"keywords":{"type":"string"},"emails":{"type":"string"}}},"ClusterInfo":{"type":"object","properties":{"id":{"description":"The unique ID for the node","type":"string"},"version":{"description":"The server version the node is on","type":"string"},"config_hash":{"description":"The hash of the configuartion file the node is using","type":"string"},"internode_url":{"description":"The URL used to communicate with those node from other nodes","type":"string"},"hostname":{"description":"The hostname for this node","type":"string"},"last_ping":{"description":"The time of the last ping to this node","type":"integer"},"is_alive":{"description":"Whether or not the node is alive and well","type":"boolean"}}},"AppError":{"type":"object","properties":{"status_code":{"type":"integer"},"id":{"type":"string"},"message":{"type":"string"},"request_id":{"type":"string"}}},"Status":{"type":"object","properties":{"user_id":{"type":"string"},"status":{"type":"string"},"manual":{"type":"boolean"},"last_activity_at":{"type":"integer","format":"int64"}}},"OAuthApp":{"type":"object","properties":{"id":{"type":"string","description":"The client id of the application"},"client_secret":{"type":"string","description":"The client secret of the application"},"name":{"type":"string","description":"The name of the client application"},"description":{"type":"string","description":"A short description of the application"},"icon_url":{"type":"string","description":"A URL to an icon to display with the application"},"callback_urls":{"type":"array","items":{"type":"string"},"description":"A list of callback URLs for the appliation"},"homepage":{"type":"string","description":"A link to the website of the application"},"is_trusted":{"type":"boolean","description":"Set this to `true` to skip asking users for permission"},"create_at":{"type":"integer","description":"The time of registration for the application","format":"int64"},"update_at":{"type":"integer","description":"The last time of update for the application","format":"int64"}}},"Job":{"type":"object","properties":{"id":{"type":"string","description":"The unique id of the job"},"type":{"type":"string","description":"The type of job"},"create_at":{"type":"integer","description":"The time at which the job was created","format":"int64"},"start_at":{"type":"integer","description":"The time at which the job was started","format":"int64"},"last_activity_at":{"type":"integer","description":"The last time at which the job had activity","format":"int64"},"status":{"type":"string","description":"The status of the job"},"progress":{"type":"integer","description":"The progress (as a percentage) of the job"},"data":{"type":"object","description":"A freeform data field containing additional information about the job"}}},"UserAccessToken":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the token"},"token":{"type":"string","description":"The token used for authentication"},"user_id":{"type":"string","description":"The user the token authenticates for"},"description":{"type":"string","description":"A description of the token usage"}}},"UserAccessTokenSanitized":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the token"},"user_id":{"type":"string","description":"The user the token authenticates for"},"description":{"type":"string","description":"A description of the token usage"},"is_active":{"type":"boolean","description":"Indicates whether the token is active"}}},"DataRetentionPolicy":{"type":"object","properties":{"message_deletion_enabled":{"type":"boolean","description":"Indicates whether data retention policy deletion of messages is enabled."},"file_deletion_enabled":{"type":"boolean","description":"Indicates whether data retention policy deletion of file attachments is enabled."},"message_retention_cutoff":{"type":"integer","description":"The current server timestamp before which messages should be deleted."},"file_retention_cutoff":{"type":"integer","description":"The current server timestamp before which files should be deleted."}}},"UserNotifyProps":{"type":"object","properties":{"email":{"type":"boolean","description":"Set to \"true\" to enable email notifications, \"false\" to disable. Defaults to \"true\"."},"push":{"type":"string","description":"Set to \"all\" to receive push notifications for all activity, \"mention\" for mentions and direct messages only, and \"none\" to disable. Defaults to \"mention\"."},"desktop":{"type":"string","description":"Set to \"all\" to receive desktop notifications for all activity, \"mention\" for mentions and direct messages only, and \"none\" to disable. Defaults to \"all\"."},"desktop_sound":{"type":"boolean","description":"Set to \"true\" to enable sound on desktop notifications, \"false\" to disable. Defaults to \"true\"."},"mention_keys":{"type":"string","description":"A comma-separated list of words to count as mentions. Defaults to username and @username."},"channel":{"type":"boolean","description":"Set to \"true\" to enable channel-wide notifications (@channel, @all, etc.), \"false\" to disable. Defaults to \"true\"."},"first_name":{"type":"boolean","description":"Set to \"true\" to enable mentions for first name. Defaults to \"true\" if a first name is set, \"false\" otherwise."}}},"Timezone":{"type":"object","properties":{"useAutomaticTimezone":{"type":"boolean","description":"Set to \"true\" to use the browser/system timezone, \"false\" to set manually. Defaults to \"true\"."},"manualTimezone":{"type":"string","description":"Value when setting manually the timezone, i.e. \"Europe/Berlin\"."},"automaticTimezone":{"type":"string","description":"This value is set automatically when the \"useAutomaticTimezone\" is set to \"true\"."}}},"ChannelNotifyProps":{"type":"object","properties":{"email":{"type":"boolean","description":"Set to \"true\" to enable email notifications, \"false\" to disable, or \"default\" to use the global user notification setting."},"push":{"type":"string","description":"Set to \"all\" to receive push notifications for all activity, \"mention\" for mentions and direct messages only, \"none\" to disable, or \"default\" to use the global user notification setting."},"desktop":{"type":"string","description":"Set to \"all\" to receive desktop notifications for all activity, \"mention\" for mentions and direct messages only, \"none\" to disable, or \"default\" to use the global user notification setting."},"mark_unread":{"type":"string","description":"Set to \"all\" to mark the channel unread for any new message, \"mention\" to mark unread for new mentions only. Defaults to \"all\"."}}},"PluginManifest":{"type":"object","properties":{"id":{"type":"string","description":"Globally unique identifier that represents the plugin."},"name":{"type":"string","description":"Name of the plugin."},"description":{"type":"string","description":"Description of what the plugin is and does."},"version":{"type":"string","description":"Version number of the plugin."},"min_server_version":{"type":"string","description":"The minimum Mattermost server version required for the plugin.\n\nAvailable as server version 5.6.\n"},"backend":{"type":"object","description":"Deprecated in Mattermost 5.2 release.","properties":{"executable":{"type":"string","description":"Path to the executable binary."}}},"server":{"type":"object","properties":{"executables":{"type":"object","description":"Paths to executable binaries, specifying multiple entry points for different platforms when bundled together in a single plugin.","properties":{"linux-amd64":{"type":"string"},"darwin-amd64":{"type":"string"},"windows-amd64":{"type":"string"}}},"executable":{"type":"string","description":"Path to the executable binary."}}},"webapp":{"type":"object","properties":{"bundle_path":{"type":"string","description":"Path to the webapp JavaScript bundle."}}},"settings_schema":{"type":"object","description":"Settings schema used to define the System Console UI for the plugin."}}},"MarketplacePlugin":{"type":"object","properties":{"homepage_url":{"type":"string","description":"URL that leads to the homepage of the plugin."},"icon_data":{"type":"string","description":"Base64 encoding of a plugin icon SVG."},"download_url":{"type":"string","description":"URL to download the plugin."},"release_notes_url":{"type":"string","description":"URL that leads to the release notes of the plugin."},"labels":{"type":"array","items":{"type":"string"},"description":"A list of the plugin labels."},"signature":{"type":"string","description":"Base64 encoded signature of the plugin."},"manifest":{"$ref":"#/components/schemas/PluginManifest"},"installed_version":{"type":"string","description":"Version number of the already installed plugin, if any."}}},"PluginManifestWebapp":{"type":"object","properties":{"id":{"type":"string","description":"Globally unique identifier that represents the plugin."},"version":{"type":"string","description":"Version number of the plugin."},"webapp":{"type":"object","properties":{"bundle_path":{"type":"string","description":"Path to the webapp JavaScript bundle."}}}}},"Role":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the role."},"name":{"type":"string","description":"The unique name of the role, used when assigning roles to users/groups in contexts."},"display_name":{"type":"string","description":"The human readable name for the role."},"description":{"type":"string","description":"A human readable description of the role."},"permissions":{"type":"array","items":{"type":"string"},"description":"A list of the unique names of the permissions this role grants."},"scheme_managed":{"type":"boolean","description":"indicates if this role is managed by a scheme (true), or is a custom stand-alone role (false)."}}},"Scheme":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the scheme."},"name":{"type":"string","description":"The human readable name for the scheme."},"description":{"type":"string","description":"A human readable description of the scheme."},"create_at":{"type":"integer","format":"int64","description":"The time at which the scheme was created."},"update_at":{"type":"integer","format":"int64","description":"The time at which the scheme was last updated."},"delete_at":{"type":"integer","format":"int64","description":"The time at which the scheme was deleted."},"scope":{"type":"string","description":"The scope to which this scheme can be applied, either \"team\" or \"channel\"."},"default_team_admin_role":{"type":"string","description":"The id of the default team admin role for this scheme."},"default_team_user_role":{"type":"string","description":"The id of the default team user role for this scheme."},"default_channel_admin_role":{"type":"string","description":"The id of the default channel admin role for this scheme."},"default_channel_user_role":{"type":"string","description":"The id of the default channel user role for this scheme."}}},"TermsOfService":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the terms of service."},"create_at":{"type":"integer","format":"int64","description":"The time at which the terms of service was created."},"user_id":{"type":"string","description":"The unique identifier of the user who created these terms of service."},"text":{"type":"string","description":"The text of terms of service. Supports Markdown."}}},"UserTermsOfService":{"type":"object","properties":{"user_id":{"type":"string","description":"The unique identifier of the user who performed this terms of service action."},"terms_of_service_id":{"type":"string","description":"The unique identifier of the terms of service the action was performed on."},"create_at":{"description":"The time in milliseconds that this action was performed.","type":"integer","format":"int64"}}},"PostIdToReactionsMap":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/Reaction"}}},"Group":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"display_name":{"type":"string"},"description":{"type":"string"},"source":{"type":"string"},"remote_id":{"type":"string"},"create_at":{"type":"integer","format":"int64"},"update_at":{"type":"integer","format":"int64"},"delete_at":{"type":"integer","format":"int64"},"has_syncables":{"type":"boolean"}}},"GroupSyncableTeam":{"type":"object","properties":{"team_id":{"type":"string"},"group_id":{"type":"string"},"auto_add":{"type":"boolean"},"create_at":{"type":"integer","format":"int64"},"delete_at":{"type":"integer","format":"int64"},"update_at":{"type":"integer","format":"int64"}}},"GroupSyncableChannel":{"type":"object","properties":{"channel_id":{"type":"string"},"group_id":{"type":"string"},"auto_add":{"type":"boolean"},"create_at":{"type":"integer","format":"int64"},"delete_at":{"type":"integer","format":"int64"},"update_at":{"type":"integer","format":"int64"}}},"GroupSyncableTeams":{"type":"object","properties":{"team_id":{"type":"string"},"team_display_name":{"type":"string"},"team_type":{"type":"string"},"group_id":{"type":"string"},"auto_add":{"type":"boolean"},"create_at":{"type":"integer","format":"int64"},"delete_at":{"type":"integer","format":"int64"},"update_at":{"type":"integer","format":"int64"}}},"GroupSyncableChannels":{"type":"object","properties":{"channel_id":{"type":"string"},"channel_display_name":{"type":"string"},"channel_type":{"type":"string"},"team_id":{"type":"string"},"team_display_name":{"type":"string"},"team_type":{"type":"string"},"group_id":{"type":"string"},"auto_add":{"type":"boolean"},"create_at":{"type":"integer","format":"int64"},"delete_at":{"type":"integer","format":"int64"},"update_at":{"type":"integer","format":"int64"}}},"Bot":{"description":"A bot account","type":"object","properties":{"user_id":{"description":"The user id of the associated user entry.","type":"string"},"create_at":{"description":"The time in milliseconds a bot was created","type":"integer","format":"int64"},"update_at":{"description":"The time in milliseconds a bot was last updated","type":"integer","format":"int64"},"delete_at":{"description":"The time in milliseconds a bot was deleted","type":"integer","format":"int64"},"username":{"type":"string"},"display_name":{"type":"string"},"description":{"type":"string"},"owner_id":{"description":"The user id of the user that currently owns this bot.","type":"string"}}},"Server_Busy":{"type":"object","properties":{"busy":{"description":"True if the server is marked as busy (under high load)","type":"boolean"},"expires":{"description":"timestamp - number of seconds since Jan 1, 1970 UTC.","type":"integer","format":"int64"}}}}},"externalDocs":{"description":"Find out more about Mattermost","url":"https://about.mattermost.com"},"security":[{"bearerAuth":[]}]}},"searchIndex":{"store":["section/Authentication","tag/introduction","tag/schema","tag/APIv3-Deprecation","tag/drivers","tag/authentication","tag/errors","tag/rate-limiting","tag/WebSocket","tag/users","tag/users/paths/~1users/post","tag/users/paths/~1users/get","tag/users/paths/~1users~1ids/post","tag/users/paths/~1users~1group_channels/post","tag/users/paths/~1users~1usernames/post","tag/users/paths/~1users~1search/post","tag/users/paths/~1users~1autocomplete/get","tag/users/paths/~1users~1stats/get","tag/users/paths/~1users~1{user_id}/get","tag/users/paths/~1users~1{user_id}/put","tag/users/paths/~1users~1{user_id}/delete","tag/users/paths/~1users~1{user_id}~1patch/put","tag/users/paths/~1users~1{user_id}~1roles/put","tag/users/paths/~1users~1{user_id}~1active/put","tag/users/paths/~1users~1{user_id}~1image/get","tag/users/paths/~1users~1{user_id}~1image/post","tag/users/paths/~1users~1{user_id}~1image/delete","tag/users/paths/~1users~1{user_id}~1image~1default/get","tag/users/paths/~1users~1username~1{username}/get","tag/users/paths/~1users~1password~1reset/post","tag/users/paths/~1users~1{user_id}~1mfa/put","tag/users/paths/~1users~1{user_id}~1mfa~1generate/post","tag/users/paths/~1users~1{user_id}~1demote/post","tag/users/paths/~1users~1{user_id}~1promote/post","tag/users/paths/~1users~1mfa/post","tag/users/paths/~1users~1{user_id}~1password/put","tag/users/paths/~1users~1password~1reset~1send/post","tag/users/paths/~1users~1email~1{email}/get","tag/users/paths/~1users~1{user_id}~1sessions/get","tag/users/paths/~1users~1{user_id}~1sessions~1revoke/post","tag/users/paths/~1users~1{user_id}~1sessions~1revoke~1all/post","tag/users/paths/~1users~1sessions~1device/put","tag/users/paths/~1users~1{user_id}~1audits/get","tag/users/paths/~1users~1email~1verify/post","tag/users/paths/~1users~1email~1verify~1send/post","tag/users/paths/~1users~1login~1switch/post","tag/users/paths/~1users~1{user_id}~1tokens/post","tag/users/paths/~1users~1{user_id}~1tokens/get","tag/users/paths/~1users~1tokens/get","tag/users/paths/~1users~1tokens~1revoke/post","tag/users/paths/~1users~1tokens~1{token_id}/get","tag/users/paths/~1users~1tokens~1disable/post","tag/users/paths/~1users~1tokens~1enable/post","tag/users/paths/~1users~1tokens~1search/post","tag/users/paths/~1users~1{user_id}~1auth/put","tag/users/paths/~1users~1{user_id}~1terms_of_service/post","tag/users/paths/~1users~1{user_id}~1terms_of_service/get","tag/users/paths/~1users~1sessions~1revoke~1all/post","tag/bots","tag/bots/paths/~1bots/post","tag/bots/paths/~1bots/get","tag/bots/paths/~1bots~1{bot_user_id}/put","tag/bots/paths/~1bots~1{bot_user_id}/get","tag/bots/paths/~1bots~1{bot_user_id}~1disable/post","tag/bots/paths/~1bots~1{bot_user_id}~1enable/post","tag/bots/paths/~1bots~1{bot_user_id}~1assign~1{user_id}/post","tag/bots/paths/~1bots~1{bot_user_id}~1icon/get","tag/bots/paths/~1bots~1{bot_user_id}~1icon/post","tag/bots/paths/~1bots~1{bot_user_id}~1icon/delete","tag/teams","tag/teams/paths/~1teams/post","tag/teams/paths/~1teams/get","tag/teams/paths/~1teams~1{team_id}/get","tag/teams/paths/~1teams~1{team_id}/put","tag/teams/paths/~1teams~1{team_id}/delete","tag/teams/paths/~1teams~1{team_id}~1patch/put","tag/teams/paths/~1teams~1name~1{name}/get","tag/teams/paths/~1teams~1search/post","tag/teams/paths/~1teams~1name~1{name}~1exists/get","tag/teams/paths/~1users~1{user_id}~1teams/get","tag/teams/paths/~1teams~1{team_id}~1members/get","tag/teams/paths/~1teams~1{team_id}~1members/post","tag/teams/paths/~1teams~1members~1invite/post","tag/teams/paths/~1teams~1{team_id}~1members~1batch/post","tag/teams/paths/~1users~1{user_id}~1teams~1members/get","tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}/get","tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}/delete","tag/teams/paths/~1teams~1{team_id}~1members~1ids/post","tag/teams/paths/~1teams~1{team_id}~1stats/get","tag/teams/paths/~1teams~1{team_id}~1regenerate_invite_id/post","tag/teams/paths/~1teams~1{team_id}~1image/get","tag/teams/paths/~1teams~1{team_id}~1image/post","tag/teams/paths/~1teams~1{team_id}~1image/delete","tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}~1roles/put","tag/teams/paths/~1teams~1{team_id}~1members~1{user_id}~1schemeRoles/put","tag/teams/paths/~1users~1{user_id}~1teams~1unread/get","tag/teams/paths/~1users~1{user_id}~1teams~1{team_id}~1unread/get","tag/teams/paths/~1teams~1{team_id}~1invite~1email/post","tag/teams/paths/~1teams~1{team_id}~1invite-guests~1email/post","tag/teams/paths/~1teams~1invites~1email/delete","tag/teams/paths/~1teams~1{team_id}~1import/post","tag/teams/paths/~1teams~1invite~1{invite_id}/get","tag/teams/paths/~1teams~1{team_id}~1scheme/put","tag/teams/paths/~1teams~1{team_id}~1members_minus_group_members/get","tag/channels","tag/channels/paths/~1channels/post","tag/channels/paths/~1channels~1direct/post","tag/channels/paths/~1channels~1group/post","tag/channels/paths/~1channels~1search/post","tag/channels/paths/~1group~1search/post","tag/channels/paths/~1teams~1{team_id}~1channels~1ids/post","tag/channels/paths/~1channels~1{channel_id}~1timezones/get","tag/channels/paths/~1channels~1{channel_id}/get","tag/channels/paths/~1channels~1{channel_id}/put","tag/channels/paths/~1channels~1{channel_id}/delete","tag/channels/paths/~1channels~1{channel_id}~1patch/put","tag/channels/paths/~1channels~1{channel_id}~1privacy/put","tag/channels/paths/~1channels~1{channel_id}~1convert/post","tag/channels/paths/~1channels~1{channel_id}~1restore/post","tag/channels/paths/~1channels~1{channel_id}~1stats/get","tag/channels/paths/~1channels~1{channel_id}~1pinned/get","tag/channels/paths/~1teams~1{team_id}~1channels/get","tag/channels/paths/~1teams~1{team_id}~1channels~1deleted/get","tag/channels/paths/~1teams~1{team_id}~1channels~1autocomplete/get","tag/channels/paths/~1teams~1{team_id}~1channels~1search_autocomplete/get","tag/channels/paths/~1teams~1{team_id}~1channels~1search/post","tag/channels/paths/~1teams~1{team_id}~1channels~1search_archived/post","tag/channels/paths/~1teams~1{team_id}~1channels~1name~1{channel_name}/get","tag/channels/paths/~1teams~1name~1{team_name}~1channels~1name~1{channel_name}/get","tag/channels/paths/~1channels~1{channel_id}~1members/get","tag/channels/paths/~1channels~1{channel_id}~1members/post","tag/channels/paths/~1channels~1{channel_id}~1members~1ids/post","tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}/get","tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}/delete","tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}~1roles/put","tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}~1schemeRoles/put","tag/channels/paths/~1channels~1{channel_id}~1members~1{user_id}~1notify_props/put","tag/channels/paths/~1channels~1members~1{user_id}~1view/post","tag/channels/paths/~1users~1{user_id}~1teams~1{team_id}~1channels~1members/get","tag/channels/paths/~1users~1{user_id}~1teams~1{team_id}~1channels/get","tag/channels/paths/~1users~1{user_id}~1channels~1{channel_id}~1unread/get","tag/channels/paths/~1channels~1{channel_id}~1scheme/put","tag/channels/paths/~1channels~1{channel_id}~1members_minus_group_members/get","tag/posts","tag/posts/paths/~1posts/post","tag/posts/paths/~1posts~1ephemeral/post","tag/posts/paths/~1posts~1{post_id}/get","tag/posts/paths/~1posts~1{post_id}/delete","tag/posts/paths/~1posts~1{post_id}/put","tag/posts/paths/~1user~1{user_id}~1posts~1{post_id}~1set_unread/post","tag/posts/paths/~1posts~1{post_id}~1patch/put","tag/posts/paths/~1posts~1{post_id}~1thread/get","tag/posts/paths/~1users~1{user_id}~1posts~1flagged/get","tag/posts/paths/~1posts~1{post_id}~1files~1info/get","tag/posts/paths/~1channels~1{channel_id}~1posts/get","tag/posts/paths/~1users~1{user_id}~1channels~1{channel_id}~1posts~1unread/get","tag/posts/paths/~1teams~1{team_id}~1posts~1search/post","tag/posts/paths/~1posts~1{post_id}~1pin/post","tag/posts/paths/~1posts~1{post_id}~1unpin/post","tag/posts/paths/~1posts~1{post_id}~1actions~1{action_id}/post","tag/files","tag/files/paths/~1files/post","tag/files/paths/~1files~1{file_id}/get","tag/files/paths/~1files~1{file_id}~1thumbnail/get","tag/files/paths/~1files~1{file_id}~1preview/get","tag/files/paths/~1files~1{file_id}~1link/get","tag/files/paths/~1files~1{file_id}~1info/get","tag/preferences","tag/preferences/paths/~1users~1{user_id}~1preferences/get","tag/preferences/paths/~1users~1{user_id}~1preferences/put","tag/preferences/paths/~1users~1{user_id}~1preferences~1delete/post","tag/preferences/paths/~1users~1{user_id}~1preferences~1{category}/get","tag/preferences/paths/~1users~1{user_id}~1preferences~1{category}~1name~1{preference_name}/get","tag/status","tag/status/paths/~1users~1{user_id}~1status/get","tag/status/paths/~1users~1{user_id}~1status/put","tag/status/paths/~1users~1status~1ids/post","tag/emoji","tag/emoji/paths/~1emoji/post","tag/emoji/paths/~1emoji/get","tag/emoji/paths/~1emoji~1{emoji_id}/get","tag/emoji/paths/~1emoji~1{emoji_id}/delete","tag/emoji/paths/~1emoji~1name~1{emoji_name}/get","tag/emoji/paths/~1emoji~1{emoji_id}~1image/get","tag/emoji/paths/~1emoji~1search/post","tag/emoji/paths/~1emoji~1autocomplete/get","tag/reactions","tag/reactions/paths/~1reactions/post","tag/reactions/paths/~1posts~1{post_id}~1reactions/get","tag/reactions/paths/~1users~1{user_id}~1posts~1{post_id}~1reactions~1{emoji_name}/delete","tag/reactions/paths/~1posts~1ids~1reactions/post","tag/webhooks","tag/webhooks/paths/~1hooks~1incoming/post","tag/webhooks/paths/~1hooks~1incoming/get","tag/webhooks/paths/~1hooks~1incoming~1{hook_id}/get","tag/webhooks/paths/~1hooks~1incoming~1{hook_id}/put","tag/webhooks/paths/~1hooks~1outgoing/post","tag/webhooks/paths/~1hooks~1outgoing/get","tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}/get","tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}/delete","tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}/put","tag/webhooks/paths/~1hooks~1outgoing~1{hook_id}~1regen_token/post","tag/commands","tag/commands/paths/~1commands/post","tag/commands/paths/~1commands/get","tag/commands/paths/~1teams~1{team_id}~1commands~1autocomplete/get","tag/commands/paths/~1commands~1{command_id}/get","tag/commands/paths/~1commands~1{command_id}/put","tag/commands/paths/~1commands~1{command_id}/delete","tag/commands/paths/~1commands~1{command_id}~1move/put","tag/commands/paths/~1commands~1{command_id}~1regen_token/put","tag/commands/paths/~1commands~1execute/post","tag/OpenGraph","tag/OpenGraph/paths/~1opengraph/post","tag/system","tag/system/paths/~1system~1ping/get","tag/system/paths/~1database~1recycle/post","tag/system/paths/~1email~1test/post","tag/system/paths/~1site_url~1test/post","tag/system/paths/~1file~1s3_test/post","tag/system/paths/~1config/get","tag/system/paths/~1config/put","tag/system/paths/~1config~1reload/post","tag/system/paths/~1config~1client/get","tag/system/paths/~1config~1environment/get","tag/system/paths/~1config~1patch/put","tag/system/paths/~1license/post","tag/system/paths/~1license/delete","tag/system/paths/~1license~1client/get","tag/system/paths/~1audits/get","tag/system/paths/~1caches~1invalidate/post","tag/system/paths/~1logs/get","tag/system/paths/~1logs/post","tag/system/paths/~1analytics~1old/get","tag/system/paths/~1server_busy/post","tag/system/paths/~1server_busy/get","tag/system/paths/~1server_busy/delete","tag/brand","tag/brand/paths/~1brand~1image/get","tag/brand/paths/~1brand~1image/post","tag/brand/paths/~1brand~1image/delete","tag/OAuth","tag/OAuth/paths/~1oauth~1apps/post","tag/OAuth/paths/~1oauth~1apps/get","tag/OAuth/paths/~1oauth~1apps~1{app_id}/get","tag/OAuth/paths/~1oauth~1apps~1{app_id}/put","tag/OAuth/paths/~1oauth~1apps~1{app_id}/delete","tag/OAuth/paths/~1oauth~1apps~1{app_id}~1regen_secret/post","tag/OAuth/paths/~1oauth~1apps~1{app_id}~1info/get","tag/OAuth/paths/~1users~1{user_id}~1oauth~1apps~1authorized/get","tag/SAML","tag/SAML/paths/~1saml~1metadata/get","tag/SAML/paths/~1saml~1certificate~1idp/post","tag/SAML/paths/~1saml~1certificate~1idp/delete","tag/SAML/paths/~1saml~1certificate~1public/post","tag/SAML/paths/~1saml~1certificate~1public/delete","tag/SAML/paths/~1saml~1certificate~1private/post","tag/SAML/paths/~1saml~1certificate~1private/delete","tag/SAML/paths/~1saml~1certificate~1status/get","tag/LDAP","tag/LDAP/paths/~1ldap~1sync/post","tag/LDAP/paths/~1ldap~1test/post","tag/groups","tag/groups/paths/~1groups/get","tag/groups/paths/~1groups~1{group_id}/get","tag/groups/paths/~1groups~1{group_id}~1patch/put","tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}~1link/post","tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}~1link/delete","tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}~1link/post","tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}~1link/delete","tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}/get","tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}/get","tag/groups/paths/~1groups~1{group_id}~1teams/get","tag/groups/paths/~1groups~1{group_id}~1channels/get","tag/groups/paths/~1groups~1{group_id}~1teams~1{team_id}~1patch/put","tag/groups/paths/~1groups~1{group_id}~1channels~1{channel_id}~1patch/put","tag/groups/paths/~1groups~1{group_id}~1members/get","tag/groups/paths/~1channels~1{channel_id}~1groups/get","tag/groups/paths/~1teams~1{team_id}~1groups/get","tag/compliance","tag/compliance/paths/~1compliance~1reports/post","tag/compliance/paths/~1compliance~1reports/get","tag/compliance/paths/~1compliance~1reports~1{report_id}/get","tag/compliance/paths/~1compliance~1reports~1{report_id}~1download/get","tag/cluster","tag/cluster/paths/~1cluster~1status/get","tag/elasticsearch","tag/elasticsearch/paths/~1elasticsearch~1test/post","tag/elasticsearch/paths/~1elasticsearch~1purge_indexes/post","tag/dataretention","tag/dataretention/paths/~1data_retention~1policy/get","tag/jobs","tag/jobs/paths/~1jobs/get","tag/jobs/paths/~1jobs/post","tag/jobs/paths/~1jobs~1{job_id}/get","tag/jobs/paths/~1jobs~1{job_id}~1cancel/post","tag/jobs/paths/~1jobs~1type~1{type}/get","tag/plugins","tag/plugins/paths/~1plugins/post","tag/plugins/paths/~1plugins/get","tag/plugins/paths/~1plugins~1install_from_url/post","tag/plugins/paths/~1plugins~1{plugin_id}/delete","tag/plugins/paths/~1plugins~1{plugin_id}~1enable/post","tag/plugins/paths/~1plugins~1{plugin_id}~1disable/post","tag/plugins/paths/~1plugins~1webapp/get","tag/plugins/paths/~1plugins~1marketplace/post","tag/plugins/paths/~1plugins~1marketplace/get","tag/roles","tag/roles/paths/~1roles~1{role_id}/get","tag/roles/paths/~1roles~1name~1{role_name}/get","tag/roles/paths/~1roles~1{role_id}~1patch/put","tag/roles/paths/~1roles~1names/post","tag/schemes","tag/schemes/paths/~1schemes/get","tag/schemes/paths/~1schemes/post","tag/schemes/paths/~1schemes~1{scheme_id}/get","tag/schemes/paths/~1schemes~1{scheme_id}/delete","tag/schemes/paths/~1schemes~1{scheme_id}~1patch/put","tag/schemes/paths/~1schemes~1{scheme_id}~1teams/get","tag/schemes/paths/~1schemes~1{scheme_id}~1channels/get","tag/integration_actions","tag/integration_actions/paths/~1actions~1dialogs~1open/post","tag/integration_actions/paths/~1actions~1dialogs~1submit/post","tag/terms-of-service","tag/terms-of-service/paths/~1users~1{user_id}~1terms_of_service/post","tag/terms-of-service/paths/~1users~1{user_id}~1terms_of_service/get"],"index":{"version":"2.3.8","fields":["title","description"],"fieldVectors":[["title/0",[0,2.415]],["description/0",[1,0.216,2,7.992,3,7.992]],["title/1",[4,7.182]],["description/1",[1,0.077,5,2.724,6,1.586,7,1.043,8,4.962,9,1.147,10,1.105,11,1.992,12,1.992,13,1.272,14,1.063,15,0.277,16,1.679,17,1.679,18,1.679,19,1.992,20,1.45,21,2.874,22,1.511,23,1.992,24,1.992,25,1.586,26,4.472,27,1.992,28,4.048,29,1.992,30,4.794,31,1.679,32,0.624,33,4.048,34,1.679,35,1.679,36,1.992,37,3.087,38,3.087,39,0.351,40,0.714,41,1.992,42,1.992,43,1.992,44,1.992,45,3.411,46,3.411,47,1.339,48,1.992,49,1.803,50,3.411,51,1.992,52,1.992,53,1.679,54,1.511,55,1.992,56,1.992,57,1.992,58,1.992,59,1.992,60,3.087,61,1.239,62,1.992,63,0.843,64,1.679,65,1.397,66,1.803,67,1.992,68,1.992,69,1.803,70,1.803,71,1.803,72,1.992,73,1.992,74,1.397,75,1.992,76,1.992]],["title/2",[77,7.182]],["description/2",[8,3.293,9,2.316,47,2.704,78,2.498,79,3.405,80,4.857,81,4.857,82,3.535,83,2.233,84,4.396,85,1.74,86,1.667,87,1.096,88,2.138,89,2.003,90,4.396,91,3.866,92,2.694,93,4.396,94,1.6]],["title/3",[95,5.927,96,4.497]],["description/3",[1,0.119,5,1.595,8,3.965,9,1.383,15,0.432,22,1.354,30,1.615,32,0.302,35,0.813,37,1.615,39,0.17,47,1.217,49,0.873,53,0.813,60,1.615,66,0.873,69,0.873,79,0.676,85,1.995,86,0.613,87,0.341,88,0.962,89,0.398,94,1.927,96,0.732,97,0.813,98,0.965,99,1.784,100,1.784,101,5.258,102,1.784,103,0.535,104,0.965,105,0.965,106,0.732,107,0.965,108,0.873,109,3.639,110,3.274,111,0.525,112,5.567,113,0.654,114,0.965,115,1.615,116,0.965,117,0.585,118,1.42,119,1.675,120,1.173,121,3.101,122,1.615,123,1.348,124,3.101,125,1.589,126,0.472,127,0.965,128,0.813,129,1.615,130,0.464,131,2.489,132,1.784,133,0.965,134,0.965,135,0.267,136,0.965,137,0.768,138,0.965,139,0.965,140,0.965,141,0.965,142,0.965,143,0.965,144,0.965,145,0.634,146,0.873,147,0.496,148,0.558,149,0.965,150,1.784,151,0.965,152,0.965,153,0.965,154,1.42,155,1.42,156,0.366,157,0.965,158,0.768,159,0.558,160,0.732,161,1.811,162,0.965,163,0.813,164,0.965,165,0.873,166,0.813,167,0.768,168,0.965,169,0.634,170,0.702,171,0.873,172,0.634,173,0.307,174,0.873,175,0.768,176,0.408,177,0.965,178,1.615,179,0.515,180,1.082,181,0.444,182,0.873,183,0.457,184,0.676,185,0.616,186,0.965,187,0.965,188,0.965,189,0.965,190,0.965]],["title/4",[18,6.052]],["description/4",[1,0.207,5,3.417,6,2.815,7,1.852,8,3.692,14,1.886,16,2.98,17,2.98,18,6.288,79,2.479,111,1.923,191,3.536,192,3.201,193,3.536,194,1.923,195,3.201,196,3.536,197,3.536,198,5.447,199,3.536,200,3.536,201,5.447,202,3.536,203,3.536,204,3.536,205,3.536,206,3.536,207,3.536,208,2.397,209,3.536]],["title/5",[0,2.415]],["description/5",[0,0.35,1,0.149,5,1.982,7,1.003,8,1.802,9,1.296,15,0.145,28,0.943,34,0.878,38,0.943,40,0.373,47,0.752,54,0.791,70,0.943,78,2.234,82,0.758,83,0.881,84,0.943,87,0.451,88,0.323,91,0.83,94,0.343,110,0.83,111,0.567,118,0.83,156,0.395,167,1.525,169,0.685,175,1.525,178,0.943,180,1.161,182,1.734,184,0.731,192,0.943,195,0.943,208,0.706,210,0.943,211,0.878,212,1.916,213,1.916,214,1.734,215,1.042,216,1.539,217,3.159,218,0.83,219,1.042,220,1.453,221,1.042,222,1.916,223,0.685,224,0.706,225,0.758,226,0.527,227,0.685,228,0.878,229,1.042,230,1.042,231,3.854,232,1.916,233,1.042,234,1.916,235,0.878,236,0.943,237,0.758,238,2.659,239,1.916,240,1.042,241,1.042,242,1.042,243,1.042,244,0.878,245,0.731,246,2.406,247,1.063,248,0.943,249,0.943,250,0.943,251,1.042,252,1.042,253,1.042,254,1.042,255,1.042,256,1.916,257,0.943,258,0.943,259,0.943,260,0.943,261,0.943,262,1.042,263,1.042,264,1.042,265,0.943,266,1.042,267,1.042,268,0.943,269,0.943,270,1.042,271,0.943,272,1.042,273,1.042,274,1.042,275,1.042,276,2.779,277,1.042,278,3.298,279,1.453,280,1.916,281,1.916,282,2.924,283,1.042,284,1.042,285,0.943,286,1.042,287,0.943,288,1.042,289,1.042,290,0.878,291,0.943,292,0.666,293,1.916,294,1.042,295,1.696,296,1.698,297,1.042,298,0.791,299,1.042,300,0.589,301,1.042,302,1.042,303,0.731,304,1.042,305,1.042]],["title/6",[161,5.226]],["description/6",[1,0.216,47,1.468,74,3.986,82,2.721,83,1.719,88,1.764,106,2.837,155,2.977,161,5.004,179,1.995,194,2.033,218,4.525,220,2.837,295,1.924,306,3.74,307,3.74,308,3.74,309,2.214,310,3.74,311,3.74,312,3.74,313,3.385,314,3.74,315,3.74,316,3.151,317,2.164,318,3.74,319,3.385]],["title/7",[320,5.365,321,4.718]],["description/7",[1,0.219,5,1.074,8,1.415,47,2.145,54,2.694,82,2.584,83,0.96,106,2.694,118,1.662,161,1.519,166,2.992,180,1.266,218,1.662,236,3.214,246,4.192,248,1.89,257,4.192,258,4.192,259,4.192,260,1.89,261,4.192,265,1.89,268,1.89,269,1.89,271,1.89,316,1.76,317,1.208,320,4.192,321,4.349,322,2.088,323,1.89,324,2.088,325,2.088,326,1.765,327,1.89,328,1.76,329,2.826,330,1.76,331,3.55,332,2.088,333,2.088,334,1.76,335,1.519,336,1.89,337,1.89,338,2.088,339,2.088,340,2.088,341,2.088,342,2.088]],["title/8",[343,6.501]],["description/8",[0,1.279,1,0.218,5,1.804,6,0.471,7,0.31,8,1.925,9,0.692,10,1.368,15,0.225,16,0.499,17,0.499,20,2.552,22,0.449,25,0.471,31,0.499,32,0.353,33,0.536,34,0.499,39,0.199,40,0.404,47,1.251,54,0.855,79,0.415,82,2.067,85,0.212,87,0.221,88,0.501,91,0.897,92,1.368,94,0.195,106,1.224,115,0.536,118,0.897,119,0.657,123,0.257,129,1.863,146,0.536,147,0.304,148,0.342,161,1.174,165,0.536,169,0.389,175,1.638,194,0.322,208,0.401,217,0.294,218,0.897,220,0.449,235,0.499,244,0.499,245,1.443,250,1.461,285,0.536,309,0.667,316,0.499,317,0.934,323,0.536,329,0.471,337,1.461,343,5.06,344,0.536,345,0.499,346,0.592,347,4.809,348,0.592,349,0.592,350,1.614,351,0.592,352,0.342,353,0.592,354,0.592,355,0.592,356,1.127,357,1.127,358,0.592,359,0.536,360,0.592,361,0.741,362,2.058,363,2.466,364,1.127,365,2.067,366,0.592,367,2.058,368,0.499,369,0.592,370,1.614,371,0.592,372,1.614,373,0.449,374,0.592,375,0.316,376,0.471,377,1.248,378,0.592,379,0.592,380,0.592,381,1.614,382,1.127,383,0.536,384,0.79,385,1.127,386,0.897,387,0.471,388,1.059,389,0.592,390,0.683,391,0.592,392,1.127,393,0.592,394,0.471,395,0.342,396,0.592,397,0.592,398,0.592,399,0.592,400,0.592,401,0.592,402,0.592,403,0.592,404,0.592,405,0.592,406,0.592,407,0.592,408,0.592,409,0.592,410,0.592,411,0.592,412,0.592,413,0.592,414,0.592,415,0.592,416,0.592,417,0.592,418,0.592,419,0.592,420,0.592,421,0.592,422,0.592,423,0.592,424,0.592,425,0.592,426,0.592,427,0.592,428,0.592,429,0.592,430,0.592,431,0.592,432,0.536,433,1.614,434,0.592,435,0.592,436,0.499,437,0.592,438,0.499,439,0.272,440,0.449,441,0.592,442,0.592,443,0.592,444,1.127,445,0.592,446,0.449,447,0.592,448,0.592,449,0.592,450,0.592,451,0.592,452,0.592,453,0.592,454,0.592,455,0.592,456,0.592,457,0.592,458,0.592]],["title/9",[87,0.983]],["description/9",[9,2.481,14,2.858,85,2.644,86,1.839,87,1.244,88,2.29,89,2.209,90,4.849,91,4.264,92,2.972,93,4.849,94,1.765,176,2.267,459,1.859]],["title/10",[87,0.811,459,2.056]],["description/10",[0,1.603,1,0.108,15,0.664,86,2.72,87,0.931,123,2.072,156,1.807,223,3.134,226,2.41,373,3.618,375,2.543,377,2.891,388,2.453,459,1.654,460,3.618,461,3.232,462,2.964,463,4.768,464,4.768,465,0.189,466,4.768,467,4.768]],["title/11",[87,0.983]],["description/11",[1,0.083,9,1.239,15,0.513,21,3.107,22,2.797,32,1.155,39,1.202,86,1.266,87,1.044,89,1.52,147,1.896,173,1.173,181,1.695,183,2.664,194,2.005,216,1.72,326,1.833,432,3.337,439,1.695,465,0.103,468,1.447,469,2.444,470,5.786,471,2.797,472,6.17,473,1.747,474,2.499,475,2.585]],["title/12",[87,0.811,88,1.839]],["description/12",[1,0.142,32,2.567,86,2.149,87,1.121,88,1.943,216,2.922,300,1.924,465,0.228,468,2.458,473,2.966]],["title/13",[39,0.775,87,0.601,88,1.363,476,1.745]],["description/13",[1,0.099,15,0.608,32,1.369,39,1.126,63,2.701,82,3.178,86,1.499,87,0.873,88,1.981,183,3.024,216,2.038,245,3.062,247,2.423,330,3.68,395,2.527,465,0.178,473,2.07,476,2.996,477,3.178,478,3.314,479,0.83,480,0.887,481,2.789]],["title/14",[87,0.811,227,3.895]],["description/14",[1,0.145,32,2.608,86,2.202,87,0.878,216,2.994,227,4.216,300,1.971,465,0.232,468,2.518,473,3.04]],["title/15",[87,0.811,130,2.852]],["description/15",[1,0.093,15,0.57,32,1.283,39,0.722,47,2.388,83,2.797,86,1.405,87,0.56,113,2.774,130,2.928,156,1.551,173,0.704,211,3.449,216,1.91,226,2.069,227,2.69,300,1.258,465,0.169,468,1.607,473,1.939,474,2.774,482,3.449,483,3.449,484,3.705,485,3.705,486,2.143,487,4.093,488,4.093,489,1.855,490,4.093,491,2.318]],["title/16",[87,0.811,492,3.895]],["description/16",[1,0.104,9,1.546,32,1.441,39,0.811,86,1.579,87,0.629,130,2.214,173,0.791,216,2.146,300,1.414,386,3.661,387,3.661,436,3.876,465,0.128,468,1.806,473,2.179,474,3.118,489,2.084,491,2.605,492,3.023,493,2.409,494,4.6,495,5.584,496,4.646,497,6.626]],["title/17",[87,0.601,123,1.909,498,3.701,499,3.496]],["description/17",[0,2.46,1,0.166,87,1.001,123,3.18,465,0.204,498,6.166,499,5.824]],["title/18",[87,0.983]],["description/18",[1,0.145,86,2.202,87,0.878,216,2.994,247,3.558,390,3.889,465,0.232,473,3.04,500,5.106,501,5.106,502,4.668]],["title/19",[87,0.811,135,1.643]],["description/19",[1,0.1,47,2.536,83,2.971,87,1.042,94,1.463,119,1.809,135,2.111,180,2.693,247,2.464,300,1.986,352,2.571,383,4.021,388,3.917,439,2.043,465,0.18,478,3.37,503,2.693,504,4.442,505,3.233,506,1.905]],["title/20",[87,0.69,507,4.251,508,3.316]],["description/20",[1,0.135,87,1.221,94,1.967,216,2.787,247,3.313,292,3.814,439,2.746,465,0.221,506,2.561,507,6.692,509,5.033]],["title/21",[87,0.811,510,3.593]],["description/21",[1,0.108,47,1.872,61,2.964,83,2.192,87,0.931,94,1.571,135,2.532,300,2.09,352,2.759,388,4.444,395,2.759,439,2.192,465,0.189,503,2.891,506,2.044,511,3.045]],["title/22",[135,1.399,512,1.912,513,2.467]],["description/22",[1,0.124,87,0.749,135,1.516,465,0.208,512,2.073,513,4.172,514,7.484,515,3.835,516,5.47,517,5.47,518,4.61,519,4.951,520,3.595,521,4.354,522,5.47]],["title/23",[87,0.601,135,1.218,317,2.541,473,2.081]],["description/23",[1,0.07,5,1.601,9,1.047,15,0.687,71,2.818,85,1.115,87,1.157,97,2.623,135,0.863,147,2.536,154,2.478,300,1.881,317,4.029,334,2.623,335,2.265,460,3.741,465,0.137,473,3.825,507,5.867,508,2.046,523,2.818,524,3.113,525,6.963,526,3.113,527,2.818,528,3.113,529,3.113,530,3.113,531,0.782]],["title/24",[512,1.912,532,3.42,533,2.508]],["description/24",[1,0.153,89,2.783,94,2.223,384,4.731,465,0.188,468,2.649,469,2.932,512,2.557,532,4.574,533,3.354]],["title/25",[119,1.788,512,1.664,532,2.977,533,2.183]],["description/25",[1,0.132,87,0.799,89,2.408,94,1.923,119,2.378,135,1.619,384,4.094,439,2.685,465,0.218,468,2.292,469,2.537,506,2.504,512,2.213,532,3.958,533,2.902]],["title/26",[512,1.664,532,2.977,533,2.183,534,1.684]],["description/26",[1,0.114,15,0.703,87,0.691,89,2.081,94,1.662,135,1.399,335,3.672,384,3.538,439,2.32,465,0.197,468,1.981,469,2.193,479,0.959,480,1.025,505,3.672,506,2.163,512,1.912,532,3.42,533,3.518,534,1.934,535,4.567]],["title/27",[125,2.228,179,1.861,505,2.538,512,1.322,532,2.365,533,1.734]],["description/27",[1,0.129,15,0.795,87,0.782,89,2.355,94,1.881,125,3.647,179,3.046,384,4.004,465,0.159,468,2.242,469,2.482,479,1.086,480,1.16,505,4.155,532,3.871,533,2.839,535,5.169]],["title/28",[87,0.811,227,3.895]],["description/28",[1,0.138,86,2.099,87,0.837,216,2.853,227,4.018,247,3.391,300,1.879,390,3.706,465,0.224,473,2.897,500,4.866,501,4.866,502,4.448]],["title/29",[223,3.895,335,4.313]],["description/29",[1,0.126,9,1.879,25,4.448,74,3.918,86,1.918,87,1.039,135,1.549,160,4.24,223,3.672,465,0.211,508,3.672,512,2.118,536,5.058,537,5.058,538,5.058,539,5.058]],["title/30",[135,1.399,225,3.671,512,1.912]],["description/30",[0,2.316,1,0.11,74,4.83,86,1.667,87,1.096,94,1.6,135,1.347,155,3.866,159,2.811,300,1.493,439,2.233,465,0.192,473,3.793,506,2.083,515,3.405,540,5.805,541,3.866]],["title/31",[125,3.222,225,3.671,542,3.828]],["description/31",[0,1.879,1,0.126,74,3.918,87,1.039,89,2.304,94,1.841,125,3.568,179,2.981,465,0.211,506,2.396,533,2.778,540,4.709,542,4.24,543,5.588,544,5.588,545,5.588]],["title/32",[87,0.69,546,5.045,547,3.671]],["description/32",[1,0.112,15,0.689,39,0.873,87,1.107,94,1.63,123,2.151,173,0.851,465,0.194,475,3.47,479,0.941,480,1.006,547,5.081,548,5.557,549,4.171,550,4.48,551,4.48,552,3.602,553,3.355,554,4.95]],["title/33",[87,0.69,547,3.671,555,5.045]],["description/33",[1,0.106,15,0.652,35,3.946,39,1.184,87,1.074,94,1.542,123,2.035,173,0.805,465,0.187,475,3.283,479,0.89,480,0.951,505,3.407,547,4.884,548,5.342,549,3.946,550,4.238,551,4.238,553,3.174,556,3.946,557,4.682]],["title/34",[145,3.895,225,4.313]],["description/34",[0,1.765,1,0.119,9,1.765,74,3.68,86,1.802,87,0.718,88,1.629,94,1.729,145,4.781,225,3.82,300,2.236,319,4.751,460,3.983,465,0.202,473,2.487,508,3.45,540,4.423,558,4.178]],["title/35",[135,1.399,223,3.316,512,1.912]],["description/35",[1,0.108,15,0.664,86,1.637,87,0.653,94,1.571,119,1.942,135,1.885,156,1.807,169,3.134,223,6.241,235,4.018,326,2.37,375,2.543,439,2.192,465,0.189,512,1.807,531,1.198,559,4.768,560,3.795]],["title/36",[223,2.886,226,2.22,335,3.196,361,2.886]],["description/36",[1,0.114,25,4.016,74,3.538,86,1.732,87,0.691,160,3.828,223,3.316,226,2.551,245,4.962,335,3.672,361,3.316,465,0.197,508,3.316,512,2.682,536,4.567,537,4.567,538,4.567,539,4.567,561,3.925]],["title/37",[87,0.811,226,2.996]],["description/37",[1,0.112,86,1.699,87,0.956,119,2.016,120,3.253,216,3.258,226,3.529,247,2.745,300,1.521,326,2.46,376,3.94,390,3.001,465,0.138,468,1.943,473,2.345,500,3.94,501,3.94,502,3.602,512,1.876,562,4.171,563,4.171]],["title/38",[216,2.766,512,2.246]],["description/38",[1,0.129,32,1.789,87,1.055,94,1.881,135,1.583,216,2.665,300,1.755,390,3.462,439,2.626,465,0.214,500,4.545,501,4.545,502,4.155,506,2.449,564,5.169]],["title/39",[87,0.69,216,2.355,292,3.222]],["description/39",[1,0.129,87,1.194,88,2.391,89,2.355,94,1.881,135,1.583,216,3.596,292,3.647,300,1.755,439,2.626,465,0.214,506,2.449]],["title/40",[87,0.601,216,2.05,292,2.805,473,2.081]],["description/40",[1,0.119,15,0.731,87,1.143,88,2.258,89,2.165,94,1.729,135,1.455,216,3.395,292,3.352,300,1.613,439,2.414,465,0.202,479,0.998,480,1.067,506,2.251,565,3.45]],["title/41",[566,4.016,567,4.567,568,4.567]],["description/41",[0,1.963,1,0.132,15,0.813,87,0.799,88,1.812,94,1.923,156,2.213,216,2.725,326,2.902,465,0.162,566,4.647,567,5.285,568,5.285,569,3.54,570,5.285,571,4.249]],["title/42",[512,2.246,572,4.313]],["description/42",[1,0.149,32,2.061,87,1.158,94,2.166,300,2.021,465,0.235,506,2.82,564,5.953,572,4.786]],["title/43",[87,0.69,226,2.55,573,4.567]],["description/43",[1,0.153,9,2.269,86,2.316,87,0.923,226,3.411,465,0.239,508,4.435,573,6.108,574,6.748]],["title/44",[226,2.55,361,3.316,575,4.567]],["description/44",[1,0.116,47,2.02,83,2.366,85,1.844,86,1.766,87,0.982,123,2.236,179,2.745,226,4.176,244,4.336,361,3.382,446,5.443,465,0.2,561,2.854,575,4.657,576,4.336,577,5.146]],["title/45",[279,3.828,460,3.828,578,4.567]],["description/45",[0,0.77,1,0.052,7,1.199,9,0.77,86,0.786,87,0.313,106,1.738,108,2.073,163,1.93,179,1.222,223,4.244,225,1.667,226,4.443,279,1.738,290,1.93,300,0.704,326,1.138,460,1.738,461,2.602,465,0.064,473,1.085,474,4.377,508,2.523,512,1.878,561,1.27,578,7.326,579,2.29,580,6.458,581,3.839,582,5.798,583,5.798,584,4.955,585,4.955,586,3.839,587,2.29,588,2.29,589,2.29,590,2.29]],["title/46",[78,2.259,87,0.601,217,2.183,459,1.524]],["description/46",[0,1.765,1,0.119,5,2.7,8,3.558,9,1.765,15,0.731,47,2.061,78,2.7,87,0.718,125,3.352,217,2.609,345,4.423,465,0.232,479,0.998,480,1.067,506,2.251,591,3.82,592,4.751,593,3.82]],["title/47",[78,2.595,87,0.69,217,2.508]],["description/47",[0,1.633,1,0.11,9,1.633,15,0.676,32,1.522,47,1.907,78,2.498,87,0.943,180,2.945,181,2.233,183,2.301,217,3.425,465,0.223,469,2.111,479,0.923,480,0.987,506,2.083,591,3.535,593,3.535,594,4.093,595,4.396]],["title/48",[78,2.595,87,0.69,217,2.508]],["description/48",[0,1.73,1,0.116,9,1.73,15,0.717,78,2.647,87,0.982,123,2.236,180,3.119,181,3.299,183,2.438,217,3.566,465,0.2,469,2.236,479,0.978,480,1.045,531,1.293,594,4.336,596,3.488]],["title/49",[78,2.259,87,0.601,217,2.183,292,2.805]],["description/49",[1,0.121,9,1.801,15,0.746,47,2.103,78,2.756,87,0.733,216,2.5,217,3.667,292,3.421,465,0.235,479,1.018,480,1.089,506,2.297,534,2.054,591,3.899,593,3.899,597,4.849]],["title/50",[78,2.595,87,0.69,217,2.508]],["description/50",[0,1.839,1,0.124,15,0.762,47,2.147,78,2.814,87,0.749,180,3.316,217,3.72,465,0.237,479,1.04,480,1.111,506,2.346,591,3.981,593,3.981,594,4.61,595,4.951]],["title/51",[78,2.259,159,2.541,217,2.183,282,3.332]],["description/51",[1,0.112,9,2.347,15,0.689,47,1.943,78,2.546,159,2.864,216,2.31,217,4.021,282,3.755,465,0.225,479,0.941,480,1.006,506,2.122,534,1.898,565,3.253,593,3.602,597,4.48,598,4.171,599,4.95]],["title/52",[78,2.259,217,2.183,282,3.332,569,2.663]],["description/52",[1,0.129,15,0.795,47,2.242,78,2.937,159,3.304,217,2.839,282,4.333,465,0.243,479,1.086,480,1.16,506,2.449,565,3.753,592,5.169,593,4.155,598,4.812]],["title/53",[130,2.852,217,2.946]],["description/53",[1,0.112,15,0.689,32,1.551,47,1.943,83,2.276,87,0.677,88,2.167,130,3.36,211,4.171,217,3.471,227,3.253,300,1.521,465,0.194,468,1.943,479,0.941,480,1.006,482,4.171,484,4.48,531,1.244,596,3.355]],["title/54",[0,1.477,135,1.218,279,3.332,512,1.664]],["description/54",[0,2.553,1,0.126,9,1.879,15,0.778,97,4.709,135,1.549,169,3.672,175,4.448,279,4.24,461,3.788,465,0.211,479,1.062,480,1.135,506,2.396,512,2.118,600,5.588]],["title/55",[7,1.515,87,0.396,92,1.605,493,1.515,601,2.028,602,1.901,603,2.303,604,1.415]],["description/55",[1,0.1,7,3.384,15,0.619,87,0.884,88,1.379,92,3.584,94,1.463,135,1.232,298,3.37,439,2.043,465,0.124,479,0.844,480,0.903,493,3.384,512,1.683,572,3.233,601,4.53,602,5.005,603,3.536,604,2.172,605,4.021,606,3.743,607,3.743]],["title/56",[7,1.396,92,2.414,493,1.396,512,1.01,602,1.752,608,2.122,609,3.464]],["description/56",[1,0.119,7,2.749,15,0.731,87,0.718,92,4.035,94,1.729,96,3.983,298,3.983,439,2.414,465,0.146,479,0.998,480,1.067,493,2.749,512,1.989,602,3.45,608,4.178,609,5.791,610,4.751,611,4.423]],["title/57",[87,0.69,216,2.355,292,3.222]],["description/57",[1,0.124,10,3.034,15,1.042,87,0.749,94,1.802,180,3.316,184,3.835,216,2.553,292,3.493,326,2.719,465,0.208,479,1.04,480,1.111,481,3.493,502,3.981,531,1.375,612,5.47]],["title/58",[613,3.984]],["description/58",[85,2.698,87,1.03,135,2.087,176,3.186,459,2.612,613,4.176]],["title/59",[459,2.056,613,3.288]],["description/59",[1,0.135,15,0.832,86,2.05,123,2.596,227,3.925,375,3.186,459,2.072,465,0.221,479,1.135,480,1.214,508,3.925,613,3.313,614,5.973,615,4.188]],["title/60",[613,3.984]],["description/60",[1,0.126,15,0.778,32,1.751,64,4.709,181,2.569,465,0.24,479,1.062,480,1.135,613,4.784,615,3.918,616,5.058,617,6.044,618,5.058]],["title/61",[510,3.593,613,3.288]],["description/61",[1,0.108,15,0.664,47,1.872,61,2.964,83,2.192,135,2.395,300,2.09,352,2.759,388,4.444,395,2.759,465,0.189,479,0.906,480,0.969,503,2.891,511,3.045,613,2.645,615,3.343,619,3.47]],["title/62",[613,3.984]],["description/62",[1,0.124,15,0.762,64,4.61,88,1.698,465,0.237,474,3.708,479,1.04,480,1.111,613,5.088,615,3.835,616,4.951,617,5.957,618,4.951]],["title/63",[159,3.43,613,3.288]],["description/63",[1,0.153,15,0.94,159,3.905,465,0.239,479,1.283,480,1.371,613,3.743,615,4.731,619,4.91]],["title/64",[569,3.593,613,3.288]],["description/64",[1,0.153,15,0.94,465,0.239,479,1.283,480,1.371,569,4.091,613,3.743,615,4.731,619,4.91]],["title/65",[87,0.69,521,4.016,613,2.799]],["description/65",[1,0.145,15,0.893,87,0.878,465,0.232,474,4.348,479,1.219,480,1.303,521,5.106,613,3.558,615,4.497,619,4.668]],["title/66",[620,3.671,621,3.671,622,3.059]],["description/66",[1,0.135,15,0.832,89,2.463,94,1.967,465,0.166,468,2.345,469,2.596,479,1.135,480,1.214,481,3.814,533,2.969,620,4.346,621,4.346,622,3.621,623,5.033]],["title/67",[119,1.583,533,1.933,620,2.83,621,2.83,622,2.357]],["description/67",[1,0.114,15,0.703,89,2.081,119,2.055,465,0.197,468,1.981,469,2.193,479,0.959,480,1.025,481,3.222,533,3.518,619,3.672,620,3.672,621,3.672,622,4.29,623,4.252,624,5.046,625,6.406,626,5.046]],["title/68",[533,1.933,534,1.491,620,2.83,621,2.83,622,2.357]],["description/68",[1,0.129,15,0.795,89,2.355,465,0.214,468,2.242,469,2.482,479,1.086,480,1.16,481,3.647,533,2.839,534,2.189,619,4.155,620,4.155,621,4.155,622,3.462,623,4.812]],["title/69",[173,1.236]],["description/69",[14,4.136,85,2.778,173,1.334,176,3.281,459,2.69]],["title/70",[173,1.02,459,2.056]],["description/70",[0,2.329,1,0.157,123,3.011,173,1.192,375,3.695,459,2.403,465,0.243,627,6.928]],["title/71",[173,1.236]],["description/71",[0,1.546,1,0.15,86,1.579,87,0.907,89,1.897,148,2.662,173,1.336,179,3.535,181,2.115,183,2.179,377,2.788,465,0.216,468,1.806,469,1.999,496,3.225,531,1.665,549,3.876,628,4.163,629,3.49,630,4.163]],["title/72",[173,1.236]],["description/72",[0,2.46,1,0.166,123,3.18,173,1.259,465,0.252,491,4.144]],["title/73",[135,1.643,173,1.02]],["description/73",[1,0.129,47,2.242,83,2.626,135,2.136,173,1.326,247,3.167,300,2.368,352,3.304,388,3.964,465,0.214,503,3.462,631,3.462]],["title/74",[173,1.02,534,2.272]],["description/74",[1,0.09,9,1.999,15,0.553,78,2.041,87,0.543,117,2.405,119,1.616,120,2.608,147,2.041,156,1.504,173,1.362,183,1.88,224,2.69,313,3.591,465,0.165,469,1.724,534,3.035,541,3.158,631,2.405,632,4.732,633,2.608,634,2.887,635,3.591,636,3.968,637,3.968,638,2.887,639,3.344,640,3.968]],["title/75",[173,1.02,510,3.593]],["description/75",[1,0.116,47,2.02,61,3.199,83,2.366,135,2.477,173,0.885,300,2.205,352,2.978,388,4.597,395,2.978,465,0.2,503,3.119,511,3.286,631,3.119]],["title/76",[173,1.02,486,3.104]],["description/76",[0,2.105,1,0.142,89,2.582,148,3.623,173,1.409,300,1.924,377,3.795,465,0.228,468,2.458,486,3.278,491,3.545]],["title/77",[130,2.852,173,1.02]],["description/77",[1,0.119,47,2.061,83,2.414,87,0.996,94,2.396,130,3.501,148,3.038,173,1.436,300,1.613,465,0.202,468,2.061,493,2.749,531,1.319,630,6.585]],["title/78",[145,3.316,173,0.868,552,3.671]],["description/78",[0,2.329,1,0.157,145,4.553,173,1.504,465,0.193,468,2.719,486,3.628,552,5.041]],["title/79",[173,1.02,512,2.246]],["description/79",[0,2.329,1,0.157,32,2.171,87,1.196,173,1.192,465,0.243,531,1.741]],["title/80",[63,2.508,173,1.02]],["description/80",[0,1.839,1,0.169,32,1.714,63,2.315,88,1.698,89,2.256,173,1.288,181,3.923,183,2.592,330,4.61,465,0.208,468,2.147,469,2.377,491,3.098]],["title/81",[87,0.69,173,0.868,641,3.222]],["description/81",[0,2.553,1,0.126,87,1.18,148,3.233,173,1.306,376,4.448,384,3.918,465,0.211,641,4.849,642,5.588,643,5.588,644,5.058]],["title/82",[87,0.601,173,0.756,641,2.805,645,2.663]],["description/82",[0,2.055,1,0.138,9,2.055,87,0.837,88,1.897,173,1.052,226,3.09,465,0.17,561,3.391,641,3.904,645,4.889,646,6.113,647,5.533]],["title/83",[87,0.601,173,0.756,210,3.975,641,2.805]],["description/83",[0,2.798,1,0.145,87,1.139,173,1.104,329,5.106,384,4.497,465,0.232,641,4.097,644,5.806]],["title/84",[63,2.135,87,0.69,173,0.868]],["description/84",[1,0.126,9,1.879,32,1.751,63,2.364,87,1.18,88,1.734,94,1.841,173,1.484,176,2.364,465,0.211,506,2.396,513,2.732,648,5.588]],["title/85",[63,2.508,173,1.02]],["description/85",[0,2.393,1,0.161,63,3.012,123,3.093,173,1.224,465,0.247,491,4.03]],["title/86",[87,0.69,103,2.799,173,0.868]],["description/86",[1,0.138,63,2.587,87,1.104,94,2.014,103,3.391,173,1.387,247,3.391,465,0.224,534,2.344,649,5.151,650,6.113]],["title/87",[63,2.135,88,1.566,173,0.868]],["description/87",[1,0.142,32,1.962,63,2.649,87,0.857,88,1.943,173,1.409,300,1.924,394,4.983,465,0.228,468,2.458,491,3.545]],["title/88",[173,1.02,651,5.365]],["description/88",[0,2.393,1,0.161,123,3.093,173,1.224,465,0.247,491,4.03,651,6.442]],["title/89",[88,1.363,173,0.756,645,2.663,652,3.196]],["description/89",[0,2.157,1,0.145,9,2.157,88,1.991,173,1.104,465,0.232,561,3.558,631,3.889,645,5.045,652,4.668]],["title/90",[173,1.02,622,3.593]],["description/90",[0,1.92,1,0.129,15,0.795,87,1.055,148,3.304,173,1.5,344,5.169,465,0.214,479,1.086,480,1.16,491,3.234,622,3.462,653,4.155]],["title/91",[119,2.055,173,0.868,622,3.059]],["description/91",[0,2.105,1,0.142,15,0.872,119,2.549,173,1.409,465,0.228,479,1.19,480,1.272,622,3.795,631,3.795,653,4.556]],["title/92",[103,2.799,173,0.868,622,3.059]],["description/92",[0,2.105,1,0.142,15,0.872,103,3.472,173,1.409,465,0.228,479,1.19,480,1.272,622,3.795,631,3.795,654,4.983]],["title/93",[63,1.858,135,1.218,173,0.756,513,2.148]],["description/93",[0,1.801,1,0.121,63,2.267,135,1.485,173,1.452,465,0.205,513,4.127,515,3.756,518,4.515,519,4.849,520,3.521,521,4.264,655,5.358,656,5.358,657,4.849]],["title/94",[63,1.645,135,1.078,173,0.669,513,1.901,658,3.52]],["description/94",[0,1.664,1,0.112,15,0.689,63,2.094,117,3.001,135,1.372,173,1.392,184,3.47,465,0.194,479,0.941,480,1.006,483,4.171,657,4.48,659,4.48,660,4.48,661,4.171,662,4.48,663,6.32,664,4.48,665,4.48]],["title/95",[87,0.69,173,0.868,666,3.222]],["description/95",[1,0.153,63,2.855,87,0.923,94,2.223,173,1.161,309,3.994,465,0.188,499,5.371,666,4.309,667,5.686]],["title/96",[173,1.02,666,3.785]],["description/96",[1,0.135,87,1.087,173,1.366,309,3.536,465,0.248,474,4.049,491,3.382,499,4.754,506,2.561,666,3.814,667,5.033]],["title/97",[87,0.601,173,0.756,226,2.22,645,2.663]],["description/97",[1,0.145,87,0.878,173,1.432,226,3.243,465,0.232,512,2.431,552,4.668,645,3.889,668,5.806,669,6.415]],["title/98",[173,0.756,226,2.22,547,3.196,645,2.663]],["description/98",[1,0.129,15,0.795,39,1.007,173,1.326,226,2.887,465,0.214,479,1.086,480,1.16,512,2.164,547,4.155,552,4.155,553,3.871,645,3.462,668,5.169,670,5.711]],["title/99",[226,2.22,473,2.081,645,2.663,671,3.701]],["description/99",[1,0.153,87,0.923,226,3.411,465,0.239,473,3.197,531,1.696,602,4.435,645,4.091,671,5.686]],["title/100",[13,3.222,173,0.868,672,4.567]],["description/100",[1,0.142,39,1.104,40,2.243,87,0.857,173,1.409,465,0.228,552,4.556,672,7.415,673,4.556,674,6.26]],["title/101",[173,0.868,645,3.059,675,4.016]],["description/101",[0,2.008,1,0.135,15,0.832,86,2.05,88,2.464,173,1.027,327,5.406,465,0.166,471,4.532,479,1.135,480,1.214,486,3.128,645,3.621,676,5.973]],["title/102",[119,2.055,677,4.567,678,2.595]],["description/102",[1,0.126,15,0.778,65,3.918,117,3.388,119,3.092,173,0.961,194,3.038,465,0.211,478,4.24,479,1.062,480,1.135,531,1.404,601,3.918,677,5.058,678,2.874,679,5.058]],["title/103",[63,2.477,173,0.669,476,1.545,680,3.095]],["description/103",[1,0.082,15,0.506,63,2.354,87,1.178,119,2.265,173,0.957,245,3.9,247,3.748,388,1.87,394,2.893,465,0.155,475,2.549,476,2.685,479,0.691,480,0.739,481,2.321,513,1.778,531,0.914,680,2.893,681,2.812,682,4.428,683,5.035,684,3.063,685,3.29,686,3.29,687,3.29]],["title/104",[39,1.267]],["description/104",[14,4.136,39,1.368,85,2.778,176,3.281,459,2.69]],["title/105",[39,1.045,459,2.056]],["description/105",[1,0.129,39,1.538,86,2.645,375,3.046,459,3.026,465,0.243,688,2.839,689,5.711,690,3.167,691,5.711]],["title/106",[39,0.775,137,3.496,309,2.6,459,1.524]],["description/106",[1,0.119,39,0.926,86,1.802,87,0.996,137,4.178,171,4.751,309,3.107,375,2.8,459,1.821,465,0.232,531,1.319,576,4.423,692,7.275,693,5.249,694,3.983,695,4.751,696,4.751]],["title/107",[39,0.775,309,2.6,459,1.524,476,1.745]],["description/107",[1,0.126,32,1.751,39,0.986,87,0.765,88,1.734,94,1.841,180,3.388,309,3.308,375,2.981,459,1.939,465,0.211,476,3.017,512,2.118,697,5.588,698,5.588,699,5.588]],["title/108",[39,0.615,130,1.679,148,2.019,173,0.6,377,2.115,690,1.935]],["description/108",[39,1.386,88,1.213,89,1.612,148,2.262,156,1.481,179,2.085,377,2.369,436,3.293,446,2.965,469,2.554,476,2.335,486,3.078,493,2.047,496,4.121,505,2.844,601,2.74,681,1.976,684,3.293,690,2.168,700,3.908,701,3.908,702,3.908,703,3.908,704,3.908,705,5.877,706,3.908,707,2.496,708,3.908,709,3.908,710,3.908]],["title/109",[39,0.89,130,2.428,476,2.005]],["description/109",[15,0.872,32,1.962,39,1.104,63,2.649,87,0.857,130,3.013,227,4.114,446,4.75,476,2.487,479,1.19,480,1.272,481,3.998,493,3.278]],["title/110",[32,1.581,39,0.89,88,1.566]],["description/110",[1,0.153,32,2.115,39,1.517,88,2.094,173,1.479,465,0.188,491,3.821,688,3.354]],["title/111",[39,1.045,711,5.365]],["description/111",[1,0.145,15,0.893,32,2.01,39,1.131,87,0.878,465,0.232,479,1.219,480,1.303,489,2.907,611,5.405,711,5.806]],["title/112",[39,1.267]],["description/112",[1,0.153,39,1.669,88,2.094,89,2.783,300,2.074,465,0.239,489,3.058]],["title/113",[39,1.045,135,1.643]],["description/113",[1,0.112,32,1.551,39,1.427,86,2.397,135,2.436,388,3.591,395,2.864,465,0.225,469,2.151,688,2.46,690,2.745,712,4.48,713,4.171,714,3.755,715,3.755]],["title/114",[39,1.045,534,2.272]],["description/114",[1,0.1,39,1.635,78,2.285,87,0.608,137,3.536,309,2.63,465,0.233,476,1.765,531,1.116,534,3.206,632,5.143,633,2.92,634,3.233,635,4.021,688,2.208,690,2.464,716,4.442,717,4.442]],["title/115",[39,1.045,510,3.593]],["description/115",[1,0.097,39,1.317,47,1.686,61,2.671,83,1.975,86,2.164,135,2.54,300,1.938,352,2.486,388,4.233,395,2.486,465,0.208,503,2.604,511,2.743,688,2.135,690,2.383,714,3.259,715,3.259]],["title/116",[135,1.399,563,4.251,718,3.828]],["description/116",[1,0.124,15,0.762,39,1.32,135,1.516,154,4.354,163,4.61,169,3.595,173,0.941,465,0.208,479,1.04,480,1.111,553,3.708,563,4.61,631,3.316,688,2.719,690,3.034,718,4.15]],["title/117",[39,0.775,548,3.496,688,2.183,690,2.436]],["description/117",[1,0.124,15,0.762,39,1.505,88,1.698,89,2.256,96,4.15,173,0.941,300,1.681,465,0.208,479,1.04,480,1.111,548,4.354,631,3.316,654,4.354,690,3.034,719,5.47]],["title/118",[39,1.045,720,5.365]],["description/118",[1,0.132,15,0.813,39,1.556,88,1.812,89,2.408,173,1.004,300,1.794,465,0.218,479,1.11,480,1.186,631,3.54,720,5.285,721,4.647]],["title/119",[39,1.045,722,5.365]],["description/119",[1,0.17,39,1.328,465,0.256,489,3.412,722,6.815]],["title/120",[40,1.808,718,3.828,723,4.016]],["description/120",[32,2.504,39,1.41,40,2.864,723,6.361]],["title/121",[39,1.045,688,2.946]],["description/121",[0,1.963,1,0.177,39,1.03,89,2.408,173,1.004,181,3.597,183,2.767,465,0.218,468,2.292,469,2.537,629,4.43,688,2.902,724,4.43]],["title/122",[39,1.045,534,2.272]],["description/122",[1,0.132,15,0.813,39,1.03,89,2.408,173,1.004,181,3.597,183,2.767,387,4.647,468,2.292,469,2.537,479,1.11,480,1.186,534,2.238,629,4.43,721,4.647]],["title/123",[39,1.045,492,3.895]],["description/123",[1,0.126,15,0.778,39,0.986,47,2.193,130,2.689,172,3.672,173,0.961,300,1.717,465,0.211,468,2.193,479,1.062,480,1.135,492,3.672,493,2.926,596,3.788,688,2.778,724,4.24]],["title/124",[39,0.89,130,2.428,492,3.316]],["description/124",[1,0.129,15,0.795,39,1.007,47,2.242,130,2.748,172,3.753,173,0.982,300,1.755,465,0.214,468,2.242,479,1.086,480,1.16,492,3.753,493,2.99,607,4.812,724,4.333]],["title/125",[39,1.045,130,2.852]],["description/125",[1,0.1,9,1.494,15,0.619,39,1.14,47,1.744,63,1.88,83,2.043,85,1.592,87,0.884,130,3.665,147,2.285,173,0.764,300,1.365,321,3.536,465,0.212,468,1.744,493,2.326,496,3.115,553,3.011,688,2.208,724,4.902,725,3.536,726,3.743]],["title/126",[39,0.89,130,2.428,509,4.251]],["description/126",[1,0.094,9,1.398,15,0.857,39,1.086,47,1.632,63,1.76,83,1.912,85,1.49,87,0.842,130,3.527,147,2.139,173,0.715,300,1.278,321,3.31,465,0.204,468,1.632,479,0.79,480,0.845,493,2.177,496,2.915,509,3.504,724,4.67,725,3.31,726,3.504,727,5.572]],["title/127",[39,1.045,486,3.104]],["description/127",[1,0.142,39,1.61,88,1.943,89,2.582,173,1.077,176,2.649,300,1.924,465,0.228,486,3.278,489,2.837]],["title/128",[39,0.775,173,0.756,486,3.356]],["description/128",[1,0.142,39,1.61,89,2.582,173,1.077,176,2.649,300,1.924,465,0.228,486,4.29,489,2.837]],["title/129",[39,1.045,63,2.508]],["description/129",[1,0.161,39,1.568,63,3.012,181,3.272,465,0.247,489,3.225]],["title/130",[39,0.89,87,0.69,641,3.222]],["description/130",[39,1.596,63,3.096,87,1.001,247,4.059,459,2.539,641,4.673]],["title/131",[39,0.89,63,2.135,88,1.566]],["description/131",[1,0.149,32,2.061,39,1.16,63,2.783,87,0.9,88,2.041,300,2.021,465,0.235,468,2.582,489,2.981]],["title/132",[39,1.045,63,2.508]],["description/132",[1,0.166,39,1.596,63,3.096,465,0.252,489,3.316]],["title/133",[39,0.89,87,0.69,103,2.799]],["description/133",[1,0.108,15,0.664,39,1.675,63,2.877,103,2.645,147,2.453,465,0.221,534,2.607,649,4.018,688,3.38,690,3.771,714,3.618,715,3.618,725,3.795,728,4.768]],["title/134",[39,0.89,135,1.399,513,2.467]],["description/134",[1,0.157,39,1.542,135,1.92,465,0.243,512,2.625,513,3.387,729,6.27]],["title/135",[39,0.686,63,1.645,135,1.078,513,1.901,658,3.52]],["description/135",[0,1.664,1,0.112,15,0.689,39,1.427,63,2.094,117,3.001,135,1.372,184,3.47,465,0.194,479,0.941,480,1.006,483,4.171,659,4.48,660,4.48,661,4.171,662,4.48,663,6.32,664,4.48,665,4.48,729,4.48]],["title/136",[39,0.89,135,1.399,571,3.671]],["description/136",[1,0.138,39,1.078,87,0.837,94,2.014,135,2.236,300,1.879,388,3.144,465,0.224,506,2.621,512,2.317,571,4.448,661,5.151]],["title/137",[39,1.045,562,4.994]],["description/137",[1,0.104,5,2.366,15,0.64,39,1.37,87,0.629,92,2.551,94,1.515,135,1.275,180,4.017,440,3.49,465,0.184,473,2.179,506,1.972,562,3.876,570,4.163,571,3.347,633,3.023,730,4.6,731,4.163,732,3.876,733,4.6,734,4.6,735,4.163,736,4.6]],["title/138",[39,0.775,87,0.601,475,3.079,513,2.148]],["description/138",[1,0.112,39,0.873,86,1.699,87,0.956,94,1.63,173,1.201,194,2.691,465,0.225,475,4.895,491,2.803,513,2.42,531,1.244,694,3.755,695,4.48,696,4.48,707,3.161,737,4.95,738,4.95,739,4.95]],["title/139",[39,1.045,87,0.811]],["description/139",[1,0.145,39,1.131,87,1.139,94,2.113,173,1.432,465,0.257,491,3.633,506,2.751]],["title/140",[309,3.509,666,3.785]],["description/140",[1,0.138,39,1.078,87,1.104,94,2.014,309,3.619,465,0.251,489,2.77,498,5.151,666,3.904,667,5.151,740,6.113]],["title/141",[119,2.055,678,2.595,718,3.828]],["description/141",[1,0.126,15,0.778,39,0.986,65,3.918,119,3.092,194,3.038,465,0.211,478,4.24,479,1.062,480,1.135,531,1.404,601,3.918,654,4.448,678,2.874,679,5.058,718,4.24]],["title/142",[39,0.686,63,2.477,476,1.545,680,3.095]],["description/142",[1,0.082,15,0.506,39,0.981,63,2.354,87,1.178,119,2.265,245,3.9,247,3.748,388,1.87,394,2.893,465,0.155,475,2.549,476,2.685,479,0.691,480,0.739,481,2.321,513,1.778,531,0.914,680,2.893,681,2.812,682,4.428,683,5.035,684,3.063,685,3.29,686,3.29,687,3.29]],["title/143",[40,2.573]],["description/143",[14,4.136,40,2.778,85,2.778,176,3.281,459,2.69]],["title/144",[40,2.124,459,2.056]],["description/144",[1,0.124,39,1.32,40,3.287,300,1.681,375,2.918,376,4.354,439,2.515,459,2.96,465,0.208,741,5.47,742,5.47,743,5.47]],["title/145",[40,1.808,459,1.75,744,4.567]],["description/145",[1,0.142,39,1.104,40,2.243,123,2.721,184,4.389,326,3.112,375,3.339,459,2.172,465,0.228,681,3.165,744,5.667,745,6.26]],["title/146",[40,2.573]],["description/146",[1,0.142,39,1.445,40,2.935,173,1.077,237,4.556,465,0.254,489,2.837,688,3.112,746,5.275]],["title/147",[40,2.124,534,2.272]],["description/147",[1,0.124,40,3.287,87,0.749,94,1.802,179,2.918,183,2.592,465,0.208,534,3.271,632,5.957,633,3.595,634,3.981,747,5.47]],["title/148",[40,2.124,135,1.643]],["description/148",[1,0.132,32,1.83,39,1.03,40,2.803,135,2.168,167,4.647,388,4.023,395,3.379,465,0.218,712,5.285,713,4.92,748,5.285]],["title/149",[40,1.808,633,3.316,666,3.222]],["description/149",[1,0.104,15,0.64,39,1.37,40,2.783,87,0.629,173,0.791,439,2.115,465,0.236,479,0.874,480,0.935,489,2.084,506,1.972,576,3.876,633,4.355,666,2.937,681,2.325,688,2.286,727,4.163,746,3.876,749,4.6]],["title/150",[40,2.124,510,3.593]],["description/150",[1,0.116,40,1.844,47,2.02,61,3.199,83,2.366,135,2.477,300,2.205,352,2.978,388,4.597,395,2.978,465,0.2,503,3.119,511,3.286,748,4.657]],["title/151",[438,6.052]],["description/151",[1,0.132,39,1.38,40,3.16,173,1.004,345,4.92,438,4.92,465,0.245,489,2.646,688,2.902,746,4.92,750,5.839]],["title/152",[32,1.581,40,1.808,751,3.828]],["description/152",[1,0.124,39,0.965,40,2.682,87,1.255,88,1.698,89,2.256,173,0.941,181,2.515,300,1.681,465,0.208,470,4.15,531,1.375,751,5.678]],["title/153",[40,1.808,126,2.467,675,4.016]],["description/153",[1,0.138,32,1.916,39,1.078,40,2.89,126,3.944,176,2.587,247,3.391,390,3.706,465,0.224,489,2.77,566,4.866]],["title/154",[39,1.045,40,2.124]],["description/154",[1,0.126,9,2.553,39,1.339,40,2.002,85,2.002,181,2.569,183,2.648,185,3.568,334,4.709,465,0.211,469,3.3,489,2.532,752,4.066,753,5.588]],["title/155",[40,1.574,606,3.701,666,2.805,754,3.975]],["description/155",[1,0.116,15,0.717,39,1.265,40,2.571,87,0.982,94,1.695,465,0.23,479,0.978,480,1.045,481,3.286,489,2.332,506,2.206,666,3.286,681,2.601,754,4.657,755,5.146,756,4.657]],["title/156",[40,1.808,130,2.428,173,0.868]],["description/156",[0,2.211,1,0.149,40,2.357,89,2.712,130,3.165,173,1.131,300,2.021,465,0.235,491,3.724,493,3.444]],["title/157",[39,0.89,40,1.808,723,4.016]],["description/157",[0,2.008,1,0.135,39,1.401,40,3.197,88,1.854,89,2.463,300,1.836,465,0.221,468,2.345,489,2.707,723,4.754]],["title/158",[39,0.89,40,1.808,757,4.567]],["description/158",[0,2.008,1,0.135,39,1.401,40,3.197,88,1.854,89,2.463,300,1.836,465,0.221,468,2.345,489,2.707,757,5.406]],["title/159",[40,1.808,92,2.799,440,3.828]],["description/159",[0,1.963,1,0.132,14,3.115,39,1.03,40,3.16,79,4.094,87,0.799,92,3.239,110,4.647,154,4.647,440,4.43,465,0.218,489,2.646]],["title/160",[126,3.512]],["description/160",[14,4.263,85,2.864,126,3.908,758,3.787]],["title/161",[126,2.898,758,2.808]],["description/161",[1,0.08,15,0.758,22,4.132,40,1.267,47,3.341,83,1.626,126,3.248,147,2.801,180,2.144,183,1.676,224,2.397,237,2.573,352,3.152,377,2.144,386,4.335,465,0.152,469,1.537,518,2.98,566,2.815,596,2.397,725,2.815,758,1.676,759,5.447,760,3.536,761,3.536,762,2.815,763,2.98,764,2.98,765,2.815,766,3.536,767,3.536]],["title/162",[126,3.512]],["description/162",[1,0.153,126,4.204,176,2.855,465,0.239,489,3.058,520,4.435,758,4.074]],["title/163",[768,4.497,769,5.365]],["description/163",[1,0.157,126,3.387,176,2.931,465,0.243,489,3.139,758,3.282,768,5.256,769,6.27]],["title/164",[768,4.497,770,4.994]],["description/164",[1,0.157,126,3.387,176,2.931,465,0.243,489,3.139,758,3.282,768,5.256,770,5.837]],["title/165",[126,2.467,561,2.799,688,2.508]],["description/165",[1,0.138,5,3.144,78,3.144,94,2.014,126,3.944,176,2.587,465,0.224,489,2.77,561,3.391,688,3.039,726,5.151,758,2.897]],["title/166",[126,2.898,771,3.895]],["description/166",[1,0.157,126,3.387,176,2.931,465,0.243,489,3.139,675,5.514,758,3.282,768,5.256]],["title/167",[772,4.354]],["description/167",[85,2.778,87,1.061,185,4.952,772,4.701,773,6.172]],["title/168",[512,2.246,772,3.593]],["description/168",[1,0.149,32,2.061,87,0.9,94,2.166,135,1.823,439,3.024,465,0.235,506,2.82,512,2.492,772,3.987]],["title/169",[512,1.912,772,3.059,773,4.016]],["description/169",[1,0.145,32,2.01,87,0.878,94,2.113,135,1.778,439,2.95,465,0.232,506,2.751,512,2.431,772,3.889,773,5.106]],["title/170",[512,1.912,534,1.934,772,3.059]],["description/170",[1,0.145,32,2.01,87,0.878,94,2.113,135,1.778,439,2.95,465,0.232,506,2.751,512,2.431,534,2.459,772,3.889]],["title/171",[32,1.376,512,1.664,772,2.663,774,3.701]],["description/171",[1,0.135,32,1.872,87,0.817,94,1.967,135,1.656,326,2.969,439,2.746,465,0.221,506,2.561,512,2.263,681,3.019,772,3.621,774,5.033,775,5.973]],["title/172",[87,0.69,194,2.743,772,3.059]],["description/172",[1,0.132,87,1.071,94,1.923,135,1.619,176,2.471,237,4.249,326,2.902,439,2.685,465,0.218,486,3.057,506,2.504,681,2.952,772,3.54,774,4.92]],["title/173",[317,4.156]],["description/173",[85,2.778,87,1.061,135,2.149,176,3.281,776,5.883]],["title/174",[87,0.811,317,3.43]],["description/174",[0,2.46,1,0.166,15,1.019,87,1.001,88,2.271,317,4.234,465,0.204]],["title/175",[87,0.69,135,1.399,317,2.92]],["description/175",[1,0.106,87,0.641,119,3.195,135,1.298,166,3.946,173,0.805,179,2.498,290,3.946,291,4.238,317,4.958,439,2.153,465,0.187,468,1.838,473,2.219,478,3.552,506,2.008,512,2.543,556,3.946,777,4.682,778,4.682]],["title/176",[87,0.69,88,1.566,776,3.828]],["description/176",[0,2.393,1,0.161,15,0.991,32,2.23,87,0.974,88,2.209,465,0.198,776,5.4]],["title/177",[779,3.761]],["description/177",[14,4.136,85,2.778,176,3.281,459,2.69,779,4.06]],["title/178",[459,1.75,604,2.467,779,2.642]],["description/178",[0,2.46,1,0.166,173,1.259,459,2.539,465,0.204,604,3.578,779,3.832]],["title/179",[32,1.581,604,2.467,779,2.642]],["description/179",[0,1.963,1,0.132,9,1.963,15,0.813,123,2.537,147,3.003,181,2.685,183,2.767,465,0.162,469,2.537,472,7.08,596,3.958,604,2.855,771,3.837,779,3.057]],["title/180",[604,2.898,779,3.104]],["description/180",[0,2.531,1,0.17,465,0.21,604,3.682,771,4.948,779,3.943]],["title/181",[534,1.934,604,2.467,779,2.642]],["description/181",[1,0.149,87,0.9,459,2.282,465,0.235,531,1.653,534,2.521,604,3.216,631,3.987,779,4.429]],["title/182",[486,2.642,604,2.467,779,2.642]],["description/182",[0,2.157,1,0.145,9,2.157,15,0.893,465,0.178,479,1.219,480,1.303,486,3.359,596,4.348,604,3.137,771,4.216,779,3.359]],["title/183",[533,2.508,604,2.467,779,2.642]],["description/183",[0,2.531,1,0.17,465,0.21,533,3.743,604,3.682,779,3.943]],["title/184",[130,2.428,604,2.467,779,2.642]],["description/184",[0,1.765,1,0.119,15,0.731,47,2.061,83,2.414,130,3.501,179,2.8,249,4.751,300,1.613,328,4.423,465,0.146,468,2.061,479,0.998,480,1.067,482,4.423,486,2.749,496,3.68,596,3.558,604,2.567,779,2.749]],["title/185",[492,3.316,604,2.467,779,2.642]],["description/185",[0,1.839,1,0.124,15,0.762,32,1.714,179,2.918,300,1.681,328,4.61,446,4.15,465,0.152,479,1.04,480,1.111,486,3.919,496,3.835,596,3.708,604,2.675,779,2.864,780,5.47,781,5.47]],["title/186",[782,4.587]],["description/186",[85,2.698,103,4.176,176,3.186,459,2.612,779,3.943,782,4.808]],["title/187",[459,2.056,782,3.785]],["description/187",[1,0.161,39,1.255,40,2.55,459,2.469,465,0.247,489,3.225,782,4.545]],["title/188",[32,1.581,40,1.808,782,3.222]],["description/188",[1,0.145,32,2.01,39,1.131,40,2.982,87,0.878,170,4.668,465,0.232,489,2.907,681,3.243,782,4.097]],["title/189",[40,1.808,103,2.799,782,3.222]],["description/189",[1,0.149,40,2.357,87,1.158,170,4.786,465,0.235,531,1.653,534,2.521,681,3.325,782,4.2]],["title/190",[40,1.808,782,3.222,783,5.045]],["description/190",[1,0.132,15,0.813,32,1.83,39,1.03,40,2.803,87,0.799,170,4.249,465,0.218,479,1.11,480,1.186,489,2.646,681,2.952,782,3.729,784,5.839]],["title/191",[785,3.57]],["description/191",[85,2.778,135,2.149,176,3.281,459,2.69,785,3.854]],["title/192",[459,1.75,785,2.508,786,3.42]],["description/192",[1,0.157,39,1.542,459,2.403,465,0.193,785,4.346,786,4.696,787,4.424]],["title/193",[32,1.581,785,2.508,786,3.42]],["description/193",[1,0.126,9,1.879,32,1.751,123,2.428,173,1.306,181,2.569,183,2.648,194,4.129,224,3.788,465,0.155,469,2.428,495,4.709,785,2.778,786,3.788,787,4.849]],["title/194",[785,2.946,786,4.018]],["description/194",[1,0.138,39,1.078,88,1.897,123,2.657,173,1.052,194,3.324,465,0.17,673,4.448,681,3.09,785,3.039,786,4.144,787,5.763]],["title/195",[135,1.399,785,2.508,786,3.42]],["description/195",[1,0.135,39,1.053,88,1.854,123,2.596,135,1.656,173,1.027,194,3.248,465,0.166,673,4.346,681,3.019,785,2.969,786,4.049,787,5.697]],["title/196",[459,1.75,785,2.508,788,3.059]],["description/196",[1,0.157,173,1.504,459,2.403,465,0.193,785,4.346,787,4.424,788,4.2]],["title/197",[32,1.581,785,2.508,788,3.059]],["description/197",[1,0.124,9,1.839,32,1.714,39,0.965,123,2.377,173,0.941,181,2.515,183,2.592,194,4.07,224,3.708,465,0.152,469,2.377,495,4.61,785,2.719,787,4.78,788,3.316,789,5.47]],["title/198",[785,2.946,788,3.593]],["description/198",[1,0.138,39,1.078,88,1.897,123,2.657,173,1.052,194,3.324,465,0.17,673,4.448,681,3.09,785,3.039,787,5.763,788,3.706]],["title/199",[534,1.934,785,2.508,788,3.059]],["description/199",[1,0.135,39,1.053,88,1.854,123,2.596,173,1.027,194,3.248,465,0.166,534,2.29,673,4.346,681,3.019,785,2.969,787,5.697,788,3.621]],["title/200",[135,1.399,785,2.508,788,3.059]],["description/200",[1,0.135,39,1.053,88,1.854,123,2.596,135,1.656,173,1.027,194,3.248,465,0.166,673,4.346,681,3.019,785,2.969,787,5.697,788,3.621]],["title/201",[217,2.183,652,3.196,785,2.183,788,2.663]],["description/201",[1,0.142,39,1.104,123,2.721,173,1.077,194,3.404,217,3.112,465,0.174,652,4.556,785,3.112,787,5.831,788,3.795]],["title/202",[790,3.694]],["description/202",[85,2.698,135,2.087,176,3.186,459,2.612,790,3.873,791,6.815]],["title/203",[459,2.056,790,3.049]],["description/203",[1,0.161,173,1.53,459,2.469,465,0.198,790,4.574,792,4.99]],["title/204",[32,1.581,173,0.868,790,2.595]],["description/204",[1,0.153,32,2.694,173,1.161,465,0.188,558,5.371,604,3.3,790,4.422,792,4.731]],["title/205",[32,1.581,492,3.316,790,2.595]],["description/205",[1,0.161,32,2.23,173,1.53,465,0.198,491,4.03,492,4.677,790,3.661]],["title/206",[790,3.694]],["description/206",[1,0.132,15,0.813,88,1.812,89,2.408,173,1.004,465,0.218,468,2.292,479,1.11,480,1.186,790,4.537,792,4.094,793,5.839,794,5.285]],["title/207",[135,1.643,790,3.049]],["description/207",[1,0.135,88,1.854,89,2.463,135,1.656,173,1.027,237,4.346,465,0.221,468,2.345,790,4.891,792,4.188,795,5.406]],["title/208",[534,2.272,790,3.049]],["description/208",[1,0.145,88,1.991,89,2.645,173,1.104,465,0.232,468,2.518,534,2.459,790,4.752,792,4.497]],["title/209",[790,3.049,796,5.365]],["description/209",[1,0.119,15,0.731,88,1.629,89,2.165,173,1.436,287,4.751,326,2.609,465,0.202,468,2.061,479,0.998,480,1.067,790,4.294,792,3.68,794,4.751,796,4.751,797,5.249]],["title/210",[125,3.222,217,2.508,375,2.691]],["description/210",[1,0.138,88,1.897,89,2.521,125,3.904,173,1.052,217,3.039,375,3.261,465,0.224,468,2.4,790,4.642,792,4.286]],["title/211",[790,3.049,798,5.365]],["description/211",[1,0.157,173,1.504,465,0.243,790,4.497,798,6.27,799,6.928]],["title/212",[800,7.182]],["description/212",[85,2.778,148,4.487,176,3.281,771,5.096,801,6.534]],["title/213",[148,2.541,172,2.886,771,2.886,801,3.701]],["description/213",[1,0.11,9,2.316,15,0.676,86,1.667,94,1.6,125,3.102,148,3.987,172,4.528,194,2.641,459,1.685,465,0.192,479,0.923,480,0.987,561,2.694,721,3.866,770,4.093,771,4.528,801,5.805,802,4.857]],["title/214",[123,3.121]],["description/214",[14,3.903,15,1.019,85,2.622,94,2.41,125,4.673,156,2.773,373,5.552]],["title/215",[123,2.193,145,3.316,803,4.567]],["description/215",[1,0.096,15,1.212,53,5.249,94,1.392,119,2.537,145,2.777,156,1.601,167,3.364,329,4.958,336,3.825,465,0.118,468,1.659,479,0.803,480,0.859,721,3.364,764,3.561,804,6.229,805,7.399,806,6.229,807,6.229,808,4.226]],["title/216",[20,3.671,634,3.671,809,4.567]],["description/216",[1,0.138,20,5.868,465,0.224,531,1.536,634,5.868,731,5.533,809,5.533,810,6.113,811,6.113,812,6.113,813,6.113]],["title/217",[226,2.55,361,3.316,814,3.42]],["description/217",[1,0.104,15,0.64,47,2.601,54,3.49,83,3.047,119,1.873,156,3.221,224,3.118,226,3.35,300,1.414,326,2.286,361,3.023,465,0.184,515,3.225,531,1.156,814,5.265,815,4.6,816,4.6,817,3.876]],["title/218",[145,2.886,172,2.886,515,3.079,818,3.975]],["description/218",[1,0.129,5,2.937,9,1.92,15,1.073,47,2.242,172,3.753,361,3.753,465,0.214,474,3.871,479,1.086,480,1.16,531,1.435,553,3.871,818,5.169,819,5.711]],["title/219",[20,3.196,814,2.977,820,3.975,821,3.975]],["description/219",[1,0.102,15,0.911,20,3.289,47,2.568,83,3.008,156,2.914,224,3.064,300,1.389,326,2.247,361,2.97,465,0.182,479,0.859,480,0.918,515,4.587,531,1.136,765,3.597,814,5.213,817,3.808,820,4.091,821,4.091]],["title/220",[156,2.722]],["description/220",[1,0.161,15,0.991,156,2.697,326,3.538,465,0.247,531,1.789,822,4.824]],["title/221",[135,1.643,156,2.246]],["description/221",[1,0.132,9,1.963,15,1.089,85,2.092,119,2.378,147,3.003,156,2.213,185,3.729,375,3.115,465,0.218,531,1.467,765,4.647,823,4.647,824,5.285]],["title/222",[156,2.246,825,5.365]],["description/222",[1,0.149,126,3.216,156,2.492,169,4.322,170,4.786,465,0.235,531,1.653,764,5.542,825,5.953,826,5.235]],["title/223",[10,3.288,156,2.246]],["description/223",[1,0.157,10,3.842,15,0.965,86,2.378,156,2.625,465,0.243,558,5.514,827,6.27]],["title/224",[79,2.726,156,1.474,170,2.83,828,3.52,829,3.52]],["description/224",[1,0.097,15,0.878,79,4.42,119,3.569,156,1.628,220,3.259,247,3.497,388,2.209,465,0.175,479,0.817,480,0.873,531,1.08,541,3.419,654,3.419,822,2.912,828,5.707,829,5.707,830,4.296,831,3.888,832,3.012,833,4.296,834,4.296]],["title/225",[156,2.246,510,3.593]],["description/225",[1,0.126,15,1.057,85,2.002,119,2.275,147,2.874,156,2.118,185,3.568,465,0.211,479,1.062,480,1.135,510,3.388,531,1.404,765,4.448,823,4.448,824,5.058,835,4.448]],["title/226",[126,2.467,758,2.391,836,3.671]],["description/226",[1,0.142,15,0.872,465,0.228,471,4.75,479,1.19,480,1.272,531,1.573,569,3.795,639,5.275,758,2.966,836,4.556,837,5.667]],["title/227",[103,2.799,126,2.467,836,3.671]],["description/227",[1,0.135,15,1.106,103,3.313,126,2.921,159,3.456,465,0.221,471,4.532,479,1.135,480,1.214,531,1.501,639,5.033,836,4.346,837,5.406]],["title/228",[10,3.288,836,4.313]],["description/228",[1,0.135,10,3.313,15,0.832,65,4.188,86,2.05,179,3.186,390,3.621,465,0.248,531,1.501,558,4.754,694,4.532,827,5.406,836,4.346]],["title/229",[572,5.226]],["description/229",[1,0.142,87,0.857,123,2.721,181,3.767,183,2.966,465,0.228,469,2.721,470,4.75,531,1.573,572,4.556,629,4.75]],["title/230",[671,4.994,838,5.365]],["description/230",[1,0.135,5,3.072,15,0.832,440,4.532,465,0.221,531,1.501,649,5.033,838,7.188,839,5.033,840,5.973,841,5.973,842,5.973,843,5.973]],["title/231",[94,2.366]],["description/231",[1,0.145,15,0.893,94,2.113,181,3.827,183,3.04,465,0.232,469,2.788,470,4.867,531,1.612,844,6.415]],["title/232",[94,1.662,309,2.987,641,3.222]],["description/232",[1,0.093,15,0.57,87,0.994,94,3.071,122,7.276,155,4.842,161,5.284,309,5.085,465,0.169,531,1.029,541,4.842,641,2.614,845,6.084,846,4.093]],["title/233",[847,6.501]],["description/233",[1,0.097,9,1.444,15,0.598,31,3.62,85,1.539,123,1.867,169,2.823,176,1.818,179,2.291,183,2.035,220,3.259,365,3.126,375,2.291,465,0.175,468,1.686,469,1.867,471,3.259,479,0.817,480,0.873,486,2.249,531,1.08,625,5.707,647,3.888,847,5.707,848,4.296,849,4.296,850,4.296,851,4.296,852,4.296]],["title/234",[15,0.486,119,1.421,751,2.647,853,2.777,854,2.647,855,2.777]],["description/234",[1,0.116,7,2.694,15,0.999,130,2.476,159,2.978,326,2.558,373,3.904,377,3.119,465,0.2,479,0.978,480,1.045,531,1.293,571,3.744,633,3.382,694,3.904,776,3.904,835,4.096,854,3.904,855,4.096,856,4.657]],["title/235",[15,0.612,160,3.332,853,3.496,857,4.392]],["description/235",[1,0.132,15,1.089,176,2.471,465,0.218,479,1.11,480,1.186,531,1.467,556,4.92,732,4.92,751,4.43,831,5.285,835,4.647,853,4.647,858,5.839]],["title/236",[15,0.486,732,2.94,751,2.647,853,2.777,854,2.647,855,2.777]],["description/236",[1,0.119,7,2.749,15,1.013,130,2.526,373,3.983,377,3.182,465,0.202,479,0.998,480,1.067,531,1.319,571,3.82,598,4.423,633,3.45,694,3.983,776,3.983,835,4.178,854,3.983,855,4.178,856,4.751]],["title/237",[859,4.869]],["description/237",[65,4.731,85,2.418,208,4.574,390,4.091,604,3.3,859,5.828,860,5.371,861,6.748,862,6.748]],["title/238",[533,2.946,859,4.018]],["description/238",[1,0.142,86,2.149,179,3.339,465,0.228,520,4.114,533,4.072,758,3.881,859,5.553,863,5.667]],["title/239",[533,2.508,758,2.391,859,3.42]],["description/239",[1,0.166,465,0.252,531,1.839,533,3.637,758,3.467,859,4.96]],["title/240",[326,2.183,533,2.183,534,1.684,859,2.977]],["description/240",[1,0.126,15,0.778,147,2.874,179,2.981,465,0.211,479,1.062,520,3.672,531,1.404,533,3.775,534,2.142,758,3.598,859,5.147,863,5.058,864,4.709]],["title/241",[295,3.694]],["description/241",[5,3.661,7,3.727,14,3.796,85,2.55,156,2.697,295,3.661,296,4.545,300,2.187]],["title/242",[111,2.743,295,2.595,303,3.537]],["description/242",[1,0.145,5,3.3,7,3.359,10,3.558,13,4.097,295,3.3,296,4.097,300,1.971,303,4.497,465,0.232,865,5.806]],["title/243",[111,3.223,295,3.049]],["description/243",[1,0.116,5,2.647,10,2.854,13,3.286,87,0.704,94,1.695,111,3.901,179,3.827,181,2.366,295,2.647,296,3.286,303,5.03,465,0.23,628,4.657,865,4.657,866,3.904,867,3.904]],["title/244",[111,3.223,295,3.049]],["description/244",[1,0.132,5,3.003,10,3.239,13,3.729,86,2.004,111,3.175,113,3.958,295,3.003,296,3.729,303,4.094,465,0.245,866,4.43,867,4.43,868,4.647]],["title/245",[111,2.743,135,1.399,295,2.595]],["description/245",[1,0.126,10,3.099,13,3.568,86,1.918,111,3.038,113,3.788,135,1.549,295,3.906,296,3.568,465,0.24,468,2.193,795,5.058,866,4.24,867,4.24,868,4.448]],["title/246",[111,2.743,295,2.595,534,1.934]],["description/246",[1,0.132,10,3.239,13,3.729,86,2.004,111,3.175,113,3.958,295,3.003,296,3.729,465,0.245,534,2.238,866,4.43,867,4.43,868,4.647,869,5.839]],["title/247",[111,2.388,295,2.259,542,3.332,652,3.196]],["description/247",[1,0.124,5,2.814,10,4.151,13,3.493,86,1.878,111,2.974,113,3.708,295,2.814,296,3.493,303,3.835,465,0.237,542,4.15,652,3.981,866,4.15,867,4.15,868,4.354]],["title/248",[111,2.743,295,2.595,675,4.016]],["description/248",[0,1.963,1,0.132,5,3.003,10,4.339,13,3.729,295,3.003,296,3.729,303,4.094,390,3.54,465,0.162,502,4.249,542,4.43,688,2.902,713,4.92,870,5.839]],["title/249",[111,2.743,276,4.251,295,2.595]],["description/249",[0,2.008,1,0.135,10,3.313,13,3.814,78,3.072,87,0.817,181,2.746,276,5.033,295,3.072,296,3.814,465,0.221,506,2.561,508,3.925,512,2.263]],["title/250",[462,4.465]],["description/250",[14,4.263,85,2.864,156,3.029,462,4.969]],["title/251",[771,4.72]],["description/251",[1,0.153,15,0.94,86,2.316,156,2.557,462,5.345,465,0.239,771,4.435,871,6.748]],["title/252",[758,2.391,872,4.016,873,3.222]],["description/252",[1,0.129,9,1.92,15,0.795,119,2.325,156,2.164,158,4.545,462,3.55,465,0.214,531,1.435,758,2.706,762,4.545,826,4.545,872,4.545,873,3.647,874,4.812,875,5.711]],["title/253",[103,2.799,872,4.016,873,3.222]],["description/253",[1,0.126,9,1.879,86,1.918,123,2.428,156,2.118,159,3.233,326,2.778,439,2.569,462,5.363,465,0.211,531,1.404,534,2.142,872,4.448,873,4.849]],["title/254",[688,2.508,758,2.391,873,3.222]],["description/254",[1,0.126,9,1.879,15,0.778,119,2.275,156,2.118,158,4.448,462,3.474,465,0.211,531,1.404,688,2.778,758,2.648,762,4.448,826,4.448,873,3.568,874,4.709,876,4.448,877,5.588]],["title/255",[103,2.799,688,2.508,873,3.222]],["description/255",[1,0.126,9,1.879,86,1.918,123,2.428,156,2.118,159,3.233,326,2.778,439,2.569,462,4.721,465,0.211,531,1.404,534,2.142,688,2.778,873,4.849,876,4.448]],["title/256",[477,3.671,690,2.799,758,2.391]],["description/256",[1,0.126,9,1.879,15,0.778,119,2.275,156,2.118,158,4.448,462,3.474,465,0.211,477,4.066,531,1.404,690,3.099,758,2.648,762,4.448,826,4.448,874,4.709,876,4.448,878,5.588]],["title/257",[103,2.799,477,3.671,690,2.799]],["description/257",[1,0.126,9,1.879,86,1.918,123,2.428,156,2.118,159,3.233,326,2.778,439,2.569,462,4.721,465,0.211,477,5.526,531,1.404,534,2.142,690,3.099,876,4.448]],["title/258",[317,3.43,873,3.785]],["description/258",[1,0.149,9,2.211,156,2.492,317,3.806,462,4.089,465,0.235,477,4.786,531,1.653,758,3.116,873,4.2]],["title/259",[461,4.869]],["description/259",[14,4.263,85,2.864,156,3.029,461,5.417]],["title/260",[461,4.018,879,5.927]],["description/260",[1,0.145,5,3.3,15,0.893,87,0.878,156,2.431,169,4.216,228,5.405,465,0.232,527,5.806,531,1.612,880,6.415]],["title/261",[156,1.912,461,3.42,814,3.42]],["description/261",[1,0.142,15,0.872,156,2.372,208,4.244,228,6.903,326,3.112,368,5.275,465,0.228,531,1.573,814,4.244,881,5.667]],["title/262",[476,2.854]],["description/262",[85,2.864,461,5.417,476,3.175,860,6.361]],["title/263",[476,2.854]],["description/263",[9,2.12,15,0.598,32,1.346,39,1.452,86,1.475,173,1.416,184,4.42,465,0.175,476,1.707,479,0.817,480,0.873,617,5.019,707,2.743,822,2.912,882,7.47,883,6.305,884,6.305,885,2.383]],["title/264",[476,2.854]],["description/264",[1,0.142,15,0.872,88,1.943,89,2.582,300,1.924,465,0.228,476,3.255,479,1.19,480,1.272,531,1.573,885,3.472]],["title/265",[476,2.355,510,3.593]],["description/265",[1,0.108,15,0.664,47,1.872,61,2.964,83,2.192,135,2.395,300,2.09,352,2.759,388,4.444,395,2.759,465,0.189,476,1.894,479,0.906,480,0.969,503,2.891,511,3.045,531,1.198,885,2.645]],["title/266",[173,0.868,476,2.005,561,2.799]],["description/266",[1,0.149,15,0.916,173,1.131,465,0.235,476,2.613,479,1.25,480,1.336,561,3.648,631,3.987,885,3.648]],["title/267",[173,0.756,476,1.745,534,1.684,561,2.436]],["description/267",[1,0.145,15,0.893,173,1.104,465,0.232,476,2.549,479,1.219,480,1.303,534,2.459,561,3.558,631,3.889,885,3.558]],["title/268",[39,0.89,476,2.005,561,2.799]],["description/268",[1,0.132,15,0.813,39,1.38,113,3.958,465,0.245,476,2.32,479,1.11,480,1.186,561,3.239,690,3.239,714,4.43,715,4.43,885,3.239]],["title/269",[39,0.775,476,1.745,534,1.684,561,2.436]],["description/269",[1,0.129,15,0.795,39,1.359,113,3.871,465,0.243,476,2.269,479,1.086,480,1.16,534,2.189,561,3.167,690,3.167,714,4.333,715,4.333,885,3.167]],["title/270",[88,1.566,173,0.868,886,3.42]],["description/270",[1,0.142,15,0.872,247,3.472,387,4.983,465,0.228,479,1.19,480,1.272,531,1.573,885,3.472,886,4.244,887,5.667,888,5.667]],["title/271",[39,0.89,88,1.566,886,3.42]],["description/271",[1,0.142,15,0.872,247,3.472,386,4.983,465,0.228,479,1.19,480,1.272,531,1.573,885,3.472,886,4.244,887,5.667,888,5.667]],["title/272",[173,1.02,476,2.355]],["description/272",[1,0.142,15,0.872,32,1.962,173,1.077,465,0.228,476,2.487,479,1.19,480,1.272,531,1.573,707,3.998,822,4.244,885,3.472]],["title/273",[39,1.045,476,2.355]],["description/273",[1,0.142,15,0.872,32,1.962,39,1.104,465,0.228,476,2.487,479,1.19,480,1.272,531,1.573,707,3.998,822,4.244,885,3.472]],["title/274",[173,0.756,510,2.663,707,2.805,886,2.977]],["description/274",[1,0.108,15,0.664,47,1.872,61,2.964,83,2.192,135,2.395,300,2.09,352,2.759,388,4.444,395,2.759,465,0.189,479,0.906,480,0.969,503,2.891,511,3.045,531,1.198,885,2.645,886,3.232]],["title/275",[39,0.775,510,2.663,707,2.805,886,2.977]],["description/275",[1,0.108,15,0.664,47,1.872,61,2.964,83,2.192,135,2.395,300,2.09,352,2.759,388,4.444,395,2.759,465,0.189,479,0.906,480,0.969,503,2.891,511,3.045,531,1.198,885,2.645,886,3.232]],["title/276",[87,0.811,476,2.355]],["description/276",[1,0.138,15,0.851,32,1.916,87,0.837,465,0.224,476,2.429,479,1.162,480,1.242,531,1.536,681,3.09,707,3.904,822,4.144,885,3.391]],["title/277",[39,1.045,476,2.355]],["description/277",[1,0.138,15,0.851,32,1.916,39,1.078,465,0.224,476,2.429,479,1.162,480,1.242,531,1.536,681,3.09,707,3.904,822,4.144,885,3.391]],["title/278",[173,1.02,476,2.355]],["description/278",[1,0.138,15,0.851,32,1.916,173,1.052,465,0.224,476,2.429,479,1.162,480,1.242,531,1.536,681,3.09,707,3.904,822,4.144,885,3.391]],["title/279",[638,5.226]],["description/279",[85,2.698,176,3.186,459,2.612,638,5.479,889,6.344,890,4.948]],["title/280",[459,2.056,890,3.895]],["description/280",[1,0.161,459,2.469,465,0.247,531,1.789,638,5.179,773,5.665,890,4.677]],["title/281",[890,4.72]],["description/281",[1,0.135,32,1.872,181,3.651,183,2.83,459,2.072,465,0.221,469,2.596,470,4.532,520,3.925,531,1.501,629,4.532,638,4.346,890,3.925]],["title/282",[890,4.72]],["description/282",[1,0.161,459,2.469,465,0.247,520,4.677,531,1.789,638,5.179,890,4.677]],["title/283",[889,4.994,890,3.895]],["description/283",[1,0.157,126,3.387,465,0.243,485,6.27,531,1.741,763,5.837,889,5.837,890,4.553]],["title/284",[891,5.717]],["description/284",[14,4.016,21,6.344,85,2.698,156,2.853,854,5.712,891,5.993]],["title/285",[317,3.43,891,4.718]],["description/285",[1,0.135,9,2.008,119,2.432,145,3.925,317,3.456,390,3.621,465,0.221,531,1.501,682,6.321,803,5.406,891,4.754,892,7.942]],["title/286",[893,5.226]],["description/286",[14,4.263,85,2.864,156,3.029,893,5.816]],["title/287",[156,1.912,814,3.42,893,3.671]],["description/287",[1,0.097,15,1.04,47,2.475,83,2.899,156,3.119,208,2.912,224,2.912,300,1.32,326,3.134,368,3.62,465,0.175,479,0.817,480,0.873,515,3.012,531,1.08,591,3.126,814,5.063,817,3.62,881,3.888,893,4.588]],["title/288",[839,4.251,893,3.671,894,4.567]],["description/288",[1,0.116,15,0.717,85,1.844,174,4.657,375,2.745,465,0.2,479,0.978,480,1.045,531,1.293,534,1.973,591,3.744,763,4.336,893,5.221,894,7.477,895,5.146,896,5.146,897,3.046,898,5.146]],["title/289",[899,7.182]],["description/289",[85,2.698,119,3.066,176,3.186,365,5.479,560,5.993,900,6.344]],["title/290",[128,3.701,365,3.196,560,3.496,900,3.701]],["description/290",[1,0.108,15,0.947,86,1.637,128,4.018,160,3.618,176,2.018,180,2.891,216,2.225,326,2.37,365,5.767,377,2.891,465,0.189,473,2.259,479,0.906,480,0.969,560,3.795,682,3.795,735,4.316,839,5.73,900,4.018,901,4.768]],["title/291",[897,4.252]],["description/291",[15,1.197,85,2.418,214,6.108,860,5.371,897,5.089,902,6.748,903,6.748,904,6.748]],["title/292",[897,4.252]],["description/292",[1,0.132,9,1.963,15,0.813,85,2.092,147,3.003,181,2.685,183,2.767,185,3.729,465,0.218,469,2.537,479,1.11,752,4.249,897,3.456,905,4.43,906,4.43]],["title/293",[375,2.691,459,1.75,897,2.987]],["description/293",[1,0.149,15,0.916,147,3.383,375,3.508,459,2.282,465,0.235,479,1.25,897,3.893,905,4.99,906,4.99]],["title/294",[897,4.252]],["description/294",[1,0.149,15,0.916,147,3.383,176,2.783,237,4.786,465,0.235,479,1.25,897,3.893,905,4.99,906,4.99]],["title/295",[897,3.509,907,5.365]],["description/295",[1,0.153,15,0.94,147,3.471,465,0.239,479,1.283,897,3.994,905,5.12,906,5.12,907,6.108]],["title/296",[377,3.059,681,2.55,897,2.987]],["description/296",[1,0.126,9,1.879,15,0.778,85,2.002,147,2.874,181,2.569,183,2.648,185,3.568,377,3.388,465,0.211,469,2.428,479,1.062,681,2.825,752,4.066,897,3.308,905,4.24,906,4.24]],["title/297",[908,3.694]],["description/297",[85,2.778,617,6.172,758,3.674,860,6.172,908,3.988]],["title/298",[758,2.808,908,3.049]],["description/298",[1,0.116,15,0.717,119,2.095,120,3.382,126,2.516,245,3.608,465,0.2,479,0.978,480,1.045,531,1.293,565,3.382,569,3.119,758,3.4,832,3.608,908,4.249,909,5.146,910,4.657,911,4.657]],["title/299",[908,3.694]],["description/299",[1,0.124,15,0.762,32,2.345,119,2.228,120,3.595,465,0.208,473,2.592,479,1.04,480,1.111,523,4.951,531,1.375,565,3.595,569,3.316,832,3.835,908,3.85,912,5.47]],["title/300",[172,3.316,908,2.595,913,3.828]],["description/300",[1,0.124,15,0.762,119,2.228,120,3.595,126,2.675,172,3.595,465,0.208,479,1.04,480,1.111,481,3.493,531,1.375,569,3.316,832,3.835,908,3.85,910,4.951,911,4.951,914,5.47]],["title/301",[103,3.288,908,3.049]],["description/301",[1,0.119,15,1.013,88,1.629,103,2.912,119,2.138,120,3.45,126,2.567,300,1.613,465,0.202,479,0.998,480,1.067,531,1.319,534,2.012,565,3.45,569,3.182,832,3.68,908,4.294]],["title/302",[569,3.593,908,3.049]],["description/302",[1,0.129,15,0.795,119,2.325,120,3.753,465,0.214,479,1.086,480,1.16,520,3.753,531,1.435,565,3.753,569,4.672,758,2.706,832,4.004,908,3.964]],["title/303",[159,3.43,908,3.049]],["description/303",[1,0.129,15,0.795,119,2.325,120,3.753,159,3.304,465,0.214,479,1.086,480,1.16,520,3.753,531,1.435,565,3.753,569,4.672,832,4.004,908,3.964]],["title/304",[359,5.365,908,3.049]],["description/304",[1,0.135,6,4.754,15,1.106,32,1.872,86,2.05,111,3.248,465,0.221,473,2.83,479,1.135,480,1.214,565,3.925,908,3.072,913,4.532]],["title/305",[908,2.595,913,3.828,915,4.016]],["description/305",[1,0.142,15,1.141,32,1.962,465,0.228,479,1.19,480,1.272,531,1.573,553,4.244,908,3.22,913,4.75,915,4.983]],["title/306",[176,2.135,908,2.595,915,4.016]],["description/306",[1,0.116,15,1.15,176,2.177,365,3.744,465,0.2,479,0.978,480,1.045,531,1.293,553,3.488,756,4.657,908,4.249,913,3.904,915,4.096,916,5.146,917,5.146,918,5.146,919,5.146]],["title/307",[513,3.512]],["description/307",[85,2.778,135,2.149,176,3.281,459,2.69,513,3.792]],["title/308",[513,3.512]],["description/308",[1,0.138,15,0.851,86,2.099,88,1.897,216,2.853,300,1.879,465,0.224,473,2.897,479,1.162,480,1.242,513,3.944,653,4.448]],["title/309",[513,3.512]],["description/309",[1,0.138,15,0.851,86,2.099,216,2.853,300,1.879,465,0.224,473,2.897,479,1.162,480,1.242,486,3.201,513,3.944,653,4.448]],["title/310",[510,3.593,513,2.898]],["description/310",[1,0.106,15,0.652,47,1.838,61,2.911,83,2.153,86,1.607,135,2.375,300,2.063,352,2.71,388,4.407,395,2.71,465,0.187,479,0.89,480,0.951,503,2.839,511,2.99,513,2.29,531,1.177,653,3.407]],["title/311",[32,1.581,486,2.642,513,2.467]],["description/311",[1,0.142,15,0.872,32,1.962,86,2.149,216,2.922,465,0.228,473,2.966,479,1.19,480,1.272,486,3.278,513,3.061,653,4.556]],["title/312",[678,3.694]],["description/312",[85,2.698,135,2.087,176,3.186,459,2.612,534,2.887,678,3.873]],["title/313",[678,3.694]],["description/313",[1,0.132,9,1.963,15,0.813,85,2.092,117,3.54,181,2.685,183,2.767,185,3.729,465,0.218,469,2.537,479,1.11,480,1.186,531,1.467,678,3.003,752,4.249]],["title/314",[459,2.056,678,3.049]],["description/314",[1,0.149,15,0.916,117,3.987,375,3.508,459,2.282,465,0.235,479,1.25,480,1.336,531,1.653,678,3.383]],["title/315",[678,3.694]],["description/315",[1,0.145,15,0.893,88,1.991,117,3.889,300,1.971,465,0.232,479,1.219,480,1.303,531,1.612,678,4.281]],["title/316",[534,2.272,678,3.049]],["description/316",[1,0.135,15,0.832,117,3.621,465,0.221,479,1.135,480,1.214,531,1.501,534,3.045,632,4.754,633,3.925,634,4.346,678,4.085]],["title/317",[510,3.593,678,3.049]],["description/317",[1,0.106,15,0.652,47,1.838,61,2.911,83,2.153,86,1.607,117,2.839,135,2.375,300,2.063,352,2.71,388,4.407,395,2.71,465,0.187,479,0.89,480,0.951,503,2.839,511,2.99,531,1.177,678,2.408]],["title/318",[9,1.477,173,0.756,181,2.019,678,2.259]],["description/318",[1,0.112,9,2.347,15,0.689,85,1.773,86,1.699,88,1.536,117,3.001,173,0.851,181,2.276,183,2.345,185,3.161,300,1.521,465,0.194,469,2.151,479,0.941,480,1.006,531,1.244,678,4.161,752,3.602,920,4.95]],["title/319",[9,1.477,39,0.775,181,2.019,678,2.259]],["description/319",[1,0.112,9,2.347,15,0.689,39,0.873,85,1.773,86,1.699,88,1.536,117,3.001,181,2.276,183,2.345,185,3.161,300,1.521,465,0.194,469,2.151,479,0.941,480,1.006,531,1.244,678,4.161,752,3.602,921,4.95]],["title/320",[922,7.182]],["description/320",[9,2.607,14,4.136,85,2.778,92,4.301,110,6.172]],["title/321",[148,3.43,923,4.718]],["description/321",[9,1.765,14,3.881,15,0.731,65,3.68,88,1.629,92,2.912,147,2.7,148,3.038,208,3.558,300,1.613,390,3.182,479,0.998,790,2.7,791,4.751,864,4.423,923,5.791,924,5.249,925,5.249,926,4.751]],["title/322",[823,4.718,923,4.718]],["description/322",[5,3.003,9,1.963,10,3.239,14,3.115,15,0.813,65,4.094,85,2.092,147,3.003,208,3.958,390,3.54,479,1.11,823,4.647,864,4.92,923,6.226,926,5.285]],["title/323",[7,3.104,493,3.104]],["description/323",[7,3.943,85,2.698,135,2.087,176,3.186,493,3.943,604,3.682]],["title/324",[7,1.515,87,0.396,92,1.605,493,1.515,601,2.028,602,1.901,603,2.303,604,1.415]],["description/324",[1,0.1,7,3.384,15,0.619,87,0.884,88,1.379,92,3.584,94,1.463,135,1.232,298,3.37,439,2.043,465,0.124,479,0.844,480,0.903,493,3.384,512,1.683,572,3.233,601,4.53,602,5.005,603,3.536,604,2.172,605,4.021,606,3.743,607,3.743]],["title/325",[7,1.396,92,2.414,493,1.396,512,1.01,602,1.752,608,2.122,609,3.464]],["description/325",[1,0.119,7,2.749,15,0.731,87,0.718,92,4.035,94,1.729,96,3.983,298,3.983,439,2.414,465,0.146,479,0.998,480,1.067,493,2.749,512,1.989,602,3.45,608,4.178,609,5.791,610,4.751,611,4.423]]],"invertedIndex":[["",{"_index":1,"title":{},"description":{"0":{},"1":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"57":{},"59":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"105":{},"106":{},"107":{},"110":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"121":{},"122":{},"123":{},"124":{},"125":{},"126":{},"127":{},"128":{},"129":{},"131":{},"132":{},"133":{},"134":{},"135":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"144":{},"145":{},"146":{},"147":{},"148":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{},"155":{},"156":{},"157":{},"158":{},"159":{},"161":{},"162":{},"163":{},"164":{},"165":{},"166":{},"168":{},"169":{},"170":{},"171":{},"172":{},"174":{},"175":{},"176":{},"178":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"187":{},"188":{},"189":{},"190":{},"192":{},"193":{},"194":{},"195":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{},"203":{},"204":{},"205":{},"206":{},"207":{},"208":{},"209":{},"210":{},"211":{},"213":{},"215":{},"216":{},"217":{},"218":{},"219":{},"220":{},"221":{},"222":{},"223":{},"224":{},"225":{},"226":{},"227":{},"228":{},"229":{},"230":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"238":{},"239":{},"240":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"249":{},"251":{},"252":{},"253":{},"254":{},"255":{},"256":{},"257":{},"258":{},"260":{},"261":{},"264":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"271":{},"272":{},"273":{},"274":{},"275":{},"276":{},"277":{},"278":{},"280":{},"281":{},"282":{},"283":{},"285":{},"287":{},"288":{},"290":{},"292":{},"293":{},"294":{},"295":{},"296":{},"298":{},"299":{},"300":{},"301":{},"302":{},"303":{},"304":{},"305":{},"306":{},"308":{},"309":{},"310":{},"311":{},"313":{},"314":{},"315":{},"316":{},"317":{},"318":{},"319":{},"324":{},"325":{}}}],["0",{"_index":316,"title":{},"description":{"6":{},"7":{},"8":{}}}],["1",{"_index":118,"title":{},"description":{"3":{},"5":{},"7":{},"8":{}}}],["10",{"_index":258,"title":{},"description":{"5":{},"7":{}}}],["100",{"_index":781,"title":{},"description":{"185":{}}}],["11",{"_index":267,"title":{},"description":{"5":{}}}],["11:20:28",{"_index":341,"title":{},"description":{"7":{}}}],["13:21:14",{"_index":270,"title":{},"description":{"5":{}}}],["1441983590",{"_index":324,"title":{},"description":{"7":{}}}],["16",{"_index":99,"title":{},"description":{"3":{}}}],["2",{"_index":129,"title":{},"description":{"3":{},"8":{}}}],["2.0",{"_index":296,"title":{},"description":{"5":{},"241":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"249":{}}}],["2.0](https://tools.ietf.org/html/rfc6749",{"_index":299,"title":{},"description":{"5":{}}}],["200",{"_index":249,"title":{},"description":{"5":{},"184":{}}}],["2015",{"_index":269,"title":{},"description":{"5":{},"7":{}}}],["2018",{"_index":100,"title":{},"description":{"3":{}}}],["3",{"_index":150,"title":{},"description":{"3":{}}}],["3.10",{"_index":721,"title":{},"description":{"118":{},"122":{},"213":{},"215":{}}}],["3.6.0.1451.1c38da627ebb4e3635677db6939e9195",{"_index":380,"title":{},"description":{"8":{}}}],["4",{"_index":153,"title":{},"description":{"3":{}}}],["4.0",{"_index":471,"title":{},"description":{"11":{},"101":{},"226":{},"227":{},"233":{}}}],["4.1",{"_index":591,"title":{},"description":{"46":{},"47":{},"49":{},"50":{},"287":{},"288":{}}}],["4.10",{"_index":654,"title":{},"description":{"92":{},"117":{},"141":{},"224":{}}}],["4.1__",{"_index":905,"title":{},"description":{"292":{},"293":{},"294":{},"295":{},"296":{}}}],["4.3",{"_index":735,"title":{},"description":{"137":{},"290":{}}}],["4.4",{"_index":565,"title":{},"description":{"40":{},"51":{},"52":{},"298":{},"299":{},"301":{},"302":{},"303":{},"304":{}}}],["4.5",{"_index":528,"title":{},"description":{"23":{}}}],["4.6",{"_index":97,"title":{},"description":{"3":{},"23":{},"54":{}}}],["4.7",{"_index":596,"title":{},"description":{"48":{},"53":{},"123":{},"161":{},"179":{},"182":{},"184":{},"185":{}}}],["4.8",{"_index":765,"title":{},"description":{"161":{},"219":{},"221":{},"225":{}}}],["4.9",{"_index":653,"title":{},"description":{"90":{},"91":{},"308":{},"309":{},"310":{},"311":{}}}],["404",{"_index":863,"title":{},"description":{"238":{},"240":{}}}],["429",{"_index":338,"title":{},"description":{"7":{}}}],["5",{"_index":162,"title":{},"description":{"3":{}}}],["5.0",{"_index":117,"title":{},"description":{"3":{},"74":{},"94":{},"102":{},"135":{},"313":{},"314":{},"315":{},"316":{},"317":{},"318":{},"319":{}}}],["5.10",{"_index":615,"title":{},"description":{"59":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{}}}],["5.11",{"_index":885,"title":{},"description":{"263":{},"264":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"271":{},"272":{},"273":{},"274":{},"275":{},"276":{},"277":{},"278":{}}}],["5.14",{"_index":481,"title":{},"description":{"13":{},"57":{},"66":{},"67":{},"68":{},"103":{},"109":{},"142":{},"155":{},"300":{}}}],["5.16",{"_index":553,"title":{},"description":{"32":{},"33":{},"98":{},"116":{},"125":{},"218":{},"305":{},"306":{}}}],["5.18",{"_index":727,"title":{},"description":{"126":{},"149":{}}}],["5.20",{"_index":835,"title":{},"description":{"225":{},"234":{},"235":{},"236":{}}}],["5.22",{"_index":794,"title":{},"description":{"206":{},"209":{}}}],["5.3",{"_index":728,"title":{},"description":{"133":{}}}],["5.4",{"_index":607,"title":{},"description":{"55":{},"124":{},"324":{}}}],["5.5",{"_index":535,"title":{},"description":{"26":{},"27":{}}}],["5.6",{"_index":611,"title":{},"description":{"56":{},"111":{},"325":{}}}],["5.6__",{"_index":864,"title":{},"description":{"240":{},"321":{},"322":{}}}],["5.8",{"_index":784,"title":{},"description":{"190":{}}}],["6.0",{"_index":719,"title":{},"description":{"117":{}}}],["657",{"_index":273,"title":{},"description":{"5":{}}}],["9",{"_index":260,"title":{},"description":{"5":{},"7":{}}}],["9xuqwrwgstrb3mzrxb83nb357a",{"_index":293,"title":{},"description":{"5":{}}}],["__minimum",{"_index":479,"title":{},"description":{"13":{},"26":{},"27":{},"32":{},"33":{},"40":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"57":{},"59":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"90":{},"91":{},"92":{},"94":{},"98":{},"101":{},"102":{},"103":{},"109":{},"111":{},"116":{},"117":{},"118":{},"122":{},"123":{},"124":{},"126":{},"135":{},"141":{},"142":{},"149":{},"155":{},"182":{},"184":{},"185":{},"190":{},"206":{},"209":{},"213":{},"215":{},"218":{},"219":{},"224":{},"225":{},"226":{},"227":{},"233":{},"234":{},"235":{},"236":{},"240":{},"263":{},"264":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"271":{},"272":{},"273":{},"274":{},"275":{},"276":{},"277":{},"278":{},"287":{},"288":{},"290":{},"292":{},"293":{},"294":{},"295":{},"296":{},"298":{},"299":{},"300":{},"301":{},"302":{},"303":{},"304":{},"305":{},"306":{},"308":{},"309":{},"310":{},"311":{},"313":{},"314":{},"315":{},"316":{},"317":{},"318":{},"319":{},"321":{},"322":{},"324":{},"325":{}}}],["__respons",{"_index":733,"title":{},"description":{"137":{}}}],["__sinc",{"_index":524,"title":{},"description":{"23":{}}}],["abil",{"_index":297,"title":{},"description":{"5":{}}}],["abov",{"_index":392,"title":{},"description":{"8":{}}}],["accept",{"_index":602,"title":{"55":{},"56":{},"324":{},"325":{}},"description":{"55":{},"56":{},"99":{},"324":{},"325":{}}}],["access",{"_index":78,"title":{"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{}},"description":{"2":{},"5":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"74":{},"114":{},"165":{},"249":{}}}],["account",{"_index":508,"title":{"20":{}},"description":{"23":{},"29":{},"34":{},"36":{},"43":{},"45":{},"59":{},"249":{}}}],["acknowledg",{"_index":67,"title":{},"description":{"1":{}}}],["act",{"_index":298,"title":{},"description":{"5":{},"55":{},"56":{},"324":{},"325":{}}}],["action",{"_index":92,"title":{"55":{},"56":{},"159":{},"324":{},"325":{}},"description":{"2":{},"8":{},"9":{},"55":{},"56":{},"137":{},"159":{},"320":{},"321":{},"324":{},"325":{}}}],["activ",{"_index":473,"title":{"23":{},"40":{},"99":{}},"description":{"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"18":{},"23":{},"28":{},"30":{},"34":{},"37":{},"45":{},"99":{},"137":{},"175":{},"290":{},"299":{},"304":{},"308":{},"309":{},"311":{}}}],["actual",{"_index":594,"title":{},"description":{"47":{},"48":{},"50":{}}}],["ad",{"_index":643,"title":{},"description":{"81":{}}}],["ad/ldap",{"_index":228,"title":{},"description":{"5":{},"260":{},"261":{}}}],["add",{"_index":641,"title":{"81":{},"82":{},"83":{},"130":{},"232":{}},"description":{"81":{},"82":{},"83":{},"130":{},"232":{}}}],["add_user_to_team",{"_index":644,"title":{},"description":{"81":{},"83":{}}}],["added_to_team",{"_index":396,"title":{},"description":{"8":{}}}],["addit",{"_index":344,"title":{},"description":{"8":{},"90":{}}}],["addition",{"_index":587,"title":{},"description":{"45":{}}}],["address",{"_index":52,"title":{},"description":{"1":{}}}],["admin",{"_index":184,"title":{},"description":{"3":{},"5":{},"57":{},"94":{},"135":{},"145":{},"263":{}}}],["again",{"_index":778,"title":{},"description":{"175":{}}}],["against",{"_index":211,"title":{},"description":{"5":{},"15":{},"53":{}}}],["alert",{"_index":372,"title":{},"description":{"8":{}}}],["allow",{"_index":154,"title":{},"description":{"3":{},"23":{},"116":{},"159":{}}}],["along",{"_index":307,"title":{},"description":{"6":{}}}],["alreadi",{"_index":146,"title":{},"description":{"3":{},"8":{}}}],["alway",{"_index":851,"title":{},"description":{"233":{}}}],["analyt",{"_index":847,"title":{"233":{}},"description":{"233":{}}}],["and/or",{"_index":490,"title":{},"description":{"15":{}}}],["anoth",{"_index":376,"title":{},"description":{"8":{},"37":{},"81":{},"144":{}}}],["answer",{"_index":51,"title":{},"description":{"1":{}}}],["api",{"_index":8,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{},"7":{},"8":{},"46":{}}}],["api/v3",{"_index":132,"title":{},"description":{"3":{}}}],["api/v4/websocket",{"_index":355,"title":{},"description":{"8":{}}}],["apiv3",{"_index":95,"title":{"3":{}},"description":{}}],["apiv4",{"_index":189,"title":{},"description":{"3":{}}}],["app",{"_index":111,"title":{"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"249":{}},"description":{"3":{},"4":{},"5":{},"243":{},"244":{},"245":{},"246":{},"247":{},"304":{}}}],["append",{"_index":697,"title":{},"description":{"107":{}}}],["applic",{"_index":13,"title":{"100":{}},"description":{"1":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"249":{}}}],["application'",{"_index":870,"title":{},"description":{"248":{}}}],["application/json",{"_index":84,"title":{},"description":{"2":{},"5":{}}}],["appropri",{"_index":306,"title":{},"description":{"6":{}}}],["archiv",{"_index":509,"title":{"126":{}},"description":{"20":{},"126":{}}}],["around",{"_index":754,"title":{"155":{}},"description":{"155":{}}}],["array",{"_index":394,"title":{},"description":{"8":{},"87":{},"103":{},"142":{}}}],["ask",{"_index":37,"title":{},"description":{"1":{},"3":{}}}],["assign",{"_index":521,"title":{"65":{}},"description":{"22":{},"65":{},"93":{}}}],["associ",{"_index":707,"title":{"274":{},"275":{}},"description":{"108":{},"138":{},"263":{},"272":{},"273":{},"276":{},"277":{},"278":{}}}],["assum",{"_index":212,"title":{},"description":{"5":{}}}],["attach",{"_index":566,"title":{"41":{}},"description":{"41":{},"153":{},"161":{}}}],["attribut",{"_index":880,"title":{},"description":{"260":{}}}],["audit",{"_index":572,"title":{"42":{},"229":{}},"description":{"42":{},"55":{},"229":{},"324":{}}}],["auth_data",{"_index":463,"title":{},"description":{"10":{}}}],["auth_servic",{"_index":464,"title":{},"description":{"10":{}}}],["authent",{"_index":0,"title":{"0":{},"5":{},"54":{}},"description":{"5":{},"8":{},"10":{},"17":{},"30":{},"31":{},"34":{},"41":{},"45":{},"46":{},"47":{},"48":{},"50":{},"54":{},"70":{},"71":{},"72":{},"76":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"85":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"101":{},"121":{},"135":{},"156":{},"157":{},"158":{},"159":{},"174":{},"176":{},"178":{},"179":{},"180":{},"182":{},"183":{},"184":{},"185":{},"248":{},"249":{}}}],["authentication_challeng",{"_index":364,"title":{},"description":{"8":{}}}],["author",{"_index":276,"title":{"249":{}},"description":{"5":{},"249":{}}}],["autocomplet",{"_index":492,"title":{"16":{},"123":{},"124":{},"185":{},"205":{}},"description":{"16":{},"123":{},"124":{},"205":{}}}],["automat",{"_index":556,"title":{},"description":{"33":{},"175":{},"235":{}}}],["avail",{"_index":21,"title":{},"description":{"1":{},"11":{},"284":{}}}],["aw",{"_index":820,"title":{"219":{}},"description":{"219":{}}}],["ay5sq51sebfh58ktrce5ijtcwi",{"_index":385,"title":{},"description":{"8":{}}}],["back",{"_index":163,"title":{},"description":{"3":{},"45":{},"116":{}}}],["background",{"_index":903,"title":{},"description":{"291":{}}}],["backslash",{"_index":242,"title":{},"description":{"5":{}}}],["base",{"_index":468,"title":{},"description":{"11":{},"12":{},"14":{},"15":{},"16":{},"24":{},"25":{},"26":{},"27":{},"37":{},"53":{},"66":{},"67":{},"68":{},"71":{},"76":{},"77":{},"78":{},"80":{},"87":{},"121":{},"122":{},"123":{},"124":{},"125":{},"126":{},"131":{},"157":{},"158":{},"175":{},"184":{},"206":{},"207":{},"208":{},"209":{},"210":{},"215":{},"233":{},"245":{}}}],["base64",{"_index":543,"title":{},"description":{"31":{}}}],["basic",{"_index":432,"title":{},"description":{"8":{},"11":{}}}],["be",{"_index":439,"title":{},"description":{"8":{},"11":{},"19":{},"20":{},"21":{},"25":{},"26":{},"30":{},"35":{},"38":{},"39":{},"40":{},"55":{},"56":{},"144":{},"149":{},"168":{},"169":{},"170":{},"171":{},"172":{},"175":{},"253":{},"255":{},"257":{},"324":{},"325":{}}}],["bearer",{"_index":278,"title":{},"description":{"5":{}}}],["befor",{"_index":334,"title":{},"description":{"7":{},"23":{},"154":{}}}],["begun",{"_index":437,"title":{},"description":{"8":{}}}],["behaviour",{"_index":752,"title":{},"description":{"154":{},"292":{},"296":{},"313":{},"318":{},"319":{}}}],["below",{"_index":167,"title":{},"description":{"3":{},"5":{},"148":{},"215":{}}}],["between",{"_index":171,"title":{},"description":{"3":{},"106":{}}}],["blank",{"_index":713,"title":{},"description":{"113":{},"148":{},"248":{}}}],["bodi",{"_index":83,"title":{},"description":{"2":{},"5":{},"6":{},"7":{},"15":{},"19":{},"21":{},"44":{},"53":{},"61":{},"73":{},"75":{},"77":{},"115":{},"125":{},"126":{},"150":{},"161":{},"184":{},"217":{},"219":{},"265":{},"274":{},"275":{},"287":{},"310":{},"317":{}}}],["boolean",{"_index":684,"title":{},"description":{"103":{},"108":{},"142":{}}}],["bot",{"_index":613,"title":{"58":{},"59":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{}},"description":{"58":{},"59":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{}}}],["bot'",{"_index":620,"title":{"66":{},"67":{},"68":{}},"description":{"66":{},"67":{},"68":{}}}],["bot_user_id",{"_index":623,"title":{},"description":{"66":{},"67":{},"68":{}}}],["both",{"_index":518,"title":{},"description":{"22":{},"93":{},"161":{}}}],["brand",{"_index":859,"title":{"237":{},"238":{},"239":{},"240":{}},"description":{"237":{},"238":{},"239":{},"240":{}}}],["break",{"_index":114,"title":{},"description":{"3":{}}}],["broadcast",{"_index":381,"title":{},"description":{"8":{}}}],["browser",{"_index":358,"title":{},"description":{"8":{}}}],["bug",{"_index":43,"title":{},"description":{"1":{}}}],["build",{"_index":187,"title":{},"description":{"3":{}}}],["built",{"_index":201,"title":{},"description":{"4":{}}}],["bulk",{"_index":783,"title":{"190":{}},"description":{}}],["busi",{"_index":853,"title":{"234":{},"235":{},"236":{}},"description":{"235":{}}}],["cach",{"_index":838,"title":{"230":{}},"description":{"230":{}}}],["call",{"_index":895,"title":{},"description":{"288":{}}}],["cancel",{"_index":907,"title":{"295":{}},"description":{"295":{}}}],["case",{"_index":451,"title":{},"description":{"8":{}}}],["categori",{"_index":774,"title":{"171":{}},"description":{"171":{},"172":{}}}],["certif",{"_index":873,"title":{"252":{},"253":{},"254":{},"255":{},"258":{}},"description":{"252":{},"253":{},"254":{},"255":{},"258":{}}}],["challeng",{"_index":357,"title":{},"description":{"8":{}}}],["chang",{"_index":169,"title":{},"description":{"3":{},"5":{},"8":{},"35":{},"54":{},"116":{},"222":{},"233":{},"260":{}}}],["changes](https://github.com/mattermost/mattermost-api-reference/commit/1ae3314f0935eebba8c885d8969dcad72f801501",{"_index":59,"title":{},"description":{"1":{}}}],["changes](https://github.com/mattermost/mattermost-api-reference/commit/d574c0c1e95dc2228dc96663afd562f1305e3ec",{"_index":57,"title":{},"description":{"1":{}}}],["channel",{"_index":39,"title":{"13":{},"104":{},"105":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"112":{},"113":{},"114":{},"115":{},"117":{},"118":{},"119":{},"121":{},"122":{},"123":{},"124":{},"125":{},"126":{},"127":{},"128":{},"129":{},"130":{},"131":{},"132":{},"133":{},"134":{},"135":{},"136":{},"137":{},"138":{},"139":{},"142":{},"154":{},"157":{},"158":{},"268":{},"269":{},"271":{},"273":{},"275":{},"277":{},"319":{}},"description":{"1":{},"3":{},"8":{},"11":{},"13":{},"15":{},"16":{},"32":{},"33":{},"98":{},"100":{},"104":{},"105":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"120":{},"121":{},"122":{},"123":{},"124":{},"125":{},"126":{},"127":{},"128":{},"129":{},"130":{},"131":{},"132":{},"133":{},"134":{},"135":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"144":{},"145":{},"146":{},"148":{},"149":{},"151":{},"152":{},"153":{},"154":{},"155":{},"157":{},"158":{},"159":{},"187":{},"188":{},"190":{},"192":{},"194":{},"195":{},"197":{},"198":{},"199":{},"200":{},"201":{},"263":{},"268":{},"269":{},"273":{},"277":{},"319":{}}}],["channel'",{"_index":718,"title":{"116":{},"120":{},"141":{}},"description":{"116":{},"141":{}}}],["channel-scop",{"_index":921,"title":{},"description":{"319":{}}}],["channel](https://pre-release.mattermost.com/core/channels/apiv4",{"_index":190,"title":{},"description":{"3":{}}}],["channel_admin",{"_index":739,"title":{},"description":{"138":{}}}],["channel_convert",{"_index":397,"title":{},"description":{"8":{}}}],["channel_cr",{"_index":398,"title":{},"description":{"8":{}}}],["channel_delet",{"_index":399,"title":{},"description":{"8":{}}}],["channel_id",{"_index":386,"title":{},"description":{"8":{},"16":{},"161":{},"271":{}}}],["channel_member_upd",{"_index":400,"title":{},"description":{"8":{}}}],["channel_upd",{"_index":401,"title":{},"description":{"8":{}}}],["channel_us",{"_index":738,"title":{},"description":{"138":{}}}],["channel_view",{"_index":402,"title":{},"description":{"8":{}}}],["charset=utf-8",{"_index":275,"title":{},"description":{"5":{}}}],["check",{"_index":145,"title":{"34":{},"78":{},"215":{},"218":{}},"description":{"3":{},"34":{},"78":{},"215":{},"285":{}}}],["clear",{"_index":732,"title":{"236":{}},"description":{"137":{},"235":{}}}],["client",{"_index":10,"title":{"223":{},"228":{}},"description":{"1":{},"8":{},"57":{},"223":{},"228":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"249":{},"322":{}}}],["client_id",{"_index":760,"title":{},"description":{"161":{}}}],["close",{"_index":810,"title":{},"description":{"216":{}}}],["cluster",{"_index":891,"title":{"284":{},"285":{}},"description":{"284":{},"285":{}}}],["code",{"_index":74,"title":{},"description":{"1":{},"6":{},"29":{},"30":{},"31":{},"34":{},"36":{}}}],["collect",{"_index":177,"title":{},"description":{"3":{}}}],["combin",{"_index":494,"title":{},"description":{"16":{}}}],["come",{"_index":445,"title":{},"description":{"8":{}}}],["command",{"_index":790,"title":{"202":{},"203":{},"204":{},"205":{},"206":{},"207":{},"208":{},"209":{},"211":{}},"description":{"202":{},"203":{},"204":{},"205":{},"206":{},"207":{},"208":{},"209":{},"210":{},"211":{},"321":{}}}],["comment",{"_index":741,"title":{},"description":{"144":{}}}],["committ",{"_index":24,"title":{},"description":{"1":{}}}],["commun",{"_index":26,"title":{},"description":{"1":{}}}],["community-built",{"_index":198,"title":{},"description":{"4":{}}}],["complet",{"_index":581,"title":{},"description":{"45":{}}}],["complianc",{"_index":638,"title":{"279":{}},"description":{"74":{},"279":{},"280":{},"281":{},"282":{}}}],["compress",{"_index":910,"title":{},"description":{"298":{},"300":{}}}],["config",{"_index":832,"title":{},"description":{"224":{},"298":{},"299":{},"300":{},"301":{},"302":{},"303":{}}}],["config.json",{"_index":158,"title":{},"description":{"3":{},"252":{},"254":{},"256":{}}}],["config_chang",{"_index":403,"title":{},"description":{"8":{}}}],["configur",{"_index":156,"title":{"220":{},"221":{},"222":{},"223":{},"224":{},"225":{},"261":{},"287":{}},"description":{"3":{},"5":{},"10":{},"15":{},"35":{},"41":{},"74":{},"108":{},"214":{},"215":{},"217":{},"219":{},"220":{},"221":{},"222":{},"223":{},"224":{},"225":{},"241":{},"250":{},"251":{},"252":{},"253":{},"254":{},"255":{},"256":{},"257":{},"258":{},"259":{},"260":{},"261":{},"284":{},"286":{},"287":{}}}],["confirm",{"_index":152,"title":{},"description":{"3":{}}}],["connect",{"_index":20,"title":{"216":{},"219":{}},"description":{"1":{},"8":{},"216":{},"219":{}}}],["consid",{"_index":53,"title":{},"description":{"1":{},"3":{},"215":{}}}],["consol",{"_index":124,"title":{},"description":{"3":{}}}],["contact",{"_index":881,"title":{},"description":{"261":{},"287":{}}}],["contain",{"_index":245,"title":{},"description":{"5":{},"8":{},"13":{},"36":{},"103":{},"142":{},"298":{}}}],["content",{"_index":763,"title":{},"description":{"161":{},"283":{},"288":{}}}],["content-length",{"_index":272,"title":{},"description":{"5":{}}}],["content-typ",{"_index":274,"title":{},"description":{"5":{}}}],["contribut",{"_index":50,"title":{},"description":{"1":{}}}],["control",{"_index":467,"title":{},"description":{"10":{}}}],["convert",{"_index":548,"title":{"117":{}},"description":{"32":{},"33":{},"117":{}}}],["cooki",{"_index":356,"title":{},"description":{"8":{}}}],["core",{"_index":23,"title":{},"description":{"1":{}}}],["correctli",{"_index":816,"title":{},"description":{"217":{}}}],["correspond",{"_index":831,"title":{},"description":{"224":{},"235":{}}}],["count",{"_index":499,"title":{"17":{}},"description":{"17":{},"95":{},"96":{}}}],["counterpart",{"_index":138,"title":{},"description":{"3":{}}}],["creat",{"_index":459,"title":{"10":{},"46":{},"59":{},"70":{},"105":{},"106":{},"107":{},"144":{},"145":{},"178":{},"187":{},"192":{},"196":{},"203":{},"280":{},"293":{},"314":{}},"description":{"9":{},"10":{},"58":{},"59":{},"69":{},"70":{},"104":{},"105":{},"106":{},"107":{},"130":{},"143":{},"144":{},"145":{},"177":{},"178":{},"181":{},"186":{},"187":{},"191":{},"192":{},"196":{},"202":{},"203":{},"213":{},"279":{},"280":{},"281":{},"282":{},"293":{},"307":{},"312":{},"314":{}}}],["create_bot",{"_index":614,"title":{},"description":{"59":{}}}],["create_direct_channel",{"_index":693,"title":{},"description":{"106":{}}}],["create_group_channel",{"_index":699,"title":{},"description":{"107":{}}}],["create_post",{"_index":743,"title":{},"description":{"144":{}}}],["create_post_ephemer",{"_index":745,"title":{},"description":{"145":{}}}],["create_private_channel",{"_index":691,"title":{},"description":{"105":{}}}],["create_public_channel",{"_index":689,"title":{},"description":{"105":{}}}],["create_team",{"_index":627,"title":{},"description":{"70":{}}}],["create_user_access_token",{"_index":592,"title":{},"description":{"46":{},"52":{}}}],["creation",{"_index":466,"title":{},"description":{"10":{}}}],["creator",{"_index":867,"title":{},"description":{"243":{},"244":{},"245":{},"246":{},"247":{}}}],["criteria",{"_index":482,"title":{},"description":{"15":{},"53":{},"184":{}}}],["curl",{"_index":231,"title":{},"description":{"5":{}}}],["current",{"_index":326,"title":{"240":{}},"description":{"7":{},"11":{},"35":{},"37":{},"41":{},"45":{},"57":{},"145":{},"171":{},"172":{},"209":{},"217":{},"219":{},"220":{},"234":{},"253":{},"255":{},"257":{},"261":{},"287":{},"290":{}}}],["current_servic",{"_index":582,"title":{},"description":{"45":{}}}],["custom",{"_index":604,"title":{"55":{},"178":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"324":{}},"description":{"55":{},"178":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"204":{},"237":{},"323":{},"324":{}}}],["cutoff",{"_index":901,"title":{},"description":{"290":{}}}],["d",{"_index":232,"title":{},"description":{"5":{}}}],["daili",{"_index":186,"title":{},"description":{"3":{}}}],["data",{"_index":365,"title":{"290":{}},"description":{"8":{},"233":{},"289":{},"290":{},"306":{}}}],["databas",{"_index":634,"title":{"216":{}},"description":{"74":{},"114":{},"147":{},"216":{},"316":{}}}],["dataretent",{"_index":899,"title":{"289":{}},"description":{}}],["date",{"_index":265,"title":{},"description":{"5":{},"7":{}}}],["deactiv",{"_index":507,"title":{"20":{}},"description":{"20":{},"23":{}}}],["debug",{"_index":122,"title":{},"description":{"3":{},"232":{}}}],["declin",{"_index":603,"title":{"55":{},"324":{}},"description":{"55":{},"324":{}}}],["default",{"_index":505,"title":{"27":{}},"description":{"19":{},"26":{},"27":{},"33":{},"108":{}}}],["defin",{"_index":352,"title":{},"description":{"8":{},"19":{},"21":{},"61":{},"73":{},"75":{},"115":{},"150":{},"161":{},"265":{},"274":{},"275":{},"310":{},"317":{}}}],["definit",{"_index":793,"title":{},"description":{"206":{}}}],["delet",{"_index":534,"title":{"26":{},"68":{},"74":{},"114":{},"122":{},"147":{},"170":{},"181":{},"199":{},"208":{},"240":{},"246":{},"267":{},"269":{},"316":{}},"description":{"26":{},"49":{},"51":{},"68":{},"74":{},"86":{},"114":{},"122":{},"133":{},"147":{},"170":{},"181":{},"189":{},"199":{},"208":{},"240":{},"246":{},"253":{},"255":{},"257":{},"267":{},"269":{},"288":{},"301":{},"312":{},"316":{}}}],["delete_others_post",{"_index":747,"title":{},"description":{"147":{}}}],["delete_private_channel",{"_index":717,"title":{},"description":{"114":{}}}],["delete_public_channel",{"_index":716,"title":{},"description":{"114":{}}}],["delete_team",{"_index":404,"title":{},"description":{"8":{}}}],["deliv",{"_index":374,"title":{},"description":{"8":{}}}],["deliveri",{"_index":348,"title":{},"description":{"8":{}}}],["demot",{"_index":546,"title":{"32":{}},"description":{}}],["demote_to_guest",{"_index":554,"title":{},"description":{"32":{}}}],["depend",{"_index":229,"title":{},"description":{"5":{}}}],["deprec",{"_index":96,"title":{"3":{}},"description":{"3":{},"56":{},"117":{},"325":{}}}],["descript",{"_index":327,"title":{},"description":{"7":{},"101":{}}}],["destin",{"_index":797,"title":{},"description":{"209":{}}}],["detail",{"_index":128,"title":{"290":{}},"description":{"3":{},"290":{}}}],["develop",{"_index":38,"title":{},"description":{"1":{},"5":{}}}],["devic",{"_index":568,"title":{"41":{}},"description":{"41":{}}}],["dialog",{"_index":923,"title":{"321":{},"322":{}},"description":{"321":{},"322":{}}}],["dialog_open",{"_index":431,"title":{},"description":{"8":{}}}],["differ",{"_index":287,"title":{},"description":{"5":{},"209":{}}}],["direct",{"_index":137,"title":{"106":{}},"description":{"3":{},"106":{},"114":{}}}],["direct_ad",{"_index":405,"title":{},"description":{"8":{}}}],["directory](https://about.mattermost.com/community-applications/#privateapp",{"_index":209,"title":{},"description":{"4":{}}}],["disabl",{"_index":159,"title":{"51":{},"63":{},"303":{}},"description":{"3":{},"30":{},"51":{},"52":{},"63":{},"227":{},"234":{},"253":{},"255":{},"257":{},"303":{}}}],["discuss",{"_index":41,"title":{},"description":{"1":{}}}],["display",{"_index":700,"title":{},"description":{"108":{}}}],["display_nam",{"_index":676,"title":{},"description":{"101":{}}}],["distinguish",{"_index":444,"title":{},"description":{"8":{}}}],["document",{"_index":28,"title":{},"description":{"1":{},"5":{}}}],["documentation](https://docs.mattermost.com/administration/branding.html",{"_index":862,"title":{},"description":{"237":{}}}],["documentation](https://docs.mattermost.com/integrations/zapier.html#register-zapier-as-an-oauth-2-0-appl",{"_index":305,"title":{},"description":{"5":{}}}],["done",{"_index":484,"title":{},"description":{"15":{},"53":{}}}],["doubl",{"_index":239,"title":{},"description":{"5":{}}}],["down",{"_index":165,"title":{},"description":{"3":{},"8":{}}}],["download",{"_index":889,"title":{"283":{}},"description":{"279":{},"283":{}}}],["driver",{"_index":18,"title":{"4":{}},"description":{"1":{},"4":{}}}],["driver](https://github.com/gnello/php-mattermost-driv",{"_index":200,"title":{},"description":{"4":{}}}],["driver](https://github.com/mattermost/mattermost-redux/blob/master/src/client/client4.t",{"_index":196,"title":{},"description":{"4":{}}}],["driver](https://github.com/mattermost/mattermost-redux/blob/master/src/client/websocket_client.j",{"_index":458,"title":{},"description":{"8":{}}}],["driver](https://github.com/mattermost/mattermost-server/blob/master/model/client4.go",{"_index":197,"title":{},"description":{"4":{}}}],["driver](https://github.com/mattermost/mattermost-server/blob/master/model/websocket_client.go",{"_index":457,"title":{},"description":{"8":{}}}],["driver](https://github.com/vaelor/python-mattermost-driv",{"_index":205,"title":{},"description":{"4":{}}}],["duti",{"_index":441,"title":{},"description":{"8":{}}}],["each",{"_index":682,"title":{},"description":{"103":{},"142":{},"285":{},"290":{}}}],["easiest",{"_index":191,"title":{},"description":{"4":{}}}],["easili",{"_index":66,"title":{},"description":{"1":{},"3":{}}}],["edit_other_us",{"_index":506,"title":{},"description":{"19":{},"20":{},"21":{},"25":{},"26":{},"30":{},"31":{},"38":{},"39":{},"40":{},"42":{},"46":{},"47":{},"49":{},"50":{},"51":{},"52":{},"54":{},"84":{},"96":{},"136":{},"137":{},"139":{},"149":{},"155":{},"168":{},"169":{},"170":{},"171":{},"172":{},"175":{},"249":{}}}],["edit_other_usr",{"_index":740,"title":{},"description":{"140":{}}}],["edit_post",{"_index":748,"title":{},"description":{"148":{},"150":{}}}],["effect",{"_index":649,"title":{},"description":{"86":{},"133":{},"230":{}}}],["elasticsearch",{"_index":893,"title":{"286":{},"287":{},"288":{}},"description":{"286":{},"287":{},"288":{}}}],["email",{"_index":226,"title":{"36":{},"37":{},"43":{},"44":{},"97":{},"98":{},"99":{},"217":{}},"description":{"5":{},"10":{},"15":{},"36":{},"37":{},"43":{},"44":{},"45":{},"82":{},"97":{},"98":{},"99":{},"217":{}}}],["emoji",{"_index":779,"title":{"177":{},"178":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{}},"description":{"177":{},"178":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"186":{}}}],["emoji_ad",{"_index":406,"title":{},"description":{"8":{}}}],["enabl",{"_index":569,"title":{"52":{},"64":{},"302":{}},"description":{"41":{},"64":{},"226":{},"298":{},"299":{},"300":{},"301":{},"302":{},"303":{}}}],["enableapiv3",{"_index":157,"title":{},"description":{"3":{}}}],["encapsul",{"_index":450,"title":{},"description":{"8":{}}}],["encod",{"_index":544,"title":{},"description":{"31":{}}}],["encrypt",{"_index":876,"title":{},"description":{"254":{},"255":{},"256":{},"257":{}}}],["end",{"_index":698,"title":{},"description":{"107":{}}}],["endpoint",{"_index":85,"title":{},"description":{"2":{},"3":{},"8":{},"9":{},"23":{},"44":{},"58":{},"69":{},"104":{},"125":{},"126":{},"143":{},"154":{},"160":{},"167":{},"173":{},"177":{},"186":{},"191":{},"202":{},"212":{},"214":{},"221":{},"225":{},"233":{},"237":{},"241":{},"250":{},"259":{},"262":{},"279":{},"284":{},"286":{},"288":{},"289":{},"291":{},"292":{},"296":{},"297":{},"307":{},"312":{},"313":{},"318":{},"319":{},"320":{},"322":{},"323":{}}}],["endpoint.__",{"_index":529,"title":{},"description":{"23":{}}}],["enterpris",{"_index":837,"title":{},"description":{"226":{},"227":{}}}],["environ",{"_index":828,"title":{"224":{}},"description":{"224":{}}}],["ephemer",{"_index":744,"title":{"145":{}},"description":{"145":{}}}],["ephemeral_messag",{"_index":407,"title":{},"description":{"8":{}}}],["epoch",{"_index":333,"title":{},"description":{"7":{}}}],["error",{"_index":161,"title":{"6":{}},"description":{"3":{},"6":{},"7":{},"8":{},"232":{}}}],["escap",{"_index":240,"title":{},"description":{"5":{}}}],["etc",{"_index":144,"title":{},"description":{"3":{}}}],["even",{"_index":577,"title":{},"description":{"44":{}}}],["event",{"_index":347,"title":{},"description":{"8":{}}}],["everyone'",{"_index":68,"title":{},"description":{"1":{}}}],["ex",{"_index":701,"title":{},"description":{"108":{}}}],["exampl",{"_index":175,"title":{},"description":{"3":{},"5":{},"8":{},"54":{}}}],["exce",{"_index":336,"title":{},"description":{"7":{},"215":{}}}],["exceed",{"_index":342,"title":{},"description":{"7":{}}}],["except",{"_index":590,"title":{},"description":{"45":{}}}],["exclud",{"_index":705,"title":{},"description":{"108":{}}}],["exclude_default_channel",{"_index":706,"title":{},"description":{"108":{}}}],["execut",{"_index":798,"title":{"211":{}},"description":{"211":{}}}],["exist",{"_index":552,"title":{"78":{}},"description":{"32":{},"78":{},"97":{},"98":{},"100":{}}}],["expir",{"_index":288,"title":{},"description":{"5":{}}}],["expiri",{"_index":857,"title":{"235":{}},"description":{}}],["fail",{"_index":452,"title":{},"description":{"8":{}}}],["fals",{"_index":155,"title":{},"description":{"3":{},"6":{},"30":{},"232":{}}}],["featur",{"_index":639,"title":{},"description":{"74":{},"226":{},"227":{}}}],["fetch",{"_index":608,"title":{"56":{},"325":{}},"description":{"56":{},"325":{}}}],["field",{"_index":388,"title":{},"description":{"8":{},"10":{},"19":{},"21":{},"61":{},"73":{},"75":{},"103":{},"113":{},"115":{},"136":{},"142":{},"148":{},"150":{},"224":{},"265":{},"274":{},"275":{},"310":{},"317":{}}}],["file",{"_index":126,"title":{"153":{},"160":{},"161":{},"162":{},"165":{},"166":{},"226":{},"227":{}},"description":{"3":{},"153":{},"160":{},"161":{},"162":{},"163":{},"164":{},"165":{},"166":{},"222":{},"227":{},"283":{},"298":{},"300":{},"301":{}}}],["file'",{"_index":768,"title":{"163":{},"164":{}},"description":{"163":{},"164":{},"166":{}}}],["filenam",{"_index":762,"title":{},"description":{"161":{},"252":{},"254":{},"256":{}}}],["filter",{"_index":495,"title":{},"description":{"16":{},"193":{},"197":{}}}],["first",{"_index":360,"title":{},"description":{"8":{}}}],["fix",{"_index":48,"title":{},"description":{"1":{}}}],["flag",{"_index":751,"title":{"152":{},"234":{},"236":{}},"description":{"152":{},"235":{}}}],["follow",{"_index":106,"title":{},"description":{"3":{},"6":{},"7":{},"8":{},"45":{}}}],["for](/#tag/driv",{"_index":19,"title":{},"description":{"1":{}}}],["form",{"_index":378,"title":{},"description":{"8":{}}}],["format",{"_index":625,"title":{},"description":{"67":{},"233":{}}}],["formdata",{"_index":761,"title":{},"description":{"161":{}}}],["forum](http://forum.mattermost.org/c/dev",{"_index":42,"title":{},"description":{"1":{}}}],["found",{"_index":301,"title":{},"description":{"5":{}}}],["fri",{"_index":266,"title":{},"description":{"5":{}}}],["full",{"_index":485,"title":{},"description":{"15":{},"283":{}}}],["function",{"_index":349,"title":{},"description":{"8":{}}}],["further",{"_index":497,"title":{},"description":{"16":{}}}],["futur",{"_index":277,"title":{},"description":{"5":{}}}],["gener",{"_index":125,"title":{"27":{},"31":{},"210":{}},"description":{"3":{},"27":{},"31":{},"46":{},"210":{},"213":{},"214":{}}}],["get",{"_index":176,"title":{"306":{}},"description":{"3":{},"9":{},"58":{},"69":{},"84":{},"104":{},"127":{},"128":{},"143":{},"153":{},"162":{},"163":{},"164":{},"165":{},"166":{},"172":{},"173":{},"177":{},"186":{},"191":{},"202":{},"212":{},"233":{},"235":{},"279":{},"289":{},"290":{},"294":{},"306":{},"307":{},"312":{},"323":{}}}],["get_status",{"_index":455,"title":{},"description":{"8":{}}}],["get_statuses_by_id",{"_index":456,"title":{},"description":{"8":{}}}],["github",{"_index":142,"title":{},"description":{"3":{}}}],["gitlab",{"_index":143,"title":{},"description":{"3":{}}}],["given",{"_index":681,"title":{"296":{}},"description":{"103":{},"108":{},"142":{},"145":{},"149":{},"155":{},"171":{},"172":{},"188":{},"189":{},"190":{},"194":{},"195":{},"198":{},"199":{},"200":{},"276":{},"277":{},"278":{},"296":{}}}],["gmt",{"_index":271,"title":{},"description":{"5":{},"7":{}}}],["gnello](https://github.com/gnello",{"_index":202,"title":{},"description":{"4":{}}}],["golang",{"_index":17,"title":{},"description":{"1":{},"4":{},"8":{}}}],["goroutin",{"_index":806,"title":{},"description":{"215":{}}}],["goroutinehealththreshold",{"_index":805,"title":{},"description":{"215":{}}}],["graph",{"_index":801,"title":{"213":{}},"description":{"212":{},"213":{}}}],["group",{"_index":476,"title":{"13":{},"103":{},"107":{},"109":{},"142":{},"262":{},"263":{},"264":{},"265":{},"266":{},"267":{},"268":{},"269":{},"272":{},"273":{},"276":{},"277":{},"278":{}},"description":{"13":{},"103":{},"107":{},"108":{},"109":{},"114":{},"142":{},"262":{},"263":{},"264":{},"265":{},"266":{},"267":{},"268":{},"269":{},"272":{},"273":{},"276":{},"277":{},"278":{}}}],["group_ad",{"_index":408,"title":{},"description":{"8":{}}}],["group_id",{"_index":887,"title":{},"description":{"270":{},"271":{}}}],["groupchannel",{"_index":709,"title":{},"description":{"108":{}}}],["groupsync",{"_index":886,"title":{"270":{},"271":{},"274":{},"275":{}},"description":{"270":{},"271":{},"274":{},"275":{}}}],["guest",{"_index":547,"title":{"32":{},"33":{},"98":{}},"description":{"32":{},"33":{},"98":{}}}],["guid",{"_index":564,"title":{},"description":{"38":{},"42":{}}}],["h",{"_index":280,"title":{},"description":{"5":{}}}],["handshak",{"_index":351,"title":{},"description":{"8":{}}}],["hard",{"_index":637,"title":{},"description":{"74":{}}}],["hard-cod",{"_index":874,"title":{},"description":{"252":{},"254":{},"256":{}}}],["hash/data",{"_index":646,"title":{},"description":{"82":{}}}],["have",{"_index":694,"title":{},"description":{"106":{},"138":{},"228":{},"234":{},"236":{}}}],["haven't",{"_index":833,"title":{},"description":{"224":{}}}],["header",{"_index":246,"title":{},"description":{"5":{},"7":{}}}],["health",{"_index":803,"title":{"215":{}},"description":{"285":{}}}],["healthi",{"_index":804,"title":{},"description":{"215":{}}}],["hello",{"_index":370,"title":{},"description":{"8":{}}}],["help",{"_index":60,"title":{},"description":{"1":{},"3":{}}}],["here",{"_index":454,"title":{},"description":{"8":{}}}],["here.](https://docs.mattermost.com/developer/oauth-2-0-applications.html",{"_index":302,"title":{},"description":{"5":{}}}],["high",{"_index":854,"title":{"234":{},"236":{}},"description":{"234":{},"236":{},"284":{}}}],["higher",{"_index":766,"title":{},"description":{"161":{}}}],["himself",{"_index":749,"title":{},"description":{"149":{}}}],["hit",{"_index":131,"title":{},"description":{"3":{}}}],["homepag",{"_index":141,"title":{},"description":{"3":{}}}],["hook",{"_index":673,"title":{},"description":{"100":{},"194":{},"195":{},"198":{},"199":{},"200":{}}}],["host",{"_index":75,"title":{},"description":{"1":{}}}],["http",{"_index":218,"title":{},"description":{"5":{},"6":{},"7":{},"8":{}}}],["http(",{"_index":80,"title":{},"description":{"2":{}}}],["http/1.1",{"_index":248,"title":{},"description":{"5":{},"7":{}}}],["http://localhost:8065",{"_index":215,"title":{},"description":{"5":{}}}],["http://localhost:8065/api/v4/users/login",{"_index":234,"title":{},"description":{"5":{}}}],["http://localhost:8065/api/v4/users/m",{"_index":281,"title":{},"description":{"5":{}}}],["httponli",{"_index":255,"title":{},"description":{"5":{}}}],["https://docs.mattermost.com/developer/interactive-dialogs.html",{"_index":926,"title":{},"description":{"321":{},"322":{}}}],["https://github.com/mattermost/mattermost-api-refer",{"_index":76,"title":{},"description":{"1":{}}}],["hyr5dmb1mbb49c44qmx4whniso",{"_index":256,"title":{},"description":{"5":{}}}],["i.",{"_index":737,"title":{},"description":{"138":{}}}],["icon",{"_index":622,"title":{"66":{},"67":{},"68":{},"90":{},"91":{},"92":{}},"description":{"66":{},"67":{},"68":{},"90":{},"91":{},"92":{}}}],["id",{"_index":88,"title":{"12":{},"13":{},"87":{},"89":{},"110":{},"131":{},"176":{},"270":{},"271":{}},"description":{"2":{},"3":{},"5":{},"6":{},"8":{},"9":{},"12":{},"13":{},"34":{},"39":{},"40":{},"41":{},"53":{},"55":{},"62":{},"80":{},"82":{},"84":{},"87":{},"89":{},"101":{},"107":{},"108":{},"110":{},"112":{},"117":{},"118":{},"127":{},"131":{},"152":{},"157":{},"158":{},"174":{},"176":{},"194":{},"195":{},"198":{},"199":{},"200":{},"206":{},"207":{},"208":{},"209":{},"210":{},"264":{},"301":{},"308":{},"315":{},"318":{},"319":{},"321":{},"324":{}}}],["idp",{"_index":872,"title":{"252":{},"253":{}},"description":{"252":{},"253":{}}}],["idpcertificatefil",{"_index":875,"title":{},"description":{"252":{}}}],["ignor",{"_index":503,"title":{},"description":{"19":{},"21":{},"61":{},"73":{},"75":{},"115":{},"150":{},"265":{},"274":{},"275":{},"310":{},"317":{}}}],["imag",{"_index":533,"title":{"24":{},"25":{},"26":{},"27":{},"67":{},"68":{},"183":{},"238":{},"239":{},"240":{}},"description":{"24":{},"25":{},"26":{},"27":{},"31":{},"66":{},"67":{},"68":{},"183":{},"238":{},"239":{},"240":{}}}],["implement",{"_index":850,"title":{},"description":{"233":{}}}],["import",{"_index":672,"title":{"100":{}},"description":{"100":{}}}],["improv",{"_index":55,"title":{},"description":{"1":{}}}],["in-hous",{"_index":133,"title":{},"description":{"3":{}}}],["in-memori",{"_index":840,"title":{},"description":{"230":{}}}],["inact",{"_index":523,"title":{},"description":{"23":{},"299":{}}}],["includ",{"_index":180,"title":{},"description":{"3":{},"5":{},"7":{},"19":{},"47":{},"48":{},"50":{},"57":{},"107":{},"137":{},"161":{},"290":{}}}],["incom",{"_index":786,"title":{"192":{},"193":{},"194":{},"195":{}},"description":{"192":{},"193":{},"194":{},"195":{}}}],["increment",{"_index":443,"title":{},"description":{"8":{}}}],["index",{"_index":894,"title":{"288":{}},"description":{"288":{}}}],["indic",{"_index":91,"title":{},"description":{"2":{},"5":{},"8":{},"9":{}}}],["info",{"_index":675,"title":{"101":{},"153":{},"248":{}},"description":{"166":{}}}],["inform",{"_index":390,"title":{},"description":{"8":{},"18":{},"28":{},"37":{},"38":{},"153":{},"228":{},"237":{},"248":{},"285":{},"321":{},"322":{}}}],["inner",{"_index":241,"title":{},"description":{"5":{}}}],["instal",{"_index":913,"title":{"300":{},"305":{}},"description":{"304":{},"305":{},"306":{}}}],["instanc",{"_index":213,"title":{},"description":{"5":{}}}],["integr",{"_index":110,"title":{},"description":{"3":{},"5":{},"159":{},"320":{}}}],["integration_act",{"_index":922,"title":{"320":{}},"description":{}}],["interact",{"_index":14,"title":{},"description":{"1":{},"4":{},"9":{},"69":{},"104":{},"143":{},"159":{},"160":{},"177":{},"214":{},"241":{},"250":{},"259":{},"284":{},"286":{},"320":{},"321":{},"322":{}}}],["interfac",{"_index":635,"title":{},"description":{"74":{},"114":{}}}],["introduct",{"_index":4,"title":{"1":{}},"description":{}}],["invalid",{"_index":671,"title":{"99":{},"230":{}},"description":{"99":{}}}],["invit",{"_index":645,"title":{"82":{},"89":{},"97":{},"98":{},"99":{},"101":{}},"description":{"82":{},"89":{},"97":{},"98":{},"99":{},"101":{}}}],["invite_guest",{"_index":670,"title":{},"description":{"98":{}}}],["invite_to_team",{"_index":669,"title":{},"description":{"97":{}}}],["involv",{"_index":730,"title":{},"description":{"137":{}}}],["is_oauth",{"_index":318,"title":{},"description":{"6":{}}}],["issu",{"_index":49,"title":{},"description":{"1":{},"3":{}}}],["januari",{"_index":98,"title":{},"description":{"3":{}}}],["javascript",{"_index":16,"title":{},"description":{"1":{},"4":{},"8":{}}}],["job",{"_index":897,"title":{"291":{},"292":{},"293":{},"294":{},"295":{},"296":{}},"description":{"288":{},"291":{},"292":{},"293":{},"294":{},"295":{},"296":{}}}],["join",{"_index":35,"title":{},"description":{"1":{},"3":{},"33":{}}}],["json",{"_index":220,"title":{},"description":{"5":{},"6":{},"8":{},"224":{},"233":{}}}],["june",{"_index":105,"title":{},"description":{"3":{}}}],["keep",{"_index":27,"title":{},"description":{"1":{}}}],["key",{"_index":477,"title":{"256":{},"257":{}},"description":{"13":{},"256":{},"257":{},"258":{}}}],["key/valu",{"_index":852,"title":{},"description":{"233":{}}}],["languag",{"_index":193,"title":{},"description":{"4":{}}}],["larger",{"_index":58,"title":{},"description":{"1":{}}}],["last",{"_index":606,"title":{"155":{}},"description":{"55":{},"324":{}}}],["last_viewed_at_tim",{"_index":734,"title":{},"description":{"137":{}}}],["later",{"_index":725,"title":{},"description":{"125":{},"126":{},"133":{},"161":{}}}],["latest",{"_index":609,"title":{"56":{},"325":{}},"description":{"56":{},"325":{}}}],["ldap",{"_index":461,"title":{"259":{},"260":{},"261":{}},"description":{"10":{},"45":{},"54":{},"259":{},"262":{}}}],["ldap/ad",{"_index":585,"title":{},"description":{"45":{}}}],["ldap_ip",{"_index":586,"title":{},"description":{"45":{}}}],["leave_team",{"_index":409,"title":{},"description":{"8":{}}}],["level",{"_index":121,"title":{},"description":{"3":{}}}],["lh",{"_index":621,"title":{"66":{},"67":{},"68":{}},"description":{"66":{},"67":{},"68":{}}}],["licens",{"_index":836,"title":{"226":{},"227":{},"228":{}},"description":{"226":{},"227":{},"228":{}}}],["license_chang",{"_index":410,"title":{},"description":{"8":{}}}],["limit",{"_index":321,"title":{"7":{}},"description":{"7":{},"125":{},"126":{}}}],["link",{"_index":561,"title":{"165":{},"266":{},"267":{},"268":{},"269":{}},"description":{"36":{},"44":{},"45":{},"82":{},"89":{},"165":{},"213":{},"266":{},"267":{},"268":{},"269":{}}}],["list",{"_index":32,"title":{"110":{},"152":{},"171":{},"179":{},"188":{},"193":{},"197":{},"204":{},"205":{},"311":{}},"description":{"1":{},"3":{},"8":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"38":{},"42":{},"47":{},"53":{},"60":{},"79":{},"80":{},"84":{},"87":{},"107":{},"109":{},"110":{},"111":{},"113":{},"120":{},"131":{},"148":{},"153":{},"168":{},"169":{},"170":{},"171":{},"176":{},"185":{},"188":{},"190":{},"193":{},"197":{},"204":{},"205":{},"263":{},"272":{},"273":{},"276":{},"277":{},"278":{},"281":{},"299":{},"304":{},"305":{},"311":{}}}],["list_team_channel",{"_index":724,"title":{},"description":{"121":{},"123":{},"124":{},"125":{},"126":{}}}],["live",{"_index":289,"title":{},"description":{"5":{}}}],["load",{"_index":855,"title":{"234":{},"236":{}},"description":{"234":{},"236":{}}}],["local",{"_index":917,"title":{},"description":{"306":{}}}],["log",{"_index":94,"title":{"231":{},"232":{}},"description":{"2":{},"3":{},"5":{},"8":{},"9":{},"19":{},"20":{},"21":{},"24":{},"25":{},"26":{},"27":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"38":{},"39":{},"40":{},"41":{},"42":{},"55":{},"56":{},"57":{},"66":{},"77":{},"84":{},"86":{},"95":{},"107":{},"136":{},"137":{},"138":{},"139":{},"140":{},"147":{},"155":{},"165":{},"168":{},"169":{},"170":{},"171":{},"172":{},"213":{},"214":{},"215":{},"231":{},"232":{},"243":{},"324":{},"325":{}}}],["login",{"_index":460,"title":{"45":{}},"description":{"10":{},"23":{},"34":{},"45":{}}}],["login_id",{"_index":222,"title":{},"description":{"5":{}}}],["login_id\":\"someone@nowhere.com\",\"password\":\"thisisabadpassword",{"_index":233,"title":{},"description":{"5":{}}}],["login_id\\\":\\\"someone@nowhere.com\\\",\\\"password\\\":\\\"thisisabadpassword",{"_index":243,"title":{},"description":{"5":{}}}],["logs_per_pag",{"_index":844,"title":{},"description":{"231":{}}}],["longer",{"_index":102,"title":{},"description":{"3":{}}}],["made",{"_index":170,"title":{"224":{}},"description":{"3":{},"188":{},"189":{},"190":{},"222":{}}}],["major",{"_index":168,"title":{},"description":{"3":{}}}],["make",{"_index":54,"title":{},"description":{"1":{},"5":{},"7":{},"8":{},"217":{}}}],["manag",{"_index":617,"title":{},"description":{"60":{},"62":{},"263":{},"297":{}}}],["manage_bot",{"_index":619,"title":{},"description":{"61":{},"63":{},"64":{},"65":{},"67":{},"68":{}}}],["manage_channel_rol",{"_index":729,"title":{},"description":{"134":{},"135":{}}}],["manage_job",{"_index":906,"title":{},"description":{"292":{},"293":{},"294":{},"295":{},"296":{}}}],["manage_oauth",{"_index":865,"title":{},"description":{"242":{},"243":{}}}],["manage_private_channel_memb",{"_index":715,"title":{},"description":{"113":{},"115":{},"133":{},"268":{},"269":{}}}],["manage_public_channel_memb",{"_index":714,"title":{},"description":{"113":{},"115":{},"133":{},"268":{},"269":{}}}],["manage_rol",{"_index":522,"title":{},"description":{"22":{}}}],["manage_slash_command",{"_index":792,"title":{},"description":{"203":{},"204":{},"206":{},"207":{},"208":{},"209":{},"210":{}}}],["manage_system",{"_index":531,"title":{},"description":{"23":{},"35":{},"48":{},"53":{},"57":{},"71":{},"77":{},"79":{},"99":{},"102":{},"103":{},"106":{},"114":{},"138":{},"141":{},"142":{},"152":{},"181":{},"189":{},"216":{},"217":{},"218":{},"219":{},"220":{},"221":{},"222":{},"224":{},"225":{},"226":{},"227":{},"228":{},"229":{},"230":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"239":{},"240":{},"252":{},"253":{},"254":{},"255":{},"256":{},"257":{},"258":{},"260":{},"261":{},"264":{},"265":{},"270":{},"271":{},"272":{},"273":{},"274":{},"275":{},"276":{},"277":{},"278":{},"280":{},"281":{},"282":{},"283":{},"285":{},"287":{},"288":{},"298":{},"299":{},"300":{},"301":{},"302":{},"303":{},"305":{},"306":{},"310":{},"313":{},"314":{},"315":{},"316":{},"317":{},"318":{},"319":{}}}],["manage_system_wide_oauth",{"_index":866,"title":{},"description":{"243":{},"244":{},"245":{},"246":{},"247":{}}}],["manage_team",{"_index":631,"title":{},"description":{"73":{},"74":{},"75":{},"89":{},"91":{},"92":{},"116":{},"117":{},"118":{},"181":{},"266":{},"267":{}}}],["manage_team_rol",{"_index":657,"title":{},"description":{"93":{},"94":{}}}],["manage_webhook",{"_index":787,"title":{},"description":{"192":{},"193":{},"194":{},"195":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{}}}],["mange_oauth",{"_index":868,"title":{},"description":{"244":{},"245":{},"246":{},"247":{}}}],["mani",{"_index":339,"title":{},"description":{"7":{}}}],["manifest",{"_index":912,"title":{},"description":{"299":{}}}],["manual",{"_index":291,"title":{},"description":{"5":{},"175":{}}}],["mark",{"_index":633,"title":{"149":{}},"description":{"74":{},"114":{},"137":{},"147":{},"149":{},"234":{},"236":{},"316":{}}}],["marketplac",{"_index":915,"title":{"305":{},"306":{}},"description":{"305":{},"306":{}}}],["master",{"_index":812,"title":{},"description":{"216":{}}}],["match",{"_index":446,"title":{},"description":{"8":{},"44":{},"108":{},"109":{},"185":{}}}],["mattermost",{"_index":5,"title":{},"description":{"1":{},"3":{},"4":{},"5":{},"7":{},"8":{},"23":{},"46":{},"137":{},"165":{},"218":{},"230":{},"241":{},"242":{},"243":{},"244":{},"247":{},"248":{},"260":{},"322":{}}}],["mattermost-zapi",{"_index":304,"title":{},"description":{"5":{}}}],["mattermosttokengoesher",{"_index":366,"title":{},"description":{"8":{}}}],["max-age=2592000",{"_index":254,"title":{},"description":{"5":{}}}],["maximum",{"_index":328,"title":{},"description":{"7":{},"184":{},"185":{}}}],["mean",{"_index":393,"title":{},"description":{"8":{}}}],["meant",{"_index":448,"title":{},"description":{"8":{}}}],["meet",{"_index":559,"title":{},"description":{"35":{}}}],["member",{"_index":63,"title":{"80":{},"84":{},"85":{},"87":{},"93":{},"94":{},"103":{},"129":{},"131":{},"132":{},"135":{},"142":{}},"description":{"1":{},"13":{},"80":{},"84":{},"85":{},"86":{},"87":{},"93":{},"94":{},"95":{},"103":{},"109":{},"125":{},"126":{},"129":{},"130":{},"131":{},"132":{},"133":{},"135":{},"142":{}}}],["member'",{"_index":659,"title":{},"description":{"94":{},"135":{}}}],["memberrole_upd",{"_index":411,"title":{},"description":{"8":{}}}],["membership",{"_index":475,"title":{"138":{}},"description":{"11":{},"32":{},"33":{},"103":{},"138":{},"142":{}}}],["mention",{"_index":667,"title":{},"description":{"95":{},"96":{},"140":{}}}],["merg",{"_index":916,"title":{},"description":{"306":{}}}],["messag",{"_index":309,"title":{"106":{},"107":{},"140":{},"232":{}},"description":{"6":{},"8":{},"95":{},"96":{},"106":{},"107":{},"114":{},"140":{},"232":{}}}],["metadata",{"_index":771,"title":{"166":{},"213":{},"251":{}},"description":{"179":{},"180":{},"182":{},"212":{},"213":{},"251":{}}}],["method",{"_index":279,"title":{"45":{},"54":{}},"description":{"5":{},"45":{},"54":{}}}],["mfa",{"_index":225,"title":{"30":{},"31":{},"34":{}},"description":{"5":{},"34":{},"45":{}}}],["mfa_cod",{"_index":588,"title":{},"description":{"45":{}}}],["migrat",{"_index":109,"title":{},"description":{"3":{}}}],["minu",{"_index":680,"title":{"103":{},"142":{}},"description":{"103":{},"142":{}}}],["mirror",{"_index":830,"title":{},"description":{"224":{}}}],["miss",{"_index":834,"title":{},"description":{"224":{}}}],["mmsid=hyr5dmb1mbb49c44qmx4whniso",{"_index":252,"title":{},"description":{"5":{}}}],["mobil",{"_index":567,"title":{"41":{}},"description":{"41":{}}}],["modifi",{"_index":185,"title":{},"description":{"3":{},"154":{},"167":{},"221":{},"225":{},"292":{},"296":{},"313":{},"318":{},"319":{}}}],["more",{"_index":65,"title":{},"description":{"1":{},"102":{},"141":{},"228":{},"237":{},"321":{},"322":{}}}],["move",{"_index":796,"title":{"209":{}},"description":{"209":{}}}],["multi-factor",{"_index":540,"title":{},"description":{"30":{},"31":{},"34":{}}}],["multipart/form-data",{"_index":759,"title":{},"description":{"161":{}}}],["multipl",{"_index":210,"title":{"83":{}},"description":{"5":{}}}],["name",{"_index":486,"title":{"76":{},"127":{},"128":{},"182":{},"311":{}},"description":{"15":{},"76":{},"78":{},"101":{},"108":{},"127":{},"128":{},"172":{},"182":{},"184":{},"185":{},"233":{},"309":{},"311":{}}}],["necessari",{"_index":174,"title":{},"description":{"3":{},"288":{}}}],["need",{"_index":558,"title":{},"description":{"34":{},"204":{},"223":{},"228":{}}}],["neg",{"_index":842,"title":{},"description":{"230":{}}}],["new",{"_index":375,"title":{"210":{},"293":{}},"description":{"8":{},"10":{},"35":{},"59":{},"70":{},"105":{},"106":{},"107":{},"144":{},"145":{},"210":{},"221":{},"233":{},"288":{},"293":{},"314":{}}}],["new_password",{"_index":584,"title":{},"description":{"45":{}}}],["new_servic",{"_index":583,"title":{},"description":{"45":{}}}],["new_us",{"_index":412,"title":{},"description":{"8":{}}}],["newer.__",{"_index":736,"title":{},"description":{"137":{}}}],["next",{"_index":71,"title":{},"description":{"1":{},"23":{}}}],["nhze199c4j87ped4wannrjdt9c",{"_index":434,"title":{},"description":{"8":{}}}],["nicknam",{"_index":487,"title":{},"description":{"15":{}}}],["node",{"_index":892,"title":{},"description":{"285":{}}}],["non-crit",{"_index":856,"title":{},"description":{"234":{},"236":{}}}],["non-log",{"_index":846,"title":{},"description":{"232":{}}}],["non-self",{"_index":593,"title":{},"description":{"46":{},"47":{},"49":{},"50":{},"51":{},"52":{}}}],["non-sso",{"_index":539,"title":{},"description":{"29":{},"36":{}}}],["not_associated_to_channel",{"_index":884,"title":{},"description":{"263":{}}}],["not_associated_to_group",{"_index":710,"title":{},"description":{"108":{}}}],["not_associated_to_team",{"_index":883,"title":{},"description":{"263":{}}}],["note",{"_index":70,"title":{},"description":{"1":{},"5":{}}}],["notic",{"_index":323,"title":{},"description":{"7":{},"8":{}}}],["notif",{"_index":571,"title":{"136":{}},"description":{"41":{},"136":{},"137":{},"234":{},"236":{}}}],["notifi",{"_index":612,"title":{},"description":{"57":{}}}],["now",{"_index":178,"title":{},"description":{"3":{},"5":{}}}],["null",{"_index":383,"title":{},"description":{"8":{},"19":{}}}],["number",{"_index":329,"title":{},"description":{"7":{},"8":{},"83":{},"215":{}}}],["oauth",{"_index":295,"title":{"241":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"249":{}},"description":{"5":{},"6":{},"241":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"249":{}}}],["oauth2/saml",{"_index":580,"title":{},"description":{"45":{}}}],["oauth2/saml/ldap",{"_index":579,"title":{},"description":{"45":{}}}],["object",{"_index":247,"title":{},"description":{"5":{},"13":{},"18":{},"19":{},"20":{},"28":{},"37":{},"73":{},"86":{},"103":{},"130":{},"142":{},"153":{},"224":{},"270":{},"271":{}}}],["off-top",{"_index":704,"title":{},"description":{"108":{}}}],["offer",{"_index":346,"title":{},"description":{"8":{}}}],["offici",{"_index":195,"title":{},"description":{"4":{},"5":{}}}],["ok",{"_index":250,"title":{},"description":{"5":{},"8":{}}}],["old",{"_index":848,"title":{},"description":{"233":{}}}],["oldest",{"_index":755,"title":{},"description":{"155":{}}}],["omit",{"_index":395,"title":{},"description":{"8":{},"13":{},"21":{},"61":{},"75":{},"113":{},"115":{},"148":{},"150":{},"265":{},"274":{},"275":{},"310":{},"317":{}}}],["omit_us",{"_index":382,"title":{},"description":{"8":{}}}],["on",{"_index":576,"title":{},"description":{"44":{},"106":{},"149":{}}}],["onc",{"_index":115,"title":{},"description":{"3":{},"8":{}}}],["one-us",{"_index":536,"title":{},"description":{"29":{},"36":{}}}],["onlin",{"_index":777,"title":{},"description":{"175":{}}}],["open",{"_index":148,"title":{"108":{},"213":{},"321":{}},"description":{"3":{},"8":{},"71":{},"76":{},"77":{},"81":{},"90":{},"108":{},"212":{},"213":{},"321":{}}}],["opengraph",{"_index":800,"title":{"212":{}},"description":{}}],["option",{"_index":224,"title":{},"description":{"5":{},"74":{},"161":{},"193":{},"197":{},"217":{},"219":{},"287":{}}}],["ordinari",{"_index":664,"title":{},"description":{"94":{},"135":{}}}],["origin",{"_index":447,"title":{},"description":{"8":{}}}],["other",{"_index":64,"title":{},"description":{"1":{},"60":{},"62":{}}}],["otherwis",{"_index":113,"title":{},"description":{"3":{},"15":{},"244":{},"245":{},"246":{},"247":{},"268":{},"269":{}}}],["out",{"_index":502,"title":{},"description":{"18":{},"28":{},"37":{},"38":{},"57":{},"248":{}}}],["outgo",{"_index":788,"title":{"196":{},"197":{},"198":{},"199":{},"200":{},"201":{}},"description":{"196":{},"197":{},"198":{},"199":{},"200":{},"201":{}}}],["over",{"_index":362,"title":{},"description":{"8":{}}}],["overwrit",{"_index":519,"title":{},"description":{"22":{},"93":{}}}],["page",{"_index":181,"title":{"318":{},"319":{}},"description":{"3":{},"11":{},"47":{},"48":{},"60":{},"71":{},"80":{},"121":{},"122":{},"129":{},"152":{},"154":{},"179":{},"193":{},"197":{},"229":{},"231":{},"243":{},"249":{},"281":{},"292":{},"296":{},"313":{},"318":{},"319":{}}}],["pair",{"_index":647,"title":{},"description":{"82":{},"233":{}}}],["param",{"_index":888,"title":{},"description":{"270":{},"271":{}}}],["paramet",{"_index":469,"title":{},"description":{"11":{},"24":{},"25":{},"26":{},"27":{},"47":{},"48":{},"66":{},"67":{},"68":{},"71":{},"74":{},"80":{},"108":{},"113":{},"121":{},"122":{},"154":{},"161":{},"179":{},"193":{},"197":{},"229":{},"231":{},"233":{},"281":{},"292":{},"296":{},"313":{},"318":{},"319":{}}}],["parent_id",{"_index":435,"title":{},"description":{"8":{}}}],["part",{"_index":182,"title":{},"description":{"3":{},"5":{}}}],["parti",{"_index":12,"title":{},"description":{"1":{}}}],["partial",{"_index":511,"title":{},"description":{"21":{},"61":{},"75":{},"115":{},"150":{},"265":{},"274":{},"275":{},"310":{},"317":{}}}],["particular",{"_index":882,"title":{},"description":{"263":{}}}],["pass",{"_index":369,"title":{},"description":{"8":{}}}],["password",{"_index":223,"title":{"29":{},"35":{},"36":{}},"description":{"5":{},"10":{},"29":{},"35":{},"36":{},"45":{}}}],["patch",{"_index":510,"title":{"21":{},"61":{},"75":{},"115":{},"150":{},"225":{},"265":{},"274":{},"275":{},"310":{},"317":{}},"description":{"225":{}}}],["path",{"_index":253,"title":{},"description":{"5":{}}}],["payload",{"_index":925,"title":{},"description":{"321":{}}}],["per",{"_index":330,"title":{},"description":{"7":{},"13":{},"80":{}}}],["per_pag",{"_index":629,"title":{},"description":{"71":{},"121":{},"122":{},"229":{},"281":{}}}],["perform",{"_index":440,"title":{"159":{}},"description":{"8":{},"137":{},"159":{},"230":{}}}],["perman",{"_index":636,"title":{},"description":{"74":{}}}],["permiss",{"_index":465,"title":{},"description":{"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"57":{},"59":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"105":{},"106":{},"107":{},"110":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"121":{},"123":{},"124":{},"125":{},"126":{},"127":{},"128":{},"129":{},"131":{},"132":{},"133":{},"134":{},"135":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"144":{},"145":{},"146":{},"147":{},"148":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{},"155":{},"156":{},"157":{},"158":{},"159":{},"161":{},"162":{},"163":{},"164":{},"165":{},"166":{},"168":{},"169":{},"170":{},"171":{},"172":{},"174":{},"175":{},"176":{},"178":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"187":{},"188":{},"189":{},"190":{},"192":{},"193":{},"194":{},"195":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{},"203":{},"204":{},"205":{},"206":{},"207":{},"208":{},"209":{},"210":{},"211":{},"213":{},"215":{},"216":{},"217":{},"218":{},"219":{},"220":{},"221":{},"222":{},"223":{},"224":{},"225":{},"226":{},"227":{},"228":{},"229":{},"230":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"238":{},"239":{},"240":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"249":{},"251":{},"252":{},"253":{},"254":{},"255":{},"256":{},"257":{},"258":{},"260":{},"261":{},"263":{},"264":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"271":{},"272":{},"273":{},"274":{},"275":{},"276":{},"277":{},"278":{},"280":{},"281":{},"282":{},"283":{},"285":{},"287":{},"288":{},"290":{},"292":{},"293":{},"294":{},"295":{},"296":{},"298":{},"299":{},"300":{},"301":{},"302":{},"303":{},"304":{},"305":{},"306":{},"308":{},"309":{},"310":{},"311":{},"313":{},"314":{},"315":{},"316":{},"317":{},"318":{},"319":{},"324":{},"325":{}}}],["permission_import_team",{"_index":674,"title":{},"description":{"100":{}}}],["person",{"_index":282,"title":{"51":{},"52":{}},"description":{"5":{},"51":{},"52":{}}}],["php",{"_index":199,"title":{},"description":{"4":{}}}],["pick",{"_index":826,"title":{},"description":{"222":{},"252":{},"254":{},"256":{}}}],["pin",{"_index":723,"title":{"120":{},"157":{}},"description":{"120":{},"157":{}}}],["ping",{"_index":819,"title":{},"description":{"218":{}}}],["place",{"_index":90,"title":{},"description":{"2":{},"9":{}}}],["plan",{"_index":149,"title":{},"description":{"3":{}}}],["pleas",{"_index":34,"title":{},"description":{"1":{},"5":{},"8":{}}}],["plugin",{"_index":908,"title":{"297":{},"298":{},"299":{},"300":{},"301":{},"302":{},"303":{},"304":{},"305":{},"306":{}},"description":{"297":{},"298":{},"299":{},"300":{},"301":{},"302":{},"303":{},"304":{},"305":{},"306":{}}}],["plugin_dis",{"_index":413,"title":{},"description":{"8":{}}}],["plugin_en",{"_index":414,"title":{},"description":{"8":{}}}],["plugin_statuses_chang",{"_index":415,"title":{},"description":{"8":{}}}],["pluginsettings.enableupload",{"_index":824,"title":{},"description":{"221":{},"225":{}}}],["polici",{"_index":560,"title":{"290":{}},"description":{"35":{},"289":{},"290":{}}}],["post",{"_index":40,"title":{"120":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{},"149":{},"150":{},"152":{},"153":{},"154":{},"155":{},"156":{},"157":{},"158":{},"159":{},"188":{},"189":{},"190":{}},"description":{"1":{},"5":{},"8":{},"100":{},"120":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{},"155":{},"156":{},"157":{},"158":{},"159":{},"161":{},"187":{},"188":{},"189":{},"190":{}}}],["post_delet",{"_index":416,"title":{},"description":{"8":{}}}],["post_edit",{"_index":417,"title":{},"description":{"8":{}}}],["post_unread",{"_index":418,"title":{},"description":{"8":{}}}],["pre-release.mattermost.com](https://pre-release.mattermost.com/signup_user_complete/?id=f1924a8db44ff3bb41c96424cdc20676",{"_index":188,"title":{},"description":{"3":{}}}],["prefer",{"_index":772,"title":{"167":{},"168":{},"169":{},"170":{},"171":{},"172":{}},"description":{"167":{},"168":{},"169":{},"170":{},"171":{},"172":{}}}],["preference_chang",{"_index":419,"title":{},"description":{"8":{}}}],["preferences_chang",{"_index":420,"title":{},"description":{"8":{}}}],["preferences_delet",{"_index":421,"title":{},"description":{"8":{}}}],["prepackag",{"_index":918,"title":{},"description":{"306":{}}}],["present",{"_index":817,"title":{},"description":{"217":{},"219":{},"287":{}}}],["preview",{"_index":770,"title":{"164":{}},"description":{"164":{},"213":{}}}],["previou",{"_index":696,"title":{},"description":{"106":{},"138":{}}}],["previous",{"_index":520,"title":{},"description":{"22":{},"93":{},"162":{},"238":{},"240":{},"281":{},"282":{},"302":{},"303":{}}}],["primarili",{"_index":371,"title":{},"description":{"8":{}}}],["print",{"_index":127,"title":{},"description":{"3":{}}}],["privaci",{"_index":563,"title":{"116":{}},"description":{"37":{},"116":{}}}],["privat",{"_index":690,"title":{"108":{},"117":{},"256":{},"257":{}},"description":{"105":{},"108":{},"113":{},"114":{},"115":{},"116":{},"117":{},"133":{},"256":{},"257":{},"268":{},"269":{}}}],["privatekeyfil",{"_index":878,"title":{},"description":{"256":{}}}],["prixone](https://github.com/prixon",{"_index":203,"title":{},"description":{"4":{}}}],["profil",{"_index":532,"title":{"24":{},"25":{},"26":{},"27":{}},"description":{"24":{},"25":{},"26":{},"27":{}}}],["promot",{"_index":555,"title":{"33":{}},"description":{}}],["promote_guest",{"_index":557,"title":{},"description":{"33":{}}}],["properli",{"_index":871,"title":{},"description":{"251":{}}}],["properti",{"_index":661,"title":{},"description":{"94":{},"135":{},"136":{}}}],["protocol",{"_index":802,"title":{},"description":{"213":{}}}],["provid",{"_index":300,"title":{},"description":{"5":{},"12":{},"14":{},"15":{},"16":{},"19":{},"21":{},"23":{},"28":{},"30":{},"34":{},"37":{},"38":{},"39":{},"40":{},"42":{},"45":{},"53":{},"61":{},"73":{},"75":{},"76":{},"77":{},"87":{},"112":{},"115":{},"117":{},"118":{},"123":{},"124":{},"125":{},"126":{},"127":{},"128":{},"131":{},"136":{},"144":{},"150":{},"152":{},"156":{},"157":{},"158":{},"184":{},"185":{},"217":{},"219":{},"241":{},"242":{},"264":{},"265":{},"274":{},"275":{},"287":{},"301":{},"308":{},"309":{},"310":{},"315":{},"317":{},"318":{},"319":{},"321":{}}}],["public",{"_index":688,"title":{"117":{},"121":{},"165":{},"254":{},"255":{}},"description":{"105":{},"110":{},"113":{},"114":{},"115":{},"116":{},"121":{},"123":{},"125":{},"133":{},"146":{},"149":{},"151":{},"165":{},"248":{},"254":{},"255":{}}}],["publiccertificatefil",{"_index":877,"title":{},"description":{"254":{}}}],["pull",{"_index":46,"title":{},"description":{"1":{}}}],["purg",{"_index":839,"title":{"288":{}},"description":{"230":{},"290":{}}}],["purpos",{"_index":436,"title":{},"description":{"8":{},"16":{},"108":{}}}],["push",{"_index":570,"title":{},"description":{"41":{},"137":{}}}],["python",{"_index":204,"title":{},"description":{"4":{}}}],["qr",{"_index":545,"title":{},"description":{"31":{}}}],["queri",{"_index":183,"title":{},"description":{"3":{},"11":{},"13":{},"47":{},"48":{},"71":{},"74":{},"80":{},"121":{},"122":{},"147":{},"154":{},"161":{},"179":{},"193":{},"197":{},"229":{},"231":{},"233":{},"281":{},"292":{},"296":{},"313":{},"318":{},"319":{}}}],["question",{"_index":30,"title":{},"description":{"1":{},"3":{}}}],["quot",{"_index":238,"title":{},"description":{"5":{}}}],["rate",{"_index":320,"title":{"7":{}},"description":{"7":{}}}],["re-en",{"_index":598,"title":{},"description":{"51":{},"52":{},"236":{}}}],["re-popul",{"_index":843,"title":{},"description":{"230":{}}}],["reaction",{"_index":782,"title":{"186":{},"187":{},"188":{},"189":{},"190":{}},"description":{"186":{},"187":{},"188":{},"189":{},"190":{}}}],["reaction_ad",{"_index":422,"title":{},"description":{"8":{}}}],["reaction_remov",{"_index":423,"title":{},"description":{"8":{}}}],["read",{"_index":731,"title":{},"description":{"137":{},"216":{}}}],["read_bot",{"_index":616,"title":{},"description":{"60":{},"62":{}}}],["read_channel",{"_index":489,"title":{},"description":{"15":{},"16":{},"111":{},"112":{},"119":{},"127":{},"128":{},"129":{},"131":{},"132":{},"140":{},"146":{},"149":{},"151":{},"153":{},"154":{},"155":{},"157":{},"158":{},"159":{},"162":{},"163":{},"164":{},"165":{},"166":{},"187":{},"188":{},"190":{}}}],["read_others_bot",{"_index":618,"title":{},"description":{"60":{},"62":{}}}],["read_public_channel",{"_index":746,"title":{},"description":{"146":{},"149":{},"151":{}}}],["read_user_access_token",{"_index":595,"title":{},"description":{"47":{},"50":{}}}],["real",{"_index":286,"title":{},"description":{"5":{}}}],["reason",{"_index":313,"title":{},"description":{"6":{},"74":{}}}],["receiv",{"_index":337,"title":{},"description":{"7":{},"8":{}}}],["reconnect",{"_index":811,"title":{},"description":{"216":{}}}],["record",{"_index":601,"title":{"55":{},"324":{}},"description":{"55":{},"102":{},"108":{},"141":{},"324":{}}}],["recoveri",{"_index":537,"title":{},"description":{"29":{},"36":{}}}],["recycl",{"_index":809,"title":{"216":{}},"description":{"216":{}}}],["redoc-inject",{"_index":2,"title":{},"description":{"0":{}}}],["refer",{"_index":33,"title":{},"description":{"1":{},"8":{}}}],["reference](https://api.mattermost.com",{"_index":136,"title":{},"description":{"3":{}}}],["reflect",{"_index":526,"title":{},"description":{"23":{}}}],["regardless",{"_index":628,"title":{},"description":{"71":{},"243":{}}}],["regener",{"_index":652,"title":{"89":{},"201":{},"247":{}},"description":{"89":{},"201":{},"247":{}}}],["regist",{"_index":303,"title":{"242":{}},"description":{"5":{},"242":{},"243":{},"244":{},"247":{},"248":{}}}],["regular",{"_index":549,"title":{},"description":{"32":{},"33":{},"71":{}}}],["reject",{"_index":626,"title":{},"description":{"67":{}}}],["relat",{"_index":860,"title":{},"description":{"237":{},"262":{},"291":{},"297":{}}}],["releas",{"_index":69,"title":{},"description":{"1":{},"3":{}}}],["relev",{"_index":389,"title":{},"description":{"8":{}}}],["reload",{"_index":825,"title":{"222":{}},"description":{"222":{}}}],["remain",{"_index":166,"title":{},"description":{"3":{},"7":{},"175":{}}}],["remov",{"_index":103,"title":{"86":{},"92":{},"133":{},"189":{},"227":{},"253":{},"255":{},"257":{},"301":{}},"description":{"3":{},"86":{},"92":{},"133":{},"186":{},"227":{},"301":{}}}],["remove_user_from_team",{"_index":650,"title":{},"description":{"86":{}}}],["replica",{"_index":813,"title":{},"description":{"216":{}}}],["repopul",{"_index":898,"title":{},"description":{"288":{}}}],["report",{"_index":890,"title":{"280":{},"281":{},"282":{},"283":{}},"description":{"279":{},"280":{},"281":{},"282":{},"283":{}}}],["reports](https://github.com/mattermost/mattermost-api-reference/issu",{"_index":44,"title":{},"description":{"1":{}}}],["repres",{"_index":683,"title":{},"description":{"103":{},"142":{}}}],["request",{"_index":47,"title":{},"description":{"1":{},"2":{},"3":{},"5":{},"6":{},"7":{},"8":{},"15":{},"19":{},"21":{},"44":{},"46":{},"47":{},"49":{},"50":{},"51":{},"52":{},"53":{},"61":{},"73":{},"75":{},"77":{},"115":{},"123":{},"124":{},"125":{},"126":{},"150":{},"161":{},"184":{},"217":{},"218":{},"219":{},"265":{},"274":{},"275":{},"287":{},"310":{},"317":{}}}],["request_id",{"_index":314,"title":{},"description":{"6":{}}}],["requir",{"_index":86,"title":{},"description":{"2":{},"3":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"18":{},"28":{},"29":{},"30":{},"34":{},"35":{},"36":{},"37":{},"43":{},"44":{},"45":{},"59":{},"71":{},"101":{},"105":{},"106":{},"113":{},"115":{},"138":{},"213":{},"223":{},"228":{},"238":{},"244":{},"245":{},"246":{},"247":{},"251":{},"253":{},"255":{},"257":{},"263":{},"290":{},"304":{},"308":{},"309":{},"310":{},"311":{},"317":{},"318":{},"319":{}}}],["reserv",{"_index":849,"title":{},"description":{"233":{}}}],["reset",{"_index":335,"title":{"29":{},"36":{}},"description":{"7":{},"23":{},"26":{},"36":{}}}],["respond",{"_index":449,"title":{},"description":{"8":{}}}],["respons",{"_index":82,"title":{},"description":{"2":{},"5":{},"6":{},"7":{},"8":{},"13":{}}}],["rest",{"_index":345,"title":{},"description":{"8":{},"46":{},"151":{}}}],["restor",{"_index":720,"title":{"118":{}},"description":{"118":{}}}],["result",{"_index":496,"title":{},"description":{"16":{},"71":{},"108":{},"125":{},"126":{},"184":{},"185":{}}}],["retain",{"_index":551,"title":{},"description":{"32":{},"33":{}}}],["retent",{"_index":900,"title":{"290":{}},"description":{"289":{},"290":{}}}],["retriev",{"_index":822,"title":{},"description":{"220":{},"224":{},"263":{},"272":{},"273":{},"276":{},"277":{},"278":{}}}],["return",{"_index":179,"title":{"27":{}},"description":{"3":{},"6":{},"27":{},"31":{},"44":{},"45":{},"71":{},"108":{},"147":{},"175":{},"184":{},"185":{},"228":{},"233":{},"238":{},"240":{},"243":{}}}],["revert",{"_index":504,"title":{},"description":{"19":{}}}],["review",{"_index":151,"title":{},"description":{"3":{}}}],["revok",{"_index":292,"title":{"39":{},"40":{},"49":{},"57":{}},"description":{"5":{},"20":{},"39":{},"40":{},"49":{},"57":{}}}],["revoke_user_access_token",{"_index":597,"title":{},"description":{"49":{},"51":{}}}],["rfc",{"_index":353,"title":{},"description":{"8":{}}}],["role",{"_index":513,"title":{"22":{},"93":{},"94":{},"134":{},"135":{},"138":{},"307":{},"308":{},"309":{},"310":{},"311":{}},"description":{"22":{},"84":{},"93":{},"103":{},"134":{},"138":{},"142":{},"307":{},"308":{},"309":{},"310":{},"311":{}}}],["role_upd",{"_index":424,"title":{},"description":{"8":{}}}],["root_id",{"_index":742,"title":{},"description":{"144":{}}}],["rout",{"_index":31,"title":{},"description":{"1":{},"8":{},"233":{}}}],["run",{"_index":214,"title":{},"description":{"5":{},"291":{}}}],["s3",{"_index":821,"title":{"219":{}},"description":{"219":{}}}],["same",{"_index":750,"title":{},"description":{"151":{}}}],["saml",{"_index":462,"title":{"250":{}},"description":{"10":{},"250":{},"251":{},"252":{},"253":{},"254":{},"255":{},"256":{},"257":{},"258":{}}}],["sanit",{"_index":501,"title":{},"description":{"18":{},"28":{},"37":{},"38":{}}}],["save",{"_index":773,"title":{"169":{}},"description":{"167":{},"169":{},"280":{}}}],["schedul",{"_index":896,"title":{},"description":{"288":{}}}],["schema",{"_index":77,"title":{"2":{}},"description":{}}],["scheme",{"_index":678,"title":{"102":{},"141":{},"312":{},"313":{},"314":{},"315":{},"316":{},"317":{},"318":{},"319":{}},"description":{"102":{},"141":{},"312":{},"313":{},"314":{},"315":{},"316":{},"317":{},"318":{},"319":{}}}],["scheme-deriv",{"_index":658,"title":{"94":{},"135":{}},"description":{}}],["scheme_admin",{"_index":687,"title":{},"description":{"103":{},"142":{}}}],["scheme_admin/scheme_us",{"_index":660,"title":{},"description":{"94":{},"135":{}}}],["scheme_admin=fals",{"_index":662,"title":{},"description":{"94":{},"135":{}}}],["scheme_admin=tru",{"_index":665,"title":{},"description":{"94":{},"135":{}}}],["scheme_guest",{"_index":685,"title":{},"description":{"103":{},"142":{}}}],["scheme_id",{"_index":679,"title":{},"description":{"102":{},"141":{}}}],["scheme_us",{"_index":686,"title":{},"description":{"103":{},"142":{}}}],["scheme_user=tru",{"_index":663,"title":{},"description":{"94":{},"135":{}}}],["search",{"_index":130,"title":{"15":{},"53":{},"77":{},"108":{},"109":{},"124":{},"125":{},"126":{},"156":{},"184":{}},"description":{"3":{},"15":{},"16":{},"53":{},"77":{},"109":{},"123":{},"124":{},"125":{},"126":{},"156":{},"184":{},"234":{},"236":{}}}],["second",{"_index":331,"title":{},"description":{"7":{}}}],["secret",{"_index":542,"title":{"31":{},"247":{}},"description":{"31":{},"247":{},"248":{}}}],["security-definit",{"_index":3,"title":{},"description":{"0":{}}}],["see",{"_index":208,"title":{},"description":{"4":{},"5":{},"8":{},"237":{},"261":{},"287":{},"321":{},"322":{}}}],["select",{"_index":470,"title":{},"description":{"11":{},"152":{},"229":{},"231":{},"281":{}}}],["self",{"_index":642,"title":{},"description":{"81":{}}}],["self-built",{"_index":134,"title":{},"description":{"3":{}}}],["send",{"_index":361,"title":{"36":{},"44":{},"217":{}},"description":{"8":{},"36":{},"44":{},"217":{},"218":{},"219":{}}}],["sensit",{"_index":500,"title":{},"description":{"18":{},"28":{},"37":{},"38":{}}}],["sent",{"_index":391,"title":{},"description":{"8":{}}}],["sep",{"_index":268,"title":{},"description":{"5":{},"7":{}}}],["separ",{"_index":904,"title":{},"description":{"291":{}}}],["seq",{"_index":363,"title":{},"description":{"8":{}}}],["seq_repli",{"_index":367,"title":{},"description":{"8":{}}}],["sequenc",{"_index":442,"title":{},"description":{"8":{}}}],["server",{"_index":15,"title":{"234":{},"235":{},"236":{}},"description":{"1":{},"3":{},"5":{},"8":{},"10":{},"11":{},"13":{},"15":{},"23":{},"26":{},"27":{},"32":{},"33":{},"35":{},"40":{},"41":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"57":{},"59":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"74":{},"90":{},"91":{},"92":{},"94":{},"98":{},"101":{},"102":{},"103":{},"109":{},"111":{},"116":{},"117":{},"118":{},"122":{},"123":{},"124":{},"125":{},"126":{},"133":{},"135":{},"137":{},"141":{},"142":{},"149":{},"155":{},"161":{},"174":{},"176":{},"179":{},"182":{},"184":{},"185":{},"190":{},"206":{},"209":{},"213":{},"214":{},"215":{},"217":{},"218":{},"219":{},"220":{},"221":{},"223":{},"224":{},"225":{},"226":{},"227":{},"228":{},"230":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"240":{},"251":{},"252":{},"254":{},"256":{},"260":{},"261":{},"263":{},"264":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"271":{},"272":{},"273":{},"274":{},"275":{},"276":{},"277":{},"278":{},"287":{},"288":{},"290":{},"291":{},"292":{},"293":{},"294":{},"295":{},"296":{},"298":{},"299":{},"300":{},"301":{},"302":{},"303":{},"304":{},"305":{},"306":{},"308":{},"309":{},"310":{},"311":{},"313":{},"314":{},"315":{},"316":{},"317":{},"318":{},"319":{},"321":{},"322":{},"324":{},"325":{}}}],["server'",{"_index":120,"title":{},"description":{"3":{},"37":{},"74":{},"298":{},"299":{},"300":{},"301":{},"302":{},"303":{}}}],["server](https://pre-release.mattermost.com/signup_user_complete/?id=f1924a8db44ff3bb41c96424cdc20676",{"_index":36,"title":{},"description":{"1":{}}}],["server_vers",{"_index":379,"title":{},"description":{"8":{}}}],["servic",{"_index":7,"title":{"55":{},"56":{},"323":{},"324":{},"325":{}},"description":{"1":{},"4":{},"5":{},"8":{},"45":{},"55":{},"56":{},"234":{},"236":{},"241":{},"242":{},"323":{},"324":{},"325":{}}}],["servicesettings.enableapiteamdelet",{"_index":640,"title":{},"description":{"74":{}}}],["servicesettings.enabledevelop",{"_index":845,"title":{},"description":{"232":{}}}],["session",{"_index":216,"title":{"38":{},"39":{},"40":{},"57":{}},"description":{"5":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"18":{},"20":{},"28":{},"37":{},"38":{},"39":{},"40":{},"41":{},"49":{},"51":{},"57":{},"290":{},"308":{},"309":{},"311":{}}}],["set",{"_index":119,"title":{"25":{},"67":{},"91":{},"102":{},"141":{},"234":{}},"description":{"3":{},"8":{},"19":{},"25":{},"35":{},"37":{},"67":{},"74":{},"91":{},"102":{},"103":{},"141":{},"142":{},"175":{},"215":{},"217":{},"221":{},"224":{},"225":{},"252":{},"254":{},"256":{},"285":{},"289":{},"298":{},"299":{},"300":{},"301":{},"302":{},"303":{}}}],["set-cooki",{"_index":251,"title":{},"description":{"5":{}}}],["ship",{"_index":919,"title":{},"description":{"306":{}}}],["show",{"_index":630,"title":{},"description":{"71":{},"77":{}}}],["shown",{"_index":294,"title":{},"description":{"5":{}}}],["sign-up",{"_index":574,"title":{},"description":{"43":{}}}],["similar",{"_index":285,"title":{},"description":{"5":{},"8":{}}}],["simpl",{"_index":107,"title":{},"description":{"3":{}}}],["singl",{"_index":237,"title":{},"description":{"5":{},"146":{},"161":{},"172":{},"207":{},"294":{}}}],["site",{"_index":818,"title":{"218":{}},"description":{"218":{}}}],["slash",{"_index":791,"title":{},"description":{"202":{},"321":{}}}],["small",{"_index":56,"title":{},"description":{"1":{}}}],["smda55ckcfy89b6tia58shk5fh",{"_index":263,"title":{},"description":{"5":{}}}],["soft",{"_index":632,"title":{},"description":{"74":{},"114":{},"147":{},"316":{}}}],["some.error.id.her",{"_index":453,"title":{},"description":{"8":{}}}],["someth",{"_index":310,"title":{},"description":{"6":{}}}],["sort",{"_index":472,"title":{},"description":{"11":{},"179":{}}}],["sourc",{"_index":73,"title":{},"description":{"1":{}}}],["specif",{"_index":194,"title":{"172":{}},"description":{"4":{},"6":{},"8":{},"11":{},"102":{},"138":{},"141":{},"193":{},"194":{},"195":{},"197":{},"198":{},"199":{},"200":{},"201":{},"213":{}}}],["specifi",{"_index":474,"title":{},"description":{"11":{},"15":{},"16":{},"45":{},"62":{},"65":{},"96":{},"218":{}}}],["specification](https://tools.ietf.org/html/rfc6455#section-1.3",{"_index":354,"title":{},"description":{"8":{}}}],["squar",{"_index":703,"title":{},"description":{"108":{}}}],["sso",{"_index":525,"title":{},"description":{"23":{}}}],["standard",{"_index":350,"title":{},"description":{"8":{}}}],["start",{"_index":780,"title":{},"description":{"185":{}}}],["stat",{"_index":651,"title":{"88":{}},"description":{"88":{}}}],["statist",{"_index":722,"title":{"119":{}},"description":{"119":{}}}],["statu",{"_index":317,"title":{"23":{},"173":{},"174":{},"175":{},"258":{},"285":{}},"description":{"6":{},"7":{},"8":{},"23":{},"174":{},"175":{},"258":{},"285":{}}}],["status",{"_index":776,"title":{"176":{}},"description":{"173":{},"176":{},"234":{},"236":{}}}],["status_chang",{"_index":425,"title":{},"description":{"8":{}}}],["status_cod",{"_index":315,"title":{},"description":{"6":{}}}],["step",{"_index":108,"title":{},"description":{"3":{},"45":{}}}],["store",{"_index":775,"title":{},"description":{"171":{}}}],["string",{"_index":89,"title":{},"description":{"2":{},"3":{},"9":{},"11":{},"24":{},"25":{},"26":{},"27":{},"31":{},"39":{},"40":{},"66":{},"67":{},"68":{},"71":{},"76":{},"80":{},"108":{},"112":{},"117":{},"118":{},"121":{},"122":{},"127":{},"128":{},"152":{},"156":{},"157":{},"158":{},"206":{},"207":{},"208":{},"209":{},"210":{},"264":{}}}],["struct",{"_index":795,"title":{},"description":{"207":{},"245":{}}}],["submit",{"_index":823,"title":{"322":{}},"description":{"221":{},"225":{},"322":{}}}],["subset",{"_index":827,"title":{},"description":{"223":{},"228":{}}}],["success",{"_index":244,"title":{},"description":{"5":{},"8":{},"44":{}}}],["successfulli",{"_index":368,"title":{},"description":{"8":{},"261":{},"287":{}}}],["such",{"_index":373,"title":{},"description":{"8":{},"10":{},"214":{},"234":{},"236":{}}}],["suppli",{"_index":914,"title":{},"description":{"300":{}}}],["support",{"_index":22,"title":{},"description":{"1":{},"3":{},"8":{},"11":{},"161":{}}}],["sure",{"_index":815,"title":{},"description":{"217":{}}}],["svg",{"_index":624,"title":{},"description":{"67":{}}}],["switch",{"_index":578,"title":{"45":{}},"description":{"45":{}}}],["sync",{"_index":879,"title":{"260":{}},"description":{}}],["synchron",{"_index":527,"title":{},"description":{"23":{},"260":{}}}],["system",{"_index":123,"title":{"17":{},"214":{},"215":{}},"description":{"3":{},"8":{},"10":{},"17":{},"32":{},"33":{},"44":{},"48":{},"59":{},"70":{},"72":{},"85":{},"88":{},"145":{},"179":{},"193":{},"194":{},"195":{},"197":{},"198":{},"199":{},"200":{},"201":{},"229":{},"233":{},"253":{},"255":{},"257":{}}}],["system'",{"_index":230,"title":{},"description":{"5":{}}}],["system-level",{"_index":514,"title":{},"description":{"22":{}}}],["system_admin",{"_index":517,"title":{},"description":{"22":{}}}],["system_us",{"_index":516,"title":{},"description":{"22":{}}}],["tabl",{"_index":605,"title":{},"description":{"55":{},"324":{}}}],["taken",{"_index":93,"title":{},"description":{"2":{},"9":{}}}],["tar.gz",{"_index":911,"title":{},"description":{"298":{},"300":{}}}],["team",{"_index":173,"title":{"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"100":{},"101":{},"103":{},"108":{},"128":{},"156":{},"204":{},"266":{},"267":{},"270":{},"272":{},"274":{},"278":{},"318":{}},"description":{"3":{},"11":{},"15":{},"16":{},"32":{},"33":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"100":{},"101":{},"102":{},"103":{},"110":{},"116":{},"117":{},"118":{},"121":{},"122":{},"123":{},"124":{},"125":{},"126":{},"127":{},"128":{},"138":{},"139":{},"146":{},"149":{},"151":{},"152":{},"156":{},"175":{},"178":{},"193":{},"194":{},"195":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{},"203":{},"204":{},"205":{},"206":{},"207":{},"208":{},"209":{},"210":{},"211":{},"263":{},"266":{},"267":{},"272":{},"278":{},"318":{}}}],["team'",{"_index":677,"title":{"102":{}},"description":{"102":{}}}],["team-scop",{"_index":920,"title":{},"description":{"318":{}}}],["team/channel",{"_index":789,"title":{},"description":{"197":{}}}],["team_admin",{"_index":656,"title":{},"description":{"93":{}}}],["team_id",{"_index":387,"title":{},"description":{"8":{},"16":{},"122":{},"270":{}}}],["team_us",{"_index":655,"title":{},"description":{"93":{}}}],["tell",{"_index":325,"title":{},"description":{"7":{}}}],["temporari",{"_index":841,"title":{},"description":{"230":{}}}],["term",{"_index":493,"title":{"55":{},"56":{},"323":{},"324":{},"325":{}},"description":{"16":{},"55":{},"56":{},"77":{},"108":{},"109":{},"123":{},"124":{},"125":{},"126":{},"156":{},"323":{},"324":{},"325":{}}}],["test",{"_index":814,"title":{"217":{},"219":{},"261":{},"287":{}},"description":{"217":{},"219":{},"261":{},"287":{}}}],["the.error.id",{"_index":308,"title":{},"description":{"6":{}}}],["themselv",{"_index":530,"title":{},"description":{"23":{}}}],["third",{"_index":11,"title":{},"description":{"1":{}}}],["third-parti",{"_index":139,"title":{},"description":{"3":{}}}],["those",{"_index":648,"title":{},"description":{"84":{}}}],["thread",{"_index":438,"title":{"151":{}},"description":{"8":{},"151":{}}}],["threshold",{"_index":807,"title":{},"description":{"215":{}}}],["through",{"_index":79,"title":{"224":{}},"description":{"2":{},"3":{},"4":{},"8":{},"159":{},"224":{}}}],["thumbnail",{"_index":769,"title":{"163":{}},"description":{"163":{}}}],["ti",{"_index":538,"title":{},"description":{"29":{},"36":{}}}],["tickets](https://github.com/mattermost/mattermost-api-reference/issu",{"_index":62,"title":{},"description":{"1":{}}}],["time",{"_index":160,"title":{"235":{}},"description":{"3":{},"29":{},"36":{},"290":{}}}],["timestamp",{"_index":858,"title":{},"description":{"235":{}}}],["timezon",{"_index":711,"title":{"111":{}},"description":{"111":{}}}],["to/from",{"_index":600,"title":{},"description":{"54":{}}}],["togeth",{"_index":753,"title":{},"description":{"154":{}}}],["token",{"_index":217,"title":{"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"201":{},"210":{}},"description":{"5":{},"8":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"201":{},"210":{}}}],["tokens](https://docs.mattermost.com/developer/personal-access-tokens.html",{"_index":283,"title":{},"description":{"5":{}}}],["total",{"_index":498,"title":{"17":{}},"description":{"17":{},"140":{}}}],["town",{"_index":702,"title":{},"description":{"108":{}}}],["track",{"_index":164,"title":{},"description":{"3":{}}}],["treat",{"_index":712,"title":{},"description":{"113":{},"148":{}}}],["tri",{"_index":589,"title":{},"description":{"45":{}}}],["trigger",{"_index":924,"title":{},"description":{"321":{}}}],["true",{"_index":541,"title":{},"description":{"30":{},"74":{},"224":{},"232":{}}}],["tue",{"_index":340,"title":{},"description":{"7":{}}}],["two",{"_index":692,"title":{},"description":{"106":{}}}],["type",{"_index":377,"title":{"108":{},"296":{}},"description":{"8":{},"10":{},"71":{},"76":{},"108":{},"161":{},"234":{},"236":{},"290":{},"296":{}}}],["typic",{"_index":483,"title":{},"description":{"15":{},"94":{},"135":{}}}],["unhealthi",{"_index":808,"title":{},"description":{"215":{}}}],["unless",{"_index":488,"title":{},"description":{"15":{}}}],["unpin",{"_index":757,"title":{"158":{}},"description":{"158":{}}}],["unread",{"_index":666,"title":{"95":{},"96":{},"140":{},"149":{},"155":{}},"description":{"95":{},"96":{},"140":{},"149":{},"155":{}}}],["unregist",{"_index":869,"title":{},"description":{"246":{}}}],["until",{"_index":290,"title":{},"description":{"5":{},"45":{},"175":{}}}],["up",{"_index":764,"title":{},"description":{"161":{},"215":{},"222":{}}}],["up-to-d",{"_index":29,"title":{},"description":{"1":{}}}],["updat",{"_index":135,"title":{"19":{},"22":{},"23":{},"30":{},"35":{},"54":{},"73":{},"93":{},"94":{},"113":{},"116":{},"134":{},"135":{},"136":{},"148":{},"175":{},"195":{},"200":{},"207":{},"221":{},"245":{}},"description":{"3":{},"19":{},"21":{},"22":{},"23":{},"25":{},"26":{},"29":{},"30":{},"35":{},"38":{},"39":{},"40":{},"54":{},"55":{},"58":{},"61":{},"73":{},"75":{},"93":{},"94":{},"113":{},"115":{},"116":{},"134":{},"135":{},"136":{},"137":{},"148":{},"150":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"175":{},"191":{},"195":{},"200":{},"202":{},"207":{},"245":{},"265":{},"274":{},"275":{},"307":{},"310":{},"312":{},"317":{},"323":{},"324":{}}}],["update_team",{"_index":426,"title":{},"description":{"8":{}}}],["upgrad",{"_index":116,"title":{},"description":{"3":{}}}],["upload",{"_index":758,"title":{"161":{},"226":{},"239":{},"252":{},"254":{},"256":{},"298":{}},"description":{"160":{},"161":{},"162":{},"163":{},"164":{},"165":{},"166":{},"226":{},"238":{},"239":{},"240":{},"252":{},"254":{},"256":{},"258":{},"297":{},"298":{},"302":{}}}],["upload_fil",{"_index":767,"title":{},"description":{"161":{}}}],["url",{"_index":172,"title":{"213":{},"218":{},"300":{}},"description":{"3":{},"123":{},"124":{},"213":{},"218":{},"300":{}}}],["us",{"_index":9,"title":{"318":{},"319":{}},"description":{"1":{},"2":{},"3":{},"5":{},"8":{},"9":{},"11":{},"16":{},"23":{},"29":{},"34":{},"43":{},"45":{},"46":{},"47":{},"48":{},"49":{},"51":{},"54":{},"74":{},"82":{},"84":{},"89":{},"125":{},"126":{},"154":{},"179":{},"182":{},"193":{},"197":{},"213":{},"218":{},"221":{},"233":{},"252":{},"253":{},"254":{},"255":{},"256":{},"257":{},"258":{},"263":{},"285":{},"292":{},"296":{},"313":{},"318":{},"319":{},"320":{},"321":{},"322":{}}}],["use_slash_command",{"_index":799,"title":{},"description":{"211":{}}}],["user",{"_index":87,"title":{"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"23":{},"28":{},"32":{},"33":{},"37":{},"39":{},"40":{},"43":{},"46":{},"47":{},"48":{},"49":{},"50":{},"55":{},"57":{},"65":{},"81":{},"82":{},"83":{},"84":{},"86":{},"95":{},"97":{},"130":{},"133":{},"138":{},"139":{},"172":{},"174":{},"175":{},"176":{},"276":{},"324":{}},"description":{"2":{},"3":{},"5":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"47":{},"48":{},"49":{},"50":{},"53":{},"55":{},"56":{},"57":{},"58":{},"65":{},"71":{},"74":{},"77":{},"79":{},"81":{},"82":{},"83":{},"84":{},"86":{},"87":{},"90":{},"95":{},"96":{},"97":{},"99":{},"100":{},"103":{},"106":{},"107":{},"109":{},"111":{},"114":{},"125":{},"126":{},"130":{},"131":{},"136":{},"137":{},"138":{},"139":{},"140":{},"142":{},"147":{},"149":{},"152":{},"155":{},"159":{},"167":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"181":{},"188":{},"189":{},"190":{},"229":{},"232":{},"243":{},"249":{},"260":{},"276":{},"324":{},"325":{}}}],["user'",{"_index":512,"title":{"22":{},"24":{},"25":{},"26":{},"27":{},"30":{},"35":{},"38":{},"42":{},"54":{},"56":{},"79":{},"168":{},"169":{},"170":{},"171":{},"325":{}},"description":{"22":{},"24":{},"25":{},"26":{},"29":{},"35":{},"36":{},"37":{},"45":{},"54":{},"55":{},"56":{},"97":{},"98":{},"107":{},"134":{},"136":{},"168":{},"169":{},"170":{},"171":{},"175":{},"249":{},"324":{},"325":{}}}],["user_ad",{"_index":427,"title":{},"description":{"8":{}}}],["user_id",{"_index":384,"title":{},"description":{"8":{},"24":{},"25":{},"26":{},"27":{},"81":{},"83":{}}}],["user_remov",{"_index":428,"title":{},"description":{"8":{}}}],["user_role_upd",{"_index":429,"title":{},"description":{"8":{}}}],["user_typ",{"_index":433,"title":{},"description":{"8":{}}}],["user_upd",{"_index":430,"title":{},"description":{"8":{}}}],["usernam",{"_index":227,"title":{"14":{},"28":{}},"description":{"5":{},"14":{},"15":{},"28":{},"53":{},"59":{},"109":{}}}],["users/tokens/en",{"_index":599,"title":{},"description":{"51":{}}}],["user’",{"_index":221,"title":{},"description":{"5":{}}}],["usign",{"_index":668,"title":{},"description":{"97":{},"98":{}}}],["utc",{"_index":332,"title":{},"description":{"7":{}}}],["v3",{"_index":101,"title":{},"description":{"3":{}}}],["v4",{"_index":112,"title":{},"description":{"3":{}}}],["v5.0",{"_index":104,"title":{},"description":{"3":{}}}],["v6.0",{"_index":610,"title":{},"description":{"56":{},"325":{}}}],["vaelor](https://github.com/vaelor",{"_index":206,"title":{},"description":{"4":{}}}],["valid",{"_index":515,"title":{"218":{}},"description":{"22":{},"30":{},"93":{},"217":{},"219":{},"287":{}}}],["valu",{"_index":478,"title":{},"description":{"13":{},"19":{},"102":{},"141":{},"175":{}}}],["variabl",{"_index":829,"title":{"224":{}},"description":{"224":{}}}],["variou",{"_index":902,"title":{},"description":{"291":{}}}],["veri",{"_index":284,"title":{},"description":{"5":{}}}],["verif",{"_index":575,"title":{"44":{}},"description":{"44":{}}}],["verifi",{"_index":573,"title":{"43":{}},"description":{"43":{}}}],["version",{"_index":147,"title":{},"description":{"3":{},"8":{},"11":{},"23":{},"74":{},"125":{},"126":{},"133":{},"161":{},"179":{},"221":{},"225":{},"240":{},"292":{},"293":{},"294":{},"295":{},"296":{},"321":{},"322":{}}}],["version](https://docs.mattermost.com/administration/changelog.html#contributor",{"_index":72,"title":{},"description":{"1":{}}}],["version__",{"_index":480,"title":{},"description":{"13":{},"26":{},"27":{},"32":{},"33":{},"40":{},"46":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"57":{},"59":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"90":{},"91":{},"92":{},"94":{},"98":{},"101":{},"102":{},"103":{},"109":{},"111":{},"116":{},"117":{},"118":{},"122":{},"123":{},"124":{},"126":{},"135":{},"141":{},"142":{},"149":{},"155":{},"182":{},"184":{},"185":{},"190":{},"206":{},"209":{},"213":{},"215":{},"218":{},"219":{},"224":{},"225":{},"226":{},"227":{},"233":{},"234":{},"235":{},"236":{},"263":{},"264":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"271":{},"272":{},"273":{},"274":{},"275":{},"276":{},"277":{},"278":{},"287":{},"288":{},"290":{},"298":{},"299":{},"300":{},"301":{},"302":{},"303":{},"304":{},"305":{},"306":{},"308":{},"309":{},"310":{},"311":{},"313":{},"314":{},"315":{},"316":{},"317":{},"318":{},"319":{},"324":{},"325":{}}}],["via",{"_index":708,"title":{},"description":{"108":{}}}],["view",{"_index":562,"title":{"137":{}},"description":{"37":{},"137":{}}}],["view_team",{"_index":491,"title":{},"description":{"15":{},"16":{},"72":{},"76":{},"80":{},"85":{},"87":{},"88":{},"90":{},"96":{},"110":{},"138":{},"139":{},"156":{},"205":{}}}],["visit",{"_index":140,"title":{},"description":{"3":{}}}],["void",{"_index":695,"title":{},"description":{"106":{},"138":{}}}],["want",{"_index":61,"title":{},"description":{"1":{},"21":{},"61":{},"75":{},"115":{},"150":{},"265":{},"274":{},"275":{},"310":{},"317":{}}}],["way",{"_index":192,"title":{},"description":{"4":{},"5":{}}}],["web",{"_index":6,"title":{},"description":{"1":{},"4":{},"8":{},"304":{}}}],["webapp",{"_index":359,"title":{"304":{}},"description":{"8":{}}}],["webhook",{"_index":785,"title":{"191":{},"192":{},"193":{},"194":{},"195":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{}},"description":{"191":{},"192":{},"193":{},"194":{},"195":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{}}}],["websocket",{"_index":343,"title":{"8":{}},"description":{"8":{}}}],["welcom",{"_index":45,"title":{},"description":{"1":{}}}],["well",{"_index":756,"title":{},"description":{"155":{},"306":{}}}],["went",{"_index":311,"title":{},"description":{"6":{}}}],["whenev",{"_index":322,"title":{},"description":{"7":{}}}],["whether",{"_index":319,"title":{},"description":{"6":{},"34":{}}}],["white-label",{"_index":861,"title":{},"description":{"237":{}}}],["whole",{"_index":550,"title":{},"description":{"32":{},"33":{}}}],["window",{"_index":236,"title":{},"description":{"5":{},"7":{}}}],["within",{"_index":909,"title":{},"description":{"298":{}}}],["without",{"_index":726,"title":{},"description":{"125":{},"126":{},"165":{}}}],["work",{"_index":25,"title":{},"description":{"1":{},"8":{},"29":{},"36":{}}}],["wrapper",{"_index":207,"title":{},"description":{"4":{}}}],["wrong",{"_index":312,"title":{},"description":{"6":{}}}],["x-ratelimit-limit",{"_index":257,"title":{},"description":{"5":{},"7":{}}}],["x-ratelimit-remain",{"_index":259,"title":{},"description":{"5":{},"7":{}}}],["x-ratelimit-reset",{"_index":261,"title":{},"description":{"5":{},"7":{}}}],["x-request-id",{"_index":262,"title":{},"description":{"5":{}}}],["x-version-id",{"_index":264,"title":{},"description":{"5":{}}}],["you'r",{"_index":235,"title":{},"description":{"5":{},"8":{},"35":{}}}],["your-mattermost-url.com/api/v4",{"_index":81,"title":{},"description":{"2":{}}}],["your-mattermost-url.com/api/v4/users/login",{"_index":219,"title":{},"description":{"5":{}}}]],"pipeline":[]}},"options":{}};
|
||
|
||
var container = document.getElementById('redoc');
|
||
Redoc.hydrate(__redoc_state, container);;
|
||
|
||
</script>
|
||
</body>
|
||
|
||
</html>
|