Salesforce IAM
Integrate with Salesforce's services to perform Identity Lifecycle Management operations.
Identity and Access Management · Salesforce
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 | 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 | 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 | 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 | 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 Keyconsumer_secret— Consumer Secretcredentials_consumer— Consumer Keyinsecure— Trust any certificate (not secure)proxy— Use system proxy settingscreate_user_enabled— Allow creating usersupdate_user_enabled— Allow updating usersenable_user_enabled— Allow enabling usersdisable_user_enabled— Allow disabling userscreate_if_not_exists— Automatically create user if not found in update and enable commandsmapper_in— Incoming Mapper (required)mapper_out— Outgoing Mapperlocalesidkey— Default Local Sid Key (required)emailencodingkey— Default Email Encoding Key (required)languagelocalekey— Default Language Locale Key (required)
Commands (5)
-
get-mapping-fieldsRetrieves 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-userCreates a user.
-
iam-disable-userDisable an active user.
-
iam-get-userRetrieves a single user resource.
-
iam-update-userUpdates an existing user with the data passed in the user-profile argument.
category: Identity and Access Management provider: Salesforce sectionorder: - Connect - Collect commonfields: id: Salesforce IAM version: -1 configuration: - display: 'Salesforce url (Eg: https://<domain>.salesforce.com/)' name: url required: true type: 0 section: Connect - display: User name name: credentials required: true type: 9 section: Connect - display: Consumer Key name: consumer_key type: 4 hidden: true required: false section: Connect - display: Consumer Secret name: consumer_secret type: 4 hidden: true required: false section: Connect - display: Consumer Key name: credentials_consumer type: 9 displaypassword: Consumer Secret section: Connect required: false - display: Trust any certificate (not secure) name: insecure type: 8 required: false section: Connect - display: Use system proxy settings name: proxy type: 8 required: false section: Connect - defaultvalue: 'true' display: Allow creating users name: create_user_enabled type: 8 required: false section: Collect - defaultvalue: 'true' display: Allow updating users name: update_user_enabled type: 8 required: false section: Collect - defaultvalue: 'true' display: Allow enabling users name: enable_user_enabled type: 8 required: false section: Collect - defaultvalue: 'true' display: Allow disabling users name: disable_user_enabled type: 8 required: false section: Collect - defaultvalue: 'true' display: Automatically create user if not found in update and enable commands name: create_if_not_exists type: 8 required: false section: Collect - defaultvalue: User Profile - Salesforce (Incoming) display: Incoming Mapper name: mapper_in required: true type: 0 section: Collect - defaultvalue: User Profile - Salesforce (Outgoing) display: Outgoing Mapper name: mapper_out required: false type: 0 section: Collect additionalinfo: Cortex XSOAR only parameter. hidden: - marketplacev2 - platform - additionalinfo: Used when creating a new user. defaultvalue: en_US display: Default Local Sid Key name: localesidkey required: true type: 0 section: Collect - additionalinfo: Used when creating a new user. defaultvalue: ISO-8859-1 display: Default Email Encoding Key name: emailencodingkey required: true section: Collect type: 0 - additionalinfo: Used when creating a new user. defaultvalue: en_US display: Default Language Locale Key name: languagelocalekey required: true type: 0 section: Collect description: Integrate with Salesforce's services to perform Identity Lifecycle Management operations. display: Salesforce IAM name: Salesforce IAM script: commands: - arguments: - description: User Profile indicator details. name: user-profile required: true - auto: PREDEFINED defaultValue: 'true' description: When set to true, after the command execution the status of the user in the 3rd-party integration will be active. name: allow-enable predefined: - 'true' - 'false' description: Creates a user. execution: true name: iam-create-user outputs: - contextPath: IAM.Vendor.active description: If true the employee's status is active, otherwise false. type: Boolean - contextPath: IAM.Vendor.brand description: Name of the integration. type: String - contextPath: IAM.Vendor.details description: Gives the user information if the API was successful, otherwise error information. type: string - contextPath: IAM.Vendor.email description: The employee's email address. type: String - contextPath: IAM.Vendor.errorCode description: HTTP error response code. type: Number - contextPath: IAM.Vendor.errorMessage description: Reason why the API failed. type: String - contextPath: IAM.Vendor.id description: The employee's user ID in the app. type: String - contextPath: IAM.Vendor.instanceName description: Name of the integration instance. type: string - contextPath: IAM.Vendor.success description: If true, the command was executed successfully, otherwise false. type: Boolean - contextPath: IAM.Vendor.username description: The employee's username in the app. type: String - arguments: - description: A User Profile indicator. name: user-profile required: true - auto: PREDEFINED defaultValue: 'true' description: When set to true, after the command execution the status of the user in the 3rd-party integration will be active. name: allow-enable predefined: - 'true' - 'false' description: Updates an existing user with the data passed in the user-profile argument. execution: true name: iam-update-user outputs: - contextPath: IAM.Vendor.active description: If true the employee's status is active, otherwise false. type: Boolean - contextPath: IAM.Vendor.brand description: Name of the integration. type: String - contextPath: IAM.Vendor.details description: Gives the user information if the API was successful, otherwise error information. type: string - contextPath: IAM.Vendor.email description: The employee's email address. type: String - contextPath: IAM.Vendor.errorCode description: HTTP error response code. type: Number - contextPath: IAM.Vendor.errorMessage description: Reason why the API failed. type: String - contextPath: IAM.Vendor.id description: The employee's user ID in the app. type: String - contextPath: IAM.Vendor.instanceName description: Name of the integration instance. type: string - contextPath: IAM.Vendor.success description: If true, the command was executed successfully, otherwise false. type: Boolean - contextPath: IAM.Vendor.username description: The employee's username in the app. type: String compliantpolicies: - User Hard Remediation - arguments: - description: A User Profile indicator. name: user-profile required: true description: Retrieves a single user resource. name: iam-get-user outputs: - contextPath: IAM.Vendor.active description: If true the employee's status is active, otherwise false. type: Boolean - contextPath: IAM.Vendor.brand description: Name of the integration. type: String - contextPath: IAM.Vendor.details description: Gives the user information if the API was successful, otherwise error information. type: string - contextPath: IAM.Vendor.email description: The employee's email address. type: String - contextPath: IAM.Vendor.errorCode description: HTTP error response code. type: Number - contextPath: IAM.Vendor.errorMessage description: Reason why the API failed. type: String - contextPath: IAM.Vendor.id description: The employee's user ID in the app. type: String - contextPath: IAM.Vendor.instanceName description: Name of the integration instance. type: string - contextPath: IAM.Vendor.success description: If true, the command was executed successfully, otherwise false. type: Boolean - contextPath: IAM.Vendor.username description: The employee's username in the app. type: String - arguments: - description: A User Profile indicator. name: user-profile required: true description: Disable an active user. execution: true name: iam-disable-user outputs: - contextPath: IAM.Vendor.active description: If true the employee's status is active, otherwise false. type: Boolean - contextPath: IAM.Vendor.brand description: Name of the integration. type: String - contextPath: IAM.Vendor.details description: Gives the user information if the API was successful, otherwise error information. type: string - contextPath: IAM.Vendor.email description: The employee's email address. type: String - contextPath: IAM.Vendor.errorCode description: HTTP error response code. type: Number - contextPath: IAM.Vendor.errorMessage description: Reason why the API failed. type: String - contextPath: IAM.Vendor.id description: The employee's user ID in the app. type: String - contextPath: IAM.Vendor.instanceName description: Name of the integration instance. type: string - contextPath: IAM.Vendor.success description: If true, the command was executed successfully, otherwise false. type: Boolean - contextPath: IAM.Vendor.username description: The employee's username in the app. type: String compliantpolicies: - User Hard Remediation - description: Retrieves a User Profile schema which holds all of the user fields within the application. Used for outgoing-mapping through the Get Schema option. name: get-mapping-fields dockerimage: demisto/python3:3.12.13.10116658 runonce: false script: '-' subtype: python3 type: python ismappable: true isremotesyncout: true tests: - No tests fromversion: 6.0.0