v1beta1.Role

    You are viewing documentation for a release that is no longer supported. The latest supported version of version 3 is [3.11]. For the most recent version 4, see

    Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

    Expand or mouse-over a field for more information about it.

    Create a Role

    HTTP request

    2. Authorization: Bearer $TOKEN
    3. Accept: application/json
    4. Connection: close
    6. {
    7.   "kind": "Role",
    8.   "apiVersion": "rbac.authorization.k8s.io/v1beta1",
    9.   ...
    10. }

    Curl request

    1. $ curl -k \
    2.     -X POST \
    3.     -d @- \
    4.     -H "Authorization: Bearer $TOKEN" \
    5.     -H 'Accept: application/json' \
    6.     -H 'Content-Type: application/json' \
    7.     https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/roles <<'EOF'
    8. {
    9.   "kind": "Role",
    10.   "apiVersion": "rbac.authorization.k8s.io/v1beta1",
    11.   ...
    12. }
    13. EOF

    HTTP body

    Query parameters

    ParameterDescription

    pretty

    If ‘true’, then the output is pretty printed.

    Responses

    HTTP CodeSchema

    200 OK

    v1beta1.Role

    401 Unauthorized

    Consumes

    • */*

    Produces

    • application/json

    • application/yaml

    • application/vnd.kubernetes.protobuf

    Create a Role in a namespace

    Create a Role

    HTTP request

    1. POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/roles HTTP/1.1
    2. Authorization: Bearer $TOKEN
    3. Accept: application/json
    4. Connection: close
    5. Content-Type: application/json'
    7. {
    8.   "kind": "Role",
    9.   "apiVersion": "rbac.authorization.k8s.io/v1beta1",
    10.   ...
    11. }

    Curl request

    1. $ curl -k \
    2.     -X POST \
    3.     -d @- \
    4.     -H "Authorization: Bearer $TOKEN" \
    5.     -H 'Accept: application/json' \
    6.     -H 'Content-Type: application/json' \
    7.     https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/roles <<'EOF'
    8. {
    9.   "kind": "Role",
    10.   "apiVersion": "rbac.authorization.k8s.io/v1beta1",
    11.   ...
    12. }
    13. EOF

    HTTP body

    ParameterSchema

    body

    v1beta1.Role

    Path parameters

    ParameterDescription

    namespace

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

    Query parameters

    ParameterDescription

    pretty

    If ‘true’, then the output is pretty printed.

    Responses

    HTTP CodeSchema

    200 OK

    v1beta1.Role

    401 Unauthorized

    Consumes

    • */*

    Produces

    • application/json

    • application/yaml

    • application/vnd.kubernetes.protobuf

    Get a Role in a namespace

    Read the specified Role

    HTTP request

    1. GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/roles/$NAME HTTP/1.1
    2. Authorization: Bearer $TOKEN
    3. Accept: application/json
    4. Connection: close

    Curl request

    2.     -H "Authorization: Bearer $TOKEN" \
    3.     -H 'Accept: application/json' \
    4.     https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/roles/$NAME

    Path parameters

    ParameterDescription

    name

    name of the Role

    namespace

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

    Query parameters

    ParameterDescription

    pretty

    If ‘true’, then the output is pretty printed.

    Responses

    HTTP CodeSchema

    200 OK

    v1beta1.Role

    401 Unauthorized

    Consumes

    • */*

    Produces

    • application/json

    • application/yaml

    • application/vnd.kubernetes.protobuf

    Get all Roles

    List or watch objects of kind Role

    HTTP request

    1. GET /apis/rbac.authorization.k8s.io/v1beta1/roles HTTP/1.1
    2. Authorization: Bearer $TOKEN
    3. Accept: application/json
    4. Connection: close

    Curl request

    Query parameters

    ParameterDescription

    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.

    Responses

    HTTP CodeSchema

    200 OK

    v1beta1.RoleList

    401 Unauthorized

    Consumes

    • */*

    Produces

    • application/json

    • application/yaml

    • application/vnd.kubernetes.protobuf

    • application/json;stream=watch

    • application/vnd.kubernetes.protobuf;stream=watch

    List or watch objects of kind Role

    HTTP request

    1. GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/roles HTTP/1.1
    2. Authorization: Bearer $TOKEN
    3. Accept: application/json
    4. Connection: close

    Curl request

    1. $ curl -k \
    2.     -H "Authorization: Bearer $TOKEN" \
    3.     -H 'Accept: application/json' \
    4.     https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/roles

    Path parameters

    Query parameters

    ParameterDescription

    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

    Responses

    HTTP CodeSchema

    200 OK

    v1beta1.RoleList

    401 Unauthorized

    Consumes

    • */*

    Produces

    • application/json

    • application/yaml

    • application/vnd.kubernetes.protobuf

    • application/json;stream=watch

    • application/vnd.kubernetes.protobuf;stream=watch

    Watch a Role in a namespace

    Watch changes to an object of kind Role

    HTTP request

    1. GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/$NAMESPACE/roles/$NAME HTTP/1.1
    2. Authorization: Bearer $TOKEN
    3. Accept: application/json
    4. Connection: close

    Curl request

    1. $ curl -k \
    2.     -H "Authorization: Bearer $TOKEN" \
    3.     -H 'Accept: application/json' \
    4.     https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/$NAMESPACE/roles/$NAME

    Path parameters

    ParameterDescription

    name

    name of the Role

    namespace

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

    Query parameters

    ParameterDescription

    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.

    Responses

    HTTP CodeSchema

    200 OK

    v1.WatchEvent

    401 Unauthorized

    Consumes

    • */*

    Produces

    • application/json

    • application/yaml

    • application/vnd.kubernetes.protobuf

    • application/json;stream=watch

    • application/vnd.kubernetes.protobuf;stream=watch

    Watch all Roles

    Watch individual changes to a list of Role

    HTTP request

    1. GET /apis/rbac.authorization.k8s.io/v1beta1/watch/roles HTTP/1.1
    2. Authorization: Bearer $TOKEN
    3. Accept: application/json
    4. Connection: close

    Curl request

    1.     -H "Authorization: Bearer $TOKEN" \
    2.     -H 'Accept: application/json' \
    3.     https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/watch/roles

    Query parameters

    ParameterDescription

    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.

    Responses

    HTTP CodeSchema

    200 OK

    v1.WatchEvent

    401 Unauthorized

    Consumes

    • */*

    Produces

    • application/json

    • application/yaml

    • application/vnd.kubernetes.protobuf

    • application/json;stream=watch

    • application/vnd.kubernetes.protobuf;stream=watch

    Watch all Roles in a namespace

    Watch individual changes to a list of Role

    HTTP request

    1. GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/$NAMESPACE/roles HTTP/1.1
    2. Authorization: Bearer $TOKEN
    3. Accept: application/json
    4. Connection: close

    Curl request

    Path parameters

    ParameterDescription

    namespace

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

    Query parameters

    ParameterDescription

    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.

    Responses

    HTTP CodeSchema

    200 OK

    v1.WatchEvent

    401 Unauthorized

    Consumes

    • */*

    Produces

    • application/json

    • application/vnd.kubernetes.protobuf

    • application/json;stream=watch

    • application/vnd.kubernetes.protobuf;stream=watch

    Replace the specified Role

    HTTP request

    1. PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/roles/$NAME HTTP/1.1
    2. Authorization: Bearer $TOKEN
    3. Accept: application/json
    4. Connection: close
    5. Content-Type: application/json'
    7. {
    8.   "kind": "Role",
    9.   "apiVersion": "rbac.authorization.k8s.io/v1beta1",
    10.   ...
    11. }

    Curl request

    1. $ curl -k \
    2.     -X PUT \
    3.     -d @- \
    4.     -H "Authorization: Bearer $TOKEN" \
    5.     -H 'Accept: application/json' \
    7.     https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/roles/$NAME <<'EOF'
    8. {
    9.   "kind": "Role",
    10.   "apiVersion": "rbac.authorization.k8s.io/v1beta1",
    11.   ...
    12. }
    13. EOF

    HTTP body

    ParameterSchema

    body

    v1beta1.Role

    Path parameters

    Query parameters

    ParameterDescription

    pretty

    If ‘true’, then the output is pretty printed.

    Responses

    HTTP CodeSchema

    200 OK

    v1beta1.Role

    401 Unauthorized

    Consumes

    • */*

    Produces

    • application/json

    • application/yaml

    • application/vnd.kubernetes.protobuf

    Patch a Role in a namespace

    Partially update the specified Role

    HTTP request

    1. PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/roles/$NAME HTTP/1.1
    2. Authorization: Bearer $TOKEN
    3. Accept: application/json
    4. Connection: close
    5. Content-Type: application/json-patch+json'
    7. {
    8.   ...
    9. }

    Curl request

    1. $ curl -k \
    2.     -X PATCH \
    3.     -d @- \
    4.     -H "Authorization: Bearer $TOKEN" \
    5.     -H 'Accept: application/json' \
    6.     -H 'Content-Type: application/json-patch+json' \
    7.     https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/roles/$NAME <<'EOF'
    8. {
    9.   ...
    10. }
    11. EOF

    HTTP body

    ParameterSchema

    body

    v1.Patch

    Path parameters

    ParameterDescription

    name

    name of the Role

    namespace

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

    Query parameters

    ParameterDescription

    pretty

    If ‘true’, then the output is pretty printed.

    Responses

    HTTP CodeSchema

    200 OK

    v1beta1.Role

    401 Unauthorized

    Consumes

    • application/json-patch+json

    • application/merge-patch+json

    • application/strategic-merge-patch+json

    Produces

    • application/json

    • application/yaml

    • application/vnd.kubernetes.protobuf

    Delete a Role in a namespace

    Delete a Role

    HTTP request

    1. DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/roles/$NAME HTTP/1.1
    2. Authorization: Bearer $TOKEN
    3. Accept: application/json
    4. Connection: close
    5. Content-Type: application/json'
    7. {
    8.   ...
    9. }

    Curl request

    1. $ curl -k \
    2.     -X DELETE \
    3.     -d @- \
    4.     -H "Authorization: Bearer $TOKEN" \
    5.     -H 'Accept: application/json' \
    6.     -H 'Content-Type: application/json' \
    7.     https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/roles/$NAME <<'EOF'
    8. {
    9.   ...
    10. }
    11. EOF

    HTTP body

    ParameterSchema

    body

    v1.DeleteOptions

    Path parameters

    ParameterDescription

    name

    name of the Role

    namespace

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

    Query parameters

    ParameterDescription

    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.

    Responses

    HTTP CodeSchema

    200 OK

    v1.Status

    401 Unauthorized

    Consumes

    • */*

    Produces

    • application/json

    • application/yaml

    • application/vnd.kubernetes.protobuf

    Delete all Roles in a namespace

    Delete collection of Role

    HTTP request

    1. DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/$NAMESPACE/roles HTTP/1.1
    2. Authorization: Bearer $TOKEN
    3. Accept: application/json
    4. Connection: close

    Curl request

    Path parameters

    ParameterDescription

    namespace

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

    Query parameters

    Responses

    HTTP CodeSchema

    200 OK

    v1.Status

    401 Unauthorized

    Consumes

    • */*

    Produces

    • application/json

    • application/yaml