List Users

List all users associated with a given entity.

Entity ID

To retrieve your entity_id, use List Portfolios.

Use the Prime SDK or CLI to test this endpoint by following the quickstart guide and running with the following examples

Java

UsersService usersService = PrimeServiceFactory.createUsersService(client);

ListUsersRequest request = new ListUsersRequest.Builder()
    .entityId("ENTITY_ID_HERE")
    .build();

ListUsersResponse response = usersService.listUsers(request);

For more information, please visit the Prime Java SDK.

.NET

var usersService = new UsersService(client);

var request = new ListUsersRequest("ENTITY_ID_HERE");

var response = usersService.ListUsers(request);

For more information, please visit the Prime .NET SDK.

Go

usersService := users.NewUsersService(client)

request := &users.ListEntityUsersRequest{
    EntityId: "ENTITY_ID_HERE",
}

response, err := usersService.ListEntityUsers(context.Background(), request)

For more information, please visit the Prime Go SDK.

Python

prime_client = PrimeClient(credentials)

request = ListUsersRequest(
    entity_id="ENTITY_ID_HERE",
)

response = prime_client.list_users(request)

For more information, please visit the Prime Python SDK.

CLI

primectl list-entity-users --help

For more information, please visit the Prime CLI.

TS/JS

const usersService = new UsersService(client);

usersService.listUsers({
    entityId: 'ENTITY_ID_HERE'
}).then(async (response) => {
    console.log('Users: ', response);
})

For more information, please visit the Prime TS SDK.