Class AuthenticationV1Api

Hierarchy

  • AuthenticationV1Api

Constructors

constructor

Properties

_basePath _defaultHeaders _useQuerystring authentications interceptors

Accessors

basePath defaultHeaders useQuerystring

Methods

addInterceptor createSelfSubjectReview createTokenReview getAPIResources setApiKey setDefaultAuthentication

Constructors

constructor

Properties

Protected _basePath

_basePath: string = defaultBasePath

Protected _defaultHeaders

_defaultHeaders: any = {}

Protected _useQuerystring

_useQuerystring: boolean = false

Protected authentications

authentications: {
    BearerToken: ApiKeyAuth;
    default: Authentication;
} = ...

Type declaration

Protected interceptors

interceptors: Interceptor[] = []

Accessors

basePath

defaultHeaders

useQuerystring

Methods

addInterceptor

createSelfSubjectReview

  • create a SelfSubjectReview

    Parameters

    • body: V1SelfSubjectReview
    • Optional dryRun: string

      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 fieldManager: string

      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 fieldValidation: string

      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 pretty: string

      If 'true', then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1SelfSubjectReview;
        response: IncomingMessage;
    }>

createTokenReview

  • create a TokenReview

    Parameters

    • body: V1TokenReview
    • Optional dryRun: string

      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 fieldManager: string

      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 fieldValidation: string

      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 pretty: string

      If &#39;true&#39;, then the output is pretty printed.

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1TokenReview;
        response: IncomingMessage;
    }>

getAPIResources

  • get available resources

    Parameters

    • options: {
          headers: {
              [name: string]: string;
          };
      } = ...
      • headers: {
            [name: string]: string;
        }
        • [name: string]: string

    Returns Promise<{
        body: V1APIResourceList;
        response: IncomingMessage;
    }>

setApiKey

setDefaultAuthentication

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc