Create a User Identity

• Request Parameters

• Response

• Examples

Creates a new user identity.

Signature

POST /user_identities/create ⇒ { user_identity }

Authentication Methods

• API key

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

To learn more, see Authentication.

Request Parameters

acs_system_ids Array of UUIDs

List of ACS system IDs to associate with the user identity through ACS users. If there's no user with the same email address or phone number in the specified ACS systems, a new ACS user is created. If there is an existing user with the same email or phone number in the specified ACS systems, the user is linked to the user identity.

---

email_address String

Unique email address for the user identity.

---

full_name String

Full name of the user associated with the user identity.

---

phone_number String

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

---

user_identity_key String

Unique key for the user identity.

---

Response

user_identity

JSON

{
  JSON representation of user_identity
}

---

Examples

Create a user identity

Specify one or more of the unique user_identity_key, email_address, or phone_number. You can also specify the full_name of the user associated with the user_identity.

JavaScript

Code

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

Output

{
  "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
  "user_identity_key": "jean_doe",
  "email_address": "[email protected]",
  "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

Code

seam.user_identities.create(
    user_identity_key="jean_doe",
    email_address="[email protected]",
    phone_number="[phone]",
    full_name="Jean Doe",
)

Output

UserIdentity(
    user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
    user_identity_key="jean_doe",
    email_address="[email protected]",
    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

Code

seam.user_identities.create(
  user_identity_key: "jean_doe",
  email_address: "[email protected]",
  phone_number: "[phone]",
  full_name: "Jean Doe",
)

Output

{
  "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
  "user_identity_key" => "jean_doe",
  "email_address" => "[email protected]",
  "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

Code

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

Output

<?php
[
    "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
    "user_identity_key" => "jean_doe",
    "email_address" => "[email protected]",
    "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

Code

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

Output

{
  "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
  "user_identity_key": "jean_doe",
  "email_address": "[email protected]",
  "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

Code

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("[email protected]"),
			PhoneNumber:     api.String("[phone]"),
			FullName:        api.String("Jean Doe"),
		},
	)
}

Output

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

cURL

Code

curl --include --request POST "https://connect.getseam.com/user_identities/create" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "user_identity_key": "jean_doe",
  "email_address": "[email protected]",
  "phone_number": "[phone]",
  "full_name": "Jean Doe"
}
EOF

Output

{
  "user_identity": {
    "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
    "user_identity_key": "jean_doe",
    "email_address": "[email protected]",
    "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"
  }
}