@goauthentik/api 2026.2.0-rc1-1766493698 → 2026.2.0-rc1-1767654897
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/dist/apis/CoreApi.d.ts +2 -0
- package/dist/apis/CoreApi.d.ts.map +1 -1
- package/dist/apis/CoreApi.js +6 -0
- package/dist/apis/CoreApi.js.map +1 -1
- package/dist/apis/RbacApi.d.ts +3 -1
- package/dist/apis/RbacApi.d.ts.map +1 -1
- package/dist/apis/RbacApi.js +6 -0
- package/dist/apis/RbacApi.js.map +1 -1
- package/dist/esm/apis/CoreApi.d.ts +2 -0
- package/dist/esm/apis/CoreApi.d.ts.map +1 -1
- package/dist/esm/apis/CoreApi.js +6 -0
- package/dist/esm/apis/CoreApi.js.map +1 -1
- package/dist/esm/apis/RbacApi.d.ts +3 -1
- package/dist/esm/apis/RbacApi.d.ts.map +1 -1
- package/dist/esm/apis/RbacApi.js +6 -0
- package/dist/esm/apis/RbacApi.js.map +1 -1
- package/dist/esm/models/Group.d.ts +7 -1
- package/dist/esm/models/Group.d.ts.map +1 -1
- package/dist/esm/models/Group.js +3 -0
- package/dist/esm/models/Group.js.map +1 -1
- package/dist/models/Group.d.ts +7 -1
- package/dist/models/Group.d.ts.map +1 -1
- package/dist/models/Group.js +3 -0
- package/dist/models/Group.js.map +1 -1
- package/dist/tsconfig.esm.tsbuildinfo +1 -1
- package/docs/CoreApi.md +8 -2
- package/docs/Group.md +2 -0
- package/docs/RbacApi.md +10 -4
- package/package.json +1 -1
- package/src/apis/CoreApi.ts +10 -0
- package/src/apis/RbacApi.ts +11 -1
- package/src/models/Group.ts +9 -1
- package/tsconfig.tsbuildinfo +1 -1
package/docs/CoreApi.md
CHANGED
|
@@ -2408,7 +2408,7 @@ example().catch(console.error);
|
|
|
2408
2408
|
|
|
2409
2409
|
## coreGroupsList
|
|
2410
2410
|
|
|
2411
|
-
> PaginatedGroupList coreGroupsList(attributes, includeChildren, includeParents, includeUsers, isSuperuser, membersByPk, membersByUsername, name, ordering, page, pageSize, search)
|
|
2411
|
+
> PaginatedGroupList coreGroupsList(attributes, includeChildren, includeInheritedRoles, includeParents, includeUsers, isSuperuser, membersByPk, membersByUsername, name, ordering, page, pageSize, search)
|
|
2412
2412
|
|
|
2413
2413
|
|
|
2414
2414
|
|
|
@@ -2437,6 +2437,8 @@ async function example() {
|
|
|
2437
2437
|
// boolean (optional)
|
|
2438
2438
|
includeChildren: true,
|
|
2439
2439
|
// boolean (optional)
|
|
2440
|
+
includeInheritedRoles: true,
|
|
2441
|
+
// boolean (optional)
|
|
2440
2442
|
includeParents: true,
|
|
2441
2443
|
// boolean (optional)
|
|
2442
2444
|
includeUsers: true,
|
|
@@ -2477,6 +2479,7 @@ example().catch(console.error);
|
|
|
2477
2479
|
|------------- | ------------- | ------------- | -------------|
|
|
2478
2480
|
| **attributes** | `string` | Attributes | [Optional] [Defaults to `undefined`] |
|
|
2479
2481
|
| **includeChildren** | `boolean` | | [Optional] [Defaults to `false`] |
|
|
2482
|
+
| **includeInheritedRoles** | `boolean` | | [Optional] [Defaults to `false`] |
|
|
2480
2483
|
| **includeParents** | `boolean` | | [Optional] [Defaults to `false`] |
|
|
2481
2484
|
| **includeUsers** | `boolean` | | [Optional] [Defaults to `true`] |
|
|
2482
2485
|
| **isSuperuser** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
@@ -2667,7 +2670,7 @@ example().catch(console.error);
|
|
|
2667
2670
|
|
|
2668
2671
|
## coreGroupsRetrieve
|
|
2669
2672
|
|
|
2670
|
-
> Group coreGroupsRetrieve(groupUuid, includeChildren, includeParents, includeUsers)
|
|
2673
|
+
> Group coreGroupsRetrieve(groupUuid, includeChildren, includeInheritedRoles, includeParents, includeUsers)
|
|
2671
2674
|
|
|
2672
2675
|
|
|
2673
2676
|
|
|
@@ -2696,6 +2699,8 @@ async function example() {
|
|
|
2696
2699
|
// boolean (optional)
|
|
2697
2700
|
includeChildren: true,
|
|
2698
2701
|
// boolean (optional)
|
|
2702
|
+
includeInheritedRoles: true,
|
|
2703
|
+
// boolean (optional)
|
|
2699
2704
|
includeParents: true,
|
|
2700
2705
|
// boolean (optional)
|
|
2701
2706
|
includeUsers: true,
|
|
@@ -2720,6 +2725,7 @@ example().catch(console.error);
|
|
|
2720
2725
|
|------------- | ------------- | ------------- | -------------|
|
|
2721
2726
|
| **groupUuid** | `string` | A UUID string identifying this Group. | [Defaults to `undefined`] |
|
|
2722
2727
|
| **includeChildren** | `boolean` | | [Optional] [Defaults to `false`] |
|
|
2728
|
+
| **includeInheritedRoles** | `boolean` | | [Optional] [Defaults to `false`] |
|
|
2723
2729
|
| **includeParents** | `boolean` | | [Optional] [Defaults to `false`] |
|
|
2724
2730
|
| **includeUsers** | `boolean` | | [Optional] [Defaults to `true`] |
|
|
2725
2731
|
|
package/docs/Group.md
CHANGED
|
@@ -18,6 +18,7 @@ Name | Type
|
|
|
18
18
|
`attributes` | { [key: string]: any; }
|
|
19
19
|
`roles` | Array<string>
|
|
20
20
|
`rolesObj` | [Array<Role>](Role.md)
|
|
21
|
+
`inheritedRolesObj` | [Array<Role>](Role.md)
|
|
21
22
|
`children` | Array<string>
|
|
22
23
|
`childrenObj` | [Array<RelatedGroup>](RelatedGroup.md)
|
|
23
24
|
|
|
@@ -39,6 +40,7 @@ const example = {
|
|
|
39
40
|
"attributes": null,
|
|
40
41
|
"roles": null,
|
|
41
42
|
"rolesObj": null,
|
|
43
|
+
"inheritedRolesObj": null,
|
|
42
44
|
"children": null,
|
|
43
45
|
"childrenObj": null,
|
|
44
46
|
} satisfies Group
|
package/docs/RbacApi.md
CHANGED
|
@@ -1278,7 +1278,7 @@ example().catch(console.error);
|
|
|
1278
1278
|
|
|
1279
1279
|
## rbacRolesList
|
|
1280
1280
|
|
|
1281
|
-
> PaginatedRoleList rbacRolesList(managed, managedIsnull, name, ordering, page, pageSize, search, users)
|
|
1281
|
+
> PaginatedRoleList rbacRolesList(akGroups, inherited, managed, managedIsnull, name, ordering, page, pageSize, search, users)
|
|
1282
1282
|
|
|
1283
1283
|
|
|
1284
1284
|
|
|
@@ -1302,6 +1302,10 @@ async function example() {
|
|
|
1302
1302
|
const api = new RbacApi(config);
|
|
1303
1303
|
|
|
1304
1304
|
const body = {
|
|
1305
|
+
// string (optional)
|
|
1306
|
+
akGroups: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1307
|
+
// boolean | Include inherited roles (requires users or ak_groups filter) (optional)
|
|
1308
|
+
inherited: true,
|
|
1305
1309
|
// Array<string> (optional)
|
|
1306
1310
|
managed: ...,
|
|
1307
1311
|
// boolean (optional)
|
|
@@ -1316,8 +1320,8 @@ async function example() {
|
|
|
1316
1320
|
pageSize: 56,
|
|
1317
1321
|
// string | A search term. (optional)
|
|
1318
1322
|
search: search_example,
|
|
1319
|
-
//
|
|
1320
|
-
users:
|
|
1323
|
+
// number (optional)
|
|
1324
|
+
users: 56,
|
|
1321
1325
|
} satisfies RbacRolesListRequest;
|
|
1322
1326
|
|
|
1323
1327
|
try {
|
|
@@ -1337,6 +1341,8 @@ example().catch(console.error);
|
|
|
1337
1341
|
|
|
1338
1342
|
| Name | Type | Description | Notes |
|
|
1339
1343
|
|------------- | ------------- | ------------- | -------------|
|
|
1344
|
+
| **akGroups** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1345
|
+
| **inherited** | `boolean` | Include inherited roles (requires users or ak_groups filter) | [Optional] [Defaults to `undefined`] |
|
|
1340
1346
|
| **managed** | `Array<string>` | | [Optional] |
|
|
1341
1347
|
| **managedIsnull** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
1342
1348
|
| **name** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
@@ -1344,7 +1350,7 @@ example().catch(console.error);
|
|
|
1344
1350
|
| **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
|
|
1345
1351
|
| **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
|
|
1346
1352
|
| **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
|
|
1347
|
-
| **users** | `
|
|
1353
|
+
| **users** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1348
1354
|
|
|
1349
1355
|
### Return type
|
|
1350
1356
|
|
package/package.json
CHANGED
package/src/apis/CoreApi.ts
CHANGED
|
@@ -326,6 +326,7 @@ export interface CoreGroupsDestroyRequest {
|
|
|
326
326
|
export interface CoreGroupsListRequest {
|
|
327
327
|
attributes?: string;
|
|
328
328
|
includeChildren?: boolean;
|
|
329
|
+
includeInheritedRoles?: boolean;
|
|
329
330
|
includeParents?: boolean;
|
|
330
331
|
includeUsers?: boolean;
|
|
331
332
|
isSuperuser?: boolean;
|
|
@@ -351,6 +352,7 @@ export interface CoreGroupsRemoveUserCreateRequest {
|
|
|
351
352
|
export interface CoreGroupsRetrieveRequest {
|
|
352
353
|
groupUuid: string;
|
|
353
354
|
includeChildren?: boolean;
|
|
355
|
+
includeInheritedRoles?: boolean;
|
|
354
356
|
includeParents?: boolean;
|
|
355
357
|
includeUsers?: boolean;
|
|
356
358
|
}
|
|
@@ -2113,6 +2115,10 @@ export class CoreApi extends runtime.BaseAPI {
|
|
|
2113
2115
|
queryParameters['include_children'] = requestParameters['includeChildren'];
|
|
2114
2116
|
}
|
|
2115
2117
|
|
|
2118
|
+
if (requestParameters['includeInheritedRoles'] != null) {
|
|
2119
|
+
queryParameters['include_inherited_roles'] = requestParameters['includeInheritedRoles'];
|
|
2120
|
+
}
|
|
2121
|
+
|
|
2116
2122
|
if (requestParameters['includeParents'] != null) {
|
|
2117
2123
|
queryParameters['include_parents'] = requestParameters['includeParents'];
|
|
2118
2124
|
}
|
|
@@ -2303,6 +2309,10 @@ export class CoreApi extends runtime.BaseAPI {
|
|
|
2303
2309
|
queryParameters['include_children'] = requestParameters['includeChildren'];
|
|
2304
2310
|
}
|
|
2305
2311
|
|
|
2312
|
+
if (requestParameters['includeInheritedRoles'] != null) {
|
|
2313
|
+
queryParameters['include_inherited_roles'] = requestParameters['includeInheritedRoles'];
|
|
2314
|
+
}
|
|
2315
|
+
|
|
2306
2316
|
if (requestParameters['includeParents'] != null) {
|
|
2307
2317
|
queryParameters['include_parents'] = requestParameters['includeParents'];
|
|
2308
2318
|
}
|
package/src/apis/RbacApi.ts
CHANGED
|
@@ -167,6 +167,8 @@ export interface RbacRolesDestroyRequest {
|
|
|
167
167
|
}
|
|
168
168
|
|
|
169
169
|
export interface RbacRolesListRequest {
|
|
170
|
+
akGroups?: string;
|
|
171
|
+
inherited?: boolean;
|
|
170
172
|
managed?: Array<string>;
|
|
171
173
|
managedIsnull?: boolean;
|
|
172
174
|
name?: string;
|
|
@@ -174,7 +176,7 @@ export interface RbacRolesListRequest {
|
|
|
174
176
|
page?: number;
|
|
175
177
|
pageSize?: number;
|
|
176
178
|
search?: string;
|
|
177
|
-
users?:
|
|
179
|
+
users?: number;
|
|
178
180
|
}
|
|
179
181
|
|
|
180
182
|
export interface RbacRolesPartialUpdateRequest {
|
|
@@ -1042,6 +1044,14 @@ export class RbacApi extends runtime.BaseAPI {
|
|
|
1042
1044
|
async rbacRolesListRaw(requestParameters: RbacRolesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedRoleList>> {
|
|
1043
1045
|
const queryParameters: any = {};
|
|
1044
1046
|
|
|
1047
|
+
if (requestParameters['akGroups'] != null) {
|
|
1048
|
+
queryParameters['ak_groups'] = requestParameters['akGroups'];
|
|
1049
|
+
}
|
|
1050
|
+
|
|
1051
|
+
if (requestParameters['inherited'] != null) {
|
|
1052
|
+
queryParameters['inherited'] = requestParameters['inherited'];
|
|
1053
|
+
}
|
|
1054
|
+
|
|
1045
1055
|
if (requestParameters['managed'] != null) {
|
|
1046
1056
|
queryParameters['managed'] = requestParameters['managed'];
|
|
1047
1057
|
}
|
package/src/models/Group.ts
CHANGED
|
@@ -107,6 +107,12 @@ export interface Group {
|
|
|
107
107
|
* @memberof Group
|
|
108
108
|
*/
|
|
109
109
|
readonly rolesObj: Array<Role>;
|
|
110
|
+
/**
|
|
111
|
+
*
|
|
112
|
+
* @type {Array<Role>}
|
|
113
|
+
* @memberof Group
|
|
114
|
+
*/
|
|
115
|
+
readonly inheritedRolesObj: Array<Role> | null;
|
|
110
116
|
/**
|
|
111
117
|
*
|
|
112
118
|
* @type {Array<string>}
|
|
@@ -131,6 +137,7 @@ export function instanceOfGroup(value: object): value is Group {
|
|
|
131
137
|
if (!('parentsObj' in value) || value['parentsObj'] === undefined) return false;
|
|
132
138
|
if (!('usersObj' in value) || value['usersObj'] === undefined) return false;
|
|
133
139
|
if (!('rolesObj' in value) || value['rolesObj'] === undefined) return false;
|
|
140
|
+
if (!('inheritedRolesObj' in value) || value['inheritedRolesObj'] === undefined) return false;
|
|
134
141
|
if (!('children' in value) || value['children'] === undefined) return false;
|
|
135
142
|
if (!('childrenObj' in value) || value['childrenObj'] === undefined) return false;
|
|
136
143
|
return true;
|
|
@@ -157,6 +164,7 @@ export function GroupFromJSONTyped(json: any, ignoreDiscriminator: boolean): Gro
|
|
|
157
164
|
'attributes': json['attributes'] == null ? undefined : json['attributes'],
|
|
158
165
|
'roles': json['roles'] == null ? undefined : json['roles'],
|
|
159
166
|
'rolesObj': ((json['roles_obj'] as Array<any>).map(RoleFromJSON)),
|
|
167
|
+
'inheritedRolesObj': (json['inherited_roles_obj'] == null ? null : (json['inherited_roles_obj'] as Array<any>).map(RoleFromJSON)),
|
|
160
168
|
'children': json['children'],
|
|
161
169
|
'childrenObj': (json['children_obj'] == null ? null : (json['children_obj'] as Array<any>).map(RelatedGroupFromJSON)),
|
|
162
170
|
};
|
|
@@ -166,7 +174,7 @@ export function GroupToJSON(json: any): Group {
|
|
|
166
174
|
return GroupToJSONTyped(json, false);
|
|
167
175
|
}
|
|
168
176
|
|
|
169
|
-
export function GroupToJSONTyped(value?: Omit<Group, 'pk'|'num_pk'|'parents_obj'|'users_obj'|'roles_obj'|'children'|'children_obj'> | null, ignoreDiscriminator: boolean = false): any {
|
|
177
|
+
export function GroupToJSONTyped(value?: Omit<Group, 'pk'|'num_pk'|'parents_obj'|'users_obj'|'roles_obj'|'inherited_roles_obj'|'children'|'children_obj'> | null, ignoreDiscriminator: boolean = false): any {
|
|
170
178
|
if (value == null) {
|
|
171
179
|
return value;
|
|
172
180
|
}
|