PingOne Platform APIs

Sign-On Policies Operations

The sign-on policies endpoints provide common operations to create and manage sign-on policies resources.

You need the Environment Admin role to perform operations on sign-on policy resources.

Sign-on policies data model

Property Type Required? Mutable? Description

createdAt

Date

N/A

Read-only

The time the resource was created.

default

Boolean

Required

Mutable

Indicates whether this sign-on policy is the environment’s default that is used by applications that do not have application-specific sign-on policy assignments. This property can only be set to true, in which case the isDefault property of all other sign-on policies are set to false.

description

String

Optional

Mutable

The description of the sign-on policy.

environment.id

String

Required

Immutable

The environment resource’s unique identifier associated with the sign-on policy.

id

String

N/A

Read-only

The sign-on policy resource’s unique identifier.

name

String

Required

Mutable

Rhe resource name. The name must be unique within the environment, and can consist of either a string of alphanumeric letters, underscore, hyphen, period: {caret}[a-zA-Z0-9_.-]+$ or an absolute URI if the string contains a ":" character.

updatedAt

Date

N/A

Read-only

The time the resource was last updated.

Sign-on policies 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.

404

The requested resource was not found.