Skip to content

Get user data (bizzstream.getUser)

You can use bizzstream.getUser to fetch information about a user.

bizzStream.getUser({ queryObject });
Parameter Type Required Description
_id String No The id of the user.
username String No The name of the user.
globalEmailAddress String No The global email address of the user. It must be a valid email address and the user must be in the environment.
name String No The name of the user in the environment.
email String No The email address of the user in the current environment.

SideNote:

  • One of the aforementioned parameters is required.

An example:

bizzStream.getUser({
     "email": "guest@defaultEnv.com"
})

Will result in:

{
  _id: 'rzKA9rYaGTFKPrZkL',
  username: 'guest',
  emails: [ { address: 'guest@maxedy.com', verified: true } ],
  external: true,
  profile: { environments: [ [Object] ] },
  _createdByUserId: 'system',
  _createdOn: '2021-01-22T08:00:17.827Z',
  _lastModifiedByUserId: 'system',
  _lastModifiedOn: '2021-01-22T08:00:17.841Z'
}