from metadata.sdk import configurefrom metadata.sdk.entities import Usersconfigure( host="https://your-company.open-metadata.org/api", jwt_token="your-jwt-token")# List first pageusers = Users.list(limit=50)for user in users.entities: print(f"{user.fullyQualifiedName.root}")# List all with auto-paginationfor user in Users.list_all(): print(f"{user.fullyQualifiedName.root}")# Filter by team with fieldsusers = Users.list( filters={"team": "Sales"}, fields=["teams", "roles", "domains"], limit=50)for user in users.entities: print(f"{user.fullyQualifiedName.root}") if user.teams: print(f" Teams: {[t.name for t in user.teams.root]}") if user.roles: print(f" Roles: {[r.name for r in user.roles.root]}")# Filter bot accountsbots = Users.list(filters={"isBot": "true"}, limit=50)
import org.openmetadata.sdk.models.ListParams;// client is an initialized OpenMetadataClient.// List first pagevar params = new ListParams().setLimit(50);var page = client.users().list(params);for (var item : page.getData()) { System.out.println(item.getFullyQualifiedName());}// Filter by team with fieldsvar filtered = new ListParams() .addFilter("team", "Sales") .setFields("teams,roles,domains") .setLimit(50);var filteredPage = client.users().list(filtered);for (var item : filteredPage.getData()) { System.out.println(item.getFullyQualifiedName());}
List all users with optional filtering and pagination
GET
/
v1
/
users
GET /v1/users
from metadata.sdk import configurefrom metadata.sdk.entities import Usersconfigure( host="https://your-company.open-metadata.org/api", jwt_token="your-jwt-token")# List first pageusers = Users.list(limit=50)for user in users.entities: print(f"{user.fullyQualifiedName.root}")# List all with auto-paginationfor user in Users.list_all(): print(f"{user.fullyQualifiedName.root}")# Filter by team with fieldsusers = Users.list( filters={"team": "Sales"}, fields=["teams", "roles", "domains"], limit=50)for user in users.entities: print(f"{user.fullyQualifiedName.root}") if user.teams: print(f" Teams: {[t.name for t in user.teams.root]}") if user.roles: print(f" Roles: {[r.name for r in user.roles.root]}")# Filter bot accountsbots = Users.list(filters={"isBot": "true"}, limit=50)
import org.openmetadata.sdk.models.ListParams;// client is an initialized OpenMetadataClient.// List first pagevar params = new ListParams().setLimit(50);var page = client.users().list(params);for (var item : page.getData()) { System.out.println(item.getFullyQualifiedName());}// Filter by team with fieldsvar filtered = new ListParams() .addFilter("team", "Sales") .setFields("teams,roles,domains") .setLimit(50);var filteredPage = client.users().list(filtered);for (var item : filteredPage.getData()) { System.out.println(item.getFullyQualifiedName());}
List all users with optional filtering and pagination.
Query Parameters
integer
default:"10"
Maximum number of results to return (max: 1000000).
string
Cursor for backward pagination.
string
Cursor for forward pagination.
string
Comma-separated list of fields to include: teams, roles, personas, domains, follows, owns. See Supported Fields below.
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
boolean
Filter by bot status. Set to true to list only bot accounts, false for human users only.
boolean
Filter by admin status. Set to true to list only admin users.
string
Filter by team name. Returns only users belonging to the specified team.
GET /v1/users
from metadata.sdk import configurefrom metadata.sdk.entities import Usersconfigure( host="https://your-company.open-metadata.org/api", jwt_token="your-jwt-token")# List first pageusers = Users.list(limit=50)for user in users.entities: print(f"{user.fullyQualifiedName.root}")# List all with auto-paginationfor user in Users.list_all(): print(f"{user.fullyQualifiedName.root}")# Filter by team with fieldsusers = Users.list( filters={"team": "Sales"}, fields=["teams", "roles", "domains"], limit=50)for user in users.entities: print(f"{user.fullyQualifiedName.root}") if user.teams: print(f" Teams: {[t.name for t in user.teams.root]}") if user.roles: print(f" Roles: {[r.name for r in user.roles.root]}")# Filter bot accountsbots = Users.list(filters={"isBot": "true"}, limit=50)
import org.openmetadata.sdk.models.ListParams;// client is an initialized OpenMetadataClient.// List first pagevar params = new ListParams().setLimit(50);var page = client.users().list(params);for (var item : page.getData()) { System.out.println(item.getFullyQualifiedName());}// Filter by team with fieldsvar filtered = new ListParams() .addFilter("team", "Sales") .setFields("teams,roles,domains") .setLimit(50);var filteredPage = client.users().list(filtered);for (var item : filteredPage.getData()) { System.out.println(item.getFullyQualifiedName());}