affinidi_tdk_login_configuration_client 1.60.0
OidcVpAdapterBackend
License: Apache-2.0
Requires Python: <4.0,>=3.8
Keywords: OpenAPI, OpenAPI-Generator, OidcVpAdapterBackend

# affinidi_tdk_login_configuration_client

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

For more information, please visit [https://www.affinidi.com](https://www.affinidi.com)

Documentation is available at [https://docs.affinidi.com/dev-tools/affinidi-tdk/clients/login-configuration/](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:

```sh
pip install affinidi_tdk_login_configuration_client
```

Then import the package:

```python
import affinidi_tdk_login_configuration_client
```

### Setuptools

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

```sh
python setup.py install --user
```

Then import the package:

```python
import affinidi_tdk_login_configuration_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

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

# 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_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**](docs/AllowListApi.md#allow_groups)                                                                                                 | **POST** /v1/allow-list/groups/add                                     |
| _AllowListApi_     | [**disallow_groups**](docs/AllowListApi.md#disallow_groups)                                                                                           | **POST** /v1/allow-list/groups/remove                                  |
| _AllowListApi_     | [**list_allowed_groups**](docs/AllowListApi.md#list_allowed_groups)                                                                                   | **GET** /v1/allow-list/groups                                          |
| _ConfigurationApi_ | [**create_login_configurations**](docs/ConfigurationApi.md#create_login_configurations)                                                               | **POST** /v1/login/configurations                                      | Create a new login configuration                      |
| _ConfigurationApi_ | [**delete_login_configurations_by_id**](docs/ConfigurationApi.md#delete_login_configurations_by_id)                                                   | **DELETE** /v1/login/configurations/{configurationId}                  | Delete login configurations by ID                     |
| _ConfigurationApi_ | [**get_client_metadata_by_client_id**](docs/ConfigurationApi.md#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**](docs/ConfigurationApi.md#get_login_configurations_by_id)                                                         | **GET** /v1/login/configurations/{configurationId}                     | Get login configuration by ID                         |
| _ConfigurationApi_ | [**list_login_configurations**](docs/ConfigurationApi.md#list_login_configurations)                                                                   | **GET** /v1/login/configurations                                       | List login configurations                             |
| _ConfigurationApi_ | [**update_login_configurations_by_id**](docs/ConfigurationApi.md#update_login_configurations_by_id)                                                   | **PATCH** /v1/login/configurations/{configurationId}                   | Update login configurations by ID                     |
| _DenyListApi_      | [**block_groups**](docs/DenyListApi.md#block_groups)                                                                                                  | **POST** /v1/deny-list/groups/add                                      |
| _DenyListApi_      | [**block_users**](docs/DenyListApi.md#block_users)                                                                                                    | **POST** /v1/deny-list/users/add                                       |
| _DenyListApi_      | [**list_blocked_groups**](docs/DenyListApi.md#list_blocked_groups)                                                                                    | **GET** /v1/deny-list/groups                                           |
| _DenyListApi_      | [**list_blocked_users**](docs/DenyListApi.md#list_blocked_users)                                                                                      | **GET** /v1/deny-list/users                                            |
| _DenyListApi_      | [**unblock_groups**](docs/DenyListApi.md#unblock_groups)                                                                                              | **POST** /v1/deny-list/groups/remove                                   |
| _DenyListApi_      | [**unblock_users**](docs/DenyListApi.md#unblock_users)                                                                                                | **POST** /v1/deny-list/users/remove                                    |
| _GroupApi_         | [**add_user_to_group**](docs/GroupApi.md#add_user_to_group)                                                                                           | **POST** /v1/groups/{groupName}/users                                  |
| _GroupApi_         | [**create_group**](docs/GroupApi.md#create_group)                                                                                                     | **POST** /v1/groups                                                    |
| _GroupApi_         | [**delete_group**](docs/GroupApi.md#delete_group)                                                                                                     | **DELETE** /v1/groups/{groupName}                                      |
| _GroupApi_         | [**get_group_by_id**](docs/GroupApi.md#get_group_by_id)                                                                                               | **GET** /v1/groups/{groupName}                                         |
| _GroupApi_         | [**list_group_user_mappings**](docs/GroupApi.md#list_group_user_mappings)                                                                             | **GET** /v1/groups/{groupName}/users                                   |
| _GroupApi_         | [**list_groups**](docs/GroupApi.md#list_groups)                                                                                                       | **GET** /v1/groups                                                     |
| _GroupApi_         | [**remove_user_from_group**](docs/GroupApi.md#remove_user_from_group)                                                                                 | **DELETE** /v1/groups/{groupName}/users                                |
| _IdpApi_           | [**v1_login_project_project_id_oauth2_auth_get**](docs/IdpApi.md#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**](docs/IdpApi.md#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**](docs/IdpApi.md#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**](docs/IdpApi.md#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**](docs/IdpApi.md#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**](docs/IdpApi.md#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**](docs/IdpApi.md#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

- [ActionForbiddenError](docs/ActionForbiddenError.md)
- [AddUserToGroupInput](docs/AddUserToGroupInput.md)
- [AuthorizationRequestDcql](docs/AuthorizationRequestDcql.md)
- [AuthorizationRequestPex](docs/AuthorizationRequestPex.md)
- [BlockedUsers](docs/BlockedUsers.md)
- [BlockedUsersInput](docs/BlockedUsersInput.md)
- [CorsLoginSessionAcceptResponseOK](docs/CorsLoginSessionAcceptResponseOK.md)
- [CorsLoginSessionForIdpOK](docs/CorsLoginSessionForIdpOK.md)
- [CorsLoginSessionRejectResponseOK](docs/CorsLoginSessionRejectResponseOK.md)
- [CreateGroupInput](docs/CreateGroupInput.md)
- [CreateHydraNetworkError](docs/CreateHydraNetworkError.md)
- [CreateLoginConfigurationInput](docs/CreateLoginConfigurationInput.md)
- [CreateLoginConfigurationOutput](docs/CreateLoginConfigurationOutput.md)
- [CreateLoginConfigurationOutputAuth](docs/CreateLoginConfigurationOutputAuth.md)
- [CreateLoginConfigurations400Response](docs/CreateLoginConfigurations400Response.md)
- [CreateProjectNetworkError](docs/CreateProjectNetworkError.md)
- [ErrorOAuth2](docs/ErrorOAuth2.md)
- [GetUserInfo](docs/GetUserInfo.md)
- [GroupDto](docs/GroupDto.md)
- [GroupNames](docs/GroupNames.md)
- [GroupNamesInput](docs/GroupNamesInput.md)
- [GroupUserMappingDto](docs/GroupUserMappingDto.md)
- [GroupUserMappingsList](docs/GroupUserMappingsList.md)
- [GroupsList](docs/GroupsList.md)
- [GroupsPerUserLimitExceededError](docs/GroupsPerUserLimitExceededError.md)
- [IdTokenMappingItem](docs/IdTokenMappingItem.md)
- [InlineObject](docs/InlineObject.md)
- [InvalidClaimContextError](docs/InvalidClaimContextError.md)
- [InvalidGroupsError](docs/InvalidGroupsError.md)
- [InvalidParameterError](docs/InvalidParameterError.md)
- [InvalidParameterErrorDetailsInner](docs/InvalidParameterErrorDetailsInner.md)
- [InvalidVPTokenCreationTimeError](docs/InvalidVPTokenCreationTimeError.md)
- [JsonWebKey](docs/JsonWebKey.md)
- [JsonWebKeyKeysInner](docs/JsonWebKeyKeysInner.md)
- [ListLoginConfigurationOutput](docs/ListLoginConfigurationOutput.md)
- [LoginConfigurationClientMetadataInput](docs/LoginConfigurationClientMetadataInput.md)
- [LoginConfigurationClientMetadataOutput](docs/LoginConfigurationClientMetadataOutput.md)
- [LoginConfigurationObject](docs/LoginConfigurationObject.md)
- [LoginConfigurationReadInvalidClientIdError](docs/LoginConfigurationReadInvalidClientIdError.md)
- [LoginSessionAcceptResponseInput](docs/LoginSessionAcceptResponseInput.md)
- [LoginSessionAcceptResponseOutput](docs/LoginSessionAcceptResponseOutput.md)
- [LoginSessionDto](docs/LoginSessionDto.md)
- [LoginSessionDtoAuthorizationRequest](docs/LoginSessionDtoAuthorizationRequest.md)
- [LoginSessionForIDPInput](docs/LoginSessionForIDPInput.md)
- [LoginSessionRejectResponseInput](docs/LoginSessionRejectResponseInput.md)
- [LoginSessionRejectResponseOutput](docs/LoginSessionRejectResponseOutput.md)
- [NotFoundError](docs/NotFoundError.md)
- [OAuth2Token](docs/OAuth2Token.md)
- [OAuth2TokenAuthorizationDetailsInner](docs/OAuth2TokenAuthorizationDetailsInner.md)
- [OIDCConfig](docs/OIDCConfig.md)
- [OIDCConfigCredentialsSupportedDraft00Inner](docs/OIDCConfigCredentialsSupportedDraft00Inner.md)
- [RedirectResponse](docs/RedirectResponse.md)
- [RemoveUserFromGroupInput](docs/RemoveUserFromGroupInput.md)
- [ResourceCreationError](docs/ResourceCreationError.md)
- [ServiceErrorResponse](docs/ServiceErrorResponse.md)
- [ServiceErrorResponseDetailsInner](docs/ServiceErrorResponseDetailsInner.md)
- [TokenEndpointAuthMethod](docs/TokenEndpointAuthMethod.md)
- [UnauthorizedError](docs/UnauthorizedError.md)
- [UpdateLoginConfigurationInput](docs/UpdateLoginConfigurationInput.md)
- [VPTokenValidationError](docs/VPTokenValidationError.md)

<a id="documentation-for-authorization"></a>

## Documentation For Authorization

Authentication schemes defined for the API:
<a id="AwsSigV4"></a>

### AwsSigV4

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header

<a id="ApiKey"></a>

### ApiKey

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

<a id="bearerAuth"></a>

### bearerAuth

- **Type**: Bearer authentication (JWT)

<a id="ConsumerTokenAuth"></a>

### ConsumerTokenAuth

- **Type**: API key
- **API key parameter name**: authorization
- **Location**: HTTP header

<a id="UserTokenAuth"></a>

### UserTokenAuth

- **Type**: API key
- **API key parameter name**: authorization
- **Location**: HTTP header

<a id="ProjectTokenAuth"></a>

### ProjectTokenAuth

- **Type**: API key
- **API key parameter name**: authorization
- **Location**: HTTP header

## Author

info@affinidi.com