AuthorizationV1Api

All URIs are relative to http://localhost

Local Subject Access Review

Method	HTTP request	Description
createNamespacedLocalSubjectAccessReview	POST /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews	create a LocalSubjectAccessReview

Self Subject Access Review

Method	HTTP request	Description
createSelfSubjectAccessReview	POST /apis/authorization.k8s.io/v1/selfsubjectaccessreviews	create a SelfSubjectAccessReview

Self Subject Rules Review

Method	HTTP request	Description
createSelfSubjectRulesReview	POST /apis/authorization.k8s.io/v1/selfsubjectrulesreviews	create a SelfSubjectRulesReview

Subject Access Review

Method	HTTP request	Description
createSubjectAccessReview	POST /apis/authorization.k8s.io/v1/subjectaccessreviews	create a SubjectAccessReview

APIResources

Method	HTTP request	Description
getAPIResources	GET /apis/authorization.k8s.io/v1/	get available resources

Local Subject Access Review

createNamespacedLocalSubjectAccessReview

V1LocalSubjectAccessReview createNamespacedLocalSubjectAccessReview(body)

create a LocalSubjectAccessReview

Example

import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node';
import type { AuthorizationV1ApiCreateNamespacedLocalSubjectAccessReviewRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AuthorizationV1Api(configuration);

const request: AuthorizationV1ApiCreateNamespacedLocalSubjectAccessReviewRequest = {
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
  body: { /* See V1LocalSubjectAccessReview: /models/security#v1localsubjectaccessreview */ },
    // 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)
  dryRun: "dryRun_example",
    // 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)
  fieldManager: "fieldManager_example",
    // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
  fieldValidation: "fieldValidation_example",
  // ...1 more optional parameter(s)
};

const data = await apiInstance.createNamespacedLocalSubjectAccessReview(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1LocalSubjectAccessReview
namespace	[string]	object name and auth scope, such as for teams and projects	defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined

Return type

V1LocalSubjectAccessReview

Self Subject Access Review

createSelfSubjectAccessReview

V1SelfSubjectAccessReview createSelfSubjectAccessReview(body)

create a SelfSubjectAccessReview

Example

import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node';
import type { AuthorizationV1ApiCreateSelfSubjectAccessReviewRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AuthorizationV1Api(configuration);

const request: AuthorizationV1ApiCreateSelfSubjectAccessReviewRequest = {
  body: { /* See V1SelfSubjectAccessReview: /models/security#v1selfsubjectaccessreview */ },
    // 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)
  dryRun: "dryRun_example",
    // 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)
  fieldManager: "fieldManager_example",
    // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
  fieldValidation: "fieldValidation_example",
  // ...1 more optional parameter(s)
};

const data = await apiInstance.createSelfSubjectAccessReview(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1SelfSubjectAccessReview
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined

Return type

V1SelfSubjectAccessReview

Self Subject Rules Review

createSelfSubjectRulesReview

V1SelfSubjectRulesReview createSelfSubjectRulesReview(body)

create a SelfSubjectRulesReview

Example

import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node';
import type { AuthorizationV1ApiCreateSelfSubjectRulesReviewRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AuthorizationV1Api(configuration);

const request: AuthorizationV1ApiCreateSelfSubjectRulesReviewRequest = {
  body: { /* See V1SelfSubjectRulesReview: /models/security#v1selfsubjectrulesreview */ },
    // 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)
  dryRun: "dryRun_example",
    // 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)
  fieldManager: "fieldManager_example",
    // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
  fieldValidation: "fieldValidation_example",
  // ...1 more optional parameter(s)
};

const data = await apiInstance.createSelfSubjectRulesReview(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1SelfSubjectRulesReview
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined

Return type

V1SelfSubjectRulesReview

Subject Access Review

createSubjectAccessReview

V1SubjectAccessReview createSubjectAccessReview(body)

create a SubjectAccessReview

Example

import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node';
import type { AuthorizationV1ApiCreateSubjectAccessReviewRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AuthorizationV1Api(configuration);

const request: AuthorizationV1ApiCreateSubjectAccessReviewRequest = {
  body: { /* See V1SubjectAccessReview: /models/security#v1subjectaccessreview */ },
    // 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)
  dryRun: "dryRun_example",
    // 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)
  fieldManager: "fieldManager_example",
    // fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
  fieldValidation: "fieldValidation_example",
  // ...1 more optional parameter(s)
};

const data = await apiInstance.createSubjectAccessReview(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1SubjectAccessReview
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined

Return type

V1SubjectAccessReview

APIResources

getAPIResources

V1APIResourceList getAPIResources()

get available resources

Example

import { createConfiguration, AuthorizationV1Api } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AuthorizationV1Api(configuration);

const request = {};

const data = await apiInstance.getAPIResources(request);
console.log('API called successfully. Returned data:', data);

Parameters

This endpoint does not need any parameter.

Return type

V1APIResourceList