UserProvisioningConfig

Represents information to use during a user provisioning request flow, such as the attributes for an update.

This type extends Metadata and inherits its fields.

UserProvisioningConfig components have the suffix .userProvisioningConfig and are stored in the UserProvisioningConfigs directory.

Introduced in API version 49.0.

• Type: string
• Required: No
• Description: Indicates whether approvals are required for provisioning users for the associated connected app. If the value is null, no approval is required.

• Type: string
• Required: Yes
• Description: The ID of the connected app for which users are being provisioned.

• Type: boolean
• Required: No
• Description: Indicates whether user provisioning is enabled for the associated connected app (true) or not (false). Default setting is false.

• Type: string (enumeration of type string)
• Required: No
• Description: Lists the operations, as comma-separated values, that create a user provisioning request for the associated connected app. Allowed values are:
• Possible values:
  • Create
  • Update
  • EnableAndDisable — (activation and deactivation)
  • SuspendAndRestore — (freeze and unfreeze)

• Type: string
• Required: No
• Description: User Provisioning flow type which includes a reference to the Apex UserProvisioningPlugin class. The flow calls the third-party service’s API to manage user account provisioning on that system.

• Type: string
• Required: Yes
• Description: The primary label for this object. This value is the internal label that doesn’t get translated.

• Type: string
• Required: No
• Description: The Salesforce ID of the named credential that’s used for a request. The named credential identifies the third-party system and the third-party authentication settings.

• Type: string
• Required: No
• Description: Serves as a place for admins to add any additional information about the configuration. This field is for internal reference only, and is not used by any process.

• Type: string
• Required: No
• Description: Lists the user attributes, as comma-separated values, that generate a user provisioning request during an update.

• Type: string
• Required: No
• Description: When collecting and analyzing users on a third-party system, the plug-in uses this filter to limit the scope of the collection.

• Type: string

• Required: No

• Description: Stores the attributes used to link the Salesforce user to the account on the third-party system, in JSON format. For example:

  1{"linkingSalesforceUserAttribute":"Username", 
  2"linkingTargetUserAttribute":"Email"}

The following is an example of a UserProvisioningConfig component.

1<?xml version="1.0" encoding="UTF-8"?>
2<UserProvisioningConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3    <approvalRequired>True</approvalRequired>
4    <enabled>true</enabled>
5    <enabledOperations>NA</enabledOperations>
6    <connectedApp>ExampleApp</connectedApp>
7    <masterLabel>label</masterLabel>
8    <notes>note</notes>
9    <onUpdateAttributes>attri</onUpdateAttributes>
10    <reconFilter>filter</reconFilter>
11    <userAccountMapping>mapping</userAccountMapping>
12</UserProvisioningConfig>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>UPC</members>
5        <name>UserProvisioningConfig</name>
6    </types>
7    <version>49.0</version>
8</Package>

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.