PingAuthorize API Reference

Policy Sets

A policy set in PingAuthorize is a container for one or more policies. These endpoints provide the ability to create, read, update, and delete policy sets in the PingAuthorize policy manager.

For detailed information about PingAuthorize policy sets, refer to Policy management in the PingAuthorize Policy Administration Guide.

Authorization policy set data model

Property Type? Required? Mutable? Description

children

Array

Optional

Mutable

References of the child policies and policy sets.

combiningAlgorithm

Object

Required

Immutable

Governs how the children are combined to produce an outcome for the policy set

condition

Object

Optional

Mutable

An object representing the targeting condition within the policy set.

description

String

Optional

Mutable

The authorization policy set resource’s description.

disabled

Boolean

Optional

Mutable

Whether the policy set is disabled or not.

id

String

N/A

Read only

The policy set resource’s unique identifier.

name

String

Required

Mutable

The name of the policy set.

shared

Boolean

N/A

N/A

Whether the policy set is shared or not.

statements

String

Optional

Mutable

A collection of statement IDs.

targets

String

N/A

N/A

A collection of Target IDs.

type

String

Required

Mutable

The attribute type. Value is always PolicySet.

version

String

Required

Read only

The unique version ID of the policy set.

Authorization policy set representation data model

Property Type? Required? Mutable? Description

children

Array

Optional

Mutable

Child policies and policy sets, either in the form of a new in-line policy / policy set (PolicyRepresentation / policy setRepresentation), or a reference to a library policy / policy set (PolicyNodeReference).

combiningAlgorithm

Object

Required

Immutable

Governs how the children are combined to produce an outcome for the policy set.

condition

Object

Optional

Mutable

An object representing the targeting condition within the policy set.

description

String

Optional

Mutable

The authorization policy set resource’s description.

disabled

Boolean

Optional

Mutable

Whether the policy set is disabled or not

id

String

N/A

Read only

The policy set resource’s unique identifier.

name

String

Required

Mutable

The name of the policy set.

shared

Boolean

N/A

N/A

Whether the policy set is shared or not.

statements

Object

Optional

Mutable

A collection of Statement IDs.

targets

String

N/A

N/A

A collection of Target IDs.

version

String

Required

Read only

The unique version ID of the policy set.

Policy node representation

Either a PolicyRepresentation, PolicySetRepresentation, or PolicyNodeReference.

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.

404

The requested resource was not found.