@ubstream/ubstream-node-client-sdk / Exports / IPublicGroup

Interface: IPublicGroup

Object representing information about a group.

Hierarchy

• IPublicGroup

↳ IPublicGroupData

Table of contents

Properties

• associatedIdpRoles
• description
• id
• locked
• name

Properties

associatedIdpRoles

• Optional associatedIdpRoles: string[]

List of remote roles associated to group for users automatically join/leave group during connection from identity provider. A user with one of this remote roles will join this group at connection time. A user without one of this remote roles will leave this group at connection time if array length equal zero.

description

• Optional description: string

The description of the group.

id

• id: string

The id of the group.

locked

• locked: boolean

Lock the group allows to prevent its deletion.

name

• name: string

The name of the group.