Ctrl+K

Admin User Summary

get/api/v2/admin/user/{userId}/summary

Admin route to get user summary

Path Parameters

  • userIdstringRequired
    The user ID

Query Parameters

  • includeDeletedstring
    Whether to include deleted users
  • excludeWalletCountsstring
    Whether to exclude wallet counts
  • maxEnterprisesstring
    Maximum number of enterprises to return

200 Response

user object required
Fields that will always be populated in accordance with the defined codec If you find other fields that will provably always be populated on a given user (even for legacy users created long ago), that field can be moved to UserRequiredFields
enterprises array[object] required
The enterprise(s) the user is a member of
organizations array[object] required
The organizations the user is a member of
walletCounts object
hasMoreEnterprises boolean
bitgoAdminRoles array[string] required
The roles the user has in BitGo Admin
identity object required
The user's identity information
shardKey string required
Field used to shard mongo. Currently used to segregate PII data for the Korea org
Allowed values: bitgoKorea unset
pricingPlan string
The pricing plan the user is on
clientSettings object
custom flags set by the UI
agreements object required
The agreements the user has accepted
allowedCoins array[string] required
The coins the user is allowed to use
bitgoEmployee boolean required
Whether the user is a BitGo employee
currency object required
The user's preferred currency
disableReset2FA boolean required
Whether the user has disabled 2FA reset
featureFlags array[string] required
Any feature flags the user has enabled
forceResetPassword boolean required
Whether the user has forced a password reset
otpDevices array[object] required
The user's devices that can be used for OTP authentication
phone object required
The user's phone number
timezone string required
The user's timezone
apps
The apps the user has access to
country string
The country of the user
Example: USA
ecdhKeychain
string or null
The user's ECDH keychain
isActive boolean
Whether the user is active
isFrozen boolean
Whether the user is frozen
freezeReason string
The reason the user is frozen if they are frozen
Example: Frozen due to suspicious activity
freeze object
Freeze object that will hold the start time and expiration time of a user's freeze. By default the freeze is infinite, and this field will eventually override the isFrozen boolean field
lastLogin string <date-time>
The last login time of the user
locale string
The user's locale
pgpKey string
The user's PGP key
rateLimits
The rate limits applied to the user
referrer object
The referrer of the user
signupDomain string
The signup domain of the user
state string
The state of the user
Example: New York
sourceVerificationRequired boolean
Whether source verification is required for the user
sourceVerificationRequiredForReadOnlyAccess boolean
Whether source verification is required for read-only access
recoveryCodeSet object
The recovery code set for the user
createTime string
passwordUpdatedAt string <date-time>
id string required
The unique identifier for the user
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
username string <email>required
The username of the user
Example: user@email.com
name object required
The name of the user
email object required
The email address of the user