Class Account

Hierarchy

Account

Index

Constructors

constructor

new Account(options: CreateAccountOptions): Account
Parameters
- options: CreateAccountOptions
Returns Account
- Defined in src/Account.ts:48

Properties

accountUrl

accountUrl: string

ca

ca: Ca

email

email: string

`Protected` keyPair

keyPair: KeyPair

Accessors

alg

get alg(): ALG
Returns ALG
- Defined in src/Account.ts:53

initialized

get initialized(): boolean
Returns boolean
- Defined in src/Account.ts:57

isExternalAccountRequired

get isExternalAccountRequired(): boolean
Returns boolean
- Defined in src/Account.ts:61

Methods

createExternalAccountBinding

createExternalAccountBinding(): Promise<ExternalAccountBinding>
Returns Promise<ExternalAccountBinding>
- Defined in src/Account.ts:92

createKeyPair

createKeyPair(alg?: ALG): Promise<void>
Parameters
- Optional alg: ALG
Returns Promise<void>
- Defined in src/Account.ts:69

exportJwk

exportJwk(): Promise<JsonWebKey>
Returns Promise<JsonWebKey>
- Defined in src/Account.ts:80

exportJwkThumbprint

exportJwkThumbprint(): Promise<string>
Returns Promise<string>
- Defined in src/Account.ts:88

exportPrivateJwk

exportPrivateJwk(): Promise<JsonWebKey>
Returns Promise<JsonWebKey>
- Defined in src/Account.ts:84

importJwk

importJwk(alg: ALG, jwk: JsonWebKey): Promise<void>
Parameters
- alg: ALG
- jwk: JsonWebKey
Returns Promise<void>
- Defined in src/Account.ts:76

sign

sign(content: string): Promise<string>
Parameters
- content: string
Returns Promise<string>
- Defined in src/Account.ts:65

`Static` create

create(options: CreateAccountOptions): Promise<Account>

Create a new account

Returns

Example

const le = new Letsencrypt()
await le.setStaging()
await Account.create({
    email: 'test@example.com',
    ca: le
})

Parameters

options: CreateAccountOptions

Returns Promise<Account>

`Static` import

import(options: ImportAccountOptions): Promise<Account>

Import account from Json Web Key

Returns

Example

await Account.import({
    email: 'test@example.com',
    ca: le,
    jwk: {...},
    accountUrl: 'https://example.com/acme/acct/evOfKhNU60wg'
})

Parameters

options: ImportAccountOptions

Class Account

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: CreateAccountOptions

Returns Account

Properties

accountUrl

ca

email

Protected keyPair

Accessors

alg

Returns ALG

initialized

Returns boolean

isExternalAccountRequired

Returns boolean

Methods

createExternalAccountBinding

Returns Promise<ExternalAccountBinding>

createKeyPair

Parameters

Optional alg: ALG

Returns Promise<void>

exportJwk

Returns Promise<JsonWebKey>

exportJwkThumbprint

Returns Promise<string>

exportPrivateJwk

Returns Promise<JsonWebKey>

importJwk

Parameters

alg: ALG

jwk: JsonWebKey

Returns Promise<void>

sign

Parameters

content: string

Returns Promise<string>

Static create

Returns

Example

Parameters

options: CreateAccountOptions

Returns Promise<Account>

Static import

Returns

Example

Parameters

options: ImportAccountOptions

Returns Promise<Account>

Settings

Member Visibility

Theme

`Protected` keyPair

`Optional` alg: ALG

`Static` create

`Static` import