Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GroupContractProperties

Package version

Group contract Properties.

Hierarchy

  • GroupContractProperties

Index

Properties

Properties

Optional builtIn

builtIn: undefined | false | true

true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

Group description. Can contain HTML formatting tags.

displayName

displayName: string

Group name.

Optional externalId

externalId: undefined | string

For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

Optional type

type: GroupType

Group type.

Generated using TypeDoc