cyphermed.api.roles.get_role_group_access

def sync_detailed( role_id: str, *, 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, ids_only: Optional[bool] = None, can_read: Optional[bool] = None, can_update: Optional[bool] = None, user_permissions_can_create: Optional[bool] = None, user_permissions_can_read: Optional[bool] = None, user_permissions_can_update: Optional[bool] = None, user_permissions_can_delete: Optional[bool] = None, device_permissions_can_create: Optional[bool] = None, device_permissions_can_read: Optional[bool] = None, device_permissions_can_update: Optional[bool] = None, device_permissions_can_delete: Optional[bool] = None, group_name: Optional[str] = None, group_description: Optional[str] = None, group_tags: Optional[str] = None, group_tags_contains: Optional[str] = None, group_tags_contains_any: Optional[str] = None, project_id: Optional[str] = None, is_admin: Optional[bool] = None, role_permissions_can_create: Optional[bool] = None, role_permissions_can_read: Optional[bool] = None, role_permissions_can_update: Optional[bool] = None, role_permissions_can_delete: Optional[bool] = None) -> cyphermed.types.Response[cyphermed.models.role_group_access_list.RoleGroupAccessList]:

Get Role Group Access

Get list of group access objects assigned to the target role

Args: role_id (str): 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]): ids_only (Union[Unset, bool]): Return list(s) of IDs only can_read (Union[Unset, bool]): Return only access for resources you can read can_update (Union[Unset, bool]): Return only access for resources you can update user_permissions_can_create (Union[Unset, bool]): User membership create permission user_permissions_can_read (Union[Unset, bool]): User membership read permission user_permissions_can_update (Union[Unset, bool]): User membership update permission user_permissions_can_delete (Union[Unset, bool]): User membership delete permission device_permissions_can_create (Union[Unset, bool]): Device membership create permissions device_permissions_can_read (Union[Unset, bool]): Device membership read permissions device_permissions_can_update (Union[Unset, bool]): Device membership update permissions device_permissions_can_delete (Union[Unset, bool]): Device membership delete permissions group_name (Union[Unset, str]): Return access for groups with a specific name group_description (Union[Unset, str]): Return access for groups with a specific description group_tags (Union[Unset, str]): Return access for groups with specific tags group_tags_contains (Union[Unset, str]): group_tags_contains_any (Union[Unset, str]): project_id (Union[Unset, str]): Only return group access under a specific project is_admin (Union[Unset, bool]): Only return group access with admin access role_permissions_can_create (Union[Unset, bool]): Role membership create permissions role_permissions_can_read (Union[Unset, bool]): Role membership read permissions role_permissions_can_update (Union[Unset, bool]): Role membership update permissions role_permissions_can_delete (Union[Unset, bool]): Role membership delete permissions

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[RoleGroupAccessList]

def sync( role_id: str, *, 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, ids_only: Optional[bool] = None, can_read: Optional[bool] = None, can_update: Optional[bool] = None, user_permissions_can_create: Optional[bool] = None, user_permissions_can_read: Optional[bool] = None, user_permissions_can_update: Optional[bool] = None, user_permissions_can_delete: Optional[bool] = None, device_permissions_can_create: Optional[bool] = None, device_permissions_can_read: Optional[bool] = None, device_permissions_can_update: Optional[bool] = None, device_permissions_can_delete: Optional[bool] = None, group_name: Optional[str] = None, group_description: Optional[str] = None, group_tags: Optional[str] = None, group_tags_contains: Optional[str] = None, group_tags_contains_any: Optional[str] = None, project_id: Optional[str] = None, is_admin: Optional[bool] = None, role_permissions_can_create: Optional[bool] = None, role_permissions_can_read: Optional[bool] = None, role_permissions_can_update: Optional[bool] = None, role_permissions_can_delete: Optional[bool] = None) -> Optional[cyphermed.models.role_group_access_list.RoleGroupAccessList]:

Get Role Group Access

Get list of group access objects assigned to the target role

Args: role_id (str): 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]): ids_only (Union[Unset, bool]): Return list(s) of IDs only can_read (Union[Unset, bool]): Return only access for resources you can read can_update (Union[Unset, bool]): Return only access for resources you can update user_permissions_can_create (Union[Unset, bool]): User membership create permission user_permissions_can_read (Union[Unset, bool]): User membership read permission user_permissions_can_update (Union[Unset, bool]): User membership update permission user_permissions_can_delete (Union[Unset, bool]): User membership delete permission device_permissions_can_create (Union[Unset, bool]): Device membership create permissions device_permissions_can_read (Union[Unset, bool]): Device membership read permissions device_permissions_can_update (Union[Unset, bool]): Device membership update permissions device_permissions_can_delete (Union[Unset, bool]): Device membership delete permissions group_name (Union[Unset, str]): Return access for groups with a specific name group_description (Union[Unset, str]): Return access for groups with a specific description group_tags (Union[Unset, str]): Return access for groups with specific tags group_tags_contains (Union[Unset, str]): group_tags_contains_any (Union[Unset, str]): project_id (Union[Unset, str]): Only return group access under a specific project is_admin (Union[Unset, bool]): Only return group access with admin access role_permissions_can_create (Union[Unset, bool]): Role membership create permissions role_permissions_can_read (Union[Unset, bool]): Role membership read permissions role_permissions_can_update (Union[Unset, bool]): Role membership update permissions role_permissions_can_delete (Union[Unset, bool]): Role membership delete permissions

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: RoleGroupAccessList

