ApiKeysApi

All URIs are relative to https://backend.id4i.de

Method	HTTP request	Description
addApiKeyPrivilege	POST /api/v1/apikeys/{key}/privileges	Add privilege
addApiKeyPrivilegeForId4ns	POST /api/v1/apikeys/{key}/privileges/{privilege}/id4ns	Add ID4ns of a privilege
createNewApiKey	POST /api/v1/apikeys	Create API key
deleteApiKey	DELETE /api/v1/apikeys/{key}	Delete API key
getApiKey	GET /api/v1/apikeys/{key}	Show API key
listAllApiKeyPrivileges	GET /api/v1/apikeys/privileges	List all privileges
listAllApiKeysOfOrganization	GET /api/v1/apikeys	Find API key by organization
listApiKeyPrivileges	GET /api/v1/apikeys/{key}/privileges	List privileges
listId4ns	GET /api/v1/apikeys/{key}/privileges/{privilege}/id4ns	ID4ns of a privilege
removeApiKeyPrivilege	DELETE /api/v1/apikeys/{key}/privileges	Remove privilege
removeApiKeyPrivilegeForId4ns	DELETE /api/v1/apikeys/{key}/privileges/{privilege}/id4ns	Remove id4ns of a privilege
updateApiKey	PUT /api/v1/apikeys/{key}	Update API keys

addApiKeyPrivilege

addApiKeyPrivilege(key, addApiKeyPrivilegeRequest)

Add privilege

Example

// Import classes:
//import de.id4i.ApiClient;
//import de.id4i.ApiException;
//import de.id4i.Configuration;
//import de.id4i.auth.*;
//import de.id4i.api.ApiKeysApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");

