cloud-api account
Use this command to connect to Microsoft 365 and Google Workspace to access the user mailboxes.
You must have domain administrator privileges to access Microsoft 365 or Google Workspace.
Syntax
config cloud-api account
edit <profile_name>
[set description <comment_str>
set type {exchange | ms365 | gmail}
set admin-email <administrator_email>
set application-secret <password_str>
set global-address-list <id_str>
set realtime-scan-status {enable | disable}
set service-email <service_email>
set service-endpoint {china | germany | global | us-dod | us-gov}
set service-password <password_str>
config user-filter
edit <user-filter_name>
set type {ad-group | email-group | imported-user | ldap-group | regex | wildcard}
set ad-group-attr {custom | displayname | mail}
set ad-group-attr-name <attribute-name_str>
set ad-group-attr-value <attribute-value_str>
set ldap-profile <profile_name>
set pattern <user-filter_pattern>
next
end
end
|
Variable |
Description |
Default |
|
Enter the name of the profile. |
|
|
|
Enter the email address of the administrator. This setting is only available if type {exchange | ms365 | gmail} is |
|
|
|
Enter the application ID. This setting is only available if type {exchange | ms365 | gmail} is |
|
|
|
This setting is only available if type {exchange | ms365 | gmail} is |
|
|
|
Enter the application secret or password. This setting is only available if type {exchange | ms365 | gmail} is |
|
|
|
Enter a description of the account. |
|
|
|
Enter an email group name. This setting is only available if type {ad-group | email-group | imported-user | ldap-group | regex | wildcard} is |
|
|
|
Enter the ID of a global address list. This setting is only available if type {exchange | ms365 | gmail} is |
|
|
|
Enter the LDAP group name. This setting is only available if type {ad-group | email-group | imported-user | ldap-group | regex | wildcard} is |
|
|
|
Select an LDAP group profile. This setting is only available if type {ad-group | email-group | imported-user | ldap-group | regex | wildcard} is |
|
|
|
Enable or disable real-time scan. |
enable |
|
|
Enter the email address used to log into the service. This setting is only available if type {exchange | ms365 | gmail} is |
|
|
|
service-endpoint {china | germany | global | us-dod | us-gov} |
Select a regional endpoint for your geographical location and regulatory compliance requirements. This setting is only available if type {exchange | ms365 | gmail} is |
global |
|
Enter the password used to log into the service. This setting is only available if type {exchange | ms365 | gmail} is |
|
|
|
Enter the URL used to log into the service. This setting is only available if type {exchange | ms365 | gmail} is |
|
|
|
Enable or disable this account. |
enable |
|
|
Enter the Microsoft 365 tenant credentials. |
|
|
|
Select whether the account is on Microsoft 365, Microsoft Exchange, or Google Workspace. |
ms365 |
|
|
Enter the name of the user filter. |
|
|
|
Enter the user filter pattern. This setting is only available if type {ad-group | email-group | imported-user | ldap-group | regex | wildcard} is |
|
|
|
Select the Microsoft Azure Entra ID (formerly Active Directory) group attribute. This setting is only available if type {ad-group | email-group | imported-user | ldap-group | regex | wildcard} is |
displayname |
|
|
Enter the custom Microsoft Azure Entra ID (formerly Active Directory) group attribute name. This setting is only available when both: |
|
|
|
Enter the Microsoft Azure Entra ID (formerly Active Directory) group attribute value. This setting is only available if type {ad-group | email-group | imported-user | ldap-group | regex | wildcard} is |
|
|
|
Enable or disable this user filter. |
disable |
|
|
type {ad-group | email-group | imported-user | ldap-group | regex | wildcard} |
Select the user filter type, either:
|
wildcard |