Get a User Identity
POST /user_identities/get ⇒ { user_identity }Returns a specified user identity.
Request
await seam.userIdentities.get({
user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
});Response
{
"user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
"user_identity_key": "jean_doe",
"email_address": "[email protected]",
"phone_number": "+15555550110",
"display_name": "Jean Doe",
"full_name": "Jean Doe",
"created_at": "2024-01-11T05:37:50.264Z",
"workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be"
}Request
seam.user_identities.get(user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a")Response
UserIdentity(
user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
user_identity_key="jean_doe",
email_address="[email protected]",
phone_number="+15555550110",
display_name="Jean Doe",
full_name="Jean Doe",
created_at="2024-01-11T05:37:50.264Z",
workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be",
)Request
seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a")Response
{
"user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
"user_identity_key" => "jean_doe",
"email_address" => "[email protected]",
"phone_number" => "+15555550110",
"display_name" => "Jean Doe",
"full_name" => "Jean Doe",
"created_at" => "2024-01-11T05:37:50.264Z",
"workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
}Request
<?php
$seam->user_identities->get(
user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"
);Response
<?php
[
"user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
"user_identity_key" => "jean_doe",
"email_address" => "[email protected]",
"phone_number" => "+15555550110",
"display_name" => "Jean Doe",
"full_name" => "Jean Doe",
"created_at" => "2024-01-11T05:37:50.264Z",
"workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
];Request
seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"Response
{
"user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
"user_identity_key": "jean_doe",
"email_address": "[email protected]",
"phone_number": "+15555550110",
"display_name": "Jean Doe",
"full_name": "Jean Doe",
"created_at": "2024-01-11T05:37:50.264Z",
"workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be"
}Request
package main
import api "github.com/seamapi/go"
func main() {
client.UserIdentities.Get(
context.Background(),
api.UserIdentitiesGetRequest{
UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"),
},
)
}Response
api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "[email protected]", PhoneNumber: "+15555550110", 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-workspaceheader in the request.
Request Parameters
user_identity_id
user_identity_idType: string Required: No
ID of the desired user identity.
user_identity_key
user_identity_keyType: string Required: No
Return Type
Last updated
Was this helpful?