Members

circle-exclamation

Organization members represent the relationship between users and organizations, including their roles and permissions within each organization.

Queries

member

Retrieves a member by its ID.

member(id: ID!): Member

Arguments

Name
Type
Description

id

ID!

The ID of the member to retrieve.

Output types:

chevron-rightMemberhashtag

A user's membership in an organization.

Implements: Node, Versioned

Field
Type
Description

id

ID!

A globally unique identifier. This ID is opaque and should not be parsed by clients.

version

Int!

The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.

user

The user.

organization

The organization the user belongs to.

isActive

Boolean!

Whether this membership is active.

assignedAt

DateTime!

The date and time when the user was assigned to this organization.

chevron-rightUser (entity)hashtag

A human user account authenticated via an identity provider.

Implements: Actor, Node, Versioned, Titled

Field
Type
Description

id

ID!

A globally unique identifier.

version

Int!

The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.

title

String!

The display name for the user. This is the user's full name for display purposes.

name

The structured name components from the identity provider.

identityProvider

String!

The identity provider name (keycloak, auth0, okta, etc.).

identityProviderId

String!

The user's unique ID in the identity provider.

email

EmailAddress!

The user's primary email address.

locale

Locale

The user's preferred locale.

externalId

String

An external system identifier for integration purposes.

isActive

Boolean!

Whether this user account is active.

memberships

The organization memberships for this user.


members

Lists members of an organization.

Arguments

Name
Type
Description

organizationId

ID!

The organization to retrieve members for.

filter

MemberFilter

Filtering options for the returned members.

first

Int

The first n elements from the paginated listarrow-up-right.

after

String

The elements that come after the specified cursorarrow-up-right.

last

Int

The last n elements from the paginated listarrow-up-right.

before

String

The elements that come before the specified cursorarrow-up-right.

orderBy

MemberOrder

The ordering options for the returned members.

Input types:

chevron-rightMemberFilterhashtag

Filtering options for members.

Field
Type
Description

userIds

[ID!]

Filter by users (OR within field).

isActive

Boolean

Filter by active status.

chevron-rightMemberOrderhashtag

Ordering options for members.

Field
Type
Description

field

The field to order by.

direction

The direction to order.

Output types:

chevron-rightMemberConnectionhashtag

A paginated list of Member items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

[Member!]!

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.

chevron-rightPageInfo (entity)hashtag

Information about the current page in a paginated connection.

Field
Type
Description

hasNextPage

Boolean!

Whether more items exist after the current page.

hasPreviousPage

Boolean!

Whether more items exist before the current page.

startCursor

String

The cursor pointing to the first item in the current page.

endCursor

String

The cursor pointing to the last item in the current page.


Mutations

memberCreate

Adds a user to an organization as a member.

Arguments

Name
Type
Description

input

MemberCreateInput!

The input fields for creating the membership.

Input types:

chevron-rightMemberCreateInputhashtag

Input for creating a membership.

Field
Type
Description

organizationId

ID!

The organization ID.

userId

ID!

The user ID to add.

Output types:

chevron-rightMemberPayloadhashtag

The result of a membership mutation.

Field
Type
Description

member

The created or updated membership.

chevron-rightMember (entity)hashtag

A user's membership in an organization.

Implements: Node, Versioned

Field
Type
Description

id

ID!

A globally unique identifier. This ID is opaque and should not be parsed by clients.

version

Int!

The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.

user

The user.

organization

The organization the user belongs to.

isActive

Boolean!

Whether this membership is active.

assignedAt

DateTime!

The date and time when the user was assigned to this organization.


memberUpdate

Updates a membership.

Arguments

Name
Type
Description

input

MemberUpdateInput!

The input fields for updating the membership.

Input types:

chevron-rightMemberUpdateInputhashtag

Input for updating a membership.

Field
Type
Description

id

ID!

The membership ID to update.

version

Int!

The current version for optimistic locking.

isActive

Boolean

The new active status.

Output types:

chevron-rightMemberPayloadhashtag

The result of a membership mutation.

Field
Type
Description

member

The created or updated membership.

chevron-rightMember (entity)hashtag

A user's membership in an organization.

Implements: Node, Versioned

Field
Type
Description

id

ID!

A globally unique identifier. This ID is opaque and should not be parsed by clients.

version

Int!

The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.

user

The user.

organization

The organization the user belongs to.

isActive

Boolean!

Whether this membership is active.

assignedAt

DateTime!

The date and time when the user was assigned to this organization.


memberRemove

Removes a user from an organization.

Arguments

Name
Type
Description

input

MemberRemoveInput!

The input fields for removing the membership.

Input types:

chevron-rightMemberRemoveInputhashtag

Input for removing a membership.

Field
Type
Description

id

ID!

The membership ID to remove.

version

Int!

The current version for optimistic locking.

Output types:

chevron-rightDeletePayloadhashtag

The result of a delete mutation.

Field
Type
Description

deletedId

ID!

The ID of the deleted entity.


Objects

Member

A user's membership in an organization.

Implements: Node, Versioned

Field
Type
Description

id

ID!

A globally unique identifier. This ID is opaque and should not be parsed by clients.

version

Int!

The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.

user

The user.

organization

The organization the user belongs to.

isActive

Boolean!

Whether this membership is active.

assignedAt

DateTime!

The date and time when the user was assigned to this organization.


MemberPayload

The result of a membership mutation.

Field
Type
Description

member

The created or updated membership.


Inputs

MemberFilter

Filtering options for members.

Field
Type
Description

userIds

[ID!]

Filter by users (OR within field).

isActive

Boolean

Filter by active status.


MemberOrder

Ordering options for members.

Field
Type
Description

field

The field to order by.

direction

The direction to order.


MemberCreateInput

Input for creating a membership.

Field
Type
Description

organizationId

ID!

The organization ID.

userId

ID!

The user ID to add.


MemberUpdateInput

Input for updating a membership.

Field
Type
Description

id

ID!

The membership ID to update.

version

Int!

The current version for optimistic locking.

isActive

Boolean

The new active status.


MemberRemoveInput

Input for removing a membership.

Field
Type
Description

id

ID!

The membership ID to remove.

version

Int!

The current version for optimistic locking.


Enums

MemberOrderField

Fields available for ordering members.

Value
Description

ASSIGNED_AT

Order by assignment date.


Pagination types

MemberConnection

A paginated list of Member items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

[Member!]!

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.


MemberEdge

An edge in the Member connection.

Implements: Edge

Field
Type
Description

cursor

String!

An opaque cursor for this edge.

node

The member at the end of the edge.


Last updated

Was this helpful?