Enum AccessSpecifier

pub enum AccessSpecifier {
    Audience(String),
    Scopes(Vec<String>),
}

Represents the access specifier for a service account based token, specifying either OAuth 2.0 scopes or a JWT audience.

It ensures that only one of these access specifiers can be applied for a given credential setup.

Variants

Audience(String)

Use AccessSpecifier::Audience for setting audience in the token. aud is a JWT claim specifying intended recipient of the token, that is, a service. Only one of audience or scopes can be specified for a credentials.

Scopes(Vec<String>)

Use AccessSpecifier::Scopes for setting scopes in the token.

scopes is a JWT claim specifying requested permission(s) for the token. Only one of audience or scopes can be specified for a credentials.

scopes define the permissions being requested for this specific session when interacting with a service. For example, https://www.googleapis.com/auth/devstorage.read_write. IAM permissions, on the other hand, define the underlying capabilities the service account possesses within a system. For example, storage.buckets.delete. When a token generated with specific scopes is used, the request must be permitted by both the service account’s underlying IAM permissions and the scopes requested for the token. Therefore, scopes act as an additional restriction on what the token can be used for. Please see relevant section in service account authorization to learn more about scopes and IAM permissions.

Implementations

impl AccessSpecifier

pub fn from_scopes<I, S>(scopes: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Creates AccessSpecifier with scopes.

Example

let access_specifier = AccessSpecifier::from_scopes(["https://www.googleapis.com/auth/pubsub"]);
let service_account_key = serde_json::json!({ /* add details here */ });
let credentials = Builder::new(service_account_key)
    .with_access_specifier(access_specifier)
    .build();

pub fn from_audience<S: Into<String>>(audience: S) -> Self

Creates AccessSpecifier with an audience.

The value should be https://{SERVICE}/, e.g., https://pubsub.googleapis.com/

Example

let access_specifier = AccessSpecifier::from_audience("https://bigtable.googleapis.com/");
let service_account_key = serde_json::json!({ /* add details here */ });
let credentials = Builder::new(service_account_key)
    .with_access_specifier(access_specifier)
    .build();

Trait Implementations

impl Clone for AccessSpecifier

fn clone(&self) -> AccessSpecifier

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AccessSpecifier

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AccessSpecifier

fn eq(&self, other: &AccessSpecifier) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AccessSpecifier