Login Configurations

Manage Login Configurations and User Groups with Affinidi Login Service.

Supported Languages

Package: @affinidi-tdk/login-configuration-client

npm install @affinidi-tdk/login-configuration-client --save

Package: affinidi_tdk_login_configuration_client

pip install affinidi_tdk_login_configuration_client

Package: affinidi-tdk/affinidi-tdk-php

composer require affinidi-tdk/affinidi-tdk-php

Package: pkg:maven/com.affinidi.tdk/login.configuration.client

<dependency>
    <groupId>com.affinidi.tdk</groupId>
    <artifactId>login.configuration.client</artifactId>
    <version><version_number></version>
</dependency>

Check the Maven repository for the latest version of the package.

Classes and Methods

Configurations API

Use to manage Login Configuration to integrate Affinidi Login.

createLoginConfigurations

Create a new Login Configuration to integrate Affinidi Login.

Parameters

CreateLoginConfigurationInput [Object]

JSON object to provide the configuration details of the application. See more here.

Module Imports

import { ConfigurationApi, Configuration, CreateLoginConfigurationInput } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.CreateLoginConfigurationInput;
import com.affinidi.tdk.login.configuration.client.models.CreateLoginConfigurationOutput;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const api = new ConfigurationApi(authConfiguration)

const request: CreateLoginConfigurationInput = {
    name: "Sample App",
    redirectUris: ["http://localhost:3000/auth/callback"]
}

const { data } = await api.createLoginConfigurations(request)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.ConfigurationApi(api_client)

    request_json = {
        name: "Sample App",
        redirectUris: ["http://localhost:3000/auth/callback"]
    }

    create_login_configuration_input = affinidi_tdk_login_configuration_client.CreateLoginConfigurationInput.from_dict(request_json)

    api_response = api_instance.create_login_configurations(create_login_configuration_input=create_login_configuration_input)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\ConfigurationApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $request = array(
        "name" => "Sample App",
        "redirectUris" => array(
            "http://localhost:3001/api/auth/callback"
        )
    );

    $result = $apiInstance->createLoginConfigurations($request);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

    ConfigurationApi apiInstance = new ConfigurationApi(defaultClient);
    List<String> redirectUris = new ArrayList<>();
    redirectUris.add("http://localhost:3001/api/auth/callback");

    CreateLoginConfigurationInput requestInput = new CreateLoginConfigurationInput()
        .name("Sample App")
        .redirectUris(redirectUris);

    System.out.println(requestInput);



    CreateLoginConfigurationOutput result = apiInstance.createLoginConfigurations(requestInput);

    System.out.println(result.toString());

} catch (Exception e) {
    e.printStackTrace();
}

deleteLoginConfigurationsById

Delete an existing Login Configuration by ID.

Parameters

configurationId [String]

ID of the Login Configuration to delete.

Module Imports

import { ConfigurationApi, Configuration } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const api = new ConfigurationApi(authConfiguration)

// configurationID fetched from listLoginConfigurations
const configurationId = "<Config_ID>"

const result = await api.deleteLoginConfigurationsById(configurationId)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.ConfigurationApi(api_client)

    configuration_id = "<Config_ID>" 

    api_instance.delete_login_configurations_by_id(configuration_id)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\ConfigurationApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $configurationId = "<Config_ID>";

    $result = $apiInstance->deleteLoginConfigurationsById($configurationId);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    // Configure API key authorization: ProjectTokenAuth
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

    ConfigurationApi apiInstance = new ConfigurationApi(defaultClient);

    Integer limit = 10;
    ListLoginConfigurationOutput result = apiInstance.listLoginConfigurations(limit, null);

} catch (Exception e) {
    e.printStackTrace();
}

getClientMetadataByClientId

Retrieves the Client Metadata info of the Login Configuration by OAuth 2.0 Client ID.

Parameters

clientId [String]

OAuth 2.0 Client ID generated by Login Configuration.

Module Imports

import { ConfigurationApi, Configuration } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.LoginConfigurationClientMetadataOutput;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const api = new ConfigurationApi(authConfiguration)

