List Users

Entity IDTo 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

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.

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.

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.

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.

primectl list-entity-users --help

For more information, please visit the Prime CLI.

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.

Path Parameters

entity_id

string

required

The entity ID

Query Parameters

cursor

string

Cursor used for pagination (last consumed record)

limit

integer<int32>

Number of items to retrieve

sort_direction

enum<string>

default:DESC

Sorting order

Available options:

DESC,

ASC

Response

200 - application/json

A successful response.

users

object[]

The entity users.

Show child attributes

users.id

string

The unique ID of the user

Example:

"54496de6-7cbd-4abb-8489-2675c4d1f8f7"

users.name

string

The name of the user

Example:

"Frank Malone"

users.email

string

The email of the user

Example:

"[email protected]"

users.entity_id

string

The entity to which this user and associated permissions are identified

Example:

"2c521d6c-1cfb-4371-bf9c-5a42938d3e75"

users.role

enum<string>

USER_ROLE_UNKNOWN: nil value
AUDITOR: An auditor
SIGNATORY: A signatory
ADMIN: An admin
INITIATOR: An initiator
REVIEWER: A reviewer
TRADER: A trader
FULL_TRADER: A trader with full permissions
TEAM_MANAGER: A team manager
APPROVER: An approver
TAX_MANAGER: A tax manager

Available options:

AUDITOR,

SIGNATORY,

ADMIN,

INITIATOR,

REVIEWER,

TRADER,

FULL_TRADER,

TEAM_MANAGER,

APPROVER,

TAX_MANAGER

pagination

object

Show child attributes

pagination.next_cursor

string

required

Cursor to navigate to next page

pagination.sort_direction

enum<string>

default:DESC

required

Available options:

DESC,

ASC

pagination.has_next

boolean

required

A boolean value indicating whether there are more items to paginate through

REST API

FIX API

Websocket Feed

Path Parameters

Query Parameters

Response