List User Identities
POST /user_identities/list ⇒ { user_identities: [user_identity, …] }Returns a list of all user identities.
Request
await seam.userIdentities.list();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.list()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.list()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->list();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 listResponse
[
{
"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
func main() {
client.UserIdentities.List(context.Background())
}Response
[]api.UserIdentity{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
Client session token
Personal access token Must also include the
seam-workspaceheader in the request.
Request Parameters
credential_manager_acs_system_id
credential_manager_acs_system_idType: string Required: No
Return Type
Array<user_identity>
Last updated
Was this helpful?