// configurationID fetched from listLoginConfigurations
const configurationId = "<Config_ID>"

const { data } = await api.getClientMetadataByClientId(configurationId)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.ConfigurationApi(api_client)

    configuration_id = "<Config_ID>" 

    api_response = api_instance.get_client_metadata_by_client_id(configuration_id)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\ConfigurationApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $configurationId = "<Config_ID>";

    $result = $apiInstance->getClientMetadataByClientId($configurationId);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    // Configure API key authorization: ProjectTokenAuth
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

    ConfigurationApi apiInstance = new ConfigurationApi(defaultClient);

    String configurationId = "<CONFIG_ID>";

    LoginConfigurationClientMetadataOutput result = apiInstance.getClientMetadataByClientId(clientId);

    System.out.println(result.toString());

} catch (Exception e) {
    e.printStackTrace();
}

getLoginConfigurationsById

Retrieves the Login Configuration details by ID.

Parameters

configurationId [String]

ID of the existing Login Configuration to retrieve.

Module Imports

import { ConfigurationApi, Configuration } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.LoginConfigurationObject;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const api = new ConfigurationApi(authConfiguration)

// configurationID fetched from listLoginConfigurations
const configurationId = "<Config_ID>"

const { data } = await api.getLoginConfigurationsById(configurationId)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.ConfigurationApi(api_client)

    configuration_id = "<Config_ID>" 

    api_response = api_instance.get_login_configurations_by_id(configuration_id)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\ConfigurationApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $configurationId = "<Config_ID>";

    $result = $apiInstance->getLoginConfigurationsById($configurationId);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    // Configure API key authorization: ProjectTokenAuth
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

    ConfigurationApi apiInstance = new ConfigurationApi(defaultClient);

    String configurationId = "<CONFIG_ID>";

    LoginConfigurationObject result = apiInstance.getLoginConfigurationsById(clientId);

    System.out.println(result.toString());

} catch (Exception e) {
    e.printStackTrace();
}

listLoginConfigurations

List all the Login Configurations in the Project.

Parameters

limit [Integer]

Maximum number of records to fetch from the list.

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.

Module Imports

import { ConfigurationApi, Configuration } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.ListLoginConfigurationOutput;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const api = new ConfigurationApi(authConfiguration)

const { data } = await api.listLoginConfigurations()

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.ConfigurationApi(api_client)

    api_response = api_instance.list_login_configurations()

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\ConfigurationApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $result = $apiInstance->listLoginConfigurations();

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    // Configure API key authorization: ProjectTokenAuth
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

    ConfigurationApi apiInstance = new ConfigurationApi(defaultClient);
    Integer limit = 10;
    ListLoginConfigurationOutput result = apiInstance.listLoginConfigurations(limit,null);

    System.out.println(result.toString());

} catch (Exception e) {
    e.printStackTrace();
}

updateLoginConfigurationsById

Update an existing Login Configuration by ID

Parameters

configurationId [String]

ID of the Login Configuration to update.

UpdateLoginConfigurationInput [Object]

JSON object to provide to update the Login Configuration details. See more here.

Module Imports

import { ConfigurationApi, Configuration, UpdateLoginConfigurationInput } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.LoginConfigurationObject;
import com.affinidi.tdk.login.configuration.client.models.UpdateLoginConfigurationInput;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const api = new ConfigurationApi(authConfiguration)

// configurationID fetched from listLoginConfigurations
const configurationId = "<Config_ID>"

// create a request object of type UpdateLoginConfigurationInput and add the attributes to be changed
const request: UpdateLoginConfigurationInput = {
    name: "My Updated Login Config"
    redirectUris: ["http://localhost:3001/api/auth/callback"]
}

