Auth (Service Control API v2-rev20240802-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.servicecontrol.v2.model.Auth

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Auth
extends com.google.api.client.json.GenericJson
```
This message defines request authentication attributes. Terminology is based on the JSON Web Token (JWT) standard, but the terms also correlate to concepts in other standards.
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 Control 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>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Auth()

Constructors
Constructor and Description
`Auth()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Auth`	`clone()`
`List<String>`	`getAccessLevels()` A list of access level resource names that allow resources to be accessed by authenticated requester.
`List<String>`	`getAudiences()` The intended audience(s) for this authentication information.
`Map<String,Object>`	`getClaims()` Structured claims presented with the credential.
`String`	`getCredentialId()` Identifies the client credential id used for authentication.
`String`	`getPresenter()` The authorized presenter of the credential.
`String`	`getPrincipal()` The authenticated principal.
`Auth`	`set(String fieldName, Object value)`
`Auth`	`setAccessLevels(List<String> accessLevels)` A list of access level resource names that allow resources to be accessed by authenticated requester.
`Auth`	`setAudiences(List<String> audiences)` The intended audience(s) for this authentication information.
`Auth`	`setClaims(Map<String,Object> claims)` Structured claims presented with the credential.
`Auth`	`setCredentialId(String credentialId)` Identifies the client credential id used for authentication.
`Auth`	`setPresenter(String presenter)` The authorized presenter of the credential.
`Auth`	`setPrincipal(String principal)` The authenticated principal.

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

- Constructor Detail
  - Auth
```
public Auth()
```
- Method Detail
  - getAccessLevels
```
public List<String> getAccessLevels()
```
    A list of access level resource names that allow resources to be accessed by authenticated requester. It is part of Secure GCP processing for the incoming request. An access level string has the format: "//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}" Example: "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"
    
    Returns:
    
    value or null for none
  - setAccessLevels
```
public Auth setAccessLevels(List<String> accessLevels)
```
    A list of access level resource names that allow resources to be accessed by authenticated requester. It is part of Secure GCP processing for the incoming request. An access level string has the format: "//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}" Example: "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"
    
    Parameters:
    
    accessLevels - accessLevels or null for none
  - getAudiences
```
public List<String> getAudiences()
```
    The intended audience(s) for this authentication information. Reflects the audience (`aud`) claim within a JWT. The audience value(s) depends on the `issuer`, but typically include one or more of the following pieces of information: * The services intended to receive the credential. For example, ["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"]. * A set of service-based scopes. For example, ["https://www.googleapis.com/auth/cloud-platform"]. * The client id of an app, such as the Firebase project id for JWTs from Firebase Auth. Consult the documentation for the credential issuer to determine the information provided.
    
    Returns:
    
    value or null for none
  - setAudiences
```
public Auth setAudiences(List<String> audiences)
```
    The intended audience(s) for this authentication information. Reflects the audience (`aud`) claim within a JWT. The audience value(s) depends on the `issuer`, but typically include one or more of the following pieces of information: * The services intended to receive the credential. For example, ["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"]. * A set of service-based scopes. For example, ["https://www.googleapis.com/auth/cloud-platform"]. * The client id of an app, such as the Firebase project id for JWTs from Firebase Auth. Consult the documentation for the credential issuer to determine the information provided.
    
    Parameters:
    
    audiences - audiences or null for none
  - getClaims
```
public Map<String,Object> getClaims()
```
    Structured claims presented with the credential. JWTs include `{key: value}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure.
    
    Returns:
    
    value or null for none
  - setClaims
```
public Auth setClaims(Map<String,Object> claims)
```
    Structured claims presented with the credential. JWTs include `{key: value}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure.
    
    Parameters:
    
    claims - claims or null for none
  - getCredentialId
```
public String getCredentialId()
```
    Identifies the client credential id used for authentication. credential_id is in the format of AUTH_METHOD:IDENTIFIER, e.g. "serviceaccount:XXXXX, apikey:XXXXX" where the format of the IDENTIFIER can vary for different AUTH_METHODs.
    
    Returns:
    
    value or null for none
  - setCredentialId
```
public Auth setCredentialId(String credentialId)
```
    Identifies the client credential id used for authentication. credential_id is in the format of AUTH_METHOD:IDENTIFIER, e.g. "serviceaccount:XXXXX, apikey:XXXXX" where the format of the IDENTIFIER can vary for different AUTH_METHODs.
    
    Parameters:
    
    credentialId - credentialId or null for none
  - getPresenter
```
public String getPresenter()
```
    The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: "123456789012.apps.googleusercontent.com".
    
    Returns:
    
    value or null for none
  - setPresenter
```
public Auth setPresenter(String presenter)
```
    The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: "123456789012.apps.googleusercontent.com".
    
    Parameters:
    
    presenter - presenter or null for none
  - getPrincipal
```
public String getPrincipal()
```
    The authenticated principal. Reflects the issuer (`iss`) and subject (`sub`) claims within a JWT. The issuer and subject should be `/` delimited, with `/` percent-encoded within the subject fragment. For Google accounts, the principal format is: "https://accounts.google.com/{id}"
    
    Returns:
    
    value or null for none
  - setPrincipal
```
public Auth setPrincipal(String principal)
```
    The authenticated principal. Reflects the issuer (`iss`) and subject (`sub`) claims within a JWT. The issuer and subject should be `/` delimited, with `/` percent-encoded within the subject fragment. For Google accounts, the principal format is: "https://accounts.google.com/{id}"
    
    Parameters:
    
    principal - principal or null for none
  - set
```
public Auth set(String fieldName,
                Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Auth clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Auth

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Auth

Method Detail

getAccessLevels

setAccessLevels

getAudiences

setAudiences

getClaims

setClaims

getCredentialId

setCredentialId

getPresenter

setPresenter

getPrincipal

setPrincipal

set

clone