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

Interface: IPublicGroupData

Object representing a group of an organization retrieved. Contains also the diagnoses of the operation.

Hierarchy

• IPublicGroup

• IPublicHttpResponseData

↳ IPublicGroupData

Table of contents

Properties

• $diagnoses
• associatedIdpRoles
• description
• id
• locked
• name

Properties

$diagnoses

• Optional $diagnoses: IPublicHttpDiagnose[]

Array of diagnoses.

Inherited from

IPublicHttpResponseData.$diagnoses

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.

Inherited from

IPublicGroup.associatedIdpRoles

description

• Optional description: string

The description of the group.

Inherited from

IPublicGroup.description

id

• id: string

The id of the group.

Inherited from

IPublicGroup.id

locked

• locked: boolean

Lock the group allows to prevent its deletion.

Inherited from

IPublicGroup.locked

name

• name: string

The name of the group.

Inherited from

IPublicGroup.name