const { data } = await api.updateLoginConfigurationsById(configurationId, request)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.ConfigurationApi(api_client)

    configuration_id = "<Config_ID>" 

    # Prepare the request data which contains the attributes to be changed
    request_json = {
        name: "My Updated Login Config"
        redirectUris: ["http://localhost:3001/api/auth/callback"]
    }

    update_login_configuration_input = affinidi_tdk_login_configuration_client.UpdateLoginConfigurationInput.from_dict(request_json)

    api_response = api_instance.update_login_configurations_by_id(configuration_id, update_login_configuration_input)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\ConfigurationApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $configurationId = "<CONFIG_ID>";
    $request = array(
        "name" => "My Updated Login Config"
        "redirectUris" => array(
            "http://localhost:3001/api/auth/callback"
        )
    );

    $result = $apiInstance->updateLoginConfigurationsById($configurationId, $request);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    // Configure API key authorization: ProjectTokenAuth
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

    ConfigurationApi apiInstance = new ConfigurationApi(defaultClient);
    String configurationId = "<My Updated Login Config>";
    List<String> redirectUris = new ArrayList<>();
    redirectUris.add("http://localhost:3001/api/auth/callback");
    UpdateLoginConfigurationInput requestInput = new UpdateLoginConfigurationInput();
         .redirectUris(redirectUris);            
    LoginConfigurationObject result = apiInstance.updateLoginConfigurationsById(configurationId,requestInput);

    System.out.println(result.toString());

} catch (Exception e) {
    e.printStackTrace();
}

Group API

Used to manage the User Groups for the Project.

addUserToGroup

Add user to the user group.

Parameters

groupName [String]

Name of the group to add the user.

AddUserToGroupInput [Object]

JSON object to provide with the ID of the user to add. See more here.

Module Imports

import { GroupApi, Configuration, AddUserToGroupInput } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.AddUserToGroupInput;
import com.affinidi.tdk.login.configuration.client.models.GroupUserMappingDto;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const groupApi = new GroupApi(authConfiguration)

const groupName = "gold"

const userToBeAdded: AddUserToGroupInput = {
    userId: "did:key:890890890890890",
}

const { data } = await groupApi.addUserToGroup(groupName, userToBeAdded)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.GroupApi(api_client)
    
    group_name = "gold"

    user_to_be_added_json = {
        user_id: "did:key:890890890890890"
    }
    
    add_user_to_group_input = affinidi_tdk_login_configuration_client.AddUserToGroupInput.from_dict(user_to_be_added_json) 

    api_response = api_instance.add_user_to_group(group_name, add_user_to_group_input)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\GroupApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $groupName = "gold";

    $request = array(
        userId: "did:key:890890890890890",
    );

    $result = $apiInstance->addUserToGroup($groupName, $request);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try{

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

    GroupApi apiInstance = new GroupApi(defaultClient);
    String groupName = "<group_name>";
    AddUserToGroupInput requestInput = new AddUserToGroupInput ()
        .userId ("did:key:890890890890890");
    System.out.println(requestInput);

    GroupUserMappingDto result = apiInstance.addUserToGroup(groupName, requestInput);

    System.out.println(result.toString());

} catch (Exception e) {
    e.printStackTrace();
}

createGroup

Create a user group.

Parameters

CreateGroupInput [Object]

JSON object to provide the name of the user group.

Module Imports

import { GroupApi, Configuration, CreateGroupInput } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.CreateGroupInput;
import com.affinidi.tdk.login.configuration.client.models.GroupDto;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const groupApi = new GroupApi(authConfiguration)

const newGroupName : CreateGroupInput = {
    groupName: "silver"
}

const { data } = await groupApi.createGroup(newGroupName)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.GroupApi(api_client)
    
    group_name_input = {
        group_name: "silver"
    }
    
    create_group_input = affinidi_tdk_login_configuration_client.CreateGroupInput.from_dict(group_name_input) 

    api_response = api_instance.create_group(create_group_input)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\GroupApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $request = array(
        groupName: "silver"
    );

    $result = $apiInstance->createGroup($request);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

    GroupApi apiInstance = new GroupApi(defaultClient);
    CreateGroupInput requestInput = new CreateGroupInput ()
        .groupName ("<groupname>");
    GroupDto result = apiInstance.createGroup(requestInput);

    System.out.println(result.toString());

} catch (Exception e) {
    e.printStackTrace();
}

deleteGroup

Delete a group by name.

Parameters

groupName [String]

Name of the group to delete.

