Provisioning List Entitlement Schema

Schema contract for an Integration Builder action that returns the SCIM server's entitlement schema properties, used to configure Entitlement Management. This differs from the user schema by scoping the returned properties to entitlement types rather than user attributes.

Input

Field	Definition	Type	Required
scim
baseUri	The base URL of the SCIM server.	Text	TRUE
authMode	Authentication mode of the SCIM server. One of `header`, `bearer`, or `oauth`.	Text	TRUE
entitlementTypes	List of entitlement types supported by the SCIM server.	List of Objects	TRUE
entitlementTypes
name	Name of the entitlement type.	Text	TRUE
endpoint	The resource type's HTTP-addressable endpoint, relative to the base URL.	Text	TRUE
description	The resource type's human-readable description.	Text	FALSE
attributes	Attributes of the entitlement type.	Object	FALSE
attributes
required	If true, the entitlement attribute is required.	True/False	FALSE
multiValued	If true, the entitlement attribute can have multiple values.	True/False	FALSE
mappings	Schema mappings for the entitlement type.	Object	TRUE
mappings
idField	Name of the field that contains the unique identifier for the entitlement.	Text	TRUE
displayNameField	Name of the field that contains the display name for the entitlement.	Text	TRUE
descriptionField	Name of the field that contains the description of the entitlement.	Text	FALSE
pagination
cursor	Cursor used to retrieve the next page of results.	Text	FALSE
limit	Maximum number of results to return in the response.	Number	FALSE

Output

Field	Definition	Type
schemaProperties
name	Name of the schema property.	Text
title	Display title of the schema property.	Text
externalName	External name of the schema property.	Text
externalNamespace	External namespace of the schema property.	Text
description	Description of the schema property.	Text
required	If true, the schema property is required.	True/False
propertyType	Data type of the schema property. One of `STRING`, `NUMBER`, `INTEGER`, `BOOLEAN`, `DATE`, `ARRAY`, `URI`, `COUNTRY_CODE`, `TIMEZONE`, `LOCALE`, `LANGUAGE_CODE`, `EMAIL`, or `OBJECT`.	Text
scope	Scope of the schema property. One of `SELF`, `SYSTEM`, or `NONE`.	Text
schemaName	Name of the schema this property belongs to.	Text
defaultValue	Default value for the schema property.	Various
enumConstraint	List of allowed values for the schema property.	List of Text
oneOfConstraint	Map of allowed key and value pairs for the schema property.	Object
enumTitles	Display titles for the allowed enum values.	Object
properties	Nested schema property definitions, present when `propertyType` is `OBJECT`.	List of Objects
minItems	Minimum number of items, for array types.	Number
maxItems	Maximum number of items, for array types.	Number
minLength	Minimum string length.	Number
maxLength	Maximum string length.	Number
pattern	Regular expression pattern constraint.	Text
minimum	Minimum numeric value.	Number
maximum	Maximum numeric value.	Number
minSize	Minimum size constraint.	Number
maxSize	Maximum size constraint.	Number
beforeDate	Upper bound date constraint.	Date & Time
afterDate	Lower bound date constraint.	Date & Time
pagination
nextCursor	Cursor for retrieving the next page of results. This field is omitted when there are no more results.	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