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

Latest commit

 

History

History
517 lines (366 loc) · 14.2 KB

EnterpriseApi.md

File metadata and controls

517 lines (366 loc) · 14.2 KB
Raw

EnterpriseApi

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

Method HTTP request Description
enterpriseLicenseCreate POST /enterprise/license/
enterpriseLicenseDestroy DELETE /enterprise/license/{license_uuid}/
enterpriseLicenseForecastRetrieve GET /enterprise/license/forecast/
enterpriseLicenseGetInstallIdRetrieve GET /enterprise/license/get_install_id/
enterpriseLicenseList GET /enterprise/license/
enterpriseLicensePartialUpdate PATCH /enterprise/license/{license_uuid}/
enterpriseLicenseRetrieve GET /enterprise/license/{license_uuid}/
enterpriseLicenseSummaryRetrieve GET /enterprise/license/summary/
enterpriseLicenseUpdate PUT /enterprise/license/{license_uuid}/
enterpriseLicenseUsedByList GET /enterprise/license/{license_uuid}/used_by/

enterpriseLicenseCreate

License enterpriseLicenseCreate(licenseRequest)

License Viewset

Example

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

val apiInstance = EnterpriseApi()
val licenseRequest : LicenseRequest =  // LicenseRequest | 
try {
    val result : License = apiInstance.enterpriseLicenseCreate(licenseRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EnterpriseApi#enterpriseLicenseCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EnterpriseApi#enterpriseLicenseCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
licenseRequest LicenseRequest

Return type

License

Authorization

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

HTTP request headers

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

enterpriseLicenseDestroy

enterpriseLicenseDestroy(licenseUuid)

License Viewset

Example

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

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

Parameters

Name Type Description Notes
licenseUuid java.util.UUID A UUID string identifying this License.

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

enterpriseLicenseForecastRetrieve

LicenseForecast enterpriseLicenseForecastRetrieve()

Forecast how many users will be required in a year

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

LicenseForecast

Authorization

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

HTTP request headers

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

enterpriseLicenseGetInstallIdRetrieve

InstallID enterpriseLicenseGetInstallIdRetrieve()

Get install_id

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

InstallID

Authorization

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

HTTP request headers

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

enterpriseLicenseList

PaginatedLicenseList enterpriseLicenseList(name, ordering, page, pageSize, search)

License Viewset

Example

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

val apiInstance = EnterpriseApi()
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 : PaginatedLicenseList = apiInstance.enterpriseLicenseList(name, ordering, page, pageSize, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EnterpriseApi#enterpriseLicenseList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EnterpriseApi#enterpriseLicenseList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
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

PaginatedLicenseList

Authorization

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

HTTP request headers

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

enterpriseLicensePartialUpdate

License enterpriseLicensePartialUpdate(licenseUuid, patchedLicenseRequest)

License Viewset

Example

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

val apiInstance = EnterpriseApi()
val licenseUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this License.
val patchedLicenseRequest : PatchedLicenseRequest =  // PatchedLicenseRequest | 
try {
    val result : License = apiInstance.enterpriseLicensePartialUpdate(licenseUuid, patchedLicenseRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EnterpriseApi#enterpriseLicensePartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EnterpriseApi#enterpriseLicensePartialUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
licenseUuid java.util.UUID A UUID string identifying this License.
patchedLicenseRequest PatchedLicenseRequest [optional]

Return type

License

Authorization

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

HTTP request headers

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

enterpriseLicenseRetrieve

License enterpriseLicenseRetrieve(licenseUuid)

License Viewset

Example

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

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

Parameters

Name Type Description Notes
licenseUuid java.util.UUID A UUID string identifying this License.

Return type

License

Authorization

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

HTTP request headers

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

enterpriseLicenseSummaryRetrieve

LicenseSummary enterpriseLicenseSummaryRetrieve()

Get the total license status

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

LicenseSummary

Authorization

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

HTTP request headers

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

enterpriseLicenseUpdate

License enterpriseLicenseUpdate(licenseUuid, licenseRequest)

License Viewset

Example

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

val apiInstance = EnterpriseApi()
val licenseUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this License.
val licenseRequest : LicenseRequest =  // LicenseRequest | 
try {
    val result : License = apiInstance.enterpriseLicenseUpdate(licenseUuid, licenseRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EnterpriseApi#enterpriseLicenseUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EnterpriseApi#enterpriseLicenseUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
licenseUuid java.util.UUID A UUID string identifying this License.
licenseRequest LicenseRequest

Return type

License

Authorization

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

HTTP request headers

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

enterpriseLicenseUsedByList

kotlin.collections.List<UsedBy> enterpriseLicenseUsedByList(licenseUuid)

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

Parameters

Name Type Description Notes
licenseUuid java.util.UUID A UUID string identifying this License.

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