Skip to main content
Browse Documentation

List users

Created by Alex Pop on 04 Aug 2020

User resources can be retrieved as a paged list by passing an optional UserListOptions object as an argument.

list(options?: UserListOptions): Promise<PagedList<User>>

Returns

A Promise that will resolve with a PagedList that contains an array of User objects.

Example

client.security.users.list({
        q: 'mycompany.com',
        pageOptions: { pageIndex: 1, pageSize: 5 },
        order: ['userName']
  })
  .then(result => {      
    console.log('API call result: ', result);              
  })
  .catch(error => {
    console.log('API call error: ', error);      
});