Skip to main content

User CLI reference

View Markdown

User CLI 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​

anyscale user list​

Usage

anyscale 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

anyscale user get​

Usage

anyscale 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"
}

anyscale user list-permissions​

Usage

anyscale user list-permissions [OPTIONS]

List users and their effective cloud/project permissions across the organization.

Shows each user's access to clouds and projects, combining both individually granted permissions and permissions inherited from user groups. Also lists the current organization owners.

Output is JSON. Use --output to save to a file.

Options

  • --user-id: Filter to a specific user ID. If not provided, lists permissions for all users.
  • --output/-o: Write JSON output to a file instead of stdout.

Examples​

# List all users' effective cloud & project permissions
$ anyscale user list-permissions
(anyscale +0.6s) Listing users and their effective permissions...
{
  "organization_id": "org_p72",
  "org_owners": [
    {
      "user_email": "admin1@p72.com",
      "user_id": "usr_aaa"
    }
  ],
  "users": [
    {
      "clouds": [
        {
          "cloud_id": "cld_111",
          "cloud_name": "prod-cloud",
          "role": "collaborator",
          "projects": [
            {
              "project_id": "prj_111",
              "project_name": "prod-project",
              "role": "readonly"
            }
          ]
        }
      ],
      "user_email": "alice@p72.com",
      "user_id": "usr_abc"
    }
  ]
}

# List permissions for a specific user
$ anyscale user list-permissions --user-id usr_abc
(anyscale +0.4s) Listing users and their effective permissions...
{
  "organization_id": "org_p72",
  "org_owners": [
    {
      "user_email": "admin1@p72.com",
      "user_id": "usr_aaa"
    }
  ],
  "users": [
    {
      "clouds": [
        {
          "cloud_id": "cld_111",
          "cloud_name": "prod-cloud",
          "role": "collaborator"
        }
      ],
      "user_email": "alice@p72.com",
      "user_id": "usr_abc"
    }
  ]
}

User models​

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})")