accountUserSearch

Account User Search

This query returns an AccountUserType attempting to match against the request. We attempt to find a user with a close or exact match to the fields provided with a confidence score >= that of the threshold argument, if threshold isn't provided we use a internal base threshold of 1.0 tweak this parameter if you are not getting results as you'd expect.

This field requires the Authorization header to be set.

Arguments

input : AccountUserSearchInputType

Returns

AccountUserType!

User objects are the core of the authentication system. They typically represent a customer who manages a portfolio of one or more accounts.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can query account user

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query AccountUserSearch($input: AccountUserSearchInputType) {
  accountUserSearch(input: $input) {
    accounts {
      ...AccountInterfaceFragment
    }
    accountUserRoles {
      ...AccountUserRoleTypeFragment
    }
    address {
      ...RichAddressTypeFragment
    }
    alternativePhoneNumbers
    businesses {
      ...BusinessConnectionTypeConnectionFragment
    }
    consents {
      ...ConsentTypeFragment
    }
    createdAt
    dateOfBirth
    details {
      ...AccountUserDetailTypeFragment
    }
    email
    externalId
    familyName
    fullName
    givenName
    hasFamilyIssues
    holdMusicChoices {
      ...TrackOptionTypeFragment
    }
    id
    isActive
    isDeceased
    isInHardship
    isOptedInToWof
    label
    landline
    liveSecretKey
    mobile
    number
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    permissions {
      ...AccountUserPermissionFragment
    }
    portfolioIds
    portfolios {
      ...PortfolioConnectionTypeConnectionFragment
    }
    portfolioUserRoles {
      ...PortfolioUserRoleTypeFragment
    }
    preferences {
      ...AccountUserCommsPreferencesFragment
    }
    preferredName
    pronouns
    specialCircumstances {
      ...SpecialCircumstancesTypeFragment
    }
    title
  }
}

{
  "input": AccountUserSearchInputType
}

{
  "data": {
    "accountUserSearch": {
      "accounts": AccountInterface,
      "accountUserRoles": [AccountUserRoleType],
      "address": RichAddressType,
      "alternativePhoneNumbers": "guess-seem-drive-responsibility-responsibility",
      "businesses": BusinessConnectionTypeConnection,
      "consents": [ConsentType],
      "createdAt": "1987-04-15T13:01:47.970358+00:00",
      "dateOfBirth": "1976-01-08",
      "details": [AccountUserDetailType],
      "email": "however-manage-beyond-cost-area",
      "externalId": "90196914",
      "familyName": "Johnson",
      "fullName": "sell-raise-manager-more-rich",
      "givenName": "Paige",
      "hasFamilyIssues": true,
      "holdMusicChoices": [TrackOptionType],
      "id": "69362806",
      "isActive": true,
      "isDeceased": true,
      "isInHardship": true,
      "isOptedInToWof": true,
      "label": "garden-study-brother-realize-believe",
      "landline": "hundred-manager-help-collection-discuss",
      "liveSecretKey": "star-leg-oil-deep-resource",
      "mobile": "form-order-travel-yes-animal",
      "number": "something-tax-floor-himself-oil",
      "paymentMethods": PaymentInstructionConnectionTypeConnection,
      "permissions": [AccountUserPermission],
      "portfolioIds": "36291143",
      "portfolios": PortfolioConnectionTypeConnection,
      "portfolioUserRoles": [PortfolioUserRoleType],
      "preferences": AccountUserCommsPreferences,
      "preferredName": "hundred-they-serve-charge-trial",
      "pronouns": "address-certain-professor-arm-here",
      "specialCircumstances": SpecialCircumstancesType,
      "title": "candidate-leg-style-town-along"
    }
  }
}