Skip to content

Latest commit

 

History

History
181 lines (128 loc) · 6.88 KB

README.md

File metadata and controls

181 lines (128 loc) · 6.88 KB
Raw

continuous-auditing-api-java-client

EU-SEC CA API

  • API version: 1.0.8
    • Build date: 2019-04-03T09:38:29.538+02:00

This is audit-api serves evidences for a continuous audit. In the EU-Sec project such evidences are collected and evaluated to determine the compliance status based on controls from the ccm.

For more information, please visit http://www.sec-cert.eu/

Automatically generated by the Swagger Codegen

Requirements

Building the API client library requires:

  1. Java 1.7+
  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>eu.sec.cert</groupId>
  <artifactId>continuous-auditing-api-java-client</artifactId>
  <version>1.0.8</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "eu.sec.cert:continuous-auditing-api-java-client:1.0.8"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/continuous-auditing-api-java-client-1.0.8.jar
  • target/lib/*.jar

Getting Started

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

import eu.sec.cert.*;
import eu.sec.cert.auth.*;
import eu.sec.cert.model.*;
import eu.sec.cert.api.CaApiIamApi;

import java.io.File;
import java.util.*;

public class CaApiIamApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        // Configure HTTP basic authorization: basic_auth
        HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth");
        basic_auth.setUsername("YOUR USERNAME");
        basic_auth.setPassword("YOUR PASSWORD");

        CaApiIamApi apiInstance = new CaApiIamApi();
        String scope = "scope_example"; // String | Scope of the service
        try {
            AdminResponse result = apiInstance.getAdmins(scope);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CaApiIamApi#getAdmins");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://localhost/euseccaapi

Class Method HTTP request Description
CaApiIamApi getAdmins GET /{scope}/identityfederation/admins/ Returns a list of administrators
CaApiIamApi getObjectAccess POST /{scope}/identityfederation/data/access Checks whether a user has a certain access to an object.
CaApiIamApi getPasswordRequirements GET /{scope}/identityfederation/{userId}/passwordRequirements returns the password requirements for a specific user
CaApiIamApi getUserAccesses GET /{scope}/identityfederation/{userId}/logins Returns a list of the last logins of a user
CaApiIamApi getUserAuthType GET /{scope}/identityfederation/{userId}/auth Returns the authentication type of a user. E.g password, two-factor
CaApiIamApi getUserOrganisation GET /{scope}/identityfederation/{userId}/groups Returns the groups of a user
CaApiMetaApi getSubmitted GET /{scope}/meta/submitted Returns a list of administrators
CaApiObjectsApi getObjects GET /{scope}/objects/ Returns Object ids of all objects that are in the scope of the audit.
CaApiPersistenceApi getEncryptionInfo GET /{scope}/persistence/{objectId}/encryption Retrieves the encryption info of an object.
CaApiPersistenceApi getLocation GET /{scope}/persistence/{objectId}/location/ Returns location the ISO 3166-1 alpha-2 country code of the location of the data of the object
CaApiPersistenceApi getStorage GET /{scope}/persistence/{objectId}/storage/ Returns persistence information for a particular data object by its Id
CaApiScopeApi getScopes GET /scopes/ Returns all scopes of the cloud service

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

api_key

  • Type: API key
  • API key parameter name: api_key
  • Location: HTTP header

basic_auth

  • Type: HTTP basic authentication

Recommendation

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

Author

contact@sec-cert.eu