Struct openstack::auth::Password

pub struct Password { /* fields omitted */ }

Password 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 Password authentication you also need:

1. User name and password.
2. Domain of the user.
3. Name of the project to use.
4. Domain of the project.

Note: currently only names are supported for user, user domain and project domain. ID support is coming later.

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

let auth = osauth::identity::Password::new(
    "https://cloud.local/identity",
    "admin",
    "pa$$w0rd",
    "Default"
)
.expect("Invalid auth_url")
.with_project_scope("project1", "Default");

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

If your cloud has several regions, pick one using with_region:

let auth = osauth::identity::Password::new(
    "https://cloud.local/identity",
    "admin",
    "pa$$w0rd",
    "Default"
)
.expect("Invalid auth_url")
.with_project_scope("project1", "Default")
.with_region("US-East");

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

By default, the public endpoint interface is used. If you would prefer to default to another one, you can set it with with_default_endpoint_interface.

let auth = osauth::identity::Password::new(
    "https://cloud.local/identity",
    "admin",
    "pa$$w0rd",
    "Default"
)
.expect("Invalid auth_url")
.with_project_scope("project1", "Default")
.with_default_endpoint_interface("internal");

The authentication token is cached while it's still valid or until refresh is called.

Methods

impl Password

pub fn new<U, S1, S2, S3>(
    auth_url: U,
    user_name: S1,
    password: S2,
    user_domain_name: S3
) -> Result<Password, Error> where
    S1: Into<String>,
    S2: Into<String>,
    S3: Into<String>,
    U: IntoUrl, 

Create a password authentication.

pub fn new_with_client<U, S1, S2, S3>(
    auth_url: U,
    client: Client,
    user_name: S1,
    password: S2,
    user_domain_name: S3
) -> Result<Password, Error> where
    S1: Into<String>,
    S2: Into<String>,
    S3: Into<String>,
    U: IntoUrl, 

Create a password authentication with the provided HTTP client.

pub fn default_endpoint_interface(&self) -> &String

The default endpoint interface.

pub fn set_default_endpoint_interface<S>(&mut self, endpoint_interface: S) where
    S: Into<String>, 

Set the default endpoint interface to use.

pub fn set_region<S>(&mut self, region: S) where
    S: Into<String>, 

Set a region for this authentication method.

pub fn set_project_scope<S1, S2>(
    &mut self,
    project_name: S1,
    project_domain_name: S2
) where
    S1: Into<String>,
    S2: Into<String>, 

Scope authentication to the given project.

This is required in the most cases.

pub fn with_default_endpoint_interface<S>(
    self,
    endpoint_interface: S
) -> Password where
    S: Into<String>, 

Convert this session into one using the given endpoint interface.

pub fn with_project_scope<S1, S2>(
    self,
    project_name: S1,
    project_domain_name: S2
) -> Password where
    S1: Into<String>,
    S2: Into<String>, 

Scope authentication to the given project.

pub fn with_region<S>(self, region: S) -> Password where
    S: Into<String>, 

Set a region for this authentication method.

pub fn user_name(&self) -> &String

Deprecated since 0.2.3:

Use user in preparation for user ID support.

User name.

pub fn user(&self) -> &IdOrName

User name or ID.

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

Project name or ID (if project scoped).

Trait Implementations

impl AuthType for Password

fn region(&self) -> Option<String>

Get region.

fn request(
    &self,
    method: Method,
    url: Url
) -> Box<dyn Future<Item = RequestBuilder, Error = Error> + 'static + Send>

Create an authenticated request.

fn get_endpoint(
    &self,
    service_type: String,
    endpoint_interface: Option<String>
) -> Box<dyn Future<Item = Url, Error = Error> + 'static + Send>

Get a URL for the requested service.

fn refresh(&self) -> Box<dyn Future<Item = (), Error = Error> + 'static + Send>

Refresh the cached token and service catalog.

impl Clone for Password

fn clone(&self) -> Password

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Password

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

Formats the value using the given formatter.

impl Identity for Password

fn auth_url(&self) -> &Url

Get a reference to the auth URL.