RoleApi
valkyrai-api
All URIs are relative to http://localhost:8080/v1
Method | HTTP request | Description |
---|---|---|
deleteRole | DELETE RoleApi | Delete a Role. |
deleteRole
Void
deleteRole(id)
Delete a Role.
Deletes a specific Role.
Example
Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.RoleApi;
RoleApi apiInstance = new RoleApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Role.
try {
Void result = apiInstance.deleteRole(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RoleApi#deleteRole");
e.printStackTrace();
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | Unique identifier for the Role. |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
getRole
Role
getRole(id)
Retrieve a single Role
Retrieves a single Role for a specific uid.
Example
Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.RoleApi;
RoleApi apiInstance = new RoleApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Role.
try {
Role result = apiInstance.getRole(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RoleApi#getRole");
e.printStackTrace();
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | Unique identifier for the Role. |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
getRoleList
Role
getRoleList()
Retrieve a list of Roles
Retrieves a list of Roles.
Example
Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.RoleApi;
RoleApi apiInstance = new RoleApi();
try {
Role result = apiInstance.getRoleList();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RoleApi#getRoleList");
e.printStackTrace();
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
postRole
Role
postRole(role)
Create a new Role
Creates a new Role.
Example
Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.RoleApi;
RoleApi apiInstance = new RoleApi();
Role role = new Role(); // Role | Role details.
try {
Role result = apiInstance.postRole(role);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RoleApi#postRole");
e.printStackTrace();
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
role | Role | Role details. |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
updateRole
Role
updateRole(idrole)
Update an existing Role
Updates an existing Role.
Example
Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.RoleApi;
RoleApi apiInstance = new RoleApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Role.
Role role = new Role(); // Role | Updated Role details.
try {
Role result = apiInstance.updateRole(idrole);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RoleApi#updateRole");
e.printStackTrace();
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | Unique identifier for the Role. | |
role | Role | Updated Role details. |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Generated Version Details
~ | value |
---|---|
GENERATOR VERSION | com.valkyrlabs:ValkyrAI API 1.0-SNAPSHOT |
API ARTIFACT | com.valkyrlabs.valkyrai-api.jar |
GENERATOR VERSION | org.openapitools.openapi-generator:7.5.0 |
GENERATOR CLASS | org.openapitools.codegen.languages.SpringCodegen |
GENERATED DATE | 2025-04-09T20:27:13.881184-07:00[America/Los_Angeles] |