/access
/access: users, groups, roles, ACL, realms, API tokens, two-factor authentication. 45 cmdlets.
- Get-PveAccess:
GET /access
Directory index. - Get-PveAccessAcl:
GET /access/acl
Get Access Control List (ACLs). - Set-PveAccessAcl:
PUT /access/acl
Update Access Control List (add or remove permissions). - Get-PveAccessDomains:
GET /access/domains
Authentication domain index. - New-PveAccessDomains:
POST /access/domains
Add an authentication server. - Remove-PveAccessDomains:
DELETE /access/domains/{realm}
Delete an authentication server. - Get-PveAccessDomainsIdx:
GET /access/domains/{realm}
Get auth server configuration. - Set-PveAccessDomains:
PUT /access/domains/{realm}
Update authentication server settings. - New-PveAccessDomainsSync:
POST /access/domains/{realm}/sync
Syncs users and/or groups from the configured LDAP to user.cfg. - Get-PveAccessGroups:
GET /access/groups
Group index. - New-PveAccessGroups:
POST /access/groups
Create new group. - Remove-PveAccessGroups:
DELETE /access/groups/{groupid}
Delete group. - Get-PveAccessGroupsIdx:
GET /access/groups/{groupid}
Get group configuration. - Set-PveAccessGroups:
PUT /access/groups/{groupid}
Update group data. - Get-PveAccessOpenid:
GET /access/openid
Directory index. - New-PveAccessOpenidAuthUrl:
POST /access/openid/auth-url
Get the OpenId Authorization Url for the specified realm. - New-PveAccessOpenidLogin:
POST /access/openid/login
Verify OpenID authorization code and create a ticket. - Set-PveAccessPassword:
PUT /access/password
Change user password. - Get-PveAccessPermissions:
GET /access/permissions
Retrieve effective permissions of given user/token. - Get-PveAccessRoles:
GET /access/roles
Role index. - New-PveAccessRoles:
POST /access/roles
Create new role. - Remove-PveAccessRoles:
DELETE /access/roles/{roleid}
Delete role. - Get-PveAccessRolesIdx:
GET /access/roles/{roleid}
Get role configuration. - Set-PveAccessRoles:
PUT /access/roles/{roleid}
Update an existing role. - Get-PveAccessTfa:
GET /access/tfa
List TFA configurations of users. - Get-PveAccessTfaIdx:
GET /access/tfa/{userid}
List TFA configurations of users. - New-PveAccessTfa:
POST /access/tfa/{userid}
Add a TFA entry for a user. - Remove-PveAccessTfa:
DELETE /access/tfa/{userid}/{id}
Delete a TFA entry by ID. - Get-PveAccessTfaIdx1:
GET /access/tfa/{userid}/{id}
Fetch a requested TFA entry if present. - Set-PveAccessTfa:
PUT /access/tfa/{userid}/{id}
Add a TFA entry for a user. - Get-PveAccessTicket:
GET /access/ticket
Dummy. - New-PveAccessTicket:
POST /access/ticket
Create or verify authentication ticket. - Get-PveAccessUsers:
GET /access/users
User index. - New-PveAccessUsers:
POST /access/users
Create new user. - Remove-PveAccessUsers:
DELETE /access/users/{userid}
Delete user. - Get-PveAccessUsersIdx:
GET /access/users/{userid}
Get user configuration. - Set-PveAccessUsers:
PUT /access/users/{userid}
Update user configuration. - Get-PveAccessUsersTfa:
GET /access/users/{userid}/tfa
Get user TFA types (Personal and Realm). - Get-PveAccessUsersToken:
GET /access/users/{userid}/token
Get user API tokens. - Remove-PveAccessUsersToken:
DELETE /access/users/{userid}/token/{tokenid}
Remove API token for a specific user. - Get-PveAccessUsersTokenIdx:
GET /access/users/{userid}/token/{tokenid}
Get specific API token information. - New-PveAccessUsersToken:
POST /access/users/{userid}/token/{tokenid}
Generate a new API token for a specific user. - Set-PveAccessUsersToken:
PUT /access/users/{userid}/token/{tokenid}
Update API token for a specific user. - Set-PveAccessUsersUnlockTfa:
PUT /access/users/{userid}/unlock-tfa
Unlock a user’s TFA authentication. - New-PveAccessVncticket:
POST /access/vncticket
verify VNC authentication ticket.