ApiKeysApi apiInstance = new ApiKeysApi();
String key = "key_example"; // String | key
AddApiKeyPrivilegeRequest addApiKeyPrivilegeRequest = new AddApiKeyPrivilegeRequest(); // AddApiKeyPrivilegeRequest | addApiKeyPrivilegeRequest
try {
    apiInstance.addApiKeyPrivilege(key, addApiKeyPrivilegeRequest);
} catch (ApiException e) {
    System.err.println("Exception when calling ApiKeysApi#addApiKeyPrivilege");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
key	String	key
addApiKeyPrivilegeRequest	AddApiKeyPrivilegeRequest	addApiKeyPrivilegeRequest

Return type

null (empty response body)

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

addApiKeyPrivilegeForId4ns

addApiKeyPrivilegeForId4ns(key, privilege, id4ns)

Add ID4ns of a privilege

Example

// Import classes:
//import de.id4i.ApiClient;
//import de.id4i.ApiException;
//import de.id4i.Configuration;
//import de.id4i.auth.*;
//import de.id4i.api.ApiKeysApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");

ApiKeysApi apiInstance = new ApiKeysApi();
String key = "key_example"; // String | key
String privilege = "privilege_example"; // String | privilege
ListOfId4ns id4ns = new ListOfId4ns(); // ListOfId4ns | id4ns
try {
    apiInstance.addApiKeyPrivilegeForId4ns(key, privilege, id4ns);
} catch (ApiException e) {
    System.err.println("Exception when calling ApiKeysApi#addApiKeyPrivilegeForId4ns");
    e.printStackTrace();
}

Parameters

Name	Type	Description
key	String	key
privilege	String	privilege
id4ns	ListOfId4ns	id4ns

Return type

null (empty response body)

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

createNewApiKey

ApiKeyPresentation createNewApiKey(creationRequest)

Create API key

Creation of a new API key.

Example

// Import classes:
//import de.id4i.ApiClient;
//import de.id4i.ApiException;
//import de.id4i.Configuration;
//import de.id4i.auth.*;
//import de.id4i.api.ApiKeysApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");

ApiKeysApi apiInstance = new ApiKeysApi();
ApiKeyCreationRequest creationRequest = new ApiKeyCreationRequest(); // ApiKeyCreationRequest | API key to be created.
try {
    ApiKeyPresentation result = apiInstance.createNewApiKey(creationRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ApiKeysApi#createNewApiKey");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
creationRequest	ApiKeyCreationRequest	API key to be created.

Return type

ApiKeyPresentation

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

deleteApiKey

deleteApiKey(key)

Delete API key

Deletion of an API key.

Example

// Import classes:
//import de.id4i.ApiClient;
//import de.id4i.ApiException;
//import de.id4i.Configuration;
//import de.id4i.auth.*;
//import de.id4i.api.ApiKeysApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");

ApiKeysApi apiInstance = new ApiKeysApi();
String key = "key_example"; // String | The API key to delete.
try {
    apiInstance.deleteApiKey(key);
} catch (ApiException e) {
    System.err.println("Exception when calling ApiKeysApi#deleteApiKey");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
key	String	The API key to delete.

Return type

null (empty response body)

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

getApiKey

ApiKeyPresentation getApiKey(key)

Show API key

Showing the details of an API key.

Example

// Import classes:
//import de.id4i.ApiClient;
//import de.id4i.ApiException;
//import de.id4i.Configuration;
//import de.id4i.auth.*;
//import de.id4i.api.ApiKeysApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");

ApiKeysApi apiInstance = new ApiKeysApi();
String key = "key_example"; // String | The API key to show.
try {
    ApiKeyPresentation result = apiInstance.getApiKey(key);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ApiKeysApi#getApiKey");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
key	String	The API key to show.

Return type

ApiKeyPresentation

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

listAllApiKeyPrivileges

PaginatedResponseOfApiKeyPrivilegeInfo listAllApiKeyPrivileges(id4nConcerning, offset, limit)

List all privileges

Listing all possible API key privileges.

Example

// Import classes:
//import de.id4i.ApiClient;
//import de.id4i.ApiException;
//import de.id4i.Configuration;
//import de.id4i.auth.*;
//import de.id4i.api.ApiKeysApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");

ApiKeysApi apiInstance = new ApiKeysApi();
Boolean id4nConcerning = true; // Boolean | id4nConcerning
Integer offset = 56; // Integer | Start with the n-th element
Integer limit = 56; // Integer | The maximum count of returned elements
try {
    PaginatedResponseOfApiKeyPrivilegeInfo result = apiInstance.listAllApiKeyPrivileges(id4nConcerning, offset, limit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ApiKeysApi#listAllApiKeyPrivileges");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id4nConcerning	Boolean	id4nConcerning	[optional]
offset	Integer	Start with the n-th element	[optional]
limit	Integer	The maximum count of returned elements	[optional]

Return type

PaginatedResponseOfApiKeyPrivilegeInfo

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

listAllApiKeysOfOrganization

PaginatedResponseOfApiKeyPresentation listAllApiKeysOfOrganization(organizationId, offset, limit)

Find API key by organization

Finding all API key assigned to the specified organization in a paginated manner.

Example

// Import classes:
//import de.id4i.ApiClient;
//import de.id4i.ApiException;
//import de.id4i.Configuration;
//import de.id4i.auth.*;
//import de.id4i.api.ApiKeysApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");

ApiKeysApi apiInstance = new ApiKeysApi();
String organizationId = "organizationId_example"; // String | The namespace of the organization to search in.
Integer offset = 56; // Integer | Start with the n-th element
Integer limit = 56; // Integer | The maximum count of returned elements
try {
    PaginatedResponseOfApiKeyPresentation result = apiInstance.listAllApiKeysOfOrganization(organizationId, offset, limit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ApiKeysApi#listAllApiKeysOfOrganization");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
organizationId	String	The namespace of the organization to search in.	[optional]
offset	Integer	Start with the n-th element	[optional]
limit	Integer	The maximum count of returned elements	[optional]

Return type

PaginatedResponseOfApiKeyPresentation

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

listApiKeyPrivileges

PaginatedResponseOfApiKeyPrivilege listApiKeyPrivileges(key, offset, limit)

List privileges

Example

// Import classes:
//import de.id4i.ApiClient;
//import de.id4i.ApiException;
//import de.id4i.Configuration;
//import de.id4i.auth.*;
//import de.id4i.api.ApiKeysApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");

ApiKeysApi apiInstance = new ApiKeysApi();
String key = "key_example"; // String | key
Integer offset = 56; // Integer | Start with the n-th element
Integer limit = 56; // Integer | The maximum count of returned elements
try {
    PaginatedResponseOfApiKeyPrivilege result = apiInstance.listApiKeyPrivileges(key, offset, limit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ApiKeysApi#listApiKeyPrivileges");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
key	String	key
offset	Integer	Start with the n-th element	[optional]
limit	Integer	The maximum count of returned elements	[optional]

Return type

PaginatedResponseOfApiKeyPrivilege

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

listId4ns

PaginatedResponseOfId4nPresentation listId4ns(key, privilege, offset, limit)

ID4ns of a privilege

Listing ID4ns of a id4n concerning privilege

Example

// Import classes:
//import de.id4i.ApiClient;
//import de.id4i.ApiException;
//import de.id4i.Configuration;
//import de.id4i.auth.*;
//import de.id4i.api.ApiKeysApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");

ApiKeysApi apiInstance = new ApiKeysApi();
String key = "key_example"; // String | key
String privilege = "privilege_example"; // String | privilege
Integer offset = 56; // Integer | Start with the n-th element
Integer limit = 56; // Integer | The maximum count of returned elements
try {
    PaginatedResponseOfId4nPresentation result = apiInstance.listId4ns(key, privilege, offset, limit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ApiKeysApi#listId4ns");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
key	String	key
privilege	String	privilege
offset	Integer	Start with the n-th element	[optional]
limit	Integer	The maximum count of returned elements	[optional]

Return type

PaginatedResponseOfId4nPresentation

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

removeApiKeyPrivilege

removeApiKeyPrivilege(key, removeApiKeyPrivilegeRequest)

Remove privilege

Example

// Import classes:
//import de.id4i.ApiClient;
//import de.id4i.ApiException;
//import de.id4i.Configuration;
//import de.id4i.auth.*;
//import de.id4i.api.ApiKeysApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");

ApiKeysApi apiInstance = new ApiKeysApi();
String key = "key_example"; // String | key
RemoveApiKeyPrivilegeRequest removeApiKeyPrivilegeRequest = new RemoveApiKeyPrivilegeRequest(); // RemoveApiKeyPrivilegeRequest | removeApiKeyPrivilegeRequest
try {
    apiInstance.removeApiKeyPrivilege(key, removeApiKeyPrivilegeRequest);
} catch (ApiException e) {
    System.err.println("Exception when calling ApiKeysApi#removeApiKeyPrivilege");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
key	String	key
removeApiKeyPrivilegeRequest	RemoveApiKeyPrivilegeRequest	removeApiKeyPrivilegeRequest

Return type

null (empty response body)

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

removeApiKeyPrivilegeForId4ns

removeApiKeyPrivilegeForId4ns(key, privilege, id4ns)

Remove id4ns of a privilege

Example

// Import classes:
//import de.id4i.ApiClient;
//import de.id4i.ApiException;
//import de.id4i.Configuration;
//import de.id4i.auth.*;
//import de.id4i.api.ApiKeysApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");

ApiKeysApi apiInstance = new ApiKeysApi();
String key = "key_example"; // String | key
String privilege = "privilege_example"; // String | privilege
ListOfId4ns id4ns = new ListOfId4ns(); // ListOfId4ns | id4ns
try {
    apiInstance.removeApiKeyPrivilegeForId4ns(key, privilege, id4ns);
} catch (ApiException e) {
    System.err.println("Exception when calling ApiKeysApi#removeApiKeyPrivilegeForId4ns");
    e.printStackTrace();
}

Parameters

Name	Type	Description
key	String	key
privilege	String	privilege
id4ns	ListOfId4ns	id4ns

Return type

null (empty response body)

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

updateApiKey

updateApiKey(key, apiKeyChange)

Update API keys

API keys can be updated with new labels, and be activated and deactivated. The secret or UUID cannot be changed.

Example

// Import classes:
//import de.id4i.ApiClient;
//import de.id4i.ApiException;
//import de.id4i.Configuration;
//import de.id4i.auth.*;
//import de.id4i.api.ApiKeysApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");

ApiKeysApi apiInstance = new ApiKeysApi();
String key = "key_example"; // String | The API key to be updated.
ApiKeyChangeRequest apiKeyChange = new ApiKeyChangeRequest(); // ApiKeyChangeRequest | The new values to apply.
try {
    apiInstance.updateApiKey(key, apiKeyChange);
} catch (ApiException e) {
    System.err.println("Exception when calling ApiKeysApi#updateApiKey");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
key	String	The API key to be updated.
apiKeyChange	ApiKeyChangeRequest	The new values to apply.

FilesExpand file tree

ApiKeysApi.md

Latest commit

History

ApiKeysApi.md

File metadata and controls

ApiKeysApi

addApiKeyPrivilege

Example

Parameters

Return type

Authorization

HTTP request headers

addApiKeyPrivilegeForId4ns

Example

Parameters

Return type

Authorization

HTTP request headers

createNewApiKey

Example

Parameters

Return type

Authorization

HTTP request headers

deleteApiKey

Example

Parameters

Return type

Authorization

HTTP request headers

getApiKey

Example

Parameters

Return type

Authorization

HTTP request headers

listAllApiKeyPrivileges

Example

Parameters

Return type

Authorization

HTTP request headers

listAllApiKeysOfOrganization

Example

Parameters

Return type

Authorization

HTTP request headers

listApiKeyPrivileges

Example

Parameters

Return type

Authorization

HTTP request headers

listId4ns

Example

Parameters

Return type

Authorization

HTTP request headers

removeApiKeyPrivilege

Example

Parameters

Return type

Authorization

HTTP request headers

removeApiKeyPrivilegeForId4ns

Example

Parameters

Return type

Authorization

HTTP request headers

updateApiKey

Example

Parameters

Return type

Authorization

HTTP request headers