cyphermed.api.users.get_users

def sync_detailed( *, client: cyphermed.client.AuthenticatedClient, page_count: Optional[bool] = None, object_count: Optional[bool] = None, desc: Optional[bool] = None, bust_cache: Optional[bool] = None, is_active: Optional[bool] = None, is_delete_protected: Optional[bool] = None, created_by: Optional[str] = None, last_updated_by: Optional[str] = None, search: Optional[str] = None, search_fields: Optional[str] = None, limit: Optional[int] = None, page: Optional[int] = None, order_by: Optional[str] = None, created_date: Optional[datetime.datetime] = None, created_date_gte: Optional[datetime.datetime] = None, created_date_lte: Optional[datetime.datetime] = None, last_updated_date: Optional[datetime.datetime] = None, last_updated_date_gte: Optional[datetime.datetime] = None, last_updated_date_lte: Optional[datetime.datetime] = None, tags: Optional[str] = None, tags_contains: Optional[str] = None, tags_contains_any: Optional[str] = None, is_org_admin: Optional[bool] = None, is_project_admin: Optional[bool] = None, is_group_admin: Optional[bool] = None, project_id: Optional[str] = None, group_id: Optional[str] = None, role_id: Optional[str] = None, locale: Optional[str] = None, locale_regex: Optional[str] = None, zoneinfo: Optional[str] = None, zoneinfo_regex: Optional[str] = None, last_seen: Optional[datetime.datetime] = None, last_seen_gte: Optional[datetime.datetime] = None, last_seen_lte: Optional[datetime.datetime] = None, mfa_enabled: Optional[bool] = None, sms_mfa_enabled: Optional[bool] = None, software_mfa_enabled: Optional[bool] = None, email: Optional[str] = None, email_regex: Optional[str] = None, phone_number: Optional[str] = None, phone_number_regex: Optional[str] = None, nickname: Optional[str] = None, nickname_regex: Optional[str] = None, username: Optional[str] = None, username_regex: Optional[str] = None, first_name: Optional[str] = None, first_name_regex: Optional[str] = None, middle_name: Optional[str] = None, middle_name_regex: Optional[str] = None, last_name: Optional[str] = None, last_name_regex: Optional[str] = None) -> cyphermed.types.Response[typing.Union[cyphermed.models.admin_user_list.AdminUserList, cyphermed.models.anon_user_list.AnonUserList, cyphermed.models.user_list.UserList]]:

Get Users

Get a list of all users

Args: page_count (Union[Unset, bool]): Whether to only return the number of pages object_count (Union[Unset, bool]): Whether to only return the number of matching entries desc (Union[Unset, bool]): Whether to order results in descending order bust_cache (Union[Unset, bool]): Whether to bypass the cache and get the latest data is_active (Union[Unset, bool]): (Admin only) Whether to only return active accounts is_delete_protected (Union[Unset, bool]): Whether to only return delete-protected accounts created_by (Union[Unset, str]): ID of the user who created the account last_updated_by (Union[Unset, str]): ID of the user who last updated the account search (Union[Unset, str]): Search term to filter accounts by search_fields (Union[Unset, str]): Comma-delimited list of fields to search in limit (Union[Unset, int]): Maximum number of objects to return page (Union[Unset, int]): Page number to return order_by (Union[Unset, str]): Field to order results by created_date (Union[Unset, datetime.datetime]): Created date of items to return created_date_gte (Union[Unset, datetime.datetime]): created_date_lte (Union[Unset, datetime.datetime]): last_updated_date (Union[Unset, datetime.datetime]): Last edited date of items to return last_updated_date_gte (Union[Unset, datetime.datetime]): last_updated_date_lte (Union[Unset, datetime.datetime]): tags (Union[Unset, str]): Comma delimited list of tags on this account tags_contains (Union[Unset, str]): tags_contains_any (Union[Unset, str]): is_org_admin (Union[Unset, bool]): Whether to only return org admins is_project_admin (Union[Unset, bool]): Whether to only return project admins is_group_admin (Union[Unset, bool]): Whether to only return group admins project_id (Union[Unset, str]): ID of the project to filter accounts by group_id (Union[Unset, str]): ID of the group to filter accounts by role_id (Union[Unset, str]): ID of the role to filter accounts by locale (Union[Unset, str]): Locale of the account locale_regex (Union[Unset, str]): zoneinfo (Union[Unset, str]): Timezone of the account zoneinfo_regex (Union[Unset, str]): last_seen (Union[Unset, datetime.datetime]): Last time the account was seen last_seen_gte (Union[Unset, datetime.datetime]): last_seen_lte (Union[Unset, datetime.datetime]): mfa_enabled (Union[Unset, bool]): Whether to only return users with MFA enabled sms_mfa_enabled (Union[Unset, bool]): Whether to only return users with SMS MFA enabled software_mfa_enabled (Union[Unset, bool]): Whether to only return users with software MFA enabled email (Union[Unset, str]): Email of the user email_regex (Union[Unset, str]): phone_number (Union[Unset, str]): Phone number of the user phone_number_regex (Union[Unset, str]): nickname (Union[Unset, str]): Nickname of the user nickname_regex (Union[Unset, str]): username (Union[Unset, str]): Username of the user username_regex (Union[Unset, str]): first_name (Union[Unset, str]): First (or given) name of the user first_name_regex (Union[Unset, str]): middle_name (Union[Unset, str]): Middle name of the user middle_name_regex (Union[Unset, str]): last_name (Union[Unset, str]): Last (or family) name of the user last_name_regex (Union[Unset, str]):

Raises: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns: Response[Union['AdminUserList', 'AnonUserList', 'UserList']]

def sync( *, client: cyphermed.client.AuthenticatedClient, page_count: Optional[bool] = None, object_count: Optional[bool] = None, desc: Optional[bool] = None, bust_cache: Optional[bool] = None, is_active: Optional[bool] = None, is_delete_protected: Optional[bool] = None, created_by: Optional[str] = None, last_updated_by: Optional[str] = None, search: Optional[str] = None, search_fields: Optional[str] = None, limit: Optional[int] = None, page: Optional[int] = None, order_by: Optional[str] = None, created_date: Optional[datetime.datetime] = None, created_date_gte: Optional[datetime.datetime] = None, created_date_lte: Optional[datetime.datetime] = None, last_updated_date: Optional[datetime.datetime] = None, last_updated_date_gte: Optional[datetime.datetime] = None, last_updated_date_lte: Optional[datetime.datetime] = None, tags: Optional[str] = None, tags_contains: Optional[str] = None, tags_contains_any: Optional[str] = None, is_org_admin: Optional[bool] = None, is_project_admin: Optional[bool] = None, is_group_admin: Optional[bool] = None, project_id: Optional[str] = None, group_id: Optional[str] = None, role_id: Optional[str] = None, locale: Optional[str] = None, locale_regex: Optional[str] = None, zoneinfo: Optional[str] = None, zoneinfo_regex: Optional[str] = None, last_seen: Optional[datetime.datetime] = None, last_seen_gte: Optional[datetime.datetime] = None, last_seen_lte: Optional[datetime.datetime] = None, mfa_enabled: Optional[bool] = None, sms_mfa_enabled: Optional[bool] = None, software_mfa_enabled: Optional[bool] = None, email: Optional[str] = None, email_regex: Optional[str] = None, phone_number: Optional[str] = None, phone_number_regex: Optional[str] = None, nickname: Optional[str] = None, nickname_regex: Optional[str] = None, username: Optional[str] = None, username_regex: Optional[str] = None, first_name: Optional[str] = None, first_name_regex: Optional[str] = None, middle_name: Optional[str] = None, middle_name_regex: Optional[str] = None, last_name: Optional[str] = None, last_name_regex: Optional[str] = None) -> Union[cyphermed.models.admin_user_list.AdminUserList, cyphermed.models.anon_user_list.AnonUserList, cyphermed.models.user_list.UserList, NoneType]:

Get Users

Get a list of all users

Args: page_count (Union[Unset, bool]): Whether to only return the number of pages object_count (Union[Unset, bool]): Whether to only return the number of matching entries desc (Union[Unset, bool]): Whether to order results in descending order bust_cache (Union[Unset, bool]): Whether to bypass the cache and get the latest data is_active (Union[Unset, bool]): (Admin only) Whether to only return active accounts is_delete_protected (Union[Unset, bool]): Whether to only return delete-protected accounts created_by (Union[Unset, str]): ID of the user who created the account last_updated_by (Union[Unset, str]): ID of the user who last updated the account search (Union[Unset, str]): Search term to filter accounts by search_fields (Union[Unset, str]): Comma-delimited list of fields to search in limit (Union[Unset, int]): Maximum number of objects to return page (Union[Unset, int]): Page number to return order_by (Union[Unset, str]): Field to order results by created_date (Union[Unset, datetime.datetime]): Created date of items to return created_date_gte (Union[Unset, datetime.datetime]): created_date_lte (Union[Unset, datetime.datetime]): last_updated_date (Union[Unset, datetime.datetime]): Last edited date of items to return last_updated_date_gte (Union[Unset, datetime.datetime]): last_updated_date_lte (Union[Unset, datetime.datetime]): tags (Union[Unset, str]): Comma delimited list of tags on this account tags_contains (Union[Unset, str]): tags_contains_any (Union[Unset, str]): is_org_admin (Union[Unset, bool]): Whether to only return org admins is_project_admin (Union[Unset, bool]): Whether to only return project admins is_group_admin (Union[Unset, bool]): Whether to only return group admins project_id (Union[Unset, str]): ID of the project to filter accounts by group_id (Union[Unset, str]): ID of the group to filter accounts by role_id (Union[Unset, str]): ID of the role to filter accounts by locale (Union[Unset, str]): Locale of the account locale_regex (Union[Unset, str]): zoneinfo (Union[Unset, str]): Timezone of the account zoneinfo_regex (Union[Unset, str]): last_seen (Union[Unset, datetime.datetime]): Last time the account was seen last_seen_gte (Union[Unset, datetime.datetime]): last_seen_lte (Union[Unset, datetime.datetime]): mfa_enabled (Union[Unset, bool]): Whether to only return users with MFA enabled sms_mfa_enabled (Union[Unset, bool]): Whether to only return users with SMS MFA enabled software_mfa_enabled (Union[Unset, bool]): Whether to only return users with software MFA enabled email (Union[Unset, str]): Email of the user email_regex (Union[Unset, str]): phone_number (Union[Unset, str]): Phone number of the user phone_number_regex (Union[Unset, str]): nickname (Union[Unset, str]): Nickname of the user nickname_regex (Union[Unset, str]): username (Union[Unset, str]): Username of the user username_regex (Union[Unset, str]): first_name (Union[Unset, str]): First (or given) name of the user first_name_regex (Union[Unset, str]): middle_name (Union[Unset, str]): Middle name of the user middle_name_regex (Union[Unset, str]): last_name (Union[Unset, str]): Last (or family) name of the user last_name_regex (Union[Unset, str]):

Raises: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns: Union['AdminUserList', 'AnonUserList', 'UserList']

async def asyncio_detailed( *, client: cyphermed.client.AuthenticatedClient, page_count: Optional[bool] = None, object_count: Optional[bool] = None, desc: Optional[bool] = None, bust_cache: Optional[bool] = None, is_active: Optional[bool] = None, is_delete_protected: Optional[bool] = None, created_by: Optional[str] = None, last_updated_by: Optional[str] = None, search: Optional[str] = None, search_fields: Optional[str] = None, limit: Optional[int] = None, page: Optional[int] = None, order_by: Optional[str] = None, created_date: Optional[datetime.datetime] = None, created_date_gte: Optional[datetime.datetime] = None, created_date_lte: Optional[datetime.datetime] = None, last_updated_date: Optional[datetime.datetime] = None, last_updated_date_gte: Optional[datetime.datetime] = None, last_updated_date_lte: Optional[datetime.datetime] = None, tags: Optional[str] = None, tags_contains: Optional[str] = None, tags_contains_any: Optional[str] = None, is_org_admin: Optional[bool] = None, is_project_admin: Optional[bool] = None, is_group_admin: Optional[bool] = None, project_id: Optional[str] = None, group_id: Optional[str] = None, role_id: Optional[str] = None, locale: Optional[str] = None, locale_regex: Optional[str] = None, zoneinfo: Optional[str] = None, zoneinfo_regex: Optional[str] = None, last_seen: Optional[datetime.datetime] = None, last_seen_gte: Optional[datetime.datetime] = None, last_seen_lte: Optional[datetime.datetime] = None, mfa_enabled: Optional[bool] = None, sms_mfa_enabled: Optional[bool] = None, software_mfa_enabled: Optional[bool] = None, email: Optional[str] = None, email_regex: Optional[str] = None, phone_number: Optional[str] = None, phone_number_regex: Optional[str] = None, nickname: Optional[str] = None, nickname_regex: Optional[str] = None, username: Optional[str] = None, username_regex: Optional[str] = None, first_name: Optional[str] = None, first_name_regex: Optional[str] = None, middle_name: Optional[str] = None, middle_name_regex: Optional[str] = None, last_name: Optional[str] = None, last_name_regex: Optional[str] = None) -> cyphermed.types.Response[typing.Union[cyphermed.models.admin_user_list.AdminUserList, cyphermed.models.anon_user_list.AnonUserList, cyphermed.models.user_list.UserList]]:

Get Users

Get a list of all users

Args: page_count (Union[Unset, bool]): Whether to only return the number of pages object_count (Union[Unset, bool]): Whether to only return the number of matching entries desc (Union[Unset, bool]): Whether to order results in descending order bust_cache (Union[Unset, bool]): Whether to bypass the cache and get the latest data is_active (Union[Unset, bool]): (Admin only) Whether to only return active accounts is_delete_protected (Union[Unset, bool]): Whether to only return delete-protected accounts created_by (Union[Unset, str]): ID of the user who created the account last_updated_by (Union[Unset, str]): ID of the user who last updated the account search (Union[Unset, str]): Search term to filter accounts by search_fields (Union[Unset, str]): Comma-delimited list of fields to search in limit (Union[Unset, int]): Maximum number of objects to return page (Union[Unset, int]): Page number to return order_by (Union[Unset, str]): Field to order results by created_date (Union[Unset, datetime.datetime]): Created date of items to return created_date_gte (Union[Unset, datetime.datetime]): created_date_lte (Union[Unset, datetime.datetime]): last_updated_date (Union[Unset, datetime.datetime]): Last edited date of items to return last_updated_date_gte (Union[Unset, datetime.datetime]): last_updated_date_lte (Union[Unset, datetime.datetime]): tags (Union[Unset, str]): Comma delimited list of tags on this account tags_contains (Union[Unset, str]): tags_contains_any (Union[Unset, str]): is_org_admin (Union[Unset, bool]): Whether to only return org admins is_project_admin (Union[Unset, bool]): Whether to only return project admins is_group_admin (Union[Unset, bool]): Whether to only return group admins project_id (Union[Unset, str]): ID of the project to filter accounts by group_id (Union[Unset, str]): ID of the group to filter accounts by role_id (Union[Unset, str]): ID of the role to filter accounts by locale (Union[Unset, str]): Locale of the account locale_regex (Union[Unset, str]): zoneinfo (Union[Unset, str]): Timezone of the account zoneinfo_regex (Union[Unset, str]): last_seen (Union[Unset, datetime.datetime]): Last time the account was seen last_seen_gte (Union[Unset, datetime.datetime]): last_seen_lte (Union[Unset, datetime.datetime]): mfa_enabled (Union[Unset, bool]): Whether to only return users with MFA enabled sms_mfa_enabled (Union[Unset, bool]): Whether to only return users with SMS MFA enabled software_mfa_enabled (Union[Unset, bool]): Whether to only return users with software MFA enabled email (Union[Unset, str]): Email of the user email_regex (Union[Unset, str]): phone_number (Union[Unset, str]): Phone number of the user phone_number_regex (Union[Unset, str]): nickname (Union[Unset, str]): Nickname of the user nickname_regex (Union[Unset, str]): username (Union[Unset, str]): Username of the user username_regex (Union[Unset, str]): first_name (Union[Unset, str]): First (or given) name of the user first_name_regex (Union[Unset, str]): middle_name (Union[Unset, str]): Middle name of the user middle_name_regex (Union[Unset, str]): last_name (Union[Unset, str]): Last (or family) name of the user last_name_regex (Union[Unset, str]):

Raises: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns: Response[Union['AdminUserList', 'AnonUserList', 'UserList']]

