Skip to content

Latest commit

 

History

History

login_configuration_client

README.md

affinidi_tdk_login_configuration_client

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

For more information, please visit https://github.com/affinidi/affinidi-tdk

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

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_login_configuration_client

Then import the package:

import affinidi_tdk_login_configuration_client

Setuptools

Install via Setuptools.

python setup.py install --user

Then import the package:

import affinidi_tdk_login_configuration_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_login_configuration_client
from affinidi_tdk_login_configuration_client.rest import ApiException
from pprint import pprint

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

# 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"]

# 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_login_configuration_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = affinidi_tdk_login_configuration_client.AllowListApi(api_client)
    group_names_input = affinidi_tdk_login_configuration_client.GroupNamesInput() # GroupNamesInput | List of group names as input (optional)

    try:
        api_instance.allow_groups(group_names_input=group_names_input)
    except ApiException as e:
        print("Exception when calling AllowListApi->allow_groups: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AllowListApi allow_groups POST /v1/allow-list/groups/add
AllowListApi disallow_groups POST /v1/allow-list/groups/remove
AllowListApi list_allowed_groups GET /v1/allow-list/groups
ConfigurationApi create_login_configurations POST /v1/login/configurations Create a new login configuration
ConfigurationApi delete_login_configurations_by_id DELETE /v1/login/configurations/{configurationId} Delete login configurations by ID
ConfigurationApi get_client_metadata_by_client_id GET /v1/login/configurations/metadata/{clientId} Get Client Metadata By OAuth 2.0 Client ID
ConfigurationApi get_login_configurations_by_id GET /v1/login/configurations/{configurationId} Get login configuration by ID
ConfigurationApi list_login_configurations GET /v1/login/configurations List login configurations
ConfigurationApi update_login_configurations_by_id PATCH /v1/login/configurations/{configurationId} Update login configurations by ID
DenyListApi block_groups POST /v1/deny-list/groups/add
DenyListApi block_users POST /v1/deny-list/users/add
DenyListApi list_blocked_groups GET /v1/deny-list/groups
DenyListApi list_blocked_users GET /v1/deny-list/users
DenyListApi unblock_groups POST /v1/deny-list/groups/remove
DenyListApi unblock_users POST /v1/deny-list/users/remove
GroupApi add_user_to_group POST /v1/groups/{groupName}/users
GroupApi create_group POST /v1/groups
GroupApi delete_group DELETE /v1/groups/{groupName}
GroupApi get_group_by_id GET /v1/groups/{groupName}
GroupApi list_group_user_mappings GET /v1/groups/{groupName}/users
GroupApi list_groups GET /v1/groups
GroupApi remove_user_from_group DELETE /v1/groups/{groupName}/users
IdpApi v1_login_project_project_id_oauth2_auth_get GET /v1/login/project/{projectId}/oauth2/auth OAuth 2.0 Authorize Endpoint
IdpApi v1_login_project_project_id_oauth2_revoke_post POST /v1/login/project/{projectId}/oauth2/revoke Revoke OAuth 2.0 Access or Refresh Token
IdpApi v1_login_project_project_id_oauth2_sessions_logout_get GET /v1/login/project/{projectId}/oauth2/sessions/logout OpenID Connect Front- and Back-channel Enabled Logout
IdpApi v1_login_project_project_id_oauth2_token_post POST /v1/login/project/{projectId}/oauth2/token The OAuth 2.0 Token Endpoint
IdpApi v1_login_project_project_id_userinfo_get GET /v1/login/project/{projectId}/userinfo OpenID Connect Userinfo
IdpApi v1_login_project_project_id_well_known_jwks_json_get GET /v1/login/project/{projectId}/.well-known/jwks.json Discover Well-Known JSON Web Keys
IdpApi v1_login_project_project_id_well_known_openid_configuration_get GET /v1/login/project/{projectId}/.well-known/openid-configuration OpenID Connect Discovery

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

Author

[email protected]