Class Groups

Hierarchy

UrlSection
- Groups

Index

Constructors

constructor

Methods

Constructors

constructor

new Groups(prv: PathSegment, id?: string, service?: any): Groups

Overrides UrlSection.constructor
- Defined in paths/Groups.ts:8
Parameters
- prv: PathSegment
- Optional id: string
- Optional service: any
Returns Groups

Methods

bulkAssign

bulkAssign(id?: string): BulkAssign

- Defined in paths/Groups.ts:13
Parameters
- Optional id: string
Returns BulkAssign

get

get(): Promise<GlipGroupInfo>

- Defined in paths/Groups.ts:46
Since 1.0.28 (Release 8.4)
Returns a group or few groups by ID(s). Batch request is supported.
Required Permissions
Permission Description
Glip Availability of Glip
API Group
Light

Returns Promise<GlipGroupInfo>

getEndpoint

getEndpoint(withValue?: boolean): string

Inherited from UrlSection.getEndpoint
- Defined in PathSegment.ts:26
Parameters
- Default value withValue: boolean = true
Returns string

Protected getRest

getRest(): RestClient

Inherited from UrlSection.getRest
- Defined in PathSegment.ts:34
Returns RestClient

list

list(query?: ListQuery): Promise<GlipGroupList>

- Defined in paths/Groups.ts:20
Since 1.0.28 (Release 8.4)
Returns the list of groups associated with the user.
Required Permissions
Permission Description
Glip Availability of Glip
API Group
Medium

Parameters
- Optional query: ListQuery
Returns Promise<GlipGroupList>

post

post(body: GlipCreateGroup): Promise<GlipGroupInfo>

- Defined in paths/Groups.ts:33
Since 1.0.28 (Release 8.4)
Creates a group.
Required Permissions
Permission Description
Glip Availability of Glip
API Group
Medium

Parameters
- body: GlipCreateGroup
Returns Promise<GlipGroupInfo>

toString

toString(withValue?: boolean): string

Inherited from UrlSection.toString
- Defined in PathSegment.ts:18
Parameters
- Default value withValue: boolean = true
Returns string

Generated using TypeDoc