@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

package/dist/models/UserVerificationEnum.js

@@ -15,7 +15,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserVerificationEnumToJSON = exports.UserVerificationEnumFromJSONTyped = exports.UserVerificationEnumFromJSON = exports.UserVerificationEnum = void 0;
 /**
- *
+ * * `required` - Required
+ * * `preferred` - Preferred
+ * * `discouraged` - Discouraged
  * @export
  */
 exports.UserVerificationEnum = {

package/dist/models/UserWriteStage.d.ts

@@ -30,25 +30,25 @@ export interface UserWriteStage {
      */
     name: string;
     /**
-     *
+     * Get object type so that we know how to edit the object
      * @type {string}
      * @memberof UserWriteStage
      */
     readonly component: string;
     /**
-     *
+     * Return object's verbose_name
      * @type {string}
      * @memberof UserWriteStage
      */
     readonly verboseName: string;
     /**
-     *
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof UserWriteStage
      */
     readonly verboseNamePlural: string;
     /**
-     *
+     * Return internal model name
      * @type {string}
      * @memberof UserWriteStage
      */

package/dist/models/Version.d.ts

@@ -16,25 +16,25 @@
  */
 export interface Version {
     /**
-     *
+     * Get current version
      * @type {string}
      * @memberof Version
      */
     readonly versionCurrent: string;
     /**
-     *
+     * Get latest version from cache
      * @type {string}
      * @memberof Version
      */
     readonly versionLatest: string;
     /**
-     *
+     * Get build hash, if version is not latest or released
      * @type {string}
      * @memberof Version
      */
     readonly buildHash: string;
     /**
-     *
+     * Check if we're running the latest version
      * @type {boolean}
      * @memberof Version
      */

package/dist/models/index.d.ts

@@ -249,6 +249,8 @@ export * from './PaginatedReputationPolicyList';
 export * from './PaginatedSAMLPropertyMappingList';
 export * from './PaginatedSAMLProviderList';
 export * from './PaginatedSAMLSourceList';
+export * from './PaginatedSCIMMappingList';
+export * from './PaginatedSCIMProviderList';
 export * from './PaginatedSMSDeviceList';
 export * from './PaginatedScopeMappingList';
 export * from './PaginatedServiceConnectionList';
@@ -327,6 +329,8 @@ export * from './PatchedReputationPolicyRequest';
 export * from './PatchedSAMLPropertyMappingRequest';
 export * from './PatchedSAMLProviderRequest';
 export * from './PatchedSAMLSourceRequest';
+export * from './PatchedSCIMMappingRequest';
+export * from './PatchedSCIMProviderRequest';
 export * from './PatchedSMSDeviceRequest';
 export * from './PatchedScopeMappingRequest';
 export * from './PatchedStaticDeviceRequest';
@@ -390,6 +394,10 @@ export * from './SAMLProvider';
 export * from './SAMLProviderRequest';
 export * from './SAMLSource';
 export * from './SAMLSourceRequest';
+export * from './SCIMMapping';
+export * from './SCIMMappingRequest';
+export * from './SCIMProvider';
+export * from './SCIMProviderRequest';
 export * from './SMSDevice';
 export * from './SMSDeviceRequest';
 export * from './ScopeMapping';

package/dist/models/index.js

@@ -267,6 +267,8 @@ __exportStar(require("./PaginatedReputationPolicyList"), exports);
 __exportStar(require("./PaginatedSAMLPropertyMappingList"), exports);
 __exportStar(require("./PaginatedSAMLProviderList"), exports);
 __exportStar(require("./PaginatedSAMLSourceList"), exports);
+__exportStar(require("./PaginatedSCIMMappingList"), exports);
+__exportStar(require("./PaginatedSCIMProviderList"), exports);
 __exportStar(require("./PaginatedSMSDeviceList"), exports);
 __exportStar(require("./PaginatedScopeMappingList"), exports);
 __exportStar(require("./PaginatedServiceConnectionList"), exports);
@@ -345,6 +347,8 @@ __exportStar(require("./PatchedReputationPolicyRequest"), exports);
 __exportStar(require("./PatchedSAMLPropertyMappingRequest"), exports);
 __exportStar(require("./PatchedSAMLProviderRequest"), exports);
 __exportStar(require("./PatchedSAMLSourceRequest"), exports);
+__exportStar(require("./PatchedSCIMMappingRequest"), exports);
+__exportStar(require("./PatchedSCIMProviderRequest"), exports);
 __exportStar(require("./PatchedSMSDeviceRequest"), exports);
 __exportStar(require("./PatchedScopeMappingRequest"), exports);
 __exportStar(require("./PatchedStaticDeviceRequest"), exports);
@@ -408,6 +412,10 @@ __exportStar(require("./SAMLProvider"), exports);
 __exportStar(require("./SAMLProviderRequest"), exports);
 __exportStar(require("./SAMLSource"), exports);
 __exportStar(require("./SAMLSourceRequest"), exports);
+__exportStar(require("./SCIMMapping"), exports);
+__exportStar(require("./SCIMMappingRequest"), exports);
+__exportStar(require("./SCIMProvider"), exports);
+__exportStar(require("./SCIMProviderRequest"), exports);
 __exportStar(require("./SMSDevice"), exports);
 __exportStar(require("./SMSDeviceRequest"), exports);
 __exportStar(require("./ScopeMapping"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@goauthentik/api",
-  "version": "2023.2.2-1677507715",
+  "version": "2023.2.2-1678200024",
   "description": "OpenAPI client for @goauthentik/api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/PropertymappingsApi.ts

@@ -42,6 +42,9 @@ import {
     PaginatedSAMLPropertyMappingList,
     PaginatedSAMLPropertyMappingListFromJSON,
     PaginatedSAMLPropertyMappingListToJSON,
+    PaginatedSCIMMappingList,
+    PaginatedSCIMMappingListFromJSON,
+    PaginatedSCIMMappingListToJSON,
     PaginatedScopeMappingList,
     PaginatedScopeMappingListFromJSON,
     PaginatedScopeMappingListToJSON,
@@ -54,6 +57,9 @@ import {
     PatchedSAMLPropertyMappingRequest,
     PatchedSAMLPropertyMappingRequestFromJSON,
     PatchedSAMLPropertyMappingRequestToJSON,
+    PatchedSCIMMappingRequest,
+    PatchedSCIMMappingRequestFromJSON,
+    PatchedSCIMMappingRequestToJSON,
     PatchedScopeMappingRequest,
     PatchedScopeMappingRequestFromJSON,
     PatchedScopeMappingRequestToJSON,
@@ -72,6 +78,12 @@ import {
     SAMLPropertyMappingRequest,
     SAMLPropertyMappingRequestFromJSON,
     SAMLPropertyMappingRequestToJSON,
+    SCIMMapping,
+    SCIMMappingFromJSON,
+    SCIMMappingToJSON,
+    SCIMMappingRequest,
+    SCIMMappingRequestFromJSON,
+    SCIMMappingRequestToJSON,
     ScopeMapping,
     ScopeMappingFromJSON,
     ScopeMappingToJSON,
@@ -226,6 +238,43 @@ export interface PropertymappingsSamlUsedByListRequest {
     pmUuid: string;
 }
 
+export interface PropertymappingsScimCreateRequest {
+    sCIMMappingRequest: SCIMMappingRequest;
+}
+
+export interface PropertymappingsScimDestroyRequest {
+    pmUuid: string;
+}
+
+export interface PropertymappingsScimListRequest {
+    expression?: string;
+    managed?: Array<string>;
+    name?: string;
+    ordering?: string;
+    page?: number;
+    pageSize?: number;
+    pmUuid?: string;
+    search?: string;
+}
+
+export interface PropertymappingsScimPartialUpdateRequest {
+    pmUuid: string;
+    patchedSCIMMappingRequest?: PatchedSCIMMappingRequest;
+}
+
+export interface PropertymappingsScimRetrieveRequest {
+    pmUuid: string;
+}
+
+export interface PropertymappingsScimUpdateRequest {
+    pmUuid: string;
+    sCIMMappingRequest: SCIMMappingRequest;
+}
+
+export interface PropertymappingsScimUsedByListRequest {
+    pmUuid: string;
+}
+
 export interface PropertymappingsScopeCreateRequest {
     scopeMappingRequest: ScopeMappingRequest;
 }
@@ -1327,6 +1376,284 @@ export class PropertymappingsApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * SCIMMapping Viewset
+     */
+    async propertymappingsScimCreateRaw(requestParameters: PropertymappingsScimCreateRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<SCIMMapping>> {
+        if (requestParameters.sCIMMappingRequest === null || requestParameters.sCIMMappingRequest === undefined) {
+            throw new runtime.RequiredError('sCIMMappingRequest','Required parameter requestParameters.sCIMMappingRequest was null or undefined when calling propertymappingsScimCreate.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // authentik authentication
+        }
+
+        const response = await this.request({
+            path: `/propertymappings/scim/`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SCIMMappingRequestToJSON(requestParameters.sCIMMappingRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SCIMMappingFromJSON(jsonValue));
+    }
+
+    /**
+     * SCIMMapping Viewset
+     */
+    async propertymappingsScimCreate(requestParameters: PropertymappingsScimCreateRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<SCIMMapping> {
+        const response = await this.propertymappingsScimCreateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * SCIMMapping Viewset
+     */
+    async propertymappingsScimDestroyRaw(requestParameters: PropertymappingsScimDestroyRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.pmUuid === null || requestParameters.pmUuid === undefined) {
+            throw new runtime.RequiredError('pmUuid','Required parameter requestParameters.pmUuid was null or undefined when calling propertymappingsScimDestroy.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // authentik authentication
+        }
+
+        const response = await this.request({
+            path: `/propertymappings/scim/{pm_uuid}/`.replace(`{${"pm_uuid"}}`, encodeURIComponent(String(requestParameters.pmUuid))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * SCIMMapping Viewset
+     */
+    async propertymappingsScimDestroy(requestParameters: PropertymappingsScimDestroyRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<void> {
+        await this.propertymappingsScimDestroyRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * SCIMMapping Viewset
+     */
+    async propertymappingsScimListRaw(requestParameters: PropertymappingsScimListRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<PaginatedSCIMMappingList>> {
+        const queryParameters: any = {};
+
+        if (requestParameters.expression !== undefined) {
+            queryParameters['expression'] = requestParameters.expression;
+        }
+
+        if (requestParameters.managed) {
+            queryParameters['managed'] = requestParameters.managed;
+        }
+
+        if (requestParameters.name !== undefined) {
+            queryParameters['name'] = requestParameters.name;
+        }
+
+        if (requestParameters.ordering !== undefined) {
+            queryParameters['ordering'] = requestParameters.ordering;
+        }
+
+        if (requestParameters.page !== undefined) {
+            queryParameters['page'] = requestParameters.page;
+        }
+
+        if (requestParameters.pageSize !== undefined) {
+            queryParameters['page_size'] = requestParameters.pageSize;
+        }
+
+        if (requestParameters.pmUuid !== undefined) {
+            queryParameters['pm_uuid'] = requestParameters.pmUuid;
+        }
+
+        if (requestParameters.search !== undefined) {
+            queryParameters['search'] = requestParameters.search;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // authentik authentication
+        }
+
+        const response = await this.request({
+            path: `/propertymappings/scim/`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedSCIMMappingListFromJSON(jsonValue));
+    }
+
+    /**
+     * SCIMMapping Viewset
+     */
+    async propertymappingsScimList(requestParameters: PropertymappingsScimListRequest = {}, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<PaginatedSCIMMappingList> {
+        const response = await this.propertymappingsScimListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * SCIMMapping Viewset
+     */
+    async propertymappingsScimPartialUpdateRaw(requestParameters: PropertymappingsScimPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<SCIMMapping>> {
+        if (requestParameters.pmUuid === null || requestParameters.pmUuid === undefined) {
+            throw new runtime.RequiredError('pmUuid','Required parameter requestParameters.pmUuid was null or undefined when calling propertymappingsScimPartialUpdate.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // authentik authentication
+        }
+
+        const response = await this.request({
+            path: `/propertymappings/scim/{pm_uuid}/`.replace(`{${"pm_uuid"}}`, encodeURIComponent(String(requestParameters.pmUuid))),
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PatchedSCIMMappingRequestToJSON(requestParameters.patchedSCIMMappingRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SCIMMappingFromJSON(jsonValue));
+    }
+
+    /**
+     * SCIMMapping Viewset
+     */
+    async propertymappingsScimPartialUpdate(requestParameters: PropertymappingsScimPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<SCIMMapping> {
+        const response = await this.propertymappingsScimPartialUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * SCIMMapping Viewset
+     */
+    async propertymappingsScimRetrieveRaw(requestParameters: PropertymappingsScimRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<SCIMMapping>> {
+        if (requestParameters.pmUuid === null || requestParameters.pmUuid === undefined) {
+            throw new runtime.RequiredError('pmUuid','Required parameter requestParameters.pmUuid was null or undefined when calling propertymappingsScimRetrieve.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // authentik authentication
+        }
+
+        const response = await this.request({
+            path: `/propertymappings/scim/{pm_uuid}/`.replace(`{${"pm_uuid"}}`, encodeURIComponent(String(requestParameters.pmUuid))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SCIMMappingFromJSON(jsonValue));
+    }
+
+    /**
+     * SCIMMapping Viewset
+     */
+    async propertymappingsScimRetrieve(requestParameters: PropertymappingsScimRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<SCIMMapping> {
+        const response = await this.propertymappingsScimRetrieveRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * SCIMMapping Viewset
+     */
+    async propertymappingsScimUpdateRaw(requestParameters: PropertymappingsScimUpdateRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<SCIMMapping>> {
+        if (requestParameters.pmUuid === null || requestParameters.pmUuid === undefined) {
+            throw new runtime.RequiredError('pmUuid','Required parameter requestParameters.pmUuid was null or undefined when calling propertymappingsScimUpdate.');
+        }
+
+        if (requestParameters.sCIMMappingRequest === null || requestParameters.sCIMMappingRequest === undefined) {
+            throw new runtime.RequiredError('sCIMMappingRequest','Required parameter requestParameters.sCIMMappingRequest was null or undefined when calling propertymappingsScimUpdate.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // authentik authentication
+        }
+
+        const response = await this.request({
+            path: `/propertymappings/scim/{pm_uuid}/`.replace(`{${"pm_uuid"}}`, encodeURIComponent(String(requestParameters.pmUuid))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SCIMMappingRequestToJSON(requestParameters.sCIMMappingRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SCIMMappingFromJSON(jsonValue));
+    }
+
+    /**
+     * SCIMMapping Viewset
+     */
+    async propertymappingsScimUpdate(requestParameters: PropertymappingsScimUpdateRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<SCIMMapping> {
+        const response = await this.propertymappingsScimUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get a list of all objects that use this object
+     */
+    async propertymappingsScimUsedByListRaw(requestParameters: PropertymappingsScimUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<Array<UsedBy>>> {
+        if (requestParameters.pmUuid === null || requestParameters.pmUuid === undefined) {
+            throw new runtime.RequiredError('pmUuid','Required parameter requestParameters.pmUuid was null or undefined when calling propertymappingsScimUsedByList.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // authentik authentication
+        }
+
+        const response = await this.request({
+            path: `/propertymappings/scim/{pm_uuid}/used_by/`.replace(`{${"pm_uuid"}}`, encodeURIComponent(String(requestParameters.pmUuid))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(UsedByFromJSON));
+    }
+
+    /**
+     * Get a list of all objects that use this object
+     */
+    async propertymappingsScimUsedByList(requestParameters: PropertymappingsScimUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<Array<UsedBy>> {
+        const response = await this.propertymappingsScimUsedByListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * ScopeMapping Viewset
      */