Soon, all Red Hat OpenShift documentation will only be available on docs.redhat.com, the official location of all Red Hat product documentation. Get familiar with the updated experience today!
  1. Documentation
×

PodSecurityPolicyReview [security.openshift.io/v1]

Description

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

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 core/v1

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_v2 core/v1

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 core/v1

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 path parameters
Parameter Type Description

namespace

string

object name and auth scope, such as for teams and projects
Table 2. 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

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

pretty

string

If 'true', then the output is pretty printed.
HTTP method

POST

Description

create a PodSecurityPolicyReview

Table 3. Body parameters
Parameter Type Description

body

PodSecurityPolicyReview security.openshift.io/v1
Table 4. HTTP responses
HTTP code Reponse body

200 - OK

PodSecurityPolicyReview security.openshift.io/v1