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

Latest commit

 

History

History
476 lines (310 loc) · 11.6 KB

AdminAPI.md

File metadata and controls

476 lines (310 loc) · 11.6 KB

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

    open class func adminAppsList(completion: @escaping (_ data: [App]?, _ error: Error?) -> Void)

Read-only view list all installed apps

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient


AdminAPI.adminAppsList() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

[App]

Authorization

authentik

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

adminMetricsRetrieve

    open class func adminMetricsRetrieve(completion: @escaping (_ data: LoginMetrics?, _ error: Error?) -> Void)

Login Metrics per 1h

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient


AdminAPI.adminMetricsRetrieve() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

LoginMetrics

Authorization

authentik

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

adminModelsList

    open class func adminModelsList(completion: @escaping (_ data: [App]?, _ error: Error?) -> Void)

Read-only view list all installed models

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient


AdminAPI.adminModelsList() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

[App]

Authorization

authentik

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

adminSettingsPartialUpdate

    open class func adminSettingsPartialUpdate(patchedSettingsRequest: PatchedSettingsRequest? = nil, completion: @escaping (_ data: Settings?, _ error: Error?) -> Void)

Settings view

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let patchedSettingsRequest = PatchedSettingsRequest(avatars: "avatars_example", defaultUserChangeName: false, defaultUserChangeEmail: false, defaultUserChangeUsername: false, eventRetention: "eventRetention_example", footerLinks: "TODO", gdprCompliance: false, impersonation: false) // PatchedSettingsRequest |  (optional)

AdminAPI.adminSettingsPartialUpdate(patchedSettingsRequest: patchedSettingsRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
patchedSettingsRequest PatchedSettingsRequest [optional]

Return type

Settings

Authorization

authentik

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

adminSettingsRetrieve

    open class func adminSettingsRetrieve(completion: @escaping (_ data: Settings?, _ error: Error?) -> Void)

Settings view

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient


AdminAPI.adminSettingsRetrieve() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Settings

Authorization

authentik

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

adminSettingsUpdate

    open class func adminSettingsUpdate(settingsRequest: SettingsRequest? = nil, completion: @escaping (_ data: Settings?, _ error: Error?) -> Void)

Settings view

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let settingsRequest = SettingsRequest(avatars: "avatars_example", defaultUserChangeName: false, defaultUserChangeEmail: false, defaultUserChangeUsername: false, eventRetention: "eventRetention_example", footerLinks: "TODO", gdprCompliance: false, impersonation: false) // SettingsRequest |  (optional)

AdminAPI.adminSettingsUpdate(settingsRequest: settingsRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
settingsRequest SettingsRequest [optional]

Return type

Settings

Authorization

authentik

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

adminSystemCreate

    open class func adminSystemCreate(completion: @escaping (_ data: SystemInfo?, _ error: Error?) -> Void)

Get system information.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient


AdminAPI.adminSystemCreate() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

SystemInfo

Authorization

authentik

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

adminSystemRetrieve

    open class func adminSystemRetrieve(completion: @escaping (_ data: SystemInfo?, _ error: Error?) -> Void)

Get system information.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient


AdminAPI.adminSystemRetrieve() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

SystemInfo

Authorization

authentik

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

adminVersionRetrieve

    open class func adminVersionRetrieve(completion: @escaping (_ data: Version?, _ error: Error?) -> Void)

Get running and latest version.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient


AdminAPI.adminVersionRetrieve() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Version

Authorization

authentik

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

adminWorkersRetrieve

    open class func adminWorkersRetrieve(completion: @escaping (_ data: Workers?, _ error: Error?) -> Void)

Get currently connected worker count.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient


AdminAPI.adminWorkersRetrieve() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Workers

Authorization

authentik

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]