Skip to content

Latest commit

 

History

History
315 lines (164 loc) · 8.68 KB

EnterpriseApi.md

File metadata and controls

315 lines (164 loc) · 8.68 KB

\EnterpriseApi

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

Method HTTP request Description
enterprise_license_create POST /enterprise/license/
enterprise_license_destroy DELETE /enterprise/license/{license_uuid}/
enterprise_license_forecast_retrieve GET /enterprise/license/forecast/
enterprise_license_get_install_id_retrieve GET /enterprise/license/get_install_id/
enterprise_license_list GET /enterprise/license/
enterprise_license_partial_update PATCH /enterprise/license/{license_uuid}/
enterprise_license_retrieve GET /enterprise/license/{license_uuid}/
enterprise_license_summary_retrieve GET /enterprise/license/summary/
enterprise_license_update PUT /enterprise/license/{license_uuid}/
enterprise_license_used_by_list GET /enterprise/license/{license_uuid}/used_by/

enterprise_license_create

models::License enterprise_license_create(license_request)

License Viewset

Parameters

Name Type Description Required Notes
license_request LicenseRequest [required]

Return type

models::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]

enterprise_license_destroy

enterprise_license_destroy(license_uuid)

License Viewset

Parameters

Name Type Description Required Notes
license_uuid uuid::Uuid A UUID string identifying this License. [required]

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]

enterprise_license_forecast_retrieve

models::LicenseForecast enterprise_license_forecast_retrieve()

Forecast how many users will be required in a year

Parameters

This endpoint does not need any parameter.

Return type

models::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]

enterprise_license_get_install_id_retrieve

models::InstallId enterprise_license_get_install_id_retrieve()

Get install_id

Parameters

This endpoint does not need any parameter.

Return type

models::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]

enterprise_license_list

models::PaginatedLicenseList enterprise_license_list(name, ordering, page, page_size, search)

License Viewset

Parameters

Name Type Description Required Notes
name Option<String>
ordering Option<String> Which field to use when ordering the results.
page Option<i32> A page number within the paginated result set.
page_size Option<i32> Number of results to return per page.
search Option<String> A search term.

Return type

models::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]

enterprise_license_partial_update

models::License enterprise_license_partial_update(license_uuid, patched_license_request)

License Viewset

Parameters

Name Type Description Required Notes
license_uuid uuid::Uuid A UUID string identifying this License. [required]
patched_license_request Option<PatchedLicenseRequest>

Return type

models::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]

enterprise_license_retrieve

models::License enterprise_license_retrieve(license_uuid)

License Viewset

Parameters

Name Type Description Required Notes
license_uuid uuid::Uuid A UUID string identifying this License. [required]

Return type

models::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]

enterprise_license_summary_retrieve

models::LicenseSummary enterprise_license_summary_retrieve()

Get the total license status

Parameters

This endpoint does not need any parameter.

Return type

models::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]

enterprise_license_update

models::License enterprise_license_update(license_uuid, license_request)

License Viewset

Parameters

Name Type Description Required Notes
license_uuid uuid::Uuid A UUID string identifying this License. [required]
license_request LicenseRequest [required]

Return type

models::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]

enterprise_license_used_by_list

Vecmodels::UsedBy enterprise_license_used_by_list(license_uuid)

Get a list of all objects that use this object

Parameters

Name Type Description Required Notes
license_uuid uuid::Uuid A UUID string identifying this License. [required]

Return type

Vecmodels::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]