ClusterRoleBinding

apiVersion: rbac.authorization.k8s.io/v1

import "k8s.io/api/rbac/v1"

ClusterRoleBinding

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.

---

• apiVersion: rbac.authorization.k8s.io/v1

• kind: ClusterRoleBinding

• metadata (ObjectMeta)

  Standard object's metadata.

• roleRef (RoleRef), required

  RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.

  RoleRef contains information that points to the role being used

  • roleRef.apiGroup (string), required

    APIGroup is the group for the resource being referenced

  • roleRef.kind (string), required

    Kind is the type of resource being referenced

  • roleRef.name (string), required

    Name is the name of resource being referenced

• subjects ([]Subject)

  Subjects holds references to the objects the role applies to.

  Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.

  • subjects.kind (string), required

    Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.

  • subjects.name (string), required

    Name of the object being referenced.

  • subjects.apiGroup (string)

    APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.

  • subjects.namespace (string)

    Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.

ClusterRoleBindingList

ClusterRoleBindingList is a collection of ClusterRoleBindings

---

• apiVersion: rbac.authorization.k8s.io/v1

• kind: ClusterRoleBindingList

• metadata (ListMeta)

  Standard object's metadata.

• items ([]ClusterRoleBinding), required

  Items is a list of ClusterRoleBindings

Operations

---

get read the specified ClusterRoleBinding

HTTP Request

GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}

Parameters

• name (in path): string, required

  name of the ClusterRoleBinding

• pretty (in query): string

  pretty

Response

200 (ClusterRoleBinding): OK

401: Unauthorized

list list or watch objects of kind ClusterRoleBinding

HTTP Request

GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings

Parameters

• allowWatchBookmarks (in query): boolean

  allowWatchBookmarks

• continue (in query): string

  continue

• fieldSelector (in query): string

  fieldSelector

• labelSelector (in query): string

  labelSelector

• limit (in query): integer

  limit

• pretty (in query): string

  pretty

• resourceVersion (in query): string

  resourceVersion

• resourceVersionMatch (in query): string

  resourceVersionMatch

• timeoutSeconds (in query): integer

  timeoutSeconds

• watch (in query): boolean

  watch

Response

200 (ClusterRoleBindingList): OK

401: Unauthorized

create create a ClusterRoleBinding

HTTP Request

POST /apis/rbac.authorization.k8s.io/v1/clusterrolebindings

Parameters

• body: ClusterRoleBinding, required

• dryRun (in query): string

  dryRun

• fieldManager (in query): string

  fieldManager

• fieldValidation (in query): string

  fieldValidation

• pretty (in query): string

  pretty

Response

200 (ClusterRoleBinding): OK

201 (ClusterRoleBinding): Created

202 (ClusterRoleBinding): Accepted

401: Unauthorized

update replace the specified ClusterRoleBinding

HTTP Request

PUT /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}

Parameters

• name (in path): string, required

  name of the ClusterRoleBinding

• body: ClusterRoleBinding, required

• dryRun (in query): string

  dryRun

• fieldManager (in query): string

  fieldManager

• fieldValidation (in query): string

  fieldValidation

• pretty (in query): string

  pretty

Response

200 (ClusterRoleBinding): OK

201 (ClusterRoleBinding): Created

401: Unauthorized

patch partially update the specified ClusterRoleBinding

HTTP Request

PATCH /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}

Parameters

• name (in path): string, required

  name of the ClusterRoleBinding

• body: Patch, required

• dryRun (in query): string

  dryRun

• fieldManager (in query): string

  fieldManager

• fieldValidation (in query): string

  fieldValidation

• force (in query): boolean

  force

• pretty (in query): string

  pretty

Response

200 (ClusterRoleBinding): OK

201 (ClusterRoleBinding): Created

401: Unauthorized

delete delete a ClusterRoleBinding

HTTP Request

DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}

Parameters

• name (in path): string, required

  name of the ClusterRoleBinding

• body: DeleteOptions

• dryRun (in query): string

  dryRun

• gracePeriodSeconds (in query): integer

  gracePeriodSeconds

• pretty (in query): string

  pretty

• propagationPolicy (in query): string

  propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

deletecollection delete collection of ClusterRoleBinding

HTTP Request

DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings

Parameters

• body: DeleteOptions

• continue (in query): string

  continue

• dryRun (in query): string

  dryRun

• fieldSelector (in query): string

  fieldSelector

• gracePeriodSeconds (in query): integer

  gracePeriodSeconds

• labelSelector (in query): string

  labelSelector

• limit (in query): integer

  limit

• pretty (in query): string

  pretty

• propagationPolicy (in query): string

  propagationPolicy

• resourceVersion (in query): string

  resourceVersion

• resourceVersionMatch (in query): string

  resourceVersionMatch

• timeoutSeconds (in query): integer

  timeoutSeconds

Response

200 (Status): OK

401: Unauthorized