mentortools/libs/: access-server-connector-v2-1.0.0+2694912373 metadata and description

Simple index

Mentortools Access Server

author OpenAPI Generator community
author_email OpenAPI Generator Community <team@openapitools.org>
description_content_type text/markdown
keywords OpenAPI, OpenAPI-Generator, Mentortools Access Server
project_urls
  • Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
requires_dist
  • python-dateutil>=2.8.2
  • aiohttp>=3.13.5
  • aiohttp-retry>=2.8.3
  • pydantic>=2.11
  • typing-extensions>=4.7.1
requires_python >=3.9
File Tox results History
access_server_connector_v2-1.0.0+2694912373-py3-none-any.whl
Size
153 KB
Type
Python Wheel
Python
3
access_server_connector_v2-1.0.0+2694912373.tar.gz
Size
74 KB
Type
Source

access-server-connector-v2

Mentortools service for Access Packages with lazy access resolution

This Python package is automatically generated by the OpenAPI Generator project:

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import access_server_connector_v2

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import access_server_connector_v2

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import access_server_connector_v2
from access_server_connector_v2.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = access_server_connector_v2.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
async with access_server_connector_v2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = access_server_connector_v2.HealthApi(api_client)

    try:
        # Health check
        api_response = await api_instance.health_health_get()
        print("The response of HealthApi->health_health_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling HealthApi->health_health_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
HealthApi health_health_get GET /health Health check
IndividualApi batch_overrides_v1_individual_overrides_post POST /v1/individual/overrides Batch-write per-member access overrides
IndividualApi member_overrides_v1_individual_members_member_id_overrides_get GET /v1/individual/members/{member_id}/overrides List a member's effective overrides (latest-wins)
OwnershipApi count_portal_members_v1_ownership_members_count_get GET /v1/ownership/members/count Count ALL members holding any package (distinct)
OwnershipApi count_portal_ownerships_v1_ownership_reasons_count_get GET /v1/ownership/reasons/count Count ALL grants across the portal's packages
OwnershipApi deactivate_v1_ownership_reasons_reason_id_deactivate_post POST /v1/ownership/reasons/{reason_id}/deactivate Deactivate (revoke) an ownership reason
OwnershipApi grant_v1_ownership_grant_post POST /v1/ownership/grant Manually grant an access package
OwnershipApi member_packages_count_v1_ownership_members_member_id_packages_count_get GET /v1/ownership/members/{member_id}/packages/count Count the access packages a member owns
OwnershipApi member_packages_v1_ownership_members_member_id_packages_get GET /v1/ownership/members/{member_id}/packages List the access packages a member owns (paginated)
OwnershipApi ownership_list_v1_ownership_members_member_id_reasons_get GET /v1/ownership/members/{member_id}/reasons List a member's ownership reasons
OwnershipApi portal_members_v1_ownership_members_get GET /v1/ownership/members List ALL members holding any package (paginated) — the members page
OwnershipApi portal_ownerships_v1_ownership_reasons_get GET /v1/ownership/reasons List ALL grants across the portal's packages (paginated) — the orders page
PackagesApi count_members_v1_packages_access_package_id_members_count_get GET /v1/packages/{access_package_id}/members/count Count the package's members (distinct)
PackagesApi count_ownerships_v1_packages_access_package_id_ownerships_count_get GET /v1/packages/{access_package_id}/ownerships/count Count the package's grants (ownership reasons)
PackagesApi count_packages_v1_packages_count_get GET /v1/packages/count Count a portal's access packages
PackagesApi create_package_v1_packages_post POST /v1/packages Create an access package
PackagesApi delete_default_v1_packages_access_package_id_defaults_resource_type_delete DELETE /v1/packages/{access_package_id}/defaults/{resource_type} Remove the package's default for a resource type
PackagesApi delete_package_v1_packages_access_package_id_delete DELETE /v1/packages/{access_package_id} Delete an access package
PackagesApi delete_rule_v1_packages_access_package_id_rules_rule_id_delete DELETE /v1/packages/{access_package_id}/rules/{rule_id} Remove an access rule from a package
PackagesApi get_package_by_slug_v1_packages_by_slug_slug_get GET /v1/packages/by-slug/{slug} Get public package data by its direct-link slug (unauthenticated)
PackagesApi get_package_v1_packages_access_package_id_get GET /v1/packages/{access_package_id} Get a single access package (with its rules)
PackagesApi get_rules_v1_packages_access_package_id_rules_get GET /v1/packages/{access_package_id}/rules List a package's access rules
PackagesApi link_product_v1_packages_access_package_id_products_put PUT /v1/packages/{access_package_id}/products Link a marketplace product to a package
PackagesApi list_defaults_v1_packages_access_package_id_defaults_get GET /v1/packages/{access_package_id}/defaults List the package's default rule bodies (one per resource type)
PackagesApi list_members_v1_packages_access_package_id_members_get GET /v1/packages/{access_package_id}/members List the package's members with their grants — one row per member (paginated)
PackagesApi list_ownerships_v1_packages_access_package_id_ownerships_get GET /v1/packages/{access_package_id}/ownerships List the package's grants — one row per ownership reason (paginated)
PackagesApi list_packages_v1_packages_get GET /v1/packages List a portal's access packages (paginated)
PackagesApi list_product_links_v1_packages_access_package_id_products_get GET /v1/packages/{access_package_id}/products List the marketplace products linked to a package
PackagesApi patch_package_v1_packages_access_package_id_patch PATCH /v1/packages/{access_package_id} Toggle is_active / is_locked
PackagesApi set_default_v1_packages_access_package_id_defaults_put PUT /v1/packages/{access_package_id}/defaults Set the package's default rule body for a resource type
PackagesApi set_rule_v1_packages_access_package_id_rules_put PUT /v1/packages/{access_package_id}/rules Set an access rule on a package
PackagesApi unlink_product_v1_packages_access_package_id_products_link_id_delete DELETE /v1/packages/{access_package_id}/products/{link_id} Unlink a marketplace product from a package
RulePresetsApi create_v1_rule_presets_post POST /v1/rule-presets Create a reusable rule preset
RulePresetsApi delete_preset_v1_rule_presets_preset_id_delete DELETE /v1/rule-presets/{preset_id} Delete a rule preset
RulePresetsApi get_preset_v1_rule_presets_preset_id_get GET /v1/rule-presets/{preset_id} Get one rule preset
RulePresetsApi list_presets_v1_rule_presets_get GET /v1/rule-presets List the portal's rule presets (flat + grouped per resource type)
RulePresetsApi update_preset_v1_rule_presets_preset_id_patch PATCH /v1/rule-presets/{preset_id} Edit a rule preset (name / type hint / body)
ServerApi check_v1_access_check_post POST /v1/access/check Check a single resource
ServerApi consume_v1_admin_consume_post POST /v1/admin/consume Apply an access.order-events payload
ServerApi resolve_v1_access_resolve_post POST /v1/access/resolve Resolve a resource tree
ServerApi resources_summary_v1_access_members_member_id_resources_get GET /v1/access/members/{member_id}/resources List the granted resources (of a type) a member reaches

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ServerName Authorization

Bearer Authorization

Author