target.apidocs.com.google.api.services.servicemanagement.model.OAuthRequirements.html Maven / Gradle / Ivy
OAuthRequirements (Service Management API v1-rev20240823-2.0.0)
com.google.api.services.servicemanagement.model
Class OAuthRequirements
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.servicemanagement.model.OAuthRequirements
-
public final class OAuthRequirements
extends com.google.api.client.json.GenericJson
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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Service Management API. For a detailed explanation
see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
OAuthRequirements()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
OAuthRequirements
clone()
String
getCanonicalScopes()
The list of publicly documented OAuth scopes that are allowed access.
OAuthRequirements
set(String fieldName,
Object value)
OAuthRequirements
setCanonicalScopes(String canonicalScopes)
The list of publicly documented OAuth scopes that are allowed access.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getCanonicalScopes
public String getCanonicalScopes()
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
- Returns:
- value or
null
for none
-
setCanonicalScopes
public OAuthRequirements setCanonicalScopes(String 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
- Parameters:
canonicalScopes
- canonicalScopes or null
for none
-
set
public OAuthRequirements set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public OAuthRequirements clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy