AuthenticationV1Api
All URIs are relative to http://localhost
Self Subject Review
| Method | HTTP request | Description |
|---|---|---|
| createSelfSubjectReview | POST /apis/authentication.k8s.io/v1/selfsubjectreviews | create a SelfSubjectReview |
Token Review
| Method | HTTP request | Description |
|---|---|---|
| createTokenReview | POST /apis/authentication.k8s.io/v1/tokenreviews | create a TokenReview |
APIResources
| Method | HTTP request | Description |
|---|---|---|
| getAPIResources | GET /apis/authentication.k8s.io/v1/ | get available resources |
Self Subject Review
createSelfSubjectReview
V1SelfSubjectReview createSelfSubjectReview(body)
create a SelfSubjectReview
Example
import { createConfiguration, AuthenticationV1Api } from '@kubernetes/client-node';
import type { AuthenticationV1ApiCreateSelfSubjectReviewRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AuthenticationV1Api(configuration);
const request: AuthenticationV1ApiCreateSelfSubjectReviewRequest = {
body: { /* See V1SelfSubjectReview: /models/other#v1selfsubjectreview */ },
// 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.createSelfSubjectReview(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1SelfSubjectReview | ||
| 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
Token Review
createTokenReview
V1TokenReview createTokenReview(body)
create a TokenReview
Example
import { createConfiguration, AuthenticationV1Api } from '@kubernetes/client-node';
import type { AuthenticationV1ApiCreateTokenReviewRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AuthenticationV1Api(configuration);
const request: AuthenticationV1ApiCreateTokenReviewRequest = {
body: { /* See V1TokenReview: /models/security#v1tokenreview */ },
// 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.createTokenReview(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1TokenReview | ||
| 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
APIResources
getAPIResources
V1APIResourceList getAPIResources()
get available resources
Example
import { createConfiguration, AuthenticationV1Api } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AuthenticationV1Api(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.