Skip to content

createconsumerrequest.md

Latest commit

 

History

History
24 lines (19 loc) · 6.16 KB

createconsumerrequest.md

File metadata and controls

24 lines (19 loc) · 6.16 KB

CreateConsumerRequest

Example Usage

import { CreateConsumerRequest } from "@apideck/unify/models/components";

let value: CreateConsumerRequest = {
  consumerId: "test_consumer_id",
  metadata: {
    accountName: "SpaceX",
    userName: "Elon Musk",
    email: "elon@musk.com",
    image: "https://www.spacex.com/static/images/share.jpg",
  },
};

Fields

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 components.ConsumerMetadata ➖ The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended.