JSDoc: Class: UserServiceClient

Class: UserServiceClient

UserServiceClient()

User Service HTTP Client for Containerized APIs Copy this file to other API containers to access cached user data across your microservices architecture. Usage: const client = new UserServiceClient('http://members-api:3000'); const userData = await client.getUserData(userId, orgId, authToken);

Constructor

new UserServiceClient()

Source:

utils/userServiceClient.js, line 12

Classes

UserServiceClient
UserServiceClient

Methods

(async) getUserData(userUID, orgaUID, authToken) → {Object}

Get user data from Members API (with automatic cache population)

Parameters:

Name	Type	Description
`userUID`	string	User UUID
`orgaUID`	string	Organization UUID
`authToken`	string	Auth token for API calls

Source:

utils/userServiceClient.js, line 24

Returns:

- User validation data

Type: Object

(async) getUserData(userUID, orgaUID, authToken) → {Object}

Get user data - works across containers via HTTP

Parameters:

Name	Type	Description
`userUID`	string	User UUID
`orgaUID`	string	Organization UUID
`authToken`	string	Auth token for API calls

Source:

utils/userService.js, line 70

Returns:

- User validation data

Type: Object

(async) isUserAdmin(userUID, orgaUID, authToken) → {boolean}

Check if user has admin privileges

Parameters:

Name	Type	Description
`userUID`	string	User UUID
`orgaUID`	string	Organization UUID
`authToken`	string	Auth token

Source:

utils/userServiceClient.js, line 65

Returns:

- True if user is admin

Type: boolean

(async) validateUserAccess(userUID, orgaUID, authToken) → {boolean}

Validate user access to organization

Parameters:

Name	Type	Description
`userUID`	string	User UUID
`orgaUID`	string	Organization UUID
`authToken`	string	Auth token

Source:

utils/userServiceClient.js, line 77

Returns:

- True if user has valid access

Type: boolean

UserServiceClientUserServiceClient()

HTTP Client for other containerized APIs This can be copied to other services or published as a shared library

Constructor

new UserServiceClient()

Source:

utils/userService.js, line 57

Classes

UserServiceClient
UserServiceClient

Methods

(async) getUserData(userUID, orgaUID, authToken) → {Object}

Get user data from Members API (with automatic cache population)

Parameters:

Name	Type	Description
`userUID`	string	User UUID
`orgaUID`	string	Organization UUID
`authToken`	string	Auth token for API calls

Source:

utils/userServiceClient.js, line 24

Returns:

- User validation data

Type: Object

(async) getUserData(userUID, orgaUID, authToken) → {Object}

Get user data - works across containers via HTTP

Parameters:

Name	Type	Description
`userUID`	string	User UUID
`orgaUID`	string	Organization UUID
`authToken`	string	Auth token for API calls

Source:

utils/userService.js, line 70

Returns:

- User validation data

Type: Object

(async) isUserAdmin(userUID, orgaUID, authToken) → {boolean}

Check if user has admin privileges

Parameters:

Name	Type	Description
`userUID`	string	User UUID
`orgaUID`	string	Organization UUID
`authToken`	string	Auth token

Source:

utils/userServiceClient.js, line 65

Returns:

- True if user is admin

Type: boolean

(async) validateUserAccess(userUID, orgaUID, authToken) → {boolean}

Validate user access to organization

Parameters:

Name	Type	Description
`userUID`	string	User UUID
`orgaUID`	string	Organization UUID
`authToken`	string	Auth token

Source:

utils/userServiceClient.js, line 77

Returns:

- True if user has valid access

Type: boolean