User
Represents information about a user.
type User {
id: ID!
firstName: String
lastName: String
displayName: String
email: String
mfaSetupComplete: Boolean
mfaPrimaryMethod: MfaMethod
account: Account!
roles: [Role!]
isAccountOwner: Boolean
status: UserStatus
language: String
abilities: JSON
permissions: [Permission]
modules: [Module!]
setting(
name: String!
): Setting
globalSetting(
name: String!
): Setting
avatar: String
avatarUrls: UserAvatarUrls
position: String
createdAt: DateTimeTz!
updatedAt: DateTimeTz!
deletedAt: DateTimeTz
phones(
where: UserPhonesWhereWhereConditions
orderBy: [UserPhonesOrderByOrderByClause!]
first: Int!
after: String
): PhoneConnection!
contacts(
where: UserContactsWhereWhereConditions
orderBy: [UserContactsOrderByOrderByClause!]
first: Int!
after: String
): ContactConnection!
companies(
where: UserCompaniesWhereWhereConditions
orderBy: [UserCompaniesOrderByOrderByClause!]
first: Int!
after: String
): CompanyConnection!
people(
where: UserPeopleWhereWhereConditions
orderBy: [UserPeopleOrderByOrderByClause!]
first: Int!
after: String
): PersonConnection!
projects(
where: UserProjectsWhereWhereConditions
orderBy: [UserProjectsOrderByOrderByClause!]
first: Int!
after: String
): ProjectConnection!
}
Fields
User.id ● ID! non-null scalar
User's unique identifier.
User.firstName ● String scalar
The user's first name.
User.lastName ● String scalar
The user's last name.
User.displayName ● String scalar
The user's full name.
User.email ● String scalar
The user's email address.
User.mfaSetupComplete ● Boolean scalar
Whether the user has set up two-factor authentication. Visible to the user themselves and to the account owner; null for anyone else.
User.mfaPrimaryMethod ● MfaMethod enum
The user's primary two-factor method. Visible to the user themselves and to the account owner; null for anyone else.
User.account ● Account! non-null object
The user's account relationship.
User.roles ● [Role!] list object
The user's role.
User.isAccountOwner ● Boolean scalar
Determine whether the user is the account owner.
User.status ● UserStatus enum
Determine the user's status.
User.language ● String scalar
The user's language. Only returned for the signed-in user, null for any other user.
User.abilities ● JSON scalar
The user's abilities. Only returned for the signed-in user, null for any other user.
User.permissions ● [Permission] list object
The user's permissions.
User.modules ● [Module!] list object
The user's modules.
User.setting ● Setting object
The user's setting.
User.setting.name ● String! non-null scalar
User.globalSetting ● Setting object
The user's global setting, that looks for a value from both the user and as a fallback from the account.
User.globalSetting.name ● String! non-null scalar
User.avatar ● String scalar
The user's avatar identifier (ULID). Use avatarUrls to obtain the actual image URLs.
User.avatarUrls ● UserAvatarUrls object
The user's avatar URLs keyed by variant (small, medium, large), or null if no avatar is set.
User.position ● String scalar
The user's position.
User.createdAt ● DateTimeTz! non-null scalar
The date and time when the user was created.
User.updatedAt ● DateTimeTz! non-null scalar
The date and time when the user was last updated.
User.deletedAt ● DateTimeTz scalar
The date and time when the user was deleted.
User.phones ● PhoneConnection! non-null object
The user's phone numbers.
User.phones.where ● UserPhonesWhereWhereConditions input
User.phones.orderBy ● [UserPhonesOrderByOrderByClause!] list input
User.phones.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
User.phones.after ● String scalar
A cursor after which elements are returned.
User.contacts ● ContactConnection! non-null object
A list of contacts the user is a member of, limited to those the current user can see.
User.contacts.where ● UserContactsWhereWhereConditions input
User.contacts.orderBy ● [UserContactsOrderByOrderByClause!] list input
User.contacts.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
User.contacts.after ● String scalar
A cursor after which elements are returned.
User.companies ● CompanyConnection! non-null object
A list of companies the user is a member of, limited to those the current user can see.
User.companies.where ● UserCompaniesWhereWhereConditions input
User.companies.orderBy ● [UserCompaniesOrderByOrderByClause!] list input
User.companies.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
User.companies.after ● String scalar
A cursor after which elements are returned.
User.people ● PersonConnection! non-null object
A list of people the user is a member of, limited to those the current user can see.
User.people.where ● UserPeopleWhereWhereConditions input
User.people.orderBy ● [UserPeopleOrderByOrderByClause!] list input
User.people.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
User.people.after ● String scalar
A cursor after which elements are returned.
User.projects ● ProjectConnection! non-null object
A list of projects the user is a member of, limited to those the current user can see.
User.projects.where ● UserProjectsWhereWhereConditions input
User.projects.orderBy ● [UserProjectsOrderByOrderByClause!] list input
User.projects.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
User.projects.after ● String scalar
A cursor after which elements are returned.
Returned By
addUserPhone mutation ● assignRole mutation ● deleteUser mutation ● deleteUserAvatar mutation ● me query ● restoreUser mutation ● updateUser mutation ● updateUserPhones mutation ● updateUserRoles mutation ● uploadUserAvatar mutation ● user query
Member Of
Act object ● Activity object ● Approval object ● ApprovalApprover object ● Comment object ● Company object ● Contact object ● Contract object ● ContractMembersEdge object ● Coordination object ● CoordinationMembersEdge object ● Dashboard object ● Easement object ● ESigning object ● Expense object ● File object ● GovernanceDocument object ● GovernanceDocumentMembersEdge object ● Invoice object ● Letter object ● LetterMembersEdge object ● LoginResponse object ● Meter object ● MfaEnforcementResult object ● Notification object ● Ordinance object ● OrdinanceMembersEdge object ● Person object ● Project object ● ProjectMembersEdge object ● Property object ● Quote object ● Reading object ● Role object ● Specification object ● SpecificationMembersEdge object ● Structure object ● Submission object ● SubmissionMembersEdge object ● Task object ● TaskBundle object ● TaskMembersEdge object ● UserEdge object ● UserMfaStatus object ● View object