Skip to main content
Browse Documentation

Get a group by name

Created by Alex Pop on 04 Aug 2020

Get a group by id

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

getById(groupId: string): Promise<Group>

Returns

A Promise that will resolve with a Group object.

Example

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

A group resource can be retrieved by its name.

getByName(username: string): Promise<Group>

Example

client.security.groups.getByNme('Test Group')
  .then(result => {      
    console.log('API call result: ', result);              
  })
  .catch(error => {
    console.log('API call error: ', error);      
});