Skip to main content
Browse Documentation

List groups

Created by Alex Pop on 04 Aug 2020

Group resources can be retrieved as a paged list by passing an optional GroupListOptions object as an argument.

list(options?: GroupListOptions): Promise<PagedList<Group>>

Returns

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

Example

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