@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

package/src/apis/ProvidersApi.ts

@@ -48,6 +48,9 @@ import {
     PaginatedSAMLProviderList,
     PaginatedSAMLProviderListFromJSON,
     PaginatedSAMLProviderListToJSON,
+    PaginatedSCIMProviderList,
+    PaginatedSCIMProviderListFromJSON,
+    PaginatedSCIMProviderListToJSON,
     PatchedLDAPProviderRequest,
     PatchedLDAPProviderRequestFromJSON,
     PatchedLDAPProviderRequestToJSON,
@@ -60,6 +63,9 @@ import {
     PatchedSAMLProviderRequest,
     PatchedSAMLProviderRequestFromJSON,
     PatchedSAMLProviderRequestToJSON,
+    PatchedSCIMProviderRequest,
+    PatchedSCIMProviderRequestFromJSON,
+    PatchedSCIMProviderRequestToJSON,
     PropertyMappingPreview,
     PropertyMappingPreviewFromJSON,
     PropertyMappingPreviewToJSON,
@@ -81,6 +87,15 @@ import {
     SAMLProviderRequest,
     SAMLProviderRequestFromJSON,
     SAMLProviderRequestToJSON,
+    SCIMProvider,
+    SCIMProviderFromJSON,
+    SCIMProviderToJSON,
+    SCIMProviderRequest,
+    SCIMProviderRequestFromJSON,
+    SCIMProviderRequestToJSON,
+    Task,
+    TaskFromJSON,
+    TaskToJSON,
     TypeCreate,
     TypeCreateFromJSON,
     TypeCreateToJSON,
@@ -324,6 +339,47 @@ export interface ProvidersSamlUsedByListRequest {
     id: number;
 }
 
+export interface ProvidersScimCreateRequest {
+    sCIMProviderRequest: SCIMProviderRequest;
+}
+
+export interface ProvidersScimDestroyRequest {
+    id: number;
+}
+
+export interface ProvidersScimListRequest {
+    excludeUsersServiceAccount?: boolean;
+    filterGroup?: string;
+    name?: string;
+    ordering?: string;
+    page?: number;
+    pageSize?: number;
+    search?: string;
+    url?: string;
+}
+
+export interface ProvidersScimPartialUpdateRequest {
+    id: number;
+    patchedSCIMProviderRequest?: PatchedSCIMProviderRequest;
+}
+
+export interface ProvidersScimRetrieveRequest {
+    id: number;
+}
+
+export interface ProvidersScimSyncStatusRetrieveRequest {
+    id: number;
+}
+
+export interface ProvidersScimUpdateRequest {
+    id: number;
+    sCIMProviderRequest: SCIMProviderRequest;
+}
+
+export interface ProvidersScimUsedByListRequest {
+    id: number;
+}
+
 /**
  * 
  */
@@ -1996,6 +2052,318 @@ export class ProvidersApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * SCIMProvider Viewset
+     */
+    async providersScimCreateRaw(requestParameters: ProvidersScimCreateRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<SCIMProvider>> {
+        if (requestParameters.sCIMProviderRequest === null || requestParameters.sCIMProviderRequest === undefined) {
+            throw new runtime.RequiredError('sCIMProviderRequest','Required parameter requestParameters.sCIMProviderRequest was null or undefined when calling providersScimCreate.');
+        }
+
+        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: `/providers/scim/`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SCIMProviderRequestToJSON(requestParameters.sCIMProviderRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SCIMProviderFromJSON(jsonValue));
+    }
+
+    /**
+     * SCIMProvider Viewset
+     */
+    async providersScimCreate(requestParameters: ProvidersScimCreateRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<SCIMProvider> {
+        const response = await this.providersScimCreateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * SCIMProvider Viewset
+     */
+    async providersScimDestroyRaw(requestParameters: ProvidersScimDestroyRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.id === null || requestParameters.id === undefined) {
+            throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling providersScimDestroy.');
+        }
+
+        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: `/providers/scim/{id}/`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * SCIMProvider Viewset
+     */
+    async providersScimDestroy(requestParameters: ProvidersScimDestroyRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<void> {
+        await this.providersScimDestroyRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * SCIMProvider Viewset
+     */
+    async providersScimListRaw(requestParameters: ProvidersScimListRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<PaginatedSCIMProviderList>> {
+        const queryParameters: any = {};
+
+        if (requestParameters.excludeUsersServiceAccount !== undefined) {
+            queryParameters['exclude_users_service_account'] = requestParameters.excludeUsersServiceAccount;
+        }
+
+        if (requestParameters.filterGroup !== undefined) {
+            queryParameters['filter_group'] = requestParameters.filterGroup;
+        }
+
+        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.search !== undefined) {
+            queryParameters['search'] = requestParameters.search;
+        }
+
+        if (requestParameters.url !== undefined) {
+            queryParameters['url'] = requestParameters.url;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // authentik authentication
+        }
+
+        const response = await this.request({
+            path: `/providers/scim/`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedSCIMProviderListFromJSON(jsonValue));
+    }
+
+    /**
+     * SCIMProvider Viewset
+     */
+    async providersScimList(requestParameters: ProvidersScimListRequest = {}, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<PaginatedSCIMProviderList> {
+        const response = await this.providersScimListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * SCIMProvider Viewset
+     */
+    async providersScimPartialUpdateRaw(requestParameters: ProvidersScimPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<SCIMProvider>> {
+        if (requestParameters.id === null || requestParameters.id === undefined) {
+            throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling providersScimPartialUpdate.');
+        }
+
+        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: `/providers/scim/{id}/`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PatchedSCIMProviderRequestToJSON(requestParameters.patchedSCIMProviderRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SCIMProviderFromJSON(jsonValue));
+    }
+
+    /**
+     * SCIMProvider Viewset
+     */
+    async providersScimPartialUpdate(requestParameters: ProvidersScimPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<SCIMProvider> {
+        const response = await this.providersScimPartialUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * SCIMProvider Viewset
+     */
+    async providersScimRetrieveRaw(requestParameters: ProvidersScimRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<SCIMProvider>> {
+        if (requestParameters.id === null || requestParameters.id === undefined) {
+            throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling providersScimRetrieve.');
+        }
+
+        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: `/providers/scim/{id}/`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SCIMProviderFromJSON(jsonValue));
+    }
+
+    /**
+     * SCIMProvider Viewset
+     */
+    async providersScimRetrieve(requestParameters: ProvidersScimRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<SCIMProvider> {
+        const response = await this.providersScimRetrieveRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get provider\'s sync status
+     */
+    async providersScimSyncStatusRetrieveRaw(requestParameters: ProvidersScimSyncStatusRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<Task>> {
+        if (requestParameters.id === null || requestParameters.id === undefined) {
+            throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling providersScimSyncStatusRetrieve.');
+        }
+
+        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: `/providers/scim/{id}/sync_status/`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TaskFromJSON(jsonValue));
+    }
+
+    /**
+     * Get provider\'s sync status
+     */
+    async providersScimSyncStatusRetrieve(requestParameters: ProvidersScimSyncStatusRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<Task> {
+        const response = await this.providersScimSyncStatusRetrieveRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * SCIMProvider Viewset
+     */
+    async providersScimUpdateRaw(requestParameters: ProvidersScimUpdateRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<SCIMProvider>> {
+        if (requestParameters.id === null || requestParameters.id === undefined) {
+            throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling providersScimUpdate.');
+        }
+
+        if (requestParameters.sCIMProviderRequest === null || requestParameters.sCIMProviderRequest === undefined) {
+            throw new runtime.RequiredError('sCIMProviderRequest','Required parameter requestParameters.sCIMProviderRequest was null or undefined when calling providersScimUpdate.');
+        }
+
+        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: `/providers/scim/{id}/`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SCIMProviderRequestToJSON(requestParameters.sCIMProviderRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SCIMProviderFromJSON(jsonValue));
+    }
+
+    /**
+     * SCIMProvider Viewset
+     */
+    async providersScimUpdate(requestParameters: ProvidersScimUpdateRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<SCIMProvider> {
+        const response = await this.providersScimUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get a list of all objects that use this object
+     */
+    async providersScimUsedByListRaw(requestParameters: ProvidersScimUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<runtime.ApiResponse<Array<UsedBy>>> {
+        if (requestParameters.id === null || requestParameters.id === undefined) {
+            throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling providersScimUsedByList.');
+        }
+
+        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: `/providers/scim/{id}/used_by/`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+            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 providersScimUsedByList(requestParameters: ProvidersScimUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverideFunction): Promise<Array<UsedBy>> {
+        const response = await this.providersScimUsedByListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }
 
 /**

package/src/models/AppEnum.ts

@@ -14,7 +14,52 @@
 
 
 /**
- * 
+ * * `authentik.admin` - authentik Admin
+ * * `authentik.api` - authentik API
+ * * `authentik.crypto` - authentik Crypto
+ * * `authentik.events` - authentik Events
+ * * `authentik.flows` - authentik Flows
+ * * `authentik.lib` - authentik lib
+ * * `authentik.outposts` - authentik Outpost
+ * * `authentik.policies.dummy` - authentik Policies.Dummy
+ * * `authentik.policies.event_matcher` - authentik Policies.Event Matcher
+ * * `authentik.policies.expiry` - authentik Policies.Expiry
+ * * `authentik.policies.expression` - authentik Policies.Expression
+ * * `authentik.policies.password` - authentik Policies.Password
+ * * `authentik.policies.reputation` - authentik Policies.Reputation
+ * * `authentik.policies` - authentik Policies
+ * * `authentik.providers.ldap` - authentik Providers.LDAP
+ * * `authentik.providers.oauth2` - authentik Providers.OAuth2
+ * * `authentik.providers.proxy` - authentik Providers.Proxy
+ * * `authentik.providers.saml` - authentik Providers.SAML
+ * * `authentik.providers.scim` - authentik Providers.SCIM
+ * * `authentik.recovery` - authentik Recovery
+ * * `authentik.sources.ldap` - authentik Sources.LDAP
+ * * `authentik.sources.oauth` - authentik Sources.OAuth
+ * * `authentik.sources.plex` - authentik Sources.Plex
+ * * `authentik.sources.saml` - authentik Sources.SAML
+ * * `authentik.stages.authenticator_duo` - authentik Stages.Authenticator.Duo
+ * * `authentik.stages.authenticator_sms` - authentik Stages.Authenticator.SMS
+ * * `authentik.stages.authenticator_static` - authentik Stages.Authenticator.Static
+ * * `authentik.stages.authenticator_totp` - authentik Stages.Authenticator.TOTP
+ * * `authentik.stages.authenticator_validate` - authentik Stages.Authenticator.Validate
+ * * `authentik.stages.authenticator_webauthn` - authentik Stages.Authenticator.WebAuthn
+ * * `authentik.stages.captcha` - authentik Stages.Captcha
+ * * `authentik.stages.consent` - authentik Stages.Consent
+ * * `authentik.stages.deny` - authentik Stages.Deny
+ * * `authentik.stages.dummy` - authentik Stages.Dummy
+ * * `authentik.stages.email` - authentik Stages.Email
+ * * `authentik.stages.identification` - authentik Stages.Identification
+ * * `authentik.stages.invitation` - authentik Stages.User Invitation
+ * * `authentik.stages.password` - authentik Stages.Password
+ * * `authentik.stages.prompt` - authentik Stages.Prompt
+ * * `authentik.stages.user_delete` - authentik Stages.User Delete
+ * * `authentik.stages.user_login` - authentik Stages.User Login
+ * * `authentik.stages.user_logout` - authentik Stages.User Logout
+ * * `authentik.stages.user_write` - authentik Stages.User Write
+ * * `authentik.tenants` - authentik Tenants
+ * * `authentik.blueprints` - authentik Blueprints
+ * * `authentik.core` - authentik Core
  * @export
  */
 export const AppEnum = {
@@ -36,6 +81,7 @@ export const AppEnum = {
     ProvidersOauth2: 'authentik.providers.oauth2',
     ProvidersProxy: 'authentik.providers.proxy',
     ProvidersSaml: 'authentik.providers.saml',
+    ProvidersScim: 'authentik.providers.scim',
     Recovery: 'authentik.recovery',
     SourcesLdap: 'authentik.sources.ldap',
     SourcesOauth: 'authentik.sources.oauth',

package/src/models/Application.ts

@@ -63,7 +63,7 @@ export interface Application {
      */
     providerObj: ApplicationProviderObj;
     /**
-     * 
+     * Allow formatting of launch URL
      * @type {string}
      * @memberof Application
      */
@@ -81,7 +81,8 @@ export interface Application {
      */
     metaLaunchUrl?: string;
     /**
-     * 
+     * Get the URL to the App Icon image. If the name is /static or starts with http
+     * it is returned as-is
      * @type {string}
      * @memberof Application
      */

package/src/models/ApplicationProviderObj.ts

@@ -51,7 +51,7 @@ export interface ApplicationProviderObj {
      */
     propertyMappings?: Array<string>;
     /**
-     * 
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof ApplicationProviderObj
      */
@@ -69,19 +69,19 @@ export interface ApplicationProviderObj {
      */
     readonly assignedApplicationName: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof ApplicationProviderObj
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof ApplicationProviderObj
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof ApplicationProviderObj
      */

package/src/models/AuthTypeEnum.ts

@@ -14,7 +14,8 @@
 
 
 /**
- * 
+ * * `basic` - Basic
+ * * `bearer` - Bearer
  * @export
  */
 export const AuthTypeEnum = {

package/src/models/AuthenticateWebAuthnStage.ts

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

package/src/models/AuthenticatedSession.ts

@@ -39,7 +39,7 @@ export interface AuthenticatedSession {
      */
     uuid?: string;
     /**
-     * 
+     * Check if session is currently active session
      * @type {boolean}
      * @memberof AuthenticatedSession
      */

package/src/models/AuthenticatedSessionGeoIp.ts

@@ -14,7 +14,7 @@
 
 import { exists, mapValues } from '../runtime';
 /**
- * GeoIP Details
+ * Get parsed user agent
  * @export
  * @interface AuthenticatedSessionGeoIp
  */

package/src/models/AuthenticatedSessionUserAgent.ts

@@ -33,7 +33,7 @@ import {
 } from './AuthenticatedSessionUserAgentUserAgent';
 
 /**
- * User agent details
+ * Get parsed user agent
  * @export
  * @interface AuthenticatedSessionUserAgent
  */

package/src/models/AuthenticationEnum.ts

@@ -14,7 +14,10 @@
 
 
 /**
- * 
+ * * `none` - None
+ * * `require_authenticated` - Require Authenticated
+ * * `require_unauthenticated` - Require Unauthenticated
+ * * `require_superuser` - Require Superuser
  * @export
  */
 export const AuthenticationEnum = {

package/src/models/AuthenticatorAttachmentEnum.ts

@@ -14,7 +14,8 @@
 
 
 /**
- * 
+ * * `platform` - Platform
+ * * `cross-platform` - Cross Platform
  * @export
  */
 export const AuthenticatorAttachmentEnum = {

package/src/models/AuthenticatorDuoStage.ts

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

package/src/models/AuthenticatorSMSStage.ts

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