OpenXchangeClient.Api.Certificate (open_xchange_client v0.10.1)
API calls for all endpoints tagged Certificate
.
Link to this section Summary
Functions
Deletes all fingerprint/hostname combinations for the user Deletes all fingerprint/hostname combinations for the user
Deletes the fingerprint/hostname combination Deletes the fingerprint/hostname combination
Examines an untrusted SSL certificate from a previous endpoint call Examines an untrusted SSL certificate from a previous endpoint call. The SSL certificate is cached for a brief amount of time by the middleware (2 minutes).
Gets all SSL certificates. Returns all trusted and untrusted SSL certificates
Gets a specific or all SSL certificates Gets a specific or all SSL certificates
Stores the fingerprint of an SSL certificate. Stores the fingerprint of an SSL certificate in combination with a hostname as either trusted or untrusted. This API call also accepts a JSONObject.
Updates the exception for an SSL certificate in combination with a hostname as either trusted or untrusted
Link to this section Functions
delete_all_certificates(connection, session, opts \\ [])
@spec delete_all_certificates(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Deletes all fingerprint/hostname combinations for the user Deletes all fingerprint/hostname combinations for the user
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
delete_certificate(connection, session, fingerprint, opts \\ [])
@spec delete_certificate(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Deletes the fingerprint/hostname combination Deletes the fingerprint/hostname combination
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- fingerprint (String.t): The fingerprint of the SSL certificate
- opts (KeywordList): [optional] Optional parameters
- :hostname (String.t): The hostname for which the SSL certificate is trusted/not trusted. If absent, then all entries for the specified fingerprint will be deleted
returns
Returns
on success {:error, Tesla.Env.t} on failure
examine_certificate(connection, session, fingerprint, opts \\ [])
@spec examine_certificate(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.CertificateExamineResponse.t()} | {:error, Tesla.Env.t()}
Examines an untrusted SSL certificate from a previous endpoint call Examines an untrusted SSL certificate from a previous endpoint call. The SSL certificate is cached for a brief amount of time by the middleware (2 minutes).
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- fingerprint (String.t): The fingerprint of the SSL certificate
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
get_all_certificates(connection, session, opts \\ [])
@spec get_all_certificates(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.CertificatesAllResponse.t()} | {:error, Tesla.Env.t()}
Gets all SSL certificates. Returns all trusted and untrusted SSL certificates
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
get_certificate(connection, session, fingerprint, opts \\ [])
@spec get_certificate(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.CertificatesAllResponse.t()} | {:error, Tesla.Env.t()}
Gets a specific or all SSL certificates Gets a specific or all SSL certificates
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- fingerprint (String.t): The fingerprint of the SSL certificate
- opts (KeywordList): [optional] Optional parameters
- :hostname (String.t): The hostname for which the SSL certificate is trusted/not trusted. If absent, then all entries for the specified fingerprint will be returned
returns
Returns
on success {:error, Tesla.Env.t} on failure
store_certificate(connection, session, fingerprint, hostname, trust, opts \\ [])
@spec store_certificate( Tesla.Env.client(), String.t(), String.t(), String.t(), boolean(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Stores the fingerprint of an SSL certificate. Stores the fingerprint of an SSL certificate in combination with a hostname as either trusted or untrusted. This API call also accepts a JSONObject.
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- fingerprint (String.t): The fingerprint of the SSL certificate
- hostname (String.t): The hostname for which to trust/untrust the SSL certificate
- trust (boolean()): Whether the combination of the SSL certificate and the hostname is to be trusted
- opts (KeywordList): [optional] Optional parameters
- :body (CertificateStoreData): A JSON object describing the SSL certificate.
returns
Returns
on success {:error, Tesla.Env.t} on failure
store_certificate_0(connection, session, fingerprint, hostname, trust, opts \\ [])
@spec store_certificate_0( Tesla.Env.client(), String.t(), String.t(), String.t(), boolean(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Updates the exception for an SSL certificate in combination with a hostname as either trusted or untrusted
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- fingerprint (String.t): The fingerprint of the SSL certificate
- hostname (String.t): The hostname for which to trust/untrust the SSL certificate
- trust (boolean()): Whether the combination of the SSL certificate and the hostname is to be trusted
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure