Skip to main content
Framed content
A user is a person with a Miru account who can (or previously could) log in to a workspace and access its resources. Users are identified by their email address and can only belong to one workspace. You cannot log in to multiple workspaces with the same email address.

​
Properties

​
first_name
string
The first name of the user. Must contain between 1 and 48 characters.Examples: John, Jane
​
last_name
string
The last name of the user. Must contain between 1 and 48 characters.Examples: Doe, Smith
​
email
string
The email address of the user.Examples: [email protected], [email protected]
​
role
enum
The user’s access role in the workspace.Allowed values:
  • member
  • admin
  • owner
​
status
enum
The user’s status.Allowed values:
  • active
  • suspended
  • left
​
avatar
image
The avatar of the user.

​
Status

To maintain an accurate audit trail of user activity, users cannot be deleted from a workspace. However, users can be suspended by an admin or leave the workspace themselves. As such, there are three possible statuses for a user:
StatusDescription
activeUser can log in and access workspace resources
suspendedUser’s access was revoked by an admin
leftUser has left the workspace
Only active users can log in and access workspace resources. suspended and left users exist solely for auditing purposes—they cannot log in to the workspace or access any resources. Users who have been suspended or left can be reinvited to the workspace at any time by an admin via invites.