OAuthFlow

object OAuthFlow
Companion:
class
trait Sum
trait Mirror
class Object
trait Matchable
class Any

Type members

Classlikes

final case class AuthorizationCode(authorizationUrl: URI, refreshUrl: Option[URI], scopes: Map[String, String], tokenUrl: URI) extends OAuthFlow

Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0.

Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0.

Value parameters:
authorizationUrl

The authorization URL to be used for this flow.

refreshUrl

The URL to be used for obtaining refresh tokens.

scopes

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.

final case class ClientCredentials(refreshUrl: Option[URI], scopes: Map[String, String], tokenUrl: URI) extends OAuthFlow

Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0.

Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0.

Value parameters:
refreshUrl

The URL to be used for obtaining refresh tokens.

scopes

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.

final case class Implicit(authorizationUrl: URI, refreshUrl: Option[URI], scopes: Map[String, String]) extends OAuthFlow

Configuration for the OAuth Implicit flow.

Configuration for the OAuth Implicit flow.

Value parameters:
authorizationUrl

The authorization URL to be used for this flow.

refreshUrl

The URL to be used for obtaining refresh tokens.

scopes

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.

final case class Password(refreshUrl: Option[URI], scopes: Map[String, String], tokenUrl: URI) extends OAuthFlow

Configuration for the OAuth Resource Owner Password flow.

Configuration for the OAuth Resource Owner Password flow.

Value parameters:
refreshUrl

The URL to be used for obtaining refresh tokens.

scopes

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.

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Inherited from:
Mirror

The name of the type

The name of the type

Inherited from:
Mirror