Skip to content
This repository has been archived by the owner on Apr 17, 2024. It is now read-only.

Latest commit

 

History

History
3328 lines (2397 loc) · 93.9 KB

CoreApi.md

File metadata and controls

3328 lines (2397 loc) · 93.9 KB
Raw

CoreApi

All URIs are relative to http://localhost/api/v3

Method HTTP request Description
coreApplicationsCheckAccessRetrieve GET /core/applications/{slug}/check_access/
coreApplicationsCreate POST /core/applications/
coreApplicationsDestroy DELETE /core/applications/{slug}/
coreApplicationsList GET /core/applications/
coreApplicationsMetricsList GET /core/applications/{slug}/metrics/
coreApplicationsPartialUpdate PATCH /core/applications/{slug}/
coreApplicationsRetrieve GET /core/applications/{slug}/
coreApplicationsSetIconCreate POST /core/applications/{slug}/set_icon/
coreApplicationsSetIconUrlCreate POST /core/applications/{slug}/set_icon_url/
coreApplicationsUpdate PUT /core/applications/{slug}/
coreApplicationsUsedByList GET /core/applications/{slug}/used_by/
coreAuthenticatedSessionsDestroy DELETE /core/authenticated_sessions/{uuid}/
coreAuthenticatedSessionsList GET /core/authenticated_sessions/
coreAuthenticatedSessionsRetrieve GET /core/authenticated_sessions/{uuid}/
coreAuthenticatedSessionsUsedByList GET /core/authenticated_sessions/{uuid}/used_by/
coreBrandsCreate POST /core/brands/
coreBrandsCurrentRetrieve GET /core/brands/current/
coreBrandsDestroy DELETE /core/brands/{brand_uuid}/
coreBrandsList GET /core/brands/
coreBrandsPartialUpdate PATCH /core/brands/{brand_uuid}/
coreBrandsRetrieve GET /core/brands/{brand_uuid}/
coreBrandsUpdate PUT /core/brands/{brand_uuid}/
coreBrandsUsedByList GET /core/brands/{brand_uuid}/used_by/
coreGroupsAddUserCreate POST /core/groups/{group_uuid}/add_user/
coreGroupsCreate POST /core/groups/
coreGroupsDestroy DELETE /core/groups/{group_uuid}/
coreGroupsList GET /core/groups/
coreGroupsPartialUpdate PATCH /core/groups/{group_uuid}/
coreGroupsRemoveUserCreate POST /core/groups/{group_uuid}/remove_user/
coreGroupsRetrieve GET /core/groups/{group_uuid}/
coreGroupsUpdate PUT /core/groups/{group_uuid}/
coreGroupsUsedByList GET /core/groups/{group_uuid}/used_by/
coreTokensCreate POST /core/tokens/
coreTokensDestroy DELETE /core/tokens/{identifier}/
coreTokensList GET /core/tokens/
coreTokensPartialUpdate PATCH /core/tokens/{identifier}/
coreTokensRetrieve GET /core/tokens/{identifier}/
coreTokensSetKeyCreate POST /core/tokens/{identifier}/set_key/
coreTokensUpdate PUT /core/tokens/{identifier}/
coreTokensUsedByList GET /core/tokens/{identifier}/used_by/
coreTokensViewKeyRetrieve GET /core/tokens/{identifier}/view_key/
coreTransactionalApplicationsUpdate PUT /core/transactional/applications/
coreUserConsentDestroy DELETE /core/user_consent/{id}/
coreUserConsentList GET /core/user_consent/
coreUserConsentRetrieve GET /core/user_consent/{id}/
coreUserConsentUsedByList GET /core/user_consent/{id}/used_by/
coreUsersCreate POST /core/users/
coreUsersDestroy DELETE /core/users/{id}/
coreUsersImpersonateCreate POST /core/users/{id}/impersonate/
coreUsersImpersonateEndRetrieve GET /core/users/impersonate_end/
coreUsersList GET /core/users/
coreUsersMeRetrieve GET /core/users/me/
coreUsersMetricsRetrieve GET /core/users/{id}/metrics/
coreUsersPartialUpdate PATCH /core/users/{id}/
coreUsersPathsRetrieve GET /core/users/paths/
coreUsersRecoveryEmailRetrieve GET /core/users/{id}/recovery_email/
coreUsersRecoveryRetrieve GET /core/users/{id}/recovery/
coreUsersRetrieve GET /core/users/{id}/
coreUsersServiceAccountCreate POST /core/users/service_account/
coreUsersSetPasswordCreate POST /core/users/{id}/set_password/
coreUsersUpdate PUT /core/users/{id}/
coreUsersUsedByList GET /core/users/{id}/used_by/

coreApplicationsCheckAccessRetrieve

PolicyTestResult coreApplicationsCheckAccessRetrieve(slug, forUser)

Check access to a single application by slug

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val slug : kotlin.String = slug_example // kotlin.String | 
val forUser : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : PolicyTestResult = apiInstance.coreApplicationsCheckAccessRetrieve(slug, forUser)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreApplicationsCheckAccessRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreApplicationsCheckAccessRetrieve")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
slug kotlin.String
forUser kotlin.Int [optional]

Return type

PolicyTestResult

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreApplicationsCreate

Application coreApplicationsCreate(applicationRequest)

Application Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val applicationRequest : ApplicationRequest =  // ApplicationRequest | 
try {
    val result : Application = apiInstance.coreApplicationsCreate(applicationRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreApplicationsCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreApplicationsCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
applicationRequest ApplicationRequest

Return type

Application

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreApplicationsDestroy

coreApplicationsDestroy(slug)

Application Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val slug : kotlin.String = slug_example // kotlin.String | 
try {
    apiInstance.coreApplicationsDestroy(slug)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreApplicationsDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreApplicationsDestroy")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
slug kotlin.String

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreApplicationsList

PaginatedApplicationList coreApplicationsList(forUser, group, metaDescription, metaLaunchUrl, metaPublisher, name, ordering, page, pageSize, search, slug, superuserFullList)

Custom list method that checks Policy based access instead of guardian

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val forUser : kotlin.Int = 56 // kotlin.Int | 
val group : kotlin.String = group_example // kotlin.String | 
val metaDescription : kotlin.String = metaDescription_example // kotlin.String | 
val metaLaunchUrl : kotlin.String = metaLaunchUrl_example // kotlin.String | 
val metaPublisher : kotlin.String = metaPublisher_example // kotlin.String | 
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
val slug : kotlin.String = slug_example // kotlin.String | 
val superuserFullList : kotlin.Boolean = true // kotlin.Boolean | 
try {
    val result : PaginatedApplicationList = apiInstance.coreApplicationsList(forUser, group, metaDescription, metaLaunchUrl, metaPublisher, name, ordering, page, pageSize, search, slug, superuserFullList)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreApplicationsList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreApplicationsList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
forUser kotlin.Int [optional]
group kotlin.String [optional]
metaDescription kotlin.String [optional]
metaLaunchUrl kotlin.String [optional]
metaPublisher kotlin.String [optional]
name kotlin.String [optional]
ordering kotlin.String Which field to use when ordering the results. [optional]
page kotlin.Int A page number within the paginated result set. [optional]
pageSize kotlin.Int Number of results to return per page. [optional]
search kotlin.String A search term. [optional]
slug kotlin.String [optional]
superuserFullList kotlin.Boolean [optional]

Return type

PaginatedApplicationList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreApplicationsMetricsList

kotlin.collections.List<Coordinate> coreApplicationsMetricsList(slug)

Metrics for application logins

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val slug : kotlin.String = slug_example // kotlin.String | 
try {
    val result : kotlin.collections.List<Coordinate> = apiInstance.coreApplicationsMetricsList(slug)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreApplicationsMetricsList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreApplicationsMetricsList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
slug kotlin.String

Return type

kotlin.collections.List<Coordinate>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreApplicationsPartialUpdate

Application coreApplicationsPartialUpdate(slug, patchedApplicationRequest)

Application Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val slug : kotlin.String = slug_example // kotlin.String | 
val patchedApplicationRequest : PatchedApplicationRequest =  // PatchedApplicationRequest | 
try {
    val result : Application = apiInstance.coreApplicationsPartialUpdate(slug, patchedApplicationRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreApplicationsPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreApplicationsPartialUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
slug kotlin.String
patchedApplicationRequest PatchedApplicationRequest [optional]

Return type

Application

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreApplicationsRetrieve

Application coreApplicationsRetrieve(slug)

Application Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val slug : kotlin.String = slug_example // kotlin.String | 
try {
    val result : Application = apiInstance.coreApplicationsRetrieve(slug)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreApplicationsRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreApplicationsRetrieve")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
slug kotlin.String

Return type

Application

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreApplicationsSetIconCreate

coreApplicationsSetIconCreate(slug, file, clear)

Set application icon

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val slug : kotlin.String = slug_example // kotlin.String | 
val file : java.io.File = BINARY_DATA_HERE // java.io.File | 
val clear : kotlin.Boolean = true // kotlin.Boolean | 
try {
    apiInstance.coreApplicationsSetIconCreate(slug, file, clear)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreApplicationsSetIconCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreApplicationsSetIconCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
slug kotlin.String
file java.io.File [optional]
clear kotlin.Boolean [optional] [default to false]

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

coreApplicationsSetIconUrlCreate

coreApplicationsSetIconUrlCreate(slug, filePathRequest)

Set application icon (as URL)

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val slug : kotlin.String = slug_example // kotlin.String | 
val filePathRequest : FilePathRequest =  // FilePathRequest | 
try {
    apiInstance.coreApplicationsSetIconUrlCreate(slug, filePathRequest)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreApplicationsSetIconUrlCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreApplicationsSetIconUrlCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
slug kotlin.String
filePathRequest FilePathRequest

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreApplicationsUpdate

Application coreApplicationsUpdate(slug, applicationRequest)

Application Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val slug : kotlin.String = slug_example // kotlin.String | 
val applicationRequest : ApplicationRequest =  // ApplicationRequest | 
try {
    val result : Application = apiInstance.coreApplicationsUpdate(slug, applicationRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreApplicationsUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreApplicationsUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
slug kotlin.String
applicationRequest ApplicationRequest

Return type

Application

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreApplicationsUsedByList

kotlin.collections.List<UsedBy> coreApplicationsUsedByList(slug)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val slug : kotlin.String = slug_example // kotlin.String | 
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.coreApplicationsUsedByList(slug)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreApplicationsUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreApplicationsUsedByList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
slug kotlin.String

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreAuthenticatedSessionsDestroy

coreAuthenticatedSessionsDestroy(uuid)

AuthenticatedSession Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Authenticated Session.
try {
    apiInstance.coreAuthenticatedSessionsDestroy(uuid)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreAuthenticatedSessionsDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreAuthenticatedSessionsDestroy")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
uuid java.util.UUID A UUID string identifying this Authenticated Session.

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreAuthenticatedSessionsList

PaginatedAuthenticatedSessionList coreAuthenticatedSessionsList(lastIp, lastUserAgent, ordering, page, pageSize, search, userUsername)

AuthenticatedSession Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val lastIp : kotlin.String = lastIp_example // kotlin.String | 
val lastUserAgent : kotlin.String = lastUserAgent_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
val userUsername : kotlin.String = userUsername_example // kotlin.String | 
try {
    val result : PaginatedAuthenticatedSessionList = apiInstance.coreAuthenticatedSessionsList(lastIp, lastUserAgent, ordering, page, pageSize, search, userUsername)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreAuthenticatedSessionsList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreAuthenticatedSessionsList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
lastIp kotlin.String [optional]
lastUserAgent kotlin.String [optional]
ordering kotlin.String Which field to use when ordering the results. [optional]
page kotlin.Int A page number within the paginated result set. [optional]
pageSize kotlin.Int Number of results to return per page. [optional]
search kotlin.String A search term. [optional]
userUsername kotlin.String [optional]

Return type

PaginatedAuthenticatedSessionList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreAuthenticatedSessionsRetrieve

AuthenticatedSession coreAuthenticatedSessionsRetrieve(uuid)

AuthenticatedSession Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Authenticated Session.
try {
    val result : AuthenticatedSession = apiInstance.coreAuthenticatedSessionsRetrieve(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreAuthenticatedSessionsRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreAuthenticatedSessionsRetrieve")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
uuid java.util.UUID A UUID string identifying this Authenticated Session.

Return type

AuthenticatedSession

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreAuthenticatedSessionsUsedByList

kotlin.collections.List<UsedBy> coreAuthenticatedSessionsUsedByList(uuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Authenticated Session.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.coreAuthenticatedSessionsUsedByList(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreAuthenticatedSessionsUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreAuthenticatedSessionsUsedByList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
uuid java.util.UUID A UUID string identifying this Authenticated Session.

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreBrandsCreate

Brand coreBrandsCreate(brandRequest)

Brand Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val brandRequest : BrandRequest =  // BrandRequest | 
try {
    val result : Brand = apiInstance.coreBrandsCreate(brandRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreBrandsCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreBrandsCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
brandRequest BrandRequest

Return type

Brand

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreBrandsCurrentRetrieve

CurrentBrand coreBrandsCurrentRetrieve()

Get current brand

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
try {
    val result : CurrentBrand = apiInstance.coreBrandsCurrentRetrieve()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreBrandsCurrentRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreBrandsCurrentRetrieve")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

CurrentBrand

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = "" Configure mobile_device_token: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreBrandsDestroy

coreBrandsDestroy(brandUuid)

Brand Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val brandUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Brand.
try {
    apiInstance.coreBrandsDestroy(brandUuid)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreBrandsDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreBrandsDestroy")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
brandUuid java.util.UUID A UUID string identifying this Brand.

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreBrandsList

PaginatedBrandList coreBrandsList(brandUuid, brandingFavicon, brandingLogo, brandingTitle, default, domain, flowAuthentication, flowDeviceCode, flowInvalidation, flowRecovery, flowUnenrollment, flowUserSettings, ordering, page, pageSize, search, webCertificate)

Brand Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val brandUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val brandingFavicon : kotlin.String = brandingFavicon_example // kotlin.String | 
val brandingLogo : kotlin.String = brandingLogo_example // kotlin.String | 
val brandingTitle : kotlin.String = brandingTitle_example // kotlin.String | 
val default : kotlin.Boolean = true // kotlin.Boolean | 
val domain : kotlin.String = domain_example // kotlin.String | 
val flowAuthentication : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val flowDeviceCode : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val flowInvalidation : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val flowRecovery : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val flowUnenrollment : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val flowUserSettings : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
val webCertificate : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
try {
    val result : PaginatedBrandList = apiInstance.coreBrandsList(brandUuid, brandingFavicon, brandingLogo, brandingTitle, default, domain, flowAuthentication, flowDeviceCode, flowInvalidation, flowRecovery, flowUnenrollment, flowUserSettings, ordering, page, pageSize, search, webCertificate)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreBrandsList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreBrandsList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
brandUuid java.util.UUID [optional]
brandingFavicon kotlin.String [optional]
brandingLogo kotlin.String [optional]
brandingTitle kotlin.String [optional]
default kotlin.Boolean [optional]
domain kotlin.String [optional]
flowAuthentication java.util.UUID [optional]
flowDeviceCode java.util.UUID [optional]
flowInvalidation java.util.UUID [optional]
flowRecovery java.util.UUID [optional]
flowUnenrollment java.util.UUID [optional]
flowUserSettings java.util.UUID [optional]
ordering kotlin.String Which field to use when ordering the results. [optional]
page kotlin.Int A page number within the paginated result set. [optional]
pageSize kotlin.Int Number of results to return per page. [optional]
search kotlin.String A search term. [optional]
webCertificate java.util.UUID [optional]

Return type

PaginatedBrandList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreBrandsPartialUpdate

Brand coreBrandsPartialUpdate(brandUuid, patchedBrandRequest)

Brand Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val brandUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Brand.
val patchedBrandRequest : PatchedBrandRequest =  // PatchedBrandRequest | 
try {
    val result : Brand = apiInstance.coreBrandsPartialUpdate(brandUuid, patchedBrandRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreBrandsPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreBrandsPartialUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
brandUuid java.util.UUID A UUID string identifying this Brand.
patchedBrandRequest PatchedBrandRequest [optional]

Return type

Brand

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreBrandsRetrieve

Brand coreBrandsRetrieve(brandUuid)

Brand Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val brandUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Brand.
try {
    val result : Brand = apiInstance.coreBrandsRetrieve(brandUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreBrandsRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreBrandsRetrieve")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
brandUuid java.util.UUID A UUID string identifying this Brand.

Return type

Brand

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreBrandsUpdate

Brand coreBrandsUpdate(brandUuid, brandRequest)

Brand Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val brandUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Brand.
val brandRequest : BrandRequest =  // BrandRequest | 
try {
    val result : Brand = apiInstance.coreBrandsUpdate(brandUuid, brandRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreBrandsUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreBrandsUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
brandUuid java.util.UUID A UUID string identifying this Brand.
brandRequest BrandRequest

Return type

Brand

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreBrandsUsedByList

kotlin.collections.List<UsedBy> coreBrandsUsedByList(brandUuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val brandUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Brand.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.coreBrandsUsedByList(brandUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreBrandsUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreBrandsUsedByList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
brandUuid java.util.UUID A UUID string identifying this Brand.

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreGroupsAddUserCreate

coreGroupsAddUserCreate(groupUuid, userAccountRequest)

Add user to group

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val groupUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Group.
val userAccountRequest : UserAccountRequest =  // UserAccountRequest | 
try {
    apiInstance.coreGroupsAddUserCreate(groupUuid, userAccountRequest)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreGroupsAddUserCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreGroupsAddUserCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
groupUuid java.util.UUID A UUID string identifying this Group.
userAccountRequest UserAccountRequest

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreGroupsCreate

Group coreGroupsCreate(groupRequest)

Group Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val groupRequest : GroupRequest =  // GroupRequest | 
try {
    val result : Group = apiInstance.coreGroupsCreate(groupRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreGroupsCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreGroupsCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
groupRequest GroupRequest

Return type

Group

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreGroupsDestroy

coreGroupsDestroy(groupUuid)

Group Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val groupUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Group.
try {
    apiInstance.coreGroupsDestroy(groupUuid)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreGroupsDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreGroupsDestroy")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
groupUuid java.util.UUID A UUID string identifying this Group.

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreGroupsList

PaginatedGroupList coreGroupsList(attributes, isSuperuser, membersByPk, membersByUsername, name, ordering, page, pageSize, search)

Group Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val attributes : kotlin.String = attributes_example // kotlin.String | Attributes
val isSuperuser : kotlin.Boolean = true // kotlin.Boolean | 
val membersByPk : kotlin.collections.List<kotlin.Int> =  // kotlin.collections.List<kotlin.Int> | 
val membersByUsername : kotlin.collections.List<kotlin.String> =  // kotlin.collections.List<kotlin.String> | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
try {
    val result : PaginatedGroupList = apiInstance.coreGroupsList(attributes, isSuperuser, membersByPk, membersByUsername, name, ordering, page, pageSize, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreGroupsList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreGroupsList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
attributes kotlin.String Attributes [optional]
isSuperuser kotlin.Boolean [optional]
membersByPk kotlin.collections.List<kotlin.Int> [optional]
membersByUsername kotlin.collections.List<kotlin.String> Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. [optional]
name kotlin.String [optional]
ordering kotlin.String Which field to use when ordering the results. [optional]
page kotlin.Int A page number within the paginated result set. [optional]
pageSize kotlin.Int Number of results to return per page. [optional]
search kotlin.String A search term. [optional]

Return type

PaginatedGroupList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreGroupsPartialUpdate

Group coreGroupsPartialUpdate(groupUuid, patchedGroupRequest)

Group Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val groupUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Group.
val patchedGroupRequest : PatchedGroupRequest =  // PatchedGroupRequest | 
try {
    val result : Group = apiInstance.coreGroupsPartialUpdate(groupUuid, patchedGroupRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreGroupsPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreGroupsPartialUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
groupUuid java.util.UUID A UUID string identifying this Group.
patchedGroupRequest PatchedGroupRequest [optional]

Return type

Group

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreGroupsRemoveUserCreate

coreGroupsRemoveUserCreate(groupUuid, userAccountRequest)

Add user to group

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val groupUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Group.
val userAccountRequest : UserAccountRequest =  // UserAccountRequest | 
try {
    apiInstance.coreGroupsRemoveUserCreate(groupUuid, userAccountRequest)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreGroupsRemoveUserCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreGroupsRemoveUserCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
groupUuid java.util.UUID A UUID string identifying this Group.
userAccountRequest UserAccountRequest

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreGroupsRetrieve

Group coreGroupsRetrieve(groupUuid)

Group Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val groupUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Group.
try {
    val result : Group = apiInstance.coreGroupsRetrieve(groupUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreGroupsRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreGroupsRetrieve")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
groupUuid java.util.UUID A UUID string identifying this Group.

Return type

Group

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreGroupsUpdate

Group coreGroupsUpdate(groupUuid, groupRequest)

Group Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val groupUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Group.
val groupRequest : GroupRequest =  // GroupRequest | 
try {
    val result : Group = apiInstance.coreGroupsUpdate(groupUuid, groupRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreGroupsUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreGroupsUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
groupUuid java.util.UUID A UUID string identifying this Group.
groupRequest GroupRequest

Return type

Group

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreGroupsUsedByList

kotlin.collections.List<UsedBy> coreGroupsUsedByList(groupUuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val groupUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Group.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.coreGroupsUsedByList(groupUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreGroupsUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreGroupsUsedByList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
groupUuid java.util.UUID A UUID string identifying this Group.

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreTokensCreate

Token coreTokensCreate(tokenRequest)

Token Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val tokenRequest : TokenRequest =  // TokenRequest | 
try {
    val result : Token = apiInstance.coreTokensCreate(tokenRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreTokensCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreTokensCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
tokenRequest TokenRequest

Return type

Token

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreTokensDestroy

coreTokensDestroy(identifier)

Token Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val identifier : kotlin.String = identifier_example // kotlin.String | 
try {
    apiInstance.coreTokensDestroy(identifier)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreTokensDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreTokensDestroy")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
identifier kotlin.String

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreTokensList

PaginatedTokenList coreTokensList(description, expires, expiring, identifier, intent, managed, ordering, page, pageSize, search, userUsername)

Token Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val description : kotlin.String = description_example // kotlin.String | 
val expires : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | 
val expiring : kotlin.Boolean = true // kotlin.Boolean | 
val identifier : kotlin.String = identifier_example // kotlin.String | 
val intent : kotlin.String = intent_example // kotlin.String | * `verification` - Intent Verification * `api` - Intent Api * `recovery` - Intent Recovery * `app_password` - Intent App Password
val managed : kotlin.String = managed_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
val userUsername : kotlin.String = userUsername_example // kotlin.String | 
try {
    val result : PaginatedTokenList = apiInstance.coreTokensList(description, expires, expiring, identifier, intent, managed, ordering, page, pageSize, search, userUsername)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreTokensList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreTokensList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
description kotlin.String [optional]
expires java.time.OffsetDateTime [optional]
expiring kotlin.Boolean [optional]
identifier kotlin.String [optional]
intent kotlin.String * `verification` - Intent Verification * `api` - Intent Api * `recovery` - Intent Recovery * `app_password` - Intent App Password [optional] [enum: api, app_password, recovery, verification]
managed kotlin.String [optional]
ordering kotlin.String Which field to use when ordering the results. [optional]
page kotlin.Int A page number within the paginated result set. [optional]
pageSize kotlin.Int Number of results to return per page. [optional]
search kotlin.String A search term. [optional]
userUsername kotlin.String [optional]

Return type

PaginatedTokenList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreTokensPartialUpdate

Token coreTokensPartialUpdate(identifier, patchedTokenRequest)

Token Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val identifier : kotlin.String = identifier_example // kotlin.String | 
val patchedTokenRequest : PatchedTokenRequest =  // PatchedTokenRequest | 
try {
    val result : Token = apiInstance.coreTokensPartialUpdate(identifier, patchedTokenRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreTokensPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreTokensPartialUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
identifier kotlin.String
patchedTokenRequest PatchedTokenRequest [optional]

Return type

Token

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreTokensRetrieve

Token coreTokensRetrieve(identifier)

Token Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val identifier : kotlin.String = identifier_example // kotlin.String | 
try {
    val result : Token = apiInstance.coreTokensRetrieve(identifier)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreTokensRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreTokensRetrieve")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
identifier kotlin.String

Return type

Token

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreTokensSetKeyCreate

coreTokensSetKeyCreate(identifier, tokenSetKeyRequest)

Set token key. Action is logged as event. `authentik_core.set_token_key` permission is required.

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val identifier : kotlin.String = identifier_example // kotlin.String | 
val tokenSetKeyRequest : TokenSetKeyRequest =  // TokenSetKeyRequest | 
try {
    apiInstance.coreTokensSetKeyCreate(identifier, tokenSetKeyRequest)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreTokensSetKeyCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreTokensSetKeyCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
identifier kotlin.String
tokenSetKeyRequest TokenSetKeyRequest

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreTokensUpdate

Token coreTokensUpdate(identifier, tokenRequest)

Token Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val identifier : kotlin.String = identifier_example // kotlin.String | 
val tokenRequest : TokenRequest =  // TokenRequest | 
try {
    val result : Token = apiInstance.coreTokensUpdate(identifier, tokenRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreTokensUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreTokensUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
identifier kotlin.String
tokenRequest TokenRequest

Return type

Token

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreTokensUsedByList

kotlin.collections.List<UsedBy> coreTokensUsedByList(identifier)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val identifier : kotlin.String = identifier_example // kotlin.String | 
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.coreTokensUsedByList(identifier)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreTokensUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreTokensUsedByList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
identifier kotlin.String

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreTokensViewKeyRetrieve

TokenView coreTokensViewKeyRetrieve(identifier)

Return token key and log access

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val identifier : kotlin.String = identifier_example // kotlin.String | 
try {
    val result : TokenView = apiInstance.coreTokensViewKeyRetrieve(identifier)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreTokensViewKeyRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreTokensViewKeyRetrieve")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
identifier kotlin.String

Return type

TokenView

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreTransactionalApplicationsUpdate

TransactionApplicationResponse coreTransactionalApplicationsUpdate(transactionApplicationRequest)

Convert data into a blueprint, validate it and apply it

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val transactionApplicationRequest : TransactionApplicationRequest =  // TransactionApplicationRequest | 
try {
    val result : TransactionApplicationResponse = apiInstance.coreTransactionalApplicationsUpdate(transactionApplicationRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreTransactionalApplicationsUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreTransactionalApplicationsUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
transactionApplicationRequest TransactionApplicationRequest

Return type

TransactionApplicationResponse

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreUserConsentDestroy

coreUserConsentDestroy(id)

UserConsent Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this User Consent.
try {
    apiInstance.coreUserConsentDestroy(id)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUserConsentDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUserConsentDestroy")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.Int A unique integer value identifying this User Consent.

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreUserConsentList

PaginatedUserConsentList coreUserConsentList(application, ordering, page, pageSize, search, user)

UserConsent Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val application : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
val user : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : PaginatedUserConsentList = apiInstance.coreUserConsentList(application, ordering, page, pageSize, search, user)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUserConsentList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUserConsentList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
application java.util.UUID [optional]
ordering kotlin.String Which field to use when ordering the results. [optional]
page kotlin.Int A page number within the paginated result set. [optional]
pageSize kotlin.Int Number of results to return per page. [optional]
search kotlin.String A search term. [optional]
user kotlin.Int [optional]

Return type

PaginatedUserConsentList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreUserConsentRetrieve

UserConsent coreUserConsentRetrieve(id)

UserConsent Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this User Consent.
try {
    val result : UserConsent = apiInstance.coreUserConsentRetrieve(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUserConsentRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUserConsentRetrieve")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.Int A unique integer value identifying this User Consent.

Return type

UserConsent

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreUserConsentUsedByList

kotlin.collections.List<UsedBy> coreUserConsentUsedByList(id)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this User Consent.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.coreUserConsentUsedByList(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUserConsentUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUserConsentUsedByList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.Int A unique integer value identifying this User Consent.

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreUsersCreate

User coreUsersCreate(userRequest)

User Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val userRequest : UserRequest =  // UserRequest | 
try {
    val result : User = apiInstance.coreUsersCreate(userRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUsersCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUsersCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
userRequest UserRequest

Return type

User

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreUsersDestroy

coreUsersDestroy(id)

User Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this User.
try {
    apiInstance.coreUsersDestroy(id)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUsersDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUsersDestroy")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.Int A unique integer value identifying this User.

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreUsersImpersonateCreate

coreUsersImpersonateCreate(id)

Impersonate a user

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this User.
try {
    apiInstance.coreUsersImpersonateCreate(id)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUsersImpersonateCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUsersImpersonateCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.Int A unique integer value identifying this User.

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreUsersImpersonateEndRetrieve

coreUsersImpersonateEndRetrieve()

End Impersonation a user

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
try {
    apiInstance.coreUsersImpersonateEndRetrieve()
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUsersImpersonateEndRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUsersImpersonateEndRetrieve")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreUsersList

PaginatedUserList coreUsersList(attributes, email, groupsByName, groupsByPk, isActive, isSuperuser, name, ordering, page, pageSize, path, pathStartswith, search, type, username, uuid)

User Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val attributes : kotlin.String = attributes_example // kotlin.String | Attributes
val email : kotlin.String = email_example // kotlin.String | 
val groupsByName : kotlin.collections.List<kotlin.String> =  // kotlin.collections.List<kotlin.String> | 
val groupsByPk : kotlin.collections.List<java.util.UUID> =  // kotlin.collections.List<java.util.UUID> | 
val isActive : kotlin.Boolean = true // kotlin.Boolean | 
val isSuperuser : kotlin.Boolean = true // kotlin.Boolean | 
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val path : kotlin.String = path_example // kotlin.String | 
val pathStartswith : kotlin.String = pathStartswith_example // kotlin.String | 
val search : kotlin.String = search_example // kotlin.String | A search term.
val type : kotlin.collections.List<kotlin.String> =  // kotlin.collections.List<kotlin.String> | * `internal` - Internal * `external` - External * `service_account` - Service Account * `internal_service_account` - Internal Service Account
val username : kotlin.String = username_example // kotlin.String | 
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
try {
    val result : PaginatedUserList = apiInstance.coreUsersList(attributes, email, groupsByName, groupsByPk, isActive, isSuperuser, name, ordering, page, pageSize, path, pathStartswith, search, type, username, uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUsersList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUsersList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
attributes kotlin.String Attributes [optional]
email kotlin.String [optional]
groupsByName kotlin.collections.List<kotlin.String> [optional]
groupsByPk kotlin.collections.List<java.util.UUID> [optional]
isActive kotlin.Boolean [optional]
isSuperuser kotlin.Boolean [optional]
name kotlin.String [optional]
ordering kotlin.String Which field to use when ordering the results. [optional]
page kotlin.Int A page number within the paginated result set. [optional]
pageSize kotlin.Int Number of results to return per page. [optional]
path kotlin.String [optional]
pathStartswith kotlin.String [optional]
search kotlin.String A search term. [optional]
type kotlin.collections.List<kotlin.String> * `internal` - Internal * `external` - External * `service_account` - Service Account * `internal_service_account` - Internal Service Account [optional] [enum: external, internal, internal_service_account, service_account]
username kotlin.String [optional]
uuid java.util.UUID [optional]

Return type

PaginatedUserList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreUsersMeRetrieve

SessionUser coreUsersMeRetrieve()

Get information about current user

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
try {
    val result : SessionUser = apiInstance.coreUsersMeRetrieve()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUsersMeRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUsersMeRetrieve")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

SessionUser

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = "" Configure mobile_device_token: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreUsersMetricsRetrieve

UserMetrics coreUsersMetricsRetrieve(id)

User metrics per 1h

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this User.
try {
    val result : UserMetrics = apiInstance.coreUsersMetricsRetrieve(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUsersMetricsRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUsersMetricsRetrieve")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.Int A unique integer value identifying this User.

Return type

UserMetrics

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreUsersPartialUpdate

User coreUsersPartialUpdate(id, patchedUserRequest)

User Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this User.
val patchedUserRequest : PatchedUserRequest =  // PatchedUserRequest | 
try {
    val result : User = apiInstance.coreUsersPartialUpdate(id, patchedUserRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUsersPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUsersPartialUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.Int A unique integer value identifying this User.
patchedUserRequest PatchedUserRequest [optional]

Return type

User

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreUsersPathsRetrieve

UserPath coreUsersPathsRetrieve(search)

Get all user paths

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val search : kotlin.String = search_example // kotlin.String | 
try {
    val result : UserPath = apiInstance.coreUsersPathsRetrieve(search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUsersPathsRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUsersPathsRetrieve")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
search kotlin.String [optional]

Return type

UserPath

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreUsersRecoveryEmailRetrieve

coreUsersRecoveryEmailRetrieve(id, emailStage)

Create a temporary link that a user can use to recover their accounts

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this User.
val emailStage : kotlin.String = emailStage_example // kotlin.String | 
try {
    apiInstance.coreUsersRecoveryEmailRetrieve(id, emailStage)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUsersRecoveryEmailRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUsersRecoveryEmailRetrieve")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.Int A unique integer value identifying this User.
emailStage kotlin.String

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreUsersRecoveryRetrieve

Link coreUsersRecoveryRetrieve(id)

Create a temporary link that a user can use to recover their accounts

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this User.
try {
    val result : Link = apiInstance.coreUsersRecoveryRetrieve(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUsersRecoveryRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUsersRecoveryRetrieve")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.Int A unique integer value identifying this User.

Return type

Link

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreUsersRetrieve

User coreUsersRetrieve(id)

User Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this User.
try {
    val result : User = apiInstance.coreUsersRetrieve(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUsersRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUsersRetrieve")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.Int A unique integer value identifying this User.

Return type

User

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

coreUsersServiceAccountCreate

UserServiceAccountResponse coreUsersServiceAccountCreate(userServiceAccountRequest)

Create a new user account that is marked as a service account

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val userServiceAccountRequest : UserServiceAccountRequest =  // UserServiceAccountRequest | 
try {
    val result : UserServiceAccountResponse = apiInstance.coreUsersServiceAccountCreate(userServiceAccountRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUsersServiceAccountCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUsersServiceAccountCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
userServiceAccountRequest UserServiceAccountRequest

Return type

UserServiceAccountResponse

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreUsersSetPasswordCreate

coreUsersSetPasswordCreate(id, userPasswordSetRequest)

Set password for user

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this User.
val userPasswordSetRequest : UserPasswordSetRequest =  // UserPasswordSetRequest | 
try {
    apiInstance.coreUsersSetPasswordCreate(id, userPasswordSetRequest)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUsersSetPasswordCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUsersSetPasswordCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.Int A unique integer value identifying this User.
userPasswordSetRequest UserPasswordSetRequest

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreUsersUpdate

User coreUsersUpdate(id, userRequest)

User Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this User.
val userRequest : UserRequest =  // UserRequest | 
try {
    val result : User = apiInstance.coreUsersUpdate(id, userRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUsersUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUsersUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.Int A unique integer value identifying this User.
userRequest UserRequest

Return type

User

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

coreUsersUsedByList

kotlin.collections.List<UsedBy> coreUsersUsedByList(id)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = CoreApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this User.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.coreUsersUsedByList(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CoreApi#coreUsersUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CoreApi#coreUsersUsedByList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.Int A unique integer value identifying this User.

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json