Authorization Policies
Authorization policies specify the statements (directives that instruct the policy decision service to perform additional processing in conjunction with an authorization decision), conditions (authorization logic comparing one thing to another), and combining algorithms (the process for combining multiple rules) to determine an authorization decision.
|
For detailed information about policies, refer to Policies in the PingOne Cloud Platform Administrator Guide. |
Authorization policies data model
| Property | Type? | Required? | Mutable? | Description |
|---|---|---|---|---|
|
Array |
Optional |
Mutable |
The list of child policies or rules. Can be either referenced or embedded. |
|
Object |
Required |
Immutable |
The algorithm that determines how rules are combined to produce an authorization decision. For details, refer to Authorization Rules. |
|
Object |
Optional |
Mutable |
The authorization condition object. For details, refer to Authorization Conditions. |
|
String |
Optional |
Mutable |
The authorization policy resource’s description. |
|
Boolean |
Optional |
Mutable |
The setting that determines whether the decision node is evaluated. The default value is |
|
String |
N/A |
Read only |
The policy resource’s unique identifier. |
|
String |
Required |
Mutable |
A user-friendly policy name. The |
|
Object |
Optional |
Mutable |
Applies the policy to each item of the specific attribute, filtered by decision. |
|
Object |
Optional |
Mutable |
The source associated with this rule. |
|
String |
Optional |
Mutable |
The UUID of the repetition source associated with this rule. |
|
String |
Optional |
Mutable |
The decision filter. Options are |
|
Object |
Optional |
Mutable |
The authorization statements object. Can be either referenced or embedded. For details, refer to Authorization Statements. |
|
String |
Required |
Mutable |
The attribute type. Options are |
|
String |
Required |
Read only |
A random ID generated by the system for concurrency control purposes. |
Authorization embedded policies data model
| Property | Type? | Required? | Mutable? | Description |
|---|---|---|---|---|
|
String |
Required |
Mutable |
The embedded policy type. Options are |
|
String |
Required |
Immutable |
The embedded policy ID. |
|
String |
Required |
Mutable |
The embedded policy name. |
|
String |
Optional |
Mutable |
The embedded policy description. |
|
Boolean |
Optional |
Mutable |
Specifies whether the embedded policy is enabled. |
|
Object |
Optional |
Mutable |
The statements associated with this embedded policy. |
|
Object |
Optional |
Mutable |
The conditions associated with this embedded policy. |
|
Object |
Required |
Mutable |
The combining algorithm for the embedded policy. |
|
Array |
Optional |
Mutable |
The list of sub-child policies or rules associated with the embedded policy. |
|
Object |
Optional |
Mutable |
The repitition settings associated with the embedded policy. |
Authorization policies embedded rules data model
| Property | Type? | Required? | Mutable? | Description |
|---|---|---|---|---|
|
String |
Required |
Mutable |
The embedded rule type. Options are |
|
String |
Required |
Immutable |
The embedded rule ID. |
|
String |
Optional |
Mutable |
The embedded rule name. |
|
String |
Optional |
Mutable |
The child policy description. |
|
Boolean |
Optional |
Mutable |
Specifies whether the child policy is enabled. |
|
Object |
Optional |
Mutable |
The statements associated with this child policy. |
|
Object |
Optional |
Mutable |
The conditions associated with this child policy. |
|
Object |
Required |
Immutable |
The settings that determine how the children are combined to produce an outcome for the policy. |
Event types
The audit reporting events applicable to the authorize policies service are:
| Topic | Event |
|---|---|
|
|
|
|
|
|
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. |