public static interface AttributeContext.AuthOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getAccessLevels(int index)
public abstract String getAccessLevels(int index)
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"
repeated string access_levels = 5;
Parameter | |
---|---|
Name | Description |
index | int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String | The accessLevels at the given index. |
getAccessLevelsBytes(int index)
public abstract ByteString getAccessLevelsBytes(int index)
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"
repeated string access_levels = 5;
Parameter | |
---|---|
Name | Description |
index | int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString | The bytes of the accessLevels at the given index. |
getAccessLevelsCount()
public abstract int getAccessLevelsCount()
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"
repeated string access_levels = 5;
Returns | |
---|---|
Type | Description |
int | The count of accessLevels. |
getAccessLevelsList()
public abstract List<String> getAccessLevelsList()
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"
repeated string access_levels = 5;
Returns | |
---|---|
Type | Description |
List<String> | A list containing the accessLevels. |
getAudiences(int index)
public abstract String getAudiences(int index)
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.
repeated string audiences = 2;
Parameter | |
---|---|
Name | Description |
index | int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String | The audiences at the given index. |
getAudiencesBytes(int index)
public abstract ByteString getAudiencesBytes(int index)
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.
repeated string audiences = 2;
Parameter | |
---|---|
Name | Description |
index | int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString | The bytes of the audiences at the given index. |
getAudiencesCount()
public abstract int getAudiencesCount()
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.
repeated string audiences = 2;
Returns | |
---|---|
Type | Description |
int | The count of audiences. |
getAudiencesList()
public abstract List<String> getAudiencesList()
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.
repeated string audiences = 2;
Returns | |
---|---|
Type | Description |
List<String> | A list containing the audiences. |
getClaims()
public abstract Struct 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.
.google.protobuf.Struct claims = 4;
Returns | |
---|---|
Type | Description |
Struct | The claims. |
getClaimsOrBuilder()
public abstract StructOrBuilder getClaimsOrBuilder()
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.
.google.protobuf.Struct claims = 4;
Returns | |
---|---|
Type | Description |
StructOrBuilder |
getPresenter()
public abstract 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".
string presenter = 3;
Returns | |
---|---|
Type | Description |
String | The presenter. |
getPresenterBytes()
public abstract ByteString getPresenterBytes()
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".
string presenter = 3;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for presenter. |
getPrincipal()
public abstract 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}"
string principal = 1;
Returns | |
---|---|
Type | Description |
String | The principal. |
getPrincipalBytes()
public abstract ByteString getPrincipalBytes()
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}"
string principal = 1;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for principal. |
hasClaims()
public abstract boolean hasClaims()
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.
.google.protobuf.Struct claims = 4;
Returns | |
---|---|
Type | Description |
boolean | Whether the claims field is set. |