async def asyncio_detailed( role_id: str, *, 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, ids_only: Optional[bool] = None, can_read: Optional[bool] = None, can_update: Optional[bool] = None, user_permissions_can_create: Optional[bool] = None, user_permissions_can_read: Optional[bool] = None, user_permissions_can_update: Optional[bool] = None, user_permissions_can_delete: Optional[bool] = None, device_permissions_can_create: Optional[bool] = None, device_permissions_can_read: Optional[bool] = None, device_permissions_can_update: Optional[bool] = None, device_permissions_can_delete: Optional[bool] = None, group_name: Optional[str] = None, group_description: Optional[str] = None, group_tags: Optional[str] = None, group_tags_contains: Optional[str] = None, group_tags_contains_any: Optional[str] = None, project_id: Optional[str] = None, is_admin: Optional[bool] = None, role_permissions_can_create: Optional[bool] = None, role_permissions_can_read: Optional[bool] = None, role_permissions_can_update: Optional[bool] = None, role_permissions_can_delete: Optional[bool] = None) -> cyphermed.types.Response[cyphermed.models.role_group_access_list.RoleGroupAccessList]:

Get Role Group Access

Get list of group access objects assigned to the target role

Args: role_id (str): 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]): ids_only (Union[Unset, bool]): Return list(s) of IDs only can_read (Union[Unset, bool]): Return only access for resources you can read can_update (Union[Unset, bool]): Return only access for resources you can update user_permissions_can_create (Union[Unset, bool]): User membership create permission user_permissions_can_read (Union[Unset, bool]): User membership read permission user_permissions_can_update (Union[Unset, bool]): User membership update permission user_permissions_can_delete (Union[Unset, bool]): User membership delete permission device_permissions_can_create (Union[Unset, bool]): Device membership create permissions device_permissions_can_read (Union[Unset, bool]): Device membership read permissions device_permissions_can_update (Union[Unset, bool]): Device membership update permissions device_permissions_can_delete (Union[Unset, bool]): Device membership delete permissions group_name (Union[Unset, str]): Return access for groups with a specific name group_description (Union[Unset, str]): Return access for groups with a specific description group_tags (Union[Unset, str]): Return access for groups with specific tags group_tags_contains (Union[Unset, str]): group_tags_contains_any (Union[Unset, str]): project_id (Union[Unset, str]): Only return group access under a specific project is_admin (Union[Unset, bool]): Only return group access with admin access role_permissions_can_create (Union[Unset, bool]): Role membership create permissions role_permissions_can_read (Union[Unset, bool]): Role membership read permissions role_permissions_can_update (Union[Unset, bool]): Role membership update permissions role_permissions_can_delete (Union[Unset, bool]): Role membership delete permissions

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[RoleGroupAccessList]

async def asyncio( role_id: str, *, 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, ids_only: Optional[bool] = None, can_read: Optional[bool] = None, can_update: Optional[bool] = None, user_permissions_can_create: Optional[bool] = None, user_permissions_can_read: Optional[bool] = None, user_permissions_can_update: Optional[bool] = None, user_permissions_can_delete: Optional[bool] = None, device_permissions_can_create: Optional[bool] = None, device_permissions_can_read: Optional[bool] = None, device_permissions_can_update: Optional[bool] = None, device_permissions_can_delete: Optional[bool] = None, group_name: Optional[str] = None, group_description: Optional[str] = None, group_tags: Optional[str] = None, group_tags_contains: Optional[str] = None, group_tags_contains_any: Optional[str] = None, project_id: Optional[str] = None, is_admin: Optional[bool] = None, role_permissions_can_create: Optional[bool] = None, role_permissions_can_read: Optional[bool] = None, role_permissions_can_update: Optional[bool] = None, role_permissions_can_delete: Optional[bool] = None) -> Optional[cyphermed.models.role_group_access_list.RoleGroupAccessList]:

Get Role Group Access

Get list of group access objects assigned to the target role

Args: role_id (str): 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]): ids_only (Union[Unset, bool]): Return list(s) of IDs only can_read (Union[Unset, bool]): Return only access for resources you can read can_update (Union[Unset, bool]): Return only access for resources you can update user_permissions_can_create (Union[Unset, bool]): User membership create permission user_permissions_can_read (Union[Unset, bool]): User membership read permission user_permissions_can_update (Union[Unset, bool]): User membership update permission user_permissions_can_delete (Union[Unset, bool]): User membership delete permission device_permissions_can_create (Union[Unset, bool]): Device membership create permissions device_permissions_can_read (Union[Unset, bool]): Device membership read permissions device_permissions_can_update (Union[Unset, bool]): Device membership update permissions device_permissions_can_delete (Union[Unset, bool]): Device membership delete permissions group_name (Union[Unset, str]): Return access for groups with a specific name group_description (Union[Unset, str]): Return access for groups with a specific description group_tags (Union[Unset, str]): Return access for groups with specific tags group_tags_contains (Union[Unset, str]): group_tags_contains_any (Union[Unset, str]): project_id (Union[Unset, str]): Only return group access under a specific project is_admin (Union[Unset, bool]): Only return group access with admin access role_permissions_can_create (Union[Unset, bool]): Role membership create permissions role_permissions_can_read (Union[Unset, bool]): Role membership read permissions role_permissions_can_update (Union[Unset, bool]): Role membership update permissions role_permissions_can_delete (Union[Unset, bool]): Role membership delete permissions

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: RoleGroupAccessList