OneWelcome provides an extension to the user schema to overcome limitations in the SCIM: Core Schema v1.1.
Singular User Attributes
| Attribute | Semantics | Validations |
|---|---|---|
| segment | A segment is a subset of identities that are contained within an OneWelcome environment and whose identities can be managed independently of identities in other segments within the same OneWelcome environment. All user identifiers are unique within the context of a segment. Often there is a 1-on-1 relation between a segment and a brand. User identifiers are unique within a segment. Once the segment is set for a particular identity, it cannot be updated using a User-PUT or User-PATCH; an identity cannot be transferred from one segment to another. | Possible segments (segment-values) are pre-configured by OneWelcome, other values are rejected. Please contact OneWelcome for list of segments that are supported in your environment. |
| state | This attribute indicates the status of an identity within OneWelcome. It allows for a more granular identity lifecycle than implied by the SCIM-specified 'active' attribute, which is a boolean value. Possible values are: 'ACTIVE', 'INACTIVE','BLOCKED', 'WITHDRAWN' or 'GRACE'. Note: The value is accepted in uppercase ( "state": "INACTIVE" ). When an identity is created with status 'INACTIVE', OneWelcome can initiate an activation process, depending on configuration. When a block is applied on an account having the status 'INACTIVE', the new status will be 'WITHDRAWN'. | |
| lastSuccessfulLogin | Read-only field that indicates the date and time of the user's last successful login. | Not applicable |
| birthDate | The user's date of birth. | The birthDate must be formatted as DD/MM/YYYY. |
| gender | The user's gender. | Values can either be 'Male' or 'Female'. |
Multi-valued Complex Attributes
| Attribute | Subattribute | Semantics | Validations |
|---|---|---|---|
| blocks | Multiple blocks can be applied to a single identity (user). As long as one or multiple blocks are placed on the identity (user), that identity cannot be active. Identities without blocks can be inactive or active. | ||
| userId | userId This is the userID of the ServiceDesk user that placed the block. | No validations are applied, any userid value can be submitted. When OneWelcome's ServiceDesk application is used to block an end user, the UUID of the ServiceDesk user's identity is submitted. | |
| reason | This subattribute indicates the reason for placing a block on the user. | No validations are applied. | |
| date | The date on which the block has been placed on the user. If no date is provided when the block is set, OneWelcome will generate the value. When a block is placed simultaneously with creation of the user (i.e. as part of User Post), the date will be the create date of the user. |