Skip to main content

GroupMember

A GroupMember represents the membership of a User in a Group. It includes permissions, notification preferences, and optional custom SMTP email settings for that user within the group.

Implements: Node

Fields

Identity & Status

FieldTypeDescription
idID!Unique identifier
nameStringFull name of the member
permissionGroupPermissionPermission level (ADMINISTER, EDIT, READ, CREATESEND, SENDONLY, SOLOSEND, SOLOALL)
featuresAWSJSONFeatures accessible to this member (based on licence and group permissions)
isActiveBooleanWhether the user is active or disabled by an admin
suspendedBooleanWhether the user is suspended
sessionOnlyBooleanSession-only access
enforceTwoFactorBooleanRequire MFA for group access
createdAWSDateTimeWhen the membership was created
modifiedAWSDateTimeWhen the membership was last modified
lastLoginAWSDateTimeLast login time

Permissions

FieldTypeDescription
canAdministerBooleanCan add/remove users from the group
canCreateSendBooleanCan create templates and send documents
canEditBooleanCan edit (non-readonly)

Notifications

FieldTypeDescription
dailyDigestBooleanSubscribed to daily activity summaries
weeklyDigestBooleanSubscribed to weekly activity summaries
visitEmailBooleanNotified when a recipient visits a document
signedRejectedEmailBooleanNotified on sign/reject
bounceEmailStringBounce notification setting

Custom SMTP

FieldTypeDescription
emailActiveBooleanUsing custom email server
emailUsernameStringSMTP username
emailPasswordStringSMTP password
emailHostStringSMTP host
emailPortIntSMTP port

Relationships

FieldTypeDescription
groupGroup!The group
userUser!The user

Query

GroupMembers are accessed via Group.memberConnection:

query GetGroupMembers {
group(id: "Z3JwbGVnYWxlc2lnbxRldg==") {
memberConnection {
groupMembers {
id
name
permission
canAdminister
user {
id
email
}
}
}
}
}

Example

Loading group members with SMTP settings (based on the Legalesign Console app):

query UsersInGroup {
group(id: "Z3JwbGVnYWxlc2lnbxRldg==") {
id
owner
memberConnection {
groupMembers {
id
name
created
permission
emailHost
emailPort
emailUsername
emailPassword
enforceTwoFactor
user {
id
firstName
lastName
email
settings
}
}
}
invitationConnection {
invitations {
id
email
created
modified
permission
}
}
}
}

Export This Article

Save a copy of this page as PDF or plain text.