Module Imports

import { GroupApi, Configuration } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const groupApi = new GroupApi(authConfiguration)

const groupName = "bronze"

const result = await groupApi.deleteGroup(groupName)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.GroupApi(api_client)
    
    group_name = "bronze"
    
    api_instance.delete_group(group_name)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\GroupApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $groupName = "bronze";

    $result = $apiInstance->deleteGroup($groupName);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

        
    GroupApi apiInstance = new GroupApi(defaultClient);
    
    String groupName = "<group_name>";

    apiInstance.deleteGroup(groupName);

    System.out.println(groupName.toString());

} catch (Exception e) {
    e.printStackTrace();
}

getGroupById

Retrieve a group by the group name.

Parameters

groupName [String]

Name of the group to retrieve.

Module Imports

import { GroupApi, Configuration } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.GroupDto;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const groupApi = new GroupApi(authConfiguration)

const groupName = "silver"

const result = await groupApi.getGroupById(groupName)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.GroupApi(api_client)
    
    group_name = "bronze"
    
    api_response = api_instance.get_group_by_id(group_name)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\GroupApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $groupName = "silver";

    $result = $apiInstance->getGroupById($groupName);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try{
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

    GroupApi apiInstance = new GroupApi(defaultClient);
    String groupName = "<groupname>";
    GroupDto result = apiInstance.getGroupById(groupName);
    System.out.println(result.toString());

} catch (Exception e) {
    e.printStackTrace();
}

listGroupUserMappings

List all the users from the group.

Parameters

groupName [String]

Name of the group to list.

limit [Integer]

Maximum number of records to fetch in a list.

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.

sortOrder [String]

sort response in specific order. By default it is in desc order.

Module Imports

import { GroupApi, Configuration } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.GroupUserMappingsList;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const groupApi = new GroupApi(authConfiguration)

const groupName = "gold"

const { data } = await groupApi.listGroupUserMappings(groupName)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.GroupApi(api_client)
    
    group_name = "gold" 

    limit = 56 # int | Maximum number of records to fetch in a list (optional)
    
    exclusive_start_key = "exclusive_start_key_example" # str | 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)
    
    sort_order = "desc"

    api_response = api_instance.list_group_user_mappings(group_name, limit=limit, exclusive_start_key=exclusive_start_key, sort_order=sort_order)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\GroupApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $groupName = "gold";

    $result = $apiInstance->listGroupUserMappings($groupName);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try{

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

    GroupApi apiInstance = new GroupApi(defaultClient);
    String groupName = "<groupName_example>"; 
    GroupUserMappingsList result = apiInstance.listGroupUserMappings(groupName, null, null ,null);

    System.out.println(result.toString());

} catch (Exception e) {
    e.printStackTrace();
}

listGroups

List all the groups in the Project.

Parameters

No Parameters Required

Module Imports

import { GroupApi, Configuration } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.GroupsList;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const groupApi = new GroupApi(authConfiguration)

const { data } = await groupApi.listGroups()

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.GroupApi(api_client)
    
    api_response = api_instance.list_groups()

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\GroupApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $result = $apiInstance->listGroups();

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try{

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

    GroupApi apiInstance = new GroupApi(defaultClient);
    
    GroupsList result = apiInstance.listGroups();

    System.out.println(result.toString());

} catch (Exception e) {
    e.printStackTrace();
}

removeUserFromGroup

Remove user from the group.

Parameters

groupName [String]

Name of the group where the user will be removed.

RemoveUserFromGroupInput [Object]

JSON object to provide the ID of the user to remove. See more here.

Module Imports

import { GroupApi, Configuration, RemoveUserFromGroupInput } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.RemoveUserFromGroupInput;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const groupApi = new GroupApi(authConfiguration)

const groupName = "gold"

const userToRemove : RemoveUserFromGroupInput = {
    "userId": "did:key:890890890890890"
}

