Skip to content

Latest commit

 

History

History
698 lines (433 loc) · 18.9 KB

EnterpriseApi.md

File metadata and controls

698 lines (433 loc) · 18.9 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/
EnterpriseLicenseInstallIdRetrieve Get /enterprise/license/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(ctx).LicenseRequest(licenseRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    licenseRequest := *openapiclient.NewLicenseRequest("Key_example") // LicenseRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EnterpriseApi.EnterpriseLicenseCreate(context.Background()).LicenseRequest(licenseRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EnterpriseApi.EnterpriseLicenseCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EnterpriseLicenseCreate`: License
    fmt.Fprintf(os.Stdout, "Response from `EnterpriseApi.EnterpriseLicenseCreate`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiEnterpriseLicenseCreateRequest struct via the builder pattern

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

EnterpriseLicenseDestroy(ctx, licenseUuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    licenseUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this License.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EnterpriseApi.EnterpriseLicenseDestroy(context.Background(), licenseUuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EnterpriseApi.EnterpriseLicenseDestroy``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
licenseUuid string A UUID string identifying this License.

Other Parameters

Other parameters are passed through a pointer to a apiEnterpriseLicenseDestroyRequest struct via the builder pattern

Name Type Description Notes

Return type

(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

LicenseForecast EnterpriseLicenseForecastRetrieve(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EnterpriseApi.EnterpriseLicenseForecastRetrieve(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EnterpriseApi.EnterpriseLicenseForecastRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EnterpriseLicenseForecastRetrieve`: LicenseForecast
    fmt.Fprintf(os.Stdout, "Response from `EnterpriseApi.EnterpriseLicenseForecastRetrieve`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiEnterpriseLicenseForecastRetrieveRequest struct via the builder pattern

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]

EnterpriseLicenseInstallIdRetrieve

InstallID EnterpriseLicenseInstallIdRetrieve(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EnterpriseApi.EnterpriseLicenseInstallIdRetrieve(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EnterpriseApi.EnterpriseLicenseInstallIdRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EnterpriseLicenseInstallIdRetrieve`: InstallID
    fmt.Fprintf(os.Stdout, "Response from `EnterpriseApi.EnterpriseLicenseInstallIdRetrieve`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiEnterpriseLicenseInstallIdRetrieveRequest struct via the builder pattern

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

PaginatedLicenseList EnterpriseLicenseList(ctx).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    name := "name_example" // string |  (optional)
    ordering := "ordering_example" // string | Which field to use when ordering the results. (optional)
    page := int32(56) // int32 | A page number within the paginated result set. (optional)
    pageSize := int32(56) // int32 | Number of results to return per page. (optional)
    search := "search_example" // string | A search term. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EnterpriseApi.EnterpriseLicenseList(context.Background()).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EnterpriseApi.EnterpriseLicenseList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EnterpriseLicenseList`: PaginatedLicenseList
    fmt.Fprintf(os.Stdout, "Response from `EnterpriseApi.EnterpriseLicenseList`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiEnterpriseLicenseListRequest struct via the builder pattern

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

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

License EnterpriseLicensePartialUpdate(ctx, licenseUuid).PatchedLicenseRequest(patchedLicenseRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    licenseUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this License.
    patchedLicenseRequest := *openapiclient.NewPatchedLicenseRequest() // PatchedLicenseRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EnterpriseApi.EnterpriseLicensePartialUpdate(context.Background(), licenseUuid).PatchedLicenseRequest(patchedLicenseRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EnterpriseApi.EnterpriseLicensePartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EnterpriseLicensePartialUpdate`: License
    fmt.Fprintf(os.Stdout, "Response from `EnterpriseApi.EnterpriseLicensePartialUpdate`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
licenseUuid string A UUID string identifying this License.

Other Parameters

Other parameters are passed through a pointer to a apiEnterpriseLicensePartialUpdateRequest struct via the builder pattern

Name Type Description Notes

patchedLicenseRequest | PatchedLicenseRequest | |

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

License EnterpriseLicenseRetrieve(ctx, licenseUuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    licenseUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this License.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EnterpriseApi.EnterpriseLicenseRetrieve(context.Background(), licenseUuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EnterpriseApi.EnterpriseLicenseRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EnterpriseLicenseRetrieve`: License
    fmt.Fprintf(os.Stdout, "Response from `EnterpriseApi.EnterpriseLicenseRetrieve`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
licenseUuid string A UUID string identifying this License.

Other Parameters

Other parameters are passed through a pointer to a apiEnterpriseLicenseRetrieveRequest struct via the builder pattern

Name Type Description Notes

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

LicenseSummary EnterpriseLicenseSummaryRetrieve(ctx).Cached(cached).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cached := true // bool |  (optional) (default to true)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EnterpriseApi.EnterpriseLicenseSummaryRetrieve(context.Background()).Cached(cached).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EnterpriseApi.EnterpriseLicenseSummaryRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EnterpriseLicenseSummaryRetrieve`: LicenseSummary
    fmt.Fprintf(os.Stdout, "Response from `EnterpriseApi.EnterpriseLicenseSummaryRetrieve`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiEnterpriseLicenseSummaryRetrieveRequest struct via the builder pattern

Name Type Description Notes
cached bool [default to true]

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

License EnterpriseLicenseUpdate(ctx, licenseUuid).LicenseRequest(licenseRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    licenseUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this License.
    licenseRequest := *openapiclient.NewLicenseRequest("Key_example") // LicenseRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EnterpriseApi.EnterpriseLicenseUpdate(context.Background(), licenseUuid).LicenseRequest(licenseRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EnterpriseApi.EnterpriseLicenseUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EnterpriseLicenseUpdate`: License
    fmt.Fprintf(os.Stdout, "Response from `EnterpriseApi.EnterpriseLicenseUpdate`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
licenseUuid string A UUID string identifying this License.

Other Parameters

Other parameters are passed through a pointer to a apiEnterpriseLicenseUpdateRequest struct via the builder pattern

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]

EnterpriseLicenseUsedByList

[]UsedBy EnterpriseLicenseUsedByList(ctx, licenseUuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    licenseUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this License.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EnterpriseApi.EnterpriseLicenseUsedByList(context.Background(), licenseUuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EnterpriseApi.EnterpriseLicenseUsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EnterpriseLicenseUsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `EnterpriseApi.EnterpriseLicenseUsedByList`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
licenseUuid string A UUID string identifying this License.

Other Parameters

Other parameters are passed through a pointer to a apiEnterpriseLicenseUsedByListRequest struct via the builder pattern

Name Type Description Notes

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]