auth-client-play-30
API
Generated with
auth-client-play-30/uk.gov.hmrc/uk.gov.hmrc.auth/uk.gov.hmrc.auth.core/uk.gov.hmrc.auth.core.retrieve

uk.gov.hmrc.auth.core.retrieve

package uk.gov.hmrc.auth.core.retrieve

Members list

Packages

package uk.gov.hmrc.auth.core.retrieve.v2

Type members

Classlikes

case class AgentInformation(agentId: Option[String], agentCode: Option[String], agentFriendlyName: Option[String])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class CompositeRetrieval[A, B](retrievalA: Retrieval[A], retrievalB: Retrieval[B]) extends Retrieval[A ~ B]

A Retrieval for two properties on successful authorisation

A Retrieval for two properties on successful authorisation

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Retrieval[A ~ B]
class Object
trait Matchable
class Any
Show all
case class Credentials(providerId: String, providerType: String)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Email(value: String)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Email.type
object EmptyRetrieval extends Retrieval[Unit]

Simple modelling of a Retrieval that returns nothing (would be a simple authorise-only call)

Simple modelling of a Retrieval that returns nothing (would be a simple authorise-only call)

Attributes

Supertypes
trait Retrieval[Unit]
class Object
trait Matchable
class Any
Self type
case class GGCredId(credId: String) extends LegacyCredentials

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GatewayInformation(gatewayToken: Option[String])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ItmpAddress(line1: Option[String], line2: Option[String], line3: Option[String], line4: Option[String], line5: Option[String], postCode: Option[String], countryName: Option[String], countryCode: Option[String])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ItmpName(givenName: Option[String], middleName: Option[String], familyName: Option[String])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ItmpName.type
trait LegacyCredentials

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class GGCredId
object OneTimeLogin
class PAClientId
object LegacyCredentials

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class LoginTimes(currentLogin: Instant, previousLogin: Option[Instant])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
LoginTimes.type
case class MdtpInformation(deviceId: String, sessionId: String)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Name(name: Option[String], lastName: Option[String])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Name.type
case object OneTimeLogin extends LegacyCredentials

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case class OptionalRetrieval[A](propertyName: String, valueReads: Reads[A]) extends Retrieval[Option[A]]

A Retrieval that will return only a single, optional property on successful authorisation

A Retrieval that will return only a single, optional property on successful authorisation

Value parameters

propertyName

The name of the property to return from auth on success. Must be a supported property in auth.

valueReads

The JSON Reads to apply to the returned JSON property in case it is present

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Retrieval[Option[A]]
class Object
trait Matchable
class Any
Show all
case class PAClientId(clientId: String) extends LegacyCredentials

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class PostCode(value: String)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
PostCode.type
trait Retrieval[A]

A typed class that models what will be returned from auth upon a successful authorisation call

A typed class that models what will be returned from auth upon a successful authorisation call

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class CompositeRetrieval[A, B]
class SimpleRetrieval[A]
case class SimpleRetrieval[A](propertyName: String, valueReads: Reads[A]) extends Retrieval[A]

A Retrieval that will return only a single property on successful authorisation

A Retrieval that will return only a single property on successful authorisation

Value parameters

propertyName

The name of the property to return from auth on success. Must be a supported property in auth.

valueReads

The JSON Reads to apply to the returned JSON property

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Retrieval[A]
class Object
trait Matchable
class Any
Show all
case class StandardApplication(clientId: String) extends LegacyCredentials

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ~[+A, +B](a: A, b: B)

Some type-trickery to allow composing of multiple retrievals at the call site

Some type-trickery to allow composing of multiple retrievals at the call site

Attributes

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

Deprecated classlikes

trait Retrievals

Attributes

Companion
object
Deprecated
[Since version 2.11.0-play-26]
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Retrievals
object Retrievals extends Retrievals

Attributes

Companion
trait
Deprecated
true
Supertypes
trait Retrievals
class Object
trait Matchable
class Any
Self type
Retrievals.type
Generated with