Users

A member sees a tenant’s studies only after they belong to that Express customer. Isolation rules are on Isolation.

Invite first from AutoScribe or Viewer. The person must accept the invitation before you can add them to a customer.

A user can belong to more than one customer (shared readers across sites). They then see the union of those customers’ studies — never other tenants, never unattached studies.

Do not make end-customer users admins.

Via dashboard

1. Open Express Customers and select a customer.
2. Click Add User.
3. Choose a user who has accepted their invitation.
4. Click Add.

Add

TypeScript

import Avara from "avara";

const client = new Avara({
  apiKey: process.env.AVARA_API_KEY,
});

await client.express.users.add("cus_1234567890abcdef1234567890abcdef", {
  userId: "usr_1234567890abcdef1234567890abcdef",
});

Python

import os
from avara import Avara

client = Avara(
    api_key=os.environ.get("AVARA_API_KEY"),
)
client.express.users.add(
    "cus_1234567890abcdef1234567890abcdef",
    user_id="usr_1234567890abcdef1234567890abcdef",
)

Java

package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.express.users.UserAddParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        UserAddParams params = UserAddParams.builder()
            .userId("usr_1234567890abcdef1234567890abcdef")
            .build();
        client.express().users().add(
            "cus_1234567890abcdef1234567890abcdef",
            params
        );
    }
}

C#

using Avara;
using Avara.Models.Express.Users;

var client = new AvaraClient();

await client.Express.Users.Add(
    "cus_1234567890abcdef1234567890abcdef",
    new UserAddParams
    {
        UserId = "usr_1234567890abcdef1234567890abcdef",
    }
);

Remove

TypeScript

await client.express.users.remove("cus_1234567890abcdef1234567890abcdef", {
  userId: "usr_1234567890abcdef1234567890abcdef",
});

Python

client.express.users.remove(
    "cus_1234567890abcdef1234567890abcdef",
    user_id="usr_1234567890abcdef1234567890abcdef",
)

Java

UserRemoveParams params = UserRemoveParams.builder()
    .userId("usr_1234567890abcdef1234567890abcdef")
    .build();
client.express().users().remove(
    "cus_1234567890abcdef1234567890abcdef",
    params
);

C#

await client.Express.Users.Remove(
    "cus_1234567890abcdef1234567890abcdef",
    new UserRemoveParams
    {
        UserId = "usr_1234567890abcdef1234567890abcdef",
    }
);

For every field on these calls, see the API Reference.