Skip to content

login.configuration.client

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

login.configuration.client

README.md

login.configuration.client

OidcVpAdapterBackend

  • API version: 1.0.0

  • Generator version: 7.13.0

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

For more information, please visit https://www.affinidi.com

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.affinidi.tdk</groupId>
  <artifactId>login.configuration.client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.affinidi.tdk:login.configuration.client:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/login.configuration.client-1.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.affinidi.tdk.login.configuration.client.*;
import com.affinidi.tdk.login.configuration.client.auth.*;
import com.affinidi.tdk.login.configuration.client.models.*;
import com.affinidi.tdk.login.configuration.client.apis.AllowListApi;

public class AllowListApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://apse1.api.affinidi.io/vpa");

        // Configure API key authorization: ProjectTokenAuth
        ApiKeyAuth ProjectTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("ProjectTokenAuth");
        ProjectTokenAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        // ProjectTokenAuth.setApiKeyPrefix("Token");
        // ❗️Uncomment the following line to set a dynamic hook to get auth token for authorization instead of setApiKey
        // defaultClient.setAuthTokenHook(authTokenHook);

        AllowListApi apiInstance = new AllowListApi(defaultClient);
        GroupNamesInput groupNamesInput = new GroupNamesInput(); // GroupNamesInput | List of group names as input
        try {
            apiInstance.allowGroups(groupNamesInput);
        } catch (ApiException e) {
            System.err.println("Exception when calling AllowListApi#allowGroups");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AllowListApi allowGroups POST /v1/allow-list/groups/add
AllowListApi disallowGroups POST /v1/allow-list/groups/remove
AllowListApi listAllowedGroups GET /v1/allow-list/groups
ConfigurationApi createLoginConfigurations POST /v1/login/configurations Create a new login configuration
ConfigurationApi deleteLoginConfigurationsById DELETE /v1/login/configurations/{configurationId} Delete login configurations by ID
ConfigurationApi getClientMetadataByClientId GET /v1/login/configurations/metadata/{clientId} Get Client Metadata By OAuth 2.0 Client ID
ConfigurationApi getLoginConfigurationsById GET /v1/login/configurations/{configurationId} Get login configuration by ID
ConfigurationApi listLoginConfigurations GET /v1/login/configurations List login configurations
ConfigurationApi updateLoginConfigurationsById PATCH /v1/login/configurations/{configurationId} Update login configurations by ID
DenyListApi blockGroups POST /v1/deny-list/groups/add
DenyListApi blockUsers POST /v1/deny-list/users/add
DenyListApi listBlockedGroups GET /v1/deny-list/groups
DenyListApi listBlockedUsers GET /v1/deny-list/users
DenyListApi unblockGroups POST /v1/deny-list/groups/remove
DenyListApi unblockUsers POST /v1/deny-list/users/remove
GroupApi addUserToGroup POST /v1/groups/{groupName}/users
GroupApi createGroup POST /v1/groups
GroupApi deleteGroup DELETE /v1/groups/{groupName}
GroupApi getGroupById GET /v1/groups/{groupName}
GroupApi listGroupUserMappings GET /v1/groups/{groupName}/users
GroupApi listGroups GET /v1/groups
GroupApi removeUserFromGroup DELETE /v1/groups/{groupName}/users
IdpApi v1LoginProjectProjectIdOauth2AuthGet GET /v1/login/project/{projectId}/oauth2/auth OAuth 2.0 Authorize Endpoint
IdpApi v1LoginProjectProjectIdOauth2RevokePost POST /v1/login/project/{projectId}/oauth2/revoke Revoke OAuth 2.0 Access or Refresh Token
IdpApi v1LoginProjectProjectIdOauth2SessionsLogoutGet GET /v1/login/project/{projectId}/oauth2/sessions/logout OpenID Connect Front- and Back-channel Enabled Logout
IdpApi v1LoginProjectProjectIdOauth2TokenPost POST /v1/login/project/{projectId}/oauth2/token The OAuth 2.0 Token Endpoint
IdpApi v1LoginProjectProjectIdUserinfoGet GET /v1/login/project/{projectId}/userinfo OpenID Connect Userinfo
IdpApi v1LoginProjectProjectIdWellKnownJwksJsonGet GET /v1/login/project/{projectId}/.well-known/jwks.json Discover Well-Known JSON Web Keys
IdpApi v1LoginProjectProjectIdWellKnownOpenidConfigurationGet 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: HTTP Bearer Token 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

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]