foundry_dev_tools.helpers.multipass package

Multipass helper classes for Foundry DevTools.

class foundry_dev_tools.helpers.multipass.Group

Bases: Principal

Not intended to be initialized directly. Use Group.from_id() or Group.create_group() instead.

name: str

__init__(*args, **kwargs)

Not intended to be initialized directly. Use Group.from_id() or Group.create_group() instead.

Return type:

None

classmethod from_id(context, group_id)

Returns group from id.

Parameters:

• context (FoundryContext) – the foundry context for the group

• group_id (api_types.GroupId) – the id of the group on foundry

Return type:

Self

classmethod create(context, name, organization_rids, /, *, description=None)

Create a new multipass group.

Parameters:

• context (FoundryContext) – the foundry context for the group

• name (str) – the name the group should receive on creation

• organization_rids (set[api_types.OrganizationRid]) – a set of organization identifiers the group will belong to

• description (str | None) – an optional group description

Return type:

Self

update(group_description)

Update the multipass group.

Parameters:

group_description (str) – The updated description to apply to the group

Return type:

Self

rename(new_group_name)

Rename group.

Parameters:

new_group_name (str) – the name the group will be renamed to

Returns:

the dict contains an entry for the renamed group and an alias group which still holds to the old name to support compatibility for projects referring to the old name

Return type:

dict[str, api_types.Group]

delete()

Deletes multipass group.

Return type:

Self

update_managers(deleted_manager_managers=None, deleted_member_managers=None, new_manager_managers=None, new_member_managers=None)

Update group managers by adding new member managers or manager managers or removing member managers or manager managers.

Parameters:

• deleted_manager_managers (set[api_types.PrincipalId] | None) – A set of principal identifiers for which to withdraw the role as manager manager

• deleted_member_managers (set[api_types.PrincipalId] | None) – A set of principal identifiers for which to withdraw the role as member manager

• new_manager_managers (set[api_types.PrincipalId] | None) – A set of principal identifiers that should be assigned the role as manager manager

• new_member_managers (set[api_types.PrincipalId] | None) – A set of principal identifiers that should be assigned the role as member manager

Return type:

Self

get_manager_managers()

Returns the principals of the group who can add and remove members and who can grant the right to manage group permissions to others.

Return type:

list[api_types.User | api_types.Group]

add_manager_managers(manager_managers)

Assign principals as manager managers to the group.

Parameters:

manager_managers (set[api_types.PrincipalId]) – A set of principal identifiers that should be assigned the role as manager manager

Return type:

Self

remove_manager_managers(manager_managers)

Withdraw the provided principals from the manager managers for the group.

Parameters:

manager_managers (set[api_types.PrincipalId]) – A set of principal identifiers that should be withdrawn from the manager managers.

Return type:

Self

get_member_managers()

Returns the principals of the group who can add and remove members.

Return type:

list[api_types.User | api_types.Group]

add_member_manager(member_managers)

Assign principals as member managers to the group.

Parameters:

member_managers (set[api_types.PrincipalId]) – A set of principal identifiers that should be assigned the role as member manager

Return type:

Self

remove_member_managers(member_managers)

Withdraw the provided principals from the member managers for the group.

Parameters:

member_managers (set[api_types.PrincipalId]) – A set of principal identifiers that should be withdrawn from the member managers.

Return type:

Self

add_members(principal_ids, expirations=None)

Add principals to the group.

Parameters:

• principal_ids (set[api_types.PrincipalId]) – The identifiers of the principals to be added to the group

• expirations (dict[api_types.GroupId, dict[api_types.PrincipalId, datetime]] | None) – Optional expiration settings that can be passed if principals should only have temporal access to the group

Return type:

Self

get_members()

Receive all immediate group members of the group.

Return type:

list[api_types.User | api_types.Group]

remove_members(principal_ids)

Remove members from the group.

Parameters:

principal_ids (set[api_types.PrincipalId]) – A set of principal identifiers which should be removed from the member list of the group

Return type:

Self

update_expiration_settings(max_expiration=None, max_duration_in_seconds=None)

Update group member expiration settings of the group.

Parameters:

• max_expiration (datetime | None) – The time in the future on which all new membership will be automatically expired and no new membership can be requested after this time

• max_duration_in_seconds (int | None) – When adding a new membership, it can last no longer than the specified maximum duration. Expiration of existing memberships will be adjusted accordingly. Value passed must be greater equal MINIMUM_MAX_DURATION_IN_SECONDS and defaults to DEFAULT_MAX_DURATION_IN_SECONDS if it does not meet the condition

Return type:

Self

get_expiration_settings()

Returns group member expiration settings for the group.

Return type:

api_types.GroupMemberExpirationSettings

reset_expiration_settings()

Reset the group member expiration settings for the group.

Return type:

Self

sync()

Fetches the attributes again.

Return type:

Self

class foundry_dev_tools.helpers.multipass.Principal

Bases: ABC

Not intended to be initialized directly. Use Principal.from_id() instead.

id: api_types.PrincipalId

attributes: dict[str, list[str]]

__init__(*args, **kwargs)

Not intended to be initialized directly. Use Principal.from_id() instead.

Return type:

None

classmethod from_id(context, principal_id)

Returns group from id.

Parameters:

• context (FoundryContext) – the foundry context for the group

• principal_id (api_types.PrincipalId) – the id of the principal on foundry

Return type:

Self

class foundry_dev_tools.helpers.multipass.User

Bases: Principal

Not intended to be initialized directly. Use User.me() instead.

username: str

__init__(*args, **kwargs)

Not intended to be initialized directly. Use User.me() instead.

Return type:

None

classmethod me(context)

Returns the user.

Parameters:

context (FoundryContext) – the foundry context for the user

Return type:

Self

Submodules

• foundry_dev_tools.helpers.multipass.group module
  • Group
    • Group.name
    • Group.__init__()
    • Group.from_id()
    • Group.create()
    • Group.update()
    • Group.rename()
    • Group.delete()
    • Group.update_managers()
    • Group.get_manager_managers()
    • Group.add_manager_managers()
    • Group.remove_manager_managers()
    • Group.get_member_managers()
    • Group.add_member_manager()
    • Group.remove_member_managers()
    • Group.add_members()
    • Group.get_members()
    • Group.remove_members()
    • Group.update_expiration_settings()
    • Group.get_expiration_settings()
    • Group.reset_expiration_settings()
    • Group.sync()
    • Group.id
    • Group.attributes
• foundry_dev_tools.helpers.multipass.principal module
  • Principal
    • Principal.id
    • Principal.attributes
    • Principal.__init__()
    • Principal.from_id()
• foundry_dev_tools.helpers.multipass.user module
  • User
    • User.username
    • User.__init__()
    • User.me()
    • User.id
    • User.attributes