Struct synapse_admin_api::users::create_or_modify::v2::Request

#[non_exhaustive]
pub struct Request<'a> {
    pub user_id: &'a UserId,
    pub password: Option<&'a str>,
    pub displayname: Option<String>,
    pub threepids: Option<Vec<ThirdPartyIdentifier>>,
    pub avatar_url: Option<String>,
    pub admin: Option<bool>,
    pub deactivated: Option<bool>,
}

Data for a request to the create_modify_account_v2 API endpoint.

create or modify account endpoint

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

user_id: &'a UserId

user ID for the account to renew

password: Option<&'a str>

This is an optional parameter. Add this parameter to create an account or set this password as new one for an existing account.

displayname: Option<String>

defaults to user_id, or the current value if user already exists Some(“”) is treated as setting it to null.

threepids: Option<Vec<ThirdPartyIdentifier>>

defaults to empty, or the current value if user already exists

avatar_url: Option<String>

The user’s avatar URL, if set.

admin: Option<bool>

Should the user be a server admin defaults to false, or the current value if user already exists

deactivated: Option<bool>

Should the user be deactivated defaults to false, or the current value if user already exists

Implementations

impl<'a> Request<'a>

pub fn new(user_id: &'a UserId, password: Option<&'a str>) -> Self

Creates a Request with the user ID and the optional password.

Trait Implementations

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> Outgoing for Request<'a>

type Incoming = IncomingRequest

The ‘Incoming’ variant of Self.