Skip to main content

User API Reference

View Markdown

User API Reference

Customer-hosted cloud features​

note

Some features are only available on customer-hosted clouds. Reach out to support@anyscale.com for info.

User CLI​

user batch-create​

Usage

user batch-create [OPTIONS]

Batch create, as an admin, users without email verification.

Options

  • --users-file/-f: Path to a YAML file that contains the information for user accounts to be created.

Examples​

$ anyscale user batch-create --users-file users.yaml
(anyscale +0.5s) Creating users...
(anyscale +0.8s) 2 users created.

$ cat users_file.yaml
create_users:
  - name: name1
    email: test1@anyscale.com
    password: ''
    is_sso_user: false
    lastname: lastname1
    title: title1
  - name: name2
    email: test2@anyscale.com
    password: ''
    is_sso_user: false
    lastname: lastname2
    title: title2

user list​

Usage

user list [OPTIONS]

List users within your organization.

Options

  • --email: Filter users by email.
  • --name: Filter users by display name.
  • --collaborator-type: Filter users by collaborator type.
  • --service-account: Only show service accounts.
  • --user-account: Only show user accounts (non-service accounts).
  • --max-items: Maximum number of users to display when running non-interactively.
  • --page-size: Items per page (max 50).
  • --json/--no-json: Render output as JSON instead of a table.
  • --interactive/--no-interactive: Enable or disable interactive pagination.

Examples​

$ anyscale user list --page-size 5 --no-interactive
Output
USERS:
EMAIL                ID         NAME         ROLE         CREATED AT
owner@anyscale.com   usr_owner  Owner Name   owner        2024-01-01 12:00
service@anyscale.com           Service Bot  collaborator 2024-02-01 08:30

user get​

Usage

user get [OPTIONS]

Get details for a single user in your organization.

Options

  • --email: Email address of the user.
  • --name: Display name of the user.
  • --collaborator-type: Optional collaborator type constraint.
  • --service-account: Restrict to service accounts.
  • --user-account: Restrict to individual user accounts.
  • --json/--no-json: Output JSON instead of YAML.

Examples​

$ anyscale user get --email owner@anyscale.com --json
Output
{
  "name": "Owner Name",
  "email": "owner@anyscale.com",
  "created_at": "2024-01-01T12:00:00+00:00",
  "permission_level": "owner",
  "user_id": "usr_owner"
}

User SDK​

anyscale.user.admin_batch_create​

Batch create, as an admin, users without email verification.

Arguments

  • admin_create_users (List[AdminCreateUser]): Users to be created by an admin.

Returns: List[AdminCreatedUser]

Examples​

import anyscale
from anyscale.user.models import AdminCreateUser

anyscale.user.admin_batch_create(
    [AdminCreateUser(
        name="name",
        email="test@anyscale.com",
        password="",
        is_sso_user=False,
        lastname="lastname",
        title="title",
    ),],
)

anyscale.user.list​

List collaborators within the organization.

Arguments

  • email (str | None) = None: Filter collaborators by exact email address.
  • name (str | None) = None: Filter collaborators by exact display name.
  • collaborator_type (str | None) = None: Filter by collaborator type. Accepts values such as 'all_accounts', 'only_service_accounts', or 'only_user_accounts'.
  • is_service_account (bool | None) = None: If provided, filter collaborators by whether they are service accounts.
  • max_items (int | None) = None: Maximum total number of users to yield (default: iterate all).
  • page_size (int | None) = None: Number of users fetched per API request (default: API default).

Returns: ResultIterator[User]

Examples​

import anyscale

for user in anyscale.user.list(max_items=10):
    print(user.email)

anyscale.user.get​

Retrieve a single collaborator by email or name.

Arguments

  • email (str | None) = None: Email address of the user to retrieve.
  • name (str | None) = None: Display name of the user to retrieve.
  • collaborator_type (str | None) = None: Optional collaborator type constraint when fetching the user.
  • is_service_account (bool | None) = None: Filter by whether the user is a service account.

Returns: User

Examples​

import anyscale

user = anyscale.user.get(email="owner@anyscale.com")
print(user.permission_level)

User Models​

AdminCreateUser​

User to be created by an admin.

Fields​

  • name (str): First name of the user to be created.
  • email (str): Email of the user to be created.
  • password (str | None): Password for the user account being created.
  • is_sso_user (bool): Whether the user is an SSO user. SSO users can log in using SSO.
  • lastname (str | None): Optional last name of the user to be created.
  • title (str | None): Optional title of the user to be created.

Python Methods​

def to_dict(self) -> Dict[str, Any]
    """Return a dictionary representation of the model."""

Examples​

import anyscale
from anyscale.user.models import AdminCreateUser

admin_create_user = AdminCreateUser(
    # First name of the user to be created.
    name="name",
    # Email of the user to be created.
    email="test@anyscale.com",
    # Password for the user account being created.
    password="",
    # Whether the user is an SSO user. SSO users can log in using SSO.
    is_sso_user=False,
    # Optional last name of the user to be created.
    lastname="lastname",
    # Optional title of the user to be created.
    title="title",
)

AdminCreatedUser​

User account created by an admin that has organization collaborator permissions.

Fields​

  • user_id (str): ID of the user that has been created.
  • name (str): First name of the user that has been created.
  • email (str): Email of the user that has been created.
  • created_at (datetime): The timestamp of when the user is created.
  • is_sso_user (bool): Whether the user is an SSO user. SSO users can log in using SSO.
  • lastname (str | None): Optional last name of the user that has been created.
  • title (str | None): Optional title of the user that has been created.

Python Methods​

def to_dict(self) -> Dict[str, Any]
    """Return a dictionary representation of the model."""

Examples​

import anyscale
from anyscale.user.models import AdminCreatedUser

admin_create_user = AdminCreateUser(
    # First name of the user to be created.
    name="name",
    # Email of the user to be created.
    email="test@anyscale.com",
    # Password for the user account being created.
    password="",
    # Whether the user is an SSO user. SSO users can log in using SSO.
    is_sso_user=False,
    # Optional last name of the user to be created.
    lastname="lastname",
    # Optional title of the user to be created.
    title="title",
)
admin_created_users: List[AdminCreatedUser] = anyscale.user.admin_batch_create([admin_create_user])

User​

Collaborator returned by anyscale.user APIs.

Fields​

  • email (str): Email address associated with the collaborator.
  • name (str): Display name of the collaborator.
  • created_at (datetime): Timestamp for when the collaborator was created.
  • permission_level (str): Organization permission level for the collaborator.
  • user_id (str | None): Optional user ID backing the collaborator (may be absent for service accounts).

Python Methods​

def to_dict(self) -> Dict[str, Any]
    """Return a dictionary representation of the model."""

Examples​

import anyscale

for user in anyscale.user.list(max_items=5):
    print(f"{user.email} ({user.permission_level})")