const { data } = await groupApi.removeUserFromGroup(groupName, userToRemove)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.GroupApi(api_client)
    
    group_name = "gold" 

    user_to_remove_json = {
        "userId": "did:key:890890890890890"
    }

    remove_user_from_group_input = affinidi_tdk_login_configuration_client.RemoveUserFromGroupInput.from_dict(user_to_remove_json)

    api_instance.remove_user_from_group(group_name, remove_user_from_group_input)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\GroupApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $groupName = "gold";
    $request = array(
        "userId": "did:key:890890890890890"
    );

    $result = $apiInstance->removeUserFromGroup($groupName, $request);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try{
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

    GroupApi apiInstance = new GroupApi(defaultClient);
    String groupName = "<groupName>";
    RemoveUserFromGroupInput requestInput = new RemoveUserFromGroupInput()
        .userId ("did:key:890890890890890");
    System.out.println(requestInput.toString());

    apiInstance.removeUserFromGroup(groupName, requestInput);

    System.out.println(groupName.toString());

} catch (Exception e) {
    e.printStackTrace();
}

DenyList API

Used to block groups and users to deny access on services like Affinidi Login when users are authenticating.

blockGroups

Block users by group.

Parameters

GroupNamesInput [Object]

List of groups to block. See more here.

Module Imports

import { DenyListApi, Configuration, GroupNamesInput } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.GroupNamesInput;
import com.affinidi.tdk.login.configuration.client.apis.DenyListApi;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const api = new DenyListApi(authConfiguration)

const request: GroupNamesInput = [
    "group-1",
    "group-2"
]

const { data } = await api.blockGroups(request)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.DenyListApi(api_client)

    request_json = [
        "group-1",
        "group-2"
    ]

    api_response = api_instance.block_groups(group_names_input=request_json)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\DenyListApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $request = array(
        "group-1",
        "group-2"
    );

    $result = $apiInstance->blockGroups($request);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try{
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

    GroupApi apiInstance = new GroupApi(defaultClient);
    List<String> groupNames = new ArrayList<>();
    groupNames.add("<groupname1>");
    groupNames.add("<groupname2>");
    GroupNamesInput requestInput = new GroupNamesInput();
    apiInstance.blockGroups(requestInput);

    System.out.println(groupName.toString());

} catch (Exception e) {
    e.printStackTrace();
}

blockUsers

Block by User ID (DID).

Parameters

BlockedUsersInput [Object]

List of User IDs (DIDs) to block. See more here.

Module Imports

import { DenyListApi, Configuration, BlockedUsersInput } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.BlockedUsersInput;
import com.affinidi.tdk.login.configuration.client.apis.DenyListApi;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const api = new DenyListApi(authConfiguration)

const request: BlockedUsersInput = [
    "user-1-did",
    "user-2-did"
]

const { data } = await api.blockUsers(request)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.DenyListApi(api_client)

    request_json = [
        "user-1-did",
        "user-2-did"
    ]

    api_response = api_instance.block_users(blocked_users_input=request_json)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\DenyListApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $request = array(
        "user-1-did",
        "user-2-did"
    );

    $result = $apiInstance->blockUsers($request);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try{
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

    DenyListApi apiInstance = new Denylist(defaultClient);
    List<String> groupNames = new ArrayList<>();
    userdid.add("<user-1-did>");
    userdid.add("<user-2-did>");
    BlockedUsersInput requestInput = new BlockedUsersInput();
    apiInstance.blockGroups(requestInput);

    System.out.println(requestInput.toString());

} catch (Exception e) {
    e.printStackTrace();
}

listBlockedGroups

Get list of blocked groups.

Parameters

pageToken [String]

Used for pagination.

Module Imports

import { DenyListApi, Configuration } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.GroupNames;
import com.affinidi.tdk.login.configuration.client.apis.DenyListApi;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const api = new DenyListApi(authConfiguration)

const { data } = await api.listBlockedGroups()

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.DenyListApi(api_client)

    api_response = api_instance.list_blocked_groups()

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\DenyListApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $result = $apiInstance->listBlockedGroups();

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try{
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());
    DenyListApi apiInstance = new DenyListApi(defaultClient);

    GroupNames result = apiInstance.listBlockedGroups(null)
    
    System.out.println(result);

} catch (Exception e) {
    e.printStackTrace();
}

listBlockedUsers

Get list of blocked users.

Parameters

pageToken [String]

Used for pagination.

Module Imports

import { DenyListApi, Configuration } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.BlockedUsers;
import com.affinidi.tdk.login.configuration.client.apis.DenyListApi;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const api = new DenyListApi(authConfiguration)

const { data } = await api.listBlockedUsers()

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.DenyListApi(api_client)

    api_response = api_instance.list_blocked_users()

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\DenyListApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $result = $apiInstance->listBlockedUsers();

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try{
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());
    DenyListApi apiInstance = new DenyListApi(defaultClient);
    BlockedUsers  result = apiInstance.listBlockedUsers(null);
    
    System.out.println(result);

} catch (Exception e) {
    e.printStackTrace();
}

unblockGroups

Unblock users by group.

Parameters

GroupNamesInput [Object]

List of groups to block. See more here.

Module Imports

import { DenyListApi, Configuration, GroupNamesInput } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.GroupNamesInput;
import com.affinidi.tdk.login.configuration.client.apis.DenyListApi;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const api = new DenyListApi(authConfiguration)

const request: GroupNamesInput = [
    "group-1-name",
    "group-2-name"
]

const { data } = await api.unblockGroups(request)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.DenyListApi(api_client)

    request_json = [
        "group-1-name",
        "group-2-name"
    ]

    api_response = api_instance.unblock_groups(group_names_input=request_json)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\DenyListApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $request = array(
        "group-1-name",
        "group-2-name"
    );

    $result = $apiInstance->unblockGroups($request);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try{

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());
    DenyListApi apiInstance = new DenyListApi(defaultClient);
    List<String> groupNames = new ArrayList<>();
    groupNames.add("<groupname1>");
    groupNames.add("<groupname2?");
    GroupNamesInput requestInput = new GroupNamesInput();

    apiInstance.unblockGroups(requestInput);

    System.out.println(requestInput);

} catch (Exception e) {
    e.printStackTrace();
}

unblockUsers

Unblock by User ID (DID).

Parameters

BlockedUsersInput [Object]

List of User IDs (DIDs) to block. See more here.

Module Imports

import { DenyListApi, Configuration, BlockedUsersInput } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.BlockedUsersInput;
import com.affinidi.tdk.login.configuration.client.apis.DenyListApi;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const api = new DenyListApi(authConfiguration)

const request: BlockedUsersInput = [
    "user-1-did",
    "user-2-did"
]

const { data } = await api.unblockUsers(request)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.DenyListApi(api_client)

    request_json = [
        "user-1-did",
        "user-2-did"
    ]

    api_response = api_instance.unblock_users(blocked_users_input=request_json)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\DenyListApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $request = array(
        "user-1-did",
        "user-2-did"
    );

    $result = $apiInstance->unblockUsers($request);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try{
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());
    DenyListApi apiInstance = new DenyListApi(defaultClient);
    List<String> userdid = new ArrayList<>();
    userdid.add("user-1-did");
    userdid.add("user-2-did");
    BlockedUsersInput requestInput = new BlockedUsersInput();

    apiInstance.unblockUsers(requestInput);

    System.out.println(requestInput);

} catch (Exception e) {
    e.printStackTrace();
}

AllowList API

Used to allow groups and users to grant access on services like Affinidi Login when users are authenticating.

allowGroups

Allows users by group.

Parameters

GroupNamesInput [Object]

List of groups to allow. See more here.

Module Imports

import { AllowListApi, Configuration, GroupNamesInput } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.GroupNamesInput;
import com.affinidi.tdk.login.configuration.client.apis.AllowListApi;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const api = new AllowListApi(authConfiguration)

const request: GroupNamesInput = [
    "group-1",
    "group-2"
]

const { data } = await api.allowGroups(request)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.AllowListApi(api_client)

    request_json = [
        "group-1",
        "group-2"
    ]

    api_response = api_instance.allow_groups(group_names_input=request_json)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\AllowListApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $request = array(
        "group-1",
        "group-2"
    );

    $result = $apiInstance->allowGroups($request);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try{

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

    AllowListApi apiInstance = new AllowListApi(defaultClient);
    GroupNamesInput requestInput = new GroupNamesInput();
    List<String> groupNames = new ArrayList<>();
    groupNames.add("<groupname1>");
    groupNames.add("<groupname2>");

    apiInstance.allowGroups(requestInput);

    System.out.println(requestInput.toString());

} catch (Exception e) {
    e.printStackTrace();
}

disallowGroups

Disallow access to users by group.

Parameters

GroupNamesInput [Object]

List of groups to disallow. See more here.

Module Imports

import { AllowListApi, Configuration, GroupNamesInput } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.GroupNamesInput;
import com.affinidi.tdk.login.configuration.client.apis.AllowListApi;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const api = new AllowListApi(authConfiguration)

const request: GroupNamesInput = [
    "group-1",
    "group-2"
]

const { data } = await api.disallowGroups(request)

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.AllowListApi(api_client)

    request_json = [
        "group-1",
        "group-2"
    ]

    api_response = api_instance.disallow_groups(group_names_input=request_json)

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\AllowListApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $request = array(
        "group-1",
        "group-2"
    );

    $result = $apiInstance->disallowGroups($request);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try{

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());

    AllowListApi apiInstance = new AllowListApi(defaultClient);
    GroupNamesInput requestInput = new GroupNamesInput();
    List<String> groupNames = new ArrayList<>();
    groupNames.add("<groupname1>");
    groupNames.add("<groupname2>");

    apiInstance.disallowGroups(requestInput);

    System.out.println(requestInput.toString());

} catch (Exception e) {
    e.printStackTrace();
}

listAllowedGroups

Get list of allowed groups.

Parameters

pageToken [String]

Used for pagination.

Module Imports

import { AllowListApi, Configuration } from '@affinidi-tdk/login-configuration-client'

import affinidi_tdk_login_configuration_client

require_once 'vendor/autoload.php';

use AffinidiTdk\Clients\LoginConfigurationClient;

import com.affinidi.tdk.authProvider.AuthProvider;
import com.affinidi.tdk.login.configuration.client.ApiClient;
import com.affinidi.tdk.login.configuration.client.Configuration;
import com.affinidi.tdk.login.configuration.client.auth.ApiKeyAuth;
import com.affinidi.tdk.login.configuration.client.models.GroupNames;
import com.affinidi.tdk.login.configuration.client.apis.AllowListApi;

Sample Codes

// Pass the projectScopedToken generated from AuthProvider package
const authConfiguration = new Configuration({
  apiKey: authProvider.fetchProjectScopedToken.bind(authProvider)
})

const api = new AllowListApi(authConfiguration)

const { data } = await api.listAllowedGroups()

configuration = affinidi_tdk_login_configuration_client.Configuration()
# Pass the projectScopedToken generated from AuthProvider package
configuration.api_key['ProjectTokenAuth'] = projectScopedToken

with affinidi_tdk_login_configuration_client.ApiClient(configuration) as api_client:
    api_instance = affinidi_tdk_login_configuration_client.AllowListApi(api_client)

    api_response = api_instance.list_allowed_groups()

$tokenCallback = [$authProvider, 'fetchProjectScopedToken'];

// Configure API key authorization: ProjectTokenAuth
$config = LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);

$apiInstance = new LoginConfigurationClient\Api\AllowListApi(
    new GuzzleHttp\Client(),
    $config
);

try {

    $result = $apiInstance->listAllowedGroups($request);

    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling method: ', $e->getMessage(), PHP_EOL;
}

try{

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
    ProjectTokenAuth.setApiKey(authProvider.fetchProjectScopedToken());
    AllowListApi apiInstance = new AllowListApi(defaultClient);
    GroupNames result = apiInstance.listAllowedGroups(null);

    System.out.println(result);

} catch (Exception e) {
    e.printStackTrace();
}

Was this page helpful?

Glad to hear it! Please tell us how we can improve more.

Sorry to hear that. Please tell us how we can improve.

Thank you for sharing your feedback so we can improve your experience.