async def asyncio( *, client: cyphermed.client.AuthenticatedClient, page_count: Optional[bool] = None, object_count: Optional[bool] = None, desc: Optional[bool] = None, bust_cache: Optional[bool] = None, is_active: Optional[bool] = None, is_delete_protected: Optional[bool] = None, created_by: Optional[str] = None, last_updated_by: Optional[str] = None, search: Optional[str] = None, search_fields: Optional[str] = None, limit: Optional[int] = None, page: Optional[int] = None, order_by: Optional[str] = None, created_date: Optional[datetime.datetime] = None, created_date_gte: Optional[datetime.datetime] = None, created_date_lte: Optional[datetime.datetime] = None, last_updated_date: Optional[datetime.datetime] = None, last_updated_date_gte: Optional[datetime.datetime] = None, last_updated_date_lte: Optional[datetime.datetime] = None, tags: Optional[str] = None, tags_contains: Optional[str] = None, tags_contains_any: Optional[str] = None, is_org_admin: Optional[bool] = None, is_project_admin: Optional[bool] = None, is_group_admin: Optional[bool] = None, project_id: Optional[str] = None, group_id: Optional[str] = None, role_id: Optional[str] = None, locale: Optional[str] = None, locale_regex: Optional[str] = None, zoneinfo: Optional[str] = None, zoneinfo_regex: Optional[str] = None, last_seen: Optional[datetime.datetime] = None, last_seen_gte: Optional[datetime.datetime] = None, last_seen_lte: Optional[datetime.datetime] = None, mfa_enabled: Optional[bool] = None, sms_mfa_enabled: Optional[bool] = None, software_mfa_enabled: Optional[bool] = None, email: Optional[str] = None, email_regex: Optional[str] = None, phone_number: Optional[str] = None, phone_number_regex: Optional[str] = None, nickname: Optional[str] = None, nickname_regex: Optional[str] = None, username: Optional[str] = None, username_regex: Optional[str] = None, first_name: Optional[str] = None, first_name_regex: Optional[str] = None, middle_name: Optional[str] = None, middle_name_regex: Optional[str] = None, last_name: Optional[str] = None, last_name_regex: Optional[str] = None) -> Union[cyphermed.models.admin_user_list.AdminUserList, cyphermed.models.anon_user_list.AnonUserList, cyphermed.models.user_list.UserList, NoneType]:

Get Users

Get a list of all users

Args: page_count (Union[Unset, bool]): Whether to only return the number of pages object_count (Union[Unset, bool]): Whether to only return the number of matching entries desc (Union[Unset, bool]): Whether to order results in descending order bust_cache (Union[Unset, bool]): Whether to bypass the cache and get the latest data is_active (Union[Unset, bool]): (Admin only) Whether to only return active accounts is_delete_protected (Union[Unset, bool]): Whether to only return delete-protected accounts created_by (Union[Unset, str]): ID of the user who created the account last_updated_by (Union[Unset, str]): ID of the user who last updated the account search (Union[Unset, str]): Search term to filter accounts by search_fields (Union[Unset, str]): Comma-delimited list of fields to search in limit (Union[Unset, int]): Maximum number of objects to return page (Union[Unset, int]): Page number to return order_by (Union[Unset, str]): Field to order results by created_date (Union[Unset, datetime.datetime]): Created date of items to return created_date_gte (Union[Unset, datetime.datetime]): created_date_lte (Union[Unset, datetime.datetime]): last_updated_date (Union[Unset, datetime.datetime]): Last edited date of items to return last_updated_date_gte (Union[Unset, datetime.datetime]): last_updated_date_lte (Union[Unset, datetime.datetime]): tags (Union[Unset, str]): Comma delimited list of tags on this account tags_contains (Union[Unset, str]): tags_contains_any (Union[Unset, str]): is_org_admin (Union[Unset, bool]): Whether to only return org admins is_project_admin (Union[Unset, bool]): Whether to only return project admins is_group_admin (Union[Unset, bool]): Whether to only return group admins project_id (Union[Unset, str]): ID of the project to filter accounts by group_id (Union[Unset, str]): ID of the group to filter accounts by role_id (Union[Unset, str]): ID of the role to filter accounts by locale (Union[Unset, str]): Locale of the account locale_regex (Union[Unset, str]): zoneinfo (Union[Unset, str]): Timezone of the account zoneinfo_regex (Union[Unset, str]): last_seen (Union[Unset, datetime.datetime]): Last time the account was seen last_seen_gte (Union[Unset, datetime.datetime]): last_seen_lte (Union[Unset, datetime.datetime]): mfa_enabled (Union[Unset, bool]): Whether to only return users with MFA enabled sms_mfa_enabled (Union[Unset, bool]): Whether to only return users with SMS MFA enabled software_mfa_enabled (Union[Unset, bool]): Whether to only return users with software MFA enabled email (Union[Unset, str]): Email of the user email_regex (Union[Unset, str]): phone_number (Union[Unset, str]): Phone number of the user phone_number_regex (Union[Unset, str]): nickname (Union[Unset, str]): Nickname of the user nickname_regex (Union[Unset, str]): username (Union[Unset, str]): Username of the user username_regex (Union[Unset, str]): first_name (Union[Unset, str]): First (or given) name of the user first_name_regex (Union[Unset, str]): middle_name (Union[Unset, str]): Middle name of the user middle_name_regex (Union[Unset, str]): last_name (Union[Unset, str]): Last (or family) name of the user last_name_regex (Union[Unset, str]):

Raises: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns: Union['AdminUserList', 'AnonUserList', 'UserList']