Skip to content

Latest commit

 

History

History
1297 lines (862 loc) · 82.9 KB

RbacAuthorizationV1Api.md

File metadata and controls

1297 lines (862 loc) · 82.9 KB

\RbacAuthorizationV1Api

All URIs are relative to https://localhost

Method HTTP request Description
CreateClusterRole Post /apis/rbac.authorization.k8s.io/v1/clusterroles
CreateClusterRoleBinding Post /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
CreateNamespacedRole Post /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
CreateNamespacedRoleBinding Post /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
DeleteClusterRole Delete /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
DeleteClusterRoleBinding Delete /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
DeleteCollectionClusterRole Delete /apis/rbac.authorization.k8s.io/v1/clusterroles
DeleteCollectionClusterRoleBinding Delete /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
DeleteCollectionNamespacedRole Delete /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
DeleteCollectionNamespacedRoleBinding Delete /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
DeleteNamespacedRole Delete /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
DeleteNamespacedRoleBinding Delete /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
GetAPIResources Get /apis/rbac.authorization.k8s.io/v1/
ListClusterRole Get /apis/rbac.authorization.k8s.io/v1/clusterroles
ListClusterRoleBinding Get /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
ListNamespacedRole Get /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
ListNamespacedRoleBinding Get /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
ListRoleBindingForAllNamespaces Get /apis/rbac.authorization.k8s.io/v1/rolebindings
ListRoleForAllNamespaces Get /apis/rbac.authorization.k8s.io/v1/roles
PatchClusterRole Patch /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
PatchClusterRoleBinding Patch /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
PatchNamespacedRole Patch /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
PatchNamespacedRoleBinding Patch /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
ReadClusterRole Get /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
ReadClusterRoleBinding Get /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
ReadNamespacedRole Get /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
ReadNamespacedRoleBinding Get /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
ReplaceClusterRole Put /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
ReplaceClusterRoleBinding Put /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
ReplaceNamespacedRole Put /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
ReplaceNamespacedRoleBinding Put /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}

CreateClusterRole

V1ClusterRole CreateClusterRole(ctx, body, optional)

create a ClusterRole

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
body V1ClusterRole
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
body V1ClusterRole
pretty string If 'true', then the output is pretty printed.

Return type

V1ClusterRole

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateClusterRoleBinding

V1ClusterRoleBinding CreateClusterRoleBinding(ctx, body, optional)

create a ClusterRoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
body V1ClusterRoleBinding
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
body V1ClusterRoleBinding
pretty string If 'true', then the output is pretty printed.

Return type

V1ClusterRoleBinding

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateNamespacedRole

V1Role CreateNamespacedRole(ctx, namespace, body, optional)

create a Role

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
namespace string object name and auth scope, such as for teams and projects
body V1Role
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
namespace string object name and auth scope, such as for teams and projects
body V1Role
pretty string If 'true', then the output is pretty printed.

Return type

V1Role

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateNamespacedRoleBinding

V1RoleBinding CreateNamespacedRoleBinding(ctx, namespace, body, optional)

create a RoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
namespace string object name and auth scope, such as for teams and projects
body V1RoleBinding
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
namespace string object name and auth scope, such as for teams and projects
body V1RoleBinding
pretty string If 'true', then the output is pretty printed.

Return type

V1RoleBinding

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteClusterRole

V1Status DeleteClusterRole(ctx, name, body, optional)

delete a ClusterRole

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
name string name of the ClusterRole
body V1DeleteOptions
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
name string name of the ClusterRole
body V1DeleteOptions
pretty string If 'true', then the output is pretty printed.
gracePeriodSeconds int32 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 bool 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.

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteClusterRoleBinding

V1Status DeleteClusterRoleBinding(ctx, name, body, optional)

delete a ClusterRoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
name string name of the ClusterRoleBinding
body V1DeleteOptions
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
name string name of the ClusterRoleBinding
body V1DeleteOptions
pretty string If 'true', then the output is pretty printed.
gracePeriodSeconds int32 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 bool 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.

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteCollectionClusterRole

V1Status DeleteCollectionClusterRole(ctx, optional)

delete collection of ClusterRole

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
pretty string If 'true', then the output is pretty printed.
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 bool 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 int32 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 int32 Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch bool Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteCollectionClusterRoleBinding

V1Status DeleteCollectionClusterRoleBinding(ctx, optional)

delete collection of ClusterRoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
pretty string If 'true', then the output is pretty printed.
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 bool 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 int32 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 int32 Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch bool Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteCollectionNamespacedRole

V1Status DeleteCollectionNamespacedRole(ctx, namespace, optional)

delete collection of Role

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
namespace string object name and auth scope, such as for teams and projects
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
namespace string object name and auth scope, such as for teams and projects
pretty string If 'true', then the output is pretty printed.
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 bool 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 int32 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 int32 Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch bool Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteCollectionNamespacedRoleBinding

V1Status DeleteCollectionNamespacedRoleBinding(ctx, namespace, optional)

delete collection of RoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
namespace string object name and auth scope, such as for teams and projects
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
namespace string object name and auth scope, such as for teams and projects
pretty string If 'true', then the output is pretty printed.
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 bool 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 int32 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 int32 Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch bool Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteNamespacedRole

V1Status DeleteNamespacedRole(ctx, name, namespace, body, optional)

delete a Role

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
name string name of the Role
namespace string object name and auth scope, such as for teams and projects
body V1DeleteOptions
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
name string name of the Role
namespace string object name and auth scope, such as for teams and projects
body V1DeleteOptions
pretty string If 'true', then the output is pretty printed.
gracePeriodSeconds int32 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 bool 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.

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteNamespacedRoleBinding

V1Status DeleteNamespacedRoleBinding(ctx, name, namespace, body, optional)

delete a RoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
name string name of the RoleBinding
namespace string object name and auth scope, such as for teams and projects
body V1DeleteOptions
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
name string name of the RoleBinding
namespace string object name and auth scope, such as for teams and projects
body V1DeleteOptions
pretty string If 'true', then the output is pretty printed.
gracePeriodSeconds int32 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 bool 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.

Return type

V1Status

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAPIResources

V1ApiResourceList GetAPIResources(ctx, )

get available resources

Required Parameters

This endpoint does not need any parameter.

Return type

V1ApiResourceList

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json, application/yaml, application/vnd.kubernetes.protobuf
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListClusterRole

V1ClusterRoleList ListClusterRole(ctx, optional)

list or watch objects of kind ClusterRole

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
pretty string If 'true', then the output is pretty printed.
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 bool 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 int32 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 int32 Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch bool Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Return type

V1ClusterRoleList

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListClusterRoleBinding

V1ClusterRoleBindingList ListClusterRoleBinding(ctx, optional)

list or watch objects of kind ClusterRoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
pretty string If 'true', then the output is pretty printed.
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 bool 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 int32 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 int32 Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch bool Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Return type

V1ClusterRoleBindingList

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListNamespacedRole

V1RoleList ListNamespacedRole(ctx, namespace, optional)

list or watch objects of kind Role

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
namespace string object name and auth scope, such as for teams and projects
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
namespace string object name and auth scope, such as for teams and projects
pretty string If 'true', then the output is pretty printed.
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 bool 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 int32 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 int32 Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch bool Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Return type

V1RoleList

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListNamespacedRoleBinding

V1RoleBindingList ListNamespacedRoleBinding(ctx, namespace, optional)

list or watch objects of kind RoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
namespace string object name and auth scope, such as for teams and projects
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
namespace string object name and auth scope, such as for teams and projects
pretty string If 'true', then the output is pretty printed.
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 bool 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 int32 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 int32 Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch bool Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Return type

V1RoleBindingList

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListRoleBindingForAllNamespaces

V1RoleBindingList ListRoleBindingForAllNamespaces(ctx, optional)

list or watch objects of kind RoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
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 bool 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 int32 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 int32 Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch bool Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Return type

V1RoleBindingList

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListRoleForAllNamespaces

V1RoleList ListRoleForAllNamespaces(ctx, optional)

list or watch objects of kind Role

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
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 bool 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 int32 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 int32 Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch bool Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Return type

V1RoleList

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchClusterRole

V1ClusterRole PatchClusterRole(ctx, name, body, optional)

partially update the specified ClusterRole

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
name string name of the ClusterRole
body interface{}
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
name string name of the ClusterRole
body interface{}
pretty string If 'true', then the output is pretty printed.

Return type

