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
| Field | Type | Description |
|---|---|---|
id | ID! | Unique identifier |
name | String | Full name of the member |
permission | GroupPermission | Permission level (ADMINISTER, EDIT, READ, CREATESEND, SENDONLY, SOLOSEND, SOLOALL) |
features | AWSJSON | Features accessible to this member (based on licence and group permissions) |
isActive | Boolean | Whether the user is active or disabled by an admin |
suspended | Boolean | Whether the user is suspended |
sessionOnly | Boolean | Session-only access |
enforceTwoFactor | Boolean | Require MFA for group access |
created | AWSDateTime | When the membership was created |
modified | AWSDateTime | When the membership was last modified |
lastLogin | AWSDateTime | Last login time |
Permissions
| Field | Type | Description |
|---|---|---|
canAdminister | Boolean | Can add/remove users from the group |
canCreateSend | Boolean | Can create templates and send documents |
canEdit | Boolean | Can edit (non-readonly) |
Notifications
| Field | Type | Description |
|---|---|---|
dailyDigest | Boolean | Subscribed to daily activity summaries |
weeklyDigest | Boolean | Subscribed to weekly activity summaries |
visitEmail | Boolean | Notified when a recipient visits a document |
signedRejectedEmail | Boolean | Notified on sign/reject |
bounceEmail | String | Bounce notification setting |
Custom SMTP
| Field | Type | Description |
|---|---|---|
emailActive | Boolean | Using custom email server |
emailUsername | String | SMTP username |
emailPassword | String | SMTP password |
emailHost | String | SMTP host |
emailPort | Int | SMTP port |
Relationships
| Field | Type | Description |
|---|---|---|
group | Group! | The group |
user | User! | 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
}
}
}
}
Related
- Group — the group
- User — the user
- Invitation — pending invitations to join a group