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

Latest commit

 

History

History
508 lines (337 loc) · 14.2 KB

EnterpriseAPI.md

File metadata and controls

508 lines (337 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

    open class func enterpriseLicenseCreate(licenseRequest: LicenseRequest, completion: @escaping (_ data: License?, _ error: Error?) -> Void)

License Viewset

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 licenseRequest = LicenseRequest(key: "key_example") // LicenseRequest | 

EnterpriseAPI.enterpriseLicenseCreate(licenseRequest: licenseRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
licenseRequest LicenseRequest

Return type

License

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]

enterpriseLicenseDestroy

    open class func enterpriseLicenseDestroy(licenseUuid: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

License Viewset

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 licenseUuid = 987 // UUID | A UUID string identifying this License.

EnterpriseAPI.enterpriseLicenseDestroy(licenseUuid: licenseUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

Return type

Void (empty response body)

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]

enterpriseLicenseForecastRetrieve

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

Forecast how many users will be required in a year

Example

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


EnterpriseAPI.enterpriseLicenseForecastRetrieve() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

LicenseForecast

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]

enterpriseLicenseGetInstallIdRetrieve

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

Get install_id

Example

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


EnterpriseAPI.enterpriseLicenseGetInstallIdRetrieve() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

InstallID

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]

enterpriseLicenseList

    open class func enterpriseLicenseList(name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedLicenseList?, _ error: Error?) -> Void)

License Viewset

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 name = "name_example" // String |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let search = "search_example" // String | A search term. (optional)

EnterpriseAPI.enterpriseLicenseList(name: name, ordering: ordering, page: page, pageSize: pageSize, search: search) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

Return type

PaginatedLicenseList

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]

enterpriseLicensePartialUpdate

    open class func enterpriseLicensePartialUpdate(licenseUuid: UUID, patchedLicenseRequest: PatchedLicenseRequest? = nil, completion: @escaping (_ data: License?, _ error: Error?) -> Void)

License Viewset

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 licenseUuid = 987 // UUID | A UUID string identifying this License.
let patchedLicenseRequest = PatchedLicenseRequest(key: "key_example") // PatchedLicenseRequest |  (optional)

EnterpriseAPI.enterpriseLicensePartialUpdate(licenseUuid: licenseUuid, patchedLicenseRequest: patchedLicenseRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

Return type

License

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]

enterpriseLicenseRetrieve

    open class func enterpriseLicenseRetrieve(licenseUuid: UUID, completion: @escaping (_ data: License?, _ error: Error?) -> Void)

License Viewset

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 licenseUuid = 987 // UUID | A UUID string identifying this License.

EnterpriseAPI.enterpriseLicenseRetrieve(licenseUuid: licenseUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

Return type

License

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]

enterpriseLicenseSummaryRetrieve

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

Get the total license status

Example

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


EnterpriseAPI.enterpriseLicenseSummaryRetrieve() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

LicenseSummary

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]

enterpriseLicenseUpdate

    open class func enterpriseLicenseUpdate(licenseUuid: UUID, licenseRequest: LicenseRequest, completion: @escaping (_ data: License?, _ error: Error?) -> Void)

License Viewset

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 licenseUuid = 987 // UUID | A UUID string identifying this License.
let licenseRequest = LicenseRequest(key: "key_example") // LicenseRequest | 

EnterpriseAPI.enterpriseLicenseUpdate(licenseUuid: licenseUuid, licenseRequest: licenseRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

Return type

License

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]

enterpriseLicenseUsedByList

    open class func enterpriseLicenseUsedByList(licenseUuid: UUID, completion: @escaping (_ data: [UsedBy]?, _ error: Error?) -> Void)

Get a list of all objects that use this object

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 licenseUuid = 987 // UUID | A UUID string identifying this License.

EnterpriseAPI.enterpriseLicenseUsedByList(licenseUuid: licenseUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

Return type

[UsedBy]

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]