Groups
The groups API endpoint supports operations to manage PingCentral groups.
|
The groups endpoint is only available in PingCentral deployments with SSO enabled. |
Group data model
| Property | Type | Description |
|---|---|---|
created |
string |
(Read-only) The time and date when the PingCentral group was created. |
description |
string |
The description of the PingCentral group. Limited to 512 characters. |
displayName |
string |
The display name of the PingCentral group. Limited to 255 characters. |
id |
string |
(Read-only) The ID of the PingCentral group. This field is required when updating an existing group as part of a PUT request. |
members |
array[UserSummaryView] |
A list of PingCentral users which are members of the group. |
modified |
string |
(Read-only) The time and date when the PingCentral group was last modified. |
name * |
string |
The name of the PingCentral group. Limited to 255 characters. |
source * |
string |
The source of the group. Limited to 256 characters. |
UserSummaryView data model
| Property | Type | Description |
|---|---|---|
firstName * |
string |
The first name of the user. |
id |
string |
(Read-only) The ID of the PingCentral user. This field is ignored during a PUT operation. |
lastName * |
string |
The last name of the user. |
source * |
string |
The source of the user. Limited to 256 characters. |
username * |
string |
The user name of the user. Limited to 78 characters. |