You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: site/static/mattermost-openapi-v4.yaml
+77-52Lines changed: 77 additions & 52 deletions
Original file line number
Diff line number
Diff line change
@@ -1502,9 +1502,9 @@ paths:
1502
1502
put:
1503
1503
tags:
1504
1504
- users
1505
-
summary: Update user active status
1505
+
summary: Activate or deactivate a user
1506
1506
description: >
1507
-
Update user active or inactive status.
1507
+
Activate or deactivate a user's account. A deactivated user can't log into Mattermost or use it without being reactivated.
1508
1508
1509
1509
1510
1510
__Since server version 4.6, users using a SSO provider to login can be activated or deactivated with this endpoint. However, if their activation status in Mattermost does not reflect their status in the SSO provider, the next synchronization or login by that user will reset the activation status to that of their account in the SSO provider. Server versions 4.5 and before do not allow activation or deactivation of SSO users from this endpoint.__
@@ -1533,11 +1533,11 @@ paths:
1533
1533
properties:
1534
1534
active:
1535
1535
type: boolean
1536
-
description: Use `true` to set the user active, `false` for inactive
1536
+
description: Use `true` to activate the user or `false` to deactivate them
1537
1537
required: true
1538
1538
responses:
1539
1539
"200":
1540
-
description: User active status update successful
1540
+
description: User activation/deactivation update successful
1541
1541
content:
1542
1542
application/json:
1543
1543
schema:
@@ -8827,6 +8827,43 @@ paths:
8827
8827
$ref: '#/components/responses/Forbidden'
8828
8828
"404":
8829
8829
$ref: '#/components/responses/NotFound'
8830
+
/api/v4/sharedchannels/{channel_id}/remotes:
8831
+
get:
8832
+
tags:
8833
+
- shared channels
8834
+
summary: Get remote clusters for a shared channel
8835
+
description: |
8836
+
Gets the remote clusters information for a shared channel.
8837
+
8838
+
__Minimum server version__: 10.11
8839
+
8840
+
##### Permissions
8841
+
Must be authenticated and have the `read_channel` permission for the channel.
8842
+
operationId: GetSharedChannelRemotes
8843
+
parameters:
8844
+
- name: channel_id
8845
+
in: path
8846
+
description: Channel GUID
8847
+
required: true
8848
+
schema:
8849
+
type: string
8850
+
responses:
8851
+
"200":
8852
+
description: Remote clusters retrieval successful
8853
+
content:
8854
+
application/json:
8855
+
schema:
8856
+
type: array
8857
+
items:
8858
+
$ref: '#/components/schemas/RemoteClusterInfo'
8859
+
"400":
8860
+
$ref: '#/components/responses/BadRequest'
8861
+
"401":
8862
+
$ref: '#/components/responses/Unauthorized'
8863
+
"403":
8864
+
$ref: '#/components/responses/Forbidden'
8865
+
"404":
8866
+
$ref: '#/components/responses/NotFound'
8830
8867
/api/v4/channels/{channel_id}/common_teams:
8831
8868
get:
8832
8869
tags:
@@ -18628,43 +18665,6 @@ paths:
18628
18665
$ref: '#/components/responses/Unauthorized'
18629
18666
"403":
18630
18667
$ref: '#/components/responses/Forbidden'
18631
-
/api/v4/sharedchannels/{channel_id}/remotes:
18632
-
get:
18633
-
tags:
18634
-
- channels
18635
-
summary: Get remote clusters for a shared channel
18636
-
description: |
18637
-
Gets the remote clusters information for a shared channel.
18638
-
18639
-
__Minimum server version__: 10.10
18640
-
18641
-
##### Permissions
18642
-
Must be authenticated and have the `read_channel` permission for the channel.
0 commit comments