This is a cache of https://docs.openshift.com/container-platform/4.15/rest_api/security_apis/podsecuritypolicyreview-security-openshift-io-v1.html. It is a snapshot of the page at 2024-11-05T13:46:16.649+0000.
PodSecurityPolicyReview [security.openshift.io/v1] - Security APIs | API reference | OpenShift Container Platform 4.15
×
Description

PodSecurityPolicyReview checks which service accounts (not users, since that would be cluster-wide) can create the PodTemplateSpec in question.

Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

Type

object

Required
  • spec

Specification

Property Type Description

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

spec

object

PodSecurityPolicyReviewSpec defines specification for PodSecurityPolicyReview

status

object

PodSecurityPolicyReviewStatus represents the status of PodSecurityPolicyReview.

.spec

Description

PodSecurityPolicyReviewSpec defines specification for PodSecurityPolicyReview

Type

object

Required
  • template

Property Type Description

serviceAccountNames

array (string)

serviceAccountNames is an optional set of serviceAccounts to run the check with. If serviceAccountNames is empty, the template.spec.serviceAccountName is used, unless it’s empty, in which case "default" is used instead. If serviceAccountNames is specified, template.spec.serviceAccountName is ignored.

template

PodTemplateSpec

template is the PodTemplateSpec to check. The template.spec.serviceAccountName field is used if serviceAccountNames is empty, unless the template.spec.serviceAccountName is empty, in which case "default" is used. If serviceAccountNames is specified, template.spec.serviceAccountName is ignored.

.status

Description

PodSecurityPolicyReviewStatus represents the status of PodSecurityPolicyReview.

Type

object

Required
  • allowedserviceAccounts

Property Type Description

allowedserviceAccounts

array

allowedserviceAccounts returns the list of service accounts in this namespace that have the power to create the PodTemplateSpec.

allowedserviceAccounts[]

object

serviceAccountPodSecurityPolicyReviewStatus represents serviceAccount name and related review status

.status.allowedserviceAccounts

Description

allowedserviceAccounts returns the list of service accounts in this namespace that have the power to create the PodTemplateSpec.

Type

array

.status.allowedserviceAccounts[]

Description

serviceAccountPodSecurityPolicyReviewStatus represents serviceAccount name and related review status

Type

object

Required
  • name

Property Type Description

allowedBy

ObjectReference

allowedBy is a reference to the rule that allows the PodTemplateSpec. A rule can be a SecurityContextConstraint or a PodSecurityPolicy A nil, indicates that it was denied.

name

string

name contains the allowed and the denied serviceAccount name

reason

string

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available.

template

PodTemplateSpec

template is the PodTemplateSpec after the defaulting is applied.

API endpoints

The following API endpoints are available:

  • /apis/security.openshift.io/v1/namespaces/{namespace}/podsecuritypolicyreviews

    • POST: create a PodSecurityPolicyReview

/apis/security.openshift.io/v1/namespaces/{namespace}/podsecuritypolicyreviews

Table 1. Global query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP method

POST

Description

create a PodSecurityPolicyReview

Table 2. Body parameters
Parameter Type Description

body

PodSecurityPolicyReview schema

Table 3. HTTP responses
HTTP code Reponse body

200 - OK

PodSecurityPolicyReview schema

201 - Created

PodSecurityPolicyReview schema

202 - Accepted

PodSecurityPolicyReview schema

401 - Unauthorized

Empty