PodSecurityPolicySubjectReview [security.openshift.io/v1] - security.openshift.io | API reference

Important

Azure Red Hat OpenShift 3.11 will be retired 30 June 2022. Support for creation of new Azure Red Hat OpenShift 3.11 clusters continues through 30 November 2020. Following retirement, remaining Azure Red Hat OpenShift 3.11 clusters will be shut down to prevent security vulnerabilities.

Follow this guide to create an Azure Red Hat OpenShift 4 cluster. If you have specific questions, please contact us

Specification
API endpoints
- /apis/security.openshift.io/v1/namespaces/{namespace}/podsecuritypolicysubjectreviews

Description

PodSecurityPolicySubjectReview checks whether a particular user/SA tuple can create the PodTemplateSpec.

Type

object

Required

spec

Specification

Property Type Description

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/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/api-conventions.md#types-kinds
`.spec`	`object`	PodSecurityPolicySubjectReviewSpec defines specification for PodSecurityPolicySubjectReview
`.status`	`object`	PodSecurityPolicySubjectReviewStatus contains information/status for PodSecurityPolicySubjectReview.

.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/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/api-conventions.md#types-kinds

.spec

object

PodSecurityPolicySubjectReviewSpec defines specification for PodSecurityPolicySubjectReview

.status

object

PodSecurityPolicySubjectReviewStatus contains information/status for PodSecurityPolicySubjectReview.

.spec

Description

PodSecurityPolicySubjectReviewSpec defines specification for PodSecurityPolicySubjectReview

Type

object

Required

template

Property Type Description

Property	Type	Description
`groups`	`array (string)`	groups is the groups you’re testing for.
`template`	`PodTemplateSpec core/v1`	template is the PodTemplateSpec to check. If template.spec.serviceAccountName is empty it will not be defaulted. If its non-empty, it will be checked.
`user`	`string`	user is the user you’re testing for. If you specify "user" but not "group", then is it interpreted as "What if user were not a member of any groups. If user and groups are empty, then the check is performed using only the serviceAccountName in the template.

groups

array (string)

groups is the groups you’re testing for.

template

PodTemplateSpec core/v1

template is the PodTemplateSpec to check. If template.spec.serviceAccountName is empty it will not be defaulted. If its non-empty, it will be checked.

user

string

user is the user you’re testing for. If you specify "user" but not "group", then is it interpreted as "What if user were not a member of any groups. If user and groups are empty, then the check is performed using only the serviceAccountName in the template.

.status

Description: PodSecurityPolicySubjectReviewStatus contains information/status for PodSecurityPolicySubjectReview.
Type: object

Property Type Description

Property	Type	Description
`allowedBy`	`ObjectReference 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.
`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.

allowedBy

ObjectReference 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.

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}/podsecuritypolicysubjectreviews
- POST: create a PodSecurityPolicySubjectReview

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

Table 1. Global path parameters
Parameter	Type	Description
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 2. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: POST
Description: create a PodSecurityPolicySubjectReview

Table 3. Body parameters
Parameter	Type	Description
`body`	`PodSecurityPolicySubjectReview security.openshift.io/v1`

Table 4. HTTP responses
HTTP code	Reponse body
200 - OK	`PodSecurityPolicySubjectReview security.openshift.io/v1`
201 - Created	`PodSecurityPolicySubjectReview security.openshift.io/v1`
202 - Accepted	`PodSecurityPolicySubjectReview security.openshift.io/v1`
401 - Unauthorized	Empty