afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/UserProvisioningConfig.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "UserProvisioningConfig - Data API",
  "description": "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.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "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. This is a relationship field.",
      "relationship_name": "ConnectedApp",
      "relationship_type": "Lookup",
      "refers_to": "ConnectedApplication"
    },
    "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. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
    },
    "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 primary 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. This is a relationship field.",
      "relationship_name": "NamedCredential",
      "relationship_type": "Lookup",
      "refers_to": "NamedCredential"
    },
    "NamespacePrefix": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The namespace prefix that is associated with this object. Each Developer Edition org 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 orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless 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 org of the package developer. In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix."
    },
    "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\"}"
    }
  },
  "wsdl_segment": "```xml\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<complexType name=\"UserProvisioningConfig\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"ApprovalRequired\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ConnectedApp\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ConnectedApplication\"/>\n        <element name=\"ConnectedAppId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"DeveloperName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Enabled\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"EnabledOperations\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"Language\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastReconDateTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"MasterLabel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"NamedCredential\" nillable=\"true\" minOccurs=\"0\" type=\"ens:NamedCredential\"/>\n        <element name=\"NamedCredentialId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"NamespacePrefix\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Notes\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"OnUpdateAttributes\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ReconFilter\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"UserAccountMapping\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n```",
  "field_reference": {
    "ApprovalRequired": {
      "field_label": "Approval Required",
      "type": "textarea",
      "length": "4000"
    },
    "ConnectedAppId": {
      "field_label": "Connected App ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "DeveloperName": {
      "field_label": "Name",
      "type": "string",
      "length": "80"
    },
    "Enabled": {
      "field_label": "Enabled",
      "type": "boolean"
    },
    "EnabledOperations": {
      "field_label": "Enabled Operations",
      "type": "textarea",
      "length": "4000"
    },
    "Id": {
      "field_label": "User Provisioning Configuration ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "Language": {
      "field_label": "Master Language",
      "type": "picklist",
      "length": "40"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReconDateTime": {
      "field_label": "Last Recon Date",
      "type": "datetime"
    },
    "MasterLabel": {
      "field_label": "Label",
      "type": "string",
      "length": "80"
    },
    "NamedCredentialId": {
      "field_label": "Named Credential ID",
      "type": "reference",
      "length": "18"
    },
    "NamespacePrefix": {
      "field_label": "Namespace Prefix",
      "type": "string",
      "length": "15"
    },
    "Notes": {
      "field_label": "Notes",
      "type": "textarea",
      "length": "65536"
    },
    "OnUpdateAttributes": {
      "field_label": "On Update Attributes",
      "type": "textarea",
      "length": "4000"
    },
    "ReconFilter": {
      "field_label": "Recon Filter",
      "type": "string",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "UserAccountMapping": {
      "field_label": "User Account Mapping",
      "type": "textarea",
      "length": "4000"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}