Skip to content

Latest commit

 

History

History
193 lines (119 loc) · 5.77 KB

MutualAuthenticationApi.md

File metadata and controls

193 lines (119 loc) · 5.77 KB

MutualAuthenticationApi

Note

All URIs are relative to https://api.fastly.com

Method HTTP request Description
create_mutual_tls_authentication POST /tls/mutual_authentications Create a Mutual Authentication
delete_mutual_tls DELETE /tls/mutual_authentications/{mutual_authentication_id} Delete a Mutual TLS
get_mutual_authentication GET /tls/mutual_authentications/{mutual_authentication_id} Get a Mutual Authentication
list_mutual_authentications GET /tls/mutual_authentications List Mutual Authentications
patch_mutual_authentication PATCH /tls/mutual_authentications/{mutual_authentication_id} Update a Mutual Authentication

create_mutual_tls_authentication

Create a mutual authentication using a bundle of certificates to enable client-to-server mutual TLS.

let cfg = &Configuration::default();
let params = CreateMutualTlsAuthenticationParams {
    // parameters
};
create_mutual_tls_authentication(cfg, params)

Parameters

Name Type Description Required Notes
mutual_authentication Option<MutualAuthentication>

Return type

crate::models::MutualAuthenticationResponse

Authorization

token

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

[Back to top] [Back to API list] [Back to README]

delete_mutual_tls

Remove a Mutual TLS authentication

let cfg = &Configuration::default();
let params = DeleteMutualTlsParams {
    // parameters
};
delete_mutual_tls(cfg, params)

Parameters

Name Type Description Required Notes
mutual_authentication_id String Alphanumeric string identifying a mutual authentication. [required]

Return type

(empty response body)

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to README]

get_mutual_authentication

Show a Mutual Authentication.

let cfg = &Configuration::default();
let params = GetMutualAuthenticationParams {
    // parameters
};
get_mutual_authentication(cfg, params)

Parameters

Name Type Description Required Notes
mutual_authentication_id String Alphanumeric string identifying a mutual authentication. [required]
include Option<String> Comma-separated list of related objects to include (optional). Permitted values: tls_activations. Including TLS activations will provide you with the TLS domain names that are related to your Mutual TLS authentication.

Return type

crate::models::MutualAuthenticationResponse

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.api+json

[Back to top] [Back to API list] [Back to README]

list_mutual_authentications

List all mutual authentications.

let cfg = &Configuration::default();
let params = ListMutualAuthenticationsParams {
    // parameters
};
list_mutual_authentications(cfg, params)

Parameters

Name Type Description Required Notes
include Option<String> Comma-separated list of related objects to include (optional). Permitted values: tls_activations. Including TLS activations will provide you with the TLS domain names that are related to your Mutual TLS authentication.
page_number Option<i32> Current page.
page_size Option<i32> Number of records per page. [default to 20]

Return type

crate::models::MutualAuthenticationsResponse

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.api+json

[Back to top] [Back to API list] [Back to README]

patch_mutual_authentication

Update a Mutual Authentication.

let cfg = &Configuration::default();
let params = PatchMutualAuthenticationParams {
    // parameters
};
patch_mutual_authentication(cfg, params)

Parameters

Name Type Description Required Notes
mutual_authentication_id String Alphanumeric string identifying a mutual authentication. [required]
mutual_authentication Option<MutualAuthentication>

Return type

crate::models::MutualAuthenticationResponse

Authorization

token

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

[Back to top] [Back to API list] [Back to README]