MemberRequestDto

The user request parameters.

Name	Type	Description	Notes
password	String	The password in plain text. It is checked against the portal password policy and rejected with 400 when it is too weak. When neither this field nor passwordHash is sent, a random password is generated and nobody learns it, so the account can only be used after a password recovery.	[optional] [example: P@ssw0rd] [nullable]
passwordHash	String	The password already hashed by the client, which is what the portal stores. It is a PBKDF2-HMACSHA256 hash of the plain password, computed with the salt, the iteration count and the key size the portal settings publish, and written as lowercase hexadecimal. When it is sent, password is ignored and the password policy is not applied.	[optional] [example: c1ba1a0bcbe0f0f42b6c86e1b41a1b4a4a9b4b0e3f2b7d2c1a0e9f8d7c6b5a49] [nullable]
email	String (email)	The email address of the new account, up to 255 characters. It is required in practice and has to be a real address, and it becomes the sign-in name of the account.	[optional] [example: john.doe@example.com] [minLength: 0] [maxLength: 255] [nullable]
type	EmployeeType	The type of the new account: User, RoomAdmin or DocSpaceAdmin. Guest is not accepted here, and the value is ignored entirely when fromInviteLink is set, because the invitation link decides the type. When no paid seat is free, the account is created as User whatever was asked for.	[optional] [enum: All, RoomAdmin, Guest, DocSpaceAdmin, User]
isUser	Boolean	Only chooses which entry the operation writes to the audit trail - the one for a guest or the one for a member. It does not change the type of the account; type and the invitation link do that.	[optional] [example: true] [nullable]
firstName	String	The first name, up to 255 characters. It is checked together with lastName, and a pair the portal does not accept as a name answers 400.	[optional] [example: John] [minLength: 0] [maxLength: 255] [nullable]
lastName	String	The last name, up to 255 characters. It is checked together with firstName, and a pair the portal does not accept as a name answers 400.	[optional] [example: Doe] [minLength: 0] [maxLength: 255] [nullable]
department	List (uuid)	The groups to put the new account into, by group ID. Read the IDs from GET api/2.0/group; an ID that matches no group is skipped without an error.	[optional] [example: [00000000-0000-0000-0000-000000000000]] [nullable]
location	String	The free-text location shown on the profile. It is stored as it is given and is not validated.	[optional] [example: New York] [nullable]
comment	String	The free-text note kept with the profile, shown to administrators. It is stored as it is given.	[optional] [example: User comment] [nullable]
contacts	List	The additional ways to reach the person, each as a type and a value pair. The type is a free-text label such as email, phone, skype or telegram, and an entry with an empty value is dropped.	[optional] [example: [{type=email, value=john.doe@example.com}]] [nullable]
files	String	The address the portal downloads the avatar from. It has to use HTTPS unless the request itself came over HTTP, an address the portal refuses to fetch is rejected, and passing the default avatar path means no avatar is downloaded.	[optional] [example: https://example.com/avatar.jpg] [nullable]
fromInviteLink	Boolean	Set it to true when the account is created by somebody accepting an invitation, which makes key required and lets the link decide the type. With the default false the caller has to hold the permission to add an account of the requested type.	[optional] [example: false]
key	String	The key of the invitation link being accepted, taken from the link itself. It is read only when fromInviteLink is true, and an expired or already used key answers 403.	[optional] [example: user_key_string] [nullable]
cultureName	String	The interface language of the new account, as a culture code. It is applied whether or not the portal has that culture enabled, so send a code the portal supports.	[optional] [example: en-US] [nullable]
target	UUID (uuid)	Not used. The handler reads nothing from this field, and it is kept only so that existing clients keep working.	[optional] [example: 00000000-0000-0000-0000-000000000000]
spam	Boolean	Whether the account agrees to receive tips, updates and offers. It defaults to false, which means no such mail is sent.	[optional] [example: false] [nullable]