Salesforce IAM

Details

ID	`Salesforce IAM`
Provider	Salesforce
Category	Identity and Access Management
From Version	6.0.0
Docker Image	`demisto/python3:3.12.13.10116658`
Supported Modules	Agentix XSIAM EDR Cortex Cloud Cloud Runtime Security

README

Note: This integration should be used along with our IAM premium pack. For further details, visit our IAM pack documentation.

Integrate with Salesforce’s services to perform Identity Lifecycle Management operations.
For more information, please refer to the Identity Lifecycle Management article.

Configure Salesforce IAM in Cortex

Required Fields in Create User Command

When creating a user in Salesforce there are mandatory fields that need to be set. Some of them are set with default values in the integration parameters:
Default Local Sid Key, Default Email Encoding Key and Default Language Locale Key.
ProfileId and Timezone Sid Key are also required, but are filled using the Salesforce mapper in the following manner:
Duplicate the GenerateProfileId and the GenerateTimeZone automations, edit them according to your needs, and use them as transformers in the User Profile - Salesforce (Outgoing) mapper under the ProfileId and TimeZoneSidKey fields respectively.
This configuration ensures that the user being created is created with the right permissions and settings in Salesforce.

Parameter	Description	Required
Salesforce url (Eg: https://domain.salesforce.com/)		True
User name		True
Password		True
Consumer Key		False
Consumer Secret		False
Trust any certificate (not secure)		False
Use system proxy settings		False
Allow creating users		False
Allow updating users		False
Allow enabling users		False
Allow disabling users		False
Automatically create user if not found in update and enable commands		False
Incoming Mapper		True
Outgoing Mapper	Cortex XSOAR only parameter.	False
Default Local Sid Key	Used when creating a new user.	True
Default Email Encoding Key	Used when creating a new user.	True
Default Language Locale Key	Used when creating a new user.	True

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

iam-create-user

Creates a user with specific settings and permissions in Salesforce, according to the configuration of the Salesforce integration and mapper - as explained in the “Required Fields in Create User Command” section.

Base Command

iam-create-user

Input

Argument Name	Description	Required
user-profile	User Profile indicator details.	Required
allow-enable	When set to true, after the command execution the status of the user in the 3rd-party integration will be active. Possible values are: true, false. Default is true.	Optional

Context Output

Path	Type	Description
IAM.Vendor.active	Boolean	If true the employee’s status is active, otherwise false.
IAM.Vendor.brand	String	Name of the integration.
IAM.Vendor.details	string	Gives the user information if the API was successful, otherwise error information.
IAM.Vendor.email	String	The employee’s email address.
IAM.Vendor.errorCode	Number	HTTP error response code.
IAM.Vendor.errorMessage	String	Reason why the API failed.
IAM.Vendor.id	String	The employee’s user ID in the app.
IAM.Vendor.instanceName	string	Name of the integration instance.
IAM.Vendor.success	Boolean	If true, the command was executed successfully, otherwise false.
IAM.Vendor.username	String	The employee’s username in the app.

Command Example

!iam-create-user user-profile=`{"email":"testdemisto2@paloaltonetworks.com", "givenname":"Test","surname":"Demisto”,”timezonesidkey": "Asia/Tokyo",“localesidkey": "en_US",“profileid": “012345678912345”}`

Human Readable Output

brand	instanceName	success	active	id	email	details
Salesforce IAM	Salesforce IAM_instance_1	true	true	edab746f1b142410042611b4bd4bcb23	testdemisto2@paloaltonetworks.com

iam-update-user

Updates an existing user with the data passed in the user-profile argument.

Base Command

iam-update-user

Input

Argument Name	Description	Required
user-profile	A User Profile indicator.	Required
allow-enable	When set to true, after the command execution the status of the user in the 3rd-party integration will be active. Possible values are: true, false. Default is true.	Optional

Context Output

Path	Type	Description
IAM.Vendor.active	Boolean	If true the employee’s status is active, otherwise false.
IAM.Vendor.brand	String	Name of the integration.
IAM.Vendor.details	string	Gives the user information if the API was successful, otherwise error information.
IAM.Vendor.email	String	The employee’s email address.
IAM.Vendor.errorCode	Number	HTTP error response code.
IAM.Vendor.errorMessage	String	Reason why the API failed.
IAM.Vendor.id	String	The employee’s user ID in the app.
IAM.Vendor.instanceName	string	Name of the integration instance.
IAM.Vendor.success	Boolean	If true, the command was executed successfully, otherwise false.
IAM.Vendor.username	String	The employee’s username in the app.

Command Example

!iam-update-user user-profile=`{"email":"testdemisto2@paloaltonetworks.com", "givenname":"Test","surname":"Demisto_updated"}`

Human Readable Output

brand	instanceName	success	active	id	email	details
Salesforce IAM	Salesforce IAM_instance_1	true	true	edab746f1b142410042611b4bd4bcb23	testdemisto2@paloaltonetworks.com

iam-get-user

Retrieves a single user resource.

Base Command

iam-get-user

Input

Argument Name	Description	Required
user-profile	A User Profile indicator.	Required

Context Output

Path	Type	Description
IAM.Vendor.active	Boolean	If true the employee’s status is active, otherwise false.
IAM.Vendor.brand	String	Name of the integration.
IAM.Vendor.details	string	Gives the user information if the API was successful, otherwise error information.
IAM.Vendor.email	String	The employee’s email address.
IAM.Vendor.errorCode	Number	HTTP error response code.
IAM.Vendor.errorMessage	String	Reason why the API failed.
IAM.Vendor.id	String	The employee’s user ID in the app.
IAM.Vendor.instanceName	string	Name of the integration instance.
IAM.Vendor.success	Boolean	If true, the command was executed successfully, otherwise false.
IAM.Vendor.username	String	The employee’s username in the app.

Command Example

!iam-get-user user-profile=`{"email":"testdemisto2@paloaltonetworks.com"}`

Human Readable Output

brand	instanceName	success	active	id	email	details
Salesforce IAM	Salesforce IAM_instance_1	true	true	edab746f1b142410042611b4bd4bcb23	testdemisto2@paloaltonetworks.com	“AboutMe”: null, “AccountId”: null, “Address”: null, “Alias”: “testdemi”, “BadgeText”: “”, “BannerPhotoUrl”: “/profilephoto/”, “CallCenterId”: null, “City”: null, “CommunityNickname”: “User1”, “CompanyName”: null, “ContactId”: null, “Country”: null, “CreatedById”: “123”, “CreatedDate”: “2020-12-29T09:07:00.000+0000”, “DefaultGroupNotificationFrequency”: “N”, “DelegatedApproverId”: null, “Department”: null, “DigestFrequency”: “D”, “Division”: null, “Email”: “testdemisto2@paloaltonetworks.com”, “EmailEncodingKey”: “ISO-8859-1”, “EmailPreferencesAutoBcc”: true, “EmailPreferencesAutoBccStayInTouch”: false, “EmailPreferencesStayInTouchReminder”: true, “EmployeeNumber”: null, “Extension”: null, “Fax”: null, “FederationIdentifier”: null, “FirstName”: “test”, “ForecastEnabled”: false, “FullPhotoUrl”: “https://profilephoto/”, “GeocodeAccuracy”: null, “Id”: “123”, “IndividualId”: null, “IsActive”: true, “IsExtIndicatorVisible”: false, “IsProfilePhotoActive”: false, “JigsawImportLimitOverride”: null, “LanguageLocaleKey”: “en_US”, “LastLoginDate”: null, “LastModifiedById”: “0054K000001WwcuQAC”, “LastModifiedDate”: “2021-01-03T13:53:24.000+0000”,”LastName”: “test2”, “LastPasswordChangeDate”: null, “LastReferencedDate”: “2021-01-03T14:14:00.000+0000”, “LastViewedDate”: “2021-01-03T14:14:00.000+0000”, “Latitude”: null, “LocaleSidKey”: “en_US”, “Longitude”: null, “ManagerId”: null, “MediumBannerPhotoUrl”: “/profilephoto/”, “MediumPhotoUrl”: “https:/profilephoto/”, “MobilePhone”: null, “Name”: “test”, “OfflinePdaTrialExpirationDate”: null, “OfflineTrialExpirationDate”: null, “OutOfOfficeMessage”: “”, “Phone”: null, “PostalCode”: null, “ProfileId”: “012345678912345”, “ReceivesAdminInfoEmails”: false, “ReceivesInfoEmails”: false, “SenderEmail”: null, “SenderName”: null, “Signature”: null, “SmallBannerPhotoUrl”: “/profilephoto/”, “SmallPhotoUrl”: “profilephoto”, “State”: null, “StayInTouchNote”: null, “StayInTouchSignature”: null, “StayInTouchSubject”: null, “Street”: null, “SystemModstamp”: “2021-01-03T13:53:24.000+0000”, “TimeZoneSidKey”: “Asia/Tokyo”, “Title”: null, “UserPermissionsCallCenterAutoLogin”: false, “UserPermissionsInteractionUser”: false, “UserPermissionsJigsawProspectingUser”: false, “UserPermissionsKnowledgeUser”: false, “UserPermissionsMarketingUser”: false, “UserPermissionsMobileUser”: false, “UserPermissionsOfflineUser”: false, “UserPermissionsSFContentUser”: true, “UserPermissionsSiteforceContributorUser”: false, “UserPermissionsSiteforcePublisherUser”: false, “UserPermissionsSupportUser”: false, “UserPermissionsWorkDotComUserFeature”: false, “UserPreferencesActivityRemindersPopup”: true, “UserPreferencesApexPagesDeveloperMode”: false, “UserPreferencesCacheDiagnostics”: false, “UserPreferencesContentEmailAsAndWhen”: false, “UserPreferencesContentNoEmail”: false, “UserPreferencesCreateLEXAppsWTShown”: false, “UserPreferencesDisCommentAfterLikeEmail”: false, “UserPreferencesDisMentionsCommentEmail”: false, “UserPreferencesDisProfPostCommentEmail”: false, “UserPreferencesDisableAllFeedsEmail”: false, “UserPreferencesDisableBookmarkEmail”: false, “UserPreferencesDisableChangeCommentEmail”: false, “UserPreferencesDisableEndorsementEmail”: false, “UserPreferencesDisableFeedbackEmail”: false, “UserPreferencesDisableFileShareNotificationsForApi”: false, “UserPreferencesDisableFollowersEmail”: false, “UserPreferencesDisableLaterCommentEmail”: false, “UserPreferencesDisableLikeEmail”: true, “UserPreferencesDisableMentionsPostEmail”: false, “UserPreferencesDisableMessageEmail”: false, “UserPreferencesDisableProfilePostEmail”: false, “UserPreferencesDisableSharePostEmail”: false, “UserPreferencesDisableWorkEmail”: false, “UserPreferencesEnableAutoSubForFeeds”: false, “UserPreferencesEventRemindersCheckboxDefault”: true, “UserPreferencesExcludeMailAppAttachments”: false, “UserPreferencesFavoritesShowTopFavorites”: false, “UserPreferencesFavoritesWTShown”: false, “UserPreferencesGlobalNavBarWTShown”: false, “UserPreferencesGlobalNavGridMenuWTShown”: false, “UserPreferencesHasCelebrationBadge”: false, “UserPreferencesHideBiggerPhotoCallout”: false, “UserPreferencesHideCSNDesktopTask”: false, “UserPreferencesHideCSNGetChatterMobileTask”: false, “UserPreferencesHideChatterOnboardingSplash”: false, “UserPreferencesHideEndUserOnboardingAssistantModal”: false, “UserPreferencesHideLightningMigrationModal”: false, “UserPreferencesHideS1BrowserUI”: false, “UserPreferencesHideSecondChatterOnboardingSplash”: false, “UserPreferencesHideSfxWelcomeMat”: true, “UserPreferencesJigsawListUser”: false, “UserPreferencesLightningExperiencePreferred”: true, “UserPreferencesNewLightningReportRunPageEnabled”: false, “UserPreferencesPathAssistantCollapsed”: false, “UserPreferencesPipelineViewHideHelpPopover”: false, “UserPreferencesPreviewCustomTheme”: false, “UserPreferencesPreviewLightning”: false, “UserPreferencesRecordHomeReservedWTShown”: false, “UserPreferencesRecordHomeSectionCollapseWTShown”: false, “UserPreferencesReminderSoundOff”: false, “UserPreferencesShowCityToExternalUsers”: false, “UserPreferencesShowCityToGuestUsers”: false, “UserPreferencesShowCountryToExternalUsers”: false, “UserPreferencesShowCountryToGuestUsers”: false, “UserPreferencesShowEmailToExternalUsers”: false, “UserPreferencesShowEmailToGuestUsers”: false, “UserPreferencesShowFaxToExternalUsers”: false, “UserPreferencesShowFaxToGuestUsers”: false, “UserPreferencesShowManagerToExternalUsers”: false, “UserPreferencesShowManagerToGuestUsers”: false, “UserPreferencesShowMobilePhoneToExternalUsers”: false, “UserPreferencesShowMobilePhoneToGuestUsers”: false, “UserPreferencesShowPostalCodeToExternalUsers”: false, “UserPreferencesShowPostalCodeToGuestUsers”: false, “UserPreferencesShowProfilePicToGuestUsers”: false, “UserPreferencesShowStateToExternalUsers”: false, “UserPreferencesShowStateToGuestUsers”: false, “UserPreferencesShowStreetAddressToExternalUsers”: false, “UserPreferencesShowStreetAddressToGuestUsers”: false, “UserPreferencesShowTitleToExternalUsers”: true, “UserPreferencesShowTitleToGuestUsers”: false, “UserPreferencesShowWorkPhoneToExternalUsers”: false, “UserPreferencesShowWorkPhoneToGuestUsers”: false, “UserPreferencesSortFeedByComment”: true, “UserPreferencesSuppressEventSFXReminders”: false, “UserPreferencesSuppressTaskSFXReminders”: false, “UserPreferencesTaskRemindersCheckboxDefault”: true, “UserPreferencesUserDebugModePref”: false, “UserRoleId”: null, “UserType”: “Standard”, “Username”: “testdemisto2@paloaltonetworks.com”,

iam-disable-user

Disable an active user.

Base Command

iam-disable-user

Input

Argument Name	Description	Required
user-profile	A User Profile indicator.	Required

Context Output

Path	Type	Description
IAM.Vendor.active	Boolean	If true the employee’s status is active, otherwise false.
IAM.Vendor.brand	String	Name of the integration.
IAM.Vendor.details	string	Gives the user information if the API was successful, otherwise error information.
IAM.Vendor.email	String	The employee’s email address.
IAM.Vendor.errorCode	Number	HTTP error response code.
IAM.Vendor.errorMessage	String	Reason why the API failed.
IAM.Vendor.id	String	The employee’s user ID in the app.
IAM.Vendor.instanceName	string	Name of the integration instance.
IAM.Vendor.success	Boolean	If true, the command was executed successfully, otherwise false.
IAM.Vendor.username	String	The employee’s username in the app.

Command Example

!iam-disable-user user-profile=`{"email":"testdemisto2@paloaltonetworks.com"}`

Human Readable Output

brand	instanceName	success	active	id	email	details
Salesforce IAM	Salesforce IAM_instance_1	true	false	edab746f1b142410042611b4bd4bcb23	testdemisto2@paloaltonetworks.com

get-mapping-fields

Retrieves a User Profile schema which holds all of the user fields within the application. Used for outgoing-mapping through the Get Schema option.

Base Command

get-mapping-fields

Input

There are no input arguments for this command.

Context Output

There is no context output for this command.

Configuration parameters

url — Salesforce url (Eg: https://<domain>.salesforce.com/) (required)
credentials — User name (required)
consumer_key — Consumer Key
consumer_secret — Consumer Secret
credentials_consumer — Consumer Key
insecure — Trust any certificate (not secure)
proxy — Use system proxy settings
create_user_enabled — Allow creating users
update_user_enabled — Allow updating users
enable_user_enabled — Allow enabling users
disable_user_enabled — Allow disabling users
create_if_not_exists — Automatically create user if not found in update and enable commands
mapper_in — Incoming Mapper (required)
mapper_out — Outgoing Mapper
localesidkey — Default Local Sid Key (required)
emailencodingkey — Default Email Encoding Key (required)
languagelocalekey — Default Language Locale Key (required)

Commands (5)

get-mapping-fields
Retrieves a User Profile schema which holds all of the user fields within the application. Used for outgoing-mapping through the Get Schema option.
iam-create-user
Creates a user.
iam-disable-user
Disable an active user.
iam-get-user
Retrieves a single user resource.
iam-update-user
Updates an existing user with the data passed in the user-profile argument.

Source

Salesforce_IAM.py Salesforce_IAM_test.py Salesforce_IAM.yml Salesforce_IAM_description.md

Download History Raw

## Prerequisites
To set up Salesforce to work with Cortex XSOAR:
Add a new connected App in salesforce by following the instruction [here](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_defining_remote_access_applications.htm)
If you already have a connected App, go to “Setup” -> “App Manager” -> choose the correct App from the list and press “View”.
The Consumer Key / Secret is under “API (Enable OAuth Settings)”
For detailed instructions see the Credentials walkthrough section at [xsoar.pan.dev](https://xsoar.pan.dev/docs/reference/integrations/salesforce).

## Enable/Disable CRUD Commands
You can select which CRUD commands are enabled in the integration instance configuration settings. By default, all commands are enabled.

## Required Fields in Create User Command
When creating a user in Salesforce there are mandatory fields that need to be set. Some of them are set with default values in the integration parameters:
**Default Local Sid Key**, **Default Email Encoding Key** and **Default Language Locale Key**.
**ProfileId** and **Timezone Sid Key** are also required, but are filled using the Salesforce mapper in the following manner:
Duplicate the **GenerateProfileId** and the **GenerateTimeZone** automations, edit them according to your needs, and use them as transformers in the **User Profile - Salesforce (Outgoing)** mapper under the **ProfileId** and **TimeZoneSidKey** fields respectively.
This configuration ensures that the user being created is created with the right permissions and settings in Salesforce.

## Add Custom Indicator Fields
Follow these steps to add custom fields to the User Profile indicator.

1. In XSOAR, create the custom indicator and incident field, for example, **Middle Name**.
2. Duplicate the **User Profile - Salesforce (Incoming)** mapper and/or the **User Profile - Salesforce (Outging)** mapper.
3. Add and map the custom field to the necessary mapper(s).
4. Go to the Salesforce IAM integration instance and in the mapper textbox, replace the name of the default mapper with the custom mapper you created.
For more information, please refer to the [Identity Lifecycle Management article](https://xsoar.pan.dev/docs/reference/articles/identity-lifecycle-management).

## Automatically create user if not found in update command
The *create-if-not-exists* parameter specifies if a new user should be created when the User Profile passed was not found in the 3rd-party integration.