OBJECT

User

A user represents a user account within an organization.

GraphQL Schema definition

1 type User {
2 
3 #   The user's name
4 name: String! 
5 
6 #   The user's unique ID.
7 #   A user ID is a string in UUID format.
8 id: ID! 
9 
10 #   The set of permissions granted to the user
11 permissions: PermissionList 
12 
13 #   The set of roles granted to the user
14 roles: [Role!] 
15 
16 roleIds: [ID!] 
17 
18 #   ID of the organization to which the user belongs.
19 organizationId: ID 
20 
21 #   GUID of the organization to which the user belongs.
22 organizationGuid: ID 
23 
24 #   Organization to which the user belongs.
25 organization: Organization 
26 
27 #   GUID of organizations to which the user belongs.
28 organizationGuids: [ID] 
29 
30 #   Freeform metadata in JSON form
31 jsondata: JSONData 
32 
33 firstName: String 
34 
35 lastName: String 
36 
37 email: String 
38 
39 acls: [UserACL!] 
40 
41 title: String 
42 
43 developerType: String 
44 
45 #   Folder tree for this organization
46 # 
47 # Arguments
48 #   type: Specify a root folder type to retrieve a specific root 
49 #   folder
50 rootFolder(type: RootFolderType): Folder 
51 
52 #   Date and time this user last changed their password
53 passwordUpdatedDateTime: DateTime 
54 
55 #   Date and time this user last logged in
56 lastLoginDateTime: DateTime 
57 
58 #   Date and time this user account was created
59 createdDateTime: DateTime 
60 
61 #   Date and time this user account was last modified
62 modifiedDateTime: DateTime 
63 
64 #   Multi-factor authentication information for the user
65 mfaInfo: MFAInfo! 
66 
67 #   User Settings for the user
68 userSettings: [UserSetting!] 
69 
70 imageUrl: String 
71 
72 #   Status of user account
73 status: UserStatus 
74 
75 #   Notifications from user default mailbox
76 notifications(
77 dateTimeFilter: [NotificationDateTimeFilter!],
78 offset: Int,
79 limit: Int,
80 orderBy: NotificationDateTimeField,
81 orderDirection: OrderDirection,
82 flags: [NotificationFlag!],
83 flagsMode: filterCombineOperator
84 ): NotificationList 
85 
86 #   The flag indicate that the user is "virtual" system user
87 systemUser: Boolean 
88 
89 #   The application keys that allowed to run as system user.
90 appsAllowedToRunAsUser: [String] 
91 
92 #   Multi Organization Invite
93 organizationInvites(
94 organizationInviteId: ID,
95 status: OrganizationInviteStatus,
96 inviteType: OrganizationInviteType
97 ): [OrganizationInvite] 
98 
99 #   SCIM represents linked user information from a third party identity provider.
100 scim(connectors: [ID]): SCIMUserList 
101 
102 }

1	type User {
2
3	# The user's name
4	name: String!
5
6	# The user's unique ID.
7	# A user ID is a string in UUID format.
8	id: ID!
9
10	# The set of permissions granted to the user
11	permissions: PermissionList
12
13	# The set of roles granted to the user
14	roles: [Role!]
15
16	roleIds: [ID!]
17
18	# ID of the organization to which the user belongs.
19	organizationId: ID
20
21	# GUID of the organization to which the user belongs.
22	organizationGuid: ID
23
24	# Organization to which the user belongs.
25	organization: Organization
26
27	# GUID of organizations to which the user belongs.
28	organizationGuids: [ID]
29
30	# Freeform metadata in JSON form
31	jsondata: JSONData
32
33	firstName: String
34
35	lastName: String
36
37	email: String
38
39	acls: [UserACL!]
40
41	title: String
42
43	developerType: String
44
45	# Folder tree for this organization
46	#
47	# Arguments
48	# type: Specify a root folder type to retrieve a specific root
49	# folder
50	rootFolder(type: RootFolderType): Folder
51
52	# Date and time this user last changed their password
53	passwordUpdatedDateTime: DateTime
54
55	# Date and time this user last logged in
56	lastLoginDateTime: DateTime
57
58	# Date and time this user account was created
59	createdDateTime: DateTime
60
61	# Date and time this user account was last modified
62	modifiedDateTime: DateTime
63
64	# Multi-factor authentication information for the user
65	mfaInfo: MFAInfo!
66
67	# User Settings for the user
68	userSettings: [UserSetting!]
69
70	imageUrl: String
71
72	# Status of user account
73	status: UserStatus
74
75	# Notifications from user default mailbox
76	notifications(
77	dateTimeFilter: [NotificationDateTimeFilter!],
78	offset: Int,
79	limit: Int,
80	orderBy: NotificationDateTimeField,
81	orderDirection: OrderDirection,
82	flags: [NotificationFlag!],
83	flagsMode: filterCombineOperator
84	): NotificationList
85
86	# The flag indicate that the user is "virtual" system user
87	systemUser: Boolean
88
89	# The application keys that allowed to run as system user.
90	appsAllowedToRunAsUser: [String]
91
92	# Multi Organization Invite
93	organizationInvites(
94	organizationInviteId: ID,
95	status: OrganizationInviteStatus,
96	inviteType: OrganizationInviteType
97	): [OrganizationInvite]
98
99	# SCIM represents linked user information from a third party identity provider.
100	scim(connectors: [ID]): SCIMUserList
101
102	}

User

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by