Struct openstack::auth::Token

pub struct Token { /* private fields */ }

Token authentication using Identity API V3.

For any Identity authentication you need to know auth_url, which is an authentication endpoint of the Identity service. For the Token authentication you also need:

1. Existing authentication token.
2. Name of the project to use.
3. Domain of the project.

Start with creating a Token object using new, then add a project scope with with_project_scope:

use osauth::common::IdOrName;
let auth = osauth::identity::Token::new(
    "https://cloud.local/identity",
    "<a token>",
)
.expect("Invalid auth_url")
.with_project_scope(IdOrName::from_name("project1"), IdOrName::from_id("default"));

let session = osauth::Session::new(auth);

The authentication token is cached while it’s still valid or until refresh is called. Clones of a Token also start with an empty cache.

Implementations

impl Token

pub fn new<U, S>(auth_url: U, token: S) -> Result<Token, Error>where U: AsRef<str>, S: Into<String>,

Create a token authentication.

pub fn set_project_scope( &mut self, project: IdOrName, domain: impl Into<Option<IdOrName>> )

Scope authentication to the given project.

A convenience wrapper around set_scope.

pub fn set_scope(&mut self, scope: Scope)

Add a scope to the authentication.

This is required in the most cases.

pub fn with_project_scope( self, project: IdOrName, domain: impl Into<Option<IdOrName>> ) -> Token

Scope authentication to the given project.

A convenience wrapper around with_scope.

pub fn with_scope(self, scope: Scope) -> Token

Add a scope to the authentication.

pub fn project(&self) -> Option<&IdOrName>

Project name or ID (if project scoped).

Trait Implementations

impl AuthType for Token

fn authenticate<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 Client, request: RequestBuilder ) -> Pin<Box<dyn Future<Output = Result<RequestBuilder, Error>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, 'life1: 'async_trait, Token: 'async_trait,

Authenticate a request.

fn get_endpoint<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, client: &'life1 Client, service_type: &'life2 str, filters: &'life3 EndpointFilters ) -> Pin<Box<dyn Future<Output = Result<Url, Error>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Token: 'async_trait,

Get a URL for the requested service.

fn refresh<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 Client ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, 'life1: 'async_trait, Token: 'async_trait,

Refresh the cached token and service catalog.

impl Clone for Token

fn clone(&self) -> Token

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Token

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

Formats the value using the given formatter.

impl TryFrom<CloudConfig> for Token

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: CloudConfig) -> Result<Token, Error>

Performs the conversion.