GroupDto

Defines the properties of the group.


Properties

string
description Optional

Description of the custom group. For enterprise groups the value will be null.


string
displayName Optional

The display name of the group.


string
domain Optional

The domain name of the group.


string
groupType Optional

USER_GROUP is an organization specific custom group, AD_GROUP is a federated domain group, SHARED_GROUP is group owned by another organization and shared with current one.

Possible values are: USER_GROUPAD_GROUPSHARED_GROUP


string
id Optional

Unique identifier of the group.


string
ownerOrgId Optional

Unique identifier (GUID) of the organization that is the owner of the current group.


array of string
sharedOrgIds Optional

Unique identifiers (GUID) of the shared organizations.


integer as int32
usersCount Optional

Number of users in the group.

JSON Example

{
	"description": "string",
	"displayName": "string",
	"domain": "string",
	"groupType": "USER_GROUP",
	"id": "string",
	"ownerOrgId": "string",
	"sharedOrgIds": [
		"string"
	],
	"usersCount": 0
}

Feedback

Was this page helpful?