post
https://{baseurl}/organiations//users/signup
The usermanagement section provides you the APIs related to sign up, onboard, enroll, and delete users. This API endpoint allows you to sign up a new user. Prior to registering the user, you need to fetch the organization branding, groups, and roles from the server. You need to fetch the default workflow details. Refer the Get Default Workflow Details API.
Path Parameters
| Parameters | Type | Description |
|---|---|---|
| organizationName | string | Denotes the name of the organization. |
Body Parameters
| Parameters | Type | Description |
|---|---|---|
| user | object | The user data object to sign up a new user. |
user Object
| Parameter | Description |
|---|---|
| id | Long (Optional) The unique ID for the user object. |
| uimsId | String (Optional) This is the UIMSID of that is assigned to the user. |
| representationId | String (Optional) This is the representation ID of the user that is assigned. |
| name | String (Required) The user's username. |
| fullName | String (Optional) The full name of the user. |
| organisationName | String (Required) The name of the organization. |
| organisationId | Long (Optional) The unique ID of an organization. |
| groupId | String (Optional) The unique ID of a group. |
| groupName | String (Optional) The name of a group. |
| refApprovalGroupId | String (Optional) The approval group ID that is assigned to the users. |
| status | String (Optional) The status of the user enrollment. Possible Values: PENDING ENROLLMENT: Yet to start enrollment ENROLLMENT IN PROGRESS: Enrollment started and is in progress PENDING APPROVAL: Pending review for enrollment approval READY FOR ISSUANCE: Enrollment completed and awaiting issuance of the devices |
| workflowName | String (Optional) The name of a workflow assigned to the user. |
| firstName | String (Optional) The user's first name. |
| middleName | String (Optional) The user's middle name. |
| lastName | String (Optional) The user's last name. |
| mothersName | String (Optional) The user's mother's maiden name. |
| String (Optional) The user's email address. | |
| contactNumber | String (Optional) The user's contact number. |
| userPrincipalName | String (Optional) The user's ?????. |
| country | String (Optional) The name of the country the user belongs to. |
| enrollmentStatus??????????? | String (Optional) The status of the user enrollment. Possible Values: PENDING ENROLLMENT: Yet to start enrollment ENROLLMENT IN PROGRESS: Enrollment started and is in progress PENDING APPROVAL: Pending review for enrollment approval READY FOR ISSUANCE: Enrollment completed and awaiting issuance of the devices |
| userStatus | String (Optional) The status of the user. Default Values: Active |
| canIssueIdentity | Boolean (Optional) Indicates if the issuance of identities is allowed. Possible Values: true: Allow issuance false: Do not allow issuance |
| isNewLdapUser | Boolean (Optional) Indicates if the user is an LDAP user. Possible Values: true: LDAP User false: Non-LDAP user |
| isFederated | Boolean (Optional) Indicates if the user is a federated user. Possible Values: true: Federated user false: Non-federated user |
| isEnrollmentInProgress | Boolean (Optional) Indicates if the enrollment is in progress. Possible Values: true: Enrollment in progress false: Enrollment not in progress |
| expressMobileEnrollment | Boolean (Optional) Indicates if the enrollment request is via mobile app. Possible Values: true: Enrollment is via mobile app false: Enrollment is not via mobile app |
| expressEnrollment | Boolean (Optional) Indicates if the user is enrolled via the express enrollment option. Possible Values: true: User enrolled via express enrollment false: User not enrolled via express enrollment |
| idvEnrollment | Boolean (Optional) Indicates if the user has identity verification enabled. Possible Values: true: false: |
| userKCLID | String (Optional) The unique ID assigned to the user in the authentication server. |
| createdBy | String (Optional) The name of the person who registered the user. |
| lastModifiedBy | String (Optional) The name of the person who last modified the user details. |
| lastModifiedDate | Instant (Optional) The date the user details were last modified. |
| workflow | Workflow Object (Optional) The object that captures the configuration details of the workflow assigned to the user. |
| enrollmentStepsStatus | Enrollment Step Status Object (Optional) The object that captures the status of each enrollment step. |
| wfDeviceProfiles | Device Profile Object (Optional) The object that captures the device profile details. |
| userPIV | PIV ID Details Object (Optional) The object that captures PIV ID details. |
| userAppearance | User Appearance Object (Required) The object that captures the user's appearance details. It is derived from the workflow configured and the type of the identity being issued. |
| userAttribute | User Attributes Object (Required) The object that captures the user's biographical information. It is derived from the workflow configured and the type of the identity being issued. |
| userAddress | User Address Object (Required) The object that captures the user's address details. It is derived from the workflow configured and the type of the identity being issued. |
| userBiometrics | User Biometrics Object (Required) The object that captures the user's biometrics data. It is derived from the workflow configured and the type of the identity being issued. |
| userIDProofDocuments | User ID Proofing Documents Object (Required) The object that captures the ID proofing documents submitted by the user. |
| userDrivingLicense | Driving License Details Object (Optional) The object that captures the driving license ID details. |
| userEmployeeID | Employee ID Details Object (Optional) The object that captures the employee ID details. |
| userPersonalizedID | Personalized ID Details Object (Optional) The object that captures the details of the identities issued to the user. |
| userStudentID | Student ID Details Object (Optional) The object that captures the student ID details. |
| userHealthID | Health ID Details Object (Optional) The object that captures the health ID details. |
| userNationalID | National ID Details Object (Optional) The object that captures the national ID details. |
| userVoterID | Voter ID Details Object (Optional) The object that captures the voter ID details. |
| userPermanentResidentID | Permanent Resident ID Details Object (Optional) The object that captures the permanent resident ID details. |
| userHealthService | Health Service Provider ID Details Object (Optional) The object that captures the health service provider ID details. |
| wfMobileIDStepDetails | Mobile ID Step Details Object (Optional) The object that captures the mobile ID configuration details. |
| userEnrollmentHistory | User Enrollment History Object (Optional) The object that captures the user's enrollment history. |
| userEnrollmentHistoryList | User Enrollment History List Object Array (Required) The object that captures the list of the modifications done during the user's enrollment. |