New-PveAccessOpenidAuthUrl
Get the OpenId Authorization Url for the specified realm.
API: POST /access/openid/auth-url, Proxmox VE API viewer
Syntax
Section titled “Syntax”New-PveAccessOpenidAuthUrl [-PveTicket <PveTicket>] -Realm <string> -RedirectUrl <string> [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Realm |
string |
Yes | Authentication domain ID. |
-RedirectUrl |
string |
Yes | Redirection Url. The client should set this to the used server url (location.origin). |
Every parameter also binds by property name from the pipeline, so an object with node and vmid properties (the output of Get-PveGuest, for one) fills -Node and -Vmid. Without -PveTicket the cmdlet uses the last connection, see Connection.
Output
Section titled “Output”A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.
