Skip to main content
Browse Documentation

Get a user by id

Created by Alex Pop on 04 Aug 2020

A user resource can be retrieved by it's GUID identifier.

getById(userId: string): Promise<User>

Returns

A Promise that will resolve with a User object.

Example

client.security.users.getById('bd8f92eb-d137-49d8-9e7a-560078a8a530')
  .then(result => {      
    console.log('API call result: ', result);              
  })
  .catch(error => {
    console.log('API call error: ', error);      
});

A user resource can be retrieved by its username.

getByUsername(username: string): Promise<User>

Example

client.security.users.getByUsername('testuser')
  .then(result => {      
    console.log('API call result: ', result);              
  })
  .catch(error => {
    console.log('API call error: ', error);      
});

A user resource can be retrieved by it's email address.

getByEmail(email: string): Promise<User>

Example

client.security.users.getByEmail('testuser@test.com')
  .then(result => {      
    console.log('API call result: ', result);              
  })
  .catch(error => {
    console.log('API call error: ', error);      
});