Create a User Identity

POST /user_identities/create ⇒ { user_identity }

Creates a new user identity.

JavaScript

Request

await seam.userIdentities.create({
  user_identity_key: "jean_doe",
  email_address: "[e-mail]",
  phone_number: "[phone]",
  full_name: "Jean Doe",
});

Response

{
  "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
  "user_identity_key": "jean_doe",
  "email_address": "[e-mail]",
  "phone_number": "[phone]",
  "display_name": "Jean Doe",
  "full_name": "Jean Doe",
  "created_at": "2024-01-11T05:37:50.264Z",
  "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be"
}

Python

Request

seam.user_identities.create(
    user_identity_key="jean_doe",
    email_address="[e-mail]",
    phone_number="[phone]",
    full_name="Jean Doe",
)

Response

UserIdentity(
    user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
    user_identity_key="jean_doe",
    email_address="[e-mail]",
    phone_number="[phone]",
    display_name="Jean Doe",
    full_name="Jean Doe",
    created_at="2024-01-11T05:37:50.264Z",
    workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be",
)

Ruby

Request

seam.user_identities.create(
  user_identity_key: "jean_doe",
  email_address: "[e-mail]",
  phone_number: "[phone]",
  full_name: "Jean Doe",
)

Response

{
  "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
  "user_identity_key" => "jean_doe",
  "email_address" => "[e-mail]",
  "phone_number" => "[phone]",
  "display_name" => "Jean Doe",
  "full_name" => "Jean Doe",
  "created_at" => "2024-01-11T05:37:50.264Z",
  "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
}

PHP

Request

<?php
$seam->user_identities->create(
    user_identity_key: "jean_doe",
    email_address: "[e-mail]",
    phone_number: "[phone]",
    full_name: "Jean Doe"
);

Response

<?php
[
    "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
    "user_identity_key" => "jean_doe",
    "email_address" => "[e-mail]",
    "phone_number" => "[phone]",
    "display_name" => "Jean Doe",
    "full_name" => "Jean Doe",
    "created_at" => "2024-01-11T05:37:50.264Z",
    "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
];

Seam CLI

Request

seam user-identities create --user_identity_key "jean_doe" --email_address "[e-mail]" --phone_number "[phone]" --full_name "Jean Doe"

Response

{
  "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
  "user_identity_key": "jean_doe",
  "email_address": "[e-mail]",
  "phone_number": "[phone]",
  "display_name": "Jean Doe",
  "full_name": "Jean Doe",
  "created_at": "2024-01-11T05:37:50.264Z",
  "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be"
}

Go

Request

package main

import api "github.com/seamapi/go"

func main() {
	client.UserIdentities.Create(
		context.Background(),
		api.UserIdentitiesCreateRequest{
			UserIdentityKey: api.String("jean_doe"),
			EmailAddress:    api.String("[e-mail]"),
			PhoneNumber:     api.String("[phone]"),
			FullName:        api.String("Jean Doe"),
		},
	)
}

Response

api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "[e-mail]", PhoneNumber: "[phone]", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"}

Authentication Methods

• API key

• Personal access token Must also include the seam-workspace header in the request.

Request Parameters

email_address

Format: String Required: No

Unique email address for the user identity.

---

full_name

Format: String Required: No

Full name of the user associated with the user identity.

---

phone_number

Format: String Required: No

Unique phone number for the user identity in E.164 format (for example, [phone]).

---

user_identity_key

Format: String Required: No

Unique key for the user identity.

---

Return Type

user_identity