Liking cljdoc? Tell your friends :D

mattermost-clj.api.groups


channels-channel-id-groups-getclj

(channels-channel-id-groups-get channel-id)
(channels-channel-id-groups-get channel-id optional-params)

Get channel groups Retrieve the list of groups associated with a given channel.

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Get channel groups
  Retrieve the list of groups associated with a given channel.

##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

channels-channel-id-groups-get-with-http-infoclj

(channels-channel-id-groups-get-with-http-info channel-id)
(channels-channel-id-groups-get-with-http-info channel-id
                                               {:keys [page per-page]})

Get channel groups Retrieve the list of groups associated with a given channel.

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Get channel groups
  Retrieve the list of groups associated with a given channel.

##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

groups-getclj

(groups-get)
(groups-get optional-params)

Get groups Retrieve the list of groups.

Minimum server version: 5.11

Get groups
  Retrieve the list of groups.

__Minimum server version__: 5.11
raw docstring

groups-get-with-http-infoclj

(groups-get-with-http-info)
(groups-get-with-http-info {:keys [page per-page q include-member-count
                                   not-associated-to-team
                                   not-associated-to-channel]})

Get groups Retrieve the list of groups.

Minimum server version: 5.11

Get groups
  Retrieve the list of groups.

__Minimum server version__: 5.11
raw docstring

groups-group-id-channels-channel-id-getclj

(groups-group-id-channels-channel-id-get group-id channel-id)

Get GroupSyncable from channel ID Get the GroupSyncable object with group_id and channel_id from params

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Get GroupSyncable from channel ID
  Get the GroupSyncable object with group_id and channel_id from params
##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-channels-channel-id-get-with-http-infoclj

(groups-group-id-channels-channel-id-get-with-http-info group-id channel-id)

Get GroupSyncable from channel ID Get the GroupSyncable object with group_id and channel_id from params

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Get GroupSyncable from channel ID
  Get the GroupSyncable object with group_id and channel_id from params
##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

(groups-group-id-channels-channel-id-link-delete group-id channel-id)

Delete a link from a channel to a group Delete a link from a channel to a group

Permissions

If the channel is private, you must have manage_private_channel_members permission. Otherwise, you must have the manage_public_channel_members permission.

Minimum server version: 5.11

Delete a link from a channel to a group
  Delete a link from a channel to a group
##### Permissions
If the channel is private, you must have `manage_private_channel_members` permission.
Otherwise, you must have the `manage_public_channel_members` permission.

__Minimum server version__: 5.11
raw docstring

(groups-group-id-channels-channel-id-link-delete-with-http-info group-id
                                                                channel-id)

Delete a link from a channel to a group Delete a link from a channel to a group

Permissions

If the channel is private, you must have manage_private_channel_members permission. Otherwise, you must have the manage_public_channel_members permission.

Minimum server version: 5.11

Delete a link from a channel to a group
  Delete a link from a channel to a group
##### Permissions
If the channel is private, you must have `manage_private_channel_members` permission.
Otherwise, you must have the `manage_public_channel_members` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-channels-channel-id-link-postclj

(groups-group-id-channels-channel-id-link-post group-id channel-id)

Link a channel to a group Link a channel to a group

Permissions

If the channel is private, you must have manage_private_channel_members permission. Otherwise, you must have the manage_public_channel_members permission.

Minimum server version: 5.11

Link a channel to a group
  Link a channel to a group
##### Permissions
If the channel is private, you must have `manage_private_channel_members` permission.
Otherwise, you must have the `manage_public_channel_members` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-channels-channel-id-link-post-with-http-infoclj

(groups-group-id-channels-channel-id-link-post-with-http-info group-id
                                                              channel-id)

Link a channel to a group Link a channel to a group

Permissions

If the channel is private, you must have manage_private_channel_members permission. Otherwise, you must have the manage_public_channel_members permission.

Minimum server version: 5.11

Link a channel to a group
  Link a channel to a group
##### Permissions
If the channel is private, you must have `manage_private_channel_members` permission.
Otherwise, you must have the `manage_public_channel_members` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-channels-channel-id-patch-putclj

(groups-group-id-channels-channel-id-patch-put group-id channel-id)
(groups-group-id-channels-channel-id-patch-put group-id
                                               channel-id
                                               optional-params)

Patch a GroupSyncable associated to Channel Partially update a GroupSyncable by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Patch a GroupSyncable associated to Channel
  Partially update a GroupSyncable by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.

##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-channels-channel-id-patch-put-with-http-infoclj

(groups-group-id-channels-channel-id-patch-put-with-http-info group-id
                                                              channel-id)
(groups-group-id-channels-channel-id-patch-put-with-http-info
  group-id
  channel-id
  {:keys [inline-object-57]})

Patch a GroupSyncable associated to Channel Partially update a GroupSyncable by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Patch a GroupSyncable associated to Channel
  Partially update a GroupSyncable by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.

##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-channels-getclj

(groups-group-id-channels-get group-id)

Get group channels Retrieve the list of channels associated to the group

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Get group channels
  Retrieve the list of channels associated to the group
##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-channels-get-with-http-infoclj

(groups-group-id-channels-get-with-http-info group-id)

Get group channels Retrieve the list of channels associated to the group

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Get group channels
  Retrieve the list of channels associated to the group
##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-getclj

(groups-group-id-get group-id)

Get a group Get group from the provided group id string

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Get a group
  Get group from the provided group id string

##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-get-with-http-infoclj

(groups-group-id-get-with-http-info group-id)

Get a group Get group from the provided group id string

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Get a group
  Get group from the provided group id string

##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-members-getclj

(groups-group-id-members-get group-id)
(groups-group-id-members-get group-id optional-params)

Get group users Retrieve the list of users associated with a given group.

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Get group users
  Retrieve the list of users associated with a given group.

##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-members-get-with-http-infoclj

(groups-group-id-members-get-with-http-info group-id)
(groups-group-id-members-get-with-http-info group-id {:keys [page per-page]})

Get group users Retrieve the list of users associated with a given group.

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Get group users
  Retrieve the list of users associated with a given group.

##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-patch-putclj

(groups-group-id-patch-put group-id)
(groups-group-id-patch-put group-id optional-params)

Patch a group Partially update a group by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Patch a group
  Partially update a group by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.

##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-patch-put-with-http-infoclj

(groups-group-id-patch-put-with-http-info group-id)
(groups-group-id-patch-put-with-http-info group-id {:keys [inline-object-55]})

Patch a group Partially update a group by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Patch a group
  Partially update a group by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.

##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-teams-getclj

(groups-group-id-teams-get group-id)

Get group teams Retrieve the list of teams associated to the group

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Get group teams
  Retrieve the list of teams associated to the group
##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-teams-get-with-http-infoclj

(groups-group-id-teams-get-with-http-info group-id)

Get group teams Retrieve the list of teams associated to the group

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Get group teams
  Retrieve the list of teams associated to the group
##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-teams-team-id-getclj

(groups-group-id-teams-team-id-get group-id team-id)

Get GroupSyncable from Team ID Get the GroupSyncable object with group_id and team_id from params

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Get GroupSyncable from Team ID
  Get the GroupSyncable object with group_id and team_id from params
##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-teams-team-id-get-with-http-infoclj

(groups-group-id-teams-team-id-get-with-http-info group-id team-id)

Get GroupSyncable from Team ID Get the GroupSyncable object with group_id and team_id from params

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Get GroupSyncable from Team ID
  Get the GroupSyncable object with group_id and team_id from params
##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

(groups-group-id-teams-team-id-link-delete group-id team-id)

Delete a link from a team to a group Delete a link from a team to a group

Permissions

Must have manage_team permission.

Minimum server version: 5.11

Delete a link from a team to a group
  Delete a link from a team to a group
##### Permissions
Must have `manage_team` permission.

__Minimum server version__: 5.11
raw docstring

(groups-group-id-teams-team-id-link-delete-with-http-info group-id team-id)

Delete a link from a team to a group Delete a link from a team to a group

Permissions

Must have manage_team permission.

Minimum server version: 5.11

Delete a link from a team to a group
  Delete a link from a team to a group
##### Permissions
Must have `manage_team` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-teams-team-id-link-postclj

(groups-group-id-teams-team-id-link-post group-id team-id)

Link a team to a group Link a team to a group

Permissions

Must have manage_team permission.

Minimum server version: 5.11

Link a team to a group
  Link a team to a group
##### Permissions
Must have `manage_team` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-teams-team-id-link-post-with-http-infoclj

(groups-group-id-teams-team-id-link-post-with-http-info group-id team-id)

Link a team to a group Link a team to a group

Permissions

Must have manage_team permission.

Minimum server version: 5.11

Link a team to a group
  Link a team to a group
##### Permissions
Must have `manage_team` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-teams-team-id-patch-putclj

(groups-group-id-teams-team-id-patch-put group-id team-id)
(groups-group-id-teams-team-id-patch-put group-id team-id optional-params)

Patch a GroupSyncable associated to Team Partially update a GroupSyncable by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Patch a GroupSyncable associated to Team
  Partially update a GroupSyncable by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.

##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

groups-group-id-teams-team-id-patch-put-with-http-infoclj

(groups-group-id-teams-team-id-patch-put-with-http-info group-id team-id)
(groups-group-id-teams-team-id-patch-put-with-http-info group-id
                                                        team-id
                                                        {:keys
                                                           [inline-object-56]})

Patch a GroupSyncable associated to Team Partially update a GroupSyncable by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Patch a GroupSyncable associated to Team
  Partially update a GroupSyncable by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.

##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

teams-team-id-groups-getclj

(teams-team-id-groups-get team-id)
(teams-team-id-groups-get team-id optional-params)

Get team groups Retrieve the list of groups associated with a given team.

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Get team groups
  Retrieve the list of groups associated with a given team.

##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

teams-team-id-groups-get-with-http-infoclj

(teams-team-id-groups-get-with-http-info team-id)
(teams-team-id-groups-get-with-http-info team-id {:keys [page per-page]})

Get team groups Retrieve the list of groups associated with a given team.

Permissions

Must have manage_system permission.

Minimum server version: 5.11

Get team groups
  Retrieve the list of groups associated with a given team.

##### Permissions
Must have `manage_system` permission.

__Minimum server version__: 5.11
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close