Packages > pkg.pkl-lang.org/pkl-pantry/org.openapis.v3 > org.openapis.v3.OAuthFlows

OAuthFlow2.1.2

Properties
Methods

class OAuthFlow

Definition of an OAuth flow.

Known subtypes:
Known usages:
All versions:

Properties

link

refreshUrl: Uri?Source

The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.
link

scopes: Mapping<String, String>Source

The available scopes for the OAuth2 security scheme.

A map between the scope name and a short description for it. The map MAY be empty.
link

authorizationUrl: Uri?Source

The authorization URL to be used for this flow.

This MUST be in the form of a URL.
link

tokenUrl: Uri?Source

The token URL to be used for this flow.

This MUST be in the form of a URL.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.