Struct IamClient 

pub struct IamClient { /* private fields */ }

Client forPharia Identity Access Management. Authenticate and authorize users.

Implementations

impl IamClient

pub fn builder(base_url: String) -> IamClientBuilder

Use this instead of IamClient::new if you want to have additional middleware.

pub fn new(base_url: String) -> Self

Construct a new client using the respective IAM instance. E.g. IAM_PRODUCTION_URL

pub async fn check_user<'a>( &self, token: impl Display, permissions: &'a [Permission<'a>], ) -> Result<UserInfoAndPermissions, CheckUserError>

One stop shop for both authentication and asking a set of permissions. While this method returns a subset of permissions to which matches the privileges of the user it does not perform the authorization check. Call authorize

Parameters

• token: Service or user token used for authentication.
• permissions: A list of all permissions you are interested in. The response will contain the subset of these permissions which are privileges the user has.

pub async fn authorize<'a>( &self, token: impl Display, permissions: &'a [Permission<'a>], ) -> Result<UserInfoAndPermissions, AuthorizationError>

Same as check_user but also performs the authorization check and fails if the user is not authorized.

Parameters

• token: Service or user token used for authentication.
• permissions: A list of all permissions you are interested in. The response will contain the subset of these permissions which are privileges the user has.

Example: Check if the user has the AccessAssistant permission.

use pharia_common::{Permission, IamClient, AuthorizationError, IAM_PRODUCTION_URL};

pub async fn authorize(token: &str) -> Result<(), AuthorizationError> {
    let iam = IamClient::new(IAM_PRODUCTION_URL.to_owned());
    let permissions = [Permission::AccessAssistant];
    let user_info = iam.authorize(token, &permissions).await?;
    Ok(())
}

Trait Implementations

impl Clone for IamClient

fn clone(&self) -> IamClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IamClient

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

Formats the value using the given formatter.