@approvio/api 0.0.26 → 0.0.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/add-group-entities-request.d.ts +1 -1
- package/dist/agent-challenge-request.d.ts +1 -1
- package/dist/agent-challenge-request.js +1 -1
- package/dist/agent-challenge-response.d.ts +1 -1
- package/dist/agent-challenge-response.js +1 -1
- package/dist/agent-get200-response.d.ts +1 -1
- package/dist/agent-get200-response.js +1 -1
- package/dist/agent-registration-request.d.ts +1 -1
- package/dist/agent-registration-request.js +1 -1
- package/dist/agent-registration-response.d.ts +1 -1
- package/dist/agent-registration-response.js +1 -1
- package/dist/agent-summary.d.ts +1 -1
- package/dist/agent-summary.js +1 -1
- package/dist/agent-token-request.d.ts +1 -1
- package/dist/agent-token-request.js +1 -1
- package/dist/agent-token-response.d.ts +1 -1
- package/dist/agent-token-response.js +1 -1
- package/dist/and-rule.d.ts +1 -1
- package/dist/api-error-details-inner.d.ts +1 -1
- package/dist/api-error-details-inner.js +1 -1
- package/dist/api-error.d.ts +1 -1
- package/dist/approval-rule.d.ts +1 -1
- package/dist/can-vote-response.d.ts +1 -1
- package/dist/can-vote-response.js +1 -1
- package/dist/email-action.d.ts +1 -1
- package/dist/email-action.js +1 -1
- package/dist/entity-membership-add.d.ts +1 -1
- package/dist/entity-membership-remove.d.ts +1 -1
- package/dist/entity-reference.d.ts +1 -1
- package/dist/entity-reference.js +1 -1
- package/dist/failed-auth-response.d.ts +1 -1
- package/dist/failed-auth-response.js +1 -1
- package/dist/get-entity-info-200-response.d.ts +1 -1
- package/dist/get-workflow-params.d.ts +1 -1
- package/dist/get-workflow-params.js +1 -1
- package/dist/get-workflow-votes-200-response.d.ts +1 -1
- package/dist/group-create.d.ts +1 -1
- package/dist/group-create.js +1 -1
- package/dist/group-info.d.ts +1 -1
- package/dist/group-info.js +1 -1
- package/dist/group-membership.d.ts +1 -1
- package/dist/group-requirement-rule.d.ts +1 -1
- package/dist/group-requirement-rule.js +1 -1
- package/dist/group-scope.d.ts +1 -1
- package/dist/group-scope.js +1 -1
- package/dist/group.d.ts +1 -1
- package/dist/group.js +1 -1
- package/dist/health-response.d.ts +1 -1
- package/dist/health-response.js +1 -1
- package/dist/index.d.ts +4 -0
- package/dist/index.html +628 -96
- package/dist/index.js +4 -0
- package/dist/index.js.map +1 -1
- package/dist/initiate-cli-login-200-response.d.ts +14 -0
- package/dist/initiate-cli-login-200-response.js +14 -0
- package/dist/initiate-cli-login-200-response.js.map +1 -0
- package/dist/initiate-cli-login-request.d.ts +17 -0
- package/dist/initiate-cli-login-request.js +14 -0
- package/dist/initiate-cli-login-request.js.map +1 -0
- package/dist/list-agents-200-response.d.ts +1 -1
- package/dist/list-agents-params.d.ts +1 -1
- package/dist/list-agents-params.js +1 -1
- package/dist/list-group-entities-200-response.d.ts +1 -1
- package/dist/list-groups-200-response.d.ts +1 -1
- package/dist/list-organization-admins-for-org-200-response.d.ts +1 -1
- package/dist/list-role-templates-200-response.d.ts +1 -1
- package/dist/list-spaces-200-response.d.ts +1 -1
- package/dist/list-users-200-response.d.ts +1 -1
- package/dist/list-workflow-templates-200-response.d.ts +1 -1
- package/dist/list-workflow-templates-params.d.ts +25 -0
- package/dist/list-workflow-templates-params.js +14 -0
- package/dist/list-workflow-templates-params.js.map +1 -0
- package/dist/list-workflows-200-response.d.ts +1 -1
- package/dist/list-workflows-params.d.ts +5 -1
- package/dist/list-workflows-params.js +1 -1
- package/dist/models.d.ts +4 -2
- package/dist/models.js +4 -2
- package/dist/models.js.map +1 -1
- package/dist/oidc-callback-request.d.ts +21 -0
- package/dist/oidc-callback-request.js +14 -0
- package/dist/oidc-callback-request.js.map +1 -0
- package/dist/or-rule.d.ts +1 -1
- package/dist/org-scope.d.ts +1 -1
- package/dist/org-scope.js +1 -1
- package/dist/organization-admin-create.d.ts +1 -1
- package/dist/organization-admin-create.js +1 -1
- package/dist/organization-admin-remove.d.ts +1 -1
- package/dist/organization-admin-remove.js +1 -1
- package/dist/organization-admin.d.ts +1 -1
- package/dist/organization-admin.js +1 -1
- package/dist/pagination.d.ts +1 -1
- package/dist/pagination.js +1 -1
- package/dist/privileged-token-exchange-request.d.ts +1 -1
- package/dist/privileged-token-exchange-request.js +1 -1
- package/dist/privileged-token-response.d.ts +2 -2
- package/dist/privileged-token-response.js +1 -1
- package/dist/refresh-token-request.d.ts +1 -1
- package/dist/refresh-token-request.js +1 -1
- package/dist/remove-group-entities-request.d.ts +1 -1
- package/dist/role-assignment-request.d.ts +1 -1
- package/dist/role-operation-item.d.ts +1 -1
- package/dist/role-operation-request.d.ts +1 -1
- package/dist/role-removal-request.d.ts +1 -1
- package/dist/role-scope.d.ts +1 -1
- package/dist/role-template.d.ts +1 -1
- package/dist/role-template.js +1 -1
- package/dist/space-create.d.ts +1 -1
- package/dist/space-create.js +1 -1
- package/dist/space-scope.d.ts +1 -1
- package/dist/space-scope.js +1 -1
- package/dist/space.d.ts +1 -1
- package/dist/space.js +1 -1
- package/dist/successful-auth-response.d.ts +1 -1
- package/dist/successful-auth-response.js +1 -1
- package/dist/token-request.d.ts +1 -1
- package/dist/token-request.js +1 -1
- package/dist/token-response.d.ts +1 -1
- package/dist/token-response.js +1 -1
- package/dist/user-create.d.ts +1 -1
- package/dist/user-create.js +1 -1
- package/dist/user-summary.d.ts +1 -1
- package/dist/user-summary.js +1 -1
- package/dist/user.d.ts +1 -1
- package/dist/user.js +1 -1
- package/dist/vote-approve.d.ts +1 -1
- package/dist/vote-approve.js +1 -1
- package/dist/vote-veto.d.ts +1 -1
- package/dist/vote-veto.js +1 -1
- package/dist/vote-withdraw.d.ts +1 -1
- package/dist/vote-withdraw.js +1 -1
- package/dist/webhook-action.d.ts +1 -1
- package/dist/webhook-action.js +1 -1
- package/dist/workflow-action.d.ts +1 -1
- package/dist/workflow-create.d.ts +1 -1
- package/dist/workflow-create.js +1 -1
- package/dist/workflow-ref.d.ts +1 -1
- package/dist/workflow-template-create.d.ts +1 -1
- package/dist/workflow-template-deprecate.d.ts +1 -1
- package/dist/workflow-template-deprecate.js +1 -1
- package/dist/workflow-template-scope.d.ts +1 -1
- package/dist/workflow-template-scope.js +1 -1
- package/dist/workflow-template-summary.d.ts +1 -1
- package/dist/workflow-template-summary.js +1 -1
- package/dist/workflow-template-update.d.ts +1 -1
- package/dist/workflow-template.d.ts +1 -1
- package/dist/workflow-vote-request-vote-type.d.ts +1 -1
- package/dist/workflow-vote-request.d.ts +1 -1
- package/dist/workflow-vote.d.ts +1 -1
- package/dist/workflow-vote.js +1 -1
- package/dist/workflow.d.ts +1 -1
- package/package.json +1 -1
package/dist/index.html
CHANGED
|
@@ -48,15 +48,15 @@ data-styled.g13[id="sc-eqYatC"]{content:"czjApA,"}/*!sc*/
|
|
|
48
48
|
h1:hover>.fRdsOi::before,h2:hover>.fRdsOi::before,.fRdsOi:hover::before{visibility:visible;}/*!sc*/
|
|
49
49
|
data-styled.g14[id="sc-kcLKEh"]{content:"fRdsOi,"}/*!sc*/
|
|
50
50
|
.dUlzCe{height:18px;width:18px;min-width:18px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
|
51
|
-
.FtowP{height:1.3em;width:1.3em;min-width:1.3em;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
|
52
|
-
.cGxVlA{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
|
53
|
-
.cGxVlA polygon{fill:#1d8127;}/*!sc*/
|
|
54
51
|
.jKYZgc{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
|
55
52
|
.jKYZgc polygon{fill:#d41f1c;}/*!sc*/
|
|
56
53
|
.iuNpUs{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(0);}/*!sc*/
|
|
57
54
|
.iuNpUs polygon{fill:white;}/*!sc*/
|
|
58
55
|
.dOPmTa{height:18px;width:18px;min-width:18px;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
|
59
|
-
|
|
56
|
+
.cGxVlA{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
|
57
|
+
.cGxVlA polygon{fill:#1d8127;}/*!sc*/
|
|
58
|
+
.FtowP{height:1.3em;width:1.3em;min-width:1.3em;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
|
59
|
+
data-styled.g15[id="sc-dntSTA"]{content:"dUlzCe,jKYZgc,iuNpUs,dOPmTa,cGxVlA,FtowP,"}/*!sc*/
|
|
60
60
|
.gdmNWp{border-left:1px solid #7c7cbb;box-sizing:border-box;position:relative;padding:10px 10px 10px 0;}/*!sc*/
|
|
61
61
|
@media screen and (max-width: 50rem){.gdmNWp{display:block;overflow:hidden;}}/*!sc*/
|
|
62
62
|
tr:first-of-type>.gdmNWp,tr.last>.gdmNWp{border-left-width:0;background-position:top left;background-repeat:no-repeat;background-size:1px 100%;}/*!sc*/
|
|
@@ -159,31 +159,6 @@ data-styled.g41[id="sc-dNFkOE"]{content:"cFlAeY,"}/*!sc*/
|
|
|
159
159
|
.kbZred a{text-decoration:auto;color:#32329f;}/*!sc*/
|
|
160
160
|
.kbZred a:visited{color:#32329f;}/*!sc*/
|
|
161
161
|
.kbZred a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
|
|
162
|
-
.drqpJr{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
|
|
163
|
-
.drqpJr p:last-child{margin-bottom:0;}/*!sc*/
|
|
164
|
-
.drqpJr p:first-child{margin-top:0;}/*!sc*/
|
|
165
|
-
.drqpJr p:last-child{margin-bottom:0;}/*!sc*/
|
|
166
|
-
.drqpJr h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
|
|
167
|
-
.drqpJr h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
|
|
168
|
-
.drqpJr code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
|
|
169
|
-
.drqpJr pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
|
|
170
|
-
.drqpJr pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
|
|
171
|
-
.drqpJr pre code:before,.drqpJr pre code:after{content:none;}/*!sc*/
|
|
172
|
-
.drqpJr blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
|
|
173
|
-
.drqpJr img{max-width:100%;box-sizing:content-box;}/*!sc*/
|
|
174
|
-
.drqpJr ul,.drqpJr ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
|
|
175
|
-
.drqpJr ul ul,.drqpJr ol ul,.drqpJr ul ol,.drqpJr ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
|
|
176
|
-
.drqpJr table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
|
|
177
|
-
.drqpJr table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
|
|
178
|
-
.drqpJr table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
|
|
179
|
-
.drqpJr table th,.drqpJr table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
|
|
180
|
-
.drqpJr table th{text-align:left;font-weight:bold;}/*!sc*/
|
|
181
|
-
.drqpJr .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
|
|
182
|
-
.drqpJr .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
|
|
183
|
-
.drqpJr h1:hover>.share-link::before,.drqpJr h2:hover>.share-link::before,.drqpJr .share-link:hover::before{visibility:visible;}/*!sc*/
|
|
184
|
-
.drqpJr a{text-decoration:auto;color:#32329f;}/*!sc*/
|
|
185
|
-
.drqpJr a:visited{color:#32329f;}/*!sc*/
|
|
186
|
-
.drqpJr a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
|
|
187
162
|
.jnwENr{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
|
|
188
163
|
.jnwENr p:last-child{margin-bottom:0;}/*!sc*/
|
|
189
164
|
.jnwENr p:first-child{margin-top:0;}/*!sc*/
|
|
@@ -210,7 +185,32 @@ data-styled.g41[id="sc-dNFkOE"]{content:"cFlAeY,"}/*!sc*/
|
|
|
210
185
|
.jnwENr a{text-decoration:auto;color:#32329f;}/*!sc*/
|
|
211
186
|
.jnwENr a:visited{color:#32329f;}/*!sc*/
|
|
212
187
|
.jnwENr a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
|
|
213
|
-
|
|
188
|
+
.drqpJr{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
|
|
189
|
+
.drqpJr p:last-child{margin-bottom:0;}/*!sc*/
|
|
190
|
+
.drqpJr p:first-child{margin-top:0;}/*!sc*/
|
|
191
|
+
.drqpJr p:last-child{margin-bottom:0;}/*!sc*/
|
|
192
|
+
.drqpJr h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
|
|
193
|
+
.drqpJr h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
|
|
194
|
+
.drqpJr code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
|
|
195
|
+
.drqpJr pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
|
|
196
|
+
.drqpJr pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
|
|
197
|
+
.drqpJr pre code:before,.drqpJr pre code:after{content:none;}/*!sc*/
|
|
198
|
+
.drqpJr blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
|
|
199
|
+
.drqpJr img{max-width:100%;box-sizing:content-box;}/*!sc*/
|
|
200
|
+
.drqpJr ul,.drqpJr ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
|
|
201
|
+
.drqpJr ul ul,.drqpJr ol ul,.drqpJr ul ol,.drqpJr ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
|
|
202
|
+
.drqpJr table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
|
|
203
|
+
.drqpJr table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
|
|
204
|
+
.drqpJr table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
|
|
205
|
+
.drqpJr table th,.drqpJr table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
|
|
206
|
+
.drqpJr table th{text-align:left;font-weight:bold;}/*!sc*/
|
|
207
|
+
.drqpJr .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
|
|
208
|
+
.drqpJr .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
|
|
209
|
+
.drqpJr h1:hover>.share-link::before,.drqpJr h2:hover>.share-link::before,.drqpJr .share-link:hover::before{visibility:visible;}/*!sc*/
|
|
210
|
+
.drqpJr a{text-decoration:auto;color:#32329f;}/*!sc*/
|
|
211
|
+
.drqpJr a:visited{color:#32329f;}/*!sc*/
|
|
212
|
+
.drqpJr a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
|
|
213
|
+
data-styled.g42[id="sc-fszimp"]{content:"kbZred,jnwENr,drqpJr,"}/*!sc*/
|
|
214
214
|
.ljKHqG{display:inline;}/*!sc*/
|
|
215
215
|
data-styled.g43[id="sc-etsjJW"]{content:"ljKHqG,"}/*!sc*/
|
|
216
216
|
.iNCOCX{position:relative;}/*!sc*/
|
|
@@ -337,11 +337,11 @@ data-styled.g112[id="sc-jvKoal"]{content:"kZcHWP,"}/*!sc*/
|
|
|
337
337
|
.iPCVMX ..sc-jvKoal{color:#ffffff;}/*!sc*/
|
|
338
338
|
.iPCVMX:focus{box-shadow:inset 0 2px 2px rgba(0, 0, 0, 0.45),0 2px 0 rgba(128, 128, 128, 0.25);}/*!sc*/
|
|
339
339
|
data-styled.g113[id="sc-buTqWO"]{content:"iPCVMX,"}/*!sc*/
|
|
340
|
-
.kwcmyC{font-size:0.929em;line-height:20px;background-color:#186FAF;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
|
341
340
|
.dynMBc{font-size:0.929em;line-height:20px;background-color:#2F8132;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
|
341
|
+
.kwcmyC{font-size:0.929em;line-height:20px;background-color:#186FAF;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
|
342
342
|
.dBzsUh{font-size:0.929em;line-height:20px;background-color:#95507c;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
|
343
343
|
.gKcHYQ{font-size:0.929em;line-height:20px;background-color:#cc3333;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
|
344
|
-
data-styled.g114[id="sc-fQLpxn"]{content:"kwcmyC,
|
|
344
|
+
data-styled.g114[id="sc-fQLpxn"]{content:"dynMBc,kwcmyC,dBzsUh,gKcHYQ,"}/*!sc*/
|
|
345
345
|
.ga-DQLq{position:absolute;width:100%;z-index:100;background:#fafafa;color:#263238;box-sizing:border-box;box-shadow:0 0 6px rgba(0, 0, 0, 0.33);overflow:hidden;border-bottom-left-radius:4px;border-bottom-right-radius:4px;transition:all 0.25s ease;visibility:hidden;transform:translateY(-50%) scaleY(0);}/*!sc*/
|
|
346
346
|
data-styled.g115[id="sc-ecJghI"]{content:"ga-DQLq,"}/*!sc*/
|
|
347
347
|
.icOxsG{padding:10px;}/*!sc*/
|
|
@@ -351,15 +351,21 @@ data-styled.g116[id="sc-iyBeIh"]{content:"icOxsG,"}/*!sc*/
|
|
|
351
351
|
data-styled.g117[id="sc-xKhEK"]{content:"okJpy,"}/*!sc*/
|
|
352
352
|
.foplsk{text-transform:lowercase;margin-left:0;line-height:1.5em;}/*!sc*/
|
|
353
353
|
data-styled.g118[id="sc-eTCgfj"]{content:"foplsk,"}/*!sc*/
|
|
354
|
-
.
|
|
355
|
-
.
|
|
354
|
+
.edHaWS{text-transform:lowercase;margin-left:0;line-height:1.5em;color:#666;font-size:0.9em;}/*!sc*/
|
|
355
|
+
data-styled.g119[id="sc-fmLCLE"]{content:"edHaWS,"}/*!sc*/
|
|
356
|
+
.cnQweL{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#ffa500;background-color:rgba(255,165,0,0.1);cursor:default;}/*!sc*/
|
|
357
|
+
.cnQweL:focus{outline:auto #ffa500;}/*!sc*/
|
|
358
|
+
.cnQweL::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/
|
|
359
|
+
.cnQweL:focus{outline:0;}/*!sc*/
|
|
356
360
|
.ifAHvq{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#d41f1c;background-color:rgba(212,31,28,0.07);}/*!sc*/
|
|
357
361
|
.ifAHvq:focus{outline:auto #d41f1c;}/*!sc*/
|
|
362
|
+
.lkmdtA{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);}/*!sc*/
|
|
363
|
+
.lkmdtA:focus{outline:auto #1d8127;}/*!sc*/
|
|
358
364
|
.oZuve{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);cursor:default;}/*!sc*/
|
|
359
365
|
.oZuve:focus{outline:auto #1d8127;}/*!sc*/
|
|
360
366
|
.oZuve::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/
|
|
361
367
|
.oZuve:focus{outline:0;}/*!sc*/
|
|
362
|
-
data-styled.g120[id="sc-jIDBmd"]{content:"
|
|
368
|
+
data-styled.g120[id="sc-jIDBmd"]{content:"cnQweL,ifAHvq,lkmdtA,oZuve,"}/*!sc*/
|
|
363
369
|
.fBhAXU{vertical-align:top;}/*!sc*/
|
|
364
370
|
data-styled.g123[id="sc-eJvlPh"]{content:"fBhAXU,"}/*!sc*/
|
|
365
371
|
.kjrVcG{font-size:1.3em;padding:0.2em 0;margin:3em 0 1.1em;color:#333333;font-weight:normal;}/*!sc*/
|
|
@@ -399,7 +405,7 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
399
405
|
|
|
400
406
|
<body>
|
|
401
407
|
|
|
402
|
-
<div id="redoc"><div class="sc-Pgsbw eHdqcJ redoc-wrap"><div class="sc-fstJre dsiHUZ menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-iRcyzz gzMPIt"><svg class="sc-enPhjR SikXG 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 placeholder="Search..." aria-label="Search" type="text" class="sc-lhsSio iOkeQy search-input" value=""/></div><div class="sc-eknHtZ ghzOpX scrollbar-container undefined"><ul role="menu" class="sc-zOxLx gAPKXX"><li tabindex="0" depth="1" data-item-id="tag/Workflows" role="menuitem" aria-label="Workflows" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Workflows" class="sc-gWaSiO cxcra">Workflows</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Workflows/operation/createWorkflow" role="menuitem" aria-label="Create a new workflow" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Create a new workflow</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflows/operation/listWorkflows" role="menuitem" aria-label="List workflows" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List workflows</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflows/operation/getWorkflow" role="menuitem" aria-label="Get workflow details" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get workflow details</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Workflow-Templates" role="menuitem" aria-label="Workflow Templates" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Workflow Templates" class="sc-gWaSiO cxcra">Workflow Templates</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Workflow-Templates/operation/createWorkflowTemplate" role="menuitem" aria-label="Create a new workflow template" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Create a new workflow template</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflow-Templates/operation/listWorkflowTemplates" role="menuitem" aria-label="List workflow templates" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List workflow templates</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflow-Templates/operation/getWorkflowTemplate" role="menuitem" aria-label="Get workflow template details" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get workflow template details</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflow-Templates/operation/updateWorkflowTemplate" role="menuitem" aria-label="Update a workflow template" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="put" class="sc-jxYSNo NmQLu operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Update a workflow template</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflow-Templates/operation/deleteWorkflowTemplate" role="menuitem" aria-label="Delete a workflow template" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="delete" class="sc-jxYSNo NmQLu operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Delete a workflow template</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Users" role="menuitem" aria-label="Users" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Users" class="sc-gWaSiO cxcra">Users</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Users/operation/createUser" role="menuitem" aria-label="Create a new user" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Create a new user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/listUsers" role="menuitem" aria-label="List users" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List users</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/getUser" role="menuitem" aria-label="Get user details" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get user details</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/listGroupEntities" role="menuitem" aria-label="List entities in a group" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List entities in a group</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/addGroupEntities" role="menuitem" aria-label="Add group entities" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Add group entities</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/removeGroupEntities" role="menuitem" aria-label="Remove group entities" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="delete" class="sc-jxYSNo NmQLu operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Remove group entities</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Groups" role="menuitem" aria-label="Groups" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Groups" class="sc-gWaSiO cxcra">Groups</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/createGroup" role="menuitem" aria-label="Create a new approver group" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Create a new approver group</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/listGroups" role="menuitem" aria-label="List groups" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List groups</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/getGroup" role="menuitem" aria-label="Get group details" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get group details</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/listGroupEntities" role="menuitem" aria-label="List entities in a group" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List entities in a group</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/addGroupEntities" role="menuitem" aria-label="Add group entities" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Add group entities</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/removeGroupEntities" role="menuitem" aria-label="Remove group entities" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="delete" class="sc-jxYSNo NmQLu operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Remove group entities</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Workflow-Actions" role="menuitem" aria-label="Workflow Actions" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Workflow Actions" class="sc-gWaSiO cxcra">Workflow Actions</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Workflow-Actions/operation/voteOnWorkflow" role="menuitem" aria-label="Vote on a workflow" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Vote on a workflow</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflow-Actions/operation/canVoteOnWorkflow" role="menuitem" aria-label="Check if the current entity can vote on a workflow" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Check if the current entity can vote on a workflow</span></label></li></ul></li></ul><div class="sc-kSaXSp QuyG"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-jOlHRD bovaLG"><div class="sc-cZnrqW crXcHD"><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="
|
|
408
|
+
<div id="redoc"><div class="sc-Pgsbw eHdqcJ redoc-wrap"><div class="sc-fstJre dsiHUZ menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-iRcyzz gzMPIt"><svg class="sc-enPhjR SikXG 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 placeholder="Search..." aria-label="Search" type="text" class="sc-lhsSio iOkeQy search-input" value=""/></div><div class="sc-eknHtZ ghzOpX scrollbar-container undefined"><ul role="menu" class="sc-zOxLx gAPKXX"><li tabindex="0" depth="1" data-item-id="tag/Authentication" role="menuitem" aria-label="Authentication" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Authentication" class="sc-gWaSiO cxcra">Authentication</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/initiateLogin" role="menuitem" aria-label="Initiate OIDC login" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Initiate OIDC login</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/handleCallback" role="menuitem" aria-label="Handle OIDC callback" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Handle OIDC callback</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/exchangeToken" role="menuitem" aria-label="Exchange authorization code for JWT token" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Exchange authorization code for JWT token</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/refreshUserToken" role="menuitem" aria-label="Refresh JWT token" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Refresh JWT token</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/authSuccess" role="menuitem" aria-label="Authentication success page" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Authentication success page</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/authError" role="menuitem" aria-label="Authentication error page" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Authentication error page</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/initiateCliLogin" role="menuitem" aria-label="Initiate OIDC login for CLI" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Initiate OIDC login for CLI</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/webCallback" role="menuitem" aria-label="Handle Web OIDC callback" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Handle Web OIDC callback</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/refreshUserTokenWeb" role="menuitem" aria-label="Refresh Web JWT token" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Refresh Web JWT token</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/initiatePrivilegeTokenWeb" role="menuitem" aria-label="Initiate Web privilege token generation (step-up)" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Initiate Web privilege token generation (step-up)</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/exchangePrivilegeTokenWeb" role="menuitem" aria-label="Exchange Web privilege token" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Exchange Web privilege token</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/initiatePrivilegedTokenExchange" role="menuitem" aria-label="Initiate privilege token generation (step-up)" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Initiate privilege token generation (step-up)</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/exchangePrivilegedToken" role="menuitem" aria-label="Exchange privilege token" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Exchange privilege token</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/getEntityInfo" role="menuitem" aria-label="Get authenticated entity information" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get authenticated entity information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/generateAgentChallenge" role="menuitem" aria-label="Generate authentication challenge for agent" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Generate authentication challenge for agent</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/exchangeAgentToken" role="menuitem" aria-label="Exchange JWT assertion for access token" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Exchange JWT assertion for access token</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Authentication/operation/refreshAgentToken" role="menuitem" aria-label="Refresh agent JWT token" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Refresh agent JWT token</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Workflows" role="menuitem" aria-label="Workflows" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Workflows" class="sc-gWaSiO cxcra">Workflows</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Workflows/operation/createWorkflow" role="menuitem" aria-label="Create a new workflow" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Create a new workflow</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflows/operation/listWorkflows" role="menuitem" aria-label="List workflows" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List workflows</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflows/operation/getWorkflow" role="menuitem" aria-label="Get workflow details" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get workflow details</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Workflow-Templates" role="menuitem" aria-label="Workflow Templates" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Workflow Templates" class="sc-gWaSiO cxcra">Workflow Templates</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Workflow-Templates/operation/createWorkflowTemplate" role="menuitem" aria-label="Create a new workflow template" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Create a new workflow template</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflow-Templates/operation/listWorkflowTemplates" role="menuitem" aria-label="List workflow templates" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List workflow templates</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflow-Templates/operation/getWorkflowTemplate" role="menuitem" aria-label="Get workflow template details" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get workflow template details</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflow-Templates/operation/updateWorkflowTemplate" role="menuitem" aria-label="Update a workflow template" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="put" class="sc-jxYSNo NmQLu operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Update a workflow template</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflow-Templates/operation/deprecateWorkflowTemplate" role="menuitem" aria-label="Deprecate a workflow template" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Deprecate a workflow template</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Users" role="menuitem" aria-label="Users" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Users" class="sc-gWaSiO cxcra">Users</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Users/operation/createUser" role="menuitem" aria-label="Create a new user" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Create a new user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/listUsers" role="menuitem" aria-label="List users" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List users</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/getUser" role="menuitem" aria-label="Get user details" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get user details</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/assignUserRoles" role="menuitem" aria-label="Assign roles to a user" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="put" class="sc-jxYSNo NmQLu operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Assign roles to a user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/removeUserRoles" role="menuitem" aria-label="Remove roles from a user" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="delete" class="sc-jxYSNo NmQLu operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Remove roles from a user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/listGroupEntities" role="menuitem" aria-label="List entities in a group" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List entities in a group</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/addGroupEntities" role="menuitem" aria-label="Add group entities" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Add group entities</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Users/operation/removeGroupEntities" role="menuitem" aria-label="Remove group entities" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="delete" class="sc-jxYSNo NmQLu operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Remove group entities</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Groups" role="menuitem" aria-label="Groups" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Groups" class="sc-gWaSiO cxcra">Groups</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/createGroup" role="menuitem" aria-label="Create a new approver group" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Create a new approver group</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/listGroups" role="menuitem" aria-label="List groups" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List groups</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/getGroup" role="menuitem" aria-label="Get group details" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get group details</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/listGroupEntities" role="menuitem" aria-label="List entities in a group" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List entities in a group</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/addGroupEntities" role="menuitem" aria-label="Add group entities" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Add group entities</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Groups/operation/removeGroupEntities" role="menuitem" aria-label="Remove group entities" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="delete" class="sc-jxYSNo NmQLu operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Remove group entities</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Spaces" role="menuitem" aria-label="Spaces" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Spaces" class="sc-gWaSiO cxcra">Spaces</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Spaces/operation/createSpace" role="menuitem" aria-label="Create a new space" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Create a new space</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spaces/operation/listSpaces" role="menuitem" aria-label="List spaces" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List spaces</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spaces/operation/getSpace" role="menuitem" aria-label="Get space details" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get space details</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spaces/operation/deleteSpace" role="menuitem" aria-label="Delete a space" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="delete" class="sc-jxYSNo NmQLu operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Delete a space</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Organization-Admins" role="menuitem" aria-label="Organization Admins" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Organization Admins" class="sc-gWaSiO cxcra">Organization Admins</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Organization-Admins/operation/addOrganizationAdminToOrg" role="menuitem" aria-label="Add organization administrator" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Add organization administrator</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Organization-Admins/operation/listOrganizationAdminsForOrg" role="menuitem" aria-label="List organization administrators" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List organization administrators</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Organization-Admins/operation/removeOrganizationAdminFromOrg" role="menuitem" aria-label="Remove organization administrator" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="delete" class="sc-jxYSNo NmQLu operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Remove organization administrator</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Workflow-Actions" role="menuitem" aria-label="Workflow Actions" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Workflow Actions" class="sc-gWaSiO cxcra">Workflow Actions</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Workflow-Actions/operation/voteOnWorkflow" role="menuitem" aria-label="Vote on a workflow" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Vote on a workflow</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflow-Actions/operation/getWorkflowVotes" role="menuitem" aria-label="Retrieve votes for a workflow" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Retrieve votes for a workflow</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workflow-Actions/operation/canVoteOnWorkflow" role="menuitem" aria-label="Check if the current entity can vote on a workflow" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Check if the current entity can vote on a workflow</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Agents" role="menuitem" aria-label="Agents" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Agents" class="sc-gWaSiO cxcra">Agents</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Agents/operation/listAgents" role="menuitem" aria-label="List agents" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List agents</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Agents/operation/registerAgent" role="menuitem" aria-label="Register a new agent" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="post" class="sc-jxYSNo NmQLu operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Register a new agent</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Agents/operation/getAgent" role="menuitem" aria-label="Get agent details" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Get agent details</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Agents/operation/assignAgentRoles" role="menuitem" aria-label="Assign roles to an agent" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="put" class="sc-jxYSNo NmQLu operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Assign roles to an agent</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Agents/operation/removeAgentRoles" role="menuitem" aria-label="Remove roles from an agent" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="delete" class="sc-jxYSNo NmQLu operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Remove roles from an agent</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Roles" role="menuitem" aria-label="Roles" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Roles" class="sc-gWaSiO cxcra">Roles</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Roles/operation/assignAgentRoles" role="menuitem" aria-label="Assign roles to an agent" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="put" class="sc-jxYSNo NmQLu operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Assign roles to an agent</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Roles/operation/removeAgentRoles" role="menuitem" aria-label="Remove roles from an agent" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="delete" class="sc-jxYSNo NmQLu operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Remove roles from an agent</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Roles/operation/listRoleTemplates" role="menuitem" aria-label="List predefined role templates" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">List predefined role templates</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Roles/operation/assignUserRoles" role="menuitem" aria-label="Assign roles to a user" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="put" class="sc-jxYSNo NmQLu operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Assign roles to a user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Roles/operation/removeUserRoles" role="menuitem" aria-label="Remove roles from a user" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="delete" class="sc-jxYSNo NmQLu operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Remove roles from a user</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Health" role="menuitem" aria-label="Health" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz lgPGwq -depth1"><span width="calc(100% - 38px)" title="Health" class="sc-gWaSiO cxcra">Health</span><svg class="sc-dntSTA dUlzCe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-zOxLx dQnkdy"><li tabindex="0" depth="2" data-item-id="tag/Health/operation/healthCheck" role="menuitem" aria-label="Health check" aria-expanded="false" class="sc-cgHfjM ixknQI"><label class="sc-fpikKz iHRgeo -depth2"><span type="get" class="sc-jxYSNo NmQLu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-gWaSiO cxcra">Health check</span></label></li></ul></li></ul><div class="sc-kSaXSp QuyG"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-jOlHRD bovaLG"><div class="sc-cZnrqW crXcHD"><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="
|
|
403
409
|
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
|
|
404
410
|
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
|
|
405
411
|
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
|
|
@@ -417,9 +423,265 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
417
423
|
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
|
|
418
424
|
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
|
|
419
425
|
-104.0616 -231.873,-231.248 z
|
|
420
|
-
" fill="currentColor"></path></g></svg></div></div><div class="sc-fkYqBV buanwU api-content"><div class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU api-info"><h1 class="sc-hwkwBN sc-jCWzJg wYHiz hPcPCj">Workflow Approval System API<!-- --> <span>(<!-- -->0.0.
|
|
426
|
+
" fill="currentColor"></path></g></svg></div></div><div class="sc-fkYqBV buanwU api-content"><div class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU api-info"><h1 class="sc-hwkwBN sc-jCWzJg wYHiz hPcPCj">Workflow Approval System API<!-- --> <span>(<!-- -->0.0.28<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div data-role="redoc-summary" html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div data-role="redoc-description" html="<p>API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.</p>
|
|
421
427
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.</p>
|
|
422
|
-
</div></div></div></div><div id="tag/
|
|
428
|
+
</div></div></div></div><div id="tag/Authentication" data-section-id="tag/Authentication" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication" aria-label="tag/Authentication"></a>Authentication</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>OIDC authentication and token management</p>
|
|
429
|
+
"><p>OIDC authentication and token management</p>
|
|
430
|
+
</div></div></div><div id="tag/Authentication/operation/initiateLogin" data-section-id="tag/Authentication/operation/initiateLogin" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/initiateLogin" id="operation/initiateLogin" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/initiateLogin" aria-label="tag/Authentication/operation/initiateLogin"></a>Initiate OIDC login<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Initiates OIDC authentication by generating PKCE challenge and redirecting to the OIDC provider</p>
|
|
431
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Initiates OIDC authentication by generating PKCE challenge and redirecting to the OIDC provider</p>
|
|
432
|
+
</div></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd cnQweL" disabled=""><strong class="sc-eJvlPh fBhAXU">302<!-- --> </strong><div html="<p>Redirect to OIDC provider for authentication</p>
|
|
433
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Redirect to OIDC provider for authentication</p>
|
|
434
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">500<!-- --> </strong><div html="<p>Failed to initiate login</p>
|
|
435
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Failed to initiate login</p>
|
|
436
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/auth/login</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/login</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R9p1gq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9p1gq»0" tabindex="0" data-rttab="true">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9p1gq»0" aria-labelledby="tab«R9p1gq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Authentication/operation/handleCallback" data-section-id="tag/Authentication/operation/handleCallback" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/handleCallback" id="operation/handleCallback" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/handleCallback" aria-label="tag/Authentication/operation/handleCallback"></a>Handle OIDC callback<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Handles the callback from OIDC provider and redirects to success page with authorization code</p>
|
|
437
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Handles the callback from OIDC provider and redirects to success page with authorization code</p>
|
|
438
|
+
</div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="query" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand query"><span class="property-name">query</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">object</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->OidcCallbackRequest<!-- -->) </span></div> <div><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd cnQweL" disabled=""><strong class="sc-eJvlPh fBhAXU">302<!-- --> </strong><div html="<p>Redirect to success page with code and state parameters</p>
|
|
439
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Redirect to success page with code and state parameters</p>
|
|
440
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Missing required parameters</p>
|
|
441
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Missing required parameters</p>
|
|
442
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/auth/callback</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/callback</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R9p2gq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9p2gq»0" tabindex="0" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9p2gq»0" aria-labelledby="tab«R9p2gq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Authentication/operation/exchangeToken" data-section-id="tag/Authentication/operation/exchangeToken" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/exchangeToken" id="operation/exchangeToken" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/exchangeToken" aria-label="tag/Authentication/operation/exchangeToken"></a>Exchange authorization code for JWT token<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Exchanges the authorization code and state for a JWT token containing user information and roles</p>
|
|
443
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Exchanges the authorization code and state for a JWT token containing user information and roles</p>
|
|
444
|
+
</div></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="code" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">code</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Authorization code received from OIDC provider</p>
|
|
445
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Authorization code received from OIDC provider</p>
|
|
446
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="state" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">state</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>State parameter used for CSRF protection</p>
|
|
447
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>State parameter used for CSRF protection</p>
|
|
448
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>JWT token generated successfully</p>
|
|
449
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>JWT token generated successfully</p>
|
|
450
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
451
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
452
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
453
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
454
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/auth/token</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/token</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R993gq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R993gq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R993gq»0" aria-labelledby="tab«R993gq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</span>: <span class="token string">"auth_code_123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">"state_123"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R9p3gq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9p3gq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R9p3gq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R9p3gq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R9p3gq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R9p3gq»2" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9p3gq»0" aria-labelledby="tab«R9p3gq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"accessToken"</span>: <span class="token string">"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"refreshToken"</span>: <span class="token string">"sd8Axmi9Xkalsmcd..."</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9p3gq»1" aria-labelledby="tab«R9p3gq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9p3gq»2" aria-labelledby="tab«R9p3gq»2"></div></div></div></div></div></div><div id="tag/Authentication/operation/refreshUserToken" data-section-id="tag/Authentication/operation/refreshUserToken" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/refreshUserToken" id="operation/refreshUserToken" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/refreshUserToken" aria-label="tag/Authentication/operation/refreshUserToken"></a>Refresh JWT token<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Exchanges a refresh token for a new pair of access and refresh tokens</p>
|
|
455
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Exchanges a refresh token for a new pair of access and refresh tokens</p>
|
|
456
|
+
</div></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="refreshToken" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">refreshToken</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Refresh token used to obtain a new access token</p>
|
|
457
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Refresh token used to obtain a new access token</p>
|
|
458
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Tokens refreshed successfully</p>
|
|
459
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Tokens refreshed successfully</p>
|
|
460
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
461
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
462
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Invalid or expired refresh token</p>
|
|
463
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid or expired refresh token</p>
|
|
464
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/auth/refresh</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/refresh</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R994gq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R994gq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R994gq»0" aria-labelledby="tab«R994gq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"refreshToken"</span>: <span class="token string">"sd8Axmi9Xkalsmcd..."</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R9p4gq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9p4gq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R9p4gq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R9p4gq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R9p4gq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R9p4gq»2" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9p4gq»0" aria-labelledby="tab«R9p4gq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"accessToken"</span>: <span class="token string">"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"refreshToken"</span>: <span class="token string">"sd8Axmi9Xkalsmcd..."</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9p4gq»1" aria-labelledby="tab«R9p4gq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9p4gq»2" aria-labelledby="tab«R9p4gq»2"></div></div></div></div></div></div><div id="tag/Authentication/operation/authSuccess" data-section-id="tag/Authentication/operation/authSuccess" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/authSuccess" id="operation/authSuccess" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/authSuccess" aria-label="tag/Authentication/operation/authSuccess"></a>Authentication success page<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns success message for completed authentication</p>
|
|
465
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns success message for completed authentication</p>
|
|
466
|
+
</div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="query" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand query"><span class="property-name">query</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">object</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->OidcCallbackRequest<!-- -->) </span></div> <div><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Authentication successful</p>
|
|
467
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication successful</p>
|
|
468
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/auth/success</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/success</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R9p5gq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9p5gq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9p5gq»0" aria-labelledby="tab«R9p5gq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"Authentication successful. Use the code and state to generate a JWT token."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"code"</span>: <span class="token string">"auth_code_123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">"state_123"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"b64encoded"</span>: <span class="token string">"YXV0aF9jb2RlXzEyMzpzdGF0ZV8xMjM="</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Authentication/operation/authError" data-section-id="tag/Authentication/operation/authError" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/authError" id="operation/authError" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/authError" aria-label="tag/Authentication/operation/authError"></a>Authentication error page<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns error message for failed authentication</p>
|
|
469
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns error message for failed authentication</p>
|
|
470
|
+
</div></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Authentication failed</p>
|
|
471
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication failed</p>
|
|
472
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/auth/error</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/error</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R9p6gq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9p6gq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9p6gq»0" aria-labelledby="tab«R9p6gq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"Authentication failed."</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Authentication/operation/initiateCliLogin" data-section-id="tag/Authentication/operation/initiateCliLogin" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/initiateCliLogin" id="operation/initiateCliLogin" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/initiateCliLogin" aria-label="tag/Authentication/operation/initiateCliLogin"></a>Initiate OIDC login for CLI<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Initiates OIDC authentication specifying a loopback redirect URI for the CLI</p>
|
|
473
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Initiates OIDC authentication specifying a loopback redirect URI for the CLI</p>
|
|
474
|
+
</div></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="redirectUri" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">redirectUri</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The local loopback URL to redirect the user to after authentication</p>
|
|
475
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The local loopback URL to redirect the user to after authentication</p>
|
|
476
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Authorization URL generated</p>
|
|
477
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authorization URL generated</p>
|
|
478
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
479
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
480
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/auth/cli/initiate</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/cli/initiate</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R997gq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R997gq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R997gq»0" aria-labelledby="tab«R997gq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"redirectUri"</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-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R9p7gq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9p7gq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R9p7gq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R9p7gq»1" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9p7gq»0" aria-labelledby="tab«R9p7gq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"authorizationUrl"</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="panel«R9p7gq»1" aria-labelledby="tab«R9p7gq»1"></div></div></div></div></div></div><div id="tag/Authentication/operation/webCallback" data-section-id="tag/Authentication/operation/webCallback" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/webCallback" id="operation/webCallback" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/webCallback" aria-label="tag/Authentication/operation/webCallback"></a>Handle Web OIDC callback<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Exchanges authorization code for tokens and sets them as HttpOnly cookies, then redirects to frontend</p>
|
|
481
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Exchanges authorization code for tokens and sets them as HttpOnly cookies, then redirects to frontend</p>
|
|
482
|
+
</div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="query" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand query"><span class="property-name">query</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">object</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->OidcCallbackRequest<!-- -->) </span></div> <div><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd cnQweL" disabled=""><strong class="sc-eJvlPh fBhAXU">302<!-- --> </strong><div html="<p>Redirect to the frontend depending on success or failure of the auth exchange</p>
|
|
483
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Redirect to the frontend depending on success or failure of the auth exchange</p>
|
|
484
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/auth/web/callback</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/web/callback</div></div></div></div></div></div></div></div><div id="tag/Authentication/operation/refreshUserTokenWeb" data-section-id="tag/Authentication/operation/refreshUserTokenWeb" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/refreshUserTokenWeb" id="operation/refreshUserTokenWeb" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/refreshUserTokenWeb" aria-label="tag/Authentication/operation/refreshUserTokenWeb"></a>Refresh Web JWT token<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Takes the refresh_token from the HttpOnly cookie and issues a new pair of tokens as cookies</p>
|
|
485
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Takes the refresh_token from the HttpOnly cookie and issues a new pair of tokens as cookies</p>
|
|
486
|
+
</div></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd oZuve" disabled=""><strong class="sc-eJvlPh fBhAXU">204<!-- --> </strong><div html="<p>Tokens refreshed successfully, set as cookies</p>
|
|
487
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Tokens refreshed successfully, set as cookies</p>
|
|
488
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
489
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
490
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Invalid or expired refresh token</p>
|
|
491
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid or expired refresh token</p>
|
|
492
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/auth/web/refresh</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/web/refresh</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R9p9gq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9p9gq»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R9p9gq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R9p9gq»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9p9gq»0" aria-labelledby="tab«R9p9gq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9p9gq»1" aria-labelledby="tab«R9p9gq»1"></div></div></div></div></div></div><div id="tag/Authentication/operation/initiatePrivilegeTokenWeb" data-section-id="tag/Authentication/operation/initiatePrivilegeTokenWeb" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/initiatePrivilegeTokenWeb" id="operation/initiatePrivilegeTokenWeb" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/initiatePrivilegeTokenWeb" aria-label="tag/Authentication/operation/initiatePrivilegeTokenWeb"></a>Initiate Web privilege token generation (step-up)<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Initiates step-up authentication flow returning the authorization URL as JSON.</p>
|
|
493
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Initiates step-up authentication flow returning the authorization URL as JSON.</p>
|
|
494
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Authorization URL generated</p>
|
|
495
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authorization URL generated</p>
|
|
496
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
497
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
498
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">500<!-- --> </strong><div html="<p>Failed to initiate step-up</p>
|
|
499
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Failed to initiate step-up</p>
|
|
500
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/auth/web/initiatePrivilegedTokenExchange</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/web/initiatePrivilegedTokenExchange</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R9pagq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9pagq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R9pagq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pagq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R9pagq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pagq»2" data-rttab="true">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9pagq»0" aria-labelledby="tab«R9pagq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"authorizationUrl"</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="panel«R9pagq»1" aria-labelledby="tab«R9pagq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9pagq»2" aria-labelledby="tab«R9pagq»2"></div></div></div></div></div></div><div id="tag/Authentication/operation/exchangePrivilegeTokenWeb" data-section-id="tag/Authentication/operation/exchangePrivilegeTokenWeb" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/exchangePrivilegeTokenWeb" id="operation/exchangePrivilegeTokenWeb" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/exchangePrivilegeTokenWeb" aria-label="tag/Authentication/operation/exchangePrivilegeTokenWeb"></a>Exchange Web privilege token<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Exchanges an IDP token for a high-privilege step-up token and sets it as an HttpOnly cookie.</p>
|
|
501
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Exchanges an IDP token for a high-privilege step-up token and sets it as an HttpOnly cookie.</p>
|
|
502
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="code" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">code</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The authorization code returned from the IDP</p>
|
|
503
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The authorization code returned from the IDP</p>
|
|
504
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="state" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">state</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The state parameter returned from the IDP</p>
|
|
505
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The state parameter returned from the IDP</p>
|
|
506
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="resourceId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">resourceId</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The identifier of the resource being accessed</p>
|
|
507
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The identifier of the resource being accessed</p>
|
|
508
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="operation" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">operation</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->PrivilegedOperation<!-- -->) </span></div> <div><div html="<p>The operation requiring high privilege authentication</p>
|
|
509
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The operation requiring high privilege authentication</p>
|
|
510
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd oZuve" disabled=""><strong class="sc-eJvlPh fBhAXU">204<!-- --> </strong><div html="<p>Privilege token set as cookie successfully</p>
|
|
511
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Privilege token set as cookie successfully</p>
|
|
512
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
513
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
514
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
515
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
516
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/auth/web/exchangePrivilegedToken</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/web/exchangePrivilegedToken</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R99bgq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R99bgq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R99bgq»0" aria-labelledby="tab«R99bgq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"resourceId"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"operation"</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-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R9pbgq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9pbgq»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R9pbgq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pbgq»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9pbgq»0" aria-labelledby="tab«R9pbgq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9pbgq»1" aria-labelledby="tab«R9pbgq»1"></div></div></div></div></div></div><div id="tag/Authentication/operation/initiatePrivilegedTokenExchange" data-section-id="tag/Authentication/operation/initiatePrivilegedTokenExchange" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/initiatePrivilegedTokenExchange" id="operation/initiatePrivilegedTokenExchange" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/initiatePrivilegedTokenExchange" aria-label="tag/Authentication/operation/initiatePrivilegedTokenExchange"></a>Initiate privilege token generation (step-up)<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Initiates the step-up authentication flow by generating an authorization URL for the IDP provider.</p>
|
|
517
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Initiates the step-up authentication flow by generating an authorization URL for the IDP provider.</p>
|
|
518
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd cnQweL" disabled=""><strong class="sc-eJvlPh fBhAXU">302<!-- --> </strong><div html="<p>Redirect to IDP for step-up authentication</p>
|
|
519
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Redirect to IDP for step-up authentication</p>
|
|
520
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
521
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
522
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">500<!-- --> </strong><div html="<p>Failed to initiate step-up</p>
|
|
523
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Failed to initiate step-up</p>
|
|
524
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/auth/initiatePrivilegedTokenExchange</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/initiatePrivilegedTokenExchange</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R9pcgq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9pcgq»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R9pcgq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pcgq»1" data-rttab="true">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9pcgq»0" aria-labelledby="tab«R9pcgq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9pcgq»1" aria-labelledby="tab«R9pcgq»1"></div></div></div></div></div></div><div id="tag/Authentication/operation/exchangePrivilegedToken" data-section-id="tag/Authentication/operation/exchangePrivilegedToken" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/exchangePrivilegedToken" id="operation/exchangePrivilegedToken" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/exchangePrivilegedToken" aria-label="tag/Authentication/operation/exchangePrivilegedToken"></a>Exchange privilege token<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Exchanges an IDP token for a high-privilege step-up token.</p>
|
|
525
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Exchanges an IDP token for a high-privilege step-up token.</p>
|
|
526
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="code" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">code</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The authorization code returned from the IDP</p>
|
|
527
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The authorization code returned from the IDP</p>
|
|
528
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="state" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">state</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The state parameter returned from the IDP</p>
|
|
529
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The state parameter returned from the IDP</p>
|
|
530
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="resourceId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">resourceId</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The identifier of the resource being accessed</p>
|
|
531
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The identifier of the resource being accessed</p>
|
|
532
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="operation" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">operation</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->PrivilegedOperation<!-- -->) </span></div> <div><div html="<p>The operation requiring high privilege authentication</p>
|
|
533
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The operation requiring high privilege authentication</p>
|
|
534
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Privilege token generated successfully</p>
|
|
535
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Privilege token generated successfully</p>
|
|
536
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
537
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
538
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
539
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
540
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/auth/exchangePrivilegedToken</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/exchangePrivilegedToken</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R99dgq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R99dgq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R99dgq»0" aria-labelledby="tab«R99dgq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"resourceId"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"operation"</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-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R9pdgq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9pdgq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R9pdgq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pdgq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R9pdgq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pdgq»2" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9pdgq»0" aria-labelledby="tab«R9pdgq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"accessToken"</span>: <span class="token string">"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9pdgq»1" aria-labelledby="tab«R9pdgq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9pdgq»2" aria-labelledby="tab«R9pdgq»2"></div></div></div></div></div></div><div id="tag/Authentication/operation/getEntityInfo" data-section-id="tag/Authentication/operation/getEntityInfo" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/getEntityInfo" id="operation/getEntityInfo" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/getEntityInfo" aria-label="tag/Authentication/operation/getEntityInfo"></a>Get authenticated entity information<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns basic information about the authenticated entity</p>
|
|
541
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns basic information about the authenticated entity</p>
|
|
542
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Entity information retrieved successfully</p>
|
|
543
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Entity information retrieved successfully</p>
|
|
544
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
545
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
546
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/auth/info</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/info</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R9pegq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9pegq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R9pegq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pegq»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9pegq»0" aria-labelledby="tab«R9pegq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"entityType"</span>: <span class="token string">"user"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"groups"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"groupId"</span>: <span class="token string">"eb54e96e-21b8-4f54-9cd4-80fccbd06f55"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"groupName"</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="panel«R9pegq»1" aria-labelledby="tab«R9pegq»1"></div></div></div></div></div></div><div id="tag/Authentication/operation/generateAgentChallenge" data-section-id="tag/Authentication/operation/generateAgentChallenge" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/generateAgentChallenge" id="operation/generateAgentChallenge" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/generateAgentChallenge" aria-label="tag/Authentication/operation/generateAgentChallenge"></a>Generate authentication challenge for agent<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Creates an encrypted challenge that must be signed by the agent to obtain a token.</p>
|
|
547
|
+
<p><strong>Challenge Format (Server → Agent):</strong>
|
|
548
|
+
The server generates a challenge encrypted with the agent&#39;s public key. When decrypted and base64 decoded, it contains a JSON object with:</p>
|
|
549
|
+
<ul>
|
|
550
|
+
<li><code>audience</code>: string (agent name)</li>
|
|
551
|
+
<li><code>expires_at</code>: ISO 8601 formatted date-time string</li>
|
|
552
|
+
<li><code>issuer</code>: string (the name of the SaaS platform, e.g., &quot;Approvio&quot;)</li>
|
|
553
|
+
<li><code>nonce</code>: a random string to ensure uniqueness (the actual challenge)</li>
|
|
554
|
+
</ul>
|
|
555
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Creates an encrypted challenge that must be signed by the agent to obtain a token.</p>
|
|
556
|
+
<p><strong>Challenge Format (Server → Agent):</strong>
|
|
557
|
+
The server generates a challenge encrypted with the agent's public key. When decrypted and base64 decoded, it contains a JSON object with:</p>
|
|
558
|
+
<ul>
|
|
559
|
+
<li><code>audience</code>: string (agent name)</li>
|
|
560
|
+
<li><code>expires_at</code>: ISO 8601 formatted date-time string</li>
|
|
561
|
+
<li><code>issuer</code>: string (the name of the SaaS platform, e.g., "Approvio")</li>
|
|
562
|
+
<li><code>nonce</code>: a random string to ensure uniqueness (the actual challenge)</li>
|
|
563
|
+
</ul>
|
|
564
|
+
</div></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="agentName" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">agentName</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Name of the agent requesting authentication</p>
|
|
565
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Name of the agent requesting authentication</p>
|
|
566
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Challenge generated successfully</p>
|
|
567
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Challenge generated successfully</p>
|
|
568
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
569
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
570
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Agent not found</p>
|
|
571
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Agent not found</p>
|
|
572
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/auth/agents/challenge</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/agents/challenge</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R99fgq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R99fgq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R99fgq»0" aria-labelledby="tab«R99fgq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"agentName"</span>: <span class="token string">"ci-deployment-agent"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R9pfgq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9pfgq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R9pfgq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pfgq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R9pfgq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pfgq»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9pfgq»0" aria-labelledby="tab«R9pfgq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"challenge"</span>: <span class="token string">"eyJhdWRpZW5jZSI6ImNpLWRlcGxveW1lbnQtYWdlbnQiLCJleHBpcmVzX2F0IjoiMjAyNS0wNC0xNVQxMjoxNTowMFoiLCJpc3N1ZXIiOiJBcHByb3ZpbyIsIm5vbmNlIjoiYWJjZGVmZ2hpams5ODc2NTQzMjEifQ=="</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9pfgq»1" aria-labelledby="tab«R9pfgq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9pfgq»2" aria-labelledby="tab«R9pfgq»2"></div></div></div></div></div></div><div id="tag/Authentication/operation/exchangeAgentToken" data-section-id="tag/Authentication/operation/exchangeAgentToken" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/exchangeAgentToken" id="operation/exchangeAgentToken" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/exchangeAgentToken" aria-label="tag/Authentication/operation/exchangeAgentToken"></a>Exchange JWT assertion for access token<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Validates a JWT assertion and returns a JWT access token for the authenticated agent using OAuth 2.0 JWT Bearer profile (RFC 7523).</p>
|
|
573
|
+
<p><strong>JWT Assertion Requirements:</strong>
|
|
574
|
+
The agent must create and sign a JWT assertion with their private key containing:</p>
|
|
575
|
+
<ul>
|
|
576
|
+
<li><code>iss</code> (issuer): Agent name</li>
|
|
577
|
+
<li><code>sub</code> (subject): Agent name (same as issuer for client authentication)</li>
|
|
578
|
+
<li><code>aud</code> (audience): Authorization server identifier </li>
|
|
579
|
+
<li><code>exp</code> (expiration): JWT expiration time (Unix timestamp)</li>
|
|
580
|
+
<li><code>jti</code> (JWT ID): Unique nonce from the server&#39;s challenge (prevents replay attacks)</li>
|
|
581
|
+
<li><code>iat</code> (issued at): JWT issued time (Unix timestamp, optional)</li>
|
|
582
|
+
</ul>
|
|
583
|
+
<p><strong>Security Notes:</strong></p>
|
|
584
|
+
<ul>
|
|
585
|
+
<li>JWT must be signed with RS256 algorithm using the agent&#39;s private key</li>
|
|
586
|
+
<li>Server verifies signature using agent&#39;s registered public key</li>
|
|
587
|
+
<li>Each challenge nonce can only be used once (replay protection)</li>
|
|
588
|
+
<li>Agent identity is extracted from the JWT issuer claim</li>
|
|
589
|
+
</ul>
|
|
590
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Validates a JWT assertion and returns a JWT access token for the authenticated agent using OAuth 2.0 JWT Bearer profile (RFC 7523).</p>
|
|
591
|
+
<p><strong>JWT Assertion Requirements:</strong>
|
|
592
|
+
The agent must create and sign a JWT assertion with their private key containing:</p>
|
|
593
|
+
<ul>
|
|
594
|
+
<li><code>iss</code> (issuer): Agent name</li>
|
|
595
|
+
<li><code>sub</code> (subject): Agent name (same as issuer for client authentication)</li>
|
|
596
|
+
<li><code>aud</code> (audience): Authorization server identifier </li>
|
|
597
|
+
<li><code>exp</code> (expiration): JWT expiration time (Unix timestamp)</li>
|
|
598
|
+
<li><code>jti</code> (JWT ID): Unique nonce from the server's challenge (prevents replay attacks)</li>
|
|
599
|
+
<li><code>iat</code> (issued at): JWT issued time (Unix timestamp, optional)</li>
|
|
600
|
+
</ul>
|
|
601
|
+
<p><strong>Security Notes:</strong></p>
|
|
602
|
+
<ul>
|
|
603
|
+
<li>JWT must be signed with RS256 algorithm using the agent's private key</li>
|
|
604
|
+
<li>Server verifies signature using agent's registered public key</li>
|
|
605
|
+
<li>Each challenge nonce can only be used once (replay protection)</li>
|
|
606
|
+
<li>Agent identity is extracted from the JWT issuer claim</li>
|
|
607
|
+
</ul>
|
|
608
|
+
</div></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="grantType" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">grantType</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Value<!-- -->:</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">"urn:ietf:params:oauth:grant-type:jwt-bearer"</span> </div> <div><div html="<p>OAuth 2.0 grant type for JWT Bearer profile</p>
|
|
609
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>OAuth 2.0 grant type for JWT Bearer profile</p>
|
|
610
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="clientAssertionType" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">clientAssertionType</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Value<!-- -->:</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">"urn:ietf:params:oauth:client-assertion-type:jwt-bearer"</span> </div> <div><div html="<p>OAuth 2.0 client assertion type for JWT Bearer profile</p>
|
|
611
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>OAuth 2.0 client assertion type for JWT Bearer profile</p>
|
|
612
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="clientAssertion" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">clientAssertion</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>JWT assertion signed with the agent&#39;s private key using RS256 algorithm.</p>
|
|
613
|
+
<p><strong>JWT Header:</strong></p>
|
|
614
|
+
<pre><code class="language-json"><span class="token punctuation">{</span>
|
|
615
|
+
<span class="token string-property property">"alg"</span><span class="token operator">:</span> <span class="token string">"RS256"</span><span class="token punctuation">,</span>
|
|
616
|
+
<span class="token string-property property">"typ"</span><span class="token operator">:</span> <span class="token string">"JWT"</span>
|
|
617
|
+
<span class="token punctuation">}</span>
|
|
618
|
+
</code></pre>
|
|
619
|
+
<p><strong>JWT Payload:</strong></p>
|
|
620
|
+
<pre><code class="language-json"><span class="token punctuation">{</span>
|
|
621
|
+
<span class="token string-property property">"iss"</span><span class="token operator">:</span> <span class="token string">"agent-name"</span><span class="token punctuation">,</span>
|
|
622
|
+
<span class="token string-property property">"sub"</span><span class="token operator">:</span> <span class="token string">"agent-name"</span><span class="token punctuation">,</span>
|
|
623
|
+
<span class="token string-property property">"aud"</span><span class="token operator">:</span> <span class="token string">"authorization-server-identifier"</span><span class="token punctuation">,</span>
|
|
624
|
+
<span class="token string-property property">"exp"</span><span class="token operator">:</span> <span class="token number">1640995200</span><span class="token punctuation">,</span>
|
|
625
|
+
<span class="token string-property property">"jti"</span><span class="token operator">:</span> <span class="token string">"nonce-from-challenge"</span><span class="token punctuation">,</span>
|
|
626
|
+
<span class="token string-property property">"iat"</span><span class="token operator">:</span> <span class="token number">1640991600</span>
|
|
627
|
+
<span class="token punctuation">}</span>
|
|
628
|
+
</code></pre>
|
|
629
|
+
<p><strong>Requirements:</strong></p>
|
|
630
|
+
<ul>
|
|
631
|
+
<li>Must be signed with agent&#39;s private key using RS256</li>
|
|
632
|
+
<li>JWT ID (jti) must match nonce from server&#39;s challenge</li>
|
|
633
|
+
<li>Issuer (iss) and subject (sub) must be the agent name</li>
|
|
634
|
+
<li>Audience (aud) must be the authorization server identifier</li>
|
|
635
|
+
<li>Agent identity is extracted from the issuer claim</li>
|
|
636
|
+
</ul>
|
|
637
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>JWT assertion signed with the agent's private key using RS256 algorithm.</p>
|
|
638
|
+
<p><strong>JWT Header:</strong></p>
|
|
639
|
+
<pre><code class="language-json"><span class="token punctuation">{</span>
|
|
640
|
+
<span class="token string-property property">"alg"</span><span class="token operator">:</span> <span class="token string">"RS256"</span><span class="token punctuation">,</span>
|
|
641
|
+
<span class="token string-property property">"typ"</span><span class="token operator">:</span> <span class="token string">"JWT"</span>
|
|
642
|
+
<span class="token punctuation">}</span>
|
|
643
|
+
</code></pre>
|
|
644
|
+
<p><strong>JWT Payload:</strong></p>
|
|
645
|
+
<pre><code class="language-json"><span class="token punctuation">{</span>
|
|
646
|
+
<span class="token string-property property">"iss"</span><span class="token operator">:</span> <span class="token string">"agent-name"</span><span class="token punctuation">,</span>
|
|
647
|
+
<span class="token string-property property">"sub"</span><span class="token operator">:</span> <span class="token string">"agent-name"</span><span class="token punctuation">,</span>
|
|
648
|
+
<span class="token string-property property">"aud"</span><span class="token operator">:</span> <span class="token string">"authorization-server-identifier"</span><span class="token punctuation">,</span>
|
|
649
|
+
<span class="token string-property property">"exp"</span><span class="token operator">:</span> <span class="token number">1640995200</span><span class="token punctuation">,</span>
|
|
650
|
+
<span class="token string-property property">"jti"</span><span class="token operator">:</span> <span class="token string">"nonce-from-challenge"</span><span class="token punctuation">,</span>
|
|
651
|
+
<span class="token string-property property">"iat"</span><span class="token operator">:</span> <span class="token number">1640991600</span>
|
|
652
|
+
<span class="token punctuation">}</span>
|
|
653
|
+
</code></pre>
|
|
654
|
+
<p><strong>Requirements:</strong></p>
|
|
655
|
+
<ul>
|
|
656
|
+
<li>Must be signed with agent's private key using RS256</li>
|
|
657
|
+
<li>JWT ID (jti) must match nonce from server's challenge</li>
|
|
658
|
+
<li>Issuer (iss) and subject (sub) must be the agent name</li>
|
|
659
|
+
<li>Audience (aud) must be the authorization server identifier</li>
|
|
660
|
+
<li>Agent identity is extracted from the issuer claim</li>
|
|
661
|
+
</ul>
|
|
662
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>JWT token generated successfully</p>
|
|
663
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>JWT token generated successfully</p>
|
|
664
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
665
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
666
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Invalid or expired challenge</p>
|
|
667
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid or expired challenge</p>
|
|
668
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Agent not found</p>
|
|
669
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Agent not found</p>
|
|
670
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">409<!-- --> </strong><div html="<p>Challenge already used</p>
|
|
671
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Challenge already used</p>
|
|
672
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/auth/agents/token</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/agents/token</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R99ggq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R99ggq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R99ggq»0" aria-labelledby="tab«R99ggq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"grantType"</span>: <span class="token string">"urn:ietf:params:oauth:grant-type:jwt-bearer"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"clientAssertionType"</span>: <span class="token string">"urn:ietf:params:oauth:client-assertion-type:jwt-bearer"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"clientAssertion"</span>: <span class="token string">"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJjaS1kZXBsb3ltZW50LWFnZW50Iiwic3ViIjoiY2ktZGVwbG95bWVudC1hZ2VudCIsImF1ZCI6IkFwcHJvdmlvIiwiZXhwIjoxNjQwOTk1MjAwLCJqdGkiOiJhYmNkZWZnaGlqazk4NzY1NDMyMSIsImlhdCI6MTY0MDk5MTYwMH0.signature"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R9pggq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9pggq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R9pggq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pggq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R9pggq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pggq»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R9pggq»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pggq»3" data-rttab="true">404</li><li class="tab-error" role="tab" id="tab«R9pggq»4" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pggq»4" data-rttab="true">409</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9pggq»0" aria-labelledby="tab«R9pggq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"accessToken"</span>: <span class="token string">"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjaS1kZXBsb3ltZW50LWFnZW50IiwiZW50aXR5VHlwZSI6ImFnZW50IiwiaWF0IjoxNjc4OTAxMjAwLCJleHAiOjE2Nzg5ODc2MDB9.signature"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"refreshToken"</span>: <span class="token string">"sd8Axmi9Xkalsmcd..."</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9pggq»1" aria-labelledby="tab«R9pggq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9pggq»2" aria-labelledby="tab«R9pggq»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9pggq»3" aria-labelledby="tab«R9pggq»3"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9pggq»4" aria-labelledby="tab«R9pggq»4"></div></div></div></div></div></div><div id="tag/Authentication/operation/refreshAgentToken" data-section-id="tag/Authentication/operation/refreshAgentToken" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/refreshAgentToken" id="operation/refreshAgentToken" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Authentication/operation/refreshAgentToken" aria-label="tag/Authentication/operation/refreshAgentToken"></a>Refresh agent JWT token<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Exchanges a refresh token for a new pair of access and refresh tokens. Requires DPoP proof.</p>
|
|
673
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Exchanges a refresh token for a new pair of access and refresh tokens. Requires DPoP proof.</p>
|
|
674
|
+
</div></div><div><h5 class="sc-eqYatC czjApA">header<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="DPoP" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">DPoP</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>DPoP proof based on RFC 9449</p>
|
|
675
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>DPoP proof based on RFC 9449</p>
|
|
676
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="refreshToken" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">refreshToken</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Refresh token used to obtain a new access token</p>
|
|
677
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Refresh token used to obtain a new access token</p>
|
|
678
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Tokens refreshed successfully</p>
|
|
679
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Tokens refreshed successfully</p>
|
|
680
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
681
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
682
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Invalid or expired refresh token, or DPoP mismatch</p>
|
|
683
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid or expired refresh token, or DPoP mismatch</p>
|
|
684
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/auth/agents/refresh</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/auth/agents/refresh</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R99hgq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R99hgq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R99hgq»0" aria-labelledby="tab«R99hgq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"refreshToken"</span>: <span class="token string">"sd8Axmi9Xkalsmcd..."</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R9phgq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9phgq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R9phgq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R9phgq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R9phgq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R9phgq»2" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9phgq»0" aria-labelledby="tab«R9phgq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"accessToken"</span>: <span class="token string">"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjaS1kZXBsb3ltZW50LWFnZW50IiwiZW50aXR5VHlwZSI6ImFnZW50IiwiaWF0IjoxNjc4OTAxMjAwLCJleHAiOjE2Nzg5ODc2MDB9.signature"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"refreshToken"</span>: <span class="token string">"sd8Axmi9Xkalsmcd..."</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9phgq»1" aria-labelledby="tab«R9phgq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9phgq»2" aria-labelledby="tab«R9phgq»2"></div></div></div></div></div></div><div id="tag/Workflows" data-section-id="tag/Workflows" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflows" aria-label="tag/Workflows"></a>Workflows</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>Workflow management and approval</p>
|
|
423
685
|
"><p>Workflow management and approval</p>
|
|
424
686
|
</div></div></div><div id="tag/Workflows/operation/createWorkflow" data-section-id="tag/Workflows/operation/createWorkflow" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/createWorkflow" id="operation/createWorkflow" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflows/operation/createWorkflow" aria-label="tag/Workflows/operation/createWorkflow"></a>Create a new workflow<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Creates a new workflow with approvers and rules</p>
|
|
425
687
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Creates a new workflow with approvers and rules</p>
|
|
@@ -437,31 +699,23 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
437
699
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
438
700
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
439
701
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
440
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/workflows</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflows</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«
|
|
702
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/workflows</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflows</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R155ha»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R155ha»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R155ha»0" aria-labelledby="tab«R155ha»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"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">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"workflowTemplateId"</span>: <span class="token string">"53e62d87-459b-4f1f-ae45-ffe2549e140f"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R175ha»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R175ha»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R175ha»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R175ha»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R175ha»0" aria-labelledby="tab«R175ha»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R175ha»1" aria-labelledby="tab«R175ha»1"></div></div></div></div></div></div><div id="tag/Workflows/operation/listWorkflows" data-section-id="tag/Workflows/operation/listWorkflows" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listWorkflows" id="operation/listWorkflows" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflows/operation/listWorkflows" aria-label="tag/Workflows/operation/listWorkflows"></a>List workflows<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of workflows with optional filtering</p>
|
|
441
703
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of workflows with optional filtering</p>
|
|
442
|
-
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="
|
|
443
|
-
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Page number for pagination</p>
|
|
444
|
-
</div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">limit</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">20</span></div> <div><div html="<p>Number of results per page</p>
|
|
445
|
-
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Number of results per page</p>
|
|
446
|
-
</div></div></div></td></tr><tr class="last "><td kind="field" title="include" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">include</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">strings</span></div><div><span class="sc-bEjUoa lhyyLL">Items<!-- --> <!-- -->Value<!-- -->:</span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">"workflow-template"</span> </div> <div><div html="<p>Comma-separated list of related objects to include in the response</p>
|
|
447
|
-
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Comma-separated list of related objects to include in the response</p>
|
|
448
|
-
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>List of workflows</p>
|
|
704
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="params" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand params"><span class="property-name">params</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">object</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->ListWorkflowsParams<!-- -->) </span></div> <div><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>List of workflows</p>
|
|
449
705
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>List of workflows</p>
|
|
450
706
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
451
707
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
452
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/workflows</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflows</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«Rjj8q»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Rjj8q»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«Rjj8q»1" aria-selected="false" aria-disabled="false" aria-controls="panel«Rjj8q»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Rjj8q»0" aria-labelledby="tab«Rjj8q»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"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">"workflowTemplateId"</span>: <span class="token string">"53e62d87-459b-4f1f-ae45-ffe2549e140f"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ref"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"workflowTemplate"</span>: <button class="collapser" aria-label="expand"></button><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">"approvalRule"</span>: <button class="collapser" aria-label="expand"></button><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">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token keyword">null</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">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"actions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</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">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expiresAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</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">"pagination"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"limit"</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="panel«Rjj8q»1" aria-labelledby="tab«Rjj8q»1"></div></div></div></div></div></div><div id="tag/Workflows/operation/getWorkflow" data-section-id="tag/Workflows/operation/getWorkflow" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/getWorkflow" id="operation/getWorkflow" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflows/operation/getWorkflow" aria-label="tag/Workflows/operation/getWorkflow"></a>Get workflow details<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns the details of a specific workflow</p>
|
|
708
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/workflows</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflows</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R176ha»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R176ha»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R176ha»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R176ha»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R176ha»0" aria-labelledby="tab«R176ha»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"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">"workflowTemplateId"</span>: <span class="token string">"53e62d87-459b-4f1f-ae45-ffe2549e140f"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ref"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"workflowTemplate"</span>: <button class="collapser" aria-label="expand"></button><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">"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">"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">"status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"allowVotingOnDeprecatedTemplate"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"approvalRule"</span>: <button class="collapser" aria-label="expand"></button><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">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token keyword">null</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">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"actions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"spaceId"</span>: <span class="token string">"a330a273-e64a-4183-aedb-f3152797a9a5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</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">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expiresAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</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">"pagination"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"limit"</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="panel«R176ha»1" aria-labelledby="tab«R176ha»1"></div></div></div></div></div></div><div id="tag/Workflows/operation/getWorkflow" data-section-id="tag/Workflows/operation/getWorkflow" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/getWorkflow" id="operation/getWorkflow" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflows/operation/getWorkflow" aria-label="tag/Workflows/operation/getWorkflow"></a>Get workflow details<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns the details of a specific workflow</p>
|
|
453
709
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns the details of a specific workflow</p>
|
|
454
|
-
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="workflowId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">workflowId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The unique identifier of the workflow</p>
|
|
455
|
-
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the workflow</p>
|
|
456
|
-
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="
|
|
457
|
-
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Comma-separated list of related objects to include in the response</p>
|
|
458
|
-
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Workflow details</p>
|
|
710
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="workflowId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">workflowId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The unique identifier or name of the workflow</p>
|
|
711
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier or name of the workflow</p>
|
|
712
|
+
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="params" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand params"><span class="property-name">params</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">object</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->GetWorkflowParams<!-- -->) </span></div> <div><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Workflow details</p>
|
|
459
713
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Workflow details</p>
|
|
460
714
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
461
715
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
462
716
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
463
717
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
464
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/workflows/{workflowId}</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflows/{workflowId}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«
|
|
718
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/workflows/{workflowId}</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflows/{workflowId}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R177ha»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R177ha»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R177ha»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R177ha»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R177ha»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R177ha»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R177ha»0" aria-labelledby="tab«R177ha»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"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">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"workflowTemplateId"</span>: <span class="token string">"53e62d87-459b-4f1f-ae45-ffe2549e140f"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ref"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"workflowTemplate"</span>: <button class="collapser" aria-label="expand"></button><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">"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">"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">"status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"allowVotingOnDeprecatedTemplate"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"approvalRule"</span>: <button class="collapser" aria-label="expand"></button><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">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token keyword">null</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">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"actions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"spaceId"</span>: <span class="token string">"a330a273-e64a-4183-aedb-f3152797a9a5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</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">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expiresAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R177ha»1" aria-labelledby="tab«R177ha»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R177ha»2" aria-labelledby="tab«R177ha»2"></div></div></div></div></div></div><div id="tag/Workflow-Templates" data-section-id="tag/Workflow-Templates" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Templates" aria-label="tag/Workflow-Templates"></a>Workflow Templates</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>Workflow template management</p>
|
|
465
719
|
"><p>Workflow template management</p>
|
|
466
720
|
</div></div></div><div id="tag/Workflow-Templates/operation/createWorkflowTemplate" data-section-id="tag/Workflow-Templates/operation/createWorkflowTemplate" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/createWorkflowTemplate" id="operation/createWorkflowTemplate" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Templates/operation/createWorkflowTemplate" aria-label="tag/Workflow-Templates/operation/createWorkflowTemplate"></a>Create a new workflow template<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Creates a new workflow template with approval rules, actions, and default expiry settings</p>
|
|
467
721
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Creates a new workflow template with approval rules, actions, and default expiry settings</p>
|
|
@@ -475,41 +729,37 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
475
729
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Configuration of approval rules. Can be a boolean operator (AND/OR) combining nested rules, or a specific requirement (minimum count from a group).</p>
|
|
476
730
|
</div></div></div></td></tr><tr class=""><td kind="field" title="actions" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand actions"><span class="property-name">actions</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">any</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->WorkflowAction<!-- -->) </span></div> <div><div html="<p>Actions to be executed when workflow is approved</p>
|
|
477
731
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Actions to be executed when workflow is approved</p>
|
|
478
|
-
</div></div></div></td></tr><tr class="
|
|
732
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="defaultExpiresInHours" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">defaultExpiresInHours</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- -->[ 1 .. 8760 ]<!-- --> </span></span></div> <div><div html="<p>Default expiry time for workflows created from this template (in hours, max 1 year)</p>
|
|
479
733
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Default expiry time for workflows created from this template (in hours, max 1 year)</p>
|
|
734
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="spaceId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">spaceId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>ID of the space to which this workflow template belongs</p>
|
|
735
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>ID of the space to which this workflow template belongs</p>
|
|
480
736
|
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">201<!-- --> </strong><div html="<p>Workflow template created successfully</p>
|
|
481
737
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Workflow template created successfully</p>
|
|
482
738
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
483
739
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
484
740
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
485
741
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
486
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/workflow-templates</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflow-templates</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R154pa»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R154pa»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R154pa»0" aria-labelledby="tab«R154pa»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"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">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"approvalRule"</span>: <button class="collapser" aria-label="collapse"></button><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">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token keyword">null</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">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R174pa»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R174pa»0" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="tab«R174pa»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R174pa»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R174pa»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R174pa»2" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R174pa»0" aria-labelledby="tab«R174pa»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"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">"approvalRule"</span>: <button class="collapser" aria-label="collapse"></button><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">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token keyword">null</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">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R174pa»1" aria-labelledby="tab«R174pa»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R174pa»2" aria-labelledby="tab«R174pa»2"></div></div></div></div></div></div><div id="tag/Workflow-Templates/operation/listWorkflowTemplates" data-section-id="tag/Workflow-Templates/operation/listWorkflowTemplates" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listWorkflowTemplates" id="operation/listWorkflowTemplates" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Templates/operation/listWorkflowTemplates" aria-label="tag/Workflow-Templates/operation/listWorkflowTemplates"></a>List workflow templates<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of workflow templates with optional filtering</p>
|
|
742
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/workflow-templates</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflow-templates</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2a9hq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2a9hq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2a9hq»0" aria-labelledby="tab«R2a9hq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"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">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"approvalRule"</span>: <button class="collapser" aria-label="collapse"></button><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">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token keyword">null</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">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spaceId"</span>: <span class="token string">"a330a273-e64a-4183-aedb-f3152797a9a5"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2e9hq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2e9hq»0" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="tab«R2e9hq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2e9hq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R2e9hq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2e9hq»2" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2e9hq»0" aria-labelledby="tab«R2e9hq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"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">"version"</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">"status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allowVotingOnDeprecatedTemplate"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"approvalRule"</span>: <button class="collapser" aria-label="collapse"></button><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">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token keyword">null</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">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spaceId"</span>: <span class="token string">"a330a273-e64a-4183-aedb-f3152797a9a5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2e9hq»1" aria-labelledby="tab«R2e9hq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2e9hq»2" aria-labelledby="tab«R2e9hq»2"></div></div></div></div></div></div><div id="tag/Workflow-Templates/operation/listWorkflowTemplates" data-section-id="tag/Workflow-Templates/operation/listWorkflowTemplates" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listWorkflowTemplates" id="operation/listWorkflowTemplates" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Templates/operation/listWorkflowTemplates" aria-label="tag/Workflow-Templates/operation/listWorkflowTemplates"></a>List workflow templates<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of workflow templates with optional filtering</p>
|
|
487
743
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of workflow templates with optional filtering</p>
|
|
488
|
-
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="
|
|
489
|
-
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Page number for pagination</p>
|
|
490
|
-
</div></div></div></td></tr><tr class="last "><td kind="field" title="limit" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">limit</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">20</span></div> <div><div html="<p>Number of results per page</p>
|
|
491
|
-
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Number of results per page</p>
|
|
492
|
-
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>List of workflow templates</p>
|
|
744
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="params" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand params"><span class="property-name">params</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">object</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->ListWorkflowTemplatesParams<!-- -->) </span></div> <div><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>List of workflow templates</p>
|
|
493
745
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>List of workflow templates</p>
|
|
494
746
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
495
747
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
496
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/workflow-templates</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflow-templates</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«
|
|
497
|
-
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns the details of a specific workflow template
|
|
498
|
-
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="
|
|
499
|
-
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the workflow template</p>
|
|
748
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/workflow-templates</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflow-templates</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2eahq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2eahq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R2eahq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eahq»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2eahq»0" aria-labelledby="tab«R2eahq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"New Workflow Template"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"version"</span>: <span class="token string">"1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"This is a new workflow template"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</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">"pagination"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"limit"</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="panel«R2eahq»1" aria-labelledby="tab«R2eahq»1"></div></div></div></div></div></div><div id="tag/Workflow-Templates/operation/getWorkflowTemplate" data-section-id="tag/Workflow-Templates/operation/getWorkflowTemplate" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/getWorkflowTemplate" id="operation/getWorkflowTemplate" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Templates/operation/getWorkflowTemplate" aria-label="tag/Workflow-Templates/operation/getWorkflowTemplate"></a>Get workflow template details<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns the details of a specific workflow template.</p>
|
|
749
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns the details of a specific workflow template.</p>
|
|
750
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="templateIdentifier" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">templateIdentifier</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The unique identifier of the workflow template (UUID)</p>
|
|
751
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the workflow template (UUID)</p>
|
|
500
752
|
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Workflow template details</p>
|
|
501
753
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Workflow template details</p>
|
|
502
754
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
503
755
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
504
756
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
505
757
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
506
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/workflow-templates/{
|
|
507
|
-
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Updates an existing workflow template</p>
|
|
508
|
-
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="
|
|
509
|
-
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The
|
|
510
|
-
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="
|
|
511
|
-
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>User-friendly name for the workflow template</p>
|
|
512
|
-
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">description</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Detailed description of the workflow template</p>
|
|
758
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/workflow-templates/{templateIdentifier}</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflow-templates/{templateIdentifier}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2ebhq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2ebhq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R2ebhq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ebhq»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2ebhq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ebhq»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2ebhq»0" aria-labelledby="tab«R2ebhq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"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">"version"</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">"status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allowVotingOnDeprecatedTemplate"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"approvalRule"</span>: <button class="collapser" aria-label="collapse"></button><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">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token keyword">null</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">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spaceId"</span>: <span class="token string">"a330a273-e64a-4183-aedb-f3152797a9a5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ebhq»1" aria-labelledby="tab«R2ebhq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ebhq»2" aria-labelledby="tab«R2ebhq»2"></div></div></div></div></div></div><div id="tag/Workflow-Templates/operation/updateWorkflowTemplate" data-section-id="tag/Workflow-Templates/operation/updateWorkflowTemplate" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/updateWorkflowTemplate" id="operation/updateWorkflowTemplate" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Templates/operation/updateWorkflowTemplate" aria-label="tag/Workflow-Templates/operation/updateWorkflowTemplate"></a>Update a workflow template<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Updates an existing workflow template by creating a new version and optionally canceling active workflows</p>
|
|
759
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Updates an existing workflow template by creating a new version and optionally canceling active workflows</p>
|
|
760
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="templateIdentifier" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">templateIdentifier</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The name of the workflow template to update</p>
|
|
761
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The name of the workflow template to update</p>
|
|
762
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="description" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">description</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Detailed description of the workflow template</p>
|
|
513
763
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Detailed description of the workflow template</p>
|
|
514
764
|
</div></div></div></td></tr><tr class=""><td kind="field" title="metadata" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">metadata</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">object</span></div> <div><div html="<p>Additional custom metadata for the workflow template</p>
|
|
515
765
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Additional custom metadata for the workflow template</p>
|
|
@@ -517,8 +767,10 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
517
767
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Configuration of approval rules. Can be a boolean operator (AND/OR) combining nested rules, or a specific requirement (minimum count from a group).</p>
|
|
518
768
|
</div></div></div></td></tr><tr class=""><td kind="field" title="actions" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand actions"><span class="property-name">actions</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">any</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->WorkflowAction<!-- -->) </span></div> <div><div html="<p>Actions to be executed when workflow is approved</p>
|
|
519
769
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Actions to be executed when workflow is approved</p>
|
|
520
|
-
</div></div></div></td></tr><tr class="
|
|
770
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="defaultExpiresInHours" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">defaultExpiresInHours</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- -->[ 1 .. 8760 ]<!-- --> </span></span></div> <div><div html="<p>Default expiry time for workflows created from this template (in hours, max 1 year)</p>
|
|
521
771
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Default expiry time for workflows created from this template (in hours, max 1 year)</p>
|
|
772
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="cancelWorkflows" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">cancelWorkflows</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">boolean</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">false</span></div> <div><div html="<p>If true, all in-progress workflows associated with this template will be canceled when creating a new version. This affects the allowVotingOnDeprecatedTemplate setting: when true, voting is disabled on the deprecated template.</p>
|
|
773
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>If true, all in-progress workflows associated with this template will be canceled when creating a new version. This affects the allowVotingOnDeprecatedTemplate setting: when true, voting is disabled on the deprecated template.</p>
|
|
522
774
|
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Workflow template updated successfully</p>
|
|
523
775
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Workflow template updated successfully</p>
|
|
524
776
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
@@ -527,17 +779,21 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
527
779
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
528
780
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
529
781
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
530
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="put" class="sc-fQLpxn dBzsUh http-verb put">put</span><span class="sc-jvKoal kZcHWP">/workflow-templates/{templateId}</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflow-templates/{templateId}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R1569a»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R1569a»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R1569a»0" aria-labelledby="tab«R1569a»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"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">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"approvalRule"</span>: <button class="collapser" aria-label="collapse"></button><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">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token keyword">null</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">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R1769a»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R1769a»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R1769a»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R1769a»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R1769a»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R1769a»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R1769a»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R1769a»3" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R1769a»0" aria-labelledby="tab«R1769a»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"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">"approvalRule"</span>: <button class="collapser" aria-label="collapse"></button><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">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token keyword">null</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">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R1769a»1" aria-labelledby="tab«R1769a»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R1769a»2" aria-labelledby="tab«R1769a»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R1769a»3" aria-labelledby="tab«R1769a»3"></div></div></div></div></div></div><div id="tag/Workflow-Templates/operation/deleteWorkflowTemplate" data-section-id="tag/Workflow-Templates/operation/deleteWorkflowTemplate" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/deleteWorkflowTemplate" id="operation/deleteWorkflowTemplate" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Templates/operation/deleteWorkflowTemplate" aria-label="tag/Workflow-Templates/operation/deleteWorkflowTemplate"></a>Delete a workflow template<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Deletes a workflow template</p>
|
|
531
|
-
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>
|
|
532
|
-
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="
|
|
533
|
-
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The
|
|
534
|
-
</div></div></div></td></tr></tbody></table></div><
|
|
535
|
-
" class="sc-eVqvcJ sc-fszimp
|
|
782
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="put" class="sc-fQLpxn dBzsUh http-verb put">put</span><span class="sc-jvKoal kZcHWP">/workflow-templates/{templateIdentifier}</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflow-templates/{templateIdentifier}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2achq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2achq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2achq»0" aria-labelledby="tab«R2achq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</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>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"approvalRule"</span>: <button class="collapser" aria-label="collapse"></button><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">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token keyword">null</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">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cancelWorkflows"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2echq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2echq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R2echq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2echq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R2echq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2echq»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2echq»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R2echq»3" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2echq»0" aria-labelledby="tab«R2echq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"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">"version"</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">"status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allowVotingOnDeprecatedTemplate"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"approvalRule"</span>: <button class="collapser" aria-label="collapse"></button><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">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token keyword">null</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">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spaceId"</span>: <span class="token string">"a330a273-e64a-4183-aedb-f3152797a9a5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2echq»1" aria-labelledby="tab«R2echq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2echq»2" aria-labelledby="tab«R2echq»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2echq»3" aria-labelledby="tab«R2echq»3"></div></div></div></div></div></div><div id="tag/Workflow-Templates/operation/deprecateWorkflowTemplate" data-section-id="tag/Workflow-Templates/operation/deprecateWorkflowTemplate" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/deprecateWorkflowTemplate" id="operation/deprecateWorkflowTemplate" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Templates/operation/deprecateWorkflowTemplate" aria-label="tag/Workflow-Templates/operation/deprecateWorkflowTemplate"></a>Deprecate a workflow template<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Marks a workflow template as deprecated with optional workflow cancellation</p>
|
|
783
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Marks a workflow template as deprecated with optional workflow cancellation</p>
|
|
784
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="templateName" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">templateName</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The name of the workflow template to deprecate</p>
|
|
785
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The name of the workflow template to deprecate</p>
|
|
786
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-fmLCLE edHaWS">optional</div></h5><div html="<p>Options for deprecating a workflow template.</p>
|
|
787
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Options for deprecating a workflow template.</p>
|
|
788
|
+
</div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="cancelWorkflows" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">cancelWorkflows</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">boolean</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">false</span></div> <div><div html="<p>If true, all in-progress workflows associated with this template will be canceled. This affects the allowVotingOnDeprecatedTemplate setting: when true, voting is disabled on the deprecated template.</p>
|
|
789
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>If true, all in-progress workflows associated with this template will be canceled. This affects the allowVotingOnDeprecatedTemplate setting: when true, voting is disabled on the deprecated template.</p>
|
|
790
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Workflow template deprecated successfully</p>
|
|
791
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Workflow template deprecated successfully</p>
|
|
536
792
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
537
793
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
538
794
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
539
795
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
540
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="
|
|
796
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/workflow-templates/{templateName}/deprecate</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflow-templates/{templateName}/deprecate</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2adhq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2adhq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2adhq»0" aria-labelledby="tab«R2adhq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cancelWorkflows"</span>: <span class="token boolean">false</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2edhq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2edhq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R2edhq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2edhq»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2edhq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2edhq»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2edhq»0" aria-labelledby="tab«R2edhq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"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">"version"</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">"status"</span>: <span class="token string">"ACTIVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allowVotingOnDeprecatedTemplate"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"approvalRule"</span>: <button class="collapser" aria-label="collapse"></button><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">"AND"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"rules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token keyword">null</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">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"EMAIL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"recipients"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"user@example.com"</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">"defaultExpiresInHours"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spaceId"</span>: <span class="token string">"a330a273-e64a-4183-aedb-f3152797a9a5"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2edhq»1" aria-labelledby="tab«R2edhq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2edhq»2" aria-labelledby="tab«R2edhq»2"></div></div></div></div></div></div><div id="tag/Users" data-section-id="tag/Users" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Users" aria-label="tag/Users"></a>Users</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>User management</p>
|
|
541
797
|
"><p>User management</p>
|
|
542
798
|
</div></div></div><div id="tag/Users/operation/createUser" data-section-id="tag/Users/operation/createUser" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/createUser" id="operation/createUser" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Users/operation/createUser" aria-label="tag/Users/operation/createUser"></a>Create a new user<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Creates a new user in the system.</p>
|
|
543
799
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Creates a new user in the system.</p>
|
|
@@ -545,8 +801,8 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
545
801
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>User's display name.</p>
|
|
546
802
|
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">email</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->email<!-- -->><!-- --> </span></div> <div><div html="<p>User&#39;s email address (must be unique).</p>
|
|
547
803
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>User's email address (must be unique).</p>
|
|
548
|
-
</div></div></div></td></tr><tr class="last "><td kind="field" title="orgRole" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">orgRole</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Role assigned to the user within the
|
|
549
|
-
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Role assigned to the user within the
|
|
804
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="orgRole" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">orgRole</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Role assigned to the user within the organization.</p>
|
|
805
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Role assigned to the user within the organization.</p>
|
|
550
806
|
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">201<!-- --> </strong><div html="<p>User created successfully</p>
|
|
551
807
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>User created successfully</p>
|
|
552
808
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
@@ -555,7 +811,7 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
555
811
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
556
812
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">409<!-- --> </strong><div html="<p>User with this email already exists</p>
|
|
557
813
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>User with this email already exists</p>
|
|
558
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/users</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/users</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«
|
|
814
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/users</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/users</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R4khia»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R4khia»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R4khia»0" aria-labelledby="tab«R4khia»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"displayName"</span>: <span class="token string">"Alex Chen"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"alex.chen@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"orgRole"</span>: <span class="token string">"member"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R4shia»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R4shia»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R4shia»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R4shia»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R4shia»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R4shia»2" data-rttab="true">409</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R4shia»0" aria-labelledby="tab«R4shia»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4shia»1" aria-labelledby="tab«R4shia»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4shia»2" aria-labelledby="tab«R4shia»2"></div></div></div></div></div></div><div id="tag/Users/operation/listUsers" data-section-id="tag/Users/operation/listUsers" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listUsers" id="operation/listUsers" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Users/operation/listUsers" aria-label="tag/Users/operation/listUsers"></a>List users<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of users</p>
|
|
559
815
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of users</p>
|
|
560
816
|
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="search" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">search</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Fuzzy search term for user display name or email.</p>
|
|
561
817
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Fuzzy search term for user display name or email.</p>
|
|
@@ -567,7 +823,7 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
567
823
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>List of users</p>
|
|
568
824
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
569
825
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
570
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/users</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/users</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«
|
|
826
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/users</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/users</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R4siia»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R4siia»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R4siia»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R4siia»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R4siia»0" aria-labelledby="tab«R4siia»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"users"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"displayName"</span>: <span class="token string">"Alex Chen"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"alex.chen@example.com"</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">"pagination"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"limit"</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="panel«R4siia»1" aria-labelledby="tab«R4siia»1"></div></div></div></div></div></div><div id="tag/Users/operation/getUser" data-section-id="tag/Users/operation/getUser" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/getUser" id="operation/getUser" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Users/operation/getUser" aria-label="tag/Users/operation/getUser"></a>Get user details<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns the details of a specific user by their ID.</p>
|
|
571
827
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns the details of a specific user by their ID.</p>
|
|
572
828
|
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="userId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">userId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the user.</p>
|
|
573
829
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the user.</p>
|
|
@@ -577,7 +833,39 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
577
833
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
578
834
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
579
835
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
580
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/users/{userId}</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/users/{userId}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«
|
|
836
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/users/{userId}</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/users/{userId}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R4sjia»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R4sjia»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R4sjia»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R4sjia»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R4sjia»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R4sjia»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R4sjia»0" aria-labelledby="tab«R4sjia»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"displayName"</span>: <span class="token string">"Alex Chen"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"alex.chen@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"orgRole"</span>: <span class="token string">"member"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4sjia»1" aria-labelledby="tab«R4sjia»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4sjia»2" aria-labelledby="tab«R4sjia»2"></div></div></div></div></div></div><div id="tag/Users/operation/assignUserRoles" data-section-id="tag/Users/operation/assignUserRoles" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/assignUserRoles" id="operation/assignUserRoles" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Users/operation/assignUserRoles" aria-label="tag/Users/operation/assignUserRoles"></a>Assign roles to a user<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Assigns standard roles to a user by replacing all existing role assignments. Roles are specified by their system-defined names and scopes. The user must be authenticated as a human (not an agent) to use this endpoint.</p>
|
|
837
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Assigns standard roles to a user by replacing all existing role assignments. Roles are specified by their system-defined names and scopes. The user must be authenticated as a human (not an agent) to use this endpoint.</p>
|
|
838
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="userId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">userId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the user.</p>
|
|
839
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the user.</p>
|
|
840
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="roles" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand roles"><span class="property-name">roles</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">objects</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->RoleOperationItem<!-- -->) </span></div> <div><div html="<p>Array of role assignments specifying role names and their scopes</p>
|
|
841
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Array of role assignments specifying role names and their scopes</p>
|
|
842
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd oZuve" disabled=""><strong class="sc-eJvlPh fBhAXU">204<!-- --> </strong><div html="<p>Roles assigned successfully</p>
|
|
843
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Roles assigned successfully</p>
|
|
844
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request (e.g., unknown role name, invalid scope, duplicate roles)</p>
|
|
845
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request (e.g., unknown role name, invalid scope, duplicate roles)</p>
|
|
846
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
847
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
848
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">403<!-- --> </strong><div html="<p>Forbidden - only human users can assign roles</p>
|
|
849
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Forbidden - only human users can assign roles</p>
|
|
850
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>User not found</p>
|
|
851
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>User not found</p>
|
|
852
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="put" class="sc-fQLpxn dBzsUh http-verb put">put</span><span class="sc-jvKoal kZcHWP">/users/{userId}/roles</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/users/{userId}/roles</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R4kkia»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R4kkia»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R4kkia»0" aria-labelledby="tab«R4kkia»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"roles"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"roleName"</span>: <span class="token string">"GroupReadOnly"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><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">"group"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"groupId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R4skia»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R4skia»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R4skia»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R4skia»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R4skia»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R4skia»2" data-rttab="true">403</li><li class="tab-error" role="tab" id="tab«R4skia»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R4skia»3" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R4skia»0" aria-labelledby="tab«R4skia»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4skia»1" aria-labelledby="tab«R4skia»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4skia»2" aria-labelledby="tab«R4skia»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4skia»3" aria-labelledby="tab«R4skia»3"></div></div></div></div></div></div><div id="tag/Users/operation/removeUserRoles" data-section-id="tag/Users/operation/removeUserRoles" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/removeUserRoles" id="operation/removeUserRoles" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Users/operation/removeUserRoles" aria-label="tag/Users/operation/removeUserRoles"></a>Remove roles from a user<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Removes specified roles from a user. Only the roles matching both the role name and scope will be removed. The user must be authenticated as a human (not an agent) to use this endpoint.</p>
|
|
853
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Removes specified roles from a user. Only the roles matching both the role name and scope will be removed. The user must be authenticated as a human (not an agent) to use this endpoint.</p>
|
|
854
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="userId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">userId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the user.</p>
|
|
855
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the user.</p>
|
|
856
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="roles" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand roles"><span class="property-name">roles</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">objects</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->RoleOperationItem<!-- -->) </span></div> <div><div html="<p>Array of role assignments specifying role names and their scopes</p>
|
|
857
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Array of role assignments specifying role names and their scopes</p>
|
|
858
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd oZuve" disabled=""><strong class="sc-eJvlPh fBhAXU">204<!-- --> </strong><div html="<p>Roles removed successfully</p>
|
|
859
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Roles removed successfully</p>
|
|
860
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request (e.g., unknown role name, invalid scope)</p>
|
|
861
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request (e.g., unknown role name, invalid scope)</p>
|
|
862
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
863
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
864
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">403<!-- --> </strong><div html="<p>Forbidden - only human users can remove roles</p>
|
|
865
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Forbidden - only human users can remove roles</p>
|
|
866
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>User not found</p>
|
|
867
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>User not found</p>
|
|
868
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="delete" class="sc-fQLpxn gKcHYQ http-verb delete">delete</span><span class="sc-jvKoal kZcHWP">/users/{userId}/roles</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/users/{userId}/roles</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R4klia»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R4klia»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R4klia»0" aria-labelledby="tab«R4klia»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"roles"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"roleName"</span>: <span class="token string">"GroupReadOnly"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><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">"group"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"groupId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R4slia»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R4slia»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R4slia»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R4slia»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R4slia»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R4slia»2" data-rttab="true">403</li><li class="tab-error" role="tab" id="tab«R4slia»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R4slia»3" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R4slia»0" aria-labelledby="tab«R4slia»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4slia»1" aria-labelledby="tab«R4slia»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4slia»2" aria-labelledby="tab«R4slia»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4slia»3" aria-labelledby="tab«R4slia»3"></div></div></div></div></div></div><div id="tag/Users/operation/listGroupEntities" data-section-id="tag/Users/operation/listGroupEntities" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listGroupEntities" id="operation/listGroupEntities" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Users/operation/listGroupEntities" aria-label="tag/Users/operation/listGroupEntities"></a>List entities in a group<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of all entities (users, systems, etc.) that belong to a specific group, including their roles.</p>
|
|
581
869
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of all entities (users, systems, etc.) that belong to a specific group, including their roles.</p>
|
|
582
870
|
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="groupId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">groupId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the group.</p>
|
|
583
871
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the group.</p>
|
|
@@ -591,7 +879,7 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
591
879
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
592
880
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
593
881
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
594
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«
|
|
882
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R4smia»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R4smia»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R4smia»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R4smia»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R4smia»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R4smia»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R4smia»0" aria-labelledby="tab«R4smia»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"entities"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entity"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entityType"</span>: <span class="token string">"human"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entityId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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">"addedAt"</span>: <span class="token string">"2025-04-16T10:30:00Z"</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">"pagination"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"limit"</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="panel«R4smia»1" aria-labelledby="tab«R4smia»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4smia»2" aria-labelledby="tab«R4smia»2"></div></div></div></div></div></div><div id="tag/Users/operation/addGroupEntities" data-section-id="tag/Users/operation/addGroupEntities" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/addGroupEntities" id="operation/addGroupEntities" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Users/operation/addGroupEntities" aria-label="tag/Users/operation/addGroupEntities"></a>Add group entities<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Add entities (like users) within a specific group.</p>
|
|
595
883
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Add entities (like users) within a specific group.</p>
|
|
596
884
|
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="groupId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">groupId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the group.</p>
|
|
597
885
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the group.</p>
|
|
@@ -607,7 +895,7 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
607
895
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Group not found</p>
|
|
608
896
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">409<!-- --> </strong><div html="<p>Conflict detected (e.g., adding an existing member).</p>
|
|
609
897
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Conflict detected (e.g., adding an existing member).</p>
|
|
610
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«
|
|
898
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R4knia»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R4knia»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R4knia»0" aria-labelledby="tab«R4knia»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"entities"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entity"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entityType"</span>: <span class="token string">"human"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entityId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R4snia»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R4snia»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R4snia»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R4snia»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R4snia»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R4snia»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R4snia»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R4snia»3" data-rttab="true">404</li><li class="tab-error" role="tab" id="tab«R4snia»4" aria-selected="false" aria-disabled="false" aria-controls="panel«R4snia»4" data-rttab="true">409</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R4snia»0" aria-labelledby="tab«R4snia»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"497f6eca-6276-4993-bfeb-53cbbbba6f08"</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">"entitiesCount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4snia»1" aria-labelledby="tab«R4snia»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4snia»2" aria-labelledby="tab«R4snia»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4snia»3" aria-labelledby="tab«R4snia»3"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4snia»4" aria-labelledby="tab«R4snia»4"></div></div></div></div></div></div><div id="tag/Users/operation/removeGroupEntities" data-section-id="tag/Users/operation/removeGroupEntities" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/removeGroupEntities" id="operation/removeGroupEntities" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Users/operation/removeGroupEntities" aria-label="tag/Users/operation/removeGroupEntities"></a>Remove group entities<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Remove entities (like users) from a specific group.</p>
|
|
611
899
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Remove entities (like users) from a specific group.</p>
|
|
612
900
|
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="groupId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">groupId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the group.</p>
|
|
613
901
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the group.</p>
|
|
@@ -623,7 +911,7 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
623
911
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Group not found</p>
|
|
624
912
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">409<!-- --> </strong><div html="<p>Conflict detected (e.g. removing a non-member).</p>
|
|
625
913
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Conflict detected (e.g. removing a non-member).</p>
|
|
626
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="delete" class="sc-fQLpxn gKcHYQ http-verb delete">delete</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«
|
|
914
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="delete" class="sc-fQLpxn gKcHYQ http-verb delete">delete</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R4koia»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R4koia»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R4koia»0" aria-labelledby="tab«R4koia»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"entities"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entity"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entityType"</span>: <span class="token string">"human"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entityId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R4soia»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R4soia»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R4soia»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R4soia»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R4soia»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R4soia»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R4soia»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R4soia»3" data-rttab="true">404</li><li class="tab-error" role="tab" id="tab«R4soia»4" aria-selected="false" aria-disabled="false" aria-controls="panel«R4soia»4" data-rttab="true">409</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R4soia»0" aria-labelledby="tab«R4soia»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"497f6eca-6276-4993-bfeb-53cbbbba6f08"</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">"entitiesCount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4soia»1" aria-labelledby="tab«R4soia»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4soia»2" aria-labelledby="tab«R4soia»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4soia»3" aria-labelledby="tab«R4soia»3"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R4soia»4" aria-labelledby="tab«R4soia»4"></div></div></div></div></div></div><div id="tag/Groups" data-section-id="tag/Groups" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Groups" aria-label="tag/Groups"></a>Groups</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>Group management</p>
|
|
627
915
|
"><p>Group management</p>
|
|
628
916
|
</div></div></div><div id="tag/Groups/operation/createGroup" data-section-id="tag/Groups/operation/createGroup" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/createGroup" id="operation/createGroup" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Groups/operation/createGroup" aria-label="tag/Groups/operation/createGroup"></a>Create a new approver group<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Create a new group for organizing approvers</p>
|
|
629
917
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Create a new group for organizing approvers</p>
|
|
@@ -637,7 +925,7 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
637
925
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
638
926
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
639
927
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
640
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/groups</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«
|
|
928
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/groups</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2a9iq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2a9iq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2a9iq»0" aria-labelledby="tab«R2a9iq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"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-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R2e9iq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2e9iq»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R2e9iq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2e9iq»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2e9iq»0" aria-labelledby="tab«R2e9iq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2e9iq»1" aria-labelledby="tab«R2e9iq»1"></div></div></div></div></div></div><div id="tag/Groups/operation/listGroups" data-section-id="tag/Groups/operation/listGroups" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listGroups" id="operation/listGroups" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Groups/operation/listGroups" aria-label="tag/Groups/operation/listGroups"></a>List groups<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of groups</p>
|
|
641
929
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of groups</p>
|
|
642
930
|
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="page" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">page</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">1</span></div> <div><div html="<p>Page number for pagination</p>
|
|
643
931
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Page number for pagination</p>
|
|
@@ -647,7 +935,7 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
647
935
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>List of groups</p>
|
|
648
936
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
649
937
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
650
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/groups</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«
|
|
938
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/groups</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2eaiq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2eaiq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R2eaiq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eaiq»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2eaiq»0" aria-labelledby="tab«R2eaiq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"groups"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"497f6eca-6276-4993-bfeb-53cbbbba6f08"</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">"entitiesCount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</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">"pagination"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"limit"</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="panel«R2eaiq»1" aria-labelledby="tab«R2eaiq»1"></div></div></div></div></div></div><div id="tag/Groups/operation/getGroup" data-section-id="tag/Groups/operation/getGroup" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/getGroup" id="operation/getGroup" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Groups/operation/getGroup" aria-label="tag/Groups/operation/getGroup"></a>Get group details<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns the details of a specific group</p>
|
|
651
939
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns the details of a specific group</p>
|
|
652
940
|
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="groupIdentifier" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">groupIdentifier</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The unique identifier of the group or the name of the group</p>
|
|
653
941
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the group or the name of the group</p>
|
|
@@ -657,7 +945,7 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
657
945
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
658
946
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
659
947
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
660
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/groups/{groupIdentifier}</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupIdentifier}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«
|
|
948
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/groups/{groupIdentifier}</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupIdentifier}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2ebiq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2ebiq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R2ebiq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ebiq»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2ebiq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ebiq»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2ebiq»0" aria-labelledby="tab«R2ebiq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"497f6eca-6276-4993-bfeb-53cbbbba6f08"</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">"entitiesCount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ebiq»1" aria-labelledby="tab«R2ebiq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ebiq»2" aria-labelledby="tab«R2ebiq»2"></div></div></div></div></div></div><div id="tag/Groups/operation/listGroupEntities" data-section-id="tag/Groups/operation/listGroupEntities" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listGroupEntities" id="operation/listGroupEntities" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Groups/operation/listGroupEntities" aria-label="tag/Groups/operation/listGroupEntities"></a>List entities in a group<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of all entities (users, systems, etc.) that belong to a specific group, including their roles.</p>
|
|
661
949
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of all entities (users, systems, etc.) that belong to a specific group, including their roles.</p>
|
|
662
950
|
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="groupId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">groupId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the group.</p>
|
|
663
951
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the group.</p>
|
|
@@ -671,7 +959,7 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
671
959
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
672
960
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
673
961
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
674
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«
|
|
962
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2eciq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2eciq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R2eciq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eciq»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2eciq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eciq»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2eciq»0" aria-labelledby="tab«R2eciq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"entities"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entity"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entityType"</span>: <span class="token string">"human"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entityId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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">"addedAt"</span>: <span class="token string">"2025-04-16T10:30:00Z"</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">"pagination"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"limit"</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="panel«R2eciq»1" aria-labelledby="tab«R2eciq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2eciq»2" aria-labelledby="tab«R2eciq»2"></div></div></div></div></div></div><div id="tag/Groups/operation/addGroupEntities" data-section-id="tag/Groups/operation/addGroupEntities" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/addGroupEntities" id="operation/addGroupEntities" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Groups/operation/addGroupEntities" aria-label="tag/Groups/operation/addGroupEntities"></a>Add group entities<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Add entities (like users) within a specific group.</p>
|
|
675
963
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Add entities (like users) within a specific group.</p>
|
|
676
964
|
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="groupId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">groupId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the group.</p>
|
|
677
965
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the group.</p>
|
|
@@ -687,7 +975,7 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
687
975
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Group not found</p>
|
|
688
976
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">409<!-- --> </strong><div html="<p>Conflict detected (e.g., adding an existing member).</p>
|
|
689
977
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Conflict detected (e.g., adding an existing member).</p>
|
|
690
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«
|
|
978
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2adiq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2adiq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2adiq»0" aria-labelledby="tab«R2adiq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"entities"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entity"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entityType"</span>: <span class="token string">"human"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entityId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2ediq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2ediq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R2ediq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ediq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R2ediq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ediq»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2ediq»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ediq»3" data-rttab="true">404</li><li class="tab-error" role="tab" id="tab«R2ediq»4" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ediq»4" data-rttab="true">409</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2ediq»0" aria-labelledby="tab«R2ediq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"497f6eca-6276-4993-bfeb-53cbbbba6f08"</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">"entitiesCount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ediq»1" aria-labelledby="tab«R2ediq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ediq»2" aria-labelledby="tab«R2ediq»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ediq»3" aria-labelledby="tab«R2ediq»3"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ediq»4" aria-labelledby="tab«R2ediq»4"></div></div></div></div></div></div><div id="tag/Groups/operation/removeGroupEntities" data-section-id="tag/Groups/operation/removeGroupEntities" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/removeGroupEntities" id="operation/removeGroupEntities" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Groups/operation/removeGroupEntities" aria-label="tag/Groups/operation/removeGroupEntities"></a>Remove group entities<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Remove entities (like users) from a specific group.</p>
|
|
691
979
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Remove entities (like users) from a specific group.</p>
|
|
692
980
|
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="groupId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">groupId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the group.</p>
|
|
693
981
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the group.</p>
|
|
@@ -703,7 +991,101 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
703
991
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Group not found</p>
|
|
704
992
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">409<!-- --> </strong><div html="<p>Conflict detected (e.g. removing a non-member).</p>
|
|
705
993
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Conflict detected (e.g. removing a non-member).</p>
|
|
706
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="delete" class="sc-fQLpxn gKcHYQ http-verb delete">delete</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«
|
|
994
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="delete" class="sc-fQLpxn gKcHYQ http-verb delete">delete</span><span class="sc-jvKoal kZcHWP">/groups/{groupId}/entities</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/groups/{groupId}/entities</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2aeiq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2aeiq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2aeiq»0" aria-labelledby="tab«R2aeiq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"entities"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entity"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"entityType"</span>: <span class="token string">"human"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"entityId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2eeiq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2eeiq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R2eeiq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eeiq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R2eeiq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eeiq»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2eeiq»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eeiq»3" data-rttab="true">404</li><li class="tab-error" role="tab" id="tab«R2eeiq»4" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eeiq»4" data-rttab="true">409</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2eeiq»0" aria-labelledby="tab«R2eeiq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"497f6eca-6276-4993-bfeb-53cbbbba6f08"</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">"entitiesCount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2eeiq»1" aria-labelledby="tab«R2eeiq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2eeiq»2" aria-labelledby="tab«R2eeiq»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2eeiq»3" aria-labelledby="tab«R2eeiq»3"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2eeiq»4" aria-labelledby="tab«R2eeiq»4"></div></div></div></div></div></div><div id="tag/Spaces" data-section-id="tag/Spaces" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Spaces" aria-label="tag/Spaces"></a>Spaces</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>Space management</p>
|
|
995
|
+
"><p>Space management</p>
|
|
996
|
+
</div></div></div><div id="tag/Spaces/operation/createSpace" data-section-id="tag/Spaces/operation/createSpace" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/createSpace" id="operation/createSpace" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Spaces/operation/createSpace" aria-label="tag/Spaces/operation/createSpace"></a>Create a new space<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Creates a new organizational space</p>
|
|
997
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Creates a new organizational space</p>
|
|
998
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="name" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">name</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Name of the space (max 255 characters)</p>
|
|
999
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Name of the space (max 255 characters)</p>
|
|
1000
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="description" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">description</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>Description of the space (max 2048 characters)</p>
|
|
1001
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Description of the space (max 2048 characters)</p>
|
|
1002
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">201<!-- --> </strong><div html="<p>Space created successfully</p>
|
|
1003
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Space created successfully</p>
|
|
1004
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
1005
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
1006
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1007
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1008
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">409<!-- --> </strong><div html="<p>Space with this name already exists</p>
|
|
1009
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Space with this name already exists</p>
|
|
1010
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/spaces</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/spaces</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2a9ja»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2a9ja»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2a9ja»0" aria-labelledby="tab«R2a9ja»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Engineering Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Space for engineering team collaboration"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R2e9ja»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2e9ja»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R2e9ja»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2e9ja»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2e9ja»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2e9ja»2" data-rttab="true">409</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2e9ja»0" aria-labelledby="tab«R2e9ja»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2e9ja»1" aria-labelledby="tab«R2e9ja»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2e9ja»2" aria-labelledby="tab«R2e9ja»2"></div></div></div></div></div></div><div id="tag/Spaces/operation/listSpaces" data-section-id="tag/Spaces/operation/listSpaces" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listSpaces" id="operation/listSpaces" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Spaces/operation/listSpaces" aria-label="tag/Spaces/operation/listSpaces"></a>List spaces<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of spaces</p>
|
|
1011
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of spaces</p>
|
|
1012
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="page" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">page</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">1</span></div> <div><div html="<p>Page number for pagination</p>
|
|
1013
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Page number for pagination</p>
|
|
1014
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="limit" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">limit</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">20</span></div> <div><div html="<p>Number of results per page</p>
|
|
1015
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Number of results per page</p>
|
|
1016
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>List of spaces</p>
|
|
1017
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>List of spaces</p>
|
|
1018
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1019
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1020
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/spaces</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/spaces</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2eaja»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2eaja»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R2eaja»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eaja»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2eaja»0" aria-labelledby="tab«R2eaja»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Engineering Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Space for engineering team collaboration"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</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">"pagination"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"limit"</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="panel«R2eaja»1" aria-labelledby="tab«R2eaja»1"></div></div></div></div></div></div><div id="tag/Spaces/operation/getSpace" data-section-id="tag/Spaces/operation/getSpace" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/getSpace" id="operation/getSpace" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Spaces/operation/getSpace" aria-label="tag/Spaces/operation/getSpace"></a>Get space details<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns the details of a specific space</p>
|
|
1021
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns the details of a specific space</p>
|
|
1022
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="spaceId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">spaceId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier of the space</p>
|
|
1023
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the space</p>
|
|
1024
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Space details</p>
|
|
1025
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Space details</p>
|
|
1026
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1027
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1028
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
1029
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
1030
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/spaces/{spaceId}</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/spaces/{spaceId}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2ebja»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2ebja»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R2ebja»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ebja»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2ebja»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ebja»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2ebja»0" aria-labelledby="tab«R2ebja»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"Engineering Team"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"Space for engineering team collaboration"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ebja»1" aria-labelledby="tab«R2ebja»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ebja»2" aria-labelledby="tab«R2ebja»2"></div></div></div></div></div></div><div id="tag/Spaces/operation/deleteSpace" data-section-id="tag/Spaces/operation/deleteSpace" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/deleteSpace" id="operation/deleteSpace" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Spaces/operation/deleteSpace" aria-label="tag/Spaces/operation/deleteSpace"></a>Delete a space<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Deletes a space</p>
|
|
1031
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Deletes a space</p>
|
|
1032
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="spaceId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">spaceId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier of the space</p>
|
|
1033
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the space</p>
|
|
1034
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd oZuve" disabled=""><strong class="sc-eJvlPh fBhAXU">204<!-- --> </strong><div html="<p>Space deleted successfully</p>
|
|
1035
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Space deleted successfully</p>
|
|
1036
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1037
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1038
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
1039
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
1040
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">409<!-- --> </strong><div html="<p>Cannot delete space with active resources</p>
|
|
1041
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Cannot delete space with active resources</p>
|
|
1042
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="delete" class="sc-fQLpxn gKcHYQ http-verb delete">delete</span><span class="sc-jvKoal kZcHWP">/spaces/{spaceId}</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/spaces/{spaceId}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R2ecja»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2ecja»0" tabindex="0" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2ecja»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ecja»1" data-rttab="true">404</li><li class="tab-error" role="tab" id="tab«R2ecja»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ecja»2" data-rttab="true">409</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2ecja»0" aria-labelledby="tab«R2ecja»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ecja»1" aria-labelledby="tab«R2ecja»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ecja»2" aria-labelledby="tab«R2ecja»2"></div></div></div></div></div></div><div id="tag/Organization-Admins" data-section-id="tag/Organization-Admins" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Organization-Admins" aria-label="tag/Organization-Admins"></a>Organization Admins</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>Organization administrator management</p>
|
|
1043
|
+
"><p>Organization administrator management</p>
|
|
1044
|
+
</div></div></div><div id="tag/Organization-Admins/operation/addOrganizationAdminToOrg" data-section-id="tag/Organization-Admins/operation/addOrganizationAdminToOrg" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/addOrganizationAdminToOrg" id="operation/addOrganizationAdminToOrg" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Organization-Admins/operation/addOrganizationAdminToOrg" aria-label="tag/Organization-Admins/operation/addOrganizationAdminToOrg"></a>Add organization administrator<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Adds a new organization administrator by email to the specified organization</p>
|
|
1045
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Adds a new organization administrator by email to the specified organization</p>
|
|
1046
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="organization-name" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">organization-name</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><span class="sc-bEjUoa lhyyLL"> <!-- -->Example:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">my-org</span></div><div><div html="<p>The name or identifier of the organization</p>
|
|
1047
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The name or identifier of the organization</p>
|
|
1048
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="email" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">email</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->email<!-- -->><!-- --> </span></div> <div><div html="<p>Email address of the organization administrator</p>
|
|
1049
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Email address of the organization administrator</p>
|
|
1050
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">201<!-- --> </strong><div html="<p>Organization admin added successfully</p>
|
|
1051
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Organization admin added successfully</p>
|
|
1052
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
1053
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
1054
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1055
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1056
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Organization not found</p>
|
|
1057
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Organization not found</p>
|
|
1058
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">409<!-- --> </strong><div html="<p>Admin with this email already exists in this organization</p>
|
|
1059
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Admin with this email already exists in this organization</p>
|
|
1060
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/organization/{organization-name}/admins</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/organization/{organization-name}/admins</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R155jq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R155jq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R155jq»0" aria-labelledby="tab«R155jq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"admin@example.com"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R175jq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R175jq»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R175jq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R175jq»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R175jq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R175jq»2" data-rttab="true">404</li><li class="tab-error" role="tab" id="tab«R175jq»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R175jq»3" data-rttab="true">409</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R175jq»0" aria-labelledby="tab«R175jq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R175jq»1" aria-labelledby="tab«R175jq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R175jq»2" aria-labelledby="tab«R175jq»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R175jq»3" aria-labelledby="tab«R175jq»3"></div></div></div></div></div></div><div id="tag/Organization-Admins/operation/listOrganizationAdminsForOrg" data-section-id="tag/Organization-Admins/operation/listOrganizationAdminsForOrg" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listOrganizationAdminsForOrg" id="operation/listOrganizationAdminsForOrg" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Organization-Admins/operation/listOrganizationAdminsForOrg" aria-label="tag/Organization-Admins/operation/listOrganizationAdminsForOrg"></a>List organization administrators<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of administrators for the specified organization</p>
|
|
1061
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of administrators for the specified organization</p>
|
|
1062
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="organization-name" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">organization-name</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><span class="sc-bEjUoa lhyyLL"> <!-- -->Example:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">my-org</span></div><div><div html="<p>The name or identifier of the organization</p>
|
|
1063
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The name or identifier of the organization</p>
|
|
1064
|
+
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class=""><td kind="field" title="page" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">page</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">1</span></div> <div><div html="<p>Page number for pagination</p>
|
|
1065
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Page number for pagination</p>
|
|
1066
|
+
</div></div></div></td></tr><tr class="last "><td kind="field" title="limit" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">limit</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">integer</span></div><div><span class="sc-bEjUoa lhyyLL"> <!-- -->Default:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">20</span></div> <div><div html="<p>Number of results per page</p>
|
|
1067
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Number of results per page</p>
|
|
1068
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>List of organization admins for the specified organization</p>
|
|
1069
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>List of organization admins for the specified organization</p>
|
|
1070
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1071
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1072
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Organization not found</p>
|
|
1073
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Organization not found</p>
|
|
1074
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/organization/{organization-name}/admins</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/organization/{organization-name}/admins</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R176jq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R176jq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R176jq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R176jq»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R176jq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R176jq»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R176jq»0" aria-labelledby="tab«R176jq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"userId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"admin@example.com"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</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">"pagination"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"limit"</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="panel«R176jq»1" aria-labelledby="tab«R176jq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R176jq»2" aria-labelledby="tab«R176jq»2"></div></div></div></div></div></div><div id="tag/Organization-Admins/operation/removeOrganizationAdminFromOrg" data-section-id="tag/Organization-Admins/operation/removeOrganizationAdminFromOrg" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/removeOrganizationAdminFromOrg" id="operation/removeOrganizationAdminFromOrg" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Organization-Admins/operation/removeOrganizationAdminFromOrg" aria-label="tag/Organization-Admins/operation/removeOrganizationAdminFromOrg"></a>Remove organization administrator<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Removes an organization administrator from the specified organization</p>
|
|
1075
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Removes an organization administrator from the specified organization</p>
|
|
1076
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="organization-name" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">organization-name</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><span class="sc-bEjUoa lhyyLL"> <!-- -->Example:<!-- --> </span> <span class="sc-bEjUoa sc-dTWiOz lhyyLL kMQdIk">my-org</span></div><div><div html="<p>The name or identifier of the organization</p>
|
|
1077
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The name or identifier of the organization</p>
|
|
1078
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="userId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">userId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier of the user to remove from organization admins</p>
|
|
1079
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the user to remove from organization admins</p>
|
|
1080
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd oZuve" disabled=""><strong class="sc-eJvlPh fBhAXU">204<!-- --> </strong><div html="<p>Organization admin removed successfully</p>
|
|
1081
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Organization admin removed successfully</p>
|
|
1082
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
1083
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
1084
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1085
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1086
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
1087
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
1088
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="delete" class="sc-fQLpxn gKcHYQ http-verb delete">delete</span><span class="sc-jvKoal kZcHWP">/organization/{organization-name}/admins</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/organization/{organization-name}/admins</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R157jq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R157jq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R157jq»0" aria-labelledby="tab«R157jq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"userId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R177jq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R177jq»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R177jq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R177jq»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R177jq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R177jq»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R177jq»0" aria-labelledby="tab«R177jq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R177jq»1" aria-labelledby="tab«R177jq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R177jq»2" aria-labelledby="tab«R177jq»2"></div></div></div></div></div></div><div id="tag/Workflow-Actions" data-section-id="tag/Workflow-Actions" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Actions" aria-label="tag/Workflow-Actions"></a>Workflow Actions</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>Workflow actions and voting</p>
|
|
707
1089
|
"><p>Workflow actions and voting</p>
|
|
708
1090
|
</div></div></div><div id="tag/Workflow-Actions/operation/voteOnWorkflow" data-section-id="tag/Workflow-Actions/operation/voteOnWorkflow" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/voteOnWorkflow" id="operation/voteOnWorkflow" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Actions/operation/voteOnWorkflow" aria-label="tag/Workflow-Actions/operation/voteOnWorkflow"></a>Vote on a workflow<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Allows an authenticated entity to cast a vote (approve or veto) on a specific workflow.</p>
|
|
709
1091
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Allows an authenticated entity to cast a vote (approve or veto) on a specific workflow.</p>
|
|
@@ -719,7 +1101,17 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
719
1101
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
720
1102
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
721
1103
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
722
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/workflows/{workflowId}/vote</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflows/{workflowId}/vote</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«
|
|
1104
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/workflows/{workflowId}/vote</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflows/{workflowId}/vote</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R155ka»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R155ka»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R155ka»0" aria-labelledby="tab«R155ka»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">"Missing critical information or LGTM!"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"voteType"</span>: <button class="collapser" aria-label="collapse"></button><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">"APPROVE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"votedForGroups"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R175ka»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R175ka»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R175ka»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R175ka»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R175ka»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R175ka»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R175ka»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R175ka»3" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R175ka»0" aria-labelledby="tab«R175ka»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><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="panel«R175ka»1" aria-labelledby="tab«R175ka»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R175ka»2" aria-labelledby="tab«R175ka»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R175ka»3" aria-labelledby="tab«R175ka»3"></div></div></div></div></div></div><div id="tag/Workflow-Actions/operation/getWorkflowVotes" data-section-id="tag/Workflow-Actions/operation/getWorkflowVotes" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/getWorkflowVotes" id="operation/getWorkflowVotes" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Actions/operation/getWorkflowVotes" aria-label="tag/Workflow-Actions/operation/getWorkflowVotes"></a>Retrieve votes for a workflow<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of all votes cast for the specified workflow.</p>
|
|
1105
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of all votes cast for the specified workflow.</p>
|
|
1106
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="workflowId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">workflowId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The unique identifier of the workflow</p>
|
|
1107
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the workflow</p>
|
|
1108
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>List of votes</p>
|
|
1109
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>List of votes</p>
|
|
1110
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1111
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1112
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
1113
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
1114
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/workflows/{workflowId}/votes</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflows/{workflowId}/votes</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R176ka»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R176ka»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R176ka»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R176ka»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R176ka»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R176ka»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R176ka»0" aria-labelledby="tab«R176ka»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"votes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"voterId"</span>: <span class="token string">"2f88d831-dd2d-4646-94b3-a7ea79cde62c"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"voterType"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"voteType"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"reason"</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">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"votedForGroups"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"497f6eca-6276-4993-bfeb-53cbbbba6f08"</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="panel«R176ka»1" aria-labelledby="tab«R176ka»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R176ka»2" aria-labelledby="tab«R176ka»2"></div></div></div></div></div></div><div id="tag/Workflow-Actions/operation/canVoteOnWorkflow" data-section-id="tag/Workflow-Actions/operation/canVoteOnWorkflow" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/canVoteOnWorkflow" id="operation/canVoteOnWorkflow" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Workflow-Actions/operation/canVoteOnWorkflow" aria-label="tag/Workflow-Actions/operation/canVoteOnWorkflow"></a>Check if the current entity can vote on a workflow<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Determines if the authenticated entity is eligible to cast a vote on the specified workflow.</p>
|
|
723
1115
|
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Determines if the authenticated entity is eligible to cast a vote on the specified workflow.</p>
|
|
724
1116
|
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="workflowId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">workflowId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The unique identifier of the workflow.</p>
|
|
725
1117
|
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier of the workflow.</p>
|
|
@@ -729,9 +1121,149 @@ data-styled.g138[id="sc-enPhjR"]{content:"SikXG,"}/*!sc*/
|
|
|
729
1121
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
730
1122
|
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
731
1123
|
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
732
|
-
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/workflows/{workflowId}/canVote</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflows/{workflowId}/canVote</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«
|
|
1124
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/workflows/{workflowId}/canVote</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/workflows/{workflowId}/canVote</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R177ka»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R177ka»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R177ka»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R177ka»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R177ka»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R177ka»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R177ka»0" aria-labelledby="tab«R177ka»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"canVote"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"voteStatus"</span>: <span class="token string">"VOTE_PENDING"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cantVoteReason"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requireHighPrivilege"</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="panel«R177ka»1" aria-labelledby="tab«R177ka»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R177ka»2" aria-labelledby="tab«R177ka»2"></div></div></div></div></div></div><div id="tag/Agents" data-section-id="tag/Agents" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Agents" aria-label="tag/Agents"></a>Agents</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>Agent registration and management</p>
|
|
1125
|
+
"><p>Agent registration and management</p>
|
|
1126
|
+
</div></div></div><div id="tag/Agents/operation/listAgents" data-section-id="tag/Agents/operation/listAgents" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listAgents" id="operation/listAgents" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Agents/operation/listAgents" aria-label="tag/Agents/operation/listAgents"></a>List agents<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of agents</p>
|
|
1127
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of agents</p>
|
|
1128
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">query<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="params" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand params"><span class="property-name">params</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">object</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->ListAgentsParams<!-- -->) </span></div> <div><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>List of agents</p>
|
|
1129
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>List of agents</p>
|
|
1130
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1131
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1132
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/agents</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/agents</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2e9kq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2e9kq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R2e9kq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2e9kq»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2e9kq»0" aria-labelledby="tab«R2e9kq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"agents"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><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">"497f6eca-6276-4993-bfeb-53cbbbba6f08"</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></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">"pagination"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"limit"</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="panel«R2e9kq»1" aria-labelledby="tab«R2e9kq»1"></div></div></div></div></div></div><div id="tag/Agents/operation/registerAgent" data-section-id="tag/Agents/operation/registerAgent" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/registerAgent" id="operation/registerAgent" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Agents/operation/registerAgent" aria-label="tag/Agents/operation/registerAgent"></a>Register a new agent<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Creates a new agent registration entry with generated asymmetric key pair for future authentication</p>
|
|
1133
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Creates a new agent registration entry with generated asymmetric key pair for future authentication</p>
|
|
1134
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="agentName" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">agentName</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span> <span class="sc-bEjUoa sc-goiVcJ lhyyLL bDfgbe"> <!-- -->[ 1 .. 1024 ] characters<!-- --> </span></span></div> <div><div html="<p>Unique name for the agent (must be unique across the system)</p>
|
|
1135
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Unique name for the agent (must be unique across the system)</p>
|
|
1136
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">201<!-- --> </strong><div html="<p>Agent registered successfully</p>
|
|
1137
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Agent registered successfully</p>
|
|
1138
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request</p>
|
|
1139
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request</p>
|
|
1140
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1141
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1142
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">409<!-- --> </strong><div html="<p>Agent with this name already exists</p>
|
|
1143
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Agent with this name already exists</p>
|
|
1144
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="post" class="sc-fQLpxn kwcmyC http-verb post">post</span><span class="sc-jvKoal kZcHWP">/agents/register</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/agents/register</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2aakq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2aakq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2aakq»0" aria-labelledby="tab«R2aakq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"agentName"</span>: <span class="token string">"ci-deployment-agent"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2eakq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2eakq»0" tabindex="0" data-rttab="true">201</li><li class="tab-error" role="tab" id="tab«R2eakq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eakq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R2eakq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eakq»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2eakq»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eakq»3" data-rttab="true">409</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2eakq»0" aria-labelledby="tab«R2eakq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"agentId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"agentName"</span>: <span class="token string">"ci-deployment-agent"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"publicKey"</span>: <span class="token string">"LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUEuLi4KLS0tLS1FTkQgUFVCTElDIEtFWS0tLS0t"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"privateKey"</span>: <span class="token string">"LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1JSUVWd0lCQURBTkJna3Foa2lHOXcwQkFRRUZBQVNDQktnZ2dnU2tBZ0VBQW9JQkFRQy4uLgotLS0tLUVORCBQUklWQVRFIEtFWS0tLS0t"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2eakq»1" aria-labelledby="tab«R2eakq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2eakq»2" aria-labelledby="tab«R2eakq»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2eakq»3" aria-labelledby="tab«R2eakq»3"></div></div></div></div></div></div><div id="tag/Agents/operation/getAgent" data-section-id="tag/Agents/operation/getAgent" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/getAgent" id="operation/getAgent" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Agents/operation/getAgent" aria-label="tag/Agents/operation/getAgent"></a>Get agent details<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns the details of a specific agent by their ID or name.</p>
|
|
1145
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns the details of a specific agent by their ID or name.</p>
|
|
1146
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="agentIdOrName" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">agentIdOrName</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="<p>The unique identifier (UUID) or the name of the agent.</p>
|
|
1147
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) or the name of the agent.</p>
|
|
1148
|
+
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Agent details retrieved successfully</p>
|
|
1149
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Agent details retrieved successfully</p>
|
|
1150
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1151
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1152
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Resource not found</p>
|
|
1153
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
|
|
1154
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/agents/{agentIdOrName}</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/agents/{agentIdOrName}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2ebkq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2ebkq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R2ebkq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ebkq»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2ebkq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ebkq»2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2ebkq»0" aria-labelledby="tab«R2ebkq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"agentName"</span>: <span class="token string">"ci-deployment-agent"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"publicKey"</span>: <span class="token string">"LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUEuLi4KLS0tLS1FTkQgUFVCTElDIEtFWS0tLS0t"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2025-04-15T12:05:00Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ebkq»1" aria-labelledby="tab«R2ebkq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ebkq»2" aria-labelledby="tab«R2ebkq»2"></div></div></div></div></div></div><div id="tag/Agents/operation/assignAgentRoles" data-section-id="tag/Agents/operation/assignAgentRoles" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/assignAgentRoles" id="operation/assignAgentRoles" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Agents/operation/assignAgentRoles" aria-label="tag/Agents/operation/assignAgentRoles"></a>Assign roles to an agent<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Assigns standard roles to an agent by replacing all existing role assignments. Roles are specified by their system-defined names and scopes. The user must be authenticated as a human (not an agent) to use this endpoint.</p>
|
|
1155
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Assigns standard roles to an agent by replacing all existing role assignments. Roles are specified by their system-defined names and scopes. The user must be authenticated as a human (not an agent) to use this endpoint.</p>
|
|
1156
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="agentId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">agentId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the agent.</p>
|
|
1157
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the agent.</p>
|
|
1158
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="roles" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand roles"><span class="property-name">roles</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">objects</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->RoleOperationItem<!-- -->) </span></div> <div><div html="<p>Array of role assignments specifying role names and their scopes</p>
|
|
1159
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Array of role assignments specifying role names and their scopes</p>
|
|
1160
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd oZuve" disabled=""><strong class="sc-eJvlPh fBhAXU">204<!-- --> </strong><div html="<p>Roles assigned successfully</p>
|
|
1161
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Roles assigned successfully</p>
|
|
1162
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request (e.g., unknown role name, invalid scope, duplicate roles)</p>
|
|
1163
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request (e.g., unknown role name, invalid scope, duplicate roles)</p>
|
|
1164
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1165
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1166
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">403<!-- --> </strong><div html="<p>Forbidden - only human users can assign roles</p>
|
|
1167
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Forbidden - only human users can assign roles</p>
|
|
1168
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Agent not found</p>
|
|
1169
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Agent not found</p>
|
|
1170
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="put" class="sc-fQLpxn dBzsUh http-verb put">put</span><span class="sc-jvKoal kZcHWP">/agents/{agentId}/roles</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/agents/{agentId}/roles</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2ackq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2ackq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2ackq»0" aria-labelledby="tab«R2ackq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"roles"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"roleName"</span>: <span class="token string">"GroupReadOnly"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><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">"group"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"groupId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R2eckq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2eckq»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R2eckq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eckq»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2eckq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eckq»2" data-rttab="true">403</li><li class="tab-error" role="tab" id="tab«R2eckq»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eckq»3" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2eckq»0" aria-labelledby="tab«R2eckq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2eckq»1" aria-labelledby="tab«R2eckq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2eckq»2" aria-labelledby="tab«R2eckq»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2eckq»3" aria-labelledby="tab«R2eckq»3"></div></div></div></div></div></div><div id="tag/Agents/operation/removeAgentRoles" data-section-id="tag/Agents/operation/removeAgentRoles" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/removeAgentRoles" id="operation/removeAgentRoles" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Agents/operation/removeAgentRoles" aria-label="tag/Agents/operation/removeAgentRoles"></a>Remove roles from an agent<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Removes specified roles from an agent. Only the roles matching both the role name and scope will be removed. The user must be authenticated as a human (not an agent) to use this endpoint.</p>
|
|
1171
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Removes specified roles from an agent. Only the roles matching both the role name and scope will be removed. The user must be authenticated as a human (not an agent) to use this endpoint.</p>
|
|
1172
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="agentId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">agentId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the agent.</p>
|
|
1173
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the agent.</p>
|
|
1174
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="roles" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand roles"><span class="property-name">roles</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">objects</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->RoleOperationItem<!-- -->) </span></div> <div><div html="<p>Array of role assignments specifying role names and their scopes</p>
|
|
1175
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Array of role assignments specifying role names and their scopes</p>
|
|
1176
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd oZuve" disabled=""><strong class="sc-eJvlPh fBhAXU">204<!-- --> </strong><div html="<p>Roles removed successfully</p>
|
|
1177
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Roles removed successfully</p>
|
|
1178
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request (e.g., unknown role name, invalid scope)</p>
|
|
1179
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request (e.g., unknown role name, invalid scope)</p>
|
|
1180
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1181
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1182
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">403<!-- --> </strong><div html="<p>Forbidden - only human users can remove roles</p>
|
|
1183
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Forbidden - only human users can remove roles</p>
|
|
1184
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Agent not found</p>
|
|
1185
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Agent not found</p>
|
|
1186
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="delete" class="sc-fQLpxn gKcHYQ http-verb delete">delete</span><span class="sc-jvKoal kZcHWP">/agents/{agentId}/roles</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/agents/{agentId}/roles</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2adkq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2adkq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2adkq»0" aria-labelledby="tab«R2adkq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"roles"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"roleName"</span>: <span class="token string">"GroupReadOnly"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><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">"group"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"groupId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R2edkq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2edkq»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R2edkq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2edkq»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2edkq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2edkq»2" data-rttab="true">403</li><li class="tab-error" role="tab" id="tab«R2edkq»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R2edkq»3" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2edkq»0" aria-labelledby="tab«R2edkq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2edkq»1" aria-labelledby="tab«R2edkq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2edkq»2" aria-labelledby="tab«R2edkq»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2edkq»3" aria-labelledby="tab«R2edkq»3"></div></div></div></div></div></div><div id="tag/Roles" data-section-id="tag/Roles" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Roles" aria-label="tag/Roles"></a>Roles</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>Role template management and listing</p>
|
|
1187
|
+
"><p>Role template management and listing</p>
|
|
1188
|
+
</div></div></div><div id="tag/Roles/operation/assignAgentRoles" data-section-id="tag/Roles/operation/assignAgentRoles" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/assignAgentRoles" id="operation/assignAgentRoles" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Roles/operation/assignAgentRoles" aria-label="tag/Roles/operation/assignAgentRoles"></a>Assign roles to an agent<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Assigns standard roles to an agent by replacing all existing role assignments. Roles are specified by their system-defined names and scopes. The user must be authenticated as a human (not an agent) to use this endpoint.</p>
|
|
1189
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Assigns standard roles to an agent by replacing all existing role assignments. Roles are specified by their system-defined names and scopes. The user must be authenticated as a human (not an agent) to use this endpoint.</p>
|
|
1190
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="agentId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">agentId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the agent.</p>
|
|
1191
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the agent.</p>
|
|
1192
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="roles" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand roles"><span class="property-name">roles</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">objects</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->RoleOperationItem<!-- -->) </span></div> <div><div html="<p>Array of role assignments specifying role names and their scopes</p>
|
|
1193
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Array of role assignments specifying role names and their scopes</p>
|
|
1194
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd oZuve" disabled=""><strong class="sc-eJvlPh fBhAXU">204<!-- --> </strong><div html="<p>Roles assigned successfully</p>
|
|
1195
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Roles assigned successfully</p>
|
|
1196
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request (e.g., unknown role name, invalid scope, duplicate roles)</p>
|
|
1197
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request (e.g., unknown role name, invalid scope, duplicate roles)</p>
|
|
1198
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1199
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1200
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">403<!-- --> </strong><div html="<p>Forbidden - only human users can assign roles</p>
|
|
1201
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Forbidden - only human users can assign roles</p>
|
|
1202
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Agent not found</p>
|
|
1203
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Agent not found</p>
|
|
1204
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="put" class="sc-fQLpxn dBzsUh http-verb put">put</span><span class="sc-jvKoal kZcHWP">/agents/{agentId}/roles</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/agents/{agentId}/roles</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2a9la»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2a9la»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2a9la»0" aria-labelledby="tab«R2a9la»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"roles"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"roleName"</span>: <span class="token string">"GroupReadOnly"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><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">"group"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"groupId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R2e9la»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2e9la»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R2e9la»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2e9la»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2e9la»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2e9la»2" data-rttab="true">403</li><li class="tab-error" role="tab" id="tab«R2e9la»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R2e9la»3" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2e9la»0" aria-labelledby="tab«R2e9la»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2e9la»1" aria-labelledby="tab«R2e9la»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2e9la»2" aria-labelledby="tab«R2e9la»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2e9la»3" aria-labelledby="tab«R2e9la»3"></div></div></div></div></div></div><div id="tag/Roles/operation/removeAgentRoles" data-section-id="tag/Roles/operation/removeAgentRoles" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/removeAgentRoles" id="operation/removeAgentRoles" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Roles/operation/removeAgentRoles" aria-label="tag/Roles/operation/removeAgentRoles"></a>Remove roles from an agent<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Removes specified roles from an agent. Only the roles matching both the role name and scope will be removed. The user must be authenticated as a human (not an agent) to use this endpoint.</p>
|
|
1205
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Removes specified roles from an agent. Only the roles matching both the role name and scope will be removed. The user must be authenticated as a human (not an agent) to use this endpoint.</p>
|
|
1206
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="agentId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">agentId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the agent.</p>
|
|
1207
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the agent.</p>
|
|
1208
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="roles" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand roles"><span class="property-name">roles</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">objects</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->RoleOperationItem<!-- -->) </span></div> <div><div html="<p>Array of role assignments specifying role names and their scopes</p>
|
|
1209
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Array of role assignments specifying role names and their scopes</p>
|
|
1210
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd oZuve" disabled=""><strong class="sc-eJvlPh fBhAXU">204<!-- --> </strong><div html="<p>Roles removed successfully</p>
|
|
1211
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Roles removed successfully</p>
|
|
1212
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request (e.g., unknown role name, invalid scope)</p>
|
|
1213
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request (e.g., unknown role name, invalid scope)</p>
|
|
1214
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1215
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1216
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">403<!-- --> </strong><div html="<p>Forbidden - only human users can remove roles</p>
|
|
1217
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Forbidden - only human users can remove roles</p>
|
|
1218
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>Agent not found</p>
|
|
1219
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Agent not found</p>
|
|
1220
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="delete" class="sc-fQLpxn gKcHYQ http-verb delete">delete</span><span class="sc-jvKoal kZcHWP">/agents/{agentId}/roles</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/agents/{agentId}/roles</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2aala»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2aala»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2aala»0" aria-labelledby="tab«R2aala»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"roles"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"roleName"</span>: <span class="token string">"GroupReadOnly"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><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">"group"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"groupId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R2eala»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2eala»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R2eala»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eala»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2eala»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eala»2" data-rttab="true">403</li><li class="tab-error" role="tab" id="tab«R2eala»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R2eala»3" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2eala»0" aria-labelledby="tab«R2eala»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2eala»1" aria-labelledby="tab«R2eala»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2eala»2" aria-labelledby="tab«R2eala»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2eala»3" aria-labelledby="tab«R2eala»3"></div></div></div></div></div></div><div id="tag/Roles/operation/listRoleTemplates" data-section-id="tag/Roles/operation/listRoleTemplates" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/listRoleTemplates" id="operation/listRoleTemplates" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Roles/operation/listRoleTemplates" aria-label="tag/Roles/operation/listRoleTemplates"></a>List predefined role templates<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns a list of all predefined role templates available in the system</p>
|
|
1221
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns a list of all predefined role templates available in the system</p>
|
|
1222
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>List of role templates</p>
|
|
1223
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>List of role templates</p>
|
|
1224
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1225
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1226
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/roles</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/roles</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2ebla»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2ebla»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R2ebla»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ebla»1" data-rttab="true">401</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2ebla»0" aria-labelledby="tab«R2ebla»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"roles"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"GroupReadOnly"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"permissions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"read"</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">"scope"</span>: <span class="token string">"group"</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="panel«R2ebla»1" aria-labelledby="tab«R2ebla»1"></div></div></div></div></div></div><div id="tag/Roles/operation/assignUserRoles" data-section-id="tag/Roles/operation/assignUserRoles" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/assignUserRoles" id="operation/assignUserRoles" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Roles/operation/assignUserRoles" aria-label="tag/Roles/operation/assignUserRoles"></a>Assign roles to a user<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Assigns standard roles to a user by replacing all existing role assignments. Roles are specified by their system-defined names and scopes. The user must be authenticated as a human (not an agent) to use this endpoint.</p>
|
|
1227
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Assigns standard roles to a user by replacing all existing role assignments. Roles are specified by their system-defined names and scopes. The user must be authenticated as a human (not an agent) to use this endpoint.</p>
|
|
1228
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="userId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">userId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the user.</p>
|
|
1229
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the user.</p>
|
|
1230
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="roles" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand roles"><span class="property-name">roles</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">objects</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->RoleOperationItem<!-- -->) </span></div> <div><div html="<p>Array of role assignments specifying role names and their scopes</p>
|
|
1231
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Array of role assignments specifying role names and their scopes</p>
|
|
1232
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd oZuve" disabled=""><strong class="sc-eJvlPh fBhAXU">204<!-- --> </strong><div html="<p>Roles assigned successfully</p>
|
|
1233
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Roles assigned successfully</p>
|
|
1234
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request (e.g., unknown role name, invalid scope, duplicate roles)</p>
|
|
1235
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request (e.g., unknown role name, invalid scope, duplicate roles)</p>
|
|
1236
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1237
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1238
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">403<!-- --> </strong><div html="<p>Forbidden - only human users can assign roles</p>
|
|
1239
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Forbidden - only human users can assign roles</p>
|
|
1240
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>User not found</p>
|
|
1241
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>User not found</p>
|
|
1242
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="put" class="sc-fQLpxn dBzsUh http-verb put">put</span><span class="sc-jvKoal kZcHWP">/users/{userId}/roles</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/users/{userId}/roles</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2acla»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2acla»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2acla»0" aria-labelledby="tab«R2acla»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"roles"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"roleName"</span>: <span class="token string">"GroupReadOnly"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><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">"group"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"groupId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R2ecla»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2ecla»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R2ecla»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ecla»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2ecla»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ecla»2" data-rttab="true">403</li><li class="tab-error" role="tab" id="tab«R2ecla»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R2ecla»3" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2ecla»0" aria-labelledby="tab«R2ecla»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ecla»1" aria-labelledby="tab«R2ecla»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ecla»2" aria-labelledby="tab«R2ecla»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2ecla»3" aria-labelledby="tab«R2ecla»3"></div></div></div></div></div></div><div id="tag/Roles/operation/removeUserRoles" data-section-id="tag/Roles/operation/removeUserRoles" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/removeUserRoles" id="operation/removeUserRoles" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Roles/operation/removeUserRoles" aria-label="tag/Roles/operation/removeUserRoles"></a>Remove roles from a user<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Removes specified roles from a user. Only the roles matching both the role name and scope will be removed. The user must be authenticated as a human (not an agent) to use this endpoint.</p>
|
|
1243
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Removes specified roles from a user. Only the roles matching both the role name and scope will be removed. The user must be authenticated as a human (not an agent) to use this endpoint.</p>
|
|
1244
|
+
</div></div><div class="sc-ikkVnJ deUlC"><div class="sc-hWgKua dPSGXF"><h5 class="sc-eqYatC sc-gFqXPY czjApA jCoZLr">Authorizations:</h5><svg class="sc-dntSTA FtowP" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jBaHRL fUkQtw"><span class="sc-iVnIWt gRXavu"><span class="sc-hqtLyI hRtRoN"><i>bearerAuth</i></span></span></div></div><div><h5 class="sc-eqYatC czjApA">path<!-- --> Parameters</h5><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="userId" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">userId</span><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq"> <!-- --><<!-- -->uuid<!-- -->><!-- --> </span></div> <div><div html="<p>The unique identifier (UUID) of the user.</p>
|
|
1245
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The unique identifier (UUID) of the user.</p>
|
|
1246
|
+
</div></div></div></td></tr></tbody></table></div><h5 class="sc-eqYatC czjApA">Request Body schema: <span class="sc-dNFkOE cFlAeY">application/json</span><div class="sc-bEjUoa sc-iIvHqT sc-eTCgfj lhyyLL crXmiY foplsk">required</div></h5><div html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><table class="sc-eqNDNG icJLQx"><tbody><tr class="last "><td kind="field" title="roles" class="sc-kCuUfV sc-fbQrwq sc-itBLYH gdmNWp dFOJWJ kdPQHX"><span class="sc-hwddKA cteAyA"></span><button aria-label="expand roles"><span class="property-name">roles</span><svg class="sc-dntSTA dOPmTa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-bEjUoa sc-iIvHqT lhyyLL crXmiY">required</div></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP">Array of </span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">objects</span><span class="sc-bEjUoa sc-hdBJTi lhyyLL nwQTz"> (<!-- -->RoleOperationItem<!-- -->) </span></div> <div><div html="<p>Array of role assignments specifying role names and their scopes</p>
|
|
1247
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Array of role assignments specifying role names and their scopes</p>
|
|
1248
|
+
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd oZuve" disabled=""><strong class="sc-eJvlPh fBhAXU">204<!-- --> </strong><div html="<p>Roles removed successfully</p>
|
|
1249
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Roles removed successfully</p>
|
|
1250
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">400<!-- --> </strong><div html="<p>Invalid request (e.g., unknown role name, invalid scope)</p>
|
|
1251
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Invalid request (e.g., unknown role name, invalid scope)</p>
|
|
1252
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">401<!-- --> </strong><div html="<p>Authentication required</p>
|
|
1253
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Authentication required</p>
|
|
1254
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">403<!-- --> </strong><div html="<p>Forbidden - only human users can remove roles</p>
|
|
1255
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Forbidden - only human users can remove roles</p>
|
|
1256
|
+
</div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="<p>User not found</p>
|
|
1257
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>User not found</p>
|
|
1258
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="delete" class="sc-fQLpxn gKcHYQ http-verb delete">delete</span><span class="sc-jvKoal kZcHWP">/users/{userId}/roles</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/users/{userId}/roles</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2adla»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2adla»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2adla»0" aria-labelledby="tab«R2adla»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"roles"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"roleName"</span>: <span class="token string">"GroupReadOnly"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><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">"group"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"groupId"</span>: <span class="token string">"a1b2c3d4-e5f6-7890-1234-567890abcdef"</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></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab«R2edla»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2edla»0" tabindex="0" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R2edla»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R2edla»1" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R2edla»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R2edla»2" data-rttab="true">403</li><li class="tab-error" role="tab" id="tab«R2edla»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R2edla»3" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2edla»0" aria-labelledby="tab«R2edla»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"code"</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">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"field"</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></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2edla»1" aria-labelledby="tab«R2edla»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2edla»2" aria-labelledby="tab«R2edla»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R2edla»3" aria-labelledby="tab«R2edla»3"></div></div></div></div></div></div><div id="tag/Health" data-section-id="tag/Health" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Health" aria-label="tag/Health"></a>Health</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="<p>Health check endpoints</p>
|
|
1259
|
+
"><p>Health check endpoints</p>
|
|
1260
|
+
</div></div></div><div id="tag/Health/operation/healthCheck" data-section-id="tag/Health/operation/healthCheck" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/healthCheck" id="operation/healthCheck" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/Health/operation/healthCheck" aria-label="tag/Health/operation/healthCheck"></a>Health check<!-- --> </h2><div class="sc-bfjeOH txIPi"><div html="<p>Returns the health status of the service</p>
|
|
1261
|
+
" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Returns the health status of the service</p>
|
|
1262
|
+
</div></div><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="<p>Health status</p>
|
|
1263
|
+
" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Health status</p>
|
|
1264
|
+
</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/health</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span></span>/health</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«Rjjlq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Rjjlq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Rjjlq»0" aria-labelledby="tab«Rjjlq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</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></div></div></div></div></div><div class="sc-evkzZa iZqpqg"></div></div></div>
|
|
733
1265
|
<script>
|
|
734
|
-
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"title":"Workflow Approval System API","description":"API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.","version":"0.0.6"},"tags":[{"name":"Workflows","description":"Workflow management and approval"},{"name":"Workflow Templates","description":"Workflow template management"},{"name":"Users","description":"User management"},{"name":"Groups","description":"Group management"},{"name":"Workflow Actions","description":"Workflow actions and voting"}],"paths":{"/workflows":{"post":{"summary":"Create a new workflow","description":"Creates a new workflow with approvers and rules","operationId":"createWorkflow","tags":["Workflows"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowCreate"}}}},"responses":{"201":{"description":"Workflow created successfully","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}},"get":{"summary":"List workflows","description":"Returns a list of workflows with optional filtering","operationId":"listWorkflows","tags":["Workflows"],"parameters":[{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"Number of results per page","schema":{"type":"integer","default":20}},{"name":"include","in":"query","description":"Comma-separated list of related objects to include in the response","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["workflow-template"]}}}],"responses":{"200":{"description":"List of workflows","content":{"application/json":{"schema":{"type":"object","required":["data","pagination"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Workflow"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/workflows/{workflowId}":{"get":{"summary":"Get workflow details","description":"Returns the details of a specific workflow","operationId":"getWorkflow","tags":["Workflows"],"parameters":[{"name":"workflowId","in":"path","required":true,"description":"The unique identifier of the workflow","schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma-separated list of related objects to include in the response","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["workflow-template"]}}}],"responses":{"200":{"description":"Workflow details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workflow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/workflows/{workflowId}/vote":{"post":{"summary":"Vote on a workflow","description":"Allows an authenticated entity to cast a vote (approve or veto) on a specific workflow.","operationId":"voteOnWorkflow","tags":["Workflow Actions"],"parameters":[{"name":"workflowId","in":"path","required":true,"description":"The unique identifier of the workflow","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowVoteRequest"}}}},"responses":{"200":{"description":"Vote cast successfully. Returns updated workflow details.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request (e.g., voter not authorized, invalid vote type/mode).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/workflows/{workflowId}/canVote":{"get":{"summary":"Check if the current entity can vote on a workflow","description":"Determines if the authenticated entity is eligible to cast a vote on the specified workflow.","operationId":"canVoteOnWorkflow","tags":["Workflow Actions"],"parameters":[{"name":"workflowId","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string"}}],"responses":{"200":{"description":"Eligibility to vote confirmed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CanVoteResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/users":{"post":{"summary":"Create a new user","description":"Creates a new user in the system.","operationId":"createUser","tags":["Users"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}}},"responses":{"201":{"description":"User created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"409":{"description":"User with this email already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}},"get":{"summary":"List users","description":"Returns a list of users","operationId":"listUsers","tags":["Users"],"parameters":[{"name":"search","in":"query","description":"Fuzzy search term for user display name or email.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"Number of results per page","schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"List of users","content":{"application/json":{"schema":{"type":"object","required":["users","pagination"],"properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserSummary"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/users/{userId}":{"get":{"summary":"Get user details","description":"Returns the details of a specific user by their ID.","operationId":"getUser","tags":["Users"],"parameters":[{"name":"userId","in":"path","required":true,"description":"The unique identifier (UUID) of the user.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"User details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/groups":{"post":{"summary":"Create a new approver group","description":"Create a new group for organizing approvers","operationId":"createGroup","tags":["Groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupCreate"}}}},"responses":{"201":{"description":"Group created successfully","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}},"get":{"summary":"List groups","description":"Returns a list of groups","operationId":"listGroups","tags":["Groups"],"parameters":[{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"Number of results per page","schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"List of groups","content":{"application/json":{"schema":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/Group"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["groups","pagination"]}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/groups/{groupIdentifier}":{"get":{"summary":"Get group details","description":"Returns the details of a specific group","operationId":"getGroup","tags":["Groups"],"parameters":[{"name":"groupIdentifier","in":"path","required":true,"description":"The unique identifier of the group or the name of the group","schema":{"type":"string"}}],"responses":{"200":{"description":"Group details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/groups/{groupId}/entities":{"get":{"summary":"List entities in a group","description":"Returns a list of all entities (users, systems, etc.) that belong to a specific group, including their roles.","operationId":"listGroupEntities","tags":["Groups","Users"],"parameters":[{"name":"groupId","in":"path","required":true,"description":"The unique identifier (UUID) of the group.","schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"Number of results per page","schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"List of entities in the group","content":{"application/json":{"schema":{"type":"object","required":["entities","pagination"],"properties":{"entities":{"type":"array","items":{"$ref":"#/components/schemas/GroupMembership"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"summary":"Add group entities","description":"Add entities (like users) within a specific group.","operationId":"addGroupEntities","tags":["Groups","Users"],"parameters":[{"name":"groupId","in":"path","required":true,"description":"The unique identifier (UUID) of the group.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddGroupEntitiesRequest"}}}},"responses":{"200":{"description":"Entities managed successfully. Returns updated group details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"409":{"description":"Conflict detected (e.g., adding an existing member).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}},"delete":{"summary":"Remove group entities","description":"Remove entities (like users) from a specific group.","operationId":"removeGroupEntities","tags":["Groups","Users"],"parameters":[{"name":"groupId","in":"path","required":true,"description":"The unique identifier (UUID) of the group.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveGroupEntitiesRequest"}}}},"responses":{"200":{"description":"Entities removed successfully. Returns updated group details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"409":{"description":"Conflict detected (e.g. removing a non-member).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/workflow-templates":{"post":{"summary":"Create a new workflow template","description":"Creates a new workflow template with approval rules, actions, and default expiry settings","operationId":"createWorkflowTemplate","tags":["Workflow Templates"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplateCreate"}}}},"responses":{"201":{"description":"Workflow template created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplate"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}},"get":{"summary":"List workflow templates","description":"Returns a list of workflow templates with optional filtering","operationId":"listWorkflowTemplates","tags":["Workflow Templates"],"parameters":[{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"Number of results per page","schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"List of workflow templates","content":{"application/json":{"schema":{"type":"object","required":["data","pagination"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowTemplateSummary"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/workflow-templates/{templateId}":{"get":{"summary":"Get workflow template details","description":"Returns the details of a specific workflow template","operationId":"getWorkflowTemplate","tags":["Workflow Templates"],"parameters":[{"name":"templateId","in":"path","required":true,"description":"The unique identifier of the workflow template","schema":{"type":"string"}}],"responses":{"200":{"description":"Workflow template details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplate"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"summary":"Update a workflow template","description":"Updates an existing workflow template","operationId":"updateWorkflowTemplate","tags":["Workflow Templates"],"parameters":[{"name":"templateId","in":"path","required":true,"description":"The unique identifier of the workflow template","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplateUpdate"}}}},"responses":{"200":{"description":"Workflow template updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplate"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"delete":{"summary":"Delete a workflow template","description":"Deletes a workflow template","operationId":"deleteWorkflowTemplate","tags":["Workflow Templates"],"parameters":[{"name":"templateId","in":"path","required":true,"description":"The unique identifier of the workflow template","schema":{"type":"string"}}],"responses":{"204":{"description":"Workflow template deleted successfully"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}},"components":{"schemas":{"UserSummary":{"type":"object","required":["id","displayName","email"],"properties":{"id":{"type":"string","format":"uuid","description":"Internal unique identifier for the user.","readOnly":true,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},"displayName":{"type":"string","description":"User's display name.","example":"Alex Chen"},"email":{"type":"string","format":"email","description":"User's email address.","example":"alex.chen@example.com"}}},"UserCreate":{"type":"object","required":["displayName","email","orgRole"],"properties":{"displayName":{"type":"string","description":"User's display name.","example":"Alex Chen"},"email":{"type":"string","format":"email","description":"User's email address (must be unique).","example":"alex.chen@example.com"},"orgRole":{"type":"string","x-extensible-enum":["admin","member"],"description":"Role assigned to the user within the group.","example":"member"}}},"User":{"type":"object","required":["id","displayName","email","createdAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Internal unique identifier for the user.","readOnly":true,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},"displayName":{"type":"string","description":"User's display name.","example":"Alex Chen"},"email":{"type":"string","format":"email","description":"User's email address.","example":"alex.chen@example.com"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the user was created.","readOnly":true,"example":"2025-04-15T12:05:00Z"}}},"EntityReference":{"type":"object","required":["entityType","entityId"],"properties":{"entityType":{"type":"string","x-extensible-enum":["human","system"],"description":"The type of the entity being referenced.","example":"human"},"entityId":{"type":"string","format":"uuid","description":"The unique identifier (UUID) of the entity.","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"}}},"EntityMembershipAdd":{"type":"object","required":["entity","role"],"properties":{"entity":{"$ref":"#/components/schemas/EntityReference"},"role":{"type":"string","x-extensible-enum":["approver","admin","owner","auditor"],"description":"Role assigned to the entity within the group.","example":"approver"}}},"EntityMembershipRemove":{"type":"object","required":["entity"],"properties":{"entity":{"$ref":"#/components/schemas/EntityReference"}}},"AddGroupEntitiesRequest":{"type":"object","description":"Defines operations to add entities within a group","required":["entities"],"properties":{"entities":{"type":"array","items":{"$ref":"#/components/schemas/EntityMembershipAdd"},"description":"List of entities to add to the group."}}},"RemoveGroupEntitiesRequest":{"type":"object","description":"Defines operations to remove entities within a group","required":["entities"],"properties":{"entities":{"type":"array","items":{"$ref":"#/components/schemas/EntityMembershipRemove"},"description":"List of entities to remove from the group."}}},"GroupMembership":{"type":"object","required":["entity","role","addedAt"],"properties":{"entity":{"$ref":"#/components/schemas/EntityReference"},"role":{"type":"string","x-extensible-enum":["approver","admin","owner","auditor"],"description":"The role of the entity within the group.","example":"approver"},"addedAt":{"type":"string","format":"date-time","description":"Timestamp when the entity was added to the group.","readOnly":true,"example":"2025-04-16T10:30:00Z"}}},"WorkflowTemplateSummary":{"type":"object","required":["id","name","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Internal unique identifier for the workflow template.","readOnly":true,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},"name":{"type":"string","description":"User-friendly name for the workflow template.","example":"New Workflow Template"},"description":{"type":"string","description":"Detailed description of the workflow template.","example":"This is a new workflow template"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the workflow template was created.","readOnly":true,"example":"2025-04-15T12:05:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the workflow template was last updated.","readOnly":true,"example":"2025-04-15T12:05:00Z"}}},"WorkflowCreate":{"type":"object","required":["name","workflowTemplateId"],"properties":{"name":{"type":"string","description":"User-friendly name for the workflow"},"description":{"type":"string","description":"Detailed description of the workflow"},"metadata":{"type":"object","description":"Additional custom metadata for the workflow"},"workflowTemplateId":{"type":"string","format":"uuid","description":"The unique identifier of the workflow template to use as parent"}}},"Workflow":{"type":"object","required":["id","name","status","workflowTemplateId","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","description":"Unique identifier for the workflow"},"name":{"type":"string","description":"User-friendly name for the workflow"},"description":{"type":"string","description":"Detailed description of the workflow"},"status":{"type":"string","x-extensible-enum":["APPROVED","REJECTED","CANCELED","EVALUATION_IN_PROGRESS","EXPIRED"],"description":"Current status of the workflow"},"workflowTemplateId":{"type":"string","format":"uuid","description":"The unique identifier of the workflow template used as parent"},"metadata":{"type":"object","description":"Additional custom metadata for the workflow"},"ref":{"type":"object","description":"Referenced objects (optional, controlled by include query parameters)","properties":{"workflowTemplate":{"$ref":"#/components/schemas/WorkflowTemplate"}}},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"expiresAt":{"type":"string","format":"date-time","description":"Expiry timestamp","readOnly":true,"example":"2025-04-15T12:05:00Z"}}},"ApprovalRule":{"description":"Configuration of approval rules. Can be a boolean operator (AND/OR) combining nested rules, or a specific requirement (minimum count from a group).\n","oneOf":[{"$ref":"#/components/schemas/AndRule"},{"$ref":"#/components/schemas/OrRule"},{"$ref":"#/components/schemas/GroupRequirementRule"}],"discriminator":{"propertyName":"type","mapping":{"AND":"#/components/schemas/AndRule","OR":"#/components/schemas/OrRule","GROUP_REQUIREMENT":"#/components/schemas/GroupRequirementRule"}}},"AndRule":{"type":"object","description":"An AND rule requiring all nested rules to be satisfied.","required":["type","rules"],"properties":{"type":{"type":"string","enum":["AND"],"description":"Rule type (AND)"},"rules":{"type":"array","description":"List of rules that must all be satisfied. Cannot be empty.","minItems":1,"items":{"$ref":"#/components/schemas/ApprovalRule"}}}},"OrRule":{"type":"object","description":"An OR rule requiring at least one of the nested rules to be satisfied.","required":["type","rules"],"properties":{"type":{"type":"string","enum":["OR"],"description":"Rule type (OR)"},"rules":{"type":"array","description":"List of rules where at least one must be satisfied. Cannot be empty.","minItems":1,"items":{"$ref":"#/components/schemas/ApprovalRule"}}}},"GroupRequirementRule":{"type":"object","description":"Requires a minimum number of approvals from a specific group.","required":["type","groupId","minCount"],"properties":{"type":{"type":"string","enum":["GROUP_REQUIREMENT"],"description":"Rule type (GROUP_REQUIREMENT)"},"groupId":{"type":"string","description":"ID of the approver group."},"minCount":{"type":"integer","description":"Minimum number of approvals required from the group. Must be at least 1.","minimum":1}}},"GroupCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the group"},"description":{"type":"string","description":"Description of the group"}}},"Group":{"type":"object","required":["id","name","entitiesCount","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the group"},"name":{"type":"string","description":"Name of the group"},"description":{"type":"string","description":"Description of the group"},"entitiesCount":{"type":"integer","description":"Number of entities in the group"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"}}},"Pagination":{"type":"object","required":["total","page","limit"],"properties":{"total":{"type":"integer","description":"Total number of items"},"page":{"type":"integer","description":"Current page number"},"limit":{"type":"integer","description":"Items per page"}}},"APIError":{"type":"object","properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}}}},"WorkflowVoteRequest":{"type":"object","title":"WorkflowVoteRequest","required":["voteType"],"properties":{"reason":{"type":"string","description":"Optional reason for the vote. Can be used for approval comments or reject reasons.","example":"Missing critical information or LGTM!"},"voteType":{"oneOf":[{"$ref":"#/components/schemas/VoteApprove"},{"$ref":"#/components/schemas/VoteVeto"},{"$ref":"#/components/schemas/VoteWithdraw"}],"discriminator":{"propertyName":"type","mapping":{"APPROVE":"#/components/schemas/VoteApprove","VETO":"#/components/schemas/VoteVeto","WITHDRAW":"#/components/schemas/VoteWithdraw"}}}}},"CanVoteResponse":{"type":"object","title":"CanVoteResponse","required":["canVote","voteStatus"],"properties":{"canVote":{"type":"boolean","description":"True if the authenticated entity can currently vote on the workflow, false otherwise."},"voteStatus":{"type":"string","x-extensible-enum":["ALREADY_VOTED","VOTE_PENDING"],"description":"Indicates the voting status for the user on this workflow.\n","example":"VOTE_PENDING"},"cantVoteReason":{"type":"string","description":"Reason why the entity cannot vote on the workflow. The value is only set if 'canVote' is false.","x-extensible-enum":["WORKFLOW_EXPIRED","WORKFLOW_APPROVED","WORKFLOW_CANCELED","NOT_ELIGIBLE_TO_VOTE"]}}},"VoteApprove":{"type":"object","required":["type","votedForGroups"],"properties":{"type":{"type":"string","enum":["APPROVE"],"description":"Vote type (APPROVE)"},"votedForGroups":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of group IDs the vote is cast for.","example":["a1b2c3d4-e5f6-7890-1234-567890abcdef"]}}},"VoteVeto":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["VETO"],"description":"Vote type (VETO)"}}},"VoteWithdraw":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["WITHDRAW"],"description":"Vote type (WITHDRAW)"}}},"WorkflowTemplateCreate":{"type":"object","required":["name","approvalRule"],"properties":{"name":{"type":"string","description":"User-friendly name for the workflow template"},"description":{"type":"string","description":"Detailed description of the workflow template"},"metadata":{"type":"object","description":"Additional custom metadata for the workflow template"},"approvalRule":{"$ref":"#/components/schemas/ApprovalRule"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowAction"},"description":"Actions to be executed when workflow is approved"},"defaultExpiresInHours":{"type":"integer","minimum":1,"maximum":8760,"description":"Default expiry time for workflows created from this template (in hours, max 1 year)"}}},"WorkflowTemplate":{"type":"object","required":["id","name","approvalRule","createdAt","updatedAt"],"properties":{"id":{"type":"string","description":"Unique identifier for the workflow template"},"name":{"type":"string","description":"User-friendly name for the workflow template"},"description":{"type":"string","description":"Detailed description of the workflow template"},"approvalRule":{"$ref":"#/components/schemas/ApprovalRule"},"metadata":{"type":"object","description":"Additional custom metadata for the workflow template"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowAction"},"description":"Actions to be executed when workflow is approved"},"defaultExpiresInHours":{"type":"integer","minimum":1,"maximum":8760,"description":"Default expiry time for workflows created from this template (in hours, max 1 year)"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"}}},"WorkflowTemplateUpdate":{"type":"object","properties":{"name":{"type":"string","description":"User-friendly name for the workflow template"},"description":{"type":"string","description":"Detailed description of the workflow template"},"metadata":{"type":"object","description":"Additional custom metadata for the workflow template"},"approvalRule":{"$ref":"#/components/schemas/ApprovalRule"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowAction"},"description":"Actions to be executed when workflow is approved"},"defaultExpiresInHours":{"type":"integer","minimum":1,"maximum":8760,"description":"Default expiry time for workflows created from this template (in hours, max 1 year)"}}},"WorkflowAction":{"description":"Configuration for actions to be executed when workflow is approved. Currently supports email actions.\n","oneOf":[{"$ref":"#/components/schemas/EmailAction"}],"discriminator":{"propertyName":"type","mapping":{"EMAIL":"#/components/schemas/EmailAction"}}},"EmailAction":{"type":"object","description":"Sends an email when workflow is approved","required":["type","recipients"],"properties":{"type":{"type":"string","enum":["EMAIL"],"description":"Action type (EMAIL)"},"recipients":{"type":"array","items":{"type":"string","format":"email"},"description":"List of email addresses to send the notification to","minItems":1,"maxItems":5}}}},"responses":{"BadRequest":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"Unauthorized":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"security":[{"bearerAuth":[]}]}},"searchIndex":{"store":["tag/Workflows","tag/Workflows/operation/createWorkflow","tag/Workflows/operation/listWorkflows","tag/Workflows/operation/getWorkflow","tag/Workflow-Templates","tag/Workflow-Templates/operation/createWorkflowTemplate","tag/Workflow-Templates/operation/listWorkflowTemplates","tag/Workflow-Templates/operation/getWorkflowTemplate","tag/Workflow-Templates/operation/updateWorkflowTemplate","tag/Workflow-Templates/operation/deleteWorkflowTemplate","tag/Users","tag/Users/operation/createUser","tag/Users/operation/listUsers","tag/Users/operation/getUser","tag/Users/operation/listGroupEntities","tag/Users/operation/addGroupEntities","tag/Users/operation/removeGroupEntities","tag/Groups","tag/Groups/operation/createGroup","tag/Groups/operation/listGroups","tag/Groups/operation/getGroup","tag/Groups/operation/listGroupEntities","tag/Groups/operation/addGroupEntities","tag/Groups/operation/removeGroupEntities","tag/Workflow-Actions","tag/Workflow-Actions/operation/voteOnWorkflow","tag/Workflow-Actions/operation/canVoteOnWorkflow"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.074]],["description/0",[0,0.069,1,2.298,2,1.836]],["title/1",[0,0.052,3,1.12,4,1.12]],["description/1",[0,0.076,2,1.46,3,1.192,4,1.192,5,2.416]],["title/2",[0,0.061,6,0.89]],["description/2",[0,0.076,6,0.806,7,0.981,8,2.416,9,2.416]],["title/3",[0,0.061,10,1.315]],["description/3",[0,0.059,7,1.053,10,1.279,11,0.955,12,3.141]],["title/4",[0,0.061,13,0.89]],["description/4",[0,0.069,1,2.298,13,1.014]],["title/5",[0,0.045,3,0.976,4,0.976,13,0.66]],["description/5",[0,0.041,2,1.089,3,0.889,4,0.889,5,1.802,13,0.601,14,1.551,15,2.183,16,2.183,17,2.183,18,1.802]],["title/6",[0,0.052,6,0.758,13,0.758]],["description/6",[0,0.052,6,0.755,7,0.918,8,2.262,9,2.262,13,0.755,18,2.262]],["title/7",[0,0.052,10,1.12,13,0.758]],["description/7",[0,0.055,7,0.981,10,1.192,11,0.89,13,0.806,19,2.079]],["title/8",[0,0.052,13,0.758,20,2.27]],["description/8",[0,0.059,13,0.865,19,2.232,20,2.593,21,3.141]],["title/9",[0,0.052,13,0.758,22,2.27]],["description/9",[0,0.064,13,0.934,19,2.408,22,2.797]],["title/10",[23,0.879]],["description/10",[1,2.514,23,0.905]],["title/11",[3,1.12,4,1.12,23,0.618]],["description/11",[3,1.279,4,1.279,23,0.949,24,2.232]],["title/12",[6,0.89,23,0.726]],["description/12",[6,0.934,7,1.136,23,0.998]],["title/13",[10,1.315,23,0.726]],["description/13",[7,0.981,10,1.192,11,0.89,23,0.658,25,2.927,26,2.927]],["title/14",[6,0.758,27,0.556,28,0.293]],["description/14",[6,0.572,7,0.696,11,0.632,23,0.467,24,1.476,27,0.42,28,0.221,29,1.715,30,1.715,31,1.715,32,1.715,33,1.036]],["title/15",[27,0.556,28,0.293,34,1.718]],["description/15",[11,0.833,23,0.616,27,0.554,28,0.292,33,1.367,34,1.711,35,2.262]],["title/16",[27,0.556,28,0.293,36,1.718]],["description/16",[11,0.89,23,0.658,27,0.591,28,0.312,33,1.46,36,1.828]],["title/17",[28,0.416]],["description/17",[1,2.514,28,0.429]],["title/18",[2,1.195,3,0.976,4,0.976,28,0.255]],["description/18",[2,1.46,3,1.192,4,1.192,28,0.429,37,2.927]],["title/19",[6,0.89,28,0.344]],["description/19",[6,0.934,7,1.136,28,0.473]],["title/20",[10,1.315,28,0.344]],["description/20",[7,1.053,10,1.279,11,0.955,28,0.335,38,3.141]],["title/21",[6,0.758,27,0.556,28,0.293]],["description/21",[6,0.572,7,0.696,11,0.632,23,0.467,24,1.476,27,0.42,28,0.221,29,1.715,30,1.715,31,1.715,32,1.715,33,1.036]],["title/22",[27,0.556,28,0.293,34,1.718]],["description/22",[11,0.833,23,0.616,27,0.554,28,0.292,33,1.367,34,1.711,35,2.262]],["title/23",[27,0.556,28,0.293,36,1.718]],["description/23",[11,0.89,23,0.658,27,0.591,28,0.312,33,1.46,36,1.828]],["title/24",[0,0.061,14,2.294]],["description/24",[0,0.069,14,2.614,39,2.046]],["title/25",[0,0.061,39,1.795]],["description/25",[0,0.043,2,1.147,11,0.699,27,0.465,39,1.279,40,2.3,41,1.898,42,1.898,43,2.3,44,2.3]],["title/26",[0,0.04,27,0.429,39,1.179,45,2.121,46,2.121]],["description/26",[0,0.046,27,0.491,39,1.351,41,2.006,42,2.006,47,2.43,48,2.43,49,2.43,50,2.43]]],"invertedIndex":[["action",{"_index":14,"title":{"24":{}},"description":{"5":{},"24":{}}}],["add",{"_index":34,"title":{"15":{},"22":{}},"description":{"15":{},"22":{}}}],["allow",{"_index":40,"title":{},"description":{"25":{}}}],["approv",{"_index":2,"title":{"18":{}},"description":{"0":{},"1":{},"5":{},"18":{},"25":{}}}],["authent",{"_index":41,"title":{},"description":{"25":{},"26":{}}}],["belong",{"_index":30,"title":{},"description":{"14":{},"21":{}}}],["cast",{"_index":42,"title":{},"description":{"25":{},"26":{}}}],["check",{"_index":45,"title":{"26":{}},"description":{}}],["creat",{"_index":3,"title":{"1":{},"5":{},"11":{},"18":{}},"description":{"1":{},"5":{},"11":{},"18":{}}}],["current",{"_index":46,"title":{"26":{}},"description":{}}],["default",{"_index":15,"title":{},"description":{"5":{}}}],["delet",{"_index":22,"title":{"9":{}},"description":{"9":{}}}],["detail",{"_index":10,"title":{"3":{},"7":{},"13":{},"20":{}},"description":{"3":{},"7":{},"13":{},"20":{}}}],["determin",{"_index":47,"title":{},"description":{"26":{}}}],["elig",{"_index":48,"title":{},"description":{"26":{}}}],["entiti",{"_index":27,"title":{"14":{},"15":{},"16":{},"21":{},"22":{},"23":{},"26":{}},"description":{"14":{},"15":{},"16":{},"21":{},"22":{},"23":{},"25":{},"26":{}}}],["etc",{"_index":29,"title":{},"description":{"14":{},"21":{}}}],["exist",{"_index":21,"title":{},"description":{"8":{}}}],["expiri",{"_index":16,"title":{},"description":{"5":{}}}],["filter",{"_index":9,"title":{},"description":{"2":{},"6":{}}}],["group",{"_index":28,"title":{"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{}},"description":{"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{}}}],["groups/{groupidentifi",{"_index":38,"title":{},"description":{"20":{}}}],["groups/{groupid}/ent",{"_index":33,"title":{},"description":{"14":{},"15":{},"16":{},"21":{},"22":{},"23":{}}}],["id",{"_index":25,"title":{},"description":{"13":{}}}],["includ",{"_index":31,"title":{},"description":{"14":{},"21":{}}}],["list",{"_index":6,"title":{"2":{},"6":{},"12":{},"14":{},"19":{},"21":{}},"description":{"2":{},"6":{},"12":{},"14":{},"19":{},"21":{}}}],["manag",{"_index":1,"title":{},"description":{"0":{},"4":{},"10":{},"17":{}}}],["new",{"_index":4,"title":{"1":{},"5":{},"11":{},"18":{}},"description":{"1":{},"5":{},"11":{},"18":{}}}],["option",{"_index":8,"title":{},"description":{"2":{},"6":{}}}],["organ",{"_index":37,"title":{},"description":{"18":{}}}],["remov",{"_index":36,"title":{"16":{},"23":{}},"description":{"16":{},"23":{}}}],["return",{"_index":7,"title":{},"description":{"2":{},"3":{},"6":{},"7":{},"12":{},"13":{},"14":{},"19":{},"20":{},"21":{}}}],["role",{"_index":32,"title":{},"description":{"14":{},"21":{}}}],["rule",{"_index":5,"title":{},"description":{"1":{},"5":{}}}],["set",{"_index":17,"title":{},"description":{"5":{}}}],["specif",{"_index":11,"title":{},"description":{"3":{},"7":{},"13":{},"14":{},"15":{},"16":{},"20":{},"21":{},"22":{},"23":{},"25":{}}}],["specifi",{"_index":49,"title":{},"description":{"26":{}}}],["system",{"_index":24,"title":{},"description":{"11":{},"14":{},"21":{}}}],["templat",{"_index":13,"title":{"4":{},"5":{},"6":{},"7":{},"8":{},"9":{}},"description":{"4":{},"5":{},"6":{},"7":{},"8":{},"9":{}}}],["updat",{"_index":20,"title":{"8":{}},"description":{"8":{}}}],["user",{"_index":23,"title":{"10":{},"11":{},"12":{},"13":{}},"description":{"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"21":{},"22":{},"23":{}}}],["users/{userid",{"_index":26,"title":{},"description":{"13":{}}}],["veto",{"_index":43,"title":{},"description":{"25":{}}}],["vote",{"_index":39,"title":{"25":{},"26":{}},"description":{"24":{},"25":{},"26":{}}}],["within",{"_index":35,"title":{},"description":{"15":{},"22":{}}}],["workflow",{"_index":0,"title":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"24":{},"25":{},"26":{}},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"24":{},"25":{},"26":{}}}],["workflow-templ",{"_index":18,"title":{},"description":{"5":{},"6":{}}}],["workflow-templates/{templateid",{"_index":19,"title":{},"description":{"7":{},"8":{},"9":{}}}],["workflows/{workflowid",{"_index":12,"title":{},"description":{"3":{}}}],["workflows/{workflowid}/canvot",{"_index":50,"title":{},"description":{"26":{}}}],["workflows/{workflowid}/vot",{"_index":44,"title":{},"description":{"25":{}}}]],"pipeline":[]}},"options":{}};
|
|
1266
|
+
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"title":"Workflow Approval System API","description":"API for a SaaS platform that allows customers to manage approvals for generic workflows, users, and groups.","version":"0.0.28"},"tags":[{"name":"Authentication","description":"OIDC authentication and token management"},{"name":"Workflows","description":"Workflow management and approval"},{"name":"Workflow Templates","description":"Workflow template management"},{"name":"Users","description":"User management"},{"name":"Groups","description":"Group management"},{"name":"Spaces","description":"Space management"},{"name":"Organization Admins","description":"Organization administrator management"},{"name":"Workflow Actions","description":"Workflow actions and voting"},{"name":"Agents","description":"Agent registration and management"},{"name":"Roles","description":"Role template management and listing"},{"name":"Health","description":"Health check endpoints"}],"paths":{"/health":{"get":{"summary":"Health check","description":"Returns the health status of the service","operationId":"healthCheck","tags":["Health"],"security":[],"responses":{"200":{"description":"Health status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}}}}},"/auth/login":{"get":{"summary":"Initiate OIDC login","description":"Initiates OIDC authentication by generating PKCE challenge and redirecting to the OIDC provider","operationId":"initiateLogin","tags":["Authentication"],"security":[],"responses":{"302":{"description":"Redirect to OIDC provider for authentication"},"500":{"description":"Failed to initiate login","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/auth/callback":{"get":{"summary":"Handle OIDC callback","description":"Handles the callback from OIDC provider and redirects to success page with authorization code","operationId":"handleCallback","tags":["Authentication"],"security":[],"parameters":[{"in":"query","name":"query","schema":{"$ref":"#/components/schemas/OidcCallbackRequest"},"style":"form","explode":true}],"responses":{"302":{"description":"Redirect to success page with code and state parameters"},"400":{"description":"Missing required parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/auth/token":{"post":{"summary":"Exchange authorization code for JWT token","description":"Exchanges the authorization code and state for a JWT token containing user information and roles","operationId":"exchangeToken","tags":["Authentication"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenRequest"}}}},"responses":{"200":{"description":"JWT token generated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/auth/refresh":{"post":{"summary":"Refresh JWT token","description":"Exchanges a refresh token for a new pair of access and refresh tokens","operationId":"refreshUserToken","tags":["Authentication"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshTokenRequest"}}}},"responses":{"200":{"description":"Tokens refreshed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"description":"Invalid or expired refresh token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/auth/success":{"get":{"summary":"Authentication success page","description":"Returns success message for completed authentication","operationId":"authSuccess","tags":["Authentication"],"security":[],"parameters":[{"in":"query","name":"query","schema":{"$ref":"#/components/schemas/OidcCallbackRequest"},"style":"form","explode":true}],"responses":{"200":{"description":"Authentication successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessfulAuthResponse"}}}}}}},"/auth/error":{"get":{"summary":"Authentication error page","description":"Returns error message for failed authentication","operationId":"authError","tags":["Authentication"],"security":[],"responses":{"200":{"description":"Authentication failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedAuthResponse"}}}}}}},"/auth/cli/initiate":{"post":{"summary":"Initiate OIDC login for CLI","description":"Initiates OIDC authentication specifying a loopback redirect URI for the CLI","operationId":"initiateCliLogin","tags":["Authentication"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["redirectUri"],"properties":{"redirectUri":{"type":"string","description":"The local loopback URL to redirect the user to after authentication"}}}}}},"responses":{"200":{"description":"Authorization URL generated","content":{"application/json":{"schema":{"type":"object","required":["authorizationUrl"],"properties":{"authorizationUrl":{"type":"string"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}},"/auth/web/callback":{"get":{"summary":"Handle Web OIDC callback","description":"Exchanges authorization code for tokens and sets them as HttpOnly cookies, then redirects to frontend","operationId":"webCallback","tags":["Authentication"],"security":[],"parameters":[{"in":"query","name":"query","schema":{"$ref":"#/components/schemas/OidcCallbackRequest"},"style":"form","explode":true}],"responses":{"302":{"description":"Redirect to the frontend depending on success or failure of the auth exchange"}}}},"/auth/web/refresh":{"post":{"summary":"Refresh Web JWT token","description":"Takes the refresh_token from the HttpOnly cookie and issues a new pair of tokens as cookies","operationId":"refreshUserTokenWeb","tags":["Authentication"],"security":[],"responses":{"204":{"description":"Tokens refreshed successfully, set as cookies"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"description":"Invalid or expired refresh token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/auth/web/initiatePrivilegedTokenExchange":{"post":{"summary":"Initiate Web privilege token generation (step-up)","description":"Initiates step-up authentication flow returning the authorization URL as JSON.","operationId":"initiatePrivilegeTokenWeb","tags":["Authentication"],"responses":{"200":{"description":"Authorization URL generated","content":{"application/json":{"schema":{"type":"object","required":["authorizationUrl"],"properties":{"authorizationUrl":{"type":"string"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"description":"Failed to initiate step-up","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/auth/web/exchangePrivilegedToken":{"post":{"summary":"Exchange Web privilege token","description":"Exchanges an IDP token for a high-privilege step-up token and sets it as an HttpOnly cookie.","operationId":"exchangePrivilegeTokenWeb","tags":["Authentication"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivilegedTokenExchangeRequest"}}}},"responses":{"204":{"description":"Privilege token set as cookie successfully"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/auth/initiatePrivilegedTokenExchange":{"get":{"summary":"Initiate privilege token generation (step-up)","description":"Initiates the step-up authentication flow by generating an authorization URL for the IDP provider.","operationId":"initiatePrivilegedTokenExchange","tags":["Authentication"],"responses":{"302":{"description":"Redirect to IDP for step-up authentication"},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"description":"Failed to initiate step-up","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/auth/exchangePrivilegedToken":{"post":{"summary":"Exchange privilege token","description":"Exchanges an IDP token for a high-privilege step-up token.","operationId":"exchangePrivilegedToken","tags":["Authentication"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivilegedTokenExchangeRequest"}}}},"responses":{"200":{"description":"Privilege token generated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivilegedTokenResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/auth/info":{"get":{"summary":"Get authenticated entity information","description":"Returns basic information about the authenticated entity","operationId":"getEntityInfo","tags":["Authentication"],"responses":{"200":{"description":"Entity information retrieved successfully","content":{"application/json":{"schema":{"type":"object","required":["entityType","groups"],"properties":{"entityType":{"type":"string","description":"Type of the authenticated entity","example":"user"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/GroupInfo"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/auth/agents/challenge":{"post":{"summary":"Generate authentication challenge for agent","description":"Creates an encrypted challenge that must be signed by the agent to obtain a token.\n\n**Challenge Format (Server → Agent):**\nThe server generates a challenge encrypted with the agent's public key. When decrypted and base64 decoded, it contains a JSON object with:\n- `audience`: string (agent name)\n- `expires_at`: ISO 8601 formatted date-time string\n- `issuer`: string (the name of the SaaS platform, e.g., \"Approvio\")\n- `nonce`: a random string to ensure uniqueness (the actual challenge)\n","operationId":"generateAgentChallenge","tags":["Authentication"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentChallengeRequest"}}}},"responses":{"200":{"description":"Challenge generated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentChallengeResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"description":"Agent not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/auth/agents/token":{"post":{"summary":"Exchange JWT assertion for access token","description":"Validates a JWT assertion and returns a JWT access token for the authenticated agent using OAuth 2.0 JWT Bearer profile (RFC 7523).\n\n**JWT Assertion Requirements:**\nThe agent must create and sign a JWT assertion with their private key containing:\n- `iss` (issuer): Agent name\n- `sub` (subject): Agent name (same as issuer for client authentication)\n- `aud` (audience): Authorization server identifier \n- `exp` (expiration): JWT expiration time (Unix timestamp)\n- `jti` (JWT ID): Unique nonce from the server's challenge (prevents replay attacks)\n- `iat` (issued at): JWT issued time (Unix timestamp, optional)\n\n**Security Notes:**\n- JWT must be signed with RS256 algorithm using the agent's private key\n- Server verifies signature using agent's registered public key\n- Each challenge nonce can only be used once (replay protection)\n- Agent identity is extracted from the JWT issuer claim\n","operationId":"exchangeAgentToken","tags":["Authentication"],"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTokenRequest"}}}},"responses":{"200":{"description":"JWT token generated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTokenResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"description":"Invalid or expired challenge","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"404":{"description":"Agent not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"409":{"description":"Challenge already used","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/auth/agents/refresh":{"post":{"summary":"Refresh agent JWT token","description":"Exchanges a refresh token for a new pair of access and refresh tokens. Requires DPoP proof.","operationId":"refreshAgentToken","tags":["Authentication"],"security":[],"parameters":[{"name":"DPoP","in":"header","required":true,"description":"DPoP proof based on RFC 9449","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshTokenRequest"}}}},"responses":{"200":{"description":"Tokens refreshed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTokenResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"description":"Invalid or expired refresh token, or DPoP mismatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/agents":{"get":{"summary":"List agents","description":"Returns a list of agents","operationId":"listAgents","tags":["Agents"],"parameters":[{"name":"params","in":"query","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/ListAgentsParams"}}],"responses":{"200":{"description":"List of agents","content":{"application/json":{"schema":{"type":"object","required":["agents","pagination"],"properties":{"agents":{"type":"array","items":{"$ref":"#/components/schemas/AgentSummary"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/agents/register":{"post":{"summary":"Register a new agent","description":"Creates a new agent registration entry with generated asymmetric key pair for future authentication","operationId":"registerAgent","tags":["Agents"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRegistrationRequest"}}}},"responses":{"201":{"description":"Agent registered successfully","headers":{"Location":{"description":"URL of the created agent","schema":{"type":"string","format":"uri"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRegistrationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"409":{"description":"Agent with this name already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/agents/{agentIdOrName}":{"get":{"summary":"Get agent details","description":"Returns the details of a specific agent by their ID or name.","operationId":"getAgent","tags":["Agents"],"parameters":[{"name":"agentIdOrName","in":"path","required":true,"description":"The unique identifier (UUID) or the name of the agent.","schema":{"type":"string"}}],"responses":{"200":{"description":"Agent details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentGet200Response"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/agents/{agentId}/roles":{"put":{"summary":"Assign roles to an agent","description":"Assigns standard roles to an agent by replacing all existing role assignments. Roles are specified by their system-defined names and scopes. The user must be authenticated as a human (not an agent) to use this endpoint.\n","operationId":"assignAgentRoles","tags":["Agents","Roles"],"parameters":[{"name":"agentId","in":"path","required":true,"description":"The unique identifier (UUID) of the agent.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleAssignmentRequest"}}}},"responses":{"204":{"description":"Roles assigned successfully"},"400":{"description":"Invalid request (e.g., unknown role name, invalid scope, duplicate roles)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"Forbidden - only human users can assign roles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"404":{"description":"Agent not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}},"delete":{"summary":"Remove roles from an agent","description":"Removes specified roles from an agent. Only the roles matching both the role name and scope will be removed. The user must be authenticated as a human (not an agent) to use this endpoint.\n","operationId":"removeAgentRoles","tags":["Agents","Roles"],"parameters":[{"name":"agentId","in":"path","required":true,"description":"The unique identifier (UUID) of the agent.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleRemovalRequest"}}}},"responses":{"204":{"description":"Roles removed successfully"},"400":{"description":"Invalid request (e.g., unknown role name, invalid scope)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"Forbidden - only human users can remove roles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"404":{"description":"Agent not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/roles":{"get":{"summary":"List predefined role templates","description":"Returns a list of all predefined role templates available in the system","operationId":"listRoleTemplates","tags":["Roles"],"responses":{"200":{"description":"List of role templates","content":{"application/json":{"schema":{"type":"object","required":["roles"],"properties":{"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleTemplate"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/workflows":{"post":{"summary":"Create a new workflow","description":"Creates a new workflow with approvers and rules","operationId":"createWorkflow","tags":["Workflows"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowCreate"}}}},"responses":{"201":{"description":"Workflow created successfully","headers":{"Location":{"description":"URL of the created workflow","schema":{"type":"string","format":"uri"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}},"get":{"summary":"List workflows","description":"Returns a list of workflows with optional filtering","operationId":"listWorkflows","tags":["Workflows"],"parameters":[{"name":"params","in":"query","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/ListWorkflowsParams"}}],"responses":{"200":{"description":"List of workflows","content":{"application/json":{"schema":{"type":"object","required":["data","pagination"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Workflow"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/workflows/{workflowId}":{"get":{"summary":"Get workflow details","description":"Returns the details of a specific workflow","operationId":"getWorkflow","tags":["Workflows"],"parameters":[{"name":"workflowId","in":"path","required":true,"description":"The unique identifier or name of the workflow","schema":{"type":"string"}},{"name":"params","in":"query","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/GetWorkflowParams"}}],"responses":{"200":{"description":"Workflow details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workflow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/workflows/{workflowId}/vote":{"post":{"summary":"Vote on a workflow","description":"Allows an authenticated entity to cast a vote (approve or veto) on a specific workflow.","operationId":"voteOnWorkflow","tags":["Workflow Actions"],"parameters":[{"name":"workflowId","in":"path","required":true,"description":"The unique identifier of the workflow","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowVoteRequest"}}}},"responses":{"200":{"description":"Vote cast successfully. Returns updated workflow details.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request (e.g., voter not authorized, invalid vote type/mode).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/workflows/{workflowId}/votes":{"get":{"summary":"Retrieve votes for a workflow","description":"Returns a list of all votes cast for the specified workflow.","operationId":"getWorkflowVotes","tags":["Workflow Actions"],"parameters":[{"name":"workflowId","in":"path","required":true,"description":"The unique identifier of the workflow","schema":{"type":"string"}}],"responses":{"200":{"description":"List of votes","content":{"application/json":{"schema":{"type":"object","required":["votes"],"properties":{"votes":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowVote"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/workflows/{workflowId}/canVote":{"get":{"summary":"Check if the current entity can vote on a workflow","description":"Determines if the authenticated entity is eligible to cast a vote on the specified workflow.","operationId":"canVoteOnWorkflow","tags":["Workflow Actions"],"parameters":[{"name":"workflowId","in":"path","required":true,"description":"The unique identifier of the workflow.","schema":{"type":"string"}}],"responses":{"200":{"description":"Eligibility to vote confirmed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CanVoteResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/users":{"post":{"summary":"Create a new user","description":"Creates a new user in the system.","operationId":"createUser","tags":["Users"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}}},"responses":{"201":{"description":"User created successfully","headers":{"Location":{"description":"URL of the created user","schema":{"type":"string","format":"uri"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"409":{"description":"User with this email already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}},"get":{"summary":"List users","description":"Returns a list of users","operationId":"listUsers","tags":["Users"],"parameters":[{"name":"search","in":"query","description":"Fuzzy search term for user display name or email.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"Number of results per page","schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"List of users","content":{"application/json":{"schema":{"type":"object","required":["users","pagination"],"properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserSummary"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/users/{userId}":{"get":{"summary":"Get user details","description":"Returns the details of a specific user by their ID.","operationId":"getUser","tags":["Users"],"parameters":[{"name":"userId","in":"path","required":true,"description":"The unique identifier (UUID) of the user.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"User details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/users/{userId}/roles":{"put":{"summary":"Assign roles to a user","description":"Assigns standard roles to a user by replacing all existing role assignments. Roles are specified by their system-defined names and scopes. The user must be authenticated as a human (not an agent) to use this endpoint.\n","operationId":"assignUserRoles","tags":["Users","Roles"],"parameters":[{"name":"userId","in":"path","required":true,"description":"The unique identifier (UUID) of the user.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleAssignmentRequest"}}}},"responses":{"204":{"description":"Roles assigned successfully"},"400":{"description":"Invalid request (e.g., unknown role name, invalid scope, duplicate roles)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"Forbidden - only human users can assign roles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"404":{"description":"User not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}},"delete":{"summary":"Remove roles from a user","description":"Removes specified roles from a user. Only the roles matching both the role name and scope will be removed. The user must be authenticated as a human (not an agent) to use this endpoint.\n","operationId":"removeUserRoles","tags":["Users","Roles"],"parameters":[{"name":"userId","in":"path","required":true,"description":"The unique identifier (UUID) of the user.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleRemovalRequest"}}}},"responses":{"204":{"description":"Roles removed successfully"},"400":{"description":"Invalid request (e.g., unknown role name, invalid scope)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"Forbidden - only human users can remove roles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"404":{"description":"User not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/groups":{"post":{"summary":"Create a new approver group","description":"Create a new group for organizing approvers","operationId":"createGroup","tags":["Groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupCreate"}}}},"responses":{"201":{"description":"Group created successfully","headers":{"Location":{"description":"URL of the created group","schema":{"type":"string","format":"uri"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}},"get":{"summary":"List groups","description":"Returns a list of groups","operationId":"listGroups","tags":["Groups"],"parameters":[{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"Number of results per page","schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"List of groups","content":{"application/json":{"schema":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/Group"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["groups","pagination"]}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/groups/{groupIdentifier}":{"get":{"summary":"Get group details","description":"Returns the details of a specific group","operationId":"getGroup","tags":["Groups"],"parameters":[{"name":"groupIdentifier","in":"path","required":true,"description":"The unique identifier of the group or the name of the group","schema":{"type":"string"}}],"responses":{"200":{"description":"Group details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/groups/{groupId}/entities":{"get":{"summary":"List entities in a group","description":"Returns a list of all entities (users, systems, etc.) that belong to a specific group, including their roles.","operationId":"listGroupEntities","tags":["Groups","Users"],"parameters":[{"name":"groupId","in":"path","required":true,"description":"The unique identifier (UUID) of the group.","schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"Number of results per page","schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"List of entities in the group","content":{"application/json":{"schema":{"type":"object","required":["entities","pagination"],"properties":{"entities":{"type":"array","items":{"$ref":"#/components/schemas/GroupMembership"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"summary":"Add group entities","description":"Add entities (like users) within a specific group.","operationId":"addGroupEntities","tags":["Groups","Users"],"parameters":[{"name":"groupId","in":"path","required":true,"description":"The unique identifier (UUID) of the group.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddGroupEntitiesRequest"}}}},"responses":{"200":{"description":"Entities managed successfully. Returns updated group details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"409":{"description":"Conflict detected (e.g., adding an existing member).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}},"delete":{"summary":"Remove group entities","description":"Remove entities (like users) from a specific group.","operationId":"removeGroupEntities","tags":["Groups","Users"],"parameters":[{"name":"groupId","in":"path","required":true,"description":"The unique identifier (UUID) of the group.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveGroupEntitiesRequest"}}}},"responses":{"200":{"description":"Entities removed successfully. Returns updated group details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"409":{"description":"Conflict detected (e.g. removing a non-member).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/spaces":{"post":{"summary":"Create a new space","description":"Creates a new organizational space","operationId":"createSpace","tags":["Spaces"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceCreate"}}}},"responses":{"201":{"description":"Space created successfully","headers":{"Location":{"description":"URL of the created space","schema":{"type":"string","format":"uri"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"409":{"description":"Space with this name already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}},"get":{"summary":"List spaces","description":"Returns a list of spaces","operationId":"listSpaces","tags":["Spaces"],"parameters":[{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"Number of results per page","schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"List of spaces","content":{"application/json":{"schema":{"type":"object","required":["data","pagination"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Space"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/spaces/{spaceId}":{"get":{"summary":"Get space details","description":"Returns the details of a specific space","operationId":"getSpace","tags":["Spaces"],"parameters":[{"name":"spaceId","in":"path","required":true,"description":"The unique identifier of the space","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Space details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Space"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"delete":{"summary":"Delete a space","description":"Deletes a space","operationId":"deleteSpace","tags":["Spaces"],"parameters":[{"name":"spaceId","in":"path","required":true,"description":"The unique identifier of the space","schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Space deleted successfully"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Cannot delete space with active resources","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/organization/{organization-name}/admins":{"post":{"summary":"Add organization administrator","description":"Adds a new organization administrator by email to the specified organization","operationId":"addOrganizationAdminToOrg","tags":["Organization Admins"],"parameters":[{"name":"organization-name","in":"path","required":true,"description":"The name or identifier of the organization","schema":{"type":"string","example":"my-org"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationAdminCreate"}}}},"responses":{"201":{"description":"Organization admin added successfully","headers":{"Location":{"description":"URL of the created organization admin","schema":{"type":"string","format":"uri"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Organization not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"409":{"description":"Admin with this email already exists in this organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}},"get":{"summary":"List organization administrators","description":"Returns a list of administrators for the specified organization","operationId":"listOrganizationAdminsForOrg","tags":["Organization Admins"],"parameters":[{"name":"organization-name","in":"path","required":true,"description":"The name or identifier of the organization","schema":{"type":"string","example":"my-org"}},{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"Number of results per page","schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"List of organization admins for the specified organization","content":{"application/json":{"schema":{"type":"object","required":["data","pagination"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationAdmin"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Organization not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}},"delete":{"summary":"Remove organization administrator","description":"Removes an organization administrator from the specified organization","operationId":"removeOrganizationAdminFromOrg","tags":["Organization Admins"],"parameters":[{"name":"organization-name","in":"path","required":true,"description":"The name or identifier of the organization","schema":{"type":"string","example":"my-org"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationAdminRemove"}}}},"responses":{"204":{"description":"Organization admin removed successfully"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/workflow-templates":{"post":{"summary":"Create a new workflow template","description":"Creates a new workflow template with approval rules, actions, and default expiry settings","operationId":"createWorkflowTemplate","tags":["Workflow Templates"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplateCreate"}}}},"responses":{"201":{"description":"Workflow template created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplate"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}},"get":{"summary":"List workflow templates","description":"Returns a list of workflow templates with optional filtering","operationId":"listWorkflowTemplates","tags":["Workflow Templates"],"parameters":[{"name":"params","in":"query","style":"form","explode":true,"schema":{"$ref":"#/components/schemas/ListWorkflowTemplatesParams"}}],"responses":{"200":{"description":"List of workflow templates","content":{"application/json":{"schema":{"type":"object","required":["data","pagination"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowTemplateSummary"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/workflow-templates/{templateIdentifier}":{"get":{"summary":"Get workflow template details","description":"Returns the details of a specific workflow template.","operationId":"getWorkflowTemplate","tags":["Workflow Templates"],"parameters":[{"name":"templateIdentifier","in":"path","required":true,"description":"The unique identifier of the workflow template (UUID)","schema":{"type":"string"}}],"responses":{"200":{"description":"Workflow template details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplate"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"summary":"Update a workflow template","description":"Updates an existing workflow template by creating a new version and optionally canceling active workflows","operationId":"updateWorkflowTemplate","tags":["Workflow Templates"],"parameters":[{"name":"templateIdentifier","in":"path","required":true,"description":"The name of the workflow template to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplateUpdate"}}}},"responses":{"200":{"description":"Workflow template updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplate"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/workflow-templates/{templateName}/deprecate":{"post":{"summary":"Deprecate a workflow template","description":"Marks a workflow template as deprecated with optional workflow cancellation","operationId":"deprecateWorkflowTemplate","tags":["Workflow Templates"],"parameters":[{"name":"templateName","in":"path","required":true,"description":"The name of the workflow template to deprecate","schema":{"type":"string"}}],"requestBody":{"description":"Options for deprecating a workflow template.","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplateDeprecate"}}}},"responses":{"200":{"description":"Workflow template deprecated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplate"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}},"components":{"schemas":{"AgentChallengeRequest":{"type":"object","required":["agentName"],"properties":{"agentName":{"type":"string","description":"Name of the agent requesting authentication","example":"ci-deployment-agent"}}},"AgentChallengeResponse":{"type":"object","required":["challenge"],"properties":{"challenge":{"type":"string","description":"Base64 encoded encrypted challenge that must be signed by the agent.\n\n**Decrypted Format (JSON object):**\n```json\n{\n \"audience\": \"agent-name\",\n \"expires_at\": \"2025-04-15T12:15:00Z\",\n \"issuer\": \"Approvio\",\n \"nonce\": \"random-string-challenge\"\n}\n```\n","example":"eyJhdWRpZW5jZSI6ImNpLWRlcGxveW1lbnQtYWdlbnQiLCJleHBpcmVzX2F0IjoiMjAyNS0wNC0xNVQxMjoxNTowMFoiLCJpc3N1ZXIiOiJBcHByb3ZpbyIsIm5vbmNlIjoiYWJjZGVmZ2hpams5ODc2NTQzMjEifQ=="}}},"AgentRegistrationRequest":{"type":"object","required":["agentName"],"properties":{"agentName":{"type":"string","description":"Unique name for the agent (must be unique across the system)","example":"ci-deployment-agent","minLength":1,"maxLength":1024}}},"AgentRegistrationResponse":{"type":"object","required":["agentId","agentName","publicKey","privateKey","createdAt"],"properties":{"agentId":{"type":"string","format":"uuid","description":"Unique identifier for the registered agent","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},"agentName":{"type":"string","description":"Name of the registered agent","example":"ci-deployment-agent"},"publicKey":{"type":"string","description":"RSA public key in base64 encoded PEM format for the agent","example":"LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUEuLi4KLS0tLS1FTkQgUFVCTElDIEtFWS0tLS0t"},"privateKey":{"type":"string","description":"RSA private key in base64 encoded PEM format for the agent (store securely!)","example":"LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1JSUVWd0lCQURBTkJna3Foa2lHOXcwQkFRRUZBQVNDQktnZ2dnU2tBZ0VBQW9JQkFRQy4uLgotLS0tLUVORCBQUklWQVRFIEtFWS0tLS0t"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the agent was registered","readOnly":true,"example":"2025-04-15T12:05:00Z"}}},"AgentGet200Response":{"type":"object","required":["id","agentName","publicKey","createdAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the agent","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},"agentName":{"type":"string","description":"Name of the agent","example":"ci-deployment-agent"},"publicKey":{"type":"string","description":"RSA public key in base64 encoded PEM format for the agent","example":"LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUEuLi4KLS0tLS1FTkQgUFVCTElDIEtFWS0tLS0t"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the agent was registered","example":"2025-04-15T12:05:00Z"}}},"AgentTokenRequest":{"type":"object","required":["grantType","clientAssertionType","clientAssertion"],"properties":{"grantType":{"type":"string","description":"OAuth 2.0 grant type for JWT Bearer profile","enum":["urn:ietf:params:oauth:grant-type:jwt-bearer"],"example":"urn:ietf:params:oauth:grant-type:jwt-bearer"},"clientAssertionType":{"type":"string","description":"OAuth 2.0 client assertion type for JWT Bearer profile","enum":["urn:ietf:params:oauth:client-assertion-type:jwt-bearer"],"example":"urn:ietf:params:oauth:client-assertion-type:jwt-bearer"},"clientAssertion":{"type":"string","description":"JWT assertion signed with the agent's private key using RS256 algorithm.\n\n**JWT Header:**\n```json\n{\n \"alg\": \"RS256\",\n \"typ\": \"JWT\"\n}\n```\n\n**JWT Payload:**\n```json\n{\n \"iss\": \"agent-name\",\n \"sub\": \"agent-name\", \n \"aud\": \"authorization-server-identifier\",\n \"exp\": 1640995200,\n \"jti\": \"nonce-from-challenge\",\n \"iat\": 1640991600\n}\n```\n\n**Requirements:**\n- Must be signed with agent's private key using RS256\n- JWT ID (jti) must match nonce from server's challenge\n- Issuer (iss) and subject (sub) must be the agent name\n- Audience (aud) must be the authorization server identifier\n- Agent identity is extracted from the issuer claim\n","example":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJjaS1kZXBsb3ltZW50LWFnZW50Iiwic3ViIjoiY2ktZGVwbG95bWVudC1hZ2VudCIsImF1ZCI6IkFwcHJvdmlvIiwiZXhwIjoxNjQwOTk1MjAwLCJqdGkiOiJhYmNkZWZnaGlqazk4NzY1NDMyMSIsImlhdCI6MTY0MDk5MTYwMH0.signature"}}},"AgentTokenResponse":{"type":"object","required":["accessToken","refreshToken"],"properties":{"accessToken":{"type":"string","description":"JWT token for the authenticated agent","example":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjaS1kZXBsb3ltZW50LWFnZW50IiwiZW50aXR5VHlwZSI6ImFnZW50IiwiaWF0IjoxNjc4OTAxMjAwLCJleHAiOjE2Nzg5ODc2MDB9.signature"},"refreshToken":{"type":"string","description":"Refresh token used to obtain a new access token","example":"sd8Axmi9Xkalsmcd..."}}},"RoleTemplate":{"type":"object","required":["name","permissions","scope"],"properties":{"name":{"type":"string","description":"Unique identifier for the role template","example":"GroupReadOnly"},"permissions":{"type":"array","items":{"type":"string"},"description":"List of permissions granted by this role","example":["read"]},"scope":{"type":"string","x-extensible-enum":["org","space","group","workflow_template"],"description":"The scope type this role applies to","example":"group"}}},"RoleScope":{"description":"Defines the scope where a role applies. Can be organization-wide, space-specific, group-specific, or workflow template-specific.\n","oneOf":[{"$ref":"#/components/schemas/OrgScope"},{"$ref":"#/components/schemas/SpaceScope"},{"$ref":"#/components/schemas/GroupScope"},{"$ref":"#/components/schemas/WorkflowTemplateScope"}],"discriminator":{"propertyName":"type","mapping":{"org":"#/components/schemas/OrgScope","space":"#/components/schemas/SpaceScope","group":"#/components/schemas/GroupScope","workflow_template":"#/components/schemas/WorkflowTemplateScope"}}},"OrgScope":{"type":"object","description":"Organization-wide scope - applies to entire organization","required":["type"],"properties":{"type":{"type":"string","enum":["org"],"description":"Scope type (org)"}}},"SpaceScope":{"type":"object","description":"Space-specific scope - applies to a specific space","required":["type","spaceId"],"properties":{"type":{"type":"string","enum":["space"],"description":"Scope type (space)"},"spaceId":{"type":"string","format":"uuid","description":"The unique identifier of the space","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"}}},"GroupScope":{"type":"object","description":"Group-specific scope - applies to a specific group","required":["type","groupId"],"properties":{"type":{"type":"string","enum":["group"],"description":"Scope type (group)"},"groupId":{"type":"string","format":"uuid","description":"The unique identifier of the group","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"}}},"WorkflowTemplateScope":{"type":"object","description":"Workflow template-specific scope - applies to a specific workflow template","required":["type","workflowTemplateId"],"properties":{"type":{"type":"string","enum":["workflow_template"],"description":"Scope type (workflow_template)"},"workflowTemplateId":{"type":"string","format":"uuid","description":"The unique identifier of the workflow template","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"}}},"RoleOperationItem":{"type":"object","description":"A role operation item that references a system-defined role by name and provides the scope where it should apply (for assignment or removal).\n","required":["roleName","scope"],"properties":{"roleName":{"type":"string","description":"Name of the system-defined role template (e.g., \"GroupReadOnly\", \"SpaceManager\"). Must match a role available from the /roles endpoint.\n","example":"GroupReadOnly"},"scope":{"$ref":"#/components/schemas/RoleScope"}}},"RoleOperationRequest":{"type":"object","description":"Request to assign or remove roles from a user or agent","required":["roles"],"properties":{"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleOperationItem"},"description":"Array of role assignments specifying role names and their scopes","example":[{"roleName":"GroupReadOnly","scope":{"type":"group","groupId":"a1b2c3d4-e5f6-7890-1234-567890abcdef"}}]}}},"RoleAssignmentRequest":{"type":"object","description":"Request to assign or remove roles from a user or agent","required":["roles"],"properties":{"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleOperationItem"},"description":"Array of role assignments specifying role names and their scopes","example":[{"roleName":"GroupReadOnly","scope":{"type":"group","groupId":"a1b2c3d4-e5f6-7890-1234-567890abcdef"}}]}}},"RoleRemovalRequest":{"type":"object","description":"Request to assign or remove roles from a user or agent","required":["roles"],"properties":{"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleOperationItem"},"description":"Array of role assignments specifying role names and their scopes","example":[{"roleName":"GroupReadOnly","scope":{"type":"group","groupId":"a1b2c3d4-e5f6-7890-1234-567890abcdef"}}]}}},"OidcCallbackRequest":{"type":"object","required":["code","state"],"properties":{"code":{"type":"string","description":"Authorization code received from OIDC provider"},"state":{"type":"string","description":"State parameter used for CSRF protection"}}},"TokenRequest":{"type":"object","required":["code","state"],"properties":{"code":{"type":"string","description":"Authorization code received from OIDC provider","example":"auth_code_123"},"state":{"type":"string","description":"State parameter used for CSRF protection","example":"state_123"}}},"RefreshTokenRequest":{"type":"object","required":["refreshToken"],"properties":{"refreshToken":{"type":"string","description":"Refresh token used to obtain a new access token","example":"sd8Axmi9Xkalsmcd..."}}},"TokenResponse":{"type":"object","required":["accessToken","refreshToken"],"properties":{"accessToken":{"type":"string","description":"JWT token containing user information and roles","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."},"refreshToken":{"type":"string","description":"Refresh token used to obtain a new access token","example":"sd8Axmi9Xkalsmcd..."}}},"PrivilegedTokenResponse":{"type":"object","required":["accessToken"],"properties":{"accessToken":{"type":"string","description":"JWT token containing user information and roles","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}},"SuccessfulAuthResponse":{"type":"object","required":["message","code","state","b64encoded"],"properties":{"message":{"type":"string","description":"Authentication status message","example":"Authentication successful. Use the code and state to generate a JWT token."},"code":{"type":"string","description":"Authorization code received from OIDC provider","example":"auth_code_123"},"state":{"type":"string","description":"State parameter used for CSRF protection","example":"state_123"},"b64encoded":{"type":"string","description":"Base64-encoded combination of code and state (format - code:state). Alternative to providing code and state separately.","example":"YXV0aF9jb2RlXzEyMzpzdGF0ZV8xMjM="}}},"FailedAuthResponse":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Authentication status message","example":"Authentication failed."}}},"SpaceCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the space (max 255 characters)","example":"Engineering Team"},"description":{"type":"string","description":"Description of the space (max 2048 characters)","example":"Space for engineering team collaboration"}}},"Space":{"type":"object","required":["id","name","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the space","readOnly":true,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},"name":{"type":"string","description":"Name of the space (max 255 characters)","example":"Engineering Team"},"description":{"type":"string","description":"Description of the space (max 2048 characters)","example":"Space for engineering team collaboration"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the space was created","readOnly":true,"example":"2025-04-15T12:05:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the space was last updated","readOnly":true,"example":"2025-04-15T12:05:00Z"}}},"OrganizationAdminCreate":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","description":"Email address of the organization administrator","example":"admin@example.com"}}},"OrganizationAdmin":{"type":"object","required":["userId","email","createdAt"],"properties":{"userId":{"type":"string","format":"uuid","description":"Unique identifier of the user who is an organization admin","readOnly":true,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},"email":{"type":"string","format":"email","description":"Email address of the organization administrator","example":"admin@example.com"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the admin was created","readOnly":true,"example":"2025-04-15T12:05:00Z"}}},"OrganizationAdminRemove":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","format":"uuid","description":"The unique identifier of the user to remove from organization admins","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"}}},"UserSummary":{"type":"object","required":["id","displayName","email"],"properties":{"id":{"type":"string","format":"uuid","description":"Internal unique identifier for the user.","readOnly":true,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},"displayName":{"type":"string","description":"User's display name.","example":"Alex Chen"},"email":{"type":"string","format":"email","description":"User's email address.","example":"alex.chen@example.com"}}},"UserCreate":{"type":"object","required":["displayName","email","orgRole"],"properties":{"displayName":{"type":"string","description":"User's display name.","example":"Alex Chen"},"email":{"type":"string","format":"email","description":"User's email address (must be unique).","example":"alex.chen@example.com"},"orgRole":{"type":"string","x-extensible-enum":["admin","member"],"description":"Role assigned to the user within the organization.","example":"member"}}},"User":{"type":"object","required":["id","displayName","email","orgRole","createdAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Internal unique identifier for the user.","readOnly":true,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},"displayName":{"type":"string","description":"User's display name.","example":"Alex Chen"},"email":{"type":"string","format":"email","description":"User's email address.","example":"alex.chen@example.com"},"orgRole":{"type":"string","x-extensible-enum":["admin","member"],"description":"Role assigned to the user within the organization.","example":"member"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the user was created.","readOnly":true,"example":"2025-04-15T12:05:00Z"}}},"EntityReference":{"type":"object","required":["entityType","entityId"],"properties":{"entityType":{"type":"string","x-extensible-enum":["human","agent"],"description":"The type of the entity being referenced.","example":"human"},"entityId":{"type":"string","format":"uuid","description":"The unique identifier (UUID) of the entity.","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"}}},"EntityMembershipAdd":{"type":"object","required":["entity"],"properties":{"entity":{"$ref":"#/components/schemas/EntityReference"}}},"EntityMembershipRemove":{"type":"object","required":["entity"],"properties":{"entity":{"$ref":"#/components/schemas/EntityReference"}}},"AddGroupEntitiesRequest":{"type":"object","description":"Defines operations to add entities within a group","required":["entities"],"properties":{"entities":{"type":"array","items":{"$ref":"#/components/schemas/EntityMembershipAdd"},"description":"List of entities to add to the group."}}},"RemoveGroupEntitiesRequest":{"type":"object","description":"Defines operations to remove entities within a group","required":["entities"],"properties":{"entities":{"type":"array","items":{"$ref":"#/components/schemas/EntityMembershipRemove"},"description":"List of entities to remove from the group."}}},"GroupMembership":{"type":"object","required":["entity","addedAt"],"properties":{"entity":{"$ref":"#/components/schemas/EntityReference"},"addedAt":{"type":"string","format":"date-time","description":"Timestamp when the entity was added to the group.","readOnly":true,"example":"2025-04-16T10:30:00Z"}}},"WorkflowTemplateSummary":{"type":"object","required":["id","name","version","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Internal unique identifier for the workflow template.","readOnly":true,"example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},"name":{"type":"string","description":"User-friendly name for the workflow template.","example":"New Workflow Template"},"version":{"type":"string","description":"Version of the workflow template.","example":"1"},"description":{"type":"string","description":"Detailed description of the workflow template.","example":"This is a new workflow template"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the workflow template was created.","readOnly":true,"example":"2025-04-15T12:05:00Z"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the workflow template was last updated.","readOnly":true,"example":"2025-04-15T12:05:00Z"}}},"WorkflowCreate":{"type":"object","required":["name","workflowTemplateId"],"properties":{"name":{"type":"string","description":"User-friendly name for the workflow"},"description":{"type":"string","description":"Detailed description of the workflow"},"metadata":{"type":"object","description":"Additional custom metadata for the workflow"},"workflowTemplateId":{"type":"string","format":"uuid","description":"The unique identifier of the workflow template to use as parent"}}},"Workflow":{"type":"object","required":["id","name","status","workflowTemplateId","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","description":"Unique identifier for the workflow"},"name":{"type":"string","description":"User-friendly name for the workflow"},"description":{"type":"string","description":"Detailed description of the workflow"},"status":{"type":"string","x-extensible-enum":["APPROVED","REJECTED","CANCELED","EVALUATION_IN_PROGRESS","EXPIRED"],"description":"Current status of the workflow"},"workflowTemplateId":{"type":"string","format":"uuid","description":"The unique identifier of the workflow template used as parent"},"metadata":{"type":"object","description":"Additional custom metadata for the workflow"},"ref":{"type":"object","description":"Referenced objects (optional, controlled by include query parameters)","properties":{"workflowTemplate":{"$ref":"#/components/schemas/WorkflowTemplate"}}},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"expiresAt":{"type":"string","format":"date-time","description":"Expiry timestamp","readOnly":true,"example":"2025-04-15T12:05:00Z"}}},"ApprovalRule":{"description":"Configuration of approval rules. Can be a boolean operator (AND/OR) combining nested rules, or a specific requirement (minimum count from a group).\n","oneOf":[{"$ref":"#/components/schemas/AndRule"},{"$ref":"#/components/schemas/OrRule"},{"$ref":"#/components/schemas/GroupRequirementRule"}],"discriminator":{"propertyName":"type","mapping":{"AND":"#/components/schemas/AndRule","OR":"#/components/schemas/OrRule","GROUP_REQUIREMENT":"#/components/schemas/GroupRequirementRule"}}},"AndRule":{"type":"object","description":"An AND rule requiring all nested rules to be satisfied.","required":["type","rules"],"properties":{"type":{"type":"string","enum":["AND"],"description":"Rule type (AND)"},"rules":{"type":"array","description":"List of rules that must all be satisfied. Cannot be empty.","minItems":1,"items":{"$ref":"#/components/schemas/ApprovalRule"}}}},"OrRule":{"type":"object","description":"An OR rule requiring at least one of the nested rules to be satisfied.","required":["type","rules"],"properties":{"type":{"type":"string","enum":["OR"],"description":"Rule type (OR)"},"rules":{"type":"array","description":"List of rules where at least one must be satisfied. Cannot be empty.","minItems":1,"items":{"$ref":"#/components/schemas/ApprovalRule"}}}},"GroupRequirementRule":{"type":"object","description":"Requires a minimum number of approvals from a specific group.","required":["type","groupId","minCount"],"properties":{"type":{"type":"string","enum":["GROUP_REQUIREMENT"],"description":"Rule type (GROUP_REQUIREMENT)"},"groupId":{"type":"string","description":"ID of the approver group."},"minCount":{"type":"integer","description":"Minimum number of approvals required from the group. Must be at least 1.","minimum":1},"requireHighPrivilege":{"type":"boolean","description":"Indicates whether a high-privilege token is required for votes fulfilling this rule."}}},"GroupCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the group"},"description":{"type":"string","description":"Description of the group"}}},"Group":{"type":"object","required":["id","name","entitiesCount","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the group"},"name":{"type":"string","description":"Name of the group"},"description":{"type":"string","description":"Description of the group"},"entitiesCount":{"type":"integer","description":"Number of entities in the group"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"}}},"Pagination":{"type":"object","required":["total","page","limit"],"properties":{"total":{"type":"integer","description":"Total number of items"},"page":{"type":"integer","description":"Current page number"},"limit":{"type":"integer","description":"Items per page"}}},"APIError":{"type":"object","properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}}}},"WorkflowInclude":{"type":"string","x-extensible-enum":["workflow-template"],"description":"Related objects to include in the workflow response"},"ListWorkflowsParams":{"type":"object","properties":{"page":{"type":"integer","default":1,"description":"Page number for pagination"},"limit":{"type":"integer","default":20,"description":"Number of results per page"},"include":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowInclude"},"description":"Comma-separated list of related objects to include in the response"},"include-only-non-terminal-state":{"type":"boolean","default":false,"description":"When set to true, only workflows that are not in terminal state will be returned."},"workflowTemplateIdentifier":{"type":"string","description":"Optional workflow template identifier (UUID or name) to filter workflows."}}},"ListWorkflowTemplatesParams":{"type":"object","properties":{"page":{"type":"integer","default":1,"description":"Page number for pagination"},"limit":{"type":"integer","default":20,"description":"Number of results per page"},"spaceIdentifier":{"type":"string","description":"Optional space identifier (UUID or name) to filter workflow templates."}}},"GetWorkflowParams":{"type":"object","properties":{"include":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowInclude"},"description":"Comma-separated list of related objects to include in the response"}}},"WorkflowVoteRequest":{"type":"object","title":"WorkflowVoteRequest","required":["voteType"],"properties":{"reason":{"type":"string","description":"Optional reason for the vote. Can be used for approval comments or reject reasons.","example":"Missing critical information or LGTM!"},"voteType":{"oneOf":[{"$ref":"#/components/schemas/VoteApprove"},{"$ref":"#/components/schemas/VoteVeto"},{"$ref":"#/components/schemas/VoteWithdraw"}],"discriminator":{"propertyName":"type","mapping":{"APPROVE":"#/components/schemas/VoteApprove","VETO":"#/components/schemas/VoteVeto","WITHDRAW":"#/components/schemas/VoteWithdraw"}}}}},"CanVoteResponse":{"type":"object","title":"CanVoteResponse","required":["canVote","voteStatus"],"properties":{"canVote":{"type":"boolean","description":"True if the authenticated entity can currently vote on the workflow, false otherwise."},"voteStatus":{"type":"string","x-extensible-enum":["ALREADY_VOTED","VOTE_PENDING"],"description":"Indicates the voting status for the user on this workflow.\n","example":"VOTE_PENDING"},"cantVoteReason":{"type":"string","description":"Reason why the entity cannot vote on the workflow. The value is only set if 'canVote' is false.","x-extensible-enum":["WORKFLOW_EXPIRED","WORKFLOW_APPROVED","WORKFLOW_CANCELED","NOT_ELIGIBLE_TO_VOTE"]},"requireHighPrivilege":{"type":"boolean","description":"Indicates whether a high-privilege token is required to cast a vote for the entity."}}},"VoteApprove":{"type":"object","required":["type","votedForGroups"],"properties":{"type":{"type":"string","enum":["APPROVE"],"description":"Vote type (APPROVE)"},"votedForGroups":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of group IDs the vote is cast for. The voter must be a member of these groups with appropriate role (approver, admin, or owner) to cast votes for them.\n","example":["a1b2c3d4-e5f6-7890-1234-567890abcdef"]}}},"VoteVeto":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["VETO"],"description":"Vote type (VETO)"}}},"VoteWithdraw":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["WITHDRAW"],"description":"Vote type (WITHDRAW)"}}},"WorkflowTemplateCreate":{"type":"object","required":["name","approvalRule","spaceId"],"properties":{"name":{"type":"string","description":"User-friendly name for the workflow template"},"description":{"type":"string","description":"Detailed description of the workflow template"},"metadata":{"type":"object","description":"Additional custom metadata for the workflow template"},"approvalRule":{"$ref":"#/components/schemas/ApprovalRule"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowAction"},"description":"Actions to be executed when workflow is approved"},"defaultExpiresInHours":{"type":"integer","minimum":1,"maximum":8760,"description":"Default expiry time for workflows created from this template (in hours, max 1 year)"},"spaceId":{"type":"string","format":"uuid","description":"ID of the space to which this workflow template belongs"}}},"WorkflowTemplate":{"type":"object","required":["id","name","version","status","allowVotingOnDeprecatedTemplate","approvalRule","spaceId","createdAt","updatedAt"],"properties":{"id":{"type":"string","description":"Unique identifier for the workflow template"},"name":{"type":"string","description":"User-friendly name for the workflow template"},"version":{"type":"string","description":"Version of the workflow template. \"latest\" for active templates, numeric for versioned templates"},"description":{"type":"string","description":"Detailed description of the workflow template"},"status":{"type":"string","enum":["ACTIVE","PENDING_DEPRECATION","DEPRECATED"],"description":"Lifecycle status of the template: * ACTIVE - Template can be referenced to create new workflows * PENDING_DEPRECATION - Template has been deprecated but there are still active workflows (intermediate status for async deprecation) * DEPRECATED - Template cannot be referenced for new workflows, voting may still be allowed based on settings\n"},"allowVotingOnDeprecatedTemplate":{"type":"boolean","description":"Whether voting is allowed on workflows using this template when it's deprecated"},"approvalRule":{"$ref":"#/components/schemas/ApprovalRule"},"metadata":{"type":"object","description":"Additional custom metadata for the workflow template"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowAction"},"description":"Actions to be executed when workflow is approved"},"defaultExpiresInHours":{"type":"integer","minimum":1,"maximum":8760,"description":"Default expiry time for workflows created from this template (in hours, max 1 year)"},"spaceId":{"type":"string","format":"uuid","description":"ID of the space to which this workflow template belongs"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"}}},"WorkflowTemplateUpdate":{"type":"object","properties":{"description":{"type":"string","description":"Detailed description of the workflow template"},"metadata":{"type":"object","description":"Additional custom metadata for the workflow template"},"approvalRule":{"$ref":"#/components/schemas/ApprovalRule"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowAction"},"description":"Actions to be executed when workflow is approved"},"defaultExpiresInHours":{"type":"integer","minimum":1,"maximum":8760,"description":"Default expiry time for workflows created from this template (in hours, max 1 year)"},"cancelWorkflows":{"type":"boolean","description":"If true, all in-progress workflows associated with this template will be canceled when creating a new version. This affects the allowVotingOnDeprecatedTemplate setting: when true, voting is disabled on the deprecated template.\n","default":false}}},"WorkflowAction":{"description":"Configuration for actions to be executed when workflow is approved. Currently supports email actions.\n","oneOf":[{"$ref":"#/components/schemas/EmailAction"},{"$ref":"#/components/schemas/WebhookAction"}],"discriminator":{"propertyName":"type","mapping":{"EMAIL":"#/components/schemas/EmailAction","WEBHOOK":"#/components/schemas/WebhookAction"}}},"WebhookAction":{"type":"object","description":"Calls a webhook when workflow is approved","required":["type","url"],"properties":{"type":{"type":"string","enum":["WEBHOOK"],"description":"Action type (WEBHOOK)"},"url":{"type":"string","format":"uri","description":"The URL to call"},"method":{"type":"string","enum":["POST","PUT","GET"],"default":"POST","description":"HTTP method to use"},"headers":{"type":"object","additionalProperties":{"type":"string"},"description":"Optional headers to send with the request"}}},"EmailAction":{"type":"object","description":"Sends an email when workflow is approved","required":["type","recipients"],"properties":{"type":{"type":"string","enum":["EMAIL"],"description":"Action type (EMAIL)"},"recipients":{"type":"array","items":{"type":"string","format":"email"},"description":"List of email addresses to send the notification to","minItems":1,"maxItems":5}}},"WorkflowTemplateDeprecate":{"type":"object","properties":{"cancelWorkflows":{"type":"boolean","description":"If true, all in-progress workflows associated with this template will be canceled. This affects the allowVotingOnDeprecatedTemplate setting: when true, voting is disabled on the deprecated template.\n","default":false}}},"GroupInfo":{"type":"object","required":["groupId","groupName"],"properties":{"groupId":{"type":"string","format":"uuid"},"groupName":{"type":"string"}}},"AgentSummary":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the agent"},"name":{"type":"string","description":"Name of the agent"}}},"ListAgentsParams":{"type":"object","properties":{"page":{"type":"integer","default":1,"description":"Page number for pagination"},"limit":{"type":"integer","default":20,"description":"Number of results per page"}}},"WorkflowVote":{"type":"object","required":["voterId","voterType","voteType","timestamp"],"properties":{"voterId":{"type":"string","format":"uuid","description":"Unique identifier of the entity that cast the vote"},"voterType":{"type":"string","x-extensible-enum":["human","agent"],"description":"Type of the entity that cast the vote"},"voteType":{"type":"string","x-extensible-enum":["APPROVE","VETO","WITHDRAW"],"description":"Type of vote cast"},"reason":{"type":"string","description":"Reason for the vote"},"timestamp":{"type":"string","format":"date-time","description":"Timestamp when the vote was cast"},"votedForGroups":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of group IDs the vote was cast on behalf of (only for APPROVE)"}}},"HealthResponse":{"type":"object","required":["status"],"properties":{"status":{"type":"string","x-extensible-enum":["OK","DEPENDENCY_ERROR"],"description":"Current health status of the service"},"message":{"type":"string","description":"Optional message providing more details about the status"}}},"PrivilegedOperation":{"type":"string","x-extensible-enum":["vote"],"description":"The operation requiring high privilege authentication"},"PrivilegedTokenExchangeRequest":{"type":"object","required":["code","state","operation"],"properties":{"code":{"type":"string","description":"The authorization code returned from the IDP"},"state":{"type":"string","description":"The state parameter returned from the IDP"},"resourceId":{"type":"string","description":"The identifier of the resource being accessed"},"operation":{"$ref":"#/components/schemas/PrivilegedOperation"}}}},"responses":{"BadRequest":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"Unauthorized":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token containing authentication information for users or agents.\nThe JWT payload includes: - Core JWT claims: iss (issuer), sub (subject ID), aud (audience), exp/iat/nbf (time claims), jti (token ID) - Standard claims: email (for users), name (display name) - Custom claims: entityType (\"user\" or \"agent\")\nUsers must have a valid email, while agents do not require an email field. Permissions and roles are resolved server-side and not included in the token for security.\n"}}},"security":[{"bearerAuth":[]}]}},"searchIndex":{"store":["tag/Authentication","tag/Authentication/operation/initiateLogin","tag/Authentication/operation/handleCallback","tag/Authentication/operation/exchangeToken","tag/Authentication/operation/refreshUserToken","tag/Authentication/operation/authSuccess","tag/Authentication/operation/authError","tag/Authentication/operation/initiateCliLogin","tag/Authentication/operation/webCallback","tag/Authentication/operation/refreshUserTokenWeb","tag/Authentication/operation/initiatePrivilegeTokenWeb","tag/Authentication/operation/exchangePrivilegeTokenWeb","tag/Authentication/operation/initiatePrivilegedTokenExchange","tag/Authentication/operation/exchangePrivilegedToken","tag/Authentication/operation/getEntityInfo","tag/Authentication/operation/generateAgentChallenge","tag/Authentication/operation/exchangeAgentToken","tag/Authentication/operation/refreshAgentToken","tag/Workflows","tag/Workflows/operation/createWorkflow","tag/Workflows/operation/listWorkflows","tag/Workflows/operation/getWorkflow","tag/Workflow-Templates","tag/Workflow-Templates/operation/createWorkflowTemplate","tag/Workflow-Templates/operation/listWorkflowTemplates","tag/Workflow-Templates/operation/getWorkflowTemplate","tag/Workflow-Templates/operation/updateWorkflowTemplate","tag/Workflow-Templates/operation/deprecateWorkflowTemplate","tag/Users","tag/Users/operation/createUser","tag/Users/operation/listUsers","tag/Users/operation/getUser","tag/Users/operation/assignUserRoles","tag/Users/operation/removeUserRoles","tag/Users/operation/listGroupEntities","tag/Users/operation/addGroupEntities","tag/Users/operation/removeGroupEntities","tag/Groups","tag/Groups/operation/createGroup","tag/Groups/operation/listGroups","tag/Groups/operation/getGroup","tag/Groups/operation/listGroupEntities","tag/Groups/operation/addGroupEntities","tag/Groups/operation/removeGroupEntities","tag/Spaces","tag/Spaces/operation/createSpace","tag/Spaces/operation/listSpaces","tag/Spaces/operation/getSpace","tag/Spaces/operation/deleteSpace","tag/Organization-Admins","tag/Organization-Admins/operation/addOrganizationAdminToOrg","tag/Organization-Admins/operation/listOrganizationAdminsForOrg","tag/Organization-Admins/operation/removeOrganizationAdminFromOrg","tag/Workflow-Actions","tag/Workflow-Actions/operation/voteOnWorkflow","tag/Workflow-Actions/operation/getWorkflowVotes","tag/Workflow-Actions/operation/canVoteOnWorkflow","tag/Agents","tag/Agents/operation/listAgents","tag/Agents/operation/registerAgent","tag/Agents/operation/getAgent","tag/Agents/operation/assignAgentRoles","tag/Agents/operation/removeAgentRoles","tag/Roles","tag/Roles/operation/assignAgentRoles","tag/Roles/operation/removeAgentRoles","tag/Roles/operation/listRoleTemplates","tag/Roles/operation/assignUserRoles","tag/Roles/operation/removeUserRoles","tag/Health","tag/Health/operation/healthCheck"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,1.411]],["description/0",[0,1.382,1,2.844,2,1.739,3,2.696]],["title/1",[1,2.086,4,2.086,5,3.28]],["description/1",[0,1.047,1,2.955,4,2.155,6,2.281,7,3.904,8,2.796,9,2.796,10,3.05,11,3.904]],["title/2",[1,2.086,12,2.952,13,2.952]],["description/2",[1,2.155,9,2.796,10,3.05,12,3.05,13,3.05,14,3.05,15,3.05,16,2.281,17,2.796,18,3.904]],["title/3",[2,0.995,16,1.722,17,2.111,19,1.466,20,1.722]],["description/3",[2,1.266,16,2.192,17,2.688,19,1.866,20,2.192,21,3.753,22,2.931,23,0.933,24,2.931,25,1.085,26,3.753]],["title/4",[2,1.275,20,2.208,27,2.511]],["description/4",[2,1.858,19,2.023,27,3.658,28,1.487,29,2.914,30,2.914,31,4.069]],["title/5",[0,1.013,14,2.952,15,2.952]],["description/5",[0,1.249,14,3.638,32,1.347,33,4.042,34,4.657,35,4.657]],["title/6",[0,1.013,15,2.952,36,3.28]],["description/6",[0,1.249,32,1.347,33,4.042,36,4.042,37,4.657,38,4.657]],["title/7",[1,1.828,4,1.828,5,2.875,39,2.875]],["description/7",[0,1.091,1,2.246,4,2.246,9,2.914,39,3.532,40,1.684,41,4.069,42,4.069,43,4.069]],["title/8",[1,1.828,12,2.587,13,2.587,44,2.372]],["description/8",[2,1.317,9,2.796,16,2.281,17,2.796,19,1.942,45,3.05,46,3.05,47,3.05,48,3.904,49,3.904]],["title/9",[2,1.117,20,1.935,27,2.2,44,2.372]],["description/9",[2,1.317,28,1.427,29,2.796,46,3.05,47,4.182,50,3.904,51,3.904,52,3.389,53,3.904]],["title/10",[2,0.896,4,1.465,6,1.551,44,1.902,54,1.902,55,1.649]],["description/10",[0,1.091,4,2.246,16,2.377,32,1.177,55,2.528,56,3.532,57,3.532,58,3.532,59,4.069]],["title/11",[2,1.117,19,1.647,44,2.372,54,2.372]],["description/11",[2,1.807,19,1.942,45,3.05,46,3.05,47,3.05,55,2.425,60,3.05,61,3.389,62,3.904]],["title/12",[2,0.995,4,1.627,6,1.722,54,2.111,55,1.831]],["description/12",[0,1.047,4,2.155,6,2.281,10,3.05,16,2.281,55,2.425,56,3.389,57,3.389,60,3.05,63,3.904]],["title/13",[2,1.275,19,1.879,54,2.706]],["description/13",[2,1.97,19,2.21,55,2.76,60,3.47,61,3.857,64,4.443]],["title/14",[0,1.013,24,2.952,65,1.381]],["description/14",[0,1.249,24,3.638,32,1.347,65,1.702,66,4.657,67,4.657]],["title/15",[0,0.888,6,1.935,8,2.372,68,0.922]],["description/15",[2,0.474,6,0.821,8,2.693,22,1.098,58,1.22,68,0.883,69,0.582,70,2.413,71,1.22,72,1.406,73,2.413,74,2.094,75,3.675,76,1.22,77,1.22,78,1.098,79,1.406,80,1.406,81,1.406,82,1.406,83,1.22,84,3.76,85,1.143,86,1.406,87,1.406,88,1.406,89,1.406,90,1.22,91,1.406,92,1.406,93,1.406,94,1.406,95,1.22,96,1.406,97,1.406,98,1.22,99,1.406,100,1.406]],["title/16",[2,0.995,19,1.466,20,1.722,30,2.111,101,2.558]],["description/16",[0,0.375,2,0.257,8,1.002,16,0.445,20,2.467,22,0.595,30,0.546,32,0.22,52,1.215,68,0.782,69,0.316,71,1.215,74,1.215,75,3.665,76,1.215,77,0.662,78,1.515,83,0.662,85,0.663,90,1.684,95,1.215,98,0.662,101,1.684,102,0.762,103,1.258,104,0.762,105,0.762,106,0.762,107,0.762,108,0.762,109,0.762,110,0.662,111,1.399,112,0.762,113,0.762,114,0.762,115,0.762,116,0.762,117,0.762,118,0.762,119,0.762,120,1.399,121,1.399,122,1.399,123,1.399,124,0.762,125,0.595,126,0.762,127,0.762,128,1.399,129,0.762,130,0.762,131,0.506,132,0.762,133,0.762,134,0.762,135,0.762,136,0.762,137,0.762,138,0.662,139,0.762,140,0.762,141,0.762,142,0.762,143,0.762,144,0.762,145,0.762]],["title/17",[2,1.117,20,1.935,27,2.2,68,0.922]],["description/17",[2,1.712,19,1.797,27,3.37,28,1.32,29,2.587,30,2.587,110,3.136,146,3.612,147,3.612,148,3.612]],["title/18",[149,1.26]],["description/18",[3,2.848,149,1.303,150,3.382]],["title/19",[28,1.381,69,1.564,149,0.905]],["description/19",[28,1.702,69,1.928,149,1.441,150,2.893,151,4.042]],["title/20",[149,1.053,152,1.322]],["description/20",[32,1.347,131,3.094,149,1.441,152,1.399,153,4.042]],["title/21",[149,1.053,154,1.99]],["description/21",[32,1.415,149,1.171,154,2.213,155,2.116,156,4.893]],["title/22",[149,1.053,157,1.745]],["description/22",[3,2.848,149,1.303,157,2.16]],["title/23",[28,1.21,69,1.371,149,0.793,157,1.314]],["description/23",[28,1.371,45,2.931,69,1.553,149,0.898,150,2.331,151,3.257,157,1.489,158,2.931,159,3.753,160,3.753,161,3.257]],["title/24",[149,0.905,152,1.135,157,1.499]],["description/24",[32,1.285,131,2.952,149,1.064,152,1.335,153,3.857,157,1.763,161,3.857]],["title/25",[149,0.905,154,1.709,157,1.499]],["description/25",[32,1.347,149,1.115,154,2.106,155,2.014,157,1.848,162,4.042]],["title/26",[149,0.905,157,1.499,163,3.28]],["description/26",[28,1.32,69,1.495,131,2.4,149,1.214,157,1.433,162,3.136,163,3.136,164,2.4,165,3.612,166,3.136,167,3.612]],["title/27",[149,0.905,157,1.499,168,3.28]],["description/27",[131,2.822,149,1.357,157,1.685,166,3.687,168,3.687,169,4.247,170,4.247]],["title/28",[23,1.309]],["description/28",[3,3.018,23,1.434]],["title/29",[23,0.94,28,1.381,69,1.564]],["description/29",[23,1.545,28,1.788,69,2.025,171,3.504]],["title/30",[23,1.094,152,1.322]],["description/30",[23,1.597,32,1.491,152,1.548]],["title/31",[23,1.094,154,1.99]],["description/31",[23,1.158,32,1.347,125,3.638,154,2.106,155,2.014,172,4.657]],["title/32",[23,0.94,25,1.093,173,2.086]],["description/32",[0,0.746,23,1.042,25,1.46,40,1.151,68,0.774,85,1.318,103,1.455,164,1.847,173,2.314,174,1.992,175,1.992,176,1.992,177,1.535,178,1.535,179,1.455,180,1.992]],["title/33",[23,0.94,25,1.093,181,1.564]],["description/33",[0,0.791,23,1.09,25,1.512,40,1.221,68,0.822,85,1.398,103,1.544,177,1.628,178,1.628,179,1.544,180,2.113,181,1.814,182,2.113,183,2.113]],["title/34",[65,1.381,152,1.135,184,1.226]],["description/34",[23,0.898,25,1.045,32,1.045,65,1.32,152,1.085,155,1.562,171,2.587,184,1.172,185,3.136,186,3.136,187,3.136,188,2.244]],["title/35",[65,1.381,184,1.226,189,2.348]],["description/35",[23,1.105,65,1.623,155,1.921,184,1.442,188,2.76,189,2.76,190,3.857]],["title/36",[65,1.381,181,1.564,184,1.226]],["description/36",[23,1.158,65,1.702,155,2.014,181,1.928,184,1.511,188,2.893]],["title/37",[184,1.708]],["description/37",[3,3.018,184,1.872]],["title/38",[28,1.21,69,1.371,150,2.057,184,1.075]],["description/38",[28,1.702,69,1.928,150,2.893,184,1.954,191,2.436]],["title/39",[152,1.322,184,1.428]],["description/39",[32,1.491,152,1.548,184,2.084]],["title/40",[154,1.99,184,1.428]],["description/40",[32,1.415,154,2.213,155,2.116,184,1.588,192,4.893]],["title/41",[65,1.381,152,1.135,184,1.226]],["description/41",[23,0.898,25,1.045,32,1.045,65,1.32,152,1.085,155,1.562,171,2.587,184,1.172,185,3.136,186,3.136,187,3.136,188,2.244]],["title/42",[65,1.381,184,1.226,189,2.348]],["description/42",[23,1.105,65,1.623,155,1.921,184,1.442,188,2.76,189,2.76,190,3.857]],["title/43",[65,1.381,181,1.564,184,1.226]],["description/43",[23,1.158,65,1.702,155,2.014,181,1.928,184,1.511,188,2.893]],["title/44",[193,2.618]],["description/44",[3,3.018,193,2.869]],["title/45",[28,1.381,69,1.564,193,1.879]],["description/45",[28,1.788,69,2.025,193,3.091,194,4.893]],["title/46",[152,1.322,193,2.188]],["description/46",[32,1.491,152,1.548,193,3.194]],["title/47",[154,1.99,193,2.188]],["description/47",[32,1.415,154,2.213,155,2.116,193,2.433,195,4.247]],["title/48",[193,2.188,196,3.819]],["description/48",[193,2.707,195,4.726,196,4.726]],["title/49",[191,2.302,197,4.399]],["description/49",[3,2.848,191,2.848,198,3.181]],["title/50",[189,2.348,191,1.977,198,2.208]],["description/50",[28,1.552,40,1.758,189,2.639,191,2.966,198,2.482,199,4.247,200,3.318]],["title/51",[152,1.135,191,1.977,198,2.208]],["description/51",[32,1.347,40,1.928,152,1.399,191,2.436,198,2.721,200,3.638]],["title/52",[181,1.564,191,1.977,198,2.208]],["description/52",[40,1.928,181,1.928,191,3.15,198,2.721,200,3.638]],["title/53",[149,1.053,158,3.437]],["description/53",[149,1.303,158,4.252,201,3.181]],["title/54",[149,1.053,201,2.57]],["description/54",[0,1.047,65,1.427,149,0.935,150,2.425,155,1.688,201,2.281,202,3.904,203,3.05,204,3.904,205,3.389]],["title/55",[149,0.905,201,2.208,206,3.779]],["description/55",[32,1.285,40,1.839,149,1.064,152,1.335,201,2.596,203,3.47,205,3.857]],["title/56",[65,1.077,149,0.706,201,1.722,207,2.302,208,2.947]],["description/56",[0,1.091,40,1.684,65,1.487,149,0.974,201,2.377,203,3.178,209,4.069,210,4.069,211,4.069]],["title/57",[68,1.466]],["description/57",[3,2.848,68,1.516,212,4.726]],["title/58",[68,1.225,152,1.322]],["description/58",[32,1.491,68,1.788,152,1.548]],["title/59",[28,1.381,68,1.052,138,3.28]],["description/59",[0,0.969,6,2.111,28,1.32,29,2.587,68,1.006,69,1.495,78,2.822,212,3.136,213,3.612,214,3.612,215,3.612,216,3.612]],["title/60",[68,1.225,154,1.99]],["description/60",[32,1.285,68,1.237,85,2.105,125,3.47,154,2.009,155,1.921,217,4.443]],["title/61",[25,1.093,68,1.052,173,2.086]],["description/61",[0,0.746,23,0.691,25,1.46,40,1.151,68,1.167,85,1.318,103,1.455,164,1.847,173,2.314,174,1.992,175,1.992,176,1.992,177,1.535,178,1.535,179,1.455,218,1.992]],["title/62",[25,1.093,68,1.052,181,1.564]],["description/62",[0,0.791,23,0.734,25,1.512,40,1.221,68,1.22,85,1.398,103,1.544,177,1.628,178,1.628,179,1.544,181,1.814,182,2.113,183,2.113,218,2.113]],["title/63",[25,1.522]],["description/63",[3,2.696,25,1.491,152,1.548,157,2.045]],["title/64",[25,1.093,68,1.052,173,2.086]],["description/64",[0,0.746,23,0.691,25,1.46,40,1.151,68,1.167,85,1.318,103,1.455,164,1.847,173,2.314,174,1.992,175,1.992,176,1.992,177,1.535,178,1.535,179,1.455,218,1.992]],["title/65",[25,1.093,68,1.052,181,1.564]],["description/65",[0,0.791,23,0.734,25,1.512,40,1.221,68,1.22,85,1.398,103,1.544,177,1.628,178,1.628,179,1.544,181,1.814,182,2.113,183,2.113,218,2.113]],["title/66",[25,0.958,152,0.995,157,1.314,219,2.875]],["description/66",[25,1.639,32,1.228,152,1.276,157,1.685,171,3.042,219,3.687,220,4.247]],["title/67",[23,0.94,25,1.093,173,2.086]],["description/67",[0,0.746,23,1.042,25,1.46,40,1.151,68,0.774,85,1.318,103,1.455,164,1.847,173,2.314,174,1.992,175,1.992,176,1.992,177,1.535,178,1.535,179,1.455,180,1.992]],["title/68",[23,0.94,25,1.093,181,1.564]],["description/68",[0,0.791,23,1.09,25,1.512,40,1.221,68,0.822,85,1.398,103,1.544,177,1.628,178,1.628,179,1.544,180,2.113,181,1.814,182,2.113,183,2.113]],["title/69",[221,3.77]],["description/69",[179,2.848,207,4.252,221,3.899]],["title/70",[207,3.437,221,3.151]],["description/70",[32,1.415,221,4.451,222,4.893,223,4.893]]],"invertedIndex":[["",{"_index":75,"title":{},"description":{"15":{},"16":{}}}],["2.0",{"_index":105,"title":{},"description":{"16":{}}}],["7523",{"_index":109,"title":{},"description":{"16":{}}}],["8601",{"_index":88,"title":{},"description":{"15":{}}}],["access",{"_index":30,"title":{"16":{}},"description":{"4":{},"16":{},"17":{}}}],["action",{"_index":158,"title":{"53":{}},"description":{"23":{},"53":{}}}],["activ",{"_index":167,"title":{},"description":{"26":{}}}],["actual",{"_index":99,"title":{},"description":{"15":{}}}],["add",{"_index":189,"title":{"35":{},"42":{},"50":{}},"description":{"35":{},"42":{},"50":{}}}],["admin",{"_index":197,"title":{"49":{}},"description":{}}],["administr",{"_index":198,"title":{"50":{},"51":{},"52":{}},"description":{"49":{},"50":{},"51":{},"52":{}}}],["agent",{"_index":68,"title":{"15":{},"17":{},"57":{},"58":{},"59":{},"60":{},"61":{},"62":{},"64":{},"65":{}},"description":{"15":{},"16":{},"32":{},"33":{},"57":{},"58":{},"59":{},"60":{},"61":{},"62":{},"64":{},"65":{},"67":{},"68":{}}}],["agent'",{"_index":76,"title":{},"description":{"15":{},"16":{}}}],["agents/regist",{"_index":216,"title":{},"description":{"59":{}}}],["agents/{agentidornam",{"_index":217,"title":{},"description":{"60":{}}}],["agents/{agentid}/rol",{"_index":218,"title":{},"description":{"61":{},"62":{},"64":{},"65":{}}}],["algorithm",{"_index":135,"title":{},"description":{"16":{}}}],["allow",{"_index":202,"title":{},"description":{"54":{}}}],["approv",{"_index":150,"title":{"38":{}},"description":{"18":{},"19":{},"23":{},"38":{},"54":{}}}],["approvio",{"_index":94,"title":{},"description":{"15":{}}}],["assert",{"_index":101,"title":{"16":{}},"description":{"16":{}}}],["assign",{"_index":173,"title":{"32":{},"61":{},"64":{},"67":{}},"description":{"32":{},"61":{},"64":{},"67":{}}}],["asymmetr",{"_index":214,"title":{},"description":{"59":{}}}],["attack",{"_index":129,"title":{},"description":{"16":{}}}],["aud",{"_index":117,"title":{},"description":{"16":{}}}],["audienc",{"_index":83,"title":{},"description":{"15":{},"16":{}}}],["auth/agents/challeng",{"_index":100,"title":{},"description":{"15":{}}}],["auth/agents/refresh",{"_index":148,"title":{},"description":{"17":{}}}],["auth/agents/token",{"_index":145,"title":{},"description":{"16":{}}}],["auth/callback",{"_index":18,"title":{},"description":{"2":{}}}],["auth/cli/initi",{"_index":43,"title":{},"description":{"7":{}}}],["auth/error",{"_index":38,"title":{},"description":{"6":{}}}],["auth/exchangeprivilegedtoken",{"_index":64,"title":{},"description":{"13":{}}}],["auth/info",{"_index":67,"title":{},"description":{"14":{}}}],["auth/initiateprivilegedtokenexchang",{"_index":63,"title":{},"description":{"12":{}}}],["auth/login",{"_index":11,"title":{},"description":{"1":{}}}],["auth/refresh",{"_index":31,"title":{},"description":{"4":{}}}],["auth/success",{"_index":35,"title":{},"description":{"5":{}}}],["auth/token",{"_index":26,"title":{},"description":{"3":{}}}],["auth/web/callback",{"_index":49,"title":{},"description":{"8":{}}}],["auth/web/exchangeprivilegedtoken",{"_index":62,"title":{},"description":{"11":{}}}],["auth/web/initiateprivilegedtokenexchang",{"_index":59,"title":{},"description":{"10":{}}}],["auth/web/refresh",{"_index":53,"title":{},"description":{"9":{}}}],["authent",{"_index":0,"title":{"0":{},"5":{},"6":{},"14":{},"15":{}},"description":{"0":{},"1":{},"5":{},"6":{},"7":{},"10":{},"12":{},"14":{},"16":{},"32":{},"33":{},"54":{},"56":{},"59":{},"61":{},"62":{},"64":{},"65":{},"67":{},"68":{}}}],["author",{"_index":16,"title":{"3":{}},"description":{"2":{},"3":{},"8":{},"10":{},"12":{},"16":{}}}],["avail",{"_index":220,"title":{},"description":{"66":{}}}],["base64",{"_index":80,"title":{},"description":{"15":{}}}],["basic",{"_index":66,"title":{},"description":{"14":{}}}],["bearer",{"_index":106,"title":{},"description":{"16":{}}}],["belong",{"_index":186,"title":{},"description":{"34":{},"41":{}}}],["both",{"_index":183,"title":{},"description":{"33":{},"62":{},"65":{},"68":{}}}],["callback",{"_index":13,"title":{"2":{},"8":{}},"description":{"2":{}}}],["cancel",{"_index":166,"title":{},"description":{"26":{},"27":{}}}],["cast",{"_index":203,"title":{},"description":{"54":{},"55":{},"56":{}}}],["challeng",{"_index":8,"title":{"15":{}},"description":{"1":{},"15":{},"16":{}}}],["check",{"_index":207,"title":{"56":{},"70":{}},"description":{"69":{}}}],["claim",{"_index":144,"title":{},"description":{"16":{}}}],["cli",{"_index":39,"title":{"7":{}},"description":{"7":{}}}],["client",{"_index":116,"title":{},"description":{"16":{}}}],["code",{"_index":17,"title":{"3":{}},"description":{"2":{},"3":{},"8":{}}}],["complet",{"_index":34,"title":{},"description":{"5":{}}}],["contain",{"_index":22,"title":{},"description":{"3":{},"15":{},"16":{}}}],["cooki",{"_index":47,"title":{},"description":{"8":{},"9":{},"11":{}}}],["creat",{"_index":69,"title":{"19":{},"23":{},"29":{},"38":{},"45":{}},"description":{"15":{},"16":{},"19":{},"23":{},"26":{},"29":{},"38":{},"45":{},"59":{}}}],["current",{"_index":208,"title":{"56":{}},"description":{}}],["date-tim",{"_index":89,"title":{},"description":{"15":{}}}],["decod",{"_index":81,"title":{},"description":{"15":{}}}],["decrypt",{"_index":79,"title":{},"description":{"15":{}}}],["default",{"_index":159,"title":{},"description":{"23":{}}}],["delet",{"_index":196,"title":{"48":{}},"description":{"48":{}}}],["deprec",{"_index":168,"title":{"27":{}},"description":{"27":{}}}],["detail",{"_index":154,"title":{"21":{},"25":{},"31":{},"40":{},"47":{},"60":{}},"description":{"21":{},"25":{},"31":{},"40":{},"47":{},"60":{}}}],["determin",{"_index":209,"title":{},"description":{"56":{}}}],["dpop",{"_index":146,"title":{},"description":{"17":{}}}],["e.g",{"_index":93,"title":{},"description":{"15":{}}}],["each",{"_index":139,"title":{},"description":{"16":{}}}],["elig",{"_index":210,"title":{},"description":{"56":{}}}],["email",{"_index":199,"title":{},"description":{"50":{}}}],["encrypt",{"_index":70,"title":{},"description":{"15":{}}}],["endpoint",{"_index":179,"title":{},"description":{"32":{},"33":{},"61":{},"62":{},"64":{},"65":{},"67":{},"68":{},"69":{}}}],["ensur",{"_index":97,"title":{},"description":{"15":{}}}],["entiti",{"_index":65,"title":{"14":{},"34":{},"35":{},"36":{},"41":{},"42":{},"43":{},"56":{}},"description":{"14":{},"34":{},"35":{},"36":{},"41":{},"42":{},"43":{},"54":{},"56":{}}}],["entri",{"_index":213,"title":{},"description":{"59":{}}}],["error",{"_index":36,"title":{"6":{}},"description":{"6":{}}}],["etc",{"_index":185,"title":{},"description":{"34":{},"41":{}}}],["exchang",{"_index":19,"title":{"3":{},"11":{},"13":{},"16":{}},"description":{"3":{},"4":{},"8":{},"11":{},"13":{},"17":{}}}],["exist",{"_index":164,"title":{},"description":{"26":{},"32":{},"61":{},"64":{},"67":{}}}],["exp",{"_index":119,"title":{},"description":{"16":{}}}],["expir",{"_index":120,"title":{},"description":{"16":{}}}],["expires_at",{"_index":86,"title":{},"description":{"15":{}}}],["expiri",{"_index":160,"title":{},"description":{"23":{}}}],["extract",{"_index":143,"title":{},"description":{"16":{}}}],["fail",{"_index":37,"title":{},"description":{"6":{}}}],["filter",{"_index":153,"title":{},"description":{"20":{},"24":{}}}],["flow",{"_index":56,"title":{},"description":{"10":{},"12":{}}}],["format",{"_index":73,"title":{},"description":{"15":{}}}],["frontend",{"_index":48,"title":{},"description":{"8":{}}}],["futur",{"_index":215,"title":{},"description":{"59":{}}}],["gener",{"_index":6,"title":{"10":{},"12":{},"15":{}},"description":{"1":{},"12":{},"15":{},"59":{}}}],["group",{"_index":184,"title":{"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{}},"description":{"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{}}}],["groups/{groupidentifi",{"_index":192,"title":{},"description":{"40":{}}}],["groups/{groupid}/ent",{"_index":188,"title":{},"description":{"34":{},"35":{},"36":{},"41":{},"42":{},"43":{}}}],["handl",{"_index":12,"title":{"2":{},"8":{}},"description":{"2":{}}}],["health",{"_index":221,"title":{"69":{},"70":{}},"description":{"69":{},"70":{}}}],["high-privileg",{"_index":61,"title":{},"description":{"11":{},"13":{}}}],["httponli",{"_index":46,"title":{},"description":{"8":{},"9":{},"11":{}}}],["human",{"_index":178,"title":{},"description":{"32":{},"33":{},"61":{},"62":{},"64":{},"65":{},"67":{},"68":{}}}],["iat",{"_index":130,"title":{},"description":{"16":{}}}],["id",{"_index":125,"title":{},"description":{"16":{},"31":{},"60":{}}}],["ident",{"_index":142,"title":{},"description":{"16":{}}}],["identifi",{"_index":118,"title":{},"description":{"16":{}}}],["idp",{"_index":60,"title":{},"description":{"11":{},"12":{},"13":{}}}],["includ",{"_index":187,"title":{},"description":{"34":{},"41":{}}}],["inform",{"_index":24,"title":{"14":{}},"description":{"3":{},"14":{}}}],["initi",{"_index":4,"title":{"1":{},"7":{},"10":{},"12":{}},"description":{"1":{},"7":{},"10":{},"12":{}}}],["iso",{"_index":87,"title":{},"description":{"15":{}}}],["iss",{"_index":112,"title":{},"description":{"16":{}}}],["issu",{"_index":52,"title":{},"description":{"9":{},"16":{}}}],["issuer",{"_index":90,"title":{},"description":{"15":{},"16":{}}}],["json",{"_index":58,"title":{},"description":{"10":{},"15":{}}}],["jti",{"_index":124,"title":{},"description":{"16":{}}}],["jwt",{"_index":20,"title":{"3":{},"4":{},"9":{},"16":{},"17":{}},"description":{"3":{},"16":{}}}],["key",{"_index":78,"title":{},"description":{"15":{},"16":{},"59":{}}}],["list",{"_index":152,"title":{"20":{},"24":{},"30":{},"34":{},"39":{},"41":{},"46":{},"51":{},"58":{},"66":{}},"description":{"20":{},"24":{},"30":{},"34":{},"39":{},"41":{},"46":{},"51":{},"55":{},"58":{},"63":{},"66":{}}}],["login",{"_index":5,"title":{"1":{},"7":{}},"description":{}}],["loopback",{"_index":41,"title":{},"description":{"7":{}}}],["manag",{"_index":3,"title":{},"description":{"0":{},"18":{},"22":{},"28":{},"37":{},"44":{},"49":{},"57":{},"63":{}}}],["mark",{"_index":169,"title":{},"description":{"27":{}}}],["match",{"_index":182,"title":{},"description":{"33":{},"62":{},"65":{},"68":{}}}],["messag",{"_index":33,"title":{},"description":{"5":{},"6":{}}}],["name",{"_index":85,"title":{},"description":{"15":{},"16":{},"32":{},"33":{},"60":{},"61":{},"62":{},"64":{},"65":{},"67":{},"68":{}}}],["new",{"_index":28,"title":{"19":{},"23":{},"29":{},"38":{},"45":{},"59":{}},"description":{"4":{},"9":{},"17":{},"19":{},"23":{},"26":{},"29":{},"38":{},"45":{},"50":{},"59":{}}}],["nonc",{"_index":95,"title":{},"description":{"15":{},"16":{}}}],["note",{"_index":133,"title":{},"description":{"16":{}}}],["oauth",{"_index":104,"title":{},"description":{"16":{}}}],["object",{"_index":82,"title":{},"description":{"15":{}}}],["obtain",{"_index":72,"title":{},"description":{"15":{}}}],["oidc",{"_index":1,"title":{"1":{},"2":{},"7":{},"8":{}},"description":{"0":{},"1":{},"2":{},"7":{}}}],["onc",{"_index":140,"title":{},"description":{"16":{}}}],["option",{"_index":131,"title":{},"description":{"16":{},"20":{},"24":{},"26":{},"27":{}}}],["organ",{"_index":191,"title":{"49":{},"50":{},"51":{},"52":{}},"description":{"38":{},"49":{},"50":{},"51":{},"52":{}}}],["organiz",{"_index":194,"title":{},"description":{"45":{}}}],["organization/{organization-name}/admin",{"_index":200,"title":{},"description":{"50":{},"51":{},"52":{}}}],["page",{"_index":15,"title":{"5":{},"6":{}},"description":{"2":{}}}],["pair",{"_index":29,"title":{},"description":{"4":{},"9":{},"17":{},"59":{}}}],["pkce",{"_index":7,"title":{},"description":{"1":{}}}],["platform",{"_index":92,"title":{},"description":{"15":{}}}],["predefin",{"_index":219,"title":{"66":{}},"description":{"66":{}}}],["prevent",{"_index":127,"title":{},"description":{"16":{}}}],["privat",{"_index":111,"title":{},"description":{"16":{}}}],["privileg",{"_index":54,"title":{"10":{},"11":{},"12":{},"13":{}},"description":{}}],["profil",{"_index":107,"title":{},"description":{"16":{}}}],["proof",{"_index":147,"title":{},"description":{"17":{}}}],["protect",{"_index":141,"title":{},"description":{"16":{}}}],["provid",{"_index":10,"title":{},"description":{"1":{},"2":{},"12":{}}}],["public",{"_index":77,"title":{},"description":{"15":{},"16":{}}}],["random",{"_index":96,"title":{},"description":{"15":{}}}],["redirect",{"_index":9,"title":{},"description":{"1":{},"2":{},"7":{},"8":{}}}],["refresh",{"_index":27,"title":{"4":{},"9":{},"17":{}},"description":{"4":{},"17":{}}}],["refresh_token",{"_index":51,"title":{},"description":{"9":{}}}],["regist",{"_index":138,"title":{"59":{}},"description":{"16":{}}}],["registr",{"_index":212,"title":{},"description":{"57":{},"59":{}}}],["remov",{"_index":181,"title":{"33":{},"36":{},"43":{},"52":{},"62":{},"65":{},"68":{}},"description":{"33":{},"36":{},"43":{},"52":{},"62":{},"65":{},"68":{}}}],["replac",{"_index":175,"title":{},"description":{"32":{},"61":{},"64":{},"67":{}}}],["replay",{"_index":128,"title":{},"description":{"16":{}}}],["requir",{"_index":110,"title":{},"description":{"16":{},"17":{}}}],["retriev",{"_index":206,"title":{"55":{}},"description":{}}],["return",{"_index":32,"title":{},"description":{"5":{},"6":{},"10":{},"14":{},"16":{},"20":{},"21":{},"24":{},"25":{},"30":{},"31":{},"34":{},"39":{},"40":{},"41":{},"46":{},"47":{},"51":{},"55":{},"58":{},"60":{},"66":{},"70":{}}}],["rfc",{"_index":108,"title":{},"description":{"16":{}}}],["role",{"_index":25,"title":{"32":{},"33":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{}},"description":{"3":{},"32":{},"33":{},"34":{},"41":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{}}}],["rs256",{"_index":134,"title":{},"description":{"16":{}}}],["rule",{"_index":151,"title":{},"description":{"19":{},"23":{}}}],["saa",{"_index":91,"title":{},"description":{"15":{}}}],["same",{"_index":115,"title":{},"description":{"16":{}}}],["scope",{"_index":177,"title":{},"description":{"32":{},"33":{},"61":{},"62":{},"64":{},"65":{},"67":{},"68":{}}}],["secur",{"_index":132,"title":{},"description":{"16":{}}}],["server",{"_index":74,"title":{},"description":{"15":{},"16":{}}}],["server'",{"_index":126,"title":{},"description":{"16":{}}}],["servic",{"_index":223,"title":{},"description":{"70":{}}}],["set",{"_index":45,"title":{},"description":{"8":{},"11":{},"23":{}}}],["sign",{"_index":71,"title":{},"description":{"15":{},"16":{}}}],["signatur",{"_index":137,"title":{},"description":{"16":{}}}],["space",{"_index":193,"title":{"44":{},"45":{},"46":{},"47":{},"48":{}},"description":{"44":{},"45":{},"46":{},"47":{},"48":{}}}],["spaces/{spaceid",{"_index":195,"title":{},"description":{"47":{},"48":{}}}],["specif",{"_index":155,"title":{},"description":{"21":{},"25":{},"31":{},"34":{},"35":{},"36":{},"40":{},"41":{},"42":{},"43":{},"47":{},"54":{},"60":{}}}],["specifi",{"_index":40,"title":{},"description":{"7":{},"32":{},"33":{},"50":{},"51":{},"52":{},"55":{},"56":{},"61":{},"62":{},"64":{},"65":{},"67":{},"68":{}}}],["standard",{"_index":174,"title":{},"description":{"32":{},"61":{},"64":{},"67":{}}}],["state",{"_index":21,"title":{},"description":{"3":{}}}],["statu",{"_index":222,"title":{},"description":{"70":{}}}],["step-up",{"_index":55,"title":{"10":{},"12":{}},"description":{"10":{},"11":{},"12":{},"13":{}}}],["string",{"_index":84,"title":{},"description":{"15":{}}}],["sub",{"_index":113,"title":{},"description":{"16":{}}}],["subject",{"_index":114,"title":{},"description":{"16":{}}}],["success",{"_index":14,"title":{"5":{}},"description":{"2":{},"5":{}}}],["system",{"_index":171,"title":{},"description":{"29":{},"34":{},"41":{},"66":{}}}],["system-defin",{"_index":176,"title":{},"description":{"32":{},"61":{},"64":{},"67":{}}}],["take",{"_index":50,"title":{},"description":{"9":{}}}],["templat",{"_index":157,"title":{"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"66":{}},"description":{"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"63":{},"66":{}}}],["time",{"_index":121,"title":{},"description":{"16":{}}}],["timestamp",{"_index":123,"title":{},"description":{"16":{}}}],["token",{"_index":2,"title":{"3":{},"4":{},"9":{},"10":{},"11":{},"12":{},"13":{},"16":{},"17":{}},"description":{"0":{},"3":{},"4":{},"8":{},"9":{},"11":{},"13":{},"15":{},"16":{},"17":{}}}],["uniqu",{"_index":98,"title":{},"description":{"15":{},"16":{}}}],["unix",{"_index":122,"title":{},"description":{"16":{}}}],["updat",{"_index":163,"title":{"26":{}},"description":{"26":{}}}],["uri",{"_index":42,"title":{},"description":{"7":{}}}],["url",{"_index":57,"title":{},"description":{"10":{},"12":{}}}],["us",{"_index":103,"title":{},"description":{"16":{},"32":{},"33":{},"61":{},"62":{},"64":{},"65":{},"67":{},"68":{}}}],["user",{"_index":23,"title":{"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"67":{},"68":{}},"description":{"3":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"41":{},"42":{},"43":{},"61":{},"62":{},"64":{},"65":{},"67":{},"68":{}}}],["users/{userid",{"_index":172,"title":{},"description":{"31":{}}}],["users/{userid}/rol",{"_index":180,"title":{},"description":{"32":{},"33":{},"67":{},"68":{}}}],["valid",{"_index":102,"title":{},"description":{"16":{}}}],["verifi",{"_index":136,"title":{},"description":{"16":{}}}],["version",{"_index":165,"title":{},"description":{"26":{}}}],["veto",{"_index":204,"title":{},"description":{"54":{}}}],["vote",{"_index":201,"title":{"54":{},"55":{},"56":{}},"description":{"53":{},"54":{},"55":{},"56":{}}}],["web",{"_index":44,"title":{"8":{},"9":{},"10":{},"11":{}},"description":{}}],["within",{"_index":190,"title":{},"description":{"35":{},"42":{}}}],["workflow",{"_index":149,"title":{"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"53":{},"54":{},"55":{},"56":{}},"description":{"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"53":{},"54":{},"55":{},"56":{}}}],["workflow-templ",{"_index":161,"title":{},"description":{"23":{},"24":{}}}],["workflow-templates/{templateidentifi",{"_index":162,"title":{},"description":{"25":{},"26":{}}}],["workflow-templates/{templatename}/deprec",{"_index":170,"title":{},"description":{"27":{}}}],["workflows/{workflowid",{"_index":156,"title":{},"description":{"21":{}}}],["workflows/{workflowid}/canvot",{"_index":211,"title":{},"description":{"56":{}}}],["workflows/{workflowid}/vot",{"_index":205,"title":{},"description":{"54":{},"55":{}}}]],"pipeline":[]}},"options":{}};
|
|
735
1267
|
|
|
736
1268
|
var container = document.getElementById('redoc');
|
|
737
1269
|
Redoc.hydrate(__redoc_state, container);
|