Class BearerUtil

[[include:auth/bearerUtil.md]]

Hierarchy

  • FullAuthUtil
    • BearerUtil

Constructors

constructor

Properties

bearerFormat? description? securitySchemeName token?

Methods

getBearerFormat getDescription getSecuritySchemeName getToken removeBearerFormat removeDescription removeToken setBearerFormat setDescription setToken toOpenAPI toOpenAPISecurity toPostman

Constructors

constructor

  • new BearerUtil(securitySchemeName): BearerUtil

  • Parameters

    • securitySchemeName: string

    Returns BearerUtil

Properties

Protected OptionalbearerFormat

bearerFormat?: string

Protected Optionaldescription

description?: string

ProtectedsecuritySchemeName

securitySchemeName: string

Protected Optionaltoken

token?: string

Methods

getBearerFormat

  • getBearerFormat(): undefined | string

  • Returns undefined | string

getDescription

  • getDescription(): undefined | string

  • Returns undefined | string

getSecuritySchemeName

  • getSecuritySchemeName(): string

  • Returns string

getToken

  • getToken(): undefined | string

  • Returns undefined | string

removeBearerFormat

  • removeBearerFormat(): undefined | string

  • Returns undefined | string

removeDescription

  • removeDescription(): undefined | string

  • Returns undefined | string

removeToken

  • removeToken(): undefined | string

  • Returns undefined | string

setBearerFormat

  • setBearerFormat(bearerFormat): BearerUtil

  • Parameters

    • bearerFormat: string

      A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.

    Returns BearerUtil

setDescription

  • setDescription(description): BearerUtil

  • Parameters

    • description: string

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

    Returns BearerUtil

setToken

  • setToken(token): BearerUtil

  • Parameters

    • token: string

    Returns BearerUtil

toOpenAPI

  • toOpenAPI(): Record<string, SecuritySchemeObject>

  • Returns Record<string, SecuritySchemeObject>

toOpenAPISecurity

  • toOpenAPISecurity(scopes?): SecurityRequirementObject[]

  • Parameters

    • Optionalscopes: string[]

    Returns SecurityRequirementObject[]

toPostman

  • toPostman(): Auth

  • Returns Auth

Settings

Member Visibility

On This Page

Constructors
Properties
Methods