Skip to main content

UserCommands

Enum UserCommands 

Source
pub enum UserCommands {
    List {
        account: Option<String>,
        project: Option<String>,
        role: Option<String>,
        status: Option<String>,
        search: Option<String>,
    },
    Add {
        email: String,
        account: Option<String>,
        role: Option<String>,
        filter: Option<String>,
        project_ids: Option<PathBuf>,
        concurrency: usize,
        dry_run: bool,
        yes: bool,
    },
    Remove {
        email: String,
        account: Option<String>,
        filter: Option<String>,
        project_ids: Option<PathBuf>,
        concurrency: usize,
        dry_run: bool,
        yes: bool,
    },
    Update {
        email: String,
        account: Option<String>,
        role: Option<String>,
        company: Option<String>,
        from_role: Option<String>,
        filter: Option<String>,
        project_ids: Option<PathBuf>,
        from_csv: Option<PathBuf>,
        concurrency: usize,
        dry_run: bool,
        yes: bool,
    },
    AddToProject {
        project: String,
        email: String,
        role_id: Option<String>,
    },
    RemoveFromProject {
        project: String,
        user_id: String,
        yes: bool,
    },
    UpdateInProject {
        project: String,
        user_id: String,
        role_id: Option<String>,
    },
    Import {
        project: String,
        from_csv: PathBuf,
    },
}
Expand description

User management subcommands

Variants§

§

List

List users in an account or project

Fields

§account: Option<String>

Account ID (defaults to APS_ACCOUNT_ID env var)

§project: Option<String>

Optional: list users for a specific project only

§role: Option<String>

Filter by role name

§status: Option<String>

Filter by status (active, inactive, not_invited)

§search: Option<String>

Search by email or name

§

Add

Add a user to multiple projects

Fields

§email: String

Email address of the user to add

§account: Option<String>

Account ID (defaults to current profile account)

§role: Option<String>

Role to assign (e.g., “Project Admin”, “Document Manager”)

§filter: Option<String>

Project filter expression (e.g., “name:Hospital,status:active”)

§project_ids: Option<PathBuf>

File containing project IDs (one per line)

§concurrency: usize

Parallel requests (default: 10, max: 50)

§dry_run: bool

Preview changes without executing

§yes: bool

Skip confirmation prompt

§

Remove

Remove a user from multiple projects

Fields

§email: String

Email address of the user to remove

§account: Option<String>

Account ID

§filter: Option<String>

Project filter expression

§project_ids: Option<PathBuf>

File containing project IDs (one per line)

§concurrency: usize

Parallel requests (default: 10, max: 50)

§dry_run: bool

Preview changes without executing

§yes: bool

Skip confirmation prompt

§

Update

Update user roles and/or company across multiple projects

Fields

§email: String

Email address of the user to update

§account: Option<String>

Account ID

§role: Option<String>

New role to assign (required unless –company is provided)

§company: Option<String>

Company name to assign at account level

§from_role: Option<String>

Only update users with this current role

§filter: Option<String>

Project filter expression

§project_ids: Option<PathBuf>

File containing project IDs (one per line)

§from_csv: Option<PathBuf>

Import updates from a CSV file (columns: email, role, company)

§concurrency: usize

Parallel requests (default: 10, max: 50)

§dry_run: bool

Preview changes without executing

§yes: bool

Skip confirmation prompt

§

AddToProject

Add a user to a single project by email

Fields

§project: String

Project ID

§email: String

Email address of the user (used as user identifier)

§role_id: Option<String>

Role ID to assign

§

RemoveFromProject

Remove a user from a single project

Fields

§project: String

Project ID

§user_id: String

User ID to remove

§yes: bool

Skip confirmation prompt

§

UpdateInProject

Update a user’s role in a single project

Fields

§project: String

Project ID

§user_id: String

User ID to update

§role_id: Option<String>

New role ID to assign

§

Import

Import new users to a project from CSV

Fields

§project: String

Project ID to import users into

§from_csv: PathBuf

CSV file with columns: email, role_id (optional)

Implementations§

Source§

impl UserCommands

Source

pub async fn execute( self, config: &Config, auth_client: &AuthClient, output_format: OutputFormat, ) -> Result<()>

Trait Implementations§

Source§

impl Debug for UserCommands

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for UserCommands

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Subcommand for UserCommands

Source§

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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