target.apidocs.com.google.api.services.servicemanagement.model.AuthRequirement.html Maven / Gradle / Ivy
AuthRequirement (Service Management API v1-rev20240823-2.0.0)
com.google.api.services.servicemanagement.model
Class AuthRequirement
- 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.AuthRequirement
-
public final class AuthRequirement
extends com.google.api.client.json.GenericJson
User-defined authentication requirements, including support for [JSON Web Token
(JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
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
AuthRequirement()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
AuthRequirement
clone()
String
getAudiences()
NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in
all the runtime components.
String
getProviderId()
id from authentication provider.
AuthRequirement
set(String fieldName,
Object value)
AuthRequirement
setAudiences(String audiences)
NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in
all the runtime components.
AuthRequirement
setProviderId(String providerId)
id from authentication provider.
-
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
-
getAudiences
public String getAudiences()
NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in
all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-
oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of
these audiences will be accepted. When this setting is absent, only JWTs with audience
"https://Service_name/API_name" will be accepted. For example, if no audiences are in the
setting, LibraryService API will only accept JWTs with the following audience "https://library-
example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences:
bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- Returns:
- value or
null
for none
-
setAudiences
public AuthRequirement setAudiences(String audiences)
NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in
all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-
oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of
these audiences will be accepted. When this setting is absent, only JWTs with audience
"https://Service_name/API_name" will be accepted. For example, if no audiences are in the
setting, LibraryService API will only accept JWTs with the following audience "https://library-
example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences:
bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- Parameters:
audiences
- audiences or null
for none
-
getProviderId
public String getProviderId()
id from authentication provider. Example: provider_id: bookstore_auth
- Returns:
- value or
null
for none
-
setProviderId
public AuthRequirement setProviderId(String providerId)
id from authentication provider. Example: provider_id: bookstore_auth
- Parameters:
providerId
- providerId or null
for none
-
set
public AuthRequirement set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public AuthRequirement 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