cyphermed.api.roles.get_roles

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, name: Optional[str] = None, name_regex: Optional[str] = None, project_id: Optional[str] = None, group_id: Optional[str] = None, is_project_admin: Optional[bool] = None, is_group_admin: Optional[bool] = None) -> cyphermed.types.Response[typing.Union[cyphermed.models.admin_role_list.AdminRoleList, cyphermed.models.role_list.RoleList]]:

Get Roles

Get a list of all roles

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]): name (Union[Unset, str]): Name of the role name_regex (Union[Unset, str]): project_id (Union[Unset, str]): ID of the project the role is linked with, if any group_id (Union[Unset, str]): ID of the group the role is linked with, if any is_project_admin (Union[Unset, bool]): Whether to only return project admins is_group_admin (Union[Unset, bool]): Whether to only return group admins

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['AdminRoleList', 'RoleList']]

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, name: Optional[str] = None, name_regex: Optional[str] = None, project_id: Optional[str] = None, group_id: Optional[str] = None, is_project_admin: Optional[bool] = None, is_group_admin: Optional[bool] = None) -> Union[cyphermed.models.admin_role_list.AdminRoleList, cyphermed.models.role_list.RoleList, NoneType]:

Get Roles

Get a list of all roles

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]): name (Union[Unset, str]): Name of the role name_regex (Union[Unset, str]): project_id (Union[Unset, str]): ID of the project the role is linked with, if any group_id (Union[Unset, str]): ID of the group the role is linked with, if any is_project_admin (Union[Unset, bool]): Whether to only return project admins is_group_admin (Union[Unset, bool]): Whether to only return group admins

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['AdminRoleList', 'RoleList']

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, name: Optional[str] = None, name_regex: Optional[str] = None, project_id: Optional[str] = None, group_id: Optional[str] = None, is_project_admin: Optional[bool] = None, is_group_admin: Optional[bool] = None) -> cyphermed.types.Response[typing.Union[cyphermed.models.admin_role_list.AdminRoleList, cyphermed.models.role_list.RoleList]]:

Get Roles

Get a list of all roles

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]): name (Union[Unset, str]): Name of the role name_regex (Union[Unset, str]): project_id (Union[Unset, str]): ID of the project the role is linked with, if any group_id (Union[Unset, str]): ID of the group the role is linked with, if any is_project_admin (Union[Unset, bool]): Whether to only return project admins is_group_admin (Union[Unset, bool]): Whether to only return group admins

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['AdminRoleList', 'RoleList']]

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, name: Optional[str] = None, name_regex: Optional[str] = None, project_id: Optional[str] = None, group_id: Optional[str] = None, is_project_admin: Optional[bool] = None, is_group_admin: Optional[bool] = None) -> Union[cyphermed.models.admin_role_list.AdminRoleList, cyphermed.models.role_list.RoleList, NoneType]:

Get Roles

Get a list of all roles

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]): name (Union[Unset, str]): Name of the role name_regex (Union[Unset, str]): project_id (Union[Unset, str]): ID of the project the role is linked with, if any group_id (Union[Unset, str]): ID of the group the role is linked with, if any is_project_admin (Union[Unset, bool]): Whether to only return project admins is_group_admin (Union[Unset, bool]): Whether to only return group admins

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['AdminRoleList', 'RoleList']