Skip to main content

removeOrgMember

Removes a user from an organization. Requires the 'manage_members' permission on the org (super admins bypass). DESTRUCTIVE: revokes the user's membership and role assignments in that org. Returns false if the user was not a member.

removeOrgMember(
  orgId: BigInt!
  userId: BigInt!
  idempotencyKey: String
): Boolean!

Arguments​

removeOrgMember.orgId ● BigInt! non-null scalar​

Organization id (BigInt as string).

removeOrgMember.userId ● BigInt! non-null scalar​

user_id of the member to remove (BigInt as string).

removeOrgMember.idempotencyKey ● String scalar​

Optional idempotency key. Recommended for retries: replaying with the same key and identical arguments returns the first result instead of re-applying; the same key with different arguments returns IDEMPOTENCY_CONFLICT. Keys expire after 24h.

Type​

Boolean scalar​

The Boolean scalar type represents true or false.