final case class OAuthRequirements(canonicalScopes: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[OAuthRequirements] with Product with Serializable

OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf.

OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means.

In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs.

When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice.

Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.

canonicalScopes

The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[OAuthRequirements], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OAuthRequirements
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OAuthRequirements(canonicalScopes: String = "", unknownFields: UnknownFieldSet = ...)

    canonicalScopes

    The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val canonicalScopes: String
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. def companion: OAuthRequirements.type
    Definition Classes
    OAuthRequirements → GeneratedMessage
  8. def discardUnknownFields: OAuthRequirements
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    OAuthRequirements → GeneratedMessage
  13. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    OAuthRequirements → GeneratedMessage
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def serializedSize: Int
    Definition Classes
    OAuthRequirements → GeneratedMessage
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  21. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  22. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  23. def toProtoString: String
    Definition Classes
    OAuthRequirements → GeneratedMessage
  24. val unknownFields: UnknownFieldSet
  25. def update(ms: (Lens[OAuthRequirements, OAuthRequirements]) ⇒ Mutation[OAuthRequirements]*): OAuthRequirements
    Definition Classes
    Updatable
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  29. def withCanonicalScopes(__v: String): OAuthRequirements
  30. def withUnknownFields(__v: UnknownFieldSet): OAuthRequirements
  31. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  32. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    OAuthRequirements → GeneratedMessage
  33. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[OAuthRequirements]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped