SecurityContextConstraints [security.openshift.io/v1] - Security APIs | API reference | OpenShift Container Platform 4.4

Specification
API endpoints
- /apis/security.openshift.io/v1/securitycontextconstraints
- /apis/security.openshift.io/v1/securitycontextconstraints/{name}

Description

SecurityContextConstraints governs the ability to make requests that affect the SecurityContext that will be applied to a container. For historical reasons SCC was exposed under the core Kubernetes API group. That exposure is deprecated and will be removed in a future release - users should instead use the security.openshift.io group to manage SecurityContextConstraints.

Type

object

Required

allowHostDirVolumePlugin
allowHostIPC
allowHostNetwork
allowHostPID
allowHostPorts
allowPrivilegedContainer
readOnlyRootFilesystem

Specification

Property Type Description

Property	Type	Description
`.allowHostDirVolumePlugin`	`boolean`	AllowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin
`.allowHostIPC`	`boolean`	AllowHostIPC determines if the policy allows host ipc in the containers.
`.allowHostNetwork`	`boolean`	AllowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec.
`.allowHostPID`	`boolean`	AllowHostPID determines if the policy allows host pid in the containers.
`.allowHostPorts`	`boolean`	AllowHostPorts determines if the policy allows host ports in the containers.
`.allowPrivilegeescalation`	``	AllowPrivilegeescalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.
`.allowPrivilegedContainer`	`boolean`	AllowPrivilegedContainer determines if a container can request to be run as privileged.
`.allowedCapabilities`	``	AllowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field maybe added at the pod author’s discretion. You must not list a capability in both AllowedCapabilities and RequiredDropCapabilities. To allow all capabilities you may use '*'.
`.allowedFlexVolumes`	``	AllowedFlexVolumes is a whitelist of allowed Flexvolumes. empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "Volumes" field.
`.allowedUnsafeSysctls`	``	AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. each entry is either a plain sysctl name or ends in "" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to whitelist all allowed unsafe sysctls explicitly to avoid rejection. examples: e.g. "foo/" allows "foo/bar", "foo/baz", etc. e.g. "foo.*" allows "foo.bar", "foo.baz", etc.
`.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
`.defaultAddCapabilities`	``	DefaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capabiility in both DefaultAddCapabilities and RequiredDropCapabilities.
`.defaultAllowPrivilegeescalation`	``	DefaultAllowPrivilegeescalation controls the default setting for whether a process can gain more privileges than its parent process.
`.forbiddenSysctls`	``	ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of forbidden sysctls. Single means all sysctls are forbidden. examples: e.g. "foo/*" forbids "foo/bar", "foo/baz", etc. e.g. "foo." forbids "foo.bar", "foo.baz", etc.
`.fsGroup`	``	FSGroup is the strategy that will dictate what fs group is used by the SecurityContext.
`.groups`	``	The groups that have permission to use this security context constraints
`.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
`.metadata`	`ObjectMeta meta/v1`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`.priority`	``	Priority influences the sort order of SCCs when evaluating which SCCs to try first for a given pod request based on access in the Users and Groups fields. The higher the int, the higher priority. An unset value is considered a 0 priority. If scores for multiple SCCs are equal they will be sorted from most restrictive to least restrictive. If both priorities and restrictions are equal the SCCs will be sorted by name.
`.readOnlyRootFilesystem`	`boolean`	ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the SCC should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to.
`.requiredDropCapabilities`	``	RequiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.
`.runAsUser`	``	RunAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext.
`.seLinuxContext`	``	SeLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext.
`.seccompProfiles`	``	SeccompProfiles lists the allowed profiles that may be set for the pod or container’s seccomp annotations. An unset (nil) or empty value means that no profiles may be specifid by the pod or container. The wildcard '*' may be used to allow all profiles. When used to generate a value for a pod the first non-wildcard profile will be used as the default.
`.supplementalGroups`	``	SupplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.
`.users`	``	The users who have permissions to use this security context constraints
`.volumes`	``	Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names of a VolumeSource (azureFile, configMap, emptyDir). To allow all volumes you may use "*". To allow no volumes, set to ["none"].

.allowHostDirVolumePlugin

boolean

AllowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin

.allowHostIPC

boolean

AllowHostIPC determines if the policy allows host ipc in the containers.

.allowHostNetwork

boolean

AllowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec.

.allowHostPID

boolean

AllowHostPID determines if the policy allows host pid in the containers.

.allowHostPorts

boolean

AllowHostPorts determines if the policy allows host ports in the containers.

.allowPrivilegeescalation

AllowPrivilegeescalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.

.allowPrivilegedContainer

boolean

AllowPrivilegedContainer determines if a container can request to be run as privileged.

.allowedCapabilities

AllowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field maybe added at the pod author’s discretion. You must not list a capability in both AllowedCapabilities and RequiredDropCapabilities. To allow all capabilities you may use '*'.

.allowedFlexVolumes

AllowedFlexVolumes is a whitelist of allowed Flexvolumes. empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "Volumes" field.

.allowedUnsafeSysctls

AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. each entry is either a plain sysctl name or ends in "" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to whitelist all allowed unsafe sysctls explicitly to avoid rejection. examples: e.g. "foo/" allows "foo/bar", "foo/baz", etc. e.g. "foo.*" allows "foo.bar", "foo.baz", etc.

.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

.defaultAddCapabilities

DefaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capabiility in both DefaultAddCapabilities and RequiredDropCapabilities.

.defaultAllowPrivilegeescalation

DefaultAllowPrivilegeescalation controls the default setting for whether a process can gain more privileges than its parent process.

.forbiddenSysctls

ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. each entry is either a plain sysctl name or ends in "" in which case it is considered as a prefix of forbidden sysctls. Single * means all sysctls are forbidden. examples: e.g. "foo/" forbids "foo/bar", "foo/baz", etc. e.g. "foo.*" forbids "foo.bar", "foo.baz", etc.

.fsGroup

FSGroup is the strategy that will dictate what fs group is used by the SecurityContext.

.groups

The groups that have permission to use this security context constraints

.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

.metadata

ObjectMeta meta/v1

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

.priority

Priority influences the sort order of SCCs when evaluating which SCCs to try first for a given pod request based on access in the Users and Groups fields. The higher the int, the higher priority. An unset value is considered a 0 priority. If scores for multiple SCCs are equal they will be sorted from most restrictive to least restrictive. If both priorities and restrictions are equal the SCCs will be sorted by name.

.readOnlyRootFilesystem

boolean

ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the SCC should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to.

.requiredDropCapabilities

RequiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.

.runAsUser

RunAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext.

.seLinuxContext

SeLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext.

.seccompProfiles

SeccompProfiles lists the allowed profiles that may be set for the pod or container’s seccomp annotations. An unset (nil) or empty value means that no profiles may be specifid by the pod or container. The wildcard '*' may be used to allow all profiles. When used to generate a value for a pod the first non-wildcard profile will be used as the default.

.supplementalGroups

SupplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.

.users

The users who have permissions to use this security context constraints

.volumes

Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names of a VolumeSource (azureFile, configMap, emptyDir). To allow all volumes you may use "*". To allow no volumes, set to ["none"].

API endpoints

The following API endpoints are available:

/apis/security.openshift.io/v1/securitycontextconstraints
- DeLeTe: delete collection of SecurityContextConstraints
- GeT: list objects of kind SecurityContextConstraints
- POST: create SecurityContextConstraints
/apis/security.openshift.io/v1/securitycontextconstraints/{name}
- DeLeTe: delete SecurityContextConstraints
- GeT: read the specified SecurityContextConstraints
- PATCH: partially update the specified SecurityContextConstraints
- PUT: replace the specified SecurityContextConstraints

/apis/security.openshift.io/v1/securitycontextconstraints

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

HTTP method: DeLeTe
Description: delete collection of SecurityContextConstraints

Table 2. Query parameters
Parameter	Type	Description
`allowWatchBookmarks`	`boolean`	allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 Resourceexpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	empty

HTTP method: GeT
Description: list objects of kind SecurityContextConstraints

Table 4. Query parameters
Parameter	Type	Description
`allowWatchBookmarks`	`boolean`	allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 Resourceexpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`SecurityContextConstraintsList security.openshift.io/v1`
401 - Unauthorized	empty

HTTP method: POST
Description: create SecurityContextConstraints

Table 6. 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.

Table 7. Body parameters
Parameter	Type	Description
`body`	`SecurityContextConstraints security.openshift.io/v1`

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`SecurityContextConstraints security.openshift.io/v1`
201 - Created	`SecurityContextConstraints security.openshift.io/v1`
202 - Accepted	`SecurityContextConstraints security.openshift.io/v1`
401 - Unauthorized	empty

/apis/security.openshift.io/v1/securitycontextconstraints/{name}

Table 9. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the SecurityContextConstraints

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

HTTP method: DeLeTe
Description: delete SecurityContextConstraints

Table 11. 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
`gracePeriodSeconds`	`integer`	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents`	`boolean`	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. either this field or PropagationPolicy may be set, but not both.
`propagationPolicy`	`string`	Whether and how garbage collection will be performed. either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

Table 12. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions meta/v1`

Table 13. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
202 - Accepted	`Status meta/v1`
401 - Unauthorized	empty

HTTP method: GeT
Description: read the specified SecurityContextConstraints

Table 14. Query parameters
Parameter	Type	Description
`resourceVersion`	`string`	When specified: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

Table 15. HTTP responses
HTTP code	Reponse body
200 - OK	`SecurityContextConstraints security.openshift.io/v1`
401 - Unauthorized	empty

HTTP method: PATCH
Description: partially update the specified SecurityContextConstraints

Table 16. 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.

Table 17. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`SecurityContextConstraints security.openshift.io/v1`
401 - Unauthorized	empty

HTTP method: PUT
Description: replace the specified SecurityContextConstraints

Table 19. 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.

Table 20. Body parameters
Parameter	Type	Description
`body`	`SecurityContextConstraints security.openshift.io/v1`

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`SecurityContextConstraints security.openshift.io/v1`
201 - Created	`SecurityContextConstraints security.openshift.io/v1`
401 - Unauthorized	empty