UserProvisioningConfig

Represents information for a flow to use during a user provisioning request process, such as the attributes for an update. This object is available in API version 34.0 and later.

Supported Calls

describeSObjects()query()retrieve()

Fields

Field Name Details
ApprovalRequired
Type
textarea
Properties
Create, Nillable, Update
Description

Denotes whether approvals are required for provisioning users for the associated connected app. If the value is null, no approval is required.

ConnectedAppId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description

The 18-digit application ID for the connected app.

DeveloperName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package, and the changes are reflected in a subscriber’s organization.
Enabled
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description

Indicates whether user provisioning is enabled for the associated connected app (true) or not (false).

EnabledOperations
Type
textarea
Properties
Create, Nillable, Update
Description

Lists the operations, as comma-separated values, that create a UserProvisioningRequest object for the associated connected app. Allowed values are:

  • Create
  • Update
  • EnableAndDisable (activation and deactivation)
  • SuspendAndRestore (freeze and unfreeze)
Language
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description

The two- to five-character code that represents the language and locale ISO. This code controls the language for labels displayed in an application.

LastReconDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description

The date and time when user accounts were last reconciled between Salesforce and the target system.

MasterLabel
Type
string
Properties
Create, Filter, Group, Sort, Update
Description

The master label for this object. This value is the internal label that doesn’t get translated.

NamedCredentialId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
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.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values:

  • In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer.
  • In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.
Notes
Type
textarea
Properties
Create, Nillable, Update
Description

A utility field for administrators to add any additional information about the configuration. This field is for internal reference only, and is not used by any process.

OnUpdateAttributes
Type
textarea
Properties
Create, Nillable, Update
Description

Lists the user attributes, as comma-separated values, that generate a UserProvisioningRequest object during an update.

ReconFilter
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
When collecting and analyzing users on a third-party system, the plug-in uses this filter to limit the scope of the collection.
UserAccountMapping
Type
textarea
Properties
Create, Nillable, Update
Description

Stores the attributes used to link the Salesforce user to the account on the third-party system, in JSON format.

For example:

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