Contracts

SCIM Request User Group Patch Contract

The following attributes are contained within the scimRequestUserGroupPatch object.

Attribute	Description
schemas	Schemas for userGroups. Example: urn:ietf:params:scim:api:messages:2.0:PatchOp. Required.
operations array operationsGroups contract	Members of userGroups. Required.

The following attributes are contained within the operationsGroups object.

Attribute	Description
op string	The operation value. Possible values: add\|replace\|remove. - Add - Use this operation to add a new value for the attribute. - Replace - Use this operation to replace existing value of an attribute. - Remove - Delete the existing value for the attribute specified in the path.
path string	Path is required for remove op. Optional for add and replace ops. Example: "path" : "urn:ietf:params:scim:schemas:extension:ice:2.0:EncompassGroup:members[value eq "userName" and type eq "User"]"
value object	Refer to the urn:ietf:params:scim:schemas:extension:ice:2.0:EncompassGroup schema for the list of supported attributes. Required for add and replace operations, not applicable to remove.

The following attributes are contained within the scimRequestPost object.

Attribute	Description
schemas	Schemas for user. You can specify either urn:ietf:params:scim:schemas:extension:ice:2.0:EncompassInternalUser or urn:ietf:params:scim:schemas:extension:ice:2.0:AIQUser or both. For the list of supported attributes, refer to the following schemas: urn:ietf:params:scim:schemas:extension:ice:2.0:EncompassInternalUser or urn:ietf:params:scim:schemas:extension:ice:2.0:AIQUser"Required Required.

Attribute

Description

schemas

Schemas for user.
You can specify either urn:ietf:params:scim:schemas:extension:ice:2.0:EncompassInternalUser or urn:ietf:params:scim:schemas:extension:ice:2.0:AIQUser or both. For the list of supported attributes, refer to the following schemas: urn:ietf:params:scim:schemas:extension:ice:2.0:EncompassInternalUser or urn:ietf:params:scim:schemas:extension:ice:2.0:AIQUser"Required
Required.

The following attributes are contained within the scimRequestPatch object.

Attribute	Description
schemas	Schemas for user. Mandatory for SCIM application. Example: urn:ietf:params:scim:api:messages:2.0:PatchOp. Required.
operations array operations contract	Supported operations for user patch. Required.

The following attributes are contained within the operations object.

Attribute	Description
op string	The operations value. Possible values: add\|replace\|remove. - Add - Use this operation to add a new value for the attribute. - Replace - Use this operation to replace existing value of an attribute and or to re-enable a disabled user. - Remove - Delete the existing value for the attribute specified in the path.
path string	Path is required for remove op. Optional for add and replace ops. Example: attribute_path\|value_path\|sub_attribute_path
value object	Refer to the urn:ietf:params:scim:schemas:extension:ice:2.0:EncompassInternalUser schema for the list of supported attributes. Required for add and replace operations, not applicable to remove.