Packages

p

zio.cli

oauth2

package oauth2

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class AccessToken(accessToken: String, tokenType: TokenType, expiresAt: Option[OffsetDateTime], refreshToken: Option[String], scope: List[String]) extends Product with Serializable
  2. sealed trait AccessTokenResponse extends Serializable with Product

    Response to access token request informing about progress of device authorization.

    Response to access token request informing about progress of device authorization. The response can be either AccessTokenResponse.AccessToken in case of successful termination or AccessTokenResponse.Error when any error occurrs.

    See also

    https://datatracker.ietf.org/doc/html/rfc6749#section-5

  3. final case class AuthorizationResponse(deviceCode: String, userCode: String, verificationUri: String, verificationUriComplete: Option[String], expiresIn: zio.Duration, interval: zio.Duration) extends Product with Serializable

    Response to device authorization request providing end-user verification code.

    Response to device authorization request providing end-user verification code.

    deviceCode

    device verification code

    userCode

    end-user verification code

    verificationUri

    end-user verification URI

    verificationUriComplete

    end-user verification URI with userCode

    expiresIn

    lifetime od deviceCode and userCode

    interval

    polling interval

    See also

    https://datatracker.ietf.org/doc/html/rfc8628#section-3.2

  4. final case class OAuth2AuxiliaryOptions(file: Path) extends Product with Serializable

    Set of options that can be provided to fine-tune OAuth2 authorization.

    Set of options that can be provided to fine-tune OAuth2 authorization.

    file

    path to file where access token will be stored

  5. trait OAuth2Provider extends AnyRef

    Provider of OAuth2 authorization.

  6. trait OAuth2Token extends AnyRef

    Access point to OAuth2 access token.

    Access point to OAuth2 access token.

    Normal lifecycle of the access token is handled automatically when calling accessToken, i. e. when token has normally expired, it will be refreshed. However, if the token is invalidated in any other way, it will not be detected and therefore the token will not be refreshed automatically. In such case, refreshTokenNow can be called.

  7. sealed trait TokenType extends Product with Serializable

    Access token type informing user about how to use access token.

    Access token type informing user about how to use access token.

    See also

    https://datatracker.ietf.org/doc/html/rfc6749#section-7.1

Value Members

  1. object AccessToken extends Serializable
  2. object AccessTokenResponse extends Serializable
  3. object AuthorizationResponse extends Serializable
  4. object OAuth2Provider
  5. object TokenType extends Serializable

Ungrouped