On this page
API Integration Actions reference
This reference provides the API Integration Actions schema contracts supported in the Integration Builder. Use them to create API action flows to your APIs.
Universal Logout
The following are schema contracts for Universal Logout actions.
Proprietary Universal Logout
The following are input (requests) and output (responses) for the Proprietary Universal Logout action.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| externalUserId | The external user ID | string | |
| externalUserName | The external username | string | |
| oktaUserId | The Okta user ID | string |
Output
| Property | Description | Type |
|---|---|---|
| executionStatus | Execution result details for the logout request | object |
| executionStatus.status | Execution result state of the request (SUCCEEDED or FAILED) | string |
| executionStatus.errors | List of error objects returned when execution fails or partially fails | array |
| executionStatus.errors[].code | Error code identifier | string |
| executionStatus.errors[].summary | Human-readable summary of the error | string |
| executionStatus.errors[].details | More error details | array |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
| logoutStatus | Final logout outcome returned by the action (SUCCESS or FAILURE) | string |
Provisioning action contracts
The following are schema contracts for provisioning actions, which also includes Entitlement Management.
Provisioning Create User
This action schema contract is for provisioning users.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| user | A SCIM user object | object | |
| user.schemas | List of schemas for the user object | array | TRUE |
| user.id | The ID of the user | string | TRUE |
| user.externalId | External ID of the user, defined by the provisioning client | string | |
| user.userName | A unique identifier for the user, typically used by the user to directly authenticate to the service provider. Each user must include a non-empty username value. This identifier must be unique across the service provider's entire set of users. Required. | string | TRUE |
| user.name | The components of the user's real name | object | |
| user.name.formatted | The full name (including middle name, titles, and suffixes) that's formatted for display | string | |
| user.name.familyName | The family name of the user | string | |
| user.name.givenName | The given name of the user | string | |
| user.name.middleName | The middle name of the user | string | |
| user.name.honorificPrefix | The honorific prefix or title of the user | string | |
| user.name.honorificSuffix | The honorific suffix of the user | string | |
| user.displayName | The name of the user, suitable for display to end users | string | |
| user.nickName | The casual way to address the user in real life | string | |
| user.profileUrl | A fully qualified URL pointing to a page representing the user's online profile | string | |
| user.title | The user's title, such as Vice President | string | |
| user.userType | Identifies the relationship between the organization and the user | string | |
| user.preferredLanguage | Indicates the user's preferred written or spoken language | string | |
| user.locale | Indicates the user's default location for localization purposes | string | |
| user.timezone | The user's time zone in Olson database format, for example America/Los_Angeles | string | |
| user.active | A boolean value indicating the user's administrative status | boolean | |
| user.password | The user's cleartext password used for initial set or reset | string | |
| user.emails | Email addresses for the user | array | |
| user.emails[].value | Email address value for the user | string | |
| user.emails[].display | Human-readable display value for the email entry | string | |
| user.emails[].type | Label indicating the email type, such as work or home | string | |
| user.emails[].primary | Indicates whether this is the primary email value | boolean | |
| user.phoneNumbers | Phone numbers for the user | array | |
| user.phoneNumbers[].value | Phone number value for the user | string | |
| user.phoneNumbers[].display | Human-readable display value for the phone entry | string | |
| user.phoneNumbers[].type | Label indicating the phone type, such as work, home, or mobile | string | |
| user.phoneNumbers[].primary | Indicates whether this is the primary phone number | boolean | |
| user.ims | Instant messaging addresses for the user | array | |
| user.ims[].value | Instant messaging address value for the user | string | |
| user.ims[].display | Human-readable display value for the IM entry | string | |
| user.ims[].type | Label indicating the IM type, such as aim or xmpp | string | |
| user.ims[].primary | Indicates whether this is the primary IM value | boolean | |
| user.photos | URLs of photos of the user | array | |
| user.photos[].value | URL value for the photo entry | string | |
| user.photos[].display | Human-readable display value for the photo entry | string | |
| user.photos[].type | Label indicating photo type, such as photo or thumbnail | string | |
| user.photos[].primary | Indicates whether this is the primary photo value | boolean | |
| user.addresses | A physical mailing address for the user | array | |
| user.addresses[].formatted | Full mailing address formatted for display | string | |
| user.addresses[].streetAddress | Full street address component | string | |
| user.addresses[].locality | City or locality component | string | |
| user.addresses[].region | State or region component | string | |
| user.addresses[].postalCode | ZIP or postal code component | string | |
| user.addresses[].country | Country name component | string | |
| user.addresses[].type | Label indicating address type, such as work or home | string | |
| user.addresses[].primary | Indicates whether this is the primary address value | boolean | |
| user.groups | A list of groups to which the user belongs | array | |
| user.groups[].value | Identifier of the user's group | string | |
| user.groups[].ref | URI of the corresponding group resource | string | |
| user.groups[].display | Human-readable display value for the group entry | string | |
| user.groups[].type | Label indicating group membership type | string | |
| user.entitlements | A list of entitlements for the user | array | |
| user.entitlements[].value | Entitlement value | string | |
| user.entitlements[].display | Human-readable display value for the entitlement entry | string | |
| user.entitlements[].type | Label indicating entitlement type | string | |
| user.entitlements[].primary | Indicates whether this is the primary entitlement value | boolean | |
| user.roles | A list of roles for the user | array | |
| user.roles[].value | Role value | string | |
| user.roles[].display | Human-readable display value for the role entry | string | |
| user.roles[].type | Label indicating role type | string | |
| user.roles[].primary | Indicates whether this is the primary role value | boolean | |
| user.x509Certificates | A list of certificates issued to the user | array | |
| user.x509Certificates[].value | X.509 certificate value | string | |
| user.x509Certificates[].display | Human-readable display value for the certificate entry | string | |
| user.x509Certificates[].type | Label indicating certificate type | string | |
| user.x509Certificates[].primary | Indicates whether this is the primary certificate value | boolean | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User | Enterprise user object schema | object | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.employeeNumber | A string identifier assigned to a person by the organization | string | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.costCenter | Name of the cost center | string | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.organization | Name of the organization | string | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.division | Name of the division | string | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.department | Name of the department | string | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.manager | Manager object for the user | object | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.manager.value | ID of the SCIM resource representing the user's manager | string | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.manager.ref | URI of the SCIM resource representing the user's manager | string | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.manager.displayName | Display name of the user's manager | string |
Output
| Property | Description | Type |
|---|---|---|
| user | A SCIM user object | object |
| user.schemas | List of schemas for the user object | array |
| user.id | The ID of the user | string |
| user.externalId | External ID of the user, defined by the provisioning client | string |
| user.userName | Unique identifier for the user, typically used by the user to directly authenticate to the service provider. Each user must include a non-empty userName value. This identifier must be unique across the service provider's entire set of users. Required. | string |
| user.name | The components of the user's real name | object |
| user.name.formatted | The full name, including middle name, titles, and suffixes, formatted for display | string |
| user.name.familyName | The family name of the user | string |
| user.name.givenName | The given name of the user | string |
| user.name.middleName | The middle name of the user | string |
| user.name.honorificPrefix | The honorific prefix or title of the user | string |
| user.name.honorificSuffix | The honorific suffix of the user | string |
| user.displayName | The name of the user for display in the UI | string |
| user.nickName | The casual way to address the user in real life | string |
| user.profileUrl | A fully qualified URL pointing to a page representing the user's online profile | string |
| user.title | The user's title, such as Vice President | string |
| user.userType | Identifies the relationship between the organization and the user | string |
| user.preferredLanguage | Indicates the user's preferred written or spoken language | string |
| user.locale | Indicates the user's default location for localization purposes | string |
| user.timezone | The user's time zone in Olson database format, for example America/Los_Angeles | string |
| user.active | A Boolean value indicating the user's administrative status | boolean |
| user.password | The user's cleartext password used for initial set or reset | string |
| user.emails | Email addresses for the user | array |
| user.emails[].value | Email address value for the user | string |
| user.emails[].display | Human-readable display value for the email entry | string |
| user.emails[].type | Label indicating the email type, such as work or home | string |
| user.emails[].primary | Indicates whether this is the primary email value | boolean |
| user.phoneNumbers | Phone numbers for the user | array |
| user.phoneNumbers[].value | Phone number value for the user | string |
| user.phoneNumbers[].display | Human-readable display value for the phone entry | string |
| user.phoneNumbers[].type | Label indicating the phone type, such as work, home, or mobile | string |
| user.phoneNumbers[].primary | Indicates whether this is the primary phone number | boolean |
| user.ims | Instant messaging addresses for the user | array |
| user.ims[].value | Instant messaging address value for the user | string |
| user.ims[].display | Human-readable display value for the IM entry | string |
| user.ims[].type | Label indicating the IM type, such as aim or xmpp | string |
| user.ims[].primary | Indicates whether this is the primary IM value | boolean |
| user.photos | URLs of photos of the user | array |
| user.photos[].value | URL value for the photo entry | string |
| user.photos[].display | Human-readable display value for the photo entry | string |
| user.photos[].type | Label indicating photo type, such as photo or thumbnail | string |
| user.photos[].primary | Indicates whether this is the primary photo value | boolean |
| user.addresses | A physical mailing address for the user | array |
| user.addresses[].formatted | Full mailing address formatted for display | string |
| user.addresses[].streetAddress | Full street address component | string |
| user.addresses[].locality | City or locality component | string |
| user.addresses[].region | State or region component | string |
| user.addresses[].postalCode | ZIP or postal code component | string |
| user.addresses[].country | Country name component | string |
| user.addresses[].type | Label indicating address type, such as work or home | string |
| user.addresses[].primary | Indicates whether this is the primary address value | boolean |
| user.groups | A list of groups to which the user belongs | array |
| user.groups[].value | Identifier of the user's group | string |
| user.groups[].ref | URI of the corresponding group resource | string |
| user.groups[].display | Human-readable display value for the group entry | string |
| user.groups[].type | Label indicating group membership type | string |
| user.entitlements | A list of entitlements for the user | array |
| user.entitlements[].value | Entitlement value | string |
| user.entitlements[].display | Human-readable display value for the entitlement entry | string |
| user.entitlements[].type | Label indicating entitlement type | string |
| user.entitlements[].primary | Indicates whether this is the primary entitlement value | boolean |
| user.roles | A list of roles for the user | array |
| user.roles[].value | Role value | string |
| user.roles[].display | Human-readable display value for the role entry | string |
| user.roles[].type | Label indicating role type | string |
| user.roles[].primary | Indicates whether this is the primary role value | boolean |
| user.x509Certificates | A list of certificates issued to the user | array |
| user.x509Certificates[].value | X.509 certificate value | string |
| user.x509Certificates[].display | Human-readable display value for the certificate entry | string |
| user.x509Certificates[].type | Label indicating certificate type | string |
| user.x509Certificates[].primary | Indicates whether this is the primary certificate value | boolean |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User | Enterprise user object schema | object |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.employeeNumber | String identifier assigned to a person by the organization | string |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.costCenter | Name of the cost center | string |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.organization | Name of the organization | string |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.division | Name of the division | string |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.department | Name of the department | string |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.manager | Manager object for the user | object |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.manager.value | ID of the SCIM resource representing the user's manager | string |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.manager.ref | URI of the SCIM resource representing the user's manager | string |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.manager.displayName | Display name of the user's manager | string |
| executionStatus | Execution result details for the request | object |
| executionStatus.status | Execution result state of the request (SUCCEEDED or FAILED) | string |
| executionStatus.errors | List of error objects returned when execution fails or partially fails | array |
| executionStatus.errors[].code | Error code identifier | string |
| executionStatus.errors[].summary | Human-readable summary of the error | string |
| executionStatus.errors[].details | More error details | array |
| executionStatus.errors[].details[] | More error detail entry | string |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning Update User
This action schema contract is for provisioning users.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| user | A SCIM user object | object | |
| user.schemas | List of schemas for the user object | array | TRUE |
| user.id | The ID of the user | string | TRUE |
| user.externalId | External ID of the user, defined by the provisioning client | string | |
| user.userName | A unique identifier for the user, typically used by the user to directly authenticate to the service provider. Each user must include a non-empty username value. This identifier must be unique across the service provider's entire set of users. Required. | string | TRUE |
| user.name | The components of the user's real name | object | |
| user.name.formatted | The full name (including middle name, titles, and suffixes) that's formatted for display | string | |
| user.name.familyName | The family name of the user | string | |
| user.name.givenName | The given name of the user | string | |
| user.name.middleName | The middle name of the user | string | |
| user.name.honorificPrefix | The honorific prefix or title of the user | string | |
| user.name.honorificSuffix | The honorific suffix of the user | string | |
| user.displayName | The name of the user, suitable for display to end users | string | |
| user.nickName | The casual way to address the user in real life | string | |
| user.profileUrl | A fully qualified URL pointing to a page representing the user's online profile | string | |
| user.title | The user's title, such as Vice President | string | |
| user.userType | Identifies the relationship between the organization and the user | string | |
| user.preferredLanguage | Indicates the user's preferred written or spoken language | string | |
| user.locale | Indicates the user's default location for localization purposes | string | |
| user.timezone | The user's time zone in Olson database format, for example America/Los_Angeles | string | |
| user.active | A boolean value indicating the user's administrative status | boolean | |
| user.password | The user's cleartext password used for initial set or reset | string | |
| user.emails | Email addresses for the user | array | |
| user.emails[].value | Email address value for the user | string | |
| user.emails[].display | Human-readable display value for the email entry | string | |
| user.emails[].type | Label indicating the email type, such as work or home | string | |
| user.emails[].primary | Indicates whether this is the primary email value | boolean | |
| user.phoneNumbers | Phone numbers for the user | array | |
| user.phoneNumbers[].value | Phone number value for the user | string | |
| user.phoneNumbers[].display | Human-readable display value for the phone entry | string | |
| user.phoneNumbers[].type | Label indicating the phone type, such as work, home, or mobile | string | |
| user.phoneNumbers[].primary | Indicates whether this is the primary phone number | boolean | |
| user.ims | Instant messaging addresses for the user | array | |
| user.ims[].value | Instant messaging address value for the user | string | |
| user.ims[].display | Human-readable display value for the IM entry | string | |
| user.ims[].type | Label indicating the IM type, such as aim or xmpp | string | |
| user.ims[].primary | Indicates whether this is the primary IM value | boolean | |
| user.photos | URLs of photos of the user | array | |
| user.photos[].value | URL value for the photo entry | string | |
| user.photos[].display | Human-readable display value for the photo entry | string | |
| user.photos[].type | Label indicating photo type, such as photo or thumbnail | string | |
| user.photos[].primary | Indicates whether this is the primary photo value | boolean | |
| user.addresses | A physical mailing address for the user | array | |
| user.addresses[].formatted | Full mailing address formatted for display | string | |
| user.addresses[].streetAddress | Full street address component | string | |
| user.addresses[].locality | City or locality component | string | |
| user.addresses[].region | State or region component | string | |
| user.addresses[].postalCode | ZIP or postal code component | string | |
| user.addresses[].country | Country name component | string | |
| user.addresses[].type | Label indicating address type, such as work or home | string | |
| user.addresses[].primary | Indicates whether this is the primary address value | boolean | |
| user.groups | A list of groups to which the user belongs | array | |
| user.groups[].value | Identifier of the user's group | string | |
| user.groups[].ref | URI of the corresponding group resource | string | |
| user.groups[].display | Human-readable display value for the group entry | string | |
| user.groups[].type | Label indicating group membership type | string | |
| user.entitlements | A list of entitlements for the user | array | |
| user.entitlements[].value | Entitlement value | string | |
| user.entitlements[].display | Human-readable display value for the entitlement entry | string | |
| user.entitlements[].type | Label indicating entitlement type | string | |
| user.entitlements[].primary | Indicates whether this is the primary entitlement value | boolean | |
| user.roles | A list of roles for the user | array | |
| user.roles[].value | Role value | string | |
| user.roles[].display | Human-readable display value for the role entry | string | |
| user.roles[].type | Label indicating role type | string | |
| user.roles[].primary | Indicates whether this is the primary role value | boolean | |
| user.x509Certificates | A list of certificates issued to the user | array | |
| user.x509Certificates[].value | X.509 certificate value | string | |
| user.x509Certificates[].display | Human-readable display value for the certificate entry | string | |
| user.x509Certificates[].type | Label indicating certificate type | string | |
| user.x509Certificates[].primary | Indicates whether this is the primary certificate value | boolean | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User | Enterprise user object schema | object | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.employeeNumber | A string identifier assigned to a person by the organization | string | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.costCenter | Name of the cost center | string | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.organization | Name of the organization | string | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.division | Name of the division | string | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.department | Name of the department | string | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.manager | Manager object for the user | object | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.manager.value | ID of the SCIM resource representing the user's manager | string | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.manager.ref | URI of the SCIM resource representing the user's manager | string | |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.manager.displayName | Display name of the user's manager | string |
Output
| Property | Description | Type |
|---|---|---|
| user | A SCIM user object | object |
| user.schemas | List of schemas for the user object | array |
| user.id | The ID of the user | string |
| user.externalId | External ID of the user, defined by the provisioning client | string |
| user.userName | A unique identifier for the user, typically used by the user to directly authenticate to the service provider. Each user must include a non-empty username value. This identifier must be unique across the service provider's entire set of users. Required. | string |
| user.name | The components of the user's real name | object |
| user.name.formatted | The full name (including middle names, titles, and suffixes) formatted for display | string |
| user.name.familyName | The family name of the user | string |
| user.name.givenName | The given name of the user | string |
| user.name.middleName | The middle name of the user | string |
| user.name.honorificPrefix | The honorific prefix or title of the user | string |
| user.name.honorificSuffix | The honorific suffix of the user | string |
| user.displayName | The name of the user, suitable for display to end users | string |
| user.nickName | The casual way to address the user in real life | string |
| user.profileUrl | A fully qualified URL pointing to a page representing the user's online profile | string |
| user.title | The user's title, such as Vice President | string |
| user.userType | Identifies the relationship between the organization and the user | string |
| user.preferredLanguage | Indicates the user's preferred written or spoken language | string |
| user.locale | Indicates the user's default location for localization purposes | string |
| user.timezone | The user's time zone in Olson database format, for example America/Los_Angeles | string |
| user.active | A boolean value indicating the user's administrative status | boolean |
| user.password | The user's cleartext password used for initial set or reset | string |
| user.emails | Email addresses for the user | array |
| user.emails[].value | Email address value for the user | string |
| user.emails[].display | Human-readable display value for the email entry | string |
| user.emails[].type | Label indicating the email type, such as work or home | string |
| user.emails[].primary | Indicates whether this is the primary email value | boolean |
| user.phoneNumbers | Phone numbers for the user | array |
| user.phoneNumbers[].value | Phone number value for the user | string |
| user.phoneNumbers[].display | Human-readable display value for the phone entry | string |
| user.phoneNumbers[].type | Label indicating the phone type, such as work, home, or mobile | string |
| user.phoneNumbers[].primary | Indicates whether this is the primary phone number | boolean |
| user.ims | Instant messaging addresses for the user | array |
| user.ims[].value | Instant messaging address value for the user | string |
| user.ims[].display | Human-readable display value for the IM entry | string |
| user.ims[].type | Label indicating the IM type, such as aim or xmpp | string |
| user.ims[].primary | Indicates whether this is the primary IM value | boolean |
| user.photos | URLs of photos of the user | array |
| user.photos[].value | URL value for the photo entry | string |
| user.photos[].display | Human-readable display value for the photo entry | string |
| user.photos[].type | Label indicating photo type, such as photo or thumbnail | string |
| user.photos[].primary | Indicates whether this is the primary photo value | boolean |
| user.addresses | A physical mailing address for the user | array |
| user.addresses[].formatted | Full mailing address formatted for display | string |
| user.addresses[].streetAddress | Full street address component | string |
| user.addresses[].locality | City or locality component | string |
| user.addresses[].region | State or region component | string |
| user.addresses[].postalCode | ZIP or postal code component | string |
| user.addresses[].country | Country name component | string |
| user.addresses[].type | Label indicating address type, such as work or home | string |
| user.addresses[].primary | Indicates whether this is the primary address value | boolean |
| user.groups | A list of groups to which the user belongs | array |
| user.groups[].value | Identifier of the user's group | string |
| user.groups[].ref | URI of the corresponding group resource | string |
| user.groups[].display | Human-readable display value for the group entry | string |
| user.groups[].type | Label indicating group membership type | string |
| user.entitlements | A list of entitlements for the user | array |
| user.entitlements[].value | Entitlement value | string |
| user.entitlements[].display | Human-readable display value for the entitlement entry | string |
| user.entitlements[].type | Label indicating entitlement type | string |
| user.entitlements[].primary | Indicates whether this is the primary entitlement value | boolean |
| user.roles | A list of roles for the user | array |
| user.roles[].value | Role value | string |
| user.roles[].display | Human-readable display value for the role entry | string |
| user.roles[].type | Label indicating role type | string |
| user.roles[].primary | Indicates whether this is the primary role value | boolean |
| user.x509Certificates | A list of certificates issued to the user | array |
| user.x509Certificates[].value | X.509 certificate value | string |
| user.x509Certificates[].display | Human-readable display value for the certificate entry | string |
| user.x509Certificates[].type | Label indicating certificate type | string |
| user.x509Certificates[].primary | Indicates whether this is the primary certificate value | boolean |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User | Enterprise user object schema | object |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.employeeNumber | A string identifier assigned to a person by the organization | string |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.costCenter | Name of the cost center | string |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.organization | Name of the organization | string |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.division | Name of the division | string |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.department | Name of the department | string |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.manager | Manager object for the user | object |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.manager.value | ID of the SCIM resource representing the user's manager | string |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.manager.ref | URI of the SCIM resource representing the user's manager | string |
| user.urn:ietf:params:scim:schemas:extension:enterprise:2.0: User.manager.displayName | Display name of the user's manager | string |
| executionStatus | Execution result details for the request | object |
| executionStatus.status | Execution result state of the request (SUCCEEDED or FAILED) | string |
| executionStatus.errors | List of error objects returned when execution fails or partially fails | array |
| executionStatus.errors[].code | Error code identifier | string |
| executionStatus.errors[].summary | Human-readable summary of the error | string |
| executionStatus.errors[].details | More error details | array |
| executionStatus.errors[].details[] | More error detail entry | string |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning Update User Password
This action schema contract is for provisioning users.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| userId | ID of the user whose password is updated | string | TRUE |
| password | New password for the user | string | TRUE |
Output
| Property | Description | Type |
|---|---|---|
| executionStatus | Execution result details for the request | object |
| executionStatus.status | Execution result state of the request (SUCCEEDED or FAILED) | string |
| executionStatus.errors | List of error objects returned when execution fails or partially fails | array |
| executionStatus.errors[].code | Error code identifier | string |
| executionStatus.errors[].summary | Human-readable summary of the error | string |
| executionStatus.errors[].details | More error details | array |
| executionStatus.errors[].details[] | More error detail entry | string |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning Activate User
This action schema contract is for provisioning users.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| userId | ID of the user to activate | string | TRUE |
Output
| Property | Description | Type |
|---|---|---|
| executionStatus | Execution result details for the request | object |
| executionStatus.status | Execution result state of the request (SUCCEEDED or FAILED) | string |
| executionStatus.errors | List of error objects returned when execution fails or partially fails | array |
| executionStatus.errors[].code | Error code identifier | string |
| executionStatus.errors[].summary | Human-readable summary of the error | string |
| executionStatus.errors[].details | More error details | array |
| executionStatus.errors[].details[] | More error detail entry | string |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning Deactivate User
This action schema contract is for provisioning users.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| userId | ID of the user to deactivate | string | TRUE |
Output
| Property | Description | Type |
|---|---|---|
| executionStatus | Execution result details for the request | object |
| executionStatus.status | Execution result state of the request (SUCCEEDED or FAILED) | string |
| executionStatus.errors | List of error objects returned when execution fails or partially fails | array |
| executionStatus.errors[].code | Error code identifier | string |
| executionStatus.errors[].summary | Human-readable summary of the error | string |
| executionStatus.errors[].details | More error details | array |
| executionStatus.errors[].details[] | More error detail entry | string |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning Get User by ID
This action schema contract is for provisioning users.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| userId | ID of the user to retrieve | string | TRUE |
Output
| Property | Description | Type |
|---|---|---|
| user | A SCIM user object | object |
| user.schemas | List of schemas for the user object. Required. | array |
| user.id | The ID of the user. Required. | string |
| user.externalId | External ID of the user, defined by the provisioning client | string |
| user.userName | A unique identifier for the user, typically used by the user to directly authenticate to the service provider. Each user must include a non-empty username value. This identifier must be unique across the service provider's entire set of users. Required. | string |
| executionStatus | Execution result details for the request | object |
| executionStatus.status | Execution result state of the request (SUCCEEDED or FAILED) | string |
| executionStatus.errors | List of error objects returned when execution fails or partially fails | array |
| executionStatus.errors[].code | Error code identifier | string |
| executionStatus.errors[].summary | Human-readable summary of the error | string |
| executionStatus.errors[].details | More error details | array |
| executionStatus.errors[].details[] | More error detail entry | string |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning Get User by UserName
This action schema contract is for provisioning users.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| userName | A unique username of the user to retrieve | string | TRUE |
Output
| Property | Description | Type |
|---|---|---|
| user | A SCIM user object | object |
| user.schemas | List of schemas for the user object | array |
| user.id | The ID of the user | string |
| user.externalId | External ID of the user, defined by the provisioning client | string |
| user.userName | A unique identifier for the user, typically used by the user to directly authenticate to the service provider. Each user must include a non-empty username value. This identifier must be unique across the service provider's entire set of users. Required. | string |
| executionStatus | Execution result details for the request | object |
| executionStatus.status | Execution result state of the request (SUCCEEDED or FAILED) | string |
| executionStatus.errors | List of error objects returned when execution fails or partially fails | array |
| executionStatus.errors[].code | Error code identifier | string |
| executionStatus.errors[].summary | Human-readable summary of the error | string |
| executionStatus.errors[].details | More error details | array |
| executionStatus.errors[].details[] | More error detail entry | string |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning List Users
This action schema contract is for provisioning users.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| pagination | Pagination object for list users requests | object | |
| pagination.cursor | Cursor used to continue listing users from a specific position | string | |
| pagination.limit | Maximum number of users to return in the response | integer |
Output
| Property | Description | Type |
|---|---|---|
| resources | List of user objects returned by the request | array |
| resources[].schemas | List of schemas for the user object | array |
| resources[].id | The ID of the user | string |
| resources[].externalId | External ID of the user, defined by the provisioning client | string |
| resources[].userName | Unique identifier for the user, typically used by the user to directly authenticate to the service provider. Each user must include a non-empty username value. This identifier must be unique across the service provider's entire set of users. Required. | string |
| pagination | Pagination details for the response | object |
| pagination.nextCursor | Cursor for retrieving the next page of users | string |
| executionStatus | Execution result details for the request | object |
| executionStatus.status | Execution result state of the request (SUCCEEDED or FAILED) | string |
| executionStatus.errors | List of error objects returned when execution fails or partially fails | array |
| executionStatus.errors[].code | Error code identifier | string |
| executionStatus.errors[].summary | Human-readable summary of the error | string |
| executionStatus.errors[].details | More error details | array |
| executionStatus.errors[].details[] | More error detail entry | string |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning Create Group
This action schema contract is for provisioning users.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| group | group object for provisioning operations | object | |
| group.schemas | List of schemas for the group object | array | TRUE |
| group.id | The ID of the group | string | |
| group.displayName | A human-readable name for the group. Required. | string | TRUE |
| group.description | Group description | string |
Output
| Property | Description | Type |
|---|---|---|
| group | A SCIM group object | object |
| group.schemas | List of schemas for the group object | array |
| group.id | The ID of the group | string |
| group.displayName | A human-readable name for the group. Required. | string |
| group.description | Group description | string |
| executionStatus | Execution result details for the request | object |
| executionStatus.status | Execution result state of the request (SUCCEEDED or FAILED) | string |
| executionStatus.errors | List of error objects returned when execution fails or partially fails | array |
| executionStatus.errors[].code | Error code identifier | string |
| executionStatus.errors[].summary | Human-readable summary of the error | string |
| executionStatus.errors[].details | More error details | array |
| executionStatus.errors[].details[] | More error detail entry | string |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning Update Group
This action schema contract is for provisioning groups.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| group | group object for provisioning operations | object | |
| group.schemas | List of schemas for the group object | array | TRUE |
| group.id | The ID of the group | string | |
| group.displayName | A human-readable name for the group. Required. | string | TRUE |
| group.description | Group description | string |
Output
| Property | Description | Type |
|---|---|---|
| group | A SCIM group object | object |
| group.schemas | List of schemas for the group object | array |
| group.id | The ID of the group | string |
| group.displayName | A human-readable name for the group. Required. | string |
| group.description | Group description | string |
| executionStatus | Execution result details for the request | object |
| executionStatus.status | Execution result state of the request (SUCCEEDED or FAILED) | string |
| executionStatus.errors | List of error objects returned when execution fails or partially fails | array |
| executionStatus.errors[].code | Error code identifier | string |
| executionStatus.errors[].summary | Human-readable summary of the error | string |
| executionStatus.errors[].details | More error details | array |
| executionStatus.errors[].details[] | More error detail entry | string |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning Remove Group
This action schema contract is for provisioning groups.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| groupId | ID of the group to remove | string | TRUE |
Output
| Property | Description | Type |
|---|---|---|
| executionStatus | Execution result details for the request | object |
| executionStatus.status | Execution result state of the request (SUCCEEDED or FAILED) | string |
| executionStatus.errors | List of error objects returned when execution fails or partially fails | array |
| executionStatus.errors[].code | Error code identifier | string |
| executionStatus.errors[].summary | Human-readable summary of the error | string |
| executionStatus.errors[].details | More error details | array |
| executionStatus.errors[].details[] | More error detail entry | string |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning Add Group Members
This action schema contract is for provisioning groups.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| groupId | Identifier of the group | string | TRUE |
| groupMembers | List of group member objects to add | array | TRUE |
| groupMembers[].value | Identifier of the member of this group | string | TRUE |
| groupMembers[].display | The display name for this group member object | string |
Output
| Property | Description | Type |
|---|---|---|
| executionStatus | Execution result details for the request | object |
| executionStatus.status | Execution result state of the request (SUCCEEDED or FAILED) | string |
| executionStatus.errors | List of error objects returned when execution fails or partially fails | array |
| executionStatus.errors[].code | Error code identifier | string |
| executionStatus.errors[].summary | Human-readable summary of the error | string |
| executionStatus.errors[].details | More error details | array |
| executionStatus.errors[].details[] | More error detail entry | string |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning Remove Group Members
This action schema contract is for provisioning groups.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| groupId | Identifier of the group | string | TRUE |
| groupMembers | List of group member objects to remove | array | TRUE |
| groupMembers[].value | Identifier of the member of this group | string | TRUE |
| groupMembers[].display | The display name for this group member object | string |
Output
| Property | Description | Type |
|---|---|---|
| executionStatus | Execution result details for the request | object |
| executionStatus.status | Execution result state of the request (SUCCEEDED or FAILED) | string |
| executionStatus.errors | List of error objects returned when execution fails or partially fails | array |
| executionStatus.errors[].code | Error code identifier | string |
| executionStatus.errors[].summary | Human-readable summary of the error | string |
| executionStatus.errors[].details | More error details | array |
| executionStatus.errors[].details[] | More error detail entry | string |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning List Group Members
This action schema contract is for provisioning groups.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| groupId | Identifier of the group | string | TRUE |
| pagination | Pagination object for list requests | object | |
| pagination.cursor | Cursor used to continue listing members from a specific position | string | |
| pagination.limit | Maximum number of members to return in the response | integer |
Output
| Property | Description | Type |
|---|---|---|
| resources | List of group member objects returned by the request | array |
| resources[].value | Identifier of the member of this group | string |
| resources[].display | The display name for this group member object | string |
| pagination | Pagination details for the response | object |
| pagination.nextCursor | Cursor for retrieving the next page of members | string |
| executionStatus | Execution result details for the request | object |
| executionStatus.status | Execution result state of the request (SUCCEEDED or FAILED) | string |
| executionStatus.errors | List of error objects returned when execution fails or partially fails | array |
| executionStatus.errors[].code | Error code identifier | string |
| executionStatus.errors[].summary | Human-readable summary of the error | string |
| executionStatus.errors[].details | More error details | array |
| executionStatus.errors[].details[] | More error detail entry | string |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning Get Group by ID
This action schema contract is for provisioning groups.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| groupId | Identifier of the group | string | TRUE |
Output
| Property | Description | Type |
|---|---|---|
| group | A SCIM group object | object |
| group.schemas | List of schemas for the group object | array |
| group.id | The ID of the group | string |
| group.displayName | A human-readable name for the group | string |
| group.description | Group description | string |
| executionStatus | Execution status of the action | object |
| executionStatus.status | Outcome of the action (SUCCEEDED, FAILED) | string |
| executionStatus.errors[] | List of errors that occurred during the action | array |
| executionStatus.errors[].code | Error code | string |
| executionStatus.errors[].summary | Summary of the error | string |
| executionStatus.errors[].details[] | Details of the error | array |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning List Groups
This action schema contract is for provisioning groups.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| pagination | Pagination object | object | |
| pagination.cursor | Cursor for the next page of results | string | |
| pagination.limit | Maximum number of results to return | integer |
Output
| Property | Description | Type |
|---|---|---|
| resources[] | List of SCIM group objects | array |
| resources[].schemas | List of schemas for the group object | array |
| resources[].id | The ID of the group | string |
| resources[].displayName | A human-readable name for the group | string |
| resources[].description | Group description | string |
| pagination | Pagination object | object |
| pagination.nextCursor | Cursor for the next page of results | string |
| executionStatus | Execution status of the action | object |
| executionStatus.status | Outcome of the action (SUCCEEDED, FAILED) | string |
| executionStatus.errors[] | List of errors that occurred during the action | array |
| executionStatus.errors[].code | Error code | string |
| executionStatus.errors[].summary | Summary of the error | string |
| executionStatus.errors[].details[] | Details of the error | array |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning List Groups by Display Name
This action schema contract is for provisioning groups.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| displayName | Display name of the group | string | TRUE |
| pagination | Pagination object | object | |
| pagination.cursor | Cursor for the next page of results | string | |
| pagination.limit | Maximum number of results to return | integer |
Output
| Property | Description | Type |
|---|---|---|
| resources[] | List of SCIM group objects | array |
| resources[].schemas | List of schemas for the group object | array |
| resources[].id | The ID of the group | string |
| resources[].displayName | A human-readable name for the group | string |
| resources[].description | Group description | string |
| pagination | Pagination object | object |
| pagination.nextCursor | Cursor for the next page of results | string |
| executionStatus | Execution status of the action | object |
| executionStatus.status | Outcome of the action (SUCCEEDED, FAILED) | string |
| executionStatus.errors[] | List of errors that occurred during the action | array |
| executionStatus.errors[].code | Error code | string |
| executionStatus.errors[].summary | Summary of the error | string |
| executionStatus.errors[].details[] | Details of the error | array |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning List User Schema
This action schema contract is for provisioning Entitlement Management.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| scim | SCIM server configuration | object | |
| scim.baseUri | The base URL of the SCIM server | string | TRUE |
| scim.authMode | Authentication mode of the SCIM server (header, bearer, oauth) | string | TRUE |
| scim.entitlementTypes[] | List of entitlement types supported by the SCIM server | array | TRUE |
| scim.entitlementTypes[].name | Entitlement type name | string | TRUE |
| scim.entitlementTypes[].endpoint | The resource type's HTTP-addressable endpoint relative to the base URL | string | TRUE |
| scim.entitlementTypes[].description | The resource type's human-readable description | string | |
| scim.entitlementTypes[].attributes | The attributes of the resource type | object | |
| scim.entitlementTypes[].attributes.required | Whether this entitlement attribute is required | boolean | |
| scim.entitlementTypes[].attributes.multiValued | Whether this entitlement attribute can have multiple values | boolean | |
| scim.entitlementTypes[].mappings | Schema mappings for the entitlement type | object | TRUE |
| scim.entitlementTypes[].mappings.idField | The name of the field that contains the unique identifier for the entitlement | string | TRUE |
| scim.entitlementTypes[].mappings.displayNameField | The name of the field that contains the display name for the entitlement | string | TRUE |
| scim.entitlementTypes[].mappings.descriptionField | The name of the field that contains the description of the entitlement | string | |
| pagination | Pagination object | object | |
| pagination.cursor | Cursor for the next page of results | string | |
| pagination.limit | Maximum number of results to return | integer |
Output
| Property | Description | Type |
|---|---|---|
| schemaProperties[] | List of schema property definitions | array |
| schemaProperties[].name | Name of the schema property | string |
| schemaProperties[].title | Display title of the schema property | string |
| schemaProperties[].externalName | External name of the schema property | string |
| schemaProperties[].externalNamespace | External namespace of the schema property | string |
| schemaProperties[].description | Description of the schema property | string |
| schemaProperties[].required | Whether the schema property is required | boolean |
| schemaProperties[].propertyType | Data type of the schema property (STRING, NUMBER, INTEGER, BOOLEAN, DATE, ARRAY, URI, COUNTRY_CODE, TIMEZONE, LOCALE, LANGUAGE_CODE, EMAIL, OBJECT) | string |
| schemaProperties[].scope | Scope of the schema property (SELF, SYSTEM, NONE) | string |
| schemaProperties[].schemaName | Name of the schema this property belongs to | string |
| schemaProperties[].defaultValue | Default value for the schema property | any |
| schemaProperties[].enumConstraint | List of allowed enum values | array |
| schemaProperties[].oneOfConstraint | Map of allowed key-value pairs for the property | object |
| schemaProperties[].enumTitles | Display titles for enum values | object |
| schemaProperties[].__metadata | More metadata for the schema property | object |
| schemaProperties[].properties[] | Nested schema property definitions (for object types) | array |
| schemaProperties[].minItems | Minimum number of items (for array types) | number |
| schemaProperties[].maxItems | Maximum number of items (for array types) | number |
| schemaProperties[].minLength | Minimum string length | number |
| schemaProperties[].maxLength | Maximum string length | number |
| schemaProperties[].pattern | Regex pattern constraint | string |
| schemaProperties[].minimum | Minimum numeric value | integer |
| schemaProperties[].maximum | Maximum numeric value | integer |
| schemaProperties[].minSize | Minimum size constraint | number |
| schemaProperties[].maxSize | Maximum size constraint | number |
| schemaProperties[].beforeDate | Upper bound date constraint | date-time |
| schemaProperties[].afterDate | Lower bound date constraint | date-time |
| pagination | Pagination object | object |
| pagination.nextCursor | Cursor for the next page of results | string |
| executionStatus | Execution status of the action | object |
| executionStatus.status | Outcome of the action (SUCCEEDED, FAILED) | string |
| executionStatus.errors[] | List of errors that occurred during the action | array |
| executionStatus.errors[].code | Error code | string |
| executionStatus.errors[].summary | Summary of the error | string |
| executionStatus.errors[].details[] | Details of the error | array |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning List Entitlement Schema
This action schema contract is for provisioning Entitlement Management.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| scim | SCIM server configuration | object | |
| scim.baseUri | The base URL of the SCIM server | string | TRUE |
| scim.authMode | Authentication mode of the SCIM server (header, bearer, oauth) | string | TRUE |
| scim.entitlementTypes[] | List of entitlement types supported by the SCIM server | array | TRUE |
| scim.entitlementTypes[].name | Entitlement type name | string | TRUE |
| scim.entitlementTypes[].endpoint | The resource type's HTTP-addressable endpoint relative to the base URL | string | TRUE |
| scim.entitlementTypes[].description | The resource type's human-readable description | string | |
| scim.entitlementTypes[].attributes | The attributes of the resource type | object | |
| scim.entitlementTypes[].attributes.required | Whether this entitlement attribute is required | boolean | |
| scim.entitlementTypes[].attributes.multiValued | Whether this entitlement attribute can have multiple values | boolean | |
| scim.entitlementTypes[].mappings | Schema mappings for the entitlement type | object | TRUE |
| scim.entitlementTypes[].mappings.idField | The name of the field that contains the unique identifier for the entitlement | string | TRUE |
| scim.entitlementTypes[].mappings.displayNameField | The name of the field that contains the display name for the entitlement | string | TRUE |
| scim.entitlementTypes[].mappings.descriptionField | The name of the field that contains the description of the entitlement | string | |
| pagination | Pagination object | object | |
| pagination.cursor | Cursor for the next page of results | string | |
| pagination.limit | Maximum number of results to return | integer |
Output
| Property | Description | Type |
|---|---|---|
| schemaProperties[] | List of schema property definitions | array |
| schemaProperties[].name | Name of the schema property | string |
| schemaProperties[].title | Display title of the schema property | string |
| schemaProperties[].externalName | External name of the schema property | string |
| schemaProperties[].externalNamespace | External namespace of the schema property | string |
| schemaProperties[].description | Description of the schema property | string |
| schemaProperties[].required | Whether the schema property is required | boolean |
| schemaProperties[].propertyType | Data type of the schema property (STRING, NUMBER, INTEGER, BOOLEAN, DATE, ARRAY, URI, COUNTRY_CODE, TIMEZONE, LOCALE, LANGUAGE_CODE, EMAIL, OBJECT) | string |
| schemaProperties[].scope | Scope of the schema property (SELF, SYSTEM, NONE) | string |
| schemaProperties[].schemaName | Name of the schema this property belongs to | string |
| schemaProperties[].defaultValue | Default value for the schema property | any |
| schemaProperties[].enumConstraint | List of allowed enum values | array |
| schemaProperties[].oneOfConstraint | Map of allowed key-value pairs for the property | object |
| schemaProperties[].enumTitles | Display titles for enum values | object |
| schemaProperties[].__metadata | More metadata for the schema property | object |
| schemaProperties[].properties[] | Nested schema property definitions (for object types) | array |
| schemaProperties[].minItems | Minimum number of items (for array types) | number |
| schemaProperties[].maxItems | Maximum number of items (for array types) | number |
| schemaProperties[].minLength | Minimum string length | number |
| schemaProperties[].maxLength | Maximum string length | number |
| schemaProperties[].pattern | Regex pattern constraint | string |
| schemaProperties[].minimum | Minimum numeric value | integer |
| schemaProperties[].maximum | Maximum numeric value | integer |
| schemaProperties[].minSize | Minimum size constraint | number |
| schemaProperties[].maxSize | Maximum size constraint | number |
| schemaProperties[].beforeDate | Upper bound date constraint | date-time |
| schemaProperties[].afterDate | Lower bound date constraint | date-time |
| pagination | Pagination object | object |
| pagination.nextCursor | Cursor for the next page of results | string |
| executionStatus | Execution status of the action | object |
| executionStatus.status | Outcome of the action (SUCCEEDED, FAILED) | string |
| executionStatus.errors[] | List of errors that occurred during the action | array |
| executionStatus.errors[].code | Error code | string |
| executionStatus.errors[].summary | Summary of the error | string |
| executionStatus.errors[].details[] | Details of the error | array |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning List User Schema Property Values
This action schema contract is for provisioning Entitlement Management.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| scim | SCIM server configuration | object | |
| scim.baseUri | The base URL of the SCIM server | string | TRUE |
| scim.authMode | Authentication mode of the SCIM server (header, bearer, oauth) | string | TRUE |
| scim.entitlementTypes[] | List of entitlement types supported by the SCIM server | array | TRUE |
| scim.entitlementTypes[].name | Entitlement type name | string | TRUE |
| scim.entitlementTypes[].endpoint | The resource type's HTTP-addressable endpoint relative to the base URL | string | TRUE |
| scim.entitlementTypes[].description | The resource type's human-readable description | string | |
| scim.entitlementTypes[].attributes | The attributes of the resource type | object | |
| scim.entitlementTypes[].attributes.required | Whether this entitlement attribute is required | boolean | |
| scim.entitlementTypes[].attributes.multiValued | Whether this entitlement attribute can have multiple values | boolean | |
| scim.entitlementTypes[].mappings | Schema mappings for the entitlement type | object | TRUE |
| scim.entitlementTypes[].mappings.idField | The name of the field that contains the unique identifier for the entitlement | string | TRUE |
| scim.entitlementTypes[].mappings.displayNameField | The name of the field that contains the display name for the entitlement | string | TRUE |
| scim.entitlementTypes[].mappings.descriptionField | The name of the field that contains the description of the entitlement | string | |
| pagination | Pagination object | object | |
| pagination.cursor | Cursor for the next page of results | string | |
| pagination.limit | Maximum number of results to return | integer |
Output
| Property | Description | Type |
|---|---|---|
| schemaPropertyValues[] | List of schema property values | array |
| schemaPropertyValues[].id | Identifier of the schema property value | string |
| schemaPropertyValues[].displayName | Display name of the schema property value | string |
| schemaPropertyValues[].schemaPropertyName | Name of the schema property associated with this value | string |
| schemaPropertyValues[].typeName | Name of the entitlement type associated with this value | string |
| schemaPropertyValues[].description | Description of the schema property value | string |
| pagination | Pagination object | object |
| pagination.nextCursor | Cursor for the next page of results | string |
| executionStatus | Execution status of the action | object |
| executionStatus.status | Outcome of the action (SUCCEEDED, FAILED) | string |
| executionStatus.errors[] | List of errors that occurred during the action | array |
| executionStatus.errors[].code | Error code | string |
| executionStatus.errors[].summary | Summary of the error | string |
| executionStatus.errors[].details[] | Details of the error | array |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
Provisioning List Entitlement Schema Property Values
This action schema contract is for provisioning Entitlement Management.
Input
| Property | Description | Type | Required |
|---|---|---|---|
| scim | SCIM server configuration | object | |
| scim.baseUri | The base URL of the SCIM server | string | TRUE |
| scim.authMode | Authentication mode of the SCIM server (header, bearer, oauth) | string | TRUE |
| scim.entitlementTypes[] | List of entitlement types supported by the SCIM server | array | TRUE |
| scim.entitlementTypes[].name | Entitlement type name | string | TRUE |
| scim.entitlementTypes[].endpoint | The resource type's HTTP-addressable endpoint relative to the base URL | string | TRUE |
| scim.entitlementTypes[].description | The resource type's human-readable description | string | |
| scim.entitlementTypes[].attributes | The attributes of the resource type | object | |
| scim.entitlementTypes[].attributes.required | Whether this entitlement attribute is required | boolean | |
| scim.entitlementTypes[].attributes.multiValued | Whether this entitlement attribute can have multiple values | boolean | |
| scim.entitlementTypes[].mappings | Schema mappings for the entitlement type | object | TRUE |
| scim.entitlementTypes[].mappings.idField | The name of the field that contains the unique identifier for the entitlement | string | TRUE |
| scim.entitlementTypes[].mappings.displayNameField | The name of the field that contains the display name for the entitlement | string | TRUE |
| scim.entitlementTypes[].mappings.descriptionField | The name of the field that contains the description of the entitlement | string | |
| pagination | Pagination object | object | |
| pagination.cursor | Cursor for the next page of results | string | |
| pagination.limit | Maximum number of results to return | integer |
Output
| Property | Description | Type |
|---|---|---|
| schemaPropertyValues[] | List of schema property values | array |
| schemaPropertyValues[].id | Identifier of the schema property value | string |
| schemaPropertyValues[].displayName | Display name of the schema property value | string |
| schemaPropertyValues[].schemaPropertyName | Name of the schema property associated with this value | string |
| schemaPropertyValues[].typeName | Name of the entitlement type associated with this value | string |
| schemaPropertyValues[].description | Description of the schema property value | string |
| pagination | Pagination object | object |
| pagination.nextCursor | Cursor for the next page of results | string |
| executionStatus | Execution status of the action | object |
| executionStatus.status | Outcome of the action (SUCCEEDED, FAILED) | string |
| executionStatus.errors[] | List of errors that occurred during the action | array |
| executionStatus.errors[].code | Error code | string |
| executionStatus.errors[].summary | Summary of the error | string |
| executionStatus.errors[].details[] | Details of the error | array |
| executionStatus.errors[].httpStatusCode | HTTP status code associated with the error | integer |
| executionStatus.errors[].requestId | Request identifier associated with the error | string |
| executionStatus.errors[].type | Categorized error type (RESOURCE_NOT_FOUND, RATE_LIMIT_EXCEEDED, INVALID_CREDENTIALS, TOKEN_EXPIRED, GENERIC_FAILURE) | string |
