Adding Users

This endpoint allows you to insert a new user.

Name	Type	Description
id	string	The unique identifier for the new user (eg. username, user id, etc.). The value is restricted to alphanumeric characters, dashes and underscore symbols.
data	object	The data related to the user.

// create a new user, if the user already exists an error is returned
const userData = new Dictionary<string, object>
{
  {"name", "John Doe" },
  {"occupation", "Software Engineer"},
  {"gender", "male"},
};

await client.Users.AddAsync("john-doe", userData);

// get or create a new user, if the user already exists the user is returned
await client.Users.AddAsync("john-doe", userData, true);

// create a new user, if the user already exists an error is returned
client.user("john-doe").create({
  name: "John Doe", 
  occupation: "Software Engineer",
  gender: 'male'
});

// get or create a new user, if the user already exists the user is returned
client.user("john-doe").getOrCreate({
  name: "John Doe", 
  occupation: "Software Engineer",
  gender: 'male'
});

# create a new user, if the user already exists an error is returned
client.users.add(
  "john-doe",
  {"name": "John Doe", "occupation": "Software Engineer", "gender": "male"},
)

# get or create a new user, if the user already exists the user is returned
client.users.add(
  "john-doe",
  {"name": "John Doe", "occupation": "Software Engineer", "gender": "male"},
  get_or_create=True,
)

# create a new user, if the user already exists, an error is returned
client.users.add(
  "john-doe", 
  :data => {:name => "John Doe", :occupation => "Software Engineer", :gender => "male"},
)

# get or create a new user, if the user already exists, the user is returned
client.users.add(
  "john-doe", 
  :data => {:name => "John Doe", :occupation => "Software Engineer", :gender => "male"},
  :get_or_create => true,
)

// create a new user with the name in userdata
$user = $client->users()->add('42', array('name' => 'Arthur Dent'));
// get OR create the user
$user = $client->users()->add('42', array('name' => 'Arthur Dent'), true);

// create a new user, if the user already exists an error is returned
client.user("john-doe").create(new Data()
    .set("name", "John Doe")
    .set("occupation", "Software Engineer")
    .set("gender", "male")).join();

// get or create a new user, if the user already exists the user is returned
client.user("john-doe").getOrCreate(new Data()
    .set("name", "John Doe")
    .set("occupation", "Software Engineer")
    .set("gender", "male")).join();

// create a new user, if the user already exist an error is returned
	userData := stream.User{
		ID: "123",
		Data: map[string]any{
			"name":    "John Doe",
			"occupation": "Software Engineer",
			"gender":   "male",
		},
	}
	resp, err := client.Users().Add(context.TODO(), userData, false)
	if err != nil {
		panic(err)
	}

	// get or create a new user, if the user already exist the user is returned
	resp, err := client.Users().Add(context.TODO(), userData, true)
	if err != nil {
		panic(err)
	}

// create a new user, if the user already exists an error is returned
client.create(user: User(id: "john-doe"), getOrCreate: false) { result in /* ... */ }

// get or create a new user, if the user already exists the user is returned
client.create(user: User(id: "john-doe"), getOrCreate: true) { result in /* ... */ }

Users

Retrieving Users