removeUserFromOrganization

Remove a user from an organization (removes all roles and applications permissions)

removeUserFromOrganization(
  input: RemoveUserFromOrganizationInput
): RemoveUserFromOrganizationPayload!

Example

Query

mutation ($input: RemoveUserFromOrganizationInput) {
  removeUserFromOrganization(input: $input) {
    user {
      auth0Id
      authMethod
      displayName
      emailAddress
      githubUsername
      id
      isConsideredInactive
      isEmailLegacyUnverified
      isEmailVerified
      isVIP
      isVipAuthUser
      lastSeenAt
      samlIdentityProviderName
      samlNameId
      samlOrganizationId
      trackingUserId
      vipAuthId
      wpcomUsername
    }
  }
}

Variables

{
  "input": {
    "organizationId": 42,
    "userId": 42
  }
}

Response

{
  "data": {
    "removeUserFromOrganization": {
      "user": {
        "auth0Id": "auth0Id",
        "authMethod": "authMethod",
        "displayName": "displayName",
        "emailAddress": "emailAddress",
        "githubUsername": "example-user",
        "id": 42,
        "isConsideredInactive": true,
        "isEmailLegacyUnverified": true,
        "isEmailVerified": true,
        "isVIP": true,
        "isVipAuthUser": true,
        "lastSeenAt": "2024-01-15T00:00:00.000Z",
        "samlIdentityProviderName": "samlIdentityProviderName",
        "samlNameId": "samlNameId",
        "samlOrganizationId": 42,
        "trackingUserId": "trackingUserId",
        "vipAuthId": "vipAuthId",
        "wpcomUsername": "wpcomUsername"
      }
    }
  }
}

Arguments

removeUserFromOrganization.input ● RemoveUserFromOrganizationInput input common

The user and organization to remove.

Type

RemoveUserFromOrganizationPayload object common

The result of removing a user from an organization.