Provisioning Update User

Schema contract for an Integration Builder action that updates a user account in an external system.

Input

Field	Definition	Type	Required
user	A SCIM user object for provisioning operations.	Object	FALSE
schemas	List of schemas for the user object.	List of Text	TRUE
id	The ID of the user.	Text	TRUE
externalId	External ID of the user, defined by the provisioning client.	Text	FALSE
userName	The unique identifier for the user, used for authentication. This must be unique across all users.	Text	TRUE
name
formatted	The full name, formatted for display.	Text	FALSE
familyName	The family name of the user.	Text	FALSE
givenName	The given name of the user.	Text	FALSE
middleName	The middle name of the user.	Text	FALSE
honorificPrefix	The honorific prefix or title of the user.	Text	FALSE
honorificSuffix	The honorific suffix of the user.	Text	FALSE
displayName	The name of the user, suitable for display to end users.	Text	FALSE
nickName	The casual way to address the user in real life.	Text	FALSE
profileUrl	A fully qualified URL pointing to a page representing the user's online profile.	Text	FALSE
title	The user's title, such as Vice President.	Text	FALSE
userType	Identifies the relationship between the organization and the user.	Text	FALSE
preferredLanguage	Indicates the user's preferred written or spoken language.	Text	FALSE
locale	Indicates the user's default location for localization purposes.	Text	FALSE
timezone	The user's time zone, in Olson database format. For example, America/Los_Angeles.	Text	FALSE
active	Indicates the user's administrative status.	True/False	FALSE
password	The user's cleartext password, used for initial set or reset.	Text	FALSE
emails	Email addresses for the user.	List of Objects	FALSE
phoneNumbers	Phone numbers for the user.	List of Objects	FALSE
ims	Instant messaging addresses for the user.	List of Objects	FALSE
photos	URLs of photos of the user.	List of Objects	FALSE
addresses	Physical mailing addresses for the user.	List of Objects	FALSE
groups	The list of groups the user belongs to.	List of Objects	FALSE
entitlements	Entitlements assigned to the user.	List of Objects	FALSE
roles	Roles assigned to the user.	List of Objects	FALSE
x509Certificates	X.509 certificates associated with the user.	List of Objects	FALSE
enterprise
employeeNumber	A string identifier assigned to a person by the organization.	Text	FALSE
costCenter	Name of the cost center.	Text	FALSE
organization	Name of the organization.	Text	FALSE
division	Name of the division.	Text	FALSE
department	Name of the department.	Text	FALSE
manager
id	ID of the SCIM resource representing the user's manager.	Text	FALSE
displayName	Display name of the user's manager.	Text	FALSE

Output

Field	Definition	Type
user	A SCIM user object for provisioning operations.	Object
schemas	List of schemas for the user object.	List of Text
id	The ID of the user.	Text
externalId	External ID of the user, defined by the provisioning client.	Text
userName	The unique identifier for the user, used for authentication. This must be unique across all users.	Text
name
formatted	The full name, formatted for display.	Text
familyName	The family name of the user.	Text
givenName	The given name of the user.	Text
middleName	The middle name of the user.	Text
honorificPrefix	The honorific prefix or title of the user.	Text
honorificSuffix	The honorific suffix of the user.	Text
displayName	The name of the user, suitable for display to end users.	Text
nickName	The casual way to address the user in real life.	Text
profileUrl	A fully qualified URL pointing to a page representing the user's online profile.	Text
title	The user's title, such as Vice President.	Text
userType	Identifies the relationship between the organization and the user.	Text
preferredLanguage	Indicates the user's preferred written or spoken language.	Text
locale	Indicates the user's default location for localization purposes.	Text
timezone	The user's time zone, in Olson database format. For example, America/Los_Angeles.	Text
active	Indicates the user's administrative status.	True/False
emails	Email addresses for the user.	List of Objects
phoneNumbers	Phone numbers for the user.	List of Objects
ims	Instant messaging addresses for the user.	List of Objects
photos	URLs of photos of the user.	List of Objects
addresses	Physical mailing addresses for the user.	List of Objects
groups	The list of groups the user belongs to.	List of Objects
entitlements	Entitlements assigned to the user.	List of Objects
roles	Roles assigned to the user.	List of Objects
x509Certificates	X.509 certificates associated with the user.	List of Objects
enterprise
employeeNumber	A string identifier assigned to a person by the organization.	Text
costCenter	Name of the cost center.	Text
organization	Name of the organization.	Text
division	Name of the division.	Text
department	Name of the department.	Text
manager
id	ID of the SCIM resource representing the user's manager.	Text
displayName	Display name of the user's manager.	Text
executionStatus
status	Indicates whether the action succeeded. One of the following values: `SUCCEEDED` `FAILED`	Text
errors	List of errors returned when the action fails or partially fails.	List of Objects
errors
code	Identifier for the error.	Text
summary	Human-readable summary of the error.	Text
details	Additional details about the error.	List of Text
httpStatusCode	HTTP status code associated with the error.	Number
requestId	Identifier of the request associated with the error.	Text
type	Category of the error. One of the following values: `RESOURCE_NOT_FOUND` `RATE_LIMIT_EXCEEDED` `INVALID_CREDENTIALS` `TOKEN_EXPIRED` `GENERIC_FAILURE`	Text