sym.sdk.integrations.boundary

Helpers for interacting with the Boundary API within the Sym SDK.

Functions

get_group(group_id)

Returns the Boundary group with the given group ID.

list_groups([scope_id, filter, recursive])

Returns a list of Boundary groups.
sym.sdk.integrations.boundary.get_group(group_id: str) → dict

Returns the Boundary group with the given group ID.

Parameters

group_id – The group ID of the group to fetch.

Returns

The group with the given group ID in the form of a dictionary. See Group Service for details.

Raises

BoundaryError – If no Boundary group with the given group_id exists, or the credentials configured in the Boundary integration do not have permissions to get the given group.

sym.sdk.integrations.boundary.list_groups(scope_id: str = 'global', filter: Optional[str] = None, recursive: bool = False) → List[dict]

Returns a list of Boundary groups.

Parameters

  • scope_id – The scope ID used to access users defined in that scope and potentially sub-scopes.

  • filter –

    A string containing certain criteria to filter the groups. See Filtering for details. To access nested JSON-values, create a path with /. For example, a selector for group[“scope”][“id”] would be “/item/scope/id”.

    Other valid filters:

    • ’”/item/member_ids” is not empty’

    • ’”/item/name” == “Group Name”’

    • ’”/item/scope/id” == “o_12345”’

  • recursive – A boolean indicating whether to list groups defined in all the sub-scopes.

Returns

A list of groups where each group is a dictionary. See Group Service for details.

Raises

BoundaryError – If the credentials configured in the Boundary integration do not have permissions to list groups in any scope.