swagger_server.controllers.operational_controller module¶

swagger_server.controllers.operational_controller.delete_user_data(user_id)[source]¶

# noqa: E501

Parameters:	user_id (dict \| bytes) – A UUID value identifying the user.
Return type:	UserDeletionData

swagger_server.controllers.operational_controller.get_all_user_roles(user_id)[source]¶

Get the effective roles that a user has at any place in the organisational tree. # noqa: E501

Parameters:	user_id (dict \| bytes) – A UUID value identifying the user.
Return type:	AllUserRoles

swagger_server.controllers.operational_controller.get_domain_roles(domain_id)[source]¶

Get the domain and its lineage's roles defined for a domain. # noqa: E501

Parameters:	domain_id (int) – A unique integer value identifying the domain.
Return type:	DomainRoles

swagger_server.controllers.operational_controller.get_resource_permissions_for_roles(role_ids)[source]¶

Get a list of all resource permissions the specified roles have. # noqa: E501

Parameters:	role_ids (List[int]) –
Return type:	List[ResourcePermission]

swagger_server.controllers.operational_controller.get_site_and_domain_roles(site_id)[source]¶

Get the site- and domain lineage roles defined for a given site. # noqa: E501

Parameters:	site_id (int) – A unique integer value identifying the site.
Return type:	SiteAndDomainRoles

swagger_server.controllers.operational_controller.get_site_role_labels_aggregated(site_id)[source]¶

Get a list of all possible role labels that a user can have from the specified site's perspective. # noqa: E501

Parameters:	site_id (int) – A unique integer value identifying the site.
Return type:	SiteRoleLabelsAggregated

swagger_server.controllers.operational_controller.get_sites_under_domain(domain_id)[source]¶

Get a list of all sites linked directly or indirectly to the specified domain. # noqa: E501

Parameters:	domain_id (int) – A unique integer value identifying the domain.
Return type:	List[Site]

swagger_server.controllers.operational_controller.get_tech_admin_resource_permissions()[source]¶

Get a list of all possible permissions any user can have. This is effectively what a tech admin user can do. # noqa: E501

Return type:	List[ResourcePermission]

swagger_server.controllers.operational_controller.get_user_site_role_labels_aggregated(user_id, site_id)[source]¶

Get a list of all role labels that the specified user has from the specified site's perspective. # noqa: E501

Parameters:	user_id (dict \| bytes) – A UUID value identifying the user. site_id (int) – A unique integer value identifying the site.
Return type:	UserSiteRoleLabelsAggregated

swagger_server.controllers.operational_controller.get_users_with_roles_for_domain(domain_id)[source]¶

Get a list of Users with their effective roles within the given domain. # noqa: E501

Parameters:	domain_id (int) – A unique integer value identifying the domain.
Return type:	List[UserWithRoles]

swagger_server.controllers.operational_controller.get_users_with_roles_for_site(site_id)[source]¶

Get a list of Users with their effective roles within the given site. # noqa: E501

Parameters:	site_id (int) – A unique integer value identifying the site.
Return type:	List [UserWithRoles]

swagger_server.controllers.operational_controller.healthcheck()[source]¶

Get the status of the service. # noqa: E501

Return type:	HealthInfo

swagger_server.controllers.operational_controller.purge_expired_invitations(cutoff_date=None)[source]¶

Purge all the expired invitations past a cutoff_date (defaults to today).

Parameters:	cutoff_date (date) – An optional cutoff_date to purge invitations expired past this date.
Return type:	PurgedInvitations