{"id":22273617,"url":"https://github.com/ingresse/access-control-python-sdk","last_synced_at":"2025-10-13T06:42:07.196Z","repository":{"id":136987857,"uuid":"84209666","full_name":"ingresse/access-control-python-sdk","owner":"ingresse","description":"Python SDK for using Access Control Service","archived":false,"fork":false,"pushed_at":"2020-07-22T15:10:35.000Z","size":49,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-25T16:51:42.084Z","etag":null,"topics":["acl","backend","python","sdk"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ingresse.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-03-07T14:38:25.000Z","updated_at":"2020-08-10T14:20:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"bd4b5a5d-b7da-40de-af68-d59010ab6dc9","html_url":"https://github.com/ingresse/access-control-python-sdk","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/ingresse/access-control-python-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingresse%2Faccess-control-python-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingresse%2Faccess-control-python-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingresse%2Faccess-control-python-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingresse%2Faccess-control-python-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ingresse","download_url":"https://codeload.github.com/ingresse/access-control-python-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingresse%2Faccess-control-python-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279013971,"owners_count":26085429,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["acl","backend","python","sdk"],"created_at":"2024-12-03T13:14:28.621Z","updated_at":"2025-10-13T06:42:07.191Z","avatar_url":"https://github.com/ingresse.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Access Control Python SDK\n\n## Install\n\n```\npip install git+https://github.com/ingresse/access-control-python-sdk.git@@{version}#egg=ingresse_acl\n```\n\nReplace `{version}` for the Release Version you want\n\n## Usage\n\nInstanciate the *IngresseACL* object with your token (JWT).\n\n```python\nfrom ingresse_acl import IngresseACL\n\nacl = IngresseACL(\"my-token\")\n```\n\n### Users\n\n#### Create\n\n```python\nnew_user = acl.User.create(ingresse_id=1234, email=\"user1234@ing.com\")\n```\n\nor just\n\n```python\nnew_user = acl.User.create(1234, \"user1234@ing.com\")\n```\n\n#### Get\n\nYou can get a User passing the user Id (ACL user Id) or the user Email\n\n```python\nmy_user = acl.User.get(123)\n```\n\nor\n\n```python\nmy_user = acl.User.get(\"user4322@ing.com\")\n```\n\n#### Update\n\n```python\nacl.User.update(123, email=\"new_email@ing.com\")\n```\n\nor\n\n```python\nacl.User.update(\"old_email@ing.com\", email=\"new_email@ing.com\")\n```\n\nor\n\n```python\nmy_user = acl.User.get(123)\nmy_user.email = \"new_email@ing.com\"\nacl.User.update(my_user)\n```\n\n#### Remove\n\n```python\nacl.User.remove(1432)\n```\n\nor\n\n```python\nmy_user = acl.User.get(1432)\nacl.User.remove(my_user)\n```\n\n#### Associate/Remove Role\n\nTo associate:\n\n```python\n### User ACL Id: 2132 and Role Id 8756\nacl.User.add_role(2132, role=8756)\n```\n\nor\n\n```python\n### User ACL Id: 2132 and Role Id 8756\nmy_user = acl.User.get(2132)\nmy_role = acl.Role.get(8756)\nacl.User.add_role(my_user, role=my_role)\n```\n\nTo remove:\n\n```python\n### User ACL Id: 2132 and Role Id 8756\nacl.User.remove_role(2132, role=8756)\n```\n\nor\n\n```python\n### User ACL Id: 2132 and Role Id 8756\nmy_user = acl.User.get(2132)\nmy_role = acl.Role.get(8756)\nacl.User.remove_role(my_user, role=my_role)\n```\n\n#### Associate/Remove Permission\nTo associate:\n\n```python\n### User ACL Id: 2132, Permission Id: 8756, Resource Id: 6543,\n### Context Id: 4624\nmy_user = acl.User.add_permission(2132, 8756, 6543, \"resVal\", context=4624, context_value=\"ctxVal\")\n```\n\nor\n\n```python\n### User ACL Id: 2132, Permission Name: \"can-read\"\n### Resource Name: \"planner\", Context Name: \"event\"\nmy_user = acl.User.add_permission(2132, \"can-read\", \"planner\", \"resVal\", context=\"event\", context_value=\"ctxVal\")\n```\n\nor\n\n```python\n### User ACL Id: 2132, Permission Name: \"can-read\"\n### Resource Name: \"planner\", Context Name: \"event\"\nmy_user = acl.User.get(2132)\nmy_user = acl.User.add_permission(my_user, \"can-read\", \"planner\", \"resVal\", context=\"event\", context_value=\"ctxVal\")\n```\n\nTo remove:\n\n```python\n### User ACL Id: 2132, Permission Id: 8756, Resource Id: 6543,\n### Context Id: 4624\nmy_user = acl.User.remove_permission(2132, 8756, 6543, \"resVal\", context=4624, context_value=\"ctxVal\")\n```\n\nor\n\n```python\n### User ACL Id: 2132, Permission Name: \"can-read\"\n### Resource Name: \"planner\", Context Name: \"event\"\nmy_user = acl.User.remove_permission(2132, \"can-read\", \"planner\", \"resVal\", context=\"event\", context_value=\"ctxVal\")\n```\n\nor\n\n```python\n### User ACL Id: 2132, Permission Name: \"can-read\"\n### Resource Name: \"planner\", Context Name: \"event\"\nmy_user = acl.User.get(2132)\nmy_user = acl.User.remove_permission(my_user, \"can-read\", \"planner\", \"resVal\", context=\"event\", context_value=\"ctxVal\")\n```\n\n### Roles\n\n#### Create\n\n```python\nnew_user = acl.Role.create(name=\"my-role\", alias=\"My Role\", description=\"My Role for teste\")\n```\n\nor just\n\n```python\nnew_user = acl.Role.create(\"my-role\", \"My Role\", \"My Role for teste\")\n```\n\n#### Get\nYou can get a Role passing the Role Id or the Role Name\n\n```python\nmy_user = acl.Role.get(123)\n```\n\nor\n\n```python\nmy_user = acl.Role.get(\"my-role\")\n```\n\n#### Update\n\n```python\nacl.Role.update(123, alias=\"New alias\", description=\"New Description\")\n```\n\nor\n\n```python\nacl.Role.update(\"my-role\", alias=\"New alias\", description=\"New Description\")\n```\n\nor\n\n```python\nmy_role = acl.Role.get(\"my-role\")\nmy_role.alias = \"New alias\"\nmy_role.description = \"New Description\"\nacl.Role.update(my_role)\n```\n\n#### Remove\n\n```python\nacl.Role.remove(1432)\n```\n\nor\n\n```python\nmy_role = acl.Role.get(1432)\nacl.Role.remove(my_role)\n```\n\n#### Associate/Remove Permission\nTo associate:\n\n```python\n### Role Id: 2132, Permission Id: 8756, Resource Id: 6543,\n### Context Id: 4624\nmy_role = acl.Role.add_permission(2132, 8756, 6543, \"resVal\", context=4624, context_value=\"ctxVal\")\n```\n\nor\n\n```python\n### Role Name: \"my-role\", Permission Name: \"can-read\"\n### Resource Name: \"planner\", Context Name: \"event\"\nmy_role = acl.Role.add_permission(\"my-role\", \"can-read\", \"planner\", \"resVal\", context=\"event\", context_value=\"ctxVal\")\n```\n\nor\n\n```python\n### Role Id: 2132, Permission Name: \"can-read\"\n### Resource Name: \"planner\", Context Name: \"event\"\nmy_role = acl.Role.get(2132)\nmy_role = acl.Role.add_permission(my_role, \"can-read\", \"planner\", \"resVal\", context=\"event\", context_value=\"ctxVal\")\n```\n\nTo remove:\n\n```python\n### Role Id: 2132, Permission Id: 8756, Resource Id: 6543,\n### Context Id: 4624\nmy_role = acl.Role.remove_permission(2132, 8756, 6543, \"resVal\", context=4624, context_value=\"ctxVal\")\n```\n\nor\n\n```python\n### User ACL Id: 2132, Permission Name: \"can-read\"\n### Resource Name: \"planner\", Context Name: \"event\"\nmy_role = acl.Role.remove_permission(2132, \"can-read\", \"planner\", \"resVal\", context=\"event\", context_value=\"ctxVal\")\n```\n\nor\n\n```python\n### User ACL Id: 2132, Permission Name: \"can-read\"\n### Resource Name: \"planner\", Context Name: \"event\"\nmy_role = acl.Role.get(2132)\nmy_role = acl.Role.remove_permission(my_role, \"can-read\", \"planner\", \"resVal\", context=\"event\", context_value=\"ctxVal\")\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fingresse%2Faccess-control-python-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fingresse%2Faccess-control-python-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fingresse%2Faccess-control-python-sdk/lists"}