get https://{baseurl}/organizations//idp-users//onboardUserDetails
This API endpoint allows you to fetch the details of an onboarded user.
Headers
- Authentication: Bearer <JWT>
- Accept: application/json
- Content-Type: application/json
Path Parameters
Parameters | Type | Description |
---|---|---|
organizationName | string | Denotes the name of the organization. |
userName | string | The unique username assigned to the user. |
Response Parameters
Parameter | Type | Description |
---|---|---|
firstName | String (Required) | The first name of the user. |
lastName | String (Required) | The last name of the user. |
String (Required) | The email address of the user. | |
userName | String (Required) | The user's username. |
enabled | Boolean (Required) | Indicates if the user is allowed access to the application (Unifyia Platform). Possible Values: true: Allow access to the application (Unifyia Platform). false: Access not enabled. |
credentialType | String (Optional) | The credential type is Password. |
credentialValue | String (Optional) | The server generated temporary password that would be sent to a user. |
credentialTemporary | Boolean (Optional) | Indicates if a temporary password that can be reset by a user on first login is allowed. Possible Values: true: User must change the password on first login false: Password reset not required |
groupID | String (Required) | The unique ID of a group. |
groupName | String (Required) | The name of a group. |
authServiceRoleID | String Array (Required) | The unique IDs of the roles assigned to the user. |
userKLKId | String (Optional) | The unique ID assigned to the user in the authentication service. |
sendInviteVia | String (Optional) | Indicates if the user must be sent an invite via an email. |
countryCode | String (Optional) | The country code. |
contactNumber | integer($int32) (Optional) | The device validity numeric value in days. |
roles | <Role> Array (Optional) | The object that captures details of the roles assigned to the user. |
sendInvite | Boolean (Optional) | Indicates if the user must be sent an email invite to self-enroll using the ID Wallet app. Possible Values: true: Send email invite false: Do not sent email invite |
loggedInUser | Long (Optional) | The username of the logged in user. |
loggedInUserId | Long (Optional) | The unique user ID of the logged in user. |
orgId | Long (Optional) | The unique organization ID of the logged in user. |
orgName | Long (Optional) | The name of the organization of the logged in user. |
userStatus | String (Optional) | The status of the user. |