File: InitializeRequest.md

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (32 lines) | stat: -rw-r--r-- 2,141 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# OpenbaoClient::InitializeRequest

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **pgp_keys** | **Array<String>** | Specifies an array of PGP public keys used to encrypt the output unseal keys. Ordering is preserved. The keys must be base64-encoded from their original binary representation. The size of this array must be the same as `secret_shares`. | [optional] |
| **recovery_pgp_keys** | **Array<String>** | Specifies an array of PGP public keys used to encrypt the output recovery keys. Ordering is preserved. The keys must be base64-encoded from their original binary representation. The size of this array must be the same as `recovery_shares`. | [optional] |
| **recovery_shares** | **Integer** | Specifies the number of shares to split the recovery key into. | [optional] |
| **recovery_threshold** | **Integer** | Specifies the number of shares required to reconstruct the recovery key. This must be less than or equal to `recovery_shares`. | [optional] |
| **root_token_pgp_key** | **String** | Specifies a PGP public key used to encrypt the initial root token. The key must be base64-encoded from its original binary representation. | [optional] |
| **secret_shares** | **Integer** | Specifies the number of shares to split the unseal key into. | [optional] |
| **secret_threshold** | **Integer** | Specifies the number of shares required to reconstruct the unseal key. This must be less than or equal secret_shares. If using OpenBao HSM with auto-unsealing, this value must be the same as `secret_shares`. | [optional] |
| **stored_shares** | **Integer** | Specifies the number of shares that should be encrypted by the HSM and stored for auto-unsealing. Currently must be the same as `secret_shares`. | [optional] |

## Example

```ruby
require 'openbao_client'

instance = OpenbaoClient::InitializeRequest.new(
  pgp_keys: null,
  recovery_pgp_keys: null,
  recovery_shares: null,
  recovery_threshold: null,
  root_token_pgp_key: null,
  secret_shares: null,
  secret_threshold: null,
  stored_shares: null
)
```