Skip to main content

affinidi_tdk_credential_issuance_client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

For more information, please visit https://www.affinidi.com

Documentation is available at https://docs.affinidi.com/dev-tools/affinidi-tdk/clients/credential-issuance/

Requirements.

Python 3.7+

Installation & Usage

pip install

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

pip install affinidi_tdk_credential_issuance_client

Then import the package:

import affinidi_tdk_credential_issuance_client

Setuptools

Install via Setuptools.

python setup.py install --user

Then import the package:

import affinidi_tdk_credential_issuance_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import affinidi_tdk_credential_issuance_client
from affinidi_tdk_credential_issuance_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://apse1.api.affinidi.io/cis
# See configuration.py for a list of all supported configuration parameters.
configuration = affinidi_tdk_credential_issuance_client.Configuration(
    host = "https://apse1.api.affinidi.io/cis"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ProjectTokenAuth
configuration.api_key['ProjectTokenAuth'] = os.environ["API_KEY"]

# Configure a hook to auto-refresh API key for your personal access token (PAT), if expired
import affinidi_tdk_auth_provider

stats = {
  apiGatewayUrl,
  keyId,
  passphrase,
  privateKey,
  projectId,
  tokenEndpoint,
  tokenId,
}
authProvider = affinidi_tdk_auth_provider.AuthProvider(stats)
configuration.refresh_api_key_hook = lambda api_client: authProvider.fetch_project_scoped_token()

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ProjectTokenAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with affinidi_tdk_credential_issuance_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = affinidi_tdk_credential_issuance_client.ConfigurationApi(api_client)
    create_issuance_config_input = affinidi_tdk_credential_issuance_client.CreateIssuanceConfigInput() # CreateIssuanceConfigInput | Request body of create configuration

    try:
        api_response = api_instance.create_issuance_config(create_issuance_config_input)
        print("The response of ConfigurationApi->create_issuance_config:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ConfigurationApi->create_issuance_config: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://apse1.api.affinidi.io/cis

Class Method HTTP request Description
ConfigurationApi create_issuance_config POST /v1/configurations
ConfigurationApi delete_issuance_config_by_id DELETE /v1/configurations/{configurationId}
ConfigurationApi get_issuance_config_by_id GET /v1/configurations/{configurationId}
ConfigurationApi get_issuance_config_list GET /v1/configurations
ConfigurationApi update_issuance_config_by_id PUT /v1/configurations/{configurationId}
CredentialsApi batch_credential POST /v1/{projectId}/batch_credential Allows wallets to claim multiple credentials at once.
CredentialsApi generate_credentials POST /v1/{projectId}/credential
CredentialsApi get_claimed_credentials GET /v1/{projectId}/configurations/{configurationId}/credentials Get claimed credential in the specified range
CredentialsApi get_issuance_id_claimed_credential GET /v1/{projectId}/configurations/{configurationId}/issuances/{issuanceId}/credentials Get claimed VC linked to the issuanceId
DefaultApi change_credential_status POST /v1/{projectId}/configurations/{configurationId}/issuance/change-status change credential status.
DefaultApi list_issuance_data_records GET /v1/{projectId}/configurations/{configurationId}/issuance/issuance-data-records List records
IssuanceApi issuance_state GET /v1/{projectId}/issuance/state/{issuanceId}
IssuanceApi issue_credentials POST /v1/{projectId}/credential/issue
IssuanceApi list_issuance GET /v1/{projectId}/issuance
IssuanceApi start_issuance POST /v1/{projectId}/issuance/start
OfferApi get_credential_offer GET /v1/{projectId}/offers/{issuanceId}
WellKnownApi get_well_known_open_id_credential_issuer GET /v1/{projectId}/.well-known/openid-credential-issuer

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

AwsSigV4

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

ApiKey

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

bearerAuth

  • Type: Bearer authentication (JWT)

ConsumerTokenAuth

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

UserTokenAuth

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

ProjectTokenAuth

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

HeritageTokenAuth

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

Author

info@affinidi.com

Metadata

Release files for affinidi_tdk_credential_issuance_client 1.67.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for affinidi_tdk_credential_issuance_client 1.67.0
File Size Uploaded
affinidi_tdk_credential_issuance_client-1.67.0.tar.gz 53.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for affinidi_tdk_credential_issuance_client 1.67.0
File Interpreter ABI Platform
affinidi_tdk_credential_issuance_client-1.67.0-py3-none-any.whl Python 3 none any Details

Total release size: 194.7 kB

Release files / affinidi_tdk_credential_issuance_client-1.67.0.tar.gz

Download URL affinidi_tdk_credential_issuance_client-1.67.0.tar.gz
Size 53.6 kB
Tags Source
SHA-256 checksum
How to use checksums
0fbf3dbdbdb8aacf29dcfd401d2f37ccb64f92e75252b60e18fb443848a2367e
BLAKE2b-256 checksum
How to use checksums
5c317d019e0b676a7bcdc363f9f74a19da52133b0376238c29e1414ec24facbc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via poetry/1.8.5 CPython/3.14.3 Linux/6.14.0-1017-azure

Release files / affinidi_tdk_credential_issuance_client-1.67.0-py3-none-any.whl

Download URL affinidi_tdk_credential_issuance_client-1.67.0-py3-none-any.whl
Size 141.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b3db7f5af7833eb24c385e2036f586b6820302a664fce9120ae7c9cef44a76db
BLAKE2b-256 checksum
How to use checksums
e4f612f6686feb91a180525a972b64087be96659143461f79b1cf9dd581112fd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via poetry/1.8.5 CPython/3.14.3 Linux/6.14.0-1017-azure
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page