fabric-credmgr-client


Namefabric-credmgr-client JSON
Version 1.6.1 PyPI version JSON
download
home_pageNone
SummaryFabric Control Framework
upload_time2024-01-23 14:54:52
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords fabric credential manager api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls. 
            [![PyPI](https://img.shields.io/pypi/v/fabric_credmgr_client?style=plastic)](https://pypi.org/project/fabric_credmgr_client/)

# Fabric Credential Manager Client
This is Fabric Credential Manager API

This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0.1
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on Github, you can install directly from Github

```sh
pip install git+https://github.com/fabric-testbed/fabric_credmgr.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/fabric-testbed/fabric_credmgr.git`)

Then import the package:
```python
import fabric_cm.credmgr.credmgr_proxy 
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
from fabric_cm.credmgr.credmgr_proxy import CredmgrProxy
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python
from fabric_cm.credmgr.credmgr_proxy import CredmgrProxy
from fabric_cm.credmgr.swagger_client.rest import ApiException

credmgr_proxy = CredmgrProxy(credmgr_host="https://dev-2.fabric-testbed.net/")
try:
    version = credmgr_proxy.version_get()
    print(version)
except ApiException as e:
    print("Exception when calling CredmgrProxy->version_get: %s\n" % e)

try:
    version = credmgr_proxy.certs_get()
    print(version)
except ApiException as e:
    print("Exception when calling CredmgrProxy->certs_get: %s\n" % e)


try:
    version = credmgr_proxy.refresh(project_id='12345', scope='all', refresh_token='TOKEN')
    print(version)
except ApiException as e:
    print("Exception when calling CredmgrProxy->refresh: %s\n" % e)

try:
    version = credmgr_proxy.revoke(refresh_token='TOKEN')
    print(version)
except ApiException as e:
    print("Exception when calling CredmgrProxy->revoke: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://127.0.0.1:7000/credmgr/*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**certs_get**](docs/DefaultApi.md#certs_get) | **GET** /certs | Return Public Keys to verify signature of the tokens
*TokensApi* | [**tokens_create_post**](docs/TokensApi.md#tokens_create_post) | **POST** /tokens/create | Generate tokens for an user
*TokensApi* | [**tokens_get**](docs/TokensApi.md#tokens_get) | **GET** /tokens | Get tokens
*TokensApi* | [**tokens_refresh_post**](docs/TokensApi.md#tokens_refresh_post) | **POST** /tokens/refresh | Refresh tokens for an user
*TokensApi* | [**tokens_revoke_list_get**](docs/TokensApi.md#tokens_revoke_list_get) | **GET** /tokens/revoke_list | Get token revoke list i.e. list of revoked identity token hashes
*TokensApi* | [**tokens_revoke_post**](docs/TokensApi.md#tokens_revoke_post) | **POST** /tokens/revoke | Revoke a token for an user
*TokensApi* | [**tokens_revokes_post**](docs/TokensApi.md#tokens_revokes_post) | **POST** /tokens/revokes | Revoke a token
*TokensApi* | [**tokens_validate_post**](docs/TokensApi.md#tokens_validate_post) | **POST** /tokens/validate | Validate an identity token issued by Credential Manager
*VersionApi* | [**version_get**](docs/VersionApi.md#version_get) | **GET** /version | Version

## Documentation For Models

 - [DecodedToken](docs/DecodedToken.md)
 - [Jwks](docs/Jwks.md)
 - [JwksKeys](docs/JwksKeys.md)
 - [Request](docs/Request.md)
 - [RevokeList](docs/RevokeList.md)
 - [Status200OkNoContent](docs/Status200OkNoContent.md)
 - [Status200OkNoContentData](docs/Status200OkNoContentData.md)
 - [Status200OkPaginated](docs/Status200OkPaginated.md)
 - [Status200OkSingle](docs/Status200OkSingle.md)
 - [Status400BadRequest](docs/Status400BadRequest.md)
 - [Status400BadRequestErrors](docs/Status400BadRequestErrors.md)
 - [Status401Unauthorized](docs/Status401Unauthorized.md)
 - [Status401UnauthorizedErrors](docs/Status401UnauthorizedErrors.md)
 - [Status403Forbidden](docs/Status403Forbidden.md)
 - [Status403ForbiddenErrors](docs/Status403ForbiddenErrors.md)
 - [Status404NotFound](docs/Status404NotFound.md)
 - [Status404NotFoundErrors](docs/Status404NotFoundErrors.md)
 - [Status500InternalServerError](docs/Status500InternalServerError.md)
 - [Status500InternalServerErrorErrors](docs/Status500InternalServerErrorErrors.md)
 - [Token](docs/Token.md)
 - [TokenPost](docs/TokenPost.md)
 - [Tokens](docs/Tokens.md)
 - [Version](docs/Version.md)
 - [VersionData](docs/VersionData.md)

## Documentation For Authorization

 All endpoints do not require authorization.


## Author

kthare10@unc.edu

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "fabric-credmgr-client",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "Fabric Credential Manager API",
    "author": null,
    "author_email": "Komal Thareja <kthare10@renci.org>",
    "download_url": "https://files.pythonhosted.org/packages/11/2b/afbd113d22da5ddae60ab116b04b32d50e135bafe1285e51d7c3a9691e53/fabric-credmgr-client-1.6.1.tar.gz",
    "platform": null,
    "description": "[![PyPI](https://img.shields.io/pypi/v/fabric_credmgr_client?style=plastic)](https://pypi.org/project/fabric_credmgr_client/)\n\n# Fabric Credential Manager Client\nThis is Fabric Credential Manager API\n\nThis Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: 1.0.1\n- Package version: 1.0.0\n- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen\n\n## Requirements.\n\nPython 3.9+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on Github, you can install directly from Github\n\n```sh\npip install git+https://github.com/fabric-testbed/fabric_credmgr.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/fabric-testbed/fabric_credmgr.git`)\n\nThen import the package:\n```python\nimport fabric_cm.credmgr.credmgr_proxy \n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nfrom fabric_cm.credmgr.credmgr_proxy import CredmgrProxy\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom fabric_cm.credmgr.credmgr_proxy import CredmgrProxy\nfrom fabric_cm.credmgr.swagger_client.rest import ApiException\n\ncredmgr_proxy = CredmgrProxy(credmgr_host=\"https://dev-2.fabric-testbed.net/\")\ntry:\n    version = credmgr_proxy.version_get()\n    print(version)\nexcept ApiException as e:\n    print(\"Exception when calling CredmgrProxy->version_get: %s\\n\" % e)\n\ntry:\n    version = credmgr_proxy.certs_get()\n    print(version)\nexcept ApiException as e:\n    print(\"Exception when calling CredmgrProxy->certs_get: %s\\n\" % e)\n\n\ntry:\n    version = credmgr_proxy.refresh(project_id='12345', scope='all', refresh_token='TOKEN')\n    print(version)\nexcept ApiException as e:\n    print(\"Exception when calling CredmgrProxy->refresh: %s\\n\" % e)\n\ntry:\n    version = credmgr_proxy.revoke(refresh_token='TOKEN')\n    print(version)\nexcept ApiException as e:\n    print(\"Exception when calling CredmgrProxy->revoke: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://127.0.0.1:7000/credmgr/*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**certs_get**](docs/DefaultApi.md#certs_get) | **GET** /certs | Return Public Keys to verify signature of the tokens\n*TokensApi* | [**tokens_create_post**](docs/TokensApi.md#tokens_create_post) | **POST** /tokens/create | Generate tokens for an user\n*TokensApi* | [**tokens_get**](docs/TokensApi.md#tokens_get) | **GET** /tokens | Get tokens\n*TokensApi* | [**tokens_refresh_post**](docs/TokensApi.md#tokens_refresh_post) | **POST** /tokens/refresh | Refresh tokens for an user\n*TokensApi* | [**tokens_revoke_list_get**](docs/TokensApi.md#tokens_revoke_list_get) | **GET** /tokens/revoke_list | Get token revoke list i.e. list of revoked identity token hashes\n*TokensApi* | [**tokens_revoke_post**](docs/TokensApi.md#tokens_revoke_post) | **POST** /tokens/revoke | Revoke a token for an user\n*TokensApi* | [**tokens_revokes_post**](docs/TokensApi.md#tokens_revokes_post) | **POST** /tokens/revokes | Revoke a token\n*TokensApi* | [**tokens_validate_post**](docs/TokensApi.md#tokens_validate_post) | **POST** /tokens/validate | Validate an identity token issued by Credential Manager\n*VersionApi* | [**version_get**](docs/VersionApi.md#version_get) | **GET** /version | Version\n\n## Documentation For Models\n\n - [DecodedToken](docs/DecodedToken.md)\n - [Jwks](docs/Jwks.md)\n - [JwksKeys](docs/JwksKeys.md)\n - [Request](docs/Request.md)\n - [RevokeList](docs/RevokeList.md)\n - [Status200OkNoContent](docs/Status200OkNoContent.md)\n - [Status200OkNoContentData](docs/Status200OkNoContentData.md)\n - [Status200OkPaginated](docs/Status200OkPaginated.md)\n - [Status200OkSingle](docs/Status200OkSingle.md)\n - [Status400BadRequest](docs/Status400BadRequest.md)\n - [Status400BadRequestErrors](docs/Status400BadRequestErrors.md)\n - [Status401Unauthorized](docs/Status401Unauthorized.md)\n - [Status401UnauthorizedErrors](docs/Status401UnauthorizedErrors.md)\n - [Status403Forbidden](docs/Status403Forbidden.md)\n - [Status403ForbiddenErrors](docs/Status403ForbiddenErrors.md)\n - [Status404NotFound](docs/Status404NotFound.md)\n - [Status404NotFoundErrors](docs/Status404NotFoundErrors.md)\n - [Status500InternalServerError](docs/Status500InternalServerError.md)\n - [Status500InternalServerErrorErrors](docs/Status500InternalServerErrorErrors.md)\n - [Token](docs/Token.md)\n - [TokenPost](docs/TokenPost.md)\n - [Tokens](docs/Tokens.md)\n - [Version](docs/Version.md)\n - [VersionData](docs/VersionData.md)\n\n## Documentation For Authorization\n\n All endpoints do not require authorization.\n\n\n## Author\n\nkthare10@unc.edu\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Fabric Control Framework",
    "version": "1.6.1",
    "project_urls": {
        "Home": "https://fabric-testbed.net/",
        "Sources": "https://github.com/fabric-testbed/fabric_credmgr_client"
    },
    "split_keywords": [
        "fabric",
        "credential",
        "manager",
        "api"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "5738336995d8c08b15b8beae0e9ecd29ea1d65b4b5c30ed85e215abeb8b04cf8",
                "md5": "45b3a6b14b6ad761e03ae99de1fc0082",
                "sha256": "509e7e7782b13b9204e795a97f3ee2539d97178a840008935d53d14cb366689d"
            },
            "downloads": -1,
            "filename": "fabric_credmgr_client-1.6.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "45b3a6b14b6ad761e03ae99de1fc0082",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 61704,
            "upload_time": "2024-01-23T14:54:51",
            "upload_time_iso_8601": "2024-01-23T14:54:51.159484Z",
            "url": "https://files.pythonhosted.org/packages/57/38/336995d8c08b15b8beae0e9ecd29ea1d65b4b5c30ed85e215abeb8b04cf8/fabric_credmgr_client-1.6.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "112bafbd113d22da5ddae60ab116b04b32d50e135bafe1285e51d7c3a9691e53",
                "md5": "fedadc6bc8e5889710ccb57a75a5aeb6",
                "sha256": "28b203535c231ce835bb25d758f21ee1527a0f45b3d2c410a571e96f7162f704"
            },
            "downloads": -1,
            "filename": "fabric-credmgr-client-1.6.1.tar.gz",
            "has_sig": false,
            "md5_digest": "fedadc6bc8e5889710ccb57a75a5aeb6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 37756,
            "upload_time": "2024-01-23T14:54:52",
            "upload_time_iso_8601": "2024-01-23T14:54:52.883504Z",
            "url": "https://files.pythonhosted.org/packages/11/2b/afbd113d22da5ddae60ab116b04b32d50e135bafe1285e51d7c3a9691e53/fabric-credmgr-client-1.6.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-23 14:54:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "fabric-testbed",
    "github_project": "fabric_credmgr_client",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "tox": true,
    "lcname": "fabric-credmgr-client"
}
None
Elapsed time: 0.16860s