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


Description

RoleBindingRestriction is an object that can be matched against a subject (user, group, or service account) to determine whether rolebindings on that subject are allowed in the namespace to which the RoleBindingRestriction belongs. If any one of those RoleBindingRestriction objects matches a subject, rolebindings on that subject in the namespace are allowed.

Type

object

Required
  • metadata

  • 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/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

.metadata

ObjectMeta meta/v1

Standard object’s metadata.

.spec

object

RoleBindingRestrictionSpec defines a rolebinding restriction. Exactly one field must be non-nil.

.spec
Description

RoleBindingRestrictionSpec defines a rolebinding restriction. Exactly one field must be non-nil.

Type

object

Required
  • userrestriction

  • grouprestriction

  • serviceaccountrestriction

Property Type Description

grouprestriction

object

GroupRestriction matches a group either by a string match on the group name or a label selector applied to group labels.

serviceaccountrestriction

object

ServiceAccountRestriction matches a service account by a string match on either the service-account name or the name of the service account’s namespace.

userrestriction

object

UserRestriction matches a user either by a string match on the user name, a string match on the name of a group to which the user belongs, or a label selector applied to the user labels.

.spec.grouprestriction
Description

GroupRestriction matches a group either by a string match on the group name or a label selector applied to group labels.

Type

object

Required
  • groups

  • labels

Property Type Description

groups

array (string)

Groups is a list of groups used to match against an individual user’s groups. If the user is a member of one of the whitelisted groups, the user is allowed to be bound to a role.

labels

array (LabelSelector meta/v1)

Selectors specifies a list of label selectors over group labels.

.spec.serviceaccountrestriction
Description

ServiceAccountRestriction matches a service account by a string match on either the service-account name or the name of the service account’s namespace.

Type

object

Required
  • serviceaccounts

  • namespaces

Property Type Description

namespaces

array (string)

Namespaces specifies a list of literal namespace names.

serviceaccounts

array

ServiceAccounts specifies a list of literal service-account names.

serviceaccounts[]

object

ServiceAccountReference specifies a service account and namespace by their names.

.spec.serviceaccountrestriction.serviceaccounts
Description

ServiceAccounts specifies a list of literal service-account names.

Type

array

.spec.serviceaccountrestriction.serviceaccounts[]
Description

ServiceAccountReference specifies a service account and namespace by their names.

Type

object

Required
  • name

  • namespace

Property Type Description

name

string

Name is the name of the service account.

namespace

string

Namespace is the namespace of the service account. Service accounts from inside the whitelisted namespaces are allowed to be bound to roles. If Namespace is empty, then the namespace of the RoleBindingRestriction in which the ServiceAccountReference is embedded is used.

.spec.userrestriction
Description

UserRestriction matches a user either by a string match on the user name, a string match on the name of a group to which the user belongs, or a label selector applied to the user labels.

Type

object

Required
  • users

  • groups

  • labels

Property Type Description

groups

array (string)

Groups specifies a list of literal group names.

labels

array (LabelSelector meta/v1)

Selectors specifies a list of label selectors over user labels.

users

array (string)

Users specifies a list of literal user names.

API endpoints

The following API endpoints are available:

  • /apis/authorization.openshift.io/v1/rolebindingrestrictions

    • GET: list or watch objects of kind RoleBindingRestriction

  • /apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindingrestrictions

    • DELETE: delete collection of RoleBindingRestriction

    • GET: list or watch objects of kind RoleBindingRestriction

    • POST: create a RoleBindingRestriction

  • /apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindingrestrictions/{name}

    • DELETE: delete a RoleBindingRestriction

    • GET: read the specified RoleBindingRestriction

    • PATCH: partially update the specified RoleBindingRestriction

    • PUT: replace the specified RoleBindingRestriction

/apis/authorization.openshift.io/v1/rolebindingrestrictions

Table 1. Global guery parameters
Parameter Type Description

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 indicating the client must restart their list without the continue field. 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.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

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.

pretty

string

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

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.

HTTP method

GET

Description

list or watch objects of kind RoleBindingRestriction

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

RoleBindingRestrictionList authorization.openshift.io/v1

401 - Unauthorized

Empty

/apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindingrestrictions

Table 3. Global path parameters
Parameter Type Description

namespace

string

object name and auth scope, such as for teams and projects

Table 4. Global guery parameters
Parameter Type Description

pretty

string

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

HTTP method

DELETE

Description

delete collection of RoleBindingRestriction

Table 5. Query parameters
Parameter Type Description

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 indicating the client must restart their list without the continue field. 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.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

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 6. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

401 - Unauthorized

Empty

HTTP method

GET

Description

list or watch objects of kind RoleBindingRestriction

Table 7. Query parameters
Parameter Type Description

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 indicating the client must restart their list without the continue field. 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.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

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 8. HTTP responses
HTTP code Reponse body

200 - OK

RoleBindingRestrictionList authorization.openshift.io/v1

401 - Unauthorized

Empty

HTTP method

POST

Description

create a RoleBindingRestriction

Table 9. Body parameters
Parameter Type Description

body

RoleBindingRestriction authorization.openshift.io/v1

Table 10. HTTP responses
HTTP code Reponse body

200 - OK

RoleBindingRestriction authorization.openshift.io/v1

201 - Created

RoleBindingRestriction authorization.openshift.io/v1

202 - Accepted

RoleBindingRestriction authorization.openshift.io/v1

401 - Unauthorized

Empty

/apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindingrestrictions/{name}

Table 11. Global path parameters
Parameter Type Description

name

string

name of the RoleBindingRestriction

namespace

string

object name and auth scope, such as for teams and projects

Table 12. Global guery parameters
Parameter Type Description

pretty

string

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

HTTP method

DELETE

Description

delete a RoleBindingRestriction

Table 13. Query parameters
Parameter Type Description

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 14. Body parameters
Parameter Type Description

body

DeleteOptions meta/v1

Table 15. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

401 - Unauthorized

Empty

HTTP method

GET

Description

read the specified RoleBindingRestriction

Table 16. Query parameters
Parameter Type Description

exact

boolean

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

export

boolean

Should this value be exported. Export strips fields that a user can not specify.

Table 17. HTTP responses
HTTP code Reponse body

200 - OK

RoleBindingRestriction authorization.openshift.io/v1

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update the specified RoleBindingRestriction

Table 18. Body parameters
Parameter Type Description

body

Patch meta/v1

Table 19. HTTP responses
HTTP code Reponse body

200 - OK

RoleBindingRestriction authorization.openshift.io/v1

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace the specified RoleBindingRestriction

Table 20. Body parameters
Parameter Type Description

body

RoleBindingRestriction authorization.openshift.io/v1

Table 21. HTTP responses
HTTP code Reponse body

200 - OK

RoleBindingRestriction authorization.openshift.io/v1

201 - Created

RoleBindingRestriction authorization.openshift.io/v1

401 - Unauthorized

Empty