OAuthFlow

zio.blocks.openapi.OAuthFlow
See theOAuthFlow companion object
final case class OAuthFlow(authorizationUrl: Option[String] = ..., tokenUrl: Option[String] = ..., refreshUrl: Option[String] = ..., scopes: ChunkMap[String, String] = ..., extensions: ChunkMap[String, Json] = ...)

Configuration details for a supported OAuth Flow.

Value parameters

authorizationUrl

The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. REQUIRED for implicit and authorizationCode flows.

extensions

Specification extensions (x-* fields). These allow adding additional properties beyond the standard OpenAPI fields.

refreshUrl

The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.

scopes

REQUIRED. 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.

tokenUrl

The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. REQUIRED for password, clientCredentials, and authorizationCode flows.

Attributes

Companion
object
Source
OpenAPI.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
Source
Product.scala
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product
Source
Product.scala