Customers commands

Reference for the `revenexx customers` commands — every subcommand with a runnable example.

Auto-generated. This page is generated from the revenexx CLI by tools/sync-cli-reference.mjs. Don't edit it by hand — your changes will be overwritten.

Every revenexx customers subcommand. The example shows the required arguments; the options table lists every flag the command accepts, with a ✓ marking required flags. Some flag names carry a -_ (e.g. --attribute-_values) — that is the exact token the CLI accepts, so copy them verbatim. Run revenexx customers <command> --help for the live options.

Bash

revenexx customers auth-login \
    --email einkauf@example.com \
    --password ''

Flag	Required	Description
`--email <email>`		The buyer's login address — the same one the contact carries.
`--password <password>`		The password from registration or recovery. Wrong credentials are a 401; a correct one on an undecided application is a 403.

auth-logout

Bash

revenexx customers auth-logout \
    --session-id '' \
    --user-id ''

Flag	Required	Description
`--session-id <session-id>`		The session to revoke — \
`--user-id <user-id>`		The platform user — \

auth-magic-link

Bash

revenexx customers auth-magic-link \
    --email einkauf@example.com \
    --url https://example.com

Flag	Required	Description
`--email <email>`		Who to send the link to. An address that has never been seen creates an account rather than failing.
`--url <url>`		Where the mailed link points. \

auth-magic-link-confirm

Bash

revenexx customers auth-magic-link-confirm \
    --secret '' \
    --user-id ''

Flag	Required	Description
`--secret <secret>`		The one-time secret the mailed link carried. Spent on first use and expiring, so a second attempt with the same one is a 401 rather than a second session.
`--user-id <user-id>`		The \

auth-me

Bash

revenexx customers auth-me \
    --user-id ''

Flag	Required	Description
`--user-id <user-id>`		The platform user to resolve — \
`--session-id <session-id>`		Optional session to verify. Pass it to ask "is this session still alive?" (a revoked one is then a 401); omit it to only ask who a user is.

auth-mfa-challenge

Bash

revenexx customers auth-mfa-challenge \
    --user-id ''

Flag	Required	Description
`--user-id <user-id>`		The platform user being challenged.
`--factor <factor>`		Which factor to challenge. Defaults to \

auth-mfa-challenge-confirm

Bash

revenexx customers auth-mfa-challenge-confirm \
    --challenge-id '' \
    --code '' \
    --session-secret ''

Flag	Required	Description
`--challenge-id <challenge-id>`		The \
`--code <code>`		What the buyer typed.
`--session-secret <session-secret>`		The same session the challenge was created with.
`--user-id <user-id>`		The platform user, for the caller's own bookkeeping. The challenge already knows whose it is.

auth-otp

Bash

revenexx customers auth-otp \
    --email einkauf@example.com

Flag	Required	Description
`--email <email>`		Who to send the code to. As with the sign-in link, an unknown address creates an account rather than failing.

auth-otp-confirm

Bash

revenexx customers auth-otp-confirm \
    --secret '' \
    --user-id ''

Flag	Required	Description
`--secret <secret>`		The one-time secret the mailed code carried. Spent on first use and expiring, so a second attempt with the same one is a 401 rather than a second session.
`--user-id <user-id>`		The \

auth-recovery

Bash

revenexx customers auth-recovery \
    --email einkauf@example.com \
    --url https://example.com

Flag	Required	Description
`--email <email>`		Who to send the recovery mail to. An address nobody holds is not distinguished here — do not build an account-existence check on the answer.
`--url <url>`		Where the mailed link points. \

auth-recovery-confirm

Bash

revenexx customers auth-recovery-confirm \
    --password '' \
    --secret '' \
    --user-id ''

Flag	Required	Description
`--password <password>`		The new password. It replaces the old one immediately; existing sessions are the identity service's business, not this app's.
`--secret <secret>`		The one-time secret from the mailed link. Only that value works — it is spent on first use and expires, and anything else is a 401, so no example here would be anything but a call that fails.
`--user-id <user-id>`		The \

auth-register

Bash

revenexx customers auth-register \
    --email einkauf@example.com \
    --password ''

Flag	Required	Description
`--email <email>`		The buyer's address. It becomes the login AND the unique key of the contact, so a second registration with it is a 409 — including while the first one is still waiting for approval.
`--password <password>`		The password the buyer chooses. It is hashed by the identity service at this moment and never travels again: an approval later enables the account, it does not issue a new credential.
`--first-name <first-name>`		Given name. Optional: an ERP import often has only a mailbox.
`--last-name <last-name>`		Family name. Optional for the same reason.
`--locale <locale>`		The language this person is written to in — BCP 47, and one of the store's configured locales. Null falls back to the store default. One of the store's own locales, or the call is a 400.
`--organization-id <organization-id>`		JOIN an existing company — the invite shape. Neither b2b_registration_enabled nor b2c_registration_enabled applies to it.
`--organization-name <organization-name>`		FOUND a new company, with this contact as its admin. This is what makes the registration a B2B one; leaving it out registers a standalone buyer.
`--url <url>`		Where the welcome mail's button points — the buyer's first stop in this shop. Absent, the mail still goes out and simply carries no button. Ignored when the registration is an APPLICATION: there is no account to send anybody to yet.
`--vat-id <vat-id>`		VAT identification number (USt-IdNr. in Germany) — the closest thing a B2B buyer has to a legal identity. Validated against the EU VIES service when the tenant's \
`--verification-url <verification-url>`		Where the address-confirmation link points, when the tenant's \

auth-verification

Bash

revenexx customers auth-verification \
    --url https://example.com \
    --user-id ''

Flag	Required	Description
`--url <url>`		Where the mailed link points. \
`--user-id <user-id>`		The platform user whose address is being confirmed — \

auth-verification-confirm

Bash

revenexx customers auth-verification-confirm \
    --secret '' \
    --user-id ''

Flag	Required	Description
`--secret <secret>`		The one-time secret the mailed link carried. Spent on first use and expiring, so a second attempt with the same one is a 401 rather than a second session.
`--user-id <user-id>`		The \

principal-resolve

Bash

revenexx customers principal-resolve \
    --contact-id ''

Flag	Required	Description
`--contact-id <contact-id>`		The contact the caller is acting for.

Was this page helpful?