Skip to main content

AuthorizationClient

Struct AuthorizationClient 

Source
pub struct AuthorizationClient { /* private fields */ }
Expand description

Client for authorization operations.

Implementations§

Source§

impl AuthorizationClient

Source

pub fn new(api: ApiClient) -> Self

Create a new authorization client.

Source

pub async fn create_application( &self, request: &CreateOrUpdateApplicationRequest, ) -> Result<ConductorApplication>

Create an application.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn get_application( &self, application_id: &str, ) -> Result<ConductorApplication>

Get an application by ID.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn list_applications(&self) -> Result<Vec<ConductorApplication>>

List all applications.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn update_application( &self, request: &CreateOrUpdateApplicationRequest, application_id: &str, ) -> Result<ConductorApplication>

Update an application.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn delete_application(&self, application_id: &str) -> Result<()>

Delete an application.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn get_app_by_access_key_id( &self, access_key_id: &str, ) -> Result<String>

Get application ID by access key ID.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn add_role_to_application_user( &self, application_id: &str, role: &str, ) -> Result<()>

Add a role to application user.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn remove_role_from_application_user( &self, application_id: &str, role: &str, ) -> Result<()>

Remove a role from application user.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn set_application_tags( &self, tags: &[MetadataTag], application_id: &str, ) -> Result<()>

Set tags for an application.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn get_application_tags( &self, application_id: &str, ) -> Result<Vec<MetadataTag>>

Get tags for an application.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn delete_application_tags( &self, tags: &[MetadataTag], application_id: &str, ) -> Result<()>

Delete tags from an application.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn create_access_key( &self, application_id: &str, ) -> Result<CreatedAccessKey>

Create an access key for an application.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn get_access_keys( &self, application_id: &str, ) -> Result<Vec<AccessKey>>

Get access keys for an application.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn toggle_access_key_status( &self, application_id: &str, key_id: &str, ) -> Result<AccessKey>

Toggle the status of an access key.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn delete_access_key( &self, application_id: &str, key_id: &str, ) -> Result<()>

Delete an access key.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn upsert_user( &self, request: &UpsertUserRequest, user_id: &str, ) -> Result<ConductorUser>

Create or update a user.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn get_user(&self, user_id: &str) -> Result<ConductorUser>

Get a user by ID.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn list_users(&self, apps: bool) -> Result<Vec<ConductorUser>>

List all users.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn delete_user(&self, user_id: &str) -> Result<()>

Delete a user.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn get_granted_permissions_for_user( &self, user_id: &str, ) -> Result<Vec<GrantedPermission>>

Get permissions granted to a user.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn check_permissions( &self, user_id: &str, target_type: &str, target_id: &str, ) -> Result<HashMap<String, bool>>

Check if user has permissions over a target.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn upsert_group( &self, request: &UpsertGroupRequest, group_id: &str, ) -> Result<Group>

Create or update a group.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn get_group(&self, group_id: &str) -> Result<Group>

Get a group by ID.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn list_groups(&self) -> Result<Vec<Group>>

List all groups.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn delete_group(&self, group_id: &str) -> Result<()>

Delete a group.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn get_granted_permissions_for_group( &self, group_id: &str, ) -> Result<Vec<GrantedPermission>>

Get permissions granted to a group.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn add_user_to_group( &self, group_id: &str, user_id: &str, ) -> Result<()>

Add a user to a group.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn add_users_to_group( &self, group_id: &str, user_ids: &[String], ) -> Result<()>

Add multiple users to a group.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn get_users_in_group( &self, group_id: &str, ) -> Result<Vec<ConductorUser>>

Get all users in a group.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn remove_user_from_group( &self, group_id: &str, user_id: &str, ) -> Result<()>

Remove a user from a group.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn remove_users_from_group( &self, group_id: &str, user_ids: &[String], ) -> Result<()>

Remove multiple users from a group.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn grant_permissions( &self, subject: &SubjectRef, target: &TargetRef, access: &[AccessType], ) -> Result<()>

Grant permissions to a subject over a target.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn get_permissions( &self, target: &TargetRef, ) -> Result<HashMap<String, Vec<SubjectRef>>>

Get permissions for a target.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn remove_permissions( &self, subject: &SubjectRef, target: &TargetRef, access: &[AccessType], ) -> Result<()>

Remove permissions from a subject over a target.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn list_all_roles(&self) -> Result<Vec<Value>>

List all roles.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn list_system_roles(&self) -> Result<HashMap<String, Value>>

List system roles.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn list_custom_roles(&self) -> Result<Vec<Value>>

List custom roles.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn list_available_permissions(&self) -> Result<HashMap<String, Value>>

List available permissions.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn create_role(&self, request: &Value) -> Result<Value>

Create a custom role.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn get_role(&self, role_name: &str) -> Result<Value>

Get a role by name.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn update_role( &self, role_name: &str, request: &Value, ) -> Result<Value>

Update a custom role.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn delete_role(&self, role_name: &str) -> Result<()>

Delete a custom role.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Source

pub async fn get_user_info_from_token(&self) -> Result<Value>

Get user info from the current token.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn generate_token( &self, key_id: &str, key_secret: &str, ) -> Result<Value>

Generate a token using access key credentials.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn create_gateway_auth_config( &self, auth_config: &Value, ) -> Result<Value>

Create API Gateway authentication configuration.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn get_gateway_auth_config(&self, config_id: &str) -> Result<Value>

Get API Gateway authentication configuration by ID.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn list_gateway_auth_configs(&self) -> Result<Vec<Value>>

List all API Gateway authentication configurations.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn update_gateway_auth_config( &self, config_id: &str, auth_config: &Value, ) -> Result<Value>

Update API Gateway authentication configuration.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status, or crate::error::ConductorError::Json if the response body can’t be deserialized.

Source

pub async fn delete_gateway_auth_config(&self, config_id: &str) -> Result<()>

Delete API Gateway authentication configuration.

§Errors

Returns crate::error::ConductorError::Http if the request fails at the transport level, or an crate::error::ConductorError::Auth/crate::error::ConductorError::Api/crate::error::ConductorError::Server variant if the server responds with a non-2xx status.

Trait Implementations§

Source§

impl Clone for AuthorizationClient

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more