---
schema_version: "1"
id: 58928c438acb3d4575acd08502b8f76cae0d81e6307556008f942e04524c563a
title: UserProvisioningConfig
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_userprovisioningconfig.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_userprovisioningconfig.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: df14c5757aaa54595e81b5625bad7f8648836cb9a9e4fb4f21fdb431dba0972a
description: Represents information to use during a user provisioning request flow, such as the attributes for an update. This type extends the Metadata metadata type and inherits its fullName field.
---
# UserProvisioningConfig

Represents information to use during a user provisioning request flow, such as the attributes for an update. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

## File Suffix and Directory Location

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

## Version

UserProvisioningConfig components are available in API version 49.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d947373e92">Field Name</th>

              <th class="featureTableHeader  " id="d947373e95">Field Type</th>

              <th class="featureTableHeader  " id="d947373e98">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">approvalRequired</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">Indicates whether approvals are required for provisioning users for the
                associated connected app. If the value is null, no approval is required.</td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">connectedApp</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">The ID of the connected app for which users are being provisioned.</td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">enabled</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">boolean</td>

              <td class="entry" headers="d947373e98" data-title="Description">Indicates whether user provisioning is enabled for the associated connected app
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Default setting is <samp class="codeph nolang">false</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">enabledOperations</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">Lists the operations, as comma-separated values, that create a user
                provisioning request for the associated connected app. Allowed values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Create</samp>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Update</samp>
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">EnableAndDisable</samp> (activation and
                    deactivation)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SuspendAndRestore</samp> (freeze and
                    unfreeze)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">flow</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">User Provisioning flow type which includes a reference to the Apex
                <span class="keyword parmname">UserProvisioningPlugin</span> class. The flow calls the third-party
                service’s API to manage user account provisioning on that system.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">The primary label for this object. This value is the internal label that
                doesn’t get translated.</td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">namedCredential</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="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.</td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">notes</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="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.</td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">onUpdateAttributes</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">Lists the user attributes, as comma-separated values, that generate a user
                provisioning request during an update.</td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">reconFilter</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">When collecting and analyzing users on a third-party system, the plug-in uses
                this filter to limit the scope of the collection.</td>

            </tr>

            <tr>
              <td class="entry" headers="d947373e92" data-title="Field Name"><span class="keyword parmname">userAccountMapping</span></td>

              <td class="entry" headers="d947373e95" data-title="Field Type">string</td>

              <td class="entry" headers="d947373e98" data-title="Description">Stores the attributes used to link the Salesforce user to the account on the
                third-party system, in JSON format. For example:
                <div class="codeSection nolang">
                  <pre class="codeblock nolang">{"linkingSalesforceUserAttribute":"Username", 
"linkingTargetUserAttribute":"Email"}</pre>
                </div>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a UserProvisioningConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<UserProvisioningConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <approvalRequired\>True</approvalRequired\>
    <enabled\>true</enabled\>
    <enabledOperations\>NA</enabledOperations\>
    <connectedApp\>ExampleApp</connectedApp\>
    <masterLabel\>label</masterLabel\>
    <notes\>note</notes\>
    <onUpdateAttributes\>attri</onUpdateAttributes\>
    <reconFilter\>filter</reconFilter\>
    <userAccountMapping\>mapping</userAccountMapping\>
</UserProvisioningConfig\>

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

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>UPC</members\>
        <name\>UserProvisioningConfig</name\>
    </types\>
    <version\>49.0</version\>
</Package\>

## Wildcard Support in the Manifest File

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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).