Field | Type | Required | Description | Example |
---|---|---|---|---|
consumerId |
String | ✔️ | Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID. | test_consumer_id |
metadata |
Optional<ConsumerMetadata> | ➖ | The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended. |