Skip to content

Latest commit

 

History

History
313 lines (221 loc) · 9.74 KB

SecureComponentProfilesApi.md

File metadata and controls

313 lines (221 loc) · 9.74 KB

SecureComponentProfilesApi

All URIs are relative to /

Method HTTP request Description
getSecureComponentProfile GET /secure-component-profiles/{scpId} Get details of a certain SecureComponentProfile.
listScpRelatedElfs GET /secure-component-profiles/{scpId}/elfs List all ELFs that use a certain SecureComponentProfile.
listScpRelatedFlavors GET /secure-component-profiles/{scpId}/services/{serviceId}/flavors List all Flavors of a certain Service that use a certain SecureCo...
listScpRelatedServices GET /secure-component-profiles/{scpId}/services List all Services that use a certain SecureComponentProfile.
listScpRelatedVersions GET /secure-component-profiles/{scpId}/services/{serviceId}/versions List all Versions of a certain Service that use a certain SecureC...
listSecureComponentProfiles GET /secure-component-profiles List all available SecureComponentProfiles.

getSecureComponentProfile

SecureComponentProfile getSecureComponentProfile(scpId)

Get details of a certain SecureComponentProfile.

Get details of a certain SecureComponentProfile.

Example

// Import classes:
//import de.bund.bsi.tsms.tsmrestapi.ApiClient;
//import de.bund.bsi.tsms.tsmrestapi.ApiException;
//import de.bund.bsi.tsms.tsmrestapi.Configuration;
//import de.bund.bsi.tsms.tsmrestapi.auth.*;
//import de.bund.bsi.tsms.tsmrestapi.api.SecureComponentProfilesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


SecureComponentProfilesApi apiInstance = new SecureComponentProfilesApi();
UUID scpId = new UUID(); // UUID | identifier of the referred Scp
try {
    SecureComponentProfile result = apiInstance.getSecureComponentProfile(scpId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SecureComponentProfilesApi#getSecureComponentProfile");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
scpId UUID identifier of the referred Scp

Return type

SecureComponentProfile

Authorization

authToken

HTTP request headers

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

listScpRelatedElfs

List<Object> listScpRelatedElfs(scpId)

List all ELFs that use a certain SecureComponentProfile.

List all ELFs that use a certain SecureComponentProfile.

Example

// Import classes:
//import de.bund.bsi.tsms.tsmrestapi.ApiClient;
//import de.bund.bsi.tsms.tsmrestapi.ApiException;
//import de.bund.bsi.tsms.tsmrestapi.Configuration;
//import de.bund.bsi.tsms.tsmrestapi.auth.*;
//import de.bund.bsi.tsms.tsmrestapi.api.SecureComponentProfilesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


SecureComponentProfilesApi apiInstance = new SecureComponentProfilesApi();
UUID scpId = new UUID(); // UUID | identifier of the referred Scp
try {
    List<Object> result = apiInstance.listScpRelatedElfs(scpId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SecureComponentProfilesApi#listScpRelatedElfs");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
scpId UUID identifier of the referred Scp

Return type

List<Object>

Authorization

authToken

HTTP request headers

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

listScpRelatedFlavors

List<Flavor> listScpRelatedFlavors(scpId, serviceId)

List all Flavors of a certain Service that use a certain SecureCo...

List all Flavors of a certain Service that use a certain SecureComponentProfile.

Example

// Import classes:
//import de.bund.bsi.tsms.tsmrestapi.ApiClient;
//import de.bund.bsi.tsms.tsmrestapi.ApiException;
//import de.bund.bsi.tsms.tsmrestapi.Configuration;
//import de.bund.bsi.tsms.tsmrestapi.auth.*;
//import de.bund.bsi.tsms.tsmrestapi.api.SecureComponentProfilesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


SecureComponentProfilesApi apiInstance = new SecureComponentProfilesApi();
UUID scpId = new UUID(); // UUID | identifier of the referred Scp
UUID serviceId = new UUID(); // UUID | identifier of the referred Service
try {
    List<Flavor> result = apiInstance.listScpRelatedFlavors(scpId, serviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SecureComponentProfilesApi#listScpRelatedFlavors");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
scpId UUID identifier of the referred Scp
serviceId UUID identifier of the referred Service

Return type

List<Flavor>

Authorization

authToken

HTTP request headers

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

listScpRelatedServices

List<Service> listScpRelatedServices(scpId)

List all Services that use a certain SecureComponentProfile.

List all Services that use a certain SecureComponentProfile.

Example

// Import classes:
//import de.bund.bsi.tsms.tsmrestapi.ApiClient;
//import de.bund.bsi.tsms.tsmrestapi.ApiException;
//import de.bund.bsi.tsms.tsmrestapi.Configuration;
//import de.bund.bsi.tsms.tsmrestapi.auth.*;
//import de.bund.bsi.tsms.tsmrestapi.api.SecureComponentProfilesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


SecureComponentProfilesApi apiInstance = new SecureComponentProfilesApi();
UUID scpId = new UUID(); // UUID | identifier of the referred Scp
try {
    List<Service> result = apiInstance.listScpRelatedServices(scpId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SecureComponentProfilesApi#listScpRelatedServices");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
scpId UUID identifier of the referred Scp

Return type

List<Service>

Authorization

authToken

HTTP request headers

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

listScpRelatedVersions

List<Version> listScpRelatedVersions(scpId, serviceId)

List all Versions of a certain Service that use a certain SecureC...

List all Versions of a certain Service that use a certain SecureComponentProfile.

Example

// Import classes:
//import de.bund.bsi.tsms.tsmrestapi.ApiClient;
//import de.bund.bsi.tsms.tsmrestapi.ApiException;
//import de.bund.bsi.tsms.tsmrestapi.Configuration;
//import de.bund.bsi.tsms.tsmrestapi.auth.*;
//import de.bund.bsi.tsms.tsmrestapi.api.SecureComponentProfilesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


SecureComponentProfilesApi apiInstance = new SecureComponentProfilesApi();
UUID scpId = new UUID(); // UUID | identifier of the referred Scp
UUID serviceId = new UUID(); // UUID | identifier of the referred Service
try {
    List<Version> result = apiInstance.listScpRelatedVersions(scpId, serviceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SecureComponentProfilesApi#listScpRelatedVersions");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
scpId UUID identifier of the referred Scp
serviceId UUID identifier of the referred Service

Return type

List<Version>

Authorization

authToken

HTTP request headers

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

listSecureComponentProfiles

List<SecureComponentProfile> listSecureComponentProfiles()

List all available SecureComponentProfiles.

List all available SecureComponentProfiles.

Example

// Import classes:
//import de.bund.bsi.tsms.tsmrestapi.ApiClient;
//import de.bund.bsi.tsms.tsmrestapi.ApiException;
//import de.bund.bsi.tsms.tsmrestapi.Configuration;
//import de.bund.bsi.tsms.tsmrestapi.auth.*;
//import de.bund.bsi.tsms.tsmrestapi.api.SecureComponentProfilesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


SecureComponentProfilesApi apiInstance = new SecureComponentProfilesApi();
try {
    List<SecureComponentProfile> result = apiInstance.listSecureComponentProfiles();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SecureComponentProfilesApi#listSecureComponentProfiles");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<SecureComponentProfile>

Authorization

authToken

HTTP request headers

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