Skip to content

Latest commit

 

History

History
311 lines (205 loc) · 12.7 KB

ConfigurationApi.md

File metadata and controls

311 lines (205 loc) · 12.7 KB
Raw

affinidi_tdk_login_configuration_client.api.ConfigurationApi

Load the API package

import 'package:affinidi_tdk_login_configuration_client/api.dart';

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

Method HTTP request Description
createLoginConfigurations POST /v1/login/configurations Create a new login configuration
deleteLoginConfigurationsById DELETE /v1/login/configurations/{configurationId} Delete login configurations by ID
getClientMetadataByClientId GET /v1/login/configurations/metadata/{clientId} Get Client Metadata By OAuth 2.0 Client ID
getLoginConfigurationsById GET /v1/login/configurations/{configurationId} Get login configuration by ID
listLoginConfigurations GET /v1/login/configurations List login configurations
updateLoginConfigurationsById PATCH /v1/login/configurations/{configurationId} Update login configurations by ID

createLoginConfigurations

CreateLoginConfigurationOutput createLoginConfigurations(createLoginConfigurationInput)

Create a new login configuration

Create a new login configuration vpDefinition and idTokenMapping have default settings that provide user email VP presentation definitions. An essential default definition is in place when it comes to the login process for end users using the Chrome extension. This definition requires users to input their email address as OIDCVP compliant, which is then verified by the Affinidi verification service.

Example

import 'package:affinidi_tdk_login_configuration_client/api.dart';
// TODO Configure API key authorization: ProjectTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKeyPrefix = 'Bearer';

final api_instance = ConfigurationApi();
final createLoginConfigurationInput = CreateLoginConfigurationInput(); // CreateLoginConfigurationInput | CreateLoginConfigurations

try {
    final result = api_instance.createLoginConfigurations(createLoginConfigurationInput);
    print(result);
} catch (e) {
    print('Exception when calling ConfigurationApi->createLoginConfigurations: $e\n');
}

Parameters

Name Type Description Notes
createLoginConfigurationInput CreateLoginConfigurationInput CreateLoginConfigurations [optional]

Return type

CreateLoginConfigurationOutput

Authorization

ProjectTokenAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteLoginConfigurationsById

deleteLoginConfigurationsById(configurationId)

Delete login configurations by ID

Delete login configurations by ID

Example

import 'package:affinidi_tdk_login_configuration_client/api.dart';
// TODO Configure API key authorization: ProjectTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKeyPrefix = 'Bearer';

final api_instance = ConfigurationApi();
final configurationId = configurationId_example; // String | The id of the login configuration

try {
    api_instance.deleteLoginConfigurationsById(configurationId);
} catch (e) {
    print('Exception when calling ConfigurationApi->deleteLoginConfigurationsById: $e\n');
}

Parameters

Name Type Description Notes
configurationId String The id of the login configuration

Return type

void (empty response body)

Authorization

ProjectTokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getClientMetadataByClientId

LoginConfigurationClientMetadataOutput getClientMetadataByClientId(clientId)

Get Client Metadata By OAuth 2.0 Client ID

Get Client Metadata By OAuth 2.0 Client ID

Example

import 'package:affinidi_tdk_login_configuration_client/api.dart';

final api_instance = ConfigurationApi();
final clientId = clientId_example; // String | OAuth 2.0 Client ID

try {
    final result = api_instance.getClientMetadataByClientId(clientId);
    print(result);
} catch (e) {
    print('Exception when calling ConfigurationApi->getClientMetadataByClientId: $e\n');
}

Parameters

Name Type Description Notes
clientId String OAuth 2.0 Client ID

Return type

LoginConfigurationClientMetadataOutput

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLoginConfigurationsById

LoginConfigurationObject getLoginConfigurationsById(configurationId)

Get login configuration by ID

Get login configuration by ID

Example

import 'package:affinidi_tdk_login_configuration_client/api.dart';
// TODO Configure API key authorization: ProjectTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKeyPrefix = 'Bearer';

final api_instance = ConfigurationApi();
final configurationId = configurationId_example; // String | The id of the login configuration

try {
    final result = api_instance.getLoginConfigurationsById(configurationId);
    print(result);
} catch (e) {
    print('Exception when calling ConfigurationApi->getLoginConfigurationsById: $e\n');
}

Parameters

Name Type Description Notes
configurationId String The id of the login configuration

Return type

LoginConfigurationObject

Authorization

ProjectTokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listLoginConfigurations

ListLoginConfigurationOutput listLoginConfigurations(limit, exclusiveStartKey)

List login configurations

Endpoint to retrieve list of login configurations

Example

import 'package:affinidi_tdk_login_configuration_client/api.dart';
// TODO Configure API key authorization: ProjectTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKeyPrefix = 'Bearer';

final api_instance = ConfigurationApi();
final limit = 56; // int | Maximum number of records to fetch in a list
final exclusiveStartKey = exclusiveStartKey_example; // String | The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation.

try {
    final result = api_instance.listLoginConfigurations(limit, exclusiveStartKey);
    print(result);
} catch (e) {
    print('Exception when calling ConfigurationApi->listLoginConfigurations: $e\n');
}

Parameters

Name Type Description Notes
limit int Maximum number of records to fetch in a list [optional]
exclusiveStartKey String The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. [optional]

Return type

ListLoginConfigurationOutput

Authorization

ProjectTokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateLoginConfigurationsById

LoginConfigurationObject updateLoginConfigurationsById(configurationId, updateLoginConfigurationInput)

Update login configurations by ID

Update login configurations by ID

Example

import 'package:affinidi_tdk_login_configuration_client/api.dart';
// TODO Configure API key authorization: ProjectTokenAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('ProjectTokenAuth').apiKeyPrefix = 'Bearer';

final api_instance = ConfigurationApi();
final configurationId = configurationId_example; // String | The id of the login configuration
final updateLoginConfigurationInput = UpdateLoginConfigurationInput(); // UpdateLoginConfigurationInput | UpdateLoginConfigurationsById

try {
    final result = api_instance.updateLoginConfigurationsById(configurationId, updateLoginConfigurationInput);
    print(result);
} catch (e) {
    print('Exception when calling ConfigurationApi->updateLoginConfigurationsById: $e\n');
}

Parameters

Name Type Description Notes
configurationId String The id of the login configuration
updateLoginConfigurationInput UpdateLoginConfigurationInput UpdateLoginConfigurationsById [optional]

Return type

LoginConfigurationObject

Authorization

ProjectTokenAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]