Struct AccessTokenScope 

pub struct AccessTokenScope {
    pub basins: Option<ResourceSet>,
    pub streams: Option<ResourceSet>,
    pub access_tokens: Option<ResourceSet>,
    pub op_groups: Option<PermittedOperationGroups>,
    pub ops: HashSet<Operation>,
}

Access token scope.

Fields

basins: Option<ResourceSet>

Basin names allowed.

streams: Option<ResourceSet>

Stream names allowed.

access_tokens: Option<ResourceSet>

Token IDs allowed.

op_groups: Option<PermittedOperationGroups>

Access permissions at operation group level.

ops: HashSet<Operation>

Operations allowed for the token. A union of allowed operations and groups is used as an effective set of allowed operations.

Implementations

impl AccessTokenScope

pub fn new() -> Self

Create a new access token scope.

Examples found in repository

examples/issue_access_token.rs (line 17)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_ACCESS_TOKEN")?;
    let config = ClientConfig::new(token);
    let client = Client::new(config);

    let access_token_id: AccessTokenId = "my-access-token".parse()?;
    let access_token_info = AccessTokenInfo::new(access_token_id).with_scope(
        AccessTokenScope::new()
            .with_op_groups(
                PermittedOperationGroups::new()
                    .with_account(ReadWritePermissions::new().with_read(true)),
            )
            .with_op(Operation::CreateStream)
            .with_streams(ResourceSet::Prefix("my-stream-prefix".to_string()))
            .with_basins(ResourceSet::Exact("my-perfect-basin".to_string())),
    );
    let token = client.issue_access_token(access_token_info).await?;

    println!("Access token: {token}");

    Ok(())
}

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

Overwrite resource set for access tokens.

Examples found in repository

examples/issue_access_token.rs (line 24)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_ACCESS_TOKEN")?;
    let config = ClientConfig::new(token);
    let client = Client::new(config);

    let access_token_id: AccessTokenId = "my-access-token".parse()?;
    let access_token_info = AccessTokenInfo::new(access_token_id).with_scope(
        AccessTokenScope::new()
            .with_op_groups(
                PermittedOperationGroups::new()
                    .with_account(ReadWritePermissions::new().with_read(true)),
            )
            .with_op(Operation::CreateStream)
            .with_streams(ResourceSet::Prefix("my-stream-prefix".to_string()))
            .with_basins(ResourceSet::Exact("my-perfect-basin".to_string())),
    );
    let token = client.issue_access_token(access_token_info).await?;

    println!("Access token: {token}");

    Ok(())
}

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

Overwrite resource set for streams.

Examples found in repository

examples/issue_access_token.rs (line 23)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_ACCESS_TOKEN")?;
    let config = ClientConfig::new(token);
    let client = Client::new(config);

    let access_token_id: AccessTokenId = "my-access-token".parse()?;
    let access_token_info = AccessTokenInfo::new(access_token_id).with_scope(
        AccessTokenScope::new()
            .with_op_groups(
                PermittedOperationGroups::new()
                    .with_account(ReadWritePermissions::new().with_read(true)),
            )
            .with_op(Operation::CreateStream)
            .with_streams(ResourceSet::Prefix("my-stream-prefix".to_string()))
            .with_basins(ResourceSet::Exact("my-perfect-basin".to_string())),
    );
    let token = client.issue_access_token(access_token_info).await?;

    println!("Access token: {token}");

    Ok(())
}

pub fn with_tokens(self, access_tokens: ResourceSet) -> Self

Overwrite resource set for access tokens.

pub fn with_op_groups(self, op_groups: PermittedOperationGroups) -> Self

Overwrite operation groups.

Examples found in repository

examples/issue_access_token.rs (lines 18-21)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_ACCESS_TOKEN")?;
    let config = ClientConfig::new(token);
    let client = Client::new(config);

    let access_token_id: AccessTokenId = "my-access-token".parse()?;
    let access_token_info = AccessTokenInfo::new(access_token_id).with_scope(
        AccessTokenScope::new()
            .with_op_groups(
                PermittedOperationGroups::new()
                    .with_account(ReadWritePermissions::new().with_read(true)),
            )
            .with_op(Operation::CreateStream)
            .with_streams(ResourceSet::Prefix("my-stream-prefix".to_string()))
            .with_basins(ResourceSet::Exact("my-perfect-basin".to_string())),
    );
    let token = client.issue_access_token(access_token_info).await?;

    println!("Access token: {token}");

    Ok(())
}

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

Overwrite operations.

pub fn with_op(self, op: Operation) -> Self

Add an operation to operations.

Examples found in repository

examples/issue_access_token.rs (line 22)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_ACCESS_TOKEN")?;
    let config = ClientConfig::new(token);
    let client = Client::new(config);

    let access_token_id: AccessTokenId = "my-access-token".parse()?;
    let access_token_info = AccessTokenInfo::new(access_token_id).with_scope(
        AccessTokenScope::new()
            .with_op_groups(
                PermittedOperationGroups::new()
                    .with_account(ReadWritePermissions::new().with_read(true)),
            )
            .with_op(Operation::CreateStream)
            .with_streams(ResourceSet::Prefix("my-stream-prefix".to_string()))
            .with_basins(ResourceSet::Exact("my-perfect-basin".to_string())),
    );
    let token = client.issue_access_token(access_token_info).await?;

    println!("Access token: {token}");

    Ok(())
}

Trait Implementations

impl Clone for AccessTokenScope

fn clone(&self) -> AccessTokenScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccessTokenScope

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

Formats the value using the given formatter.

impl Default for AccessTokenScope

fn default() -> AccessTokenScope

Returns the “default value” for a type.