List User Identities

Returns a list of all user identities.

POST /user_identities/list ⇒ { user_identities: [user_identity, …] }

Authentication Methods

API key
Client session token
Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

credential_manager_acs_system_id String

Response

Array of user_identitys

{
  JSON representation of user_identity
}

Examples

List user identities

To filter the list of user identities, specify the desired credential_manager_acs_system_id.

Code

await seam.userIdentities.list();

Output

[
  {
    "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"
  }
]

Code

seam.user_identities.list()

Output

[
    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",
    )
]

Code

seam.user_identities.list()

Output

[
  {
    "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",
  },
]

Code

<?php
$seam->user_identities->list();

Output

<?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",
    ],
];

Code

seam user-identities list

Output

[
  {
    "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"
  }
]

Code

package main

func main() {
	client.UserIdentities.List(context.Background())
}

Output

[]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"}}

Code

curl --include --request POST "https://connect.getseam.com/user_identities/list" \
  --header "Authorization: Bearer $SEAM_API_KEY"

Output

{
  "user_identities": [
    {
      "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"
    }
  ]
}

PreviousCreate a User Identity NextGet a User Identity

Last updated 10 months ago

Was this helpful?

hashtagRequest Parameters

hashtagResponse

hashtagExamples

hashtagList user identities

Request Parameters

Response

Examples

List user identities