affinidi_tdk_iam_client 1.63.0

Iam

affinidi_tdk_iam_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

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_iam_client

Then import the package:

import affinidi_tdk_iam_client

Setuptools

Install via Setuptools.

python setup.py install --user

Then import the package:

import affinidi_tdk_iam_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_iam_client
from affinidi_tdk_iam_client.rest import ApiException
from pprint import pprint

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

# 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: ConsumerTokenAuth
configuration.api_key['ConsumerTokenAuth'] = 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['ConsumerTokenAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with affinidi_tdk_iam_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = affinidi_tdk_iam_client.AuthzApi(api_client)
    grantee_did = 'grantee_did_example' # str |

    try:
        # delete access of granteeDid
        api_instance.delete_access_vfs(grantee_did)
    except ApiException as e:
        print("Exception when calling AuthzApi->delete_access_vfs: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AuthzApi	delete_access_vfs	DELETE /v1/authz/vfs/access/{granteeDid}	delete access of granteeDid
AuthzApi	grant_access_vfs	POST /v1/authz/vfs/access	Grant access to the virtual file system
AuthzApi	update_access_vfs	PUT /v1/authz/vfs/access/{granteeDid}	Update access of granteeDid
ConsumerAuthApi	consumer_auth_token_endpoint	POST /v1/consumer/oauth2/token	The Consumer OAuth 2.0 Token Endpoint
DefaultApi	v1_auth_proxy_delete	DELETE /v1/auth/{proxy+}
DefaultApi	v1_auth_proxy_get	GET /v1/auth/{proxy+}
DefaultApi	v1_auth_proxy_patch	PATCH /v1/auth/{proxy+}
DefaultApi	v1_auth_proxy_post	POST /v1/auth/{proxy+}
DefaultApi	v1_auth_proxy_put	PUT /v1/auth/{proxy+}
DefaultApi	v1_idp_proxy_delete	DELETE /v1/idp/{proxy+}
DefaultApi	v1_idp_proxy_get	GET /v1/idp/{proxy+}
DefaultApi	v1_idp_proxy_patch	PATCH /v1/idp/{proxy+}
DefaultApi	v1_idp_proxy_post	POST /v1/idp/{proxy+}
DefaultApi	v1_idp_proxy_put	PUT /v1/idp/{proxy+}
PoliciesApi	get_policies	GET /v1/policies/principals/{principalId}
PoliciesApi	update_policies	PUT /v1/policies/principals/{principalId}
ProjectsApi	add_principal_to_project	POST /v1/projects/principals
ProjectsApi	create_project	POST /v1/projects
ProjectsApi	delete_principal_from_project	DELETE /v1/projects/principals/{principalId}
ProjectsApi	get_project	GET /v1/projects/{projectId}
ProjectsApi	list_principals_of_project	GET /v1/projects/principals
ProjectsApi	list_project	GET /v1/projects
ProjectsApi	update_project	PATCH /v1/projects/{projectId}
StsApi	create_project_scoped_token	POST /v1/sts/create-project-scoped-token
StsApi	whoami	GET /v1/sts/whoami
TokensApi	create_token	POST /v1/tokens
TokensApi	delete_token	DELETE /v1/tokens/{tokenId}
TokensApi	get_token	GET /v1/tokens/{tokenId}
TokensApi	list_projects_of_token	GET /v1/tokens/{tokenId}/projects
TokensApi	list_token	GET /v1/tokens
TokensApi	update_token	PATCH /v1/tokens/{tokenId}
WellKnownApi	get_well_known_did	GET /.well-known/did.json
WellKnownApi	get_well_known_jwks	GET /.well-known/jwks.json

Documentation For Models

• ActionForbiddenError
• AddUserToProjectInput
• ConsumerAuthTokenEndpointInput
• ConsumerAuthTokenEndpointOutput
• CreateProjectInput
• CreateProjectScopedTokenInput
• CreateProjectScopedTokenOutput
• CreateTokenInput
• GrantAccessInput
• GrantAccessOutput
• InvalidDIDError
• InvalidParameterError
• JsonWebKeyDto
• JsonWebKeySetDto
• NotFoundError
• PolicyDto
• PolicyStatementDto
• PrincipalCannotBeDeletedError
• PrincipalDoesNotBelongToProjectError
• ProjectDto
• ProjectList
• ProjectWithPolicyDto
• ProjectWithPolicyList
• RightsEnum
• TokenDto
• TokenList
• TokenPrivateKeyAuthenticationMethodDto
• TokenPrivateKeyAuthenticationMethodDtoPublicKeyInfo
• TokenPrivateKeyAuthenticationMethodDtoPublicKeyInfoOneOf
• TokenPrivateKeyAuthenticationMethodDtoPublicKeyInfoOneOf1
• UnauthorizedError
• UnexpectedError
• UnexpectedErrorDetailsInner
• UpdateAccessInput
• UpdateAccessOutput
• UpdateProjectInput
• UpdateTokenInput
• UpdateTokenPrivateKeyAuthenticationMethodDto
• UserDto
• UserList
• WhoamiDto

Documentation For Authorization

Authentication schemes defined for the API:

HeritageTokenAuth

• 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

ConsumerTokenAuth

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

Author

[e-mail]