Provisioning List Entitlement Schema Property Values
Schema contract for an Integration Builder action that returns the values of a SCIM server's entitlement schema properties, used to configure Entitlement Management. This differs from the user schema property values by scoping the returned values 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 |
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 |
|---|---|---|
|
schemaPropertyValues |
||
|
id |
Identifier of the schema property value. |
Text |
|
displayName |
Display name of the schema property value. |
Text |
|
schemaPropertyName |
Name of the schema property associated with this value. |
Text |
|
typeName |
Name of the entitlement type associated with this value. |
Text |
|
description |
Description of the schema property value. |
Text |
|
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:
|
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:
|
Text |