Skip to main content

UserQueries

No description

type UserQueries {
listMembers: [UserData!]
listRoles: [Role!]
listInvitations: [OrganizationInvitation!]
invitationByToken(
token: String!
): InvitationPreview
planRemoveAccess(
webUserId: Long!
): RemoveAccessPlan
planDeactivation(
webUserId: Long!
): MemberDeactivationPlan
}

Fields​

UserQueries.listMembers ● [UserData!] list object​

List of all members in the current organization, including external members whose home organization is elsewhere

UserQueries.listRoles ● [Role!] list object​

List of all available roles

UserQueries.listInvitations ● [OrganizationInvitation!] list object​

Invitations this organization has sent to existing accounts (requires canManageUsers permission)

UserQueries.invitationByToken ● InvitationPreview object​

Resolve an emailed invitation token. Deliberately available without authentication so the landing page can explain itself before asking the visitor to sign in; accepting still requires a session belonging to the invitee.

UserQueries.invitationByToken.token ● String! non-null scalar​

UserQueries.planRemoveAccess ● RemoveAccessPlan object​

What removing an external member's access would do, so the confirmation dialog can state it (requires canManageUsers permission)

UserQueries.planRemoveAccess.webUserId ● Long! non-null scalar​

UserQueries.planDeactivation ● MemberDeactivationPlan object​

UserQueries.planDeactivation.webUserId ● Long! non-null scalar​

Returned By​

users query