zio.cli.oauth2

package zio.cli.oauth2

Members list

Type members

Classlikes

final case class AccessToken(accessToken: String, tokenType: TokenType, expiresAt: Option[OffsetDateTime], refreshToken: Option[String], scope: List[String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AccessToken

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait AccessTokenResponse extends Serializable, Product

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.

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.

Attributes

See also
Companion
object
Supertypes
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class AccessToken
class Error

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class AuthorizationResponse(deviceCode: String, userCode: String, verificationUri: String, verificationUriComplete: Option[String], expiresIn: Duration, interval: Duration)

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

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

Value parameters

deviceCode

device verification code

expiresIn

lifetime od deviceCode and userCode

interval

polling interval

userCode

end-user verification code

verificationUri

end-user verification URI

verificationUriComplete

end-user verification URI with userCode

Attributes

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class OAuth2AuxiliaryOptions(file: JPath)

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

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

Value parameters

file

path to file where access token will be stored

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Provider of OAuth2 authorization.

Provider of OAuth2 authorization.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Facebook
class Github
class Google

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait OAuth2Token

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.

Attributes

Supertypes
class Object
trait Matchable
class Any
sealed trait TokenType extends Product, Serializable

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

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

Attributes

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object Bearer
object Mac
class Other
object TokenType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
TokenType.type