@goauthentik/api 2026.2.0-rc1-1766432129 → 2026.2.0-rc1-1766493698

package/docs/Token.md

@@ -0,0 +1,51 @@
+
+# Token
+
+Token Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`managed` | string
+`identifier` | string
+`intent` | [IntentEnum](IntentEnum.md)
+`user` | number
+`userObj` | [User](User.md)
+`description` | string
+`expires` | Date
+`expiring` | boolean
+
+## Example
+
+```typescript
+import type { Token } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "managed": null,
+  "identifier": null,
+  "intent": null,
+  "user": null,
+  "userObj": null,
+  "description": null,
+  "expires": null,
+  "expiring": null,
+} satisfies Token
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Token
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TokenModel.md

@@ -0,0 +1,49 @@
+
+# TokenModel
+
+Serializer for BaseGrantModel and RefreshToken
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | number
+`provider` | [OAuth2Provider](OAuth2Provider.md)
+`user` | [User](User.md)
+`isExpired` | boolean
+`expires` | Date
+`scope` | Array<string>
+`idToken` | string
+`revoked` | boolean
+
+## Example
+
+```typescript
+import type { TokenModel } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "provider": null,
+  "user": null,
+  "isExpired": null,
+  "expires": null,
+  "scope": null,
+  "idToken": null,
+  "revoked": null,
+} satisfies TokenModel
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TokenModel
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TokenRequest.md

@@ -0,0 +1,47 @@
+
+# TokenRequest
+
+Token Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`managed` | string
+`identifier` | string
+`intent` | [IntentEnum](IntentEnum.md)
+`user` | number
+`description` | string
+`expires` | Date
+`expiring` | boolean
+
+## Example
+
+```typescript
+import type { TokenRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "managed": null,
+  "identifier": null,
+  "intent": null,
+  "user": null,
+  "description": null,
+  "expires": null,
+  "expiring": null,
+} satisfies TokenRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TokenRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TokenSetKeyRequest.md

@@ -0,0 +1,35 @@
+
+# TokenSetKeyRequest
+
+Set token\'s key
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+
+## Example
+
+```typescript
+import type { TokenSetKeyRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+} satisfies TokenSetKeyRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TokenSetKeyRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TokenView.md

@@ -0,0 +1,35 @@
+
+# TokenView
+
+Show token\'s current key
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+
+## Example
+
+```typescript
+import type { TokenView } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+} satisfies TokenView
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TokenView
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TransactionApplicationRequest.md

@@ -0,0 +1,41 @@
+
+# TransactionApplicationRequest
+
+Serializer for creating a provider and an application in one transaction
+
+## Properties
+
+Name | Type
+------------ | -------------
+`app` | [ApplicationRequest](ApplicationRequest.md)
+`providerModel` | [ProviderModelEnum](ProviderModelEnum.md)
+`provider` | [ModelRequest](ModelRequest.md)
+`policyBindings` | [Array<TransactionPolicyBindingRequest>](TransactionPolicyBindingRequest.md)
+
+## Example
+
+```typescript
+import type { TransactionApplicationRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "app": null,
+  "providerModel": null,
+  "provider": null,
+  "policyBindings": null,
+} satisfies TransactionApplicationRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TransactionApplicationRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TransactionApplicationResponse.md

@@ -0,0 +1,37 @@
+
+# TransactionApplicationResponse
+
+Transactional creation response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`applied` | boolean
+`logs` | Array<string>
+
+## Example
+
+```typescript
+import type { TransactionApplicationResponse } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "applied": null,
+  "logs": null,
+} satisfies TransactionApplicationResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TransactionApplicationResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TransactionPolicyBindingRequest.md

@@ -0,0 +1,49 @@
+
+# TransactionPolicyBindingRequest
+
+PolicyBindingSerializer which does not require target as target is set implicitly
+
+## Properties
+
+Name | Type
+------------ | -------------
+`policy` | string
+`group` | string
+`user` | number
+`negate` | boolean
+`enabled` | boolean
+`order` | number
+`timeout` | number
+`failureResult` | boolean
+
+## Example
+
+```typescript
+import type { TransactionPolicyBindingRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "policy": null,
+  "group": null,
+  "user": null,
+  "negate": null,
+  "enabled": null,
+  "order": null,
+  "timeout": null,
+  "failureResult": null,
+} satisfies TransactionPolicyBindingRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TransactionPolicyBindingRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TypeCreate.md

@@ -0,0 +1,47 @@
+
+# TypeCreate
+
+Types of an object that can be created
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`component` | string
+`modelName` | string
+`iconUrl` | string
+`requiresEnterprise` | boolean
+`deprecated` | boolean
+
+## Example
+
+```typescript
+import type { TypeCreate } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "component": null,
+  "modelName": null,
+  "iconUrl": null,
+  "requiresEnterprise": null,
+  "deprecated": null,
+} satisfies TypeCreate
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TypeCreate
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/UiThemeEnum.md

@@ -0,0 +1,32 @@
+
+# UiThemeEnum
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { UiThemeEnum } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies UiThemeEnum
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UiThemeEnum
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/UniquePasswordPolicy.md

@@ -0,0 +1,53 @@
+
+# UniquePasswordPolicy
+
+Password Uniqueness Policy Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`executionLogging` | boolean
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`boundTo` | number
+`passwordField` | string
+`numHistoricalPasswords` | number
+
+## Example
+
+```typescript
+import type { UniquePasswordPolicy } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "name": null,
+  "executionLogging": null,
+  "component": null,
+  "verboseName": null,
+  "verboseNamePlural": null,
+  "metaModelName": null,
+  "boundTo": null,
+  "passwordField": null,
+  "numHistoricalPasswords": null,
+} satisfies UniquePasswordPolicy
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UniquePasswordPolicy
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/UniquePasswordPolicyRequest.md

@@ -0,0 +1,41 @@
+
+# UniquePasswordPolicyRequest
+
+Password Uniqueness Policy Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`executionLogging` | boolean
+`passwordField` | string
+`numHistoricalPasswords` | number
+
+## Example
+
+```typescript
+import type { UniquePasswordPolicyRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "executionLogging": null,
+  "passwordField": null,
+  "numHistoricalPasswords": null,
+} satisfies UniquePasswordPolicyRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UniquePasswordPolicyRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/UsedBy.md

@@ -0,0 +1,43 @@
+
+# UsedBy
+
+A list of all objects referencing the queried object
+
+## Properties
+
+Name | Type
+------------ | -------------
+`app` | string
+`modelName` | string
+`pk` | string
+`name` | string
+`action` | [UsedByActionEnum](UsedByActionEnum.md)
+
+## Example
+
+```typescript
+import type { UsedBy } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "app": null,
+  "modelName": null,
+  "pk": null,
+  "name": null,
+  "action": null,
+} satisfies UsedBy
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UsedBy
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/UsedByActionEnum.md

@@ -0,0 +1,32 @@
+
+# UsedByActionEnum
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { UsedByActionEnum } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies UsedByActionEnum
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UsedByActionEnum
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/User.md

@@ -0,0 +1,73 @@
+
+# User
+
+User Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | number
+`username` | string
+`name` | string
+`isActive` | boolean
+`lastLogin` | Date
+`dateJoined` | Date
+`isSuperuser` | boolean
+`groups` | Array<string>
+`groupsObj` | [Array<PartialGroup>](PartialGroup.md)
+`roles` | Array<string>
+`rolesObj` | [Array<Role>](Role.md)
+`email` | string
+`avatar` | string
+`attributes` | { [key: string]: any; }
+`uid` | string
+`path` | string
+`type` | [UserTypeEnum](UserTypeEnum.md)
+`uuid` | string
+`passwordChangeDate` | Date
+`lastUpdated` | Date
+
+## Example
+
+```typescript
+import type { User } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "username": null,
+  "name": null,
+  "isActive": null,
+  "lastLogin": null,
+  "dateJoined": null,
+  "isSuperuser": null,
+  "groups": null,
+  "groupsObj": null,
+  "roles": null,
+  "rolesObj": null,
+  "email": null,
+  "avatar": null,
+  "attributes": null,
+  "uid": null,
+  "path": null,
+  "type": null,
+  "uuid": null,
+  "passwordChangeDate": null,
+  "lastUpdated": null,
+} satisfies User
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as User
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+