PingOne Platform APIs - Early Access

Authorization Processors

Authorization processors transform the data coming from the resolvers. Processors manipulate and transform data, including extracting details from structured data, or converting data to different formats. These endpoints provide operations to create, read, update, and delete authorizaton processor resources.

For detailed information about processor resources in the PingOne Authorize trust framework, refer to Processors in the PingOne Cloud Platform Administrator Guide.

Authorization processors data model

Property Type? Required? Mutable? Description

description

String

Optional

Mutable

The authorization processor resource’s description.

fullName

String

Required

Mutable

A unique name generated by the system for each authorization processor resource. It is the concatenation of names in the processor resource hierarchy.

id

String

N/A

Read only

The resource’s unique identifier.

name

String

Required

Mutable

A user-friendly authorization processor name.

parent

Object

Optional

Mutable

The authorization processor resource’s parent.

parent.id

String

Optional

Mutable

The authorization processor resource’s parent ID.

processor

Object

Optional

Mutable

The authorization processor resource’s processor object.

processor.type

String

Optional

Mutable

The authorization processor resource’s processor type. Options are JSON_PATH, SPEL, XPATH, COLLECTION_FILTER, COLLECTION_TRANSFORM, CHAIN, REFERENCE. Refer to Authorization processors processor type data model for additional properties for each processor type.

processor.name

String

Optional

Mutable

A user-friendly authorization processor name. The name value must be unique.

type

String

Optional

Mutable

The processor resource’s processor type. Options are PROCESSOR.

version

String

Required

Read only

A random ID generated by the system for concurrency control purposes.

Authorization processors processor type data model

Processor type Description

JSON_PATH

The JSON path expression processor. Additional properties are:

* expression, the JSON path expression.

* valueType, the output type for the value. Options are BOOLEAN, STRING, NUMBER, XML, JSON, COLLECTION, DATE_TIME, LOCAL_TIME, LOCAL_DATE, LOCAL_DATE_TIME.

CHAIN

The CHAIN processor. Additional properties are:

* processors, the list of processors to apply in the given order.

COLLECTION_FILTER

The collection filter processor. Additional properties are:

* predicate, the XPath expression.

COLLECTION_TRANSFORM

The collection transform processor. Additional properties are:

* processors, the list of processors to apply in the given order.

REFERENCE

The reference processor. Additional properties are:

* processor, the processor object.

* processor.id, the ID of an authorization processor.

SPEL

The SpEL expression processor. Additional properties are:

* expression, the SpEL expression.

* valueType, the output type for the value. Options are BOOLEAN, STRING, NUMBER, XML, JSON, COLLECTION, DATE_TIME, LOCAL_TIME, LOCAL_DATE, LOCAL_DATE_TIME.

XPATH

The XPath expression processor. Additional properties are:

* expression, the XPath expression.

* valueType, the output type for the value. Options are BOOLEAN, STRING, NUMBER, XML, JSON, COLLECTION, DATE_TIME, LOCAL_TIME, LOCAL_DATE, LOCAL_DATE_TIME.

Event types

The audit reporting events applicable to the authorize processors service are:

Topic Event

authorize-model

AUTHORIZE_PROCESSOR.CREATED

authorize-model

AUTHORIZE_PROCESSOR.UPDATED

authorize-model

AUTHORIZE_PROCESSOR.DELETED

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.