ExAcme.RegistrationBuilder (ExAcme v0.5.1)
View SourceRepresents an ACME Account registration.
Provides functionalities to create and manage account registrations with the ACME server.
Attributes
contact
- List of contact URIs.terms_of_service_agreed
- Boolean indicating agreement to terms.only_return_existing
- Boolean to indicate if only existing accounts should be returned.external_account_binding
- External account binding information.
Summary
Functions
Agrees to the terms of service for the registration.
Adds contact URIs to the registration.
Configures the external account binding for the registration.
Creates a new account registration struct with default values.
Converts the registration struct to a map.
Types
Functions
Agrees to the terms of service for the registration.
Parameters
registration
- The current registration struct.
Returns
- Updated
ExAcme.RegistrationBuilder
struct.
Adds contact URIs to the registration.
Parameters
registration
- The current registration struct.contacts
- A list or single contact URI.
Returns
- Updated
ExAcme.RegistrationBuilder
struct.
@spec external_account_binding( t(), JOSE.JWK.t(), ExAcme.client(), String.t(), String.t() ) :: t()
Configures the external account binding for the registration.
This function sets up an external account binding using the provided key, client, external account binding key ID, and MAC key.
Parameters
registration
- The current registration struct.key
- TheJOSE.JWK
key being registered.client
- The ExAcme client name or pid.eab_kid
- The external account binding key ID.eab_mac_key
- The external account binding MAC key. This must be a valid base64url-encoded string.
Returns
- Updated
ExAcme.RegistrationBuilder
struct with external account binding.
@spec new_registration() :: t()
Creates a new account registration struct with default values.
Returns
ExAcme.RegistrationBuilder
struct.
Converts the registration struct to a map.
This function transforms the RegistrationBuilder struct into a map format, removes nil values, and converts keys to camelCase for API compatibility.
Parameters
registration
- The current registration struct.
Returns
- A map representation of the registration.