@goauthentik/api 2026.2.0-rc1-1769128766 → 2026.2.0-rc1-1769200848
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +8 -0
- package/dist/apis/EndpointsApi.d.ts +84 -1
- package/dist/apis/EndpointsApi.d.ts.map +1 -1
- package/dist/apis/EndpointsApi.js +249 -0
- package/dist/apis/EndpointsApi.js.map +1 -1
- package/dist/apis/RbacApi.d.ts +1 -0
- package/dist/apis/RbacApi.d.ts.map +1 -1
- package/dist/apis/RbacApi.js +1 -0
- package/dist/apis/RbacApi.js.map +1 -1
- package/dist/esm/apis/EndpointsApi.d.ts +84 -1
- package/dist/esm/apis/EndpointsApi.d.ts.map +1 -1
- package/dist/esm/apis/EndpointsApi.js +249 -0
- package/dist/esm/apis/EndpointsApi.js.map +1 -1
- package/dist/esm/apis/RbacApi.d.ts +1 -0
- package/dist/esm/apis/RbacApi.d.ts.map +1 -1
- package/dist/esm/apis/RbacApi.js +1 -0
- package/dist/esm/apis/RbacApi.js.map +1 -1
- package/dist/esm/models/AppEnum.d.ts +1 -0
- package/dist/esm/models/AppEnum.d.ts.map +1 -1
- package/dist/esm/models/AppEnum.js +1 -0
- package/dist/esm/models/AppEnum.js.map +1 -1
- package/dist/esm/models/DeviceAccessGroup.d.ts +8 -0
- package/dist/esm/models/DeviceAccessGroup.d.ts.map +1 -1
- package/dist/esm/models/DeviceAccessGroup.js +2 -0
- package/dist/esm/models/DeviceAccessGroup.js.map +1 -1
- package/dist/esm/models/DeviceAccessGroupRequest.d.ts +8 -0
- package/dist/esm/models/DeviceAccessGroupRequest.d.ts.map +1 -1
- package/dist/esm/models/DeviceAccessGroupRequest.js +2 -0
- package/dist/esm/models/DeviceAccessGroupRequest.js.map +1 -1
- package/dist/esm/models/FleetConnector.d.ts +93 -0
- package/dist/esm/models/FleetConnector.d.ts.map +1 -0
- package/dist/esm/models/FleetConnector.js +77 -0
- package/dist/esm/models/FleetConnector.js.map +1 -0
- package/dist/esm/models/FleetConnectorRequest.d.ts +75 -0
- package/dist/esm/models/FleetConnectorRequest.d.ts.map +1 -0
- package/dist/esm/models/FleetConnectorRequest.js +69 -0
- package/dist/esm/models/FleetConnectorRequest.js.map +1 -0
- package/dist/esm/models/ModelEnum.d.ts +1 -0
- package/dist/esm/models/ModelEnum.d.ts.map +1 -1
- package/dist/esm/models/ModelEnum.js +1 -0
- package/dist/esm/models/ModelEnum.js.map +1 -1
- package/dist/esm/models/OperatingSystem.d.ts +7 -3
- package/dist/esm/models/OperatingSystem.d.ts.map +1 -1
- package/dist/esm/models/OperatingSystem.js.map +1 -1
- package/dist/esm/models/OperatingSystemRequest.d.ts +7 -3
- package/dist/esm/models/OperatingSystemRequest.d.ts.map +1 -1
- package/dist/esm/models/OperatingSystemRequest.js.map +1 -1
- package/dist/esm/models/PaginatedFleetConnectorList.d.ts +49 -0
- package/dist/esm/models/PaginatedFleetConnectorList.d.ts.map +1 -0
- package/dist/esm/models/PaginatedFleetConnectorList.js +61 -0
- package/dist/esm/models/PaginatedFleetConnectorList.js.map +1 -0
- package/dist/esm/models/PatchedDeviceAccessGroupRequest.d.ts +8 -0
- package/dist/esm/models/PatchedDeviceAccessGroupRequest.d.ts.map +1 -1
- package/dist/esm/models/PatchedDeviceAccessGroupRequest.js +2 -0
- package/dist/esm/models/PatchedDeviceAccessGroupRequest.js.map +1 -1
- package/dist/esm/models/PatchedFleetConnectorRequest.d.ts +75 -0
- package/dist/esm/models/PatchedFleetConnectorRequest.d.ts.map +1 -0
- package/dist/esm/models/PatchedFleetConnectorRequest.js +63 -0
- package/dist/esm/models/PatchedFleetConnectorRequest.js.map +1 -0
- package/dist/esm/models/VendorEnum.d.ts +1 -0
- package/dist/esm/models/VendorEnum.d.ts.map +1 -1
- package/dist/esm/models/VendorEnum.js +1 -0
- package/dist/esm/models/VendorEnum.js.map +1 -1
- package/dist/esm/models/index.d.ts +4 -0
- package/dist/esm/models/index.d.ts.map +1 -1
- package/dist/esm/models/index.js +4 -0
- package/dist/esm/models/index.js.map +1 -1
- package/dist/models/AppEnum.d.ts +1 -0
- package/dist/models/AppEnum.d.ts.map +1 -1
- package/dist/models/AppEnum.js +1 -0
- package/dist/models/AppEnum.js.map +1 -1
- package/dist/models/DeviceAccessGroup.d.ts +8 -0
- package/dist/models/DeviceAccessGroup.d.ts.map +1 -1
- package/dist/models/DeviceAccessGroup.js +2 -0
- package/dist/models/DeviceAccessGroup.js.map +1 -1
- package/dist/models/DeviceAccessGroupRequest.d.ts +8 -0
- package/dist/models/DeviceAccessGroupRequest.d.ts.map +1 -1
- package/dist/models/DeviceAccessGroupRequest.js +2 -0
- package/dist/models/DeviceAccessGroupRequest.js.map +1 -1
- package/dist/models/FleetConnector.d.ts +93 -0
- package/dist/models/FleetConnector.d.ts.map +1 -0
- package/dist/models/FleetConnector.js +77 -0
- package/dist/models/FleetConnector.js.map +1 -0
- package/dist/models/FleetConnectorRequest.d.ts +75 -0
- package/dist/models/FleetConnectorRequest.d.ts.map +1 -0
- package/dist/models/FleetConnectorRequest.js +69 -0
- package/dist/models/FleetConnectorRequest.js.map +1 -0
- package/dist/models/ModelEnum.d.ts +1 -0
- package/dist/models/ModelEnum.d.ts.map +1 -1
- package/dist/models/ModelEnum.js +1 -0
- package/dist/models/ModelEnum.js.map +1 -1
- package/dist/models/OperatingSystem.d.ts +7 -3
- package/dist/models/OperatingSystem.d.ts.map +1 -1
- package/dist/models/OperatingSystem.js.map +1 -1
- package/dist/models/OperatingSystemRequest.d.ts +7 -3
- package/dist/models/OperatingSystemRequest.d.ts.map +1 -1
- package/dist/models/OperatingSystemRequest.js.map +1 -1
- package/dist/models/PaginatedFleetConnectorList.d.ts +49 -0
- package/dist/models/PaginatedFleetConnectorList.d.ts.map +1 -0
- package/dist/models/PaginatedFleetConnectorList.js +61 -0
- package/dist/models/PaginatedFleetConnectorList.js.map +1 -0
- package/dist/models/PatchedDeviceAccessGroupRequest.d.ts +8 -0
- package/dist/models/PatchedDeviceAccessGroupRequest.d.ts.map +1 -1
- package/dist/models/PatchedDeviceAccessGroupRequest.js +2 -0
- package/dist/models/PatchedDeviceAccessGroupRequest.js.map +1 -1
- package/dist/models/PatchedFleetConnectorRequest.d.ts +75 -0
- package/dist/models/PatchedFleetConnectorRequest.d.ts.map +1 -0
- package/dist/models/PatchedFleetConnectorRequest.js +63 -0
- package/dist/models/PatchedFleetConnectorRequest.js.map +1 -0
- package/dist/models/VendorEnum.d.ts +1 -0
- package/dist/models/VendorEnum.d.ts.map +1 -1
- package/dist/models/VendorEnum.js +1 -0
- package/dist/models/VendorEnum.js.map +1 -1
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.d.ts.map +1 -1
- package/dist/models/index.js +4 -0
- package/dist/models/index.js.map +1 -1
- package/dist/tsconfig.esm.tsbuildinfo +1 -1
- package/docs/DeviceAccessGroup.md +2 -0
- package/docs/DeviceAccessGroupRequest.md +2 -0
- package/docs/EndpointsApi.md +536 -0
- package/docs/FleetConnector.md +55 -0
- package/docs/FleetConnectorRequest.md +49 -0
- package/docs/OperatingSystem.md +1 -0
- package/docs/OperatingSystemRequest.md +1 -0
- package/docs/PaginatedFleetConnectorList.md +38 -0
- package/docs/PatchedDeviceAccessGroupRequest.md +2 -0
- package/docs/PatchedFleetConnectorRequest.md +49 -0
- package/docs/RbacApi.md +2 -2
- package/package.json +1 -1
- package/src/apis/EndpointsApi.ts +387 -0
- package/src/apis/RbacApi.ts +1 -0
- package/src/models/AppEnum.ts +1 -0
- package/src/models/DeviceAccessGroup.ts +8 -0
- package/src/models/DeviceAccessGroupRequest.ts +8 -0
- package/src/models/FleetConnector.ts +147 -0
- package/src/models/FleetConnectorRequest.ts +124 -0
- package/src/models/ModelEnum.ts +1 -0
- package/src/models/OperatingSystem.ts +7 -3
- package/src/models/OperatingSystemRequest.ts +7 -3
- package/src/models/PaginatedFleetConnectorList.ts +99 -0
- package/src/models/PatchedDeviceAccessGroupRequest.ts +8 -0
- package/src/models/PatchedFleetConnectorRequest.ts +121 -0
- package/src/models/VendorEnum.ts +1 -0
- package/src/models/index.ts +4 -0
- package/tsconfig.tsbuildinfo +1 -1
|
@@ -8,6 +8,7 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`pbmUuid` | string
|
|
10
10
|
`name` | string
|
|
11
|
+
`attributes` | { [key: string]: any; }
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ import type { DeviceAccessGroup } from '@goauthentik/api'
|
|
|
18
19
|
const example = {
|
|
19
20
|
"pbmUuid": null,
|
|
20
21
|
"name": null,
|
|
22
|
+
"attributes": null,
|
|
21
23
|
} satisfies DeviceAccessGroup
|
|
22
24
|
|
|
23
25
|
console.log(example)
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`name` | string
|
|
10
|
+
`attributes` | { [key: string]: any; }
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -16,6 +17,7 @@ import type { DeviceAccessGroupRequest } from '@goauthentik/api'
|
|
|
16
17
|
// TODO: Update the object below with actual values
|
|
17
18
|
const example = {
|
|
18
19
|
"name": null,
|
|
20
|
+
"attributes": null,
|
|
19
21
|
} satisfies DeviceAccessGroupRequest
|
|
20
22
|
|
|
21
23
|
console.log(example)
|
package/docs/EndpointsApi.md
CHANGED
|
@@ -53,6 +53,13 @@ All URIs are relative to */api/v3*
|
|
|
53
53
|
| [**endpointsDevicesSummaryRetrieve**](EndpointsApi.md#endpointsdevicessummaryretrieve) | **GET** /endpoints/devices/summary/ | |
|
|
54
54
|
| [**endpointsDevicesUpdate**](EndpointsApi.md#endpointsdevicesupdate) | **PUT** /endpoints/devices/{device_uuid}/ | |
|
|
55
55
|
| [**endpointsDevicesUsedByList**](EndpointsApi.md#endpointsdevicesusedbylist) | **GET** /endpoints/devices/{device_uuid}/used_by/ | |
|
|
56
|
+
| [**endpointsFleetConnectorsCreate**](EndpointsApi.md#endpointsfleetconnectorscreate) | **POST** /endpoints/fleet/connectors/ | |
|
|
57
|
+
| [**endpointsFleetConnectorsDestroy**](EndpointsApi.md#endpointsfleetconnectorsdestroy) | **DELETE** /endpoints/fleet/connectors/{connector_uuid}/ | |
|
|
58
|
+
| [**endpointsFleetConnectorsList**](EndpointsApi.md#endpointsfleetconnectorslist) | **GET** /endpoints/fleet/connectors/ | |
|
|
59
|
+
| [**endpointsFleetConnectorsPartialUpdate**](EndpointsApi.md#endpointsfleetconnectorspartialupdate) | **PATCH** /endpoints/fleet/connectors/{connector_uuid}/ | |
|
|
60
|
+
| [**endpointsFleetConnectorsRetrieve**](EndpointsApi.md#endpointsfleetconnectorsretrieve) | **GET** /endpoints/fleet/connectors/{connector_uuid}/ | |
|
|
61
|
+
| [**endpointsFleetConnectorsUpdate**](EndpointsApi.md#endpointsfleetconnectorsupdate) | **PUT** /endpoints/fleet/connectors/{connector_uuid}/ | |
|
|
62
|
+
| [**endpointsFleetConnectorsUsedByList**](EndpointsApi.md#endpointsfleetconnectorsusedbylist) | **GET** /endpoints/fleet/connectors/{connector_uuid}/used_by/ | |
|
|
56
63
|
|
|
57
64
|
|
|
58
65
|
|
|
@@ -3702,3 +3709,532 @@ example().catch(console.error);
|
|
|
3702
3709
|
|
|
3703
3710
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3704
3711
|
|
|
3712
|
+
|
|
3713
|
+
## endpointsFleetConnectorsCreate
|
|
3714
|
+
|
|
3715
|
+
> FleetConnector endpointsFleetConnectorsCreate(fleetConnectorRequest)
|
|
3716
|
+
|
|
3717
|
+
|
|
3718
|
+
|
|
3719
|
+
FleetConnector Viewset
|
|
3720
|
+
|
|
3721
|
+
### Example
|
|
3722
|
+
|
|
3723
|
+
```ts
|
|
3724
|
+
import {
|
|
3725
|
+
Configuration,
|
|
3726
|
+
EndpointsApi,
|
|
3727
|
+
} from '@goauthentik/api';
|
|
3728
|
+
import type { EndpointsFleetConnectorsCreateRequest } from '@goauthentik/api';
|
|
3729
|
+
|
|
3730
|
+
async function example() {
|
|
3731
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
3732
|
+
const config = new Configuration({
|
|
3733
|
+
// Configure HTTP bearer authorization: authentik
|
|
3734
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
3735
|
+
});
|
|
3736
|
+
const api = new EndpointsApi(config);
|
|
3737
|
+
|
|
3738
|
+
const body = {
|
|
3739
|
+
// FleetConnectorRequest
|
|
3740
|
+
fleetConnectorRequest: ...,
|
|
3741
|
+
} satisfies EndpointsFleetConnectorsCreateRequest;
|
|
3742
|
+
|
|
3743
|
+
try {
|
|
3744
|
+
const data = await api.endpointsFleetConnectorsCreate(body);
|
|
3745
|
+
console.log(data);
|
|
3746
|
+
} catch (error) {
|
|
3747
|
+
console.error(error);
|
|
3748
|
+
}
|
|
3749
|
+
}
|
|
3750
|
+
|
|
3751
|
+
// Run the test
|
|
3752
|
+
example().catch(console.error);
|
|
3753
|
+
```
|
|
3754
|
+
|
|
3755
|
+
### Parameters
|
|
3756
|
+
|
|
3757
|
+
|
|
3758
|
+
| Name | Type | Description | Notes |
|
|
3759
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3760
|
+
| **fleetConnectorRequest** | [FleetConnectorRequest](FleetConnectorRequest.md) | | |
|
|
3761
|
+
|
|
3762
|
+
### Return type
|
|
3763
|
+
|
|
3764
|
+
[**FleetConnector**](FleetConnector.md)
|
|
3765
|
+
|
|
3766
|
+
### Authorization
|
|
3767
|
+
|
|
3768
|
+
[authentik](../README.md#authentik)
|
|
3769
|
+
|
|
3770
|
+
### HTTP request headers
|
|
3771
|
+
|
|
3772
|
+
- **Content-Type**: `application/json`
|
|
3773
|
+
- **Accept**: `application/json`
|
|
3774
|
+
|
|
3775
|
+
|
|
3776
|
+
### HTTP response details
|
|
3777
|
+
| Status code | Description | Response headers |
|
|
3778
|
+
|-------------|-------------|------------------|
|
|
3779
|
+
| **201** | | - |
|
|
3780
|
+
| **400** | | - |
|
|
3781
|
+
| **403** | | - |
|
|
3782
|
+
|
|
3783
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3784
|
+
|
|
3785
|
+
|
|
3786
|
+
## endpointsFleetConnectorsDestroy
|
|
3787
|
+
|
|
3788
|
+
> endpointsFleetConnectorsDestroy(connectorUuid)
|
|
3789
|
+
|
|
3790
|
+
|
|
3791
|
+
|
|
3792
|
+
FleetConnector Viewset
|
|
3793
|
+
|
|
3794
|
+
### Example
|
|
3795
|
+
|
|
3796
|
+
```ts
|
|
3797
|
+
import {
|
|
3798
|
+
Configuration,
|
|
3799
|
+
EndpointsApi,
|
|
3800
|
+
} from '@goauthentik/api';
|
|
3801
|
+
import type { EndpointsFleetConnectorsDestroyRequest } from '@goauthentik/api';
|
|
3802
|
+
|
|
3803
|
+
async function example() {
|
|
3804
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
3805
|
+
const config = new Configuration({
|
|
3806
|
+
// Configure HTTP bearer authorization: authentik
|
|
3807
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
3808
|
+
});
|
|
3809
|
+
const api = new EndpointsApi(config);
|
|
3810
|
+
|
|
3811
|
+
const body = {
|
|
3812
|
+
// string | A UUID string identifying this Fleet Connector.
|
|
3813
|
+
connectorUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
3814
|
+
} satisfies EndpointsFleetConnectorsDestroyRequest;
|
|
3815
|
+
|
|
3816
|
+
try {
|
|
3817
|
+
const data = await api.endpointsFleetConnectorsDestroy(body);
|
|
3818
|
+
console.log(data);
|
|
3819
|
+
} catch (error) {
|
|
3820
|
+
console.error(error);
|
|
3821
|
+
}
|
|
3822
|
+
}
|
|
3823
|
+
|
|
3824
|
+
// Run the test
|
|
3825
|
+
example().catch(console.error);
|
|
3826
|
+
```
|
|
3827
|
+
|
|
3828
|
+
### Parameters
|
|
3829
|
+
|
|
3830
|
+
|
|
3831
|
+
| Name | Type | Description | Notes |
|
|
3832
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3833
|
+
| **connectorUuid** | `string` | A UUID string identifying this Fleet Connector. | [Defaults to `undefined`] |
|
|
3834
|
+
|
|
3835
|
+
### Return type
|
|
3836
|
+
|
|
3837
|
+
`void` (Empty response body)
|
|
3838
|
+
|
|
3839
|
+
### Authorization
|
|
3840
|
+
|
|
3841
|
+
[authentik](../README.md#authentik)
|
|
3842
|
+
|
|
3843
|
+
### HTTP request headers
|
|
3844
|
+
|
|
3845
|
+
- **Content-Type**: Not defined
|
|
3846
|
+
- **Accept**: `application/json`
|
|
3847
|
+
|
|
3848
|
+
|
|
3849
|
+
### HTTP response details
|
|
3850
|
+
| Status code | Description | Response headers |
|
|
3851
|
+
|-------------|-------------|------------------|
|
|
3852
|
+
| **204** | No response body | - |
|
|
3853
|
+
| **400** | | - |
|
|
3854
|
+
| **403** | | - |
|
|
3855
|
+
|
|
3856
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3857
|
+
|
|
3858
|
+
|
|
3859
|
+
## endpointsFleetConnectorsList
|
|
3860
|
+
|
|
3861
|
+
> PaginatedFleetConnectorList endpointsFleetConnectorsList(name, ordering, page, pageSize, search)
|
|
3862
|
+
|
|
3863
|
+
|
|
3864
|
+
|
|
3865
|
+
FleetConnector Viewset
|
|
3866
|
+
|
|
3867
|
+
### Example
|
|
3868
|
+
|
|
3869
|
+
```ts
|
|
3870
|
+
import {
|
|
3871
|
+
Configuration,
|
|
3872
|
+
EndpointsApi,
|
|
3873
|
+
} from '@goauthentik/api';
|
|
3874
|
+
import type { EndpointsFleetConnectorsListRequest } from '@goauthentik/api';
|
|
3875
|
+
|
|
3876
|
+
async function example() {
|
|
3877
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
3878
|
+
const config = new Configuration({
|
|
3879
|
+
// Configure HTTP bearer authorization: authentik
|
|
3880
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
3881
|
+
});
|
|
3882
|
+
const api = new EndpointsApi(config);
|
|
3883
|
+
|
|
3884
|
+
const body = {
|
|
3885
|
+
// string (optional)
|
|
3886
|
+
name: name_example,
|
|
3887
|
+
// string | Which field to use when ordering the results. (optional)
|
|
3888
|
+
ordering: ordering_example,
|
|
3889
|
+
// number | A page number within the paginated result set. (optional)
|
|
3890
|
+
page: 56,
|
|
3891
|
+
// number | Number of results to return per page. (optional)
|
|
3892
|
+
pageSize: 56,
|
|
3893
|
+
// string | A search term. (optional)
|
|
3894
|
+
search: search_example,
|
|
3895
|
+
} satisfies EndpointsFleetConnectorsListRequest;
|
|
3896
|
+
|
|
3897
|
+
try {
|
|
3898
|
+
const data = await api.endpointsFleetConnectorsList(body);
|
|
3899
|
+
console.log(data);
|
|
3900
|
+
} catch (error) {
|
|
3901
|
+
console.error(error);
|
|
3902
|
+
}
|
|
3903
|
+
}
|
|
3904
|
+
|
|
3905
|
+
// Run the test
|
|
3906
|
+
example().catch(console.error);
|
|
3907
|
+
```
|
|
3908
|
+
|
|
3909
|
+
### Parameters
|
|
3910
|
+
|
|
3911
|
+
|
|
3912
|
+
| Name | Type | Description | Notes |
|
|
3913
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3914
|
+
| **name** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
3915
|
+
| **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
|
|
3916
|
+
| **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
|
|
3917
|
+
| **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
|
|
3918
|
+
| **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
|
|
3919
|
+
|
|
3920
|
+
### Return type
|
|
3921
|
+
|
|
3922
|
+
[**PaginatedFleetConnectorList**](PaginatedFleetConnectorList.md)
|
|
3923
|
+
|
|
3924
|
+
### Authorization
|
|
3925
|
+
|
|
3926
|
+
[authentik](../README.md#authentik)
|
|
3927
|
+
|
|
3928
|
+
### HTTP request headers
|
|
3929
|
+
|
|
3930
|
+
- **Content-Type**: Not defined
|
|
3931
|
+
- **Accept**: `application/json`
|
|
3932
|
+
|
|
3933
|
+
|
|
3934
|
+
### HTTP response details
|
|
3935
|
+
| Status code | Description | Response headers |
|
|
3936
|
+
|-------------|-------------|------------------|
|
|
3937
|
+
| **200** | | - |
|
|
3938
|
+
| **400** | | - |
|
|
3939
|
+
| **403** | | - |
|
|
3940
|
+
|
|
3941
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3942
|
+
|
|
3943
|
+
|
|
3944
|
+
## endpointsFleetConnectorsPartialUpdate
|
|
3945
|
+
|
|
3946
|
+
> FleetConnector endpointsFleetConnectorsPartialUpdate(connectorUuid, patchedFleetConnectorRequest)
|
|
3947
|
+
|
|
3948
|
+
|
|
3949
|
+
|
|
3950
|
+
FleetConnector Viewset
|
|
3951
|
+
|
|
3952
|
+
### Example
|
|
3953
|
+
|
|
3954
|
+
```ts
|
|
3955
|
+
import {
|
|
3956
|
+
Configuration,
|
|
3957
|
+
EndpointsApi,
|
|
3958
|
+
} from '@goauthentik/api';
|
|
3959
|
+
import type { EndpointsFleetConnectorsPartialUpdateRequest } from '@goauthentik/api';
|
|
3960
|
+
|
|
3961
|
+
async function example() {
|
|
3962
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
3963
|
+
const config = new Configuration({
|
|
3964
|
+
// Configure HTTP bearer authorization: authentik
|
|
3965
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
3966
|
+
});
|
|
3967
|
+
const api = new EndpointsApi(config);
|
|
3968
|
+
|
|
3969
|
+
const body = {
|
|
3970
|
+
// string | A UUID string identifying this Fleet Connector.
|
|
3971
|
+
connectorUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
3972
|
+
// PatchedFleetConnectorRequest (optional)
|
|
3973
|
+
patchedFleetConnectorRequest: ...,
|
|
3974
|
+
} satisfies EndpointsFleetConnectorsPartialUpdateRequest;
|
|
3975
|
+
|
|
3976
|
+
try {
|
|
3977
|
+
const data = await api.endpointsFleetConnectorsPartialUpdate(body);
|
|
3978
|
+
console.log(data);
|
|
3979
|
+
} catch (error) {
|
|
3980
|
+
console.error(error);
|
|
3981
|
+
}
|
|
3982
|
+
}
|
|
3983
|
+
|
|
3984
|
+
// Run the test
|
|
3985
|
+
example().catch(console.error);
|
|
3986
|
+
```
|
|
3987
|
+
|
|
3988
|
+
### Parameters
|
|
3989
|
+
|
|
3990
|
+
|
|
3991
|
+
| Name | Type | Description | Notes |
|
|
3992
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3993
|
+
| **connectorUuid** | `string` | A UUID string identifying this Fleet Connector. | [Defaults to `undefined`] |
|
|
3994
|
+
| **patchedFleetConnectorRequest** | [PatchedFleetConnectorRequest](PatchedFleetConnectorRequest.md) | | [Optional] |
|
|
3995
|
+
|
|
3996
|
+
### Return type
|
|
3997
|
+
|
|
3998
|
+
[**FleetConnector**](FleetConnector.md)
|
|
3999
|
+
|
|
4000
|
+
### Authorization
|
|
4001
|
+
|
|
4002
|
+
[authentik](../README.md#authentik)
|
|
4003
|
+
|
|
4004
|
+
### HTTP request headers
|
|
4005
|
+
|
|
4006
|
+
- **Content-Type**: `application/json`
|
|
4007
|
+
- **Accept**: `application/json`
|
|
4008
|
+
|
|
4009
|
+
|
|
4010
|
+
### HTTP response details
|
|
4011
|
+
| Status code | Description | Response headers |
|
|
4012
|
+
|-------------|-------------|------------------|
|
|
4013
|
+
| **200** | | - |
|
|
4014
|
+
| **400** | | - |
|
|
4015
|
+
| **403** | | - |
|
|
4016
|
+
|
|
4017
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
4018
|
+
|
|
4019
|
+
|
|
4020
|
+
## endpointsFleetConnectorsRetrieve
|
|
4021
|
+
|
|
4022
|
+
> FleetConnector endpointsFleetConnectorsRetrieve(connectorUuid)
|
|
4023
|
+
|
|
4024
|
+
|
|
4025
|
+
|
|
4026
|
+
FleetConnector Viewset
|
|
4027
|
+
|
|
4028
|
+
### Example
|
|
4029
|
+
|
|
4030
|
+
```ts
|
|
4031
|
+
import {
|
|
4032
|
+
Configuration,
|
|
4033
|
+
EndpointsApi,
|
|
4034
|
+
} from '@goauthentik/api';
|
|
4035
|
+
import type { EndpointsFleetConnectorsRetrieveRequest } from '@goauthentik/api';
|
|
4036
|
+
|
|
4037
|
+
async function example() {
|
|
4038
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
4039
|
+
const config = new Configuration({
|
|
4040
|
+
// Configure HTTP bearer authorization: authentik
|
|
4041
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
4042
|
+
});
|
|
4043
|
+
const api = new EndpointsApi(config);
|
|
4044
|
+
|
|
4045
|
+
const body = {
|
|
4046
|
+
// string | A UUID string identifying this Fleet Connector.
|
|
4047
|
+
connectorUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
4048
|
+
} satisfies EndpointsFleetConnectorsRetrieveRequest;
|
|
4049
|
+
|
|
4050
|
+
try {
|
|
4051
|
+
const data = await api.endpointsFleetConnectorsRetrieve(body);
|
|
4052
|
+
console.log(data);
|
|
4053
|
+
} catch (error) {
|
|
4054
|
+
console.error(error);
|
|
4055
|
+
}
|
|
4056
|
+
}
|
|
4057
|
+
|
|
4058
|
+
// Run the test
|
|
4059
|
+
example().catch(console.error);
|
|
4060
|
+
```
|
|
4061
|
+
|
|
4062
|
+
### Parameters
|
|
4063
|
+
|
|
4064
|
+
|
|
4065
|
+
| Name | Type | Description | Notes |
|
|
4066
|
+
|------------- | ------------- | ------------- | -------------|
|
|
4067
|
+
| **connectorUuid** | `string` | A UUID string identifying this Fleet Connector. | [Defaults to `undefined`] |
|
|
4068
|
+
|
|
4069
|
+
### Return type
|
|
4070
|
+
|
|
4071
|
+
[**FleetConnector**](FleetConnector.md)
|
|
4072
|
+
|
|
4073
|
+
### Authorization
|
|
4074
|
+
|
|
4075
|
+
[authentik](../README.md#authentik)
|
|
4076
|
+
|
|
4077
|
+
### HTTP request headers
|
|
4078
|
+
|
|
4079
|
+
- **Content-Type**: Not defined
|
|
4080
|
+
- **Accept**: `application/json`
|
|
4081
|
+
|
|
4082
|
+
|
|
4083
|
+
### HTTP response details
|
|
4084
|
+
| Status code | Description | Response headers |
|
|
4085
|
+
|-------------|-------------|------------------|
|
|
4086
|
+
| **200** | | - |
|
|
4087
|
+
| **400** | | - |
|
|
4088
|
+
| **403** | | - |
|
|
4089
|
+
|
|
4090
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
4091
|
+
|
|
4092
|
+
|
|
4093
|
+
## endpointsFleetConnectorsUpdate
|
|
4094
|
+
|
|
4095
|
+
> FleetConnector endpointsFleetConnectorsUpdate(connectorUuid, fleetConnectorRequest)
|
|
4096
|
+
|
|
4097
|
+
|
|
4098
|
+
|
|
4099
|
+
FleetConnector Viewset
|
|
4100
|
+
|
|
4101
|
+
### Example
|
|
4102
|
+
|
|
4103
|
+
```ts
|
|
4104
|
+
import {
|
|
4105
|
+
Configuration,
|
|
4106
|
+
EndpointsApi,
|
|
4107
|
+
} from '@goauthentik/api';
|
|
4108
|
+
import type { EndpointsFleetConnectorsUpdateRequest } from '@goauthentik/api';
|
|
4109
|
+
|
|
4110
|
+
async function example() {
|
|
4111
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
4112
|
+
const config = new Configuration({
|
|
4113
|
+
// Configure HTTP bearer authorization: authentik
|
|
4114
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
4115
|
+
});
|
|
4116
|
+
const api = new EndpointsApi(config);
|
|
4117
|
+
|
|
4118
|
+
const body = {
|
|
4119
|
+
// string | A UUID string identifying this Fleet Connector.
|
|
4120
|
+
connectorUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
4121
|
+
// FleetConnectorRequest
|
|
4122
|
+
fleetConnectorRequest: ...,
|
|
4123
|
+
} satisfies EndpointsFleetConnectorsUpdateRequest;
|
|
4124
|
+
|
|
4125
|
+
try {
|
|
4126
|
+
const data = await api.endpointsFleetConnectorsUpdate(body);
|
|
4127
|
+
console.log(data);
|
|
4128
|
+
} catch (error) {
|
|
4129
|
+
console.error(error);
|
|
4130
|
+
}
|
|
4131
|
+
}
|
|
4132
|
+
|
|
4133
|
+
// Run the test
|
|
4134
|
+
example().catch(console.error);
|
|
4135
|
+
```
|
|
4136
|
+
|
|
4137
|
+
### Parameters
|
|
4138
|
+
|
|
4139
|
+
|
|
4140
|
+
| Name | Type | Description | Notes |
|
|
4141
|
+
|------------- | ------------- | ------------- | -------------|
|
|
4142
|
+
| **connectorUuid** | `string` | A UUID string identifying this Fleet Connector. | [Defaults to `undefined`] |
|
|
4143
|
+
| **fleetConnectorRequest** | [FleetConnectorRequest](FleetConnectorRequest.md) | | |
|
|
4144
|
+
|
|
4145
|
+
### Return type
|
|
4146
|
+
|
|
4147
|
+
[**FleetConnector**](FleetConnector.md)
|
|
4148
|
+
|
|
4149
|
+
### Authorization
|
|
4150
|
+
|
|
4151
|
+
[authentik](../README.md#authentik)
|
|
4152
|
+
|
|
4153
|
+
### HTTP request headers
|
|
4154
|
+
|
|
4155
|
+
- **Content-Type**: `application/json`
|
|
4156
|
+
- **Accept**: `application/json`
|
|
4157
|
+
|
|
4158
|
+
|
|
4159
|
+
### HTTP response details
|
|
4160
|
+
| Status code | Description | Response headers |
|
|
4161
|
+
|-------------|-------------|------------------|
|
|
4162
|
+
| **200** | | - |
|
|
4163
|
+
| **400** | | - |
|
|
4164
|
+
| **403** | | - |
|
|
4165
|
+
|
|
4166
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
4167
|
+
|
|
4168
|
+
|
|
4169
|
+
## endpointsFleetConnectorsUsedByList
|
|
4170
|
+
|
|
4171
|
+
> Array<UsedBy> endpointsFleetConnectorsUsedByList(connectorUuid)
|
|
4172
|
+
|
|
4173
|
+
|
|
4174
|
+
|
|
4175
|
+
Get a list of all objects that use this object
|
|
4176
|
+
|
|
4177
|
+
### Example
|
|
4178
|
+
|
|
4179
|
+
```ts
|
|
4180
|
+
import {
|
|
4181
|
+
Configuration,
|
|
4182
|
+
EndpointsApi,
|
|
4183
|
+
} from '@goauthentik/api';
|
|
4184
|
+
import type { EndpointsFleetConnectorsUsedByListRequest } from '@goauthentik/api';
|
|
4185
|
+
|
|
4186
|
+
async function example() {
|
|
4187
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
4188
|
+
const config = new Configuration({
|
|
4189
|
+
// Configure HTTP bearer authorization: authentik
|
|
4190
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
4191
|
+
});
|
|
4192
|
+
const api = new EndpointsApi(config);
|
|
4193
|
+
|
|
4194
|
+
const body = {
|
|
4195
|
+
// string | A UUID string identifying this Fleet Connector.
|
|
4196
|
+
connectorUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
4197
|
+
} satisfies EndpointsFleetConnectorsUsedByListRequest;
|
|
4198
|
+
|
|
4199
|
+
try {
|
|
4200
|
+
const data = await api.endpointsFleetConnectorsUsedByList(body);
|
|
4201
|
+
console.log(data);
|
|
4202
|
+
} catch (error) {
|
|
4203
|
+
console.error(error);
|
|
4204
|
+
}
|
|
4205
|
+
}
|
|
4206
|
+
|
|
4207
|
+
// Run the test
|
|
4208
|
+
example().catch(console.error);
|
|
4209
|
+
```
|
|
4210
|
+
|
|
4211
|
+
### Parameters
|
|
4212
|
+
|
|
4213
|
+
|
|
4214
|
+
| Name | Type | Description | Notes |
|
|
4215
|
+
|------------- | ------------- | ------------- | -------------|
|
|
4216
|
+
| **connectorUuid** | `string` | A UUID string identifying this Fleet Connector. | [Defaults to `undefined`] |
|
|
4217
|
+
|
|
4218
|
+
### Return type
|
|
4219
|
+
|
|
4220
|
+
[**Array<UsedBy>**](UsedBy.md)
|
|
4221
|
+
|
|
4222
|
+
### Authorization
|
|
4223
|
+
|
|
4224
|
+
[authentik](../README.md#authentik)
|
|
4225
|
+
|
|
4226
|
+
### HTTP request headers
|
|
4227
|
+
|
|
4228
|
+
- **Content-Type**: Not defined
|
|
4229
|
+
- **Accept**: `application/json`
|
|
4230
|
+
|
|
4231
|
+
|
|
4232
|
+
### HTTP response details
|
|
4233
|
+
| Status code | Description | Response headers |
|
|
4234
|
+
|-------------|-------------|------------------|
|
|
4235
|
+
| **200** | | - |
|
|
4236
|
+
| **400** | | - |
|
|
4237
|
+
| **403** | | - |
|
|
4238
|
+
|
|
4239
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
4240
|
+
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
|
|
2
|
+
# FleetConnector
|
|
3
|
+
|
|
4
|
+
FleetConnector Serializer
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`connectorUuid` | string
|
|
11
|
+
`name` | string
|
|
12
|
+
`enabled` | boolean
|
|
13
|
+
`component` | string
|
|
14
|
+
`verboseName` | string
|
|
15
|
+
`verboseNamePlural` | string
|
|
16
|
+
`metaModelName` | string
|
|
17
|
+
`url` | string
|
|
18
|
+
`headersMapping` | string
|
|
19
|
+
`mapUsers` | boolean
|
|
20
|
+
`mapTeamsAccessGroup` | boolean
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import type { FleetConnector } from '@goauthentik/api'
|
|
26
|
+
|
|
27
|
+
// TODO: Update the object below with actual values
|
|
28
|
+
const example = {
|
|
29
|
+
"connectorUuid": null,
|
|
30
|
+
"name": null,
|
|
31
|
+
"enabled": null,
|
|
32
|
+
"component": null,
|
|
33
|
+
"verboseName": null,
|
|
34
|
+
"verboseNamePlural": null,
|
|
35
|
+
"metaModelName": null,
|
|
36
|
+
"url": null,
|
|
37
|
+
"headersMapping": null,
|
|
38
|
+
"mapUsers": null,
|
|
39
|
+
"mapTeamsAccessGroup": null,
|
|
40
|
+
} satisfies FleetConnector
|
|
41
|
+
|
|
42
|
+
console.log(example)
|
|
43
|
+
|
|
44
|
+
// Convert the instance to a JSON string
|
|
45
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
46
|
+
console.log(exampleJSON)
|
|
47
|
+
|
|
48
|
+
// Parse the JSON string back to an object
|
|
49
|
+
const exampleParsed = JSON.parse(exampleJSON) as FleetConnector
|
|
50
|
+
console.log(exampleParsed)
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
54
|
+
|
|
55
|
+
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
|
|
2
|
+
# FleetConnectorRequest
|
|
3
|
+
|
|
4
|
+
FleetConnector Serializer
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`connectorUuid` | string
|
|
11
|
+
`name` | string
|
|
12
|
+
`enabled` | boolean
|
|
13
|
+
`url` | string
|
|
14
|
+
`token` | string
|
|
15
|
+
`headersMapping` | string
|
|
16
|
+
`mapUsers` | boolean
|
|
17
|
+
`mapTeamsAccessGroup` | boolean
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { FleetConnectorRequest } from '@goauthentik/api'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"connectorUuid": null,
|
|
27
|
+
"name": null,
|
|
28
|
+
"enabled": null,
|
|
29
|
+
"url": null,
|
|
30
|
+
"token": null,
|
|
31
|
+
"headersMapping": null,
|
|
32
|
+
"mapUsers": null,
|
|
33
|
+
"mapTeamsAccessGroup": null,
|
|
34
|
+
} satisfies FleetConnectorRequest
|
|
35
|
+
|
|
36
|
+
console.log(example)
|
|
37
|
+
|
|
38
|
+
// Convert the instance to a JSON string
|
|
39
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
40
|
+
console.log(exampleJSON)
|
|
41
|
+
|
|
42
|
+
// Parse the JSON string back to an object
|
|
43
|
+
const exampleParsed = JSON.parse(exampleJSON) as FleetConnectorRequest
|
|
44
|
+
console.log(exampleParsed)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
48
|
+
|
|
49
|
+
|
package/docs/OperatingSystem.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# OperatingSystem
|
|
3
3
|
|
|
4
|
+
For example: {\"family\":\"linux\",\"name\":\"Ubuntu\",\"version\":\"24.04.3 LTS (Noble Numbat)\",\"arch\":\"amd64\"} {\"family\": \"windows\",\"name\":\"Server 2022 Datacenter\",\"version\":\"10.0.20348.4405\",\"arch\":\"amd64\"} {\"family\": \"windows\",\"name\":\"Server 2022 Datacenter\",\"version\":\"10.0.20348.4405\",\"arch\":\"amd64\"} {\"family\": \"mac_os\", \"name\": \"\", \"version\": \"26.2\", \"arch\": \"arm64\"}
|
|
4
5
|
|
|
5
6
|
## Properties
|
|
6
7
|
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# OperatingSystemRequest
|
|
3
3
|
|
|
4
|
+
For example: {\"family\":\"linux\",\"name\":\"Ubuntu\",\"version\":\"24.04.3 LTS (Noble Numbat)\",\"arch\":\"amd64\"} {\"family\": \"windows\",\"name\":\"Server 2022 Datacenter\",\"version\":\"10.0.20348.4405\",\"arch\":\"amd64\"} {\"family\": \"windows\",\"name\":\"Server 2022 Datacenter\",\"version\":\"10.0.20348.4405\",\"arch\":\"amd64\"} {\"family\": \"mac_os\", \"name\": \"\", \"version\": \"26.2\", \"arch\": \"arm64\"}
|
|
4
5
|
|
|
5
6
|
## Properties
|
|
6
7
|
|