Yu Liao b227345fb2 generated API change

2022-02-14 14:12:02 -08:00

22 KiB

Raw Blame History

kubernetes.client.AuthorizationV1Api

All URIs are relative to http://localhost

Method	HTTP request	Description
create_namespaced_local_subject_access_review	POST /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews
create_self_subject_access_review	POST /apis/authorization.k8s.io/v1/selfsubjectaccessreviews
create_self_subject_rules_review	POST /apis/authorization.k8s.io/v1/selfsubjectrulesreviews
create_subject_access_review	POST /apis/authorization.k8s.io/v1/subjectaccessreviews
get_api_resources	GET /apis/authorization.k8s.io/v1/

create_namespaced_local_subject_access_review

V1LocalSubjectAccessReview create_namespaced_local_subject_access_review(namespace, body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)

create a LocalSubjectAccessReview

Example

Api Key Authentication (BearerToken):

from __future__ import print_function
import time
import kubernetes.client
from kubernetes.client.rest import ApiException
from pprint import pprint
configuration = kubernetes.client.Configuration()
# Configure API key authorization: BearerToken
configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API kubernetes.client
with kubernetes.client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kubernetes.client.AuthorizationV1Api(api_client)
    namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes.client.V1LocalSubjectAccessReview() # V1LocalSubjectAccessReview | 
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
field_validation = 'field_validation_example' # str | fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in  this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. (optional)
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)

    try:
        api_response = api_instance.create_namespaced_local_subject_access_review(namespace, body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthorizationV1Api->create_namespaced_local_subject_access_review: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str	object name and auth scope, such as for teams and projects
body	V1LocalSubjectAccessReview
dry_run	str	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed	[optional]
field_manager	str	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.	[optional]
field_validation	str	fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.	[optional]
pretty	str	If 'true', then the output is pretty printed.	[optional]

Return type

V1LocalSubjectAccessReview

Authorization

BearerToken

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
201	Created	-
202	Accepted	-
401	Unauthorized	-

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

create_self_subject_access_review

V1SelfSubjectAccessReview create_self_subject_access_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)

create a SelfSubjectAccessReview

Example

Api Key Authentication (BearerToken):

from __future__ import print_function
import time
import kubernetes.client
from kubernetes.client.rest import ApiException
from pprint import pprint
configuration = kubernetes.client.Configuration()
# Configure API key authorization: BearerToken
configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API kubernetes.client
with kubernetes.client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kubernetes.client.AuthorizationV1Api(api_client)
    body = kubernetes.client.V1SelfSubjectAccessReview() # V1SelfSubjectAccessReview | 
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
field_validation = 'field_validation_example' # str | fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in  this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. (optional)
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)

    try:
        api_response = api_instance.create_self_subject_access_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthorizationV1Api->create_self_subject_access_review: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	V1SelfSubjectAccessReview
dry_run	str	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed	[optional]
field_manager	str	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.	[optional]
field_validation	str	fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.	[optional]
pretty	str	If 'true', then the output is pretty printed.	[optional]

Return type

V1SelfSubjectAccessReview

Authorization

BearerToken

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
201	Created	-
202	Accepted	-
401	Unauthorized	-

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

create_self_subject_rules_review

V1SelfSubjectRulesReview create_self_subject_rules_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)

create a SelfSubjectRulesReview

Example

Api Key Authentication (BearerToken):

from __future__ import print_function
import time
import kubernetes.client
from kubernetes.client.rest import ApiException
from pprint import pprint
configuration = kubernetes.client.Configuration()
# Configure API key authorization: BearerToken
configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API kubernetes.client
with kubernetes.client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kubernetes.client.AuthorizationV1Api(api_client)
    body = kubernetes.client.V1SelfSubjectRulesReview() # V1SelfSubjectRulesReview | 
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
field_validation = 'field_validation_example' # str | fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in  this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. (optional)
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)

    try:
        api_response = api_instance.create_self_subject_rules_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthorizationV1Api->create_self_subject_rules_review: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	V1SelfSubjectRulesReview
dry_run	str	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed	[optional]
field_manager	str	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.	[optional]
field_validation	str	fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.	[optional]
pretty	str	If 'true', then the output is pretty printed.	[optional]

Return type

V1SelfSubjectRulesReview

Authorization

BearerToken

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
201	Created	-
202	Accepted	-
401	Unauthorized	-

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

create_subject_access_review

V1SubjectAccessReview create_subject_access_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)

create a SubjectAccessReview

Example

Api Key Authentication (BearerToken):

from __future__ import print_function
import time
import kubernetes.client
from kubernetes.client.rest import ApiException
from pprint import pprint
configuration = kubernetes.client.Configuration()
# Configure API key authorization: BearerToken
configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API kubernetes.client
with kubernetes.client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kubernetes.client.AuthorizationV1Api(api_client)
    body = kubernetes.client.V1SubjectAccessReview() # V1SubjectAccessReview | 
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
field_validation = 'field_validation_example' # str | fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in  this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. (optional)
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)

    try:
        api_response = api_instance.create_subject_access_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthorizationV1Api->create_subject_access_review: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	V1SubjectAccessReview
dry_run	str	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed	[optional]
field_manager	str	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.	[optional]
field_validation	str	fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.	[optional]
pretty	str	If 'true', then the output is pretty printed.	[optional]

Return type

V1SubjectAccessReview

Authorization

BearerToken

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
201	Created	-
202	Accepted	-
401	Unauthorized	-

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

get_api_resources

V1APIResourceList get_api_resources()

get available resources

Example

Api Key Authentication (BearerToken):

from __future__ import print_function
import time
import kubernetes.client
from kubernetes.client.rest import ApiException
from pprint import pprint
configuration = kubernetes.client.Configuration()
# Configure API key authorization: BearerToken
configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'

# Defining host is optional and default to http://localhost
configuration.host = "http://localhost"

# Enter a context with an instance of the API kubernetes.client
with kubernetes.client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kubernetes.client.AuthorizationV1Api(api_client)
    
    try:
        api_response = api_instance.get_api_resources()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthorizationV1Api->get_api_resources: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

V1APIResourceList

Authorization

BearerToken

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-

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

22 KiB Raw Blame History

kubernetes.client.AuthorizationV1Api

create_namespaced_local_subject_access_review

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_self_subject_access_review

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_self_subject_rules_review

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_subject_access_review

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_api_resources

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

22 KiB

Raw Blame History