Skip to main content
Server path: /sophos-central-directory | Type: Application | PCID required: Yes

Tools


sophos-central-directory_add_users_to_group

Add users to group Parameters:
ParameterTypeRequiredDefaultDescription
groupIdstringYesGroup ID
idsstring[]YesUser IDs to add

sophos-central-directory_create_user

Create directory user Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoEmail address
exchangeLoginstringNoExchange login
firstNamestringYesFirst name
lastNamestringYesLast name
namestringYesDisplay name

sophos-central-directory_create_user_group

Create user group Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoGroup description
namestringYesGroup name

sophos-central-directory_delete_user

Delete user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID

sophos-central-directory_delete_user_group

Delete user group Parameters:
ParameterTypeRequiredDefaultDescription
groupIdstringYesGroup ID

sophos-central-directory_get_user

Get user details Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID

sophos-central-directory_get_user_group

Get user group Parameters:
ParameterTypeRequiredDefaultDescription
groupIdstringYesGroup ID

sophos-central-directory_list_admins

List administrators Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoItems per page
pageintegerNoPage number

sophos-central-directory_list_roles

List roles Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoItems per page
pageintegerNoPage number

sophos-central-directory_list_user_group_members

List user group members Parameters:
ParameterTypeRequiredDefaultDescription
groupIdstringYesGroup ID
pageSizeintegerNoItems per page
pageintegerNoPage number

sophos-central-directory_list_user_groups

List user groups Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoNumber of items per page
pageintegerNoPage number
searchstringNoSearch by group name

sophos-central-directory_list_users

List directory users Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoNumber of items per page
pageintegerNoPage number
searchstringNoSearch by name or email
groupIdstringNoFilter by group ID

sophos-central-directory_remove_user_from_group

Remove user from group Parameters:
ParameterTypeRequiredDefaultDescription
groupIdstringYesGroup ID
userIdstringYesUser ID

sophos-central-directory_update_user

Update user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
emailstringNoUpdated email
firstNamestringNoUpdated first name
lastNamestringNoUpdated last name
namestringNoUpdated display name

sophos-central-directory_update_user_group

Update user group Parameters:
ParameterTypeRequiredDefaultDescription
groupIdstringYesGroup ID
descriptionstringNoUpdated description
namestringNoUpdated group name