POST /apis/rbac.authorization.k8s.io/v1beta1/rolebindings HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "RoleBinding",
"apiVersion": "rbac.authorization.k8s.io/v1beta1",
...
}
×
v1beta1.RoleBinding
- Description
- Object Schema
- Operations
- Create a RoleBinding
- Create a RoleBinding in a namespace
- Get a RoleBinding in a namespace
- Get all RoleBindings
- Get all RoleBindings in a namespace
- Watch a RoleBinding in a namespace
- Watch all RoleBindings
- Watch all RoleBindings in a namespace
- Update a RoleBinding in a namespace
- Patch a RoleBinding in a namespace
- Delete a RoleBinding in a namespace
- Delete all RoleBindings in a namespace
Description
RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.
Object Schema
Expand or mouse-over a field for more information about it.
apiVersion:kind:metadata:
annotations:
[string]:clusterName:creationTimestamp:deletionGracePeriodSeconds:deletionTimestamp:finalizers:
- [string]:generateName:generation:initializers:
pending:
- name:result:
apiVersion:code:details:
causes:
- field:message:reason:group:kind:name:retryAfterSeconds:uid:kind:message:metadata:
resourceVersion:selfLink:reason:status:labels:
[string]:name:namespace:ownerReferences:
- apiVersion:blockOwnerDeletion:controller:kind:name:uid:resourceVersion:selfLink:uid:roleRef:
apiGroup:kind:name:subjects:
- apiGroup:kind:name:namespace:
Operations
Create a RoleBinding
Create a RoleBinding
HTTP request
Curl request
$ curl -k \
-X POST \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/rolebindings <<'EOF'
{
"kind": "RoleBinding",
"apiVersion": "rbac.authorization.k8s.io/v1beta1",
...
}
EOF
Create a RoleBinding in a namespace
Create a RoleBinding
HTTP request
POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/rolebindings HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "RoleBinding",
"apiVersion": "rbac.authorization.k8s.io/v1beta1",
...
}
Curl request
$ curl -k \
-X POST \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/rolebindings <<'EOF'
{
"kind": "RoleBinding",
"apiVersion": "rbac.authorization.k8s.io/v1beta1",
...
}
EOF
Get a RoleBinding in a namespace
Read the specified RoleBinding
HTTP request
GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/rolebindings/$NAME HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/rolebindings/$NAME
Get all RoleBindings
List or watch objects of kind RoleBinding
HTTP request
GET /apis/rbac.authorization.k8s.io/v1beta1/rolebindings HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/rolebindings
Query parameters
| Parameter | Description |
|---|---|
pretty |
If 'true', then the output is pretty printed. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
resourceVersion |
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 |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Get all RoleBindings in a namespace
List or watch objects of kind RoleBinding
HTTP request
GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/rolebindings HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/rolebindings
Path parameters
| Parameter | Description |
|---|---|
namespace |
object name and auth scope, such as for teams and projects |
Query parameters
| Parameter | Description |
|---|---|
pretty |
If 'true', then the output is pretty printed. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
resourceVersion |
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 |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Watch a RoleBinding in a namespace
Watch changes to an object of kind RoleBinding
HTTP request
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/$NAMESPACE/rolebindings/$NAME HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/$NAMESPACE/rolebindings/$NAME
Path parameters
| Parameter | Description |
|---|---|
name |
name of the RoleBinding |
namespace |
object name and auth scope, such as for teams and projects |
Query parameters
| Parameter | Description |
|---|---|
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
pretty |
If 'true', then the output is pretty printed. |
resourceVersion |
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 |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Watch all RoleBindings
Watch individual changes to a list of RoleBinding
HTTP request
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/rolebindings HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/watch/rolebindings
Query parameters
| Parameter | Description |
|---|---|
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
pretty |
If 'true', then the output is pretty printed. |
resourceVersion |
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 |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Watch all RoleBindings in a namespace
Watch individual changes to a list of RoleBinding
HTTP request
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/$NAMESPACE/rolebindings HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/$NAMESPACE/rolebindings
Path parameters
| Parameter | Description |
|---|---|
namespace |
object name and auth scope, such as for teams and projects |
Query parameters
| Parameter | Description |
|---|---|
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
pretty |
If 'true', then the output is pretty printed. |
resourceVersion |
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 |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Update a RoleBinding in a namespace
Replace the specified RoleBinding
HTTP request
PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/rolebindings/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "RoleBinding",
"apiVersion": "rbac.authorization.k8s.io/v1beta1",
...
}
Curl request
$ curl -k \
-X PUT \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/rolebindings/$NAME <<'EOF'
{
"kind": "RoleBinding",
"apiVersion": "rbac.authorization.k8s.io/v1beta1",
...
}
EOF
Patch a RoleBinding in a namespace
Partially update the specified RoleBinding
HTTP request
PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/rolebindings/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'
{
...
}
Curl request
$ curl -k \
-X PATCH \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json-patch+json' \
https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/rolebindings/$NAME <<'EOF'
{
...
}
EOF
Path parameters
| Parameter | Description |
|---|---|
name |
name of the RoleBinding |
namespace |
object name and auth scope, such as for teams and projects |
Delete a RoleBinding in a namespace
Delete a RoleBinding
HTTP request
DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/rolebindings/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
...
}
Curl request
$ curl -k \
-X DELETE \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/rolebindings/$NAME <<'EOF'
{
...
}
EOF
Path parameters
| Parameter | Description |
|---|---|
name |
name of the RoleBinding |
namespace |
object name and auth scope, such as for teams and projects |
Query parameters
| Parameter | Description |
|---|---|
pretty |
If 'true', then the output is pretty printed. |
gracePeriodSeconds |
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 |
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 |
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. |
Delete all RoleBindings in a namespace
Delete collection of RoleBinding
HTTP request
DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/rolebindings HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
Curl request
$ curl -k \
-X DELETE \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/rolebindings
Path parameters
| Parameter | Description |
|---|---|
namespace |
object name and auth scope, such as for teams and projects |
Query parameters
| Parameter | Description |
|---|---|
pretty |
If 'true', then the output is pretty printed. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
resourceVersion |
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 |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |