Users

Get User

Returns an Express user object based on a user ID.

get/users/{userId}

Request

Base URL
https://env.unqork.io/api/1.0
Auth
OAuth 2
Client credentials
Password
Token URLhttps://xyzfinancial.unqork.io/api/1.0/oauth2/access_token
TypeScript
https://skmtc.dev/unqork/apis/unqork-customer-api/docs/users/:userId/get.ts
A function with typed inputs. Its response is checked against the schema.

userIdstring required

ID of user to retrieve

User

userIdstring required

namestring required

emailstring required

phonestring

rolestring

One of the roles configured in Unqork

expressRolesstring[]

Express roles configured in Unqork

groupsstring[]

List of groups configured in Unqork

applicationRolesobject

Map of applications to roles

createdstring date-time required

modifiedstring date-time required

isServiceUserboolean

lastLoginstring date-time

...customAttributesstring

Custom attributes will be included as additional keys in the response body.

No recorded changes to this operation across all 6 revisions of this API.