Struct AccessTokenScopeInput 

#[non_exhaustive]
pub struct AccessTokenScopeInput { /* private fields */ }

Scope of an access token.

Note: The final set of permitted operations is the union of ops and the operations permitted by op_group_perms. Also, the final set must not be empty.

See IssueAccessTokenInput::scope.

Implementations

impl AccessTokenScopeInput

pub fn from_ops(ops: impl IntoIterator<Item = Operation>) -> Self

Create a new AccessTokenScopeInput with the given permitted operations.

pub fn from_op_group_perms(op_group_perms: OperationGroupPermissions) -> Self

Create a new AccessTokenScopeInput with the given operation group permissions.

Examples found in repository

examples/issue_access_token.rs (lines 22-24)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let access_token =
        std::env::var("S2_ACCESS_TOKEN").map_err(|_| "S2_ACCESS_TOKEN env var not set")?;
    let basin_name: BasinName = std::env::var("S2_BASIN")
        .map_err(|_| "S2_BASIN env var not set")?
        .parse()?;

    let config = S2Config::new(access_token);
    let s2 = S2::new(config)?;

    let input = IssueAccessTokenInput::new(
        "ro-token".parse()?,
        AccessTokenScopeInput::from_op_group_perms(
            OperationGroupPermissions::new().with_account(ReadWritePermissions::read_only()),
        )
        .with_ops([Operation::CreateStream])
        .with_streams(StreamMatcher::Prefix("audit".parse()?))
        .with_basins(BasinMatcher::Exact(basin_name)),
    );
    let issued_token = s2.issue_access_token(input).await?;
    println!("Issued access token: {issued_token}");

    Ok(())
}

pub fn with_ops(self, ops: impl IntoIterator<Item = Operation>) -> Self

Set the permitted operations.

Examples found in repository

examples/issue_access_token.rs (line 25)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let access_token =
        std::env::var("S2_ACCESS_TOKEN").map_err(|_| "S2_ACCESS_TOKEN env var not set")?;
    let basin_name: BasinName = std::env::var("S2_BASIN")
        .map_err(|_| "S2_BASIN env var not set")?
        .parse()?;

    let config = S2Config::new(access_token);
    let s2 = S2::new(config)?;

    let input = IssueAccessTokenInput::new(
        "ro-token".parse()?,
        AccessTokenScopeInput::from_op_group_perms(
            OperationGroupPermissions::new().with_account(ReadWritePermissions::read_only()),
        )
        .with_ops([Operation::CreateStream])
        .with_streams(StreamMatcher::Prefix("audit".parse()?))
        .with_basins(BasinMatcher::Exact(basin_name)),
    );
    let issued_token = s2.issue_access_token(input).await?;
    println!("Issued access token: {issued_token}");

    Ok(())
}

pub fn with_op_group_perms( self, op_group_perms: OperationGroupPermissions, ) -> Self

Set the access permissions at the operation group level.

pub fn with_basins(self, basins: BasinMatcher) -> Self

Set the permitted basins.

Defaults to no basins.

Examples found in repository

examples/issue_access_token.rs (line 27)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let access_token =
        std::env::var("S2_ACCESS_TOKEN").map_err(|_| "S2_ACCESS_TOKEN env var not set")?;
    let basin_name: BasinName = std::env::var("S2_BASIN")
        .map_err(|_| "S2_BASIN env var not set")?
        .parse()?;

    let config = S2Config::new(access_token);
    let s2 = S2::new(config)?;

    let input = IssueAccessTokenInput::new(
        "ro-token".parse()?,
        AccessTokenScopeInput::from_op_group_perms(
            OperationGroupPermissions::new().with_account(ReadWritePermissions::read_only()),
        )
        .with_ops([Operation::CreateStream])
        .with_streams(StreamMatcher::Prefix("audit".parse()?))
        .with_basins(BasinMatcher::Exact(basin_name)),
    );
    let issued_token = s2.issue_access_token(input).await?;
    println!("Issued access token: {issued_token}");

    Ok(())
}

pub fn with_streams(self, streams: StreamMatcher) -> Self

Set the permitted streams.

Defaults to no streams.

Examples found in repository

examples/issue_access_token.rs (line 26)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let access_token =
        std::env::var("S2_ACCESS_TOKEN").map_err(|_| "S2_ACCESS_TOKEN env var not set")?;
    let basin_name: BasinName = std::env::var("S2_BASIN")
        .map_err(|_| "S2_BASIN env var not set")?
        .parse()?;

    let config = S2Config::new(access_token);
    let s2 = S2::new(config)?;

    let input = IssueAccessTokenInput::new(
        "ro-token".parse()?,
        AccessTokenScopeInput::from_op_group_perms(
            OperationGroupPermissions::new().with_account(ReadWritePermissions::read_only()),
        )
        .with_ops([Operation::CreateStream])
        .with_streams(StreamMatcher::Prefix("audit".parse()?))
        .with_basins(BasinMatcher::Exact(basin_name)),
    );
    let issued_token = s2.issue_access_token(input).await?;
    println!("Issued access token: {issued_token}");

    Ok(())
}

pub fn with_access_tokens(self, access_tokens: AccessTokenMatcher) -> Self

Set the permitted access tokens.

Defaults to no access tokens.

Trait Implementations

impl Clone for AccessTokenScopeInput

fn clone(&self) -> AccessTokenScopeInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccessTokenScopeInput

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

Formats the value using the given formatter.

impl From<AccessTokenScopeInput> for AccessTokenScope

fn from(value: AccessTokenScopeInput) -> Self

Converts to this type from the input type.