Module: Sophos::Client::Common

Included in:

TenantClient

Defined in:

lib/sophos/client/common.rb

Overview

Common API module for handling various endpoints in Sophos Central. This module provides access to alerts, directory users, and user groups.

See Also:

• https://developer.sophos.com/docs/common-v1/1/overview

Instance Method Summary

• #directory_user_group_users(group_id, params = {}) ⇒ Hash

  Fetch paginated users in a specified user group.

• #directory_user_groups(user_id, params = {}) ⇒ Hash

  Fetch paginated user groups for a specified user.

Instance Method Details

#directory_user_group_users(group_id, params = {}) ⇒ Hash

Fetch paginated users in a specified user group.

Parameters:

• group_id (String) —

  The ID of the user group.

• params (Hash) (defaults to: {}) —

  Additional query parameters (e.g., pageSize, page).

Returns:

• (Hash) —

  API response containing users in the specified group.

See Also:

• https://developer.sophos.com/docs/common-v1/1/routes/directory/user-groups/get

# File 'lib/sophos/client/common.rb', line 26

def directory_user_group_users(group_id, params = {})
  get_paged(Helper::common_url("directory/user-groups/#{group_id}/users"), params)
end

#directory_user_groups(user_id, params = {}) ⇒ Hash

Fetch paginated user groups for a specified user.

Parameters:

• user_id (String) —

  The ID of the user.

• params (Hash) (defaults to: {}) —

  Additional query parameters (e.g., pageSize, page).

Returns:

• (Hash) —

  API response containing groups the user belongs to.

See Also:

• https://developer.sophos.com/docs/common-v1/1/routes/directory/users/get

# File 'lib/sophos/client/common.rb', line 39

def directory_user_groups(user_id, params = {})
  get_paged(Helper::common_url("directory/users/#{user_id}/groups"), params)
end