V1ClusterRole

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchClusterRoleBinding

V1ClusterRoleBinding PatchClusterRoleBinding(ctx, name, body, optional)

partially update the specified ClusterRoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
name string name of the ClusterRoleBinding
body interface{}
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
name string name of the ClusterRoleBinding
body interface{}
pretty string If 'true', then the output is pretty printed.

Return type

V1ClusterRoleBinding

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchNamespacedRole

V1Role PatchNamespacedRole(ctx, name, namespace, body, optional)

partially update the specified Role

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
name string name of the Role
namespace string object name and auth scope, such as for teams and projects
body interface{}
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
name string name of the Role
namespace string object name and auth scope, such as for teams and projects
body interface{}
pretty string If 'true', then the output is pretty printed.

Return type

V1Role

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchNamespacedRoleBinding

V1RoleBinding PatchNamespacedRoleBinding(ctx, name, namespace, body, optional)

partially update the specified RoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
name string name of the RoleBinding
namespace string object name and auth scope, such as for teams and projects
body interface{}
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
name string name of the RoleBinding
namespace string object name and auth scope, such as for teams and projects
body interface{}
pretty string If 'true', then the output is pretty printed.

Return type

V1RoleBinding

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReadClusterRole

V1ClusterRole ReadClusterRole(ctx, name, optional)

read the specified ClusterRole

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
name string name of the ClusterRole
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
name string name of the ClusterRole
pretty string If 'true', then the output is pretty printed.

Return type

V1ClusterRole

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReadClusterRoleBinding

V1ClusterRoleBinding ReadClusterRoleBinding(ctx, name, optional)

read the specified ClusterRoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
name string name of the ClusterRoleBinding
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
name string name of the ClusterRoleBinding
pretty string If 'true', then the output is pretty printed.

Return type

V1ClusterRoleBinding

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReadNamespacedRole

V1Role ReadNamespacedRole(ctx, name, namespace, optional)

read the specified Role

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
name string name of the Role
namespace string object name and auth scope, such as for teams and projects
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
name string name of the Role
namespace string object name and auth scope, such as for teams and projects
pretty string If 'true', then the output is pretty printed.

Return type

V1Role

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReadNamespacedRoleBinding

V1RoleBinding ReadNamespacedRoleBinding(ctx, name, namespace, optional)

read the specified RoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
name string name of the RoleBinding
namespace string object name and auth scope, such as for teams and projects
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
name string name of the RoleBinding
namespace string object name and auth scope, such as for teams and projects
pretty string If 'true', then the output is pretty printed.

Return type

V1RoleBinding

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReplaceClusterRole

V1ClusterRole ReplaceClusterRole(ctx, name, body, optional)

replace the specified ClusterRole

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
name string name of the ClusterRole
body V1ClusterRole
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
name string name of the ClusterRole
body V1ClusterRole
pretty string If 'true', then the output is pretty printed.

Return type

V1ClusterRole

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReplaceClusterRoleBinding

V1ClusterRoleBinding ReplaceClusterRoleBinding(ctx, name, body, optional)

replace the specified ClusterRoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
name string name of the ClusterRoleBinding
body V1ClusterRoleBinding
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
name string name of the ClusterRoleBinding
body V1ClusterRoleBinding
pretty string If 'true', then the output is pretty printed.

Return type

V1ClusterRoleBinding

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReplaceNamespacedRole

V1Role ReplaceNamespacedRole(ctx, name, namespace, body, optional)

replace the specified Role

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
name string name of the Role
namespace string object name and auth scope, such as for teams and projects
body V1Role
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
name string name of the Role
namespace string object name and auth scope, such as for teams and projects
body V1Role
pretty string If 'true', then the output is pretty printed.

Return type

V1Role

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReplaceNamespacedRoleBinding

V1RoleBinding ReplaceNamespacedRoleBinding(ctx, name, namespace, body, optional)

replace the specified RoleBinding

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
name string name of the RoleBinding
namespace string object name and auth scope, such as for teams and projects
body V1RoleBinding
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
name string name of the RoleBinding
namespace string object name and auth scope, such as for teams and projects
body V1RoleBinding
pretty string If 'true', then the output is pretty printed.

Return type

V1RoleBinding

Authorization

BearerToken

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]