The users API endpoints support operations to create, read, update, and delete user resources. The users endpoints allow you to add users directly to PingCentral and manage their access through the application. To complete a user’s profile in PingCentral, you need their first and last names, user names, and their assigned roles.

User view data model

Property Type Description
confirmpassword * string The confirm password for the user.
firstName * string The first name of the user.
groups array[GroupSummaryView] A list of PingCentral groups which the user is a member of. This field is only applicable if PingCentral is configured in SSO mode.
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.
password * string The password for the user.
role * string The role 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.

GroupSummaryView 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.
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.

Response codes

Code Message
200 Successful operation.
201 Successfully created.
204 Successfully removed. No content.
400 The request could not be completed.
401 You do not have access to this resource.
403 You do not have permissions or are not licensed to make this request, or your license is exceeded.
404 The requested resource was not found.
500 An unexpected error occurred.