access / ticket

2 operations.

proxmox.access.ticket.$get()

Dummy. Useful for formatters which want to provide a login page.

Returns nothing.

proxmox.access.ticket.$post()

Create or verify authentication ticket.

Returns object.

WARNING

Not callable with an API token.

Parameter	Type	Required	Notes
`new-format`	boolean		This parameter is now ignored and assumed to be 1. — default `1`
`otp`	string		One-time password for Two-factor authentication.
`password`	string	yes	The secret password. This can also be a valid ticket.
`path`	string		Verify ticket, and check if user have access 'privs' on 'path' — ≤ 64 chars
`privs`	string		Verify ticket, and check if user have access 'privs' on 'path' — format `pve-priv-list`, ≤ 64 chars
`realm`	string		You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<realm>. — format `pve-realm`, ≤ 32 chars
`tfa-challenge`	string		The signed TFA challenge string the user wants to respond to.
`username`	string	yes	User name — ≤ 64 chars

access / ticket ​