mattermost-clj.api.users — mattermost-clj 4.0.3

users-autocomplete-get clj

(users-autocomplete-get name)

(users-autocomplete-get name optional-params)

Autocomplete users Get a list of users for the purpose of autocompleting based on the provided search term. Specify a combination of team_id and channel_id to filter results further.

Permissions

Requires an active session and view_team and read_channel on any teams or channels used to filter the results further.

users-autocomplete-get-with-http-info clj

(users-autocomplete-get-with-http-info name)

(users-autocomplete-get-with-http-info name {:keys [team-id channel-id limit]})

Autocomplete users Get a list of users for the purpose of autocompleting based on the provided search term. Specify a combination of team_id and channel_id to filter results further.

Permissions

Requires an active session and view_team and read_channel on any teams or channels used to filter the results further.

users-email-email-get clj

(users-email-email-get email)

Get a user by email Get a user object by providing a user email. Sensitive information will be sanitized out.

Permissions

Requires an active session and for the current session to be able to view another user's email based on the server's privacy settings.

users-email-email-get-with-http-info clj

(users-email-email-get-with-http-info email)

Get a user by email Get a user object by providing a user email. Sensitive information will be sanitized out.

Permissions

Requires an active session and for the current session to be able to view another user's email based on the server's privacy settings.

users-email-verify-post clj

(users-email-verify-post)

(users-email-verify-post optional-params)

Verify user email Verify the email used by a user to sign-up their account with.

Permissions

No permissions required.

users-email-verify-post-with-http-info clj

(users-email-verify-post-with-http-info)

(users-email-verify-post-with-http-info {:keys [inline-object-13]})

Verify user email Verify the email used by a user to sign-up their account with.

Permissions

No permissions required.

users-email-verify-send-post clj

(users-email-verify-send-post)

(users-email-verify-send-post optional-params)

Send verification email Send an email with a verification link to a user that has an email matching the one in the request body. This endpoint will return success even if the email does not match any users on the system.

Permissions

No permissions required.

users-email-verify-send-post-with-http-info clj

(users-email-verify-send-post-with-http-info)

(users-email-verify-send-post-with-http-info {:keys [inline-object-14]})

Send verification email Send an email with a verification link to a user that has an email matching the one in the request body. This endpoint will return success even if the email does not match any users on the system.

Permissions

No permissions required.

users-get clj

(users-get)

(users-get optional-params)

Get users Get a page of a list of users. Based on query string parameters, select users from a team, channel, or select users not in a specific channel.

Since server version 4.0, some basic sorting is available using the sort query parameter. Sorting is currently only supported when selecting users on a team.

Permissions

Requires an active session and (if specified) membership to the channel or team being selected from.

users-get-with-http-info clj

(users-get-with-http-info)

(users-get-with-http-info {:keys [page per-page in-team not-in-team in-channel
                                  not-in-channel group-constrained without-team
                                  sort]})

Get users Get a page of a list of users. Based on query string parameters, select users from a team, channel, or select users not in a specific channel.

Since server version 4.0, some basic sorting is available using the sort query parameter. Sorting is currently only supported when selecting users on a team.

Permissions

Requires an active session and (if specified) membership to the channel or team being selected from.

users-group-channels-post clj

(users-group-channels-post string)

Get users by group channels ids Get an object containing a key per group channel id in the query and its value as a list of users members of that group channel.

The user must be a member of the group ids in the query, or they will be omitted from the response.

Permissions

Requires an active session but no other permissions.

Minimum server version: 5.14

users-group-channels-post-with-http-info clj

(users-group-channels-post-with-http-info string)

Get users by group channels ids Get an object containing a key per group channel id in the query and its value as a list of users members of that group channel.

The user must be a member of the group ids in the query, or they will be omitted from the response.

Permissions

Requires an active session but no other permissions.

Minimum server version: 5.14

users-ids-post clj

(users-ids-post string)

(users-ids-post string optional-params)

Get users by ids Get a list of users based on a provided list of user ids.

Permissions

Requires an active session but no other permissions.

users-ids-post-with-http-info clj

(users-ids-post-with-http-info string)

(users-ids-post-with-http-info string {:keys [since]})

Get users by ids Get a list of users based on a provided list of user ids.

Permissions

Requires an active session but no other permissions.

users-login-switch-post clj

(users-login-switch-post)

(users-login-switch-post optional-params)

Switch login method Switch a user's login method from using email to OAuth2/SAML/LDAP or back to email. When switching to OAuth2/SAML, account switching is not complete until the user follows the returned link and completes any steps on the OAuth2/SAML service provider.

To switch from email to OAuth2/SAML, specify current_service, new_service, email and password.

To switch from OAuth2/SAML to email, specify current_service, new_service, email and new_password.

To switch from email to LDAP/AD, specify current_service, new_service, email, password, ldap_ip and new_password (this is the user's LDAP password).

To switch from LDAP/AD to email, specify current_service, new_service, ldap_ip, password (this is the user's LDAP password), email and new_password.

Additionally, specify mfa_code when trying to switch an account on LDAP/AD or email that has MFA activated.

Permissions

No current authentication required except when switching from OAuth2/SAML to email.

users-login-switch-post-with-http-info clj

(users-login-switch-post-with-http-info)

(users-login-switch-post-with-http-info {:keys [inline-object-15]})

Switch login method Switch a user's login method from using email to OAuth2/SAML/LDAP or back to email. When switching to OAuth2/SAML, account switching is not complete until the user follows the returned link and completes any steps on the OAuth2/SAML service provider.

To switch from email to OAuth2/SAML, specify current_service, new_service, email and password.

To switch from OAuth2/SAML to email, specify current_service, new_service, email and new_password.

To switch from email to LDAP/AD, specify current_service, new_service, email, password, ldap_ip and new_password (this is the user's LDAP password).

To switch from LDAP/AD to email, specify current_service, new_service, ldap_ip, password (this is the user's LDAP password), email and new_password.

Additionally, specify mfa_code when trying to switch an account on LDAP/AD or email that has MFA activated.

Permissions

No current authentication required except when switching from OAuth2/SAML to email.

users-mfa-post clj

(users-mfa-post)

(users-mfa-post optional-params)

Check MFA Check if a user has multi-factor authentication active on their account by providing a login id. Used to check whether an MFA code needs to be provided when logging in.

Permissions

No permission required.

users-mfa-post-with-http-info clj

(users-mfa-post-with-http-info)

(users-mfa-post-with-http-info {:keys [inline-object-8]})

Check MFA Check if a user has multi-factor authentication active on their account by providing a login id. Used to check whether an MFA code needs to be provided when logging in.

Permissions

No permission required.

users-password-reset-post clj

(users-password-reset-post)

(users-password-reset-post optional-params)

Reset password Update the password for a user using a one-use, timed recovery code tied to the user's account. Only works for non-SSO users.

Permissions

No permissions required.

users-password-reset-post-with-http-info clj

(users-password-reset-post-with-http-info)

(users-password-reset-post-with-http-info {:keys [inline-object-6]})

Reset password Update the password for a user using a one-use, timed recovery code tied to the user's account. Only works for non-SSO users.

Permissions

No permissions required.

users-password-reset-send-post clj

(users-password-reset-send-post)

(users-password-reset-send-post optional-params)

Send password reset email Send an email containing a link for resetting the user's password. The link will contain a one-use, timed recovery code tied to the user's account. Only works for non-SSO users.

Permissions

No permissions required.

users-password-reset-send-post-with-http-info clj

(users-password-reset-send-post-with-http-info)

(users-password-reset-send-post-with-http-info {:keys [inline-object-10]})

Send password reset email Send an email containing a link for resetting the user's password. The link will contain a one-use, timed recovery code tied to the user's account. Only works for non-SSO users.

Permissions

No permissions required.

users-post clj

(users-post)

(users-post optional-params)

Create a user Create a new user on the system. Password is required for email login. For other authentication types such as LDAP or SAML, auth_data and auth_service fields are required.

Permissions

No permission required but user creation can be controlled by server configuration.

users-post-with-http-info clj

(users-post-with-http-info)

(users-post-with-http-info {:keys [t iid inline-object]})

Create a user Create a new user on the system. Password is required for email login. For other authentication types such as LDAP or SAML, auth_data and auth_service fields are required.

Permissions

No permission required but user creation can be controlled by server configuration.

users-search-post clj

(users-search-post)

(users-search-post optional-params)

Search users Get a list of users based on search criteria provided in the request body. Searches are typically done against username, full name, nickname and email unless otherwise configured by the server.

Permissions

Requires an active session and read_channel and/or view_team permissions for any channels or teams specified in the request body.

users-search-post-with-http-info clj

(users-search-post-with-http-info)

(users-search-post-with-http-info {:keys [inline-object-1]})

Search users Get a list of users based on search criteria provided in the request body. Searches are typically done against username, full name, nickname and email unless otherwise configured by the server.

Permissions

Requires an active session and read_channel and/or view_team permissions for any channels or teams specified in the request body.

users-sessions-device-put clj

(users-sessions-device-put)

(users-sessions-device-put optional-params)

Attach mobile device Attach a mobile device id to the currently logged in session. This will enable push notifications for a user, if configured by the server.

Permissions

Must be authenticated.

users-sessions-device-put-with-http-info clj

(users-sessions-device-put-with-http-info)

(users-sessions-device-put-with-http-info {:keys [inline-object-12]})

Attach mobile device Attach a mobile device id to the currently logged in session. This will enable push notifications for a user, if configured by the server.

Permissions

Must be authenticated.

users-sessions-revoke-all-post clj

(users-sessions-revoke-all-post)

Revoke all sessions from all users. For any session currently on the server (including admin) it will be revoked. Clients will be notified to log out users.

Minimum server version: 5.14

Permissions

Must have manage_system permission.

users-sessions-revoke-all-post-with-http-info clj

(users-sessions-revoke-all-post-with-http-info)

Revoke all sessions from all users. For any session currently on the server (including admin) it will be revoked. Clients will be notified to log out users.

Minimum server version: 5.14

Permissions

Must have manage_system permission.

users-stats-get clj

(users-stats-get)

Get total count of users in the system Get a total count of users in the system.

Permissions

Must be authenticated.

users-stats-get-with-http-info clj

(users-stats-get-with-http-info)

Get total count of users in the system Get a total count of users in the system.

Permissions

Must be authenticated.

users-tokens-disable-post clj

(users-tokens-disable-post)

(users-tokens-disable-post optional-params)

Disable personal access token Disable a personal access token and delete any sessions using the token. The token can be re-enabled using /users/tokens/enable.

Minimum server version: 4.4

Permissions

Must have revoke_user_access_token permission. For non-self requests, must also have the edit_other_users permission.

users-tokens-disable-post-with-http-info clj

(users-tokens-disable-post-with-http-info)

(users-tokens-disable-post-with-http-info {:keys [inline-object-18]})

Disable personal access token Disable a personal access token and delete any sessions using the token. The token can be re-enabled using /users/tokens/enable.

Minimum server version: 4.4

Permissions

Must have revoke_user_access_token permission. For non-self requests, must also have the edit_other_users permission.

users-tokens-enable-post clj

(users-tokens-enable-post)

(users-tokens-enable-post optional-params)

Enable personal access token Re-enable a personal access token that has been disabled.

Minimum server version: 4.4

Permissions

Must have create_user_access_token permission. For non-self requests, must also have the edit_other_users permission.

users-tokens-enable-post-with-http-info clj

(users-tokens-enable-post-with-http-info)

(users-tokens-enable-post-with-http-info {:keys [inline-object-19]})

Enable personal access token Re-enable a personal access token that has been disabled.

Minimum server version: 4.4

Permissions

Must have create_user_access_token permission. For non-self requests, must also have the edit_other_users permission.

users-tokens-get clj

(users-tokens-get)

(users-tokens-get optional-params)

Get user access tokens Get a page of user access tokens for users on the system. Does not include the actual authentication tokens. Use query parameters for paging.

Minimum server version: 4.7

Permissions

Must have manage_system permission.

users-tokens-get-with-http-info clj

(users-tokens-get-with-http-info)

(users-tokens-get-with-http-info {:keys [page per-page]})

Get user access tokens Get a page of user access tokens for users on the system. Does not include the actual authentication tokens. Use query parameters for paging.

Minimum server version: 4.7

Permissions

Must have manage_system permission.

users-tokens-revoke-post clj

(users-tokens-revoke-post)

(users-tokens-revoke-post optional-params)

Revoke a user access token Revoke a user access token and delete any sessions using the token.

Minimum server version: 4.1

Permissions

Must have revoke_user_access_token permission. For non-self requests, must also have the edit_other_users permission.

users-tokens-revoke-post-with-http-info clj

(users-tokens-revoke-post-with-http-info)

(users-tokens-revoke-post-with-http-info {:keys [inline-object-17]})

Revoke a user access token Revoke a user access token and delete any sessions using the token.

Minimum server version: 4.1

Permissions

Must have revoke_user_access_token permission. For non-self requests, must also have the edit_other_users permission.

users-tokens-search-post clj

(users-tokens-search-post)

(users-tokens-search-post optional-params)

Search tokens Get a list of tokens based on search criteria provided in the request body. Searches are done against the token id, user id and username.

Minimum server version: 4.7

Permissions

Must have manage_system permission.

users-tokens-search-post-with-http-info clj

(users-tokens-search-post-with-http-info)

(users-tokens-search-post-with-http-info {:keys [inline-object-20]})

Search tokens Get a list of tokens based on search criteria provided in the request body. Searches are done against the token id, user id and username.

Minimum server version: 4.7

Permissions

Must have manage_system permission.

users-tokens-token-id-get clj

(users-tokens-token-id-get token-id)

Get a user access token Get a user access token. Does not include the actual authentication token.

Minimum server version: 4.1

Permissions

Must have read_user_access_token permission. For non-self requests, must also have the edit_other_users permission.

users-tokens-token-id-get-with-http-info clj

(users-tokens-token-id-get-with-http-info token-id)

Get a user access token Get a user access token. Does not include the actual authentication token.

Minimum server version: 4.1

Permissions

Must have read_user_access_token permission. For non-self requests, must also have the edit_other_users permission.

users-user-id-active-put clj

(users-user-id-active-put user-id)

(users-user-id-active-put user-id optional-params)

Update user active status Update user active or inactive status.

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.

Permissions

User can deactivate themselves. User with manage_system permission can activate or deactivate a user.

users-user-id-active-put-with-http-info clj

(users-user-id-active-put-with-http-info user-id)

(users-user-id-active-put-with-http-info user-id {:keys [inline-object-5]})

Update user active status Update user active or inactive status.

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.

Permissions

User can deactivate themselves. User with manage_system permission can activate or deactivate a user.

users-user-id-audits-get clj

(users-user-id-audits-get user-id)

Get user's audits Get a list of audit by providing the user GUID.

Permissions

Must be logged in as the user or have the edit_other_users permission.

users-user-id-audits-get-with-http-info clj

(users-user-id-audits-get-with-http-info user-id)

Get user's audits Get a list of audit by providing the user GUID.

Permissions

Must be logged in as the user or have the edit_other_users permission.

users-user-id-auth-put clj

(users-user-id-auth-put user-id user-auth-data)

Update a user's authentication method Updates a user's authentication method. This can be used to change them to/from LDAP authentication for example.

Minimum server version: 4.6

Permissions

Must have the edit_other_users permission.

users-user-id-auth-put-with-http-info clj

(users-user-id-auth-put-with-http-info user-id user-auth-data)

Update a user's authentication method Updates a user's authentication method. This can be used to change them to/from LDAP authentication for example.

Minimum server version: 4.6

Permissions

Must have the edit_other_users permission.

users-user-id-delete clj

(users-user-id-delete user-id)

Deactivate a user account. Deactivates the user and revokes all its sessions by archiving its user object.

Permissions

Must be logged in as the user being deactivated or have the edit_other_users permission.

users-user-id-delete-with-http-info clj

(users-user-id-delete-with-http-info user-id)

Deactivate a user account. Deactivates the user and revokes all its sessions by archiving its user object.

Permissions

Must be logged in as the user being deactivated or have the edit_other_users permission.

users-user-id-demote-post clj

(users-user-id-demote-post user-id)

Demote a user to a guest Convert a regular user into a guest. This will convert the user into a guest for the whole system while retaining their existing team and channel memberships.

Minimum server version: 5.16

Permissions

Must be logged in as the user or have the demote_to_guest permission.

users-user-id-demote-post-with-http-info clj

(users-user-id-demote-post-with-http-info user-id)

Demote a user to a guest Convert a regular user into a guest. This will convert the user into a guest for the whole system while retaining their existing team and channel memberships.

Minimum server version: 5.16

Permissions

Must be logged in as the user or have the demote_to_guest permission.

users-user-id-get clj

(users-user-id-get user-id)

Get a user Get a user a object. Sensitive information will be sanitized out.

Permissions

Requires an active session but no other permissions.

users-user-id-get-with-http-info clj

(users-user-id-get-with-http-info user-id)

Get a user Get a user a object. Sensitive information will be sanitized out.

Permissions

Requires an active session but no other permissions.

users-user-id-image-default-get clj

(users-user-id-image-default-get user-id)

Return user's default (generated) profile image Returns the default (generated) user profile image based on user_id string parameter.

Permissions

Must be logged in. Minimum server version: 5.5

users-user-id-image-default-get-with-http-info clj

(users-user-id-image-default-get-with-http-info user-id)

Return user's default (generated) profile image Returns the default (generated) user profile image based on user_id string parameter.

Permissions

Must be logged in. Minimum server version: 5.5

users-user-id-image-delete clj

(users-user-id-image-delete user-id)

Delete user's profile image Delete user's profile image and reset to default image based on user_id string parameter.

Permissions

Must be logged in as the user being updated or have the edit_other_users permission. Minimum server version: 5.5

users-user-id-image-delete-with-http-info clj

(users-user-id-image-delete-with-http-info user-id)

Delete user's profile image Delete user's profile image and reset to default image based on user_id string parameter.

Permissions

Must be logged in as the user being updated or have the edit_other_users permission. Minimum server version: 5.5

users-user-id-image-get clj

(users-user-id-image-get user-id)

Get user's profile image Get a user's profile image based on user_id string parameter.

Permissions

Must be logged in.

users-user-id-image-get-with-http-info clj

(users-user-id-image-get-with-http-info user-id)

Get user's profile image Get a user's profile image based on user_id string parameter.

Permissions

Must be logged in.

users-user-id-image-post clj

(users-user-id-image-post user-id image)

Set user's profile image Set a user's profile image based on user_id string parameter.

Permissions

Must be logged in as the user being updated or have the edit_other_users permission.

users-user-id-image-post-with-http-info clj

(users-user-id-image-post-with-http-info user-id image)

Set user's profile image Set a user's profile image based on user_id string parameter.

Permissions

Must be logged in as the user being updated or have the edit_other_users permission.

users-user-id-mfa-generate-post clj

(users-user-id-mfa-generate-post user-id)

Generate MFA secret Generates an multi-factor authentication secret for a user and returns it as a string and as base64 encoded QR code image.

Permissions

Must be logged in as the user or have the edit_other_users permission.

users-user-id-mfa-generate-post-with-http-info clj

(users-user-id-mfa-generate-post-with-http-info user-id)

Generate MFA secret Generates an multi-factor authentication secret for a user and returns it as a string and as base64 encoded QR code image.

Permissions

Must be logged in as the user or have the edit_other_users permission.

users-user-id-mfa-put clj

(users-user-id-mfa-put user-id)

(users-user-id-mfa-put user-id optional-params)

Update a user's MFA Activates multi-factor authentication for the user if activate is true and a valid code is provided. If activate is false, then code is not required and multi-factor authentication is disabled for the user.

Permissions

Must be logged in as the user being updated or have the edit_other_users permission.

users-user-id-mfa-put-with-http-info clj

(users-user-id-mfa-put-with-http-info user-id)

(users-user-id-mfa-put-with-http-info user-id {:keys [inline-object-7]})

Update a user's MFA Activates multi-factor authentication for the user if activate is true and a valid code is provided. If activate is false, then code is not required and multi-factor authentication is disabled for the user.

Permissions

Must be logged in as the user being updated or have the edit_other_users permission.

users-user-id-password-put clj

(users-user-id-password-put user-id)

(users-user-id-password-put user-id optional-params)

Update a user's password Update a user's password. New password must meet password policy set by server configuration. Current password is required if you're updating your own password.

Permissions

Must be logged in as the user the password is being changed for or have manage_system permission.

users-user-id-password-put-with-http-info clj

(users-user-id-password-put-with-http-info user-id)

(users-user-id-password-put-with-http-info user-id {:keys [inline-object-9]})

Update a user's password Update a user's password. New password must meet password policy set by server configuration. Current password is required if you're updating your own password.

Permissions

Must be logged in as the user the password is being changed for or have manage_system permission.

users-user-id-patch-put clj

(users-user-id-patch-put user-id)

(users-user-id-patch-put user-id optional-params)

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

Permissions

Must be logged in as the user being updated or have the edit_other_users permission.

users-user-id-patch-put-with-http-info clj

(users-user-id-patch-put-with-http-info user-id)

(users-user-id-patch-put-with-http-info user-id {:keys [inline-object-3]})

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

Permissions

Must be logged in as the user being updated or have the edit_other_users permission.

users-user-id-promote-post clj

(users-user-id-promote-post user-id)

Promote a guest to user Convert a guest into a regular user. This will convert the guest into a user for the whole system while retaining any team and channel memberships and automatically joining them to the default channels.

Minimum server version: 5.16

Permissions

Must be logged in as the user or have the promote_guest permission.

users-user-id-promote-post-with-http-info clj

(users-user-id-promote-post-with-http-info user-id)

Promote a guest to user Convert a guest into a regular user. This will convert the guest into a user for the whole system while retaining any team and channel memberships and automatically joining them to the default channels.

Minimum server version: 5.16

Permissions

Must be logged in as the user or have the promote_guest permission.

users-user-id-put clj

(users-user-id-put user-id)

(users-user-id-put user-id optional-params)

Update a user Update a user by providing the user object. The fields that can be updated are defined in the request body, all other provided fields will be ignored. Any fields not included in the request body will be set to null or reverted to default values.

Permissions

Must be logged in as the user being updated or have the edit_other_users permission.

users-user-id-put-with-http-info clj

(users-user-id-put-with-http-info user-id)

(users-user-id-put-with-http-info user-id {:keys [inline-object-2]})

Update a user Update a user by providing the user object. The fields that can be updated are defined in the request body, all other provided fields will be ignored. Any fields not included in the request body will be set to null or reverted to default values.

Permissions

Must be logged in as the user being updated or have the edit_other_users permission.

users-user-id-roles-put clj

(users-user-id-roles-put user-id)

(users-user-id-roles-put user-id optional-params)

Update a user's roles Update a user's system-level roles. Valid user roles are "system_user", "system_admin" or both of them. Overwrites any previously assigned system-level roles.

Permissions

Must have the manage_roles permission.

users-user-id-roles-put-with-http-info clj

(users-user-id-roles-put-with-http-info user-id)

(users-user-id-roles-put-with-http-info user-id {:keys [inline-object-4]})

Update a user's roles Update a user's system-level roles. Valid user roles are "system_user", "system_admin" or both of them. Overwrites any previously assigned system-level roles.

Permissions

Must have the manage_roles permission.

users-user-id-sessions-get clj

(users-user-id-sessions-get user-id)

Get user's sessions Get a list of sessions by providing the user GUID. Sensitive information will be sanitized out.

Permissions

Must be logged in as the user being updated or have the edit_other_users permission.

users-user-id-sessions-get-with-http-info clj

(users-user-id-sessions-get-with-http-info user-id)

Get user's sessions Get a list of sessions by providing the user GUID. Sensitive information will be sanitized out.

Permissions

Must be logged in as the user being updated or have the edit_other_users permission.

users-user-id-sessions-revoke-all-post clj

(users-user-id-sessions-revoke-all-post user-id)

Revoke all active sessions for a user Revokes all user sessions from the provided user id and session id strings.

Permissions

Must be logged in as the user being updated or have the edit_other_users permission. Minimum server version: 4.4

users-user-id-sessions-revoke-all-post-with-http-info clj

(users-user-id-sessions-revoke-all-post-with-http-info user-id)

Revoke all active sessions for a user Revokes all user sessions from the provided user id and session id strings.

Permissions

Must be logged in as the user being updated or have the edit_other_users permission. Minimum server version: 4.4

users-user-id-sessions-revoke-post clj

(users-user-id-sessions-revoke-post user-id)

(users-user-id-sessions-revoke-post user-id optional-params)

Revoke a user session Revokes a user session from the provided user id and session id strings.

Permissions

Must be logged in as the user being updated or have the edit_other_users permission.

users-user-id-sessions-revoke-post-with-http-info clj

(users-user-id-sessions-revoke-post-with-http-info user-id)

(users-user-id-sessions-revoke-post-with-http-info user-id
                                                   {:keys [inline-object-11]})

Revoke a user session Revokes a user session from the provided user id and session id strings.

Permissions

Must be logged in as the user being updated or have the edit_other_users permission.

users-user-id-terms-of-service-get clj

(users-user-id-terms-of-service-get user-id)

Fetches user's latest terms of service action if the latest action was for acceptance. Will be deprecated in v6.0 Fetches user's latest terms of service action if the latest action was for acceptance.

Minimum server version: 5.6

Permissions

Must be logged in as the user being acted on.

users-user-id-terms-of-service-get-with-http-info clj

(users-user-id-terms-of-service-get-with-http-info user-id)

Fetches user's latest terms of service action if the latest action was for acceptance. Will be deprecated in v6.0 Fetches user's latest terms of service action if the latest action was for acceptance.

Minimum server version: 5.6

Permissions

Must be logged in as the user being acted on.

users-user-id-terms-of-service-post clj

(users-user-id-terms-of-service-post user-id)

(users-user-id-terms-of-service-post user-id optional-params)

Records user action when they accept or decline custom terms of service Records user action when they accept or decline custom terms of service. Records the action in audit table. Updates user's last accepted terms of service ID if they accepted it.

Minimum server version: 5.4

Permissions

Must be logged in as the user being acted on.

users-user-id-terms-of-service-post-with-http-info clj

(users-user-id-terms-of-service-post-with-http-info user-id)

(users-user-id-terms-of-service-post-with-http-info user-id
                                                    {:keys [inline-object-21]})

Records user action when they accept or decline custom terms of service Records user action when they accept or decline custom terms of service. Records the action in audit table. Updates user's last accepted terms of service ID if they accepted it.

Minimum server version: 5.4

Permissions

Must be logged in as the user being acted on.

users-user-id-tokens-get clj

(users-user-id-tokens-get user-id)

(users-user-id-tokens-get user-id optional-params)

Get user access tokens Get a list of user access tokens for a user. Does not include the actual authentication tokens. Use query parameters for paging.

Minimum server version: 4.1

Permissions

Must have read_user_access_token permission. For non-self requests, must also have the edit_other_users permission.

users-user-id-tokens-get-with-http-info clj

(users-user-id-tokens-get-with-http-info user-id)

(users-user-id-tokens-get-with-http-info user-id {:keys [page per-page]})

Get user access tokens Get a list of user access tokens for a user. Does not include the actual authentication tokens. Use query parameters for paging.

Minimum server version: 4.1

Permissions

Must have read_user_access_token permission. For non-self requests, must also have the edit_other_users permission.

users-user-id-tokens-post clj

(users-user-id-tokens-post user-id)

(users-user-id-tokens-post user-id optional-params)

Create a user access token Generate a user access token that can be used to authenticate with the Mattermost REST API.

Minimum server version: 4.1

Permissions

Must have create_user_access_token permission. For non-self requests, must also have the edit_other_users permission.

users-user-id-tokens-post-with-http-info clj

(users-user-id-tokens-post-with-http-info user-id)

(users-user-id-tokens-post-with-http-info user-id {:keys [inline-object-16]})

Create a user access token Generate a user access token that can be used to authenticate with the Mattermost REST API.

Minimum server version: 4.1

Permissions

Must have create_user_access_token permission. For non-self requests, must also have the edit_other_users permission.

users-username-username-get clj

(users-username-username-get username)

Get a user by username Get a user object by providing a username. Sensitive information will be sanitized out.

Permissions

Requires an active session but no other permissions.

users-username-username-get-with-http-info clj

(users-username-username-get-with-http-info username)

Get a user by username Get a user object by providing a username. Sensitive information will be sanitized out.

Permissions

Requires an active session but no other permissions.

users-usernames-post clj

(users-usernames-post string)

Get users by usernames Get a list of users based on a provided list of usernames.

Permissions

Requires an active session but no other permissions.

users-usernames-post-with-http-info clj

(users-usernames-post-with-http-info string)

Get users by usernames Get a list of users based on a provided list of usernames.

Permissions

Requires an active session but no other permissions.