Skip to main content

PrincipalApi

valkyrai-api

All URIs are relative to http://localhost:8080/v1

MethodHTTP requestDescription
deletePrincipalDELETE PrincipalApiDelete a Principal.

deletePrincipal

Void
deletePrincipal(id)

Delete a Principal.

Deletes a specific Principal.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.PrincipalApi;


PrincipalApi apiInstance = new PrincipalApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Principal.

try {
Void result = apiInstance.deletePrincipal(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PrincipalApi#deletePrincipal");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
idUUIDUnique identifier for the Principal.

Return type

Void

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getPrincipal

Principal
getPrincipal(id)

Retrieve a single Principal

Retrieves a single Principal for a specific uid.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.PrincipalApi;


PrincipalApi apiInstance = new PrincipalApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Principal.

try {
Principal result = apiInstance.getPrincipal(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PrincipalApi#getPrincipal");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
idUUIDUnique identifier for the Principal.

Return type

Principal

Authorization

No authorization required

HTTP request headers

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

getPrincipalList

Principal
getPrincipalList()

Retrieve a list of Principals

Retrieves a list of Principals.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.PrincipalApi;


PrincipalApi apiInstance = new PrincipalApi();

try {
Principal result = apiInstance.getPrincipalList();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PrincipalApi#getPrincipalList");
e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

Principal

Authorization

No authorization required

HTTP request headers

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

postPrincipal

Principal
postPrincipal(principal)

Create a new Principal

Creates a new Principal.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.PrincipalApi;


PrincipalApi apiInstance = new PrincipalApi();
Principal principal = new Principal(); // Principal | Principal details.

try {
Principal result = apiInstance.postPrincipal(principal);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PrincipalApi#postPrincipal");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
principalPrincipalPrincipal details.

Return type

Principal

Authorization

No authorization required

HTTP request headers

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

updatePrincipal

Principal
updatePrincipal(idprincipal)

Update an existing Principal

Updates an existing Principal.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.PrincipalApi;


PrincipalApi apiInstance = new PrincipalApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Principal.
Principal principal = new Principal(); // Principal | Updated Principal details.

try {
Principal result = apiInstance.updatePrincipal(idprincipal);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PrincipalApi#updatePrincipal");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
idUUIDUnique identifier for the Principal.
principalPrincipalUpdated Principal details.

Return type

Principal

Authorization

No authorization required

HTTP request headers

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

Generated Version Details

~value
GENERATOR VERSIONcom.valkyrlabs:ValkyrAI API 1.0-SNAPSHOT
API ARTIFACTcom.valkyrlabs.valkyrai-api.jar
GENERATOR VERSIONorg.openapitools.openapi-generator:7.5.0
GENERATOR CLASSorg.openapitools.codegen.languages.SpringCodegen
GENERATED DATE2025-04-09T20:27:13.881184-07:00[America/Los_Angeles]