Class ApiKeyUtil

{@include ../../../typedocIncludes/auth/apiKeyUtil.md}

Hierarchy

  • FullAuthUtil
    • ApiKeyUtil

Constructors

constructor

Properties

apiKeyLocation? description? key? securitySchemeName value?

Methods

getApiKeyLocation getDescription getKey getName getSecuritySchemeName getValue removeApiKeyLocation removeDescription removeKey removeName removeValue setApiKeyLocation setDescription setKey setName setValue toOpenAPI toOpenAPISecurity toPostman

Constructors

constructor

  • new ApiKeyUtil(securitySchemeName: string): ApiKeyUtil

  • Parameters

    • securitySchemeName: string

    Returns ApiKeyUtil

Properties

Protected OptionalapiKeyLocation

apiKeyLocation?: string

Protected Optionaldescription

description?: string

Protected Optionalkey

key?: string

ProtectedsecuritySchemeName

securitySchemeName: string

Protected Optionalvalue

value?: string

Methods

getApiKeyLocation

  • getApiKeyLocation(): undefined | string

  • Returns undefined | string

getDescription

  • getDescription(): undefined | string

  • Returns undefined | string

getKey

  • getKey(): undefined | string

  • Returns undefined | string

getName

  • getName(): undefined | string

  • Returns undefined | string

getSecuritySchemeName

  • getSecuritySchemeName(): string

  • Returns string

getValue

  • getValue(): undefined | string

  • Returns undefined | string

removeApiKeyLocation

  • removeApiKeyLocation(): undefined | string

  • Returns undefined | string

removeDescription

  • removeDescription(): undefined | string

  • Returns undefined | string

removeKey

  • removeKey(): undefined | string

  • Returns undefined | string

removeName

  • removeName(): undefined | string

  • Returns undefined | string

removeValue

  • removeValue(): undefined | string

  • Returns undefined | string

setApiKeyLocation

  • setApiKeyLocation(apiKeyLocation: ApiKeyLocation): ApiKeyUtil

  • Parameters

    Returns ApiKeyUtil

  • setApiKeyLocation(apiKeyLocation: string): ApiKeyUtil

  • Parameters

    • apiKeyLocation: string

    Returns ApiKeyUtil

setDescription

  • setDescription(description: string): ApiKeyUtil

  • Parameters

    • description: string

      A short description for security scheme. CommonMark syntax MAY be used for rich text representation.

    Returns ApiKeyUtil

setKey

  • setKey(key: string): ApiKeyUtil

  • Parameters

    • key: string

    Returns ApiKeyUtil

setName

  • setName(key: string): ApiKeyUtil

  • Parameters

    • key: string

    Returns ApiKeyUtil

setValue

  • setValue(value: string): ApiKeyUtil

  • Parameters

    • value: string

    Returns ApiKeyUtil

toOpenAPI

  • toOpenAPI(): Record<string, SecuritySchemeObject>

  • Returns Record<string, SecuritySchemeObject>

toOpenAPISecurity

  • toOpenAPISecurity(scopes?: string[]): SecurityRequirementObject[]

  • Parameters

    • Optionalscopes: string[]

    Returns SecurityRequirementObject[]

toPostman

  • toPostman(): Auth

  • Returns Auth

Settings

Member Visibility

On This Page

Constructors
Properties
Methods