v1.Role

v1.Role

Description

Role is a logical grouping of PolicyRules that can be referenced as a unit by RoleBindings.

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:
rules:
- apiGroups:
- - [string]:
  attributeRestrictions:
    Raw:
  nonResourceURLs:
  - [string]:
  resourceNames:
  - [string]:
  resources:
  - [string]:
  verbs:
  - [string]:

Operations

Create a Role

HTTP request

POST /apis/authorization.openshift.io/v1/roles HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "Role",
  "apiVersion": "authorization.openshift.io/v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/authorization.openshift.io/v1/roles <<'EOF'
{
  "kind": "Role",
  "apiVersion": "authorization.openshift.io/v1",
  ...
}
EOF

HTTP body

Parameter	Schema
body	v1.Role

Query parameters

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

Responses

HTTP Code	Schema
200 OK	v1.Role
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Create a Role in a namespace

Create a Role

HTTP request

POST /apis/authorization.openshift.io/v1/namespaces/$NAMESPACE/roles HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "Role",
  "apiVersion": "authorization.openshift.io/v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/authorization.openshift.io/v1/namespaces/$NAMESPACE/roles <<'EOF'
{
  "kind": "Role",
  "apiVersion": "authorization.openshift.io/v1",
  ...
}
EOF

HTTP body

Parameter	Schema
body	v1.Role

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.

Responses

HTTP Code	Schema
200 OK	v1.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

GET /apis/authorization.openshift.io/v1/namespaces/$NAMESPACE/roles/$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/authorization.openshift.io/v1/namespaces/$NAMESPACE/roles/$NAME

Path parameters

Parameter	Description
name	name of the Role
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.

Responses

HTTP Code	Schema
200 OK	v1.Role
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Get all Roles

List objects of kind Role

HTTP request

GET /apis/authorization.openshift.io/v1/roles 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/authorization.openshift.io/v1/roles

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.

Responses

HTTP Code	Schema
200 OK	v1.RoleList
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

Get all Roles in a namespace

List objects of kind Role

HTTP request

GET /apis/authorization.openshift.io/v1/namespaces/$NAMESPACE/roles 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/authorization.openshift.io/v1/namespaces/$NAMESPACE/roles

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.

Responses

HTTP Code	Schema
200 OK	v1.RoleList
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

Update a Role in a namespace

Replace the specified Role

HTTP request

PUT /apis/authorization.openshift.io/v1/namespaces/$NAMESPACE/roles/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "Role",
  "apiVersion": "authorization.openshift.io/v1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/apis/authorization.openshift.io/v1/namespaces/$NAMESPACE/roles/$NAME <<'EOF'
{
  "kind": "Role",
  "apiVersion": "authorization.openshift.io/v1",
  ...
}
EOF

HTTP body

Parameter	Schema
body	v1.Role

Path parameters

Parameter	Description
name	name of the Role
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.

Responses

HTTP Code	Schema
200 OK	v1.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

PATCH /apis/authorization.openshift.io/v1/namespaces/$NAMESPACE/roles/$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/authorization.openshift.io/v1/namespaces/$NAMESPACE/roles/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter	Schema
body	v1.Patch

Path parameters

Parameter	Description
name	name of the Role
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.

Responses

HTTP Code	Schema
200 OK	v1.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

DELETE /apis/authorization.openshift.io/v1/namespaces/$NAMESPACE/roles/$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/authorization.openshift.io/v1/namespaces/$NAMESPACE/roles/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter	Schema
body	v1.DeleteOptions

Path parameters

Parameter	Description
name	name of the Role
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.

Responses

HTTP Code	Schema
200 OK	v1.Status
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf