Skip to content

Latest commit

 

History

History
427 lines (228 loc) · 12.5 KB

RacApi.md

File metadata and controls

427 lines (228 loc) · 12.5 KB
Raw

\RacApi

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

Method HTTP request Description
rac_connection_tokens_destroy DELETE /rac/connection_tokens/{connection_token_uuid}/
rac_connection_tokens_list GET /rac/connection_tokens/
rac_connection_tokens_partial_update PATCH /rac/connection_tokens/{connection_token_uuid}/
rac_connection_tokens_retrieve GET /rac/connection_tokens/{connection_token_uuid}/
rac_connection_tokens_update PUT /rac/connection_tokens/{connection_token_uuid}/
rac_connection_tokens_used_by_list GET /rac/connection_tokens/{connection_token_uuid}/used_by/
rac_endpoints_create POST /rac/endpoints/
rac_endpoints_destroy DELETE /rac/endpoints/{pbm_uuid}/
rac_endpoints_list GET /rac/endpoints/
rac_endpoints_partial_update PATCH /rac/endpoints/{pbm_uuid}/
rac_endpoints_retrieve GET /rac/endpoints/{pbm_uuid}/
rac_endpoints_update PUT /rac/endpoints/{pbm_uuid}/
rac_endpoints_used_by_list GET /rac/endpoints/{pbm_uuid}/used_by/

rac_connection_tokens_destroy

rac_connection_tokens_destroy(connection_token_uuid)

ConnectionToken Viewset

Parameters

Name Type Description Required Notes
connection_token_uuid uuid::Uuid A UUID string identifying this RAC Connection token. [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]

rac_connection_tokens_list

models::PaginatedConnectionTokenList rac_connection_tokens_list(endpoint, ordering, page, page_size, provider, search, session__user)

ConnectionToken Viewset

Parameters

Name Type Description Required Notes
endpoint Option<uuid::Uuid>
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.
provider Option<i32>
search Option<String> A search term.
session__user Option<i32>

Return type

models::PaginatedConnectionTokenList

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]

rac_connection_tokens_partial_update

models::ConnectionToken rac_connection_tokens_partial_update(connection_token_uuid, patched_connection_token_request)

ConnectionToken Viewset

Parameters

Name Type Description Required Notes
connection_token_uuid uuid::Uuid A UUID string identifying this RAC Connection token. [required]
patched_connection_token_request Option<PatchedConnectionTokenRequest>

Return type

models::ConnectionToken

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]

rac_connection_tokens_retrieve

models::ConnectionToken rac_connection_tokens_retrieve(connection_token_uuid)

ConnectionToken Viewset

Parameters

Name Type Description Required Notes
connection_token_uuid uuid::Uuid A UUID string identifying this RAC Connection token. [required]

Return type

models::ConnectionToken

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]

rac_connection_tokens_update

models::ConnectionToken rac_connection_tokens_update(connection_token_uuid, connection_token_request)

ConnectionToken Viewset

Parameters

Name Type Description Required Notes
connection_token_uuid uuid::Uuid A UUID string identifying this RAC Connection token. [required]
connection_token_request ConnectionTokenRequest [required]

Return type

models::ConnectionToken

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]

rac_connection_tokens_used_by_list

Vecmodels::UsedBy rac_connection_tokens_used_by_list(connection_token_uuid)

Get a list of all objects that use this object

Parameters

Name Type Description Required Notes
connection_token_uuid uuid::Uuid A UUID string identifying this RAC Connection token. [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]

rac_endpoints_create

models::Endpoint rac_endpoints_create(endpoint_request)

Endpoint Viewset

Parameters

Name Type Description Required Notes
endpoint_request EndpointRequest [required]

Return type

models::Endpoint

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]

rac_endpoints_destroy

rac_endpoints_destroy(pbm_uuid)

Endpoint Viewset

Parameters

Name Type Description Required Notes
pbm_uuid uuid::Uuid A UUID string identifying this RAC Endpoint. [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]

rac_endpoints_list

models::PaginatedEndpointList rac_endpoints_list(name, ordering, page, page_size, provider, search, superuser_full_list)

List accessible endpoints

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.
provider Option<i32>
search Option<String>
superuser_full_list Option<bool>

Return type

models::PaginatedEndpointList

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]

rac_endpoints_partial_update

models::Endpoint rac_endpoints_partial_update(pbm_uuid, patched_endpoint_request)

Endpoint Viewset

Parameters

Name Type Description Required Notes
pbm_uuid uuid::Uuid A UUID string identifying this RAC Endpoint. [required]
patched_endpoint_request Option<PatchedEndpointRequest>

Return type

models::Endpoint

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]

rac_endpoints_retrieve

models::Endpoint rac_endpoints_retrieve(pbm_uuid)

Endpoint Viewset

Parameters

Name Type Description Required Notes
pbm_uuid uuid::Uuid A UUID string identifying this RAC Endpoint. [required]

Return type

models::Endpoint

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]

rac_endpoints_update

models::Endpoint rac_endpoints_update(pbm_uuid, endpoint_request)

Endpoint Viewset

Parameters

Name Type Description Required Notes
pbm_uuid uuid::Uuid A UUID string identifying this RAC Endpoint. [required]
endpoint_request EndpointRequest [required]

Return type

models::Endpoint

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]

rac_endpoints_used_by_list

Vecmodels::UsedBy rac_endpoints_used_by_list(pbm_uuid)

Get a list of all objects that use this object

Parameters

Name Type Description Required Notes
pbm_uuid uuid::Uuid A UUID string identifying this RAC Endpoint. [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]