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

Latest commit

 

History

History
486 lines (340 loc) · 10.9 KB

AdminApi.md

File metadata and controls

486 lines (340 loc) · 10.9 KB
Raw

AdminApi

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

Method HTTP request Description
adminAppsList GET /admin/apps/
adminMetricsRetrieve GET /admin/metrics/
adminModelsList GET /admin/models/
adminSettingsPartialUpdate PATCH /admin/settings/
adminSettingsRetrieve GET /admin/settings/
adminSettingsUpdate PUT /admin/settings/
adminSystemCreate POST /admin/system/
adminSystemRetrieve GET /admin/system/
adminVersionRetrieve GET /admin/version/
adminWorkersRetrieve GET /admin/workers/

adminAppsList

kotlin.collections.List<App> adminAppsList()

Read-only view list all installed apps

Example

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

val apiInstance = AdminApi()
try {
    val result : kotlin.collections.List<App> = apiInstance.adminAppsList()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#adminAppsList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#adminAppsList")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<App>

Authorization

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

HTTP request headers

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

adminMetricsRetrieve

LoginMetrics adminMetricsRetrieve()

Login Metrics per 1h

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

LoginMetrics

Authorization

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

HTTP request headers

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

adminModelsList

kotlin.collections.List<App> adminModelsList()

Read-only view list all installed models

Example

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

val apiInstance = AdminApi()
try {
    val result : kotlin.collections.List<App> = apiInstance.adminModelsList()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#adminModelsList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#adminModelsList")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<App>

Authorization

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

HTTP request headers

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

adminSettingsPartialUpdate

Settings adminSettingsPartialUpdate(patchedSettingsRequest)

Settings view

Example

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

val apiInstance = AdminApi()
val patchedSettingsRequest : PatchedSettingsRequest =  // PatchedSettingsRequest | 
try {
    val result : Settings = apiInstance.adminSettingsPartialUpdate(patchedSettingsRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#adminSettingsPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#adminSettingsPartialUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
patchedSettingsRequest PatchedSettingsRequest [optional]

Return type

Settings

Authorization

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

HTTP request headers

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

adminSettingsRetrieve

Settings adminSettingsRetrieve()

Settings view

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

Settings

Authorization

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

HTTP request headers

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

adminSettingsUpdate

Settings adminSettingsUpdate(settingsRequest)

Settings view

Example

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

val apiInstance = AdminApi()
val settingsRequest : SettingsRequest =  // SettingsRequest | 
try {
    val result : Settings = apiInstance.adminSettingsUpdate(settingsRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#adminSettingsUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#adminSettingsUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
settingsRequest SettingsRequest [optional]

Return type

Settings

Authorization

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

HTTP request headers

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

adminSystemCreate

SystemInfo adminSystemCreate()

Get system information.

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

SystemInfo

Authorization

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

HTTP request headers

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

adminSystemRetrieve

SystemInfo adminSystemRetrieve()

Get system information.

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

SystemInfo

Authorization

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

HTTP request headers

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

adminVersionRetrieve

Version adminVersionRetrieve()

Get running and latest version.

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

Version

Authorization

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

HTTP request headers

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

adminWorkersRetrieve

Workers adminWorkersRetrieve()

Get currently connected worker count.

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

Workers

Authorization

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

HTTP request headers

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