Populations

In PingOne, populations are similar to an organizational unit (OU) and are used to simplify user and policy management within a given environment. For example, you can create a population for similar types of users, such as those in a particular region or job function, and assign those users a unique password policy.

The /environments/{{envID}}/populations endpoint provides operations to create, read, update, and delete population resources within a specified environment.

Before you can create users, you must have at least one existing population. When you create a user, you can assign them to a specified population. If you do not specify a population, PingOne adds the new user to the default population. You can configure any population to be the default population, either at the time of creation or at a later time.

Individual users cannot belong to more than one population within a PingOne environment. However, you can move users to a different population within the existing environment.

Learn more in Populations, in the PingOne Admin Guide.

Populations data model

Property Type Required? Mutable? Description

Property	Type	Required?	Mutable?	Description
`alternatveIdentifiers`	String[]	Optional	Mutable	Alternative identifiers that can be used to search for populations besides `name`.
`createdAt`	Date	N/A	Read-only	The time the resource was created.
`default`	String	Required	Mutable	The population to use as the default population for the environment. Only one population per environment can be the default. New users are assigned to the default population if it exists, and the Population ID is not provided in the Create User request.
`description`	String	Optional	Mutable	The description of the population.
`environment.id`	String	Required	Immutable	The environment resource’s unique identifier associated with the population.
`id`	String	Required/Optional	Immutable	The resource’s unique identifier. This is optional if you’re setting PingOne as the default identity provider using PUT Update Population Default IdP.
`name`	String	Required	Mutable	The population name, which must be provided and must be unique within an environment.
`preferredLanguage`	String	Optional	Mutable	The language locale for the population. If absent, the environment default is used.
`updatedAt`	Date	N/A	Read-only	The time the resource was last updated.
`userCount`	Integer	N/A	Read-only	The number of users that belong to the population.
`passwordPolicy`	Object	Optional	Mutable	The object reference to the password policy resource.
`passwordPolicy.id`	String	Optional	Immutable	The ID of the password policy that is used for this population. If absent, the environment’s default is used.
`theme`	Object	Optional	Mutable	The object reference to the theme resource.
`theme.id`	String	Optional	Immutable	The ID of the theme to use for the population. If absent, the environment’s default is used.

alternatveIdentifiers

String[]

Optional

Mutable

Alternative identifiers that can be used to search for populations besides name.

createdAt

Date

N/A

Read-only

The time the resource was created.

default

String

Required

Mutable

The population to use as the default population for the environment. Only one population per environment can be the default. New users are assigned to the default population if it exists, and the Population ID is not provided in the Create User request.

description

String

Optional

Mutable

The description of the population.

environment.id

String

Required

Immutable

The environment resource’s unique identifier associated with the population.

id

String

Required/Optional

Immutable

The resource’s unique identifier. This is optional if you’re setting PingOne as the default identity provider using PUT Update Population Default IdP.

name

String

Required

Mutable

The population name, which must be provided and must be unique within an environment.

preferredLanguage

String

Optional

Mutable

The language locale for the population. If absent, the environment default is used.

updatedAt

Date

N/A

Read-only

The time the resource was last updated.

userCount

Integer

N/A

Read-only

The number of users that belong to the population.

passwordPolicy

Object

Optional

Mutable

The object reference to the password policy resource.

passwordPolicy.id

String

Optional

Immutable

The ID of the password policy that is used for this population. If absent, the environment’s default is used.

theme

Object

Optional

Mutable

The object reference to the theme resource.

theme.id

String

Optional

Immutable

The ID of the theme to use for the population. If absent, the environment’s default is used.

Populations events generated

Refer to Audit Reporting Events for the events generated.

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.
404	The requested resource was not found.

PingOne Platform APIs

Populations

Populations data model

Populations events generated

Response codes