Parallels REST API
ProductsSupportPartnersDocumentation
  • About
  • API reference
    • Infrastructure
      • Agents
        • Logs
        • Diagnostics
          • Broker
          • Enrollment Server
          • Gateway
          • Guest
          • HALB Device
          • Provider
          • RDS
      • Application Packages
        • MSIX Image
          • Details
      • AVD
        • Custom Host
          • All
        • Gallery
          • Image
        • Host Pool
          • App Package Assigned
          • Assignment
          • Auto Upgrade
            • Messages
          • Create Hosts
          • Existing
          • Optimization
            • Registry
            • Windows Component
            • Windows Scheduled Task
            • Windows Service
          • Recreate Hosts
          • Repair
          • Schedule
            • Disable
            • Messages
            • Reboot
            • Shutdown
            • Startup
            • Target
          • Status
          • FSLogix
            • General
            • Office Container
              • CCD Locations
              • User Exclusion
              • User Inclusion
              • VHD Locations
            • Profile Container
              • CCD Locations
              • Folder Exclusion
              • Folder Inclusion
              • User Exclusion
              • User Inclusion
              • VHD Locations
        • Location
        • Offer
        • Predefined Images
        • Publisher
        • Resource Group
        • Settings
        • SKU
        • Template
          • Enter Maintenance
          • Exit Maintenance
          • Optimization
            • Registry
            • Windows Component
            • Windows Scheduled Task
            • Windows Service
          • Recreate Desktops
          • Repair
          • Status
          • Version
          • VersionStatus
        • Version
        • Virtual Network
        • Workspace
          • Existing
          • Repair
          • Status
        • Default Settings
          • Multi Session
            • Application Package Assigned
            • Auto Upgrade
              • Messages
            • Optimization
              • Registry
              • Windows Component
              • Windows Scheduled Task
              • Windows Service
            • FSLogix
              • General
              • Office Container
                • CCD Locations
                • User Exclusion
                • User Inclusion
                • VHD Locations
              • Profile Container
                • CCD Locations
                • Folder Exclusion
                • Folder Inclusion
                • User Exclusion
                • User Inclusion
                • VHD Locations
          • Single Session
            • Application Package Assigned
            • Auto Upgrade
              • Messages
            • Optimization
              • Registry
              • Windows Component
              • Windows Scheduled Task
              • Windows Service
            • FSLogix
              • General
              • Office Container
                • CCD Locations
                • User Exclusion
                • User Inclusion
                • VHD Locations
              • Profile Container
                • CCD Locations
                • Folder Exclusion
                • Folder Inclusion
                • User Exclusion
                • User Inclusion
                • VHD Locations
        • VM Size
          • Provider
          • Workspace
        • Subnets
      • Certificates
        • Export
        • Generate Lets Encrypt
        • Generate Request
        • Generate Self Signed
        • Import Certificate
        • Import Pfx
        • Import Public Key
        • Renew
        • Retry
        • Revoke
        • Update Intermediate
        • Lets Encrypt Settings
          • EULA
      • Connection Brokers
        • Priority
        • Promote
        • Status
        • Broker Promotion
      • Enrollment Servers
        • Status
      • HALBs
        • Device
        • Status
      • Providers
        • Avd
        • Awsec2
        • Azure
        • Hyperv
        • Hypervfailover
        • Nutanix
        • Remote PC dynamic
        • Remote PC static
          • Remote PC
            • Import
        • Scale
        • Status
        • Vcenter
        • VM
          • AVD Host
            • Schedule
              • Disable
              • Messages
              • Reboot
              • Shutdown
              • Startup
              • Target
            • Session
              • Processes
            • Standalone
            • Status
            • Templated
          • Reset
          • Restart
          • Start
          • Stop
          • Suspend
          • VDI Host
            • Assignment
            • Disconnect
            • LogOff
            • Schedule
              • Disable
              • Messages
              • Reboot
              • Shutdown
              • Startup
              • Target
            • SendMsg
            • Session
              • Processes
            • Status
          • Host
            • Process
              • Kill
            • Status
        • Vmwareesxi
      • RD Session Hosts
        • RDS Default Settings
          • App Package Assigned
          • Auto Upgrade
            • Messages
          • Optimization
            • Registry
            • Windows Component
            • Windows Scheduled Task
            • Windows Service
          • FSLogix
            • General
            • Office Container
              • CCD Locations
              • User Exclusion
              • User Inclusion
              • VHD Locations
            • ProfileContainer
              • CCD Locations
              • Folder Exclusion
              • Folder Inclusion
              • User Exclusion
              • User Inclusion
              • VHD Locations
        • RDS
          • Host
            • AppPackageAssigned
            • CancelDisabledState
            • CancelPendingReboot
            • DisableLogonsAndReconnections
            • Drain
            • DrainUntilReboot
            • EnableLogons
            • InstallRDSRole
            • Optimization
              • Registry
              • WindowsComponent
              • WindowsScheduledTask
              • WindowsService
              • Predefined
                • WindowsComponent
                • WindowsScheduledTask
                • WindowsService
            • Reboot
            • Schedule
              • Disable
              • Messages
              • Reboot
              • Shutdown
              • Startup
              • Target
            • Sessions
              • Disconnect
              • Logoff
              • Processes
                • Kill
              • Sendmsg
            • Shutdown
            • Status
            • FSLogix
              • General
              • OfficeContainer
                • CCDLocations
                • UserExclusion
                • UserInclusion
                • VHDLocations
              • ProfileContainer
                • CCDLocations
                • FolderExclusion
                • FolderInclusion
                • UserExclusion
                • UserInclusion
                • VHDLocations
          • HostPool
            • AppPackageAssigned
            • AutoUpgrade
              • Messages
            • CancelDisabledState
            • CancelPendingReboot
            • CancelPendingShutdown
            • CreateHosts
            • Members
            • RecreateHosts
            • Schedule
              • Disable
              • Messages
              • Reboot
              • Shutdown
              • Startup
              • Target
            • Status
            • FSLogix
              • General
              • OfficeContainer
                • CCDLocations
                • UserExclusion
                • UserInclusion
                • VHDLocations
              • ProfileContainer
                • CCDLocations
                • FolderExclusion
                • FolderInclusion
                • UserExclusion
                • UserInclusion
                • VHDLocations
          • Template
            • EnterMaintenance
            • ExitMaintenance
            • LicenseKey
            • Optimization
              • Registry
              • WindowsComponent
              • WindowsScheduledTask
              • WindowsService
            • RecreateDesktops
            • Status
            • Version
            • VersionStatus
      • SAML IDPs
        • Duplicate
      • Gateway
        • Certificate
        • Private Key
        • Status
        • Gateway Default Settings
        • Tests a URL that leads to a client IP detection service
      • Sites
        • Status
      • Themes
        • Footer URL
        • Group Filter
        • Image
        • Custom Images
      • Tunneling Policies
        • Basic Operations
        • Listing, Updating, and Deleting
      • VDI
        • Host Pool
          • AppPackageAssigned
          • AutoUpgrade
            • Messages
          • CreateHosts
          • Members
          • Optimization
            • Registry
            • WindowsComponent
            • WindowsScheduledTask
            • WindowsService
          • RecreateHosts
          • Schedule
            • Disable
            • Messages
            • Reboot
            • Shutdown
            • Startup
            • Target
          • FSLogix
            • General
            • OfficeContainer
              • CCDLocations
              • UserExclusion
              • UserInclusion
              • VHDLocations
            • ProfileContainer
              • CCDLocations
              • FolderExclusion
              • FolderInclusion
              • UserExclusion
              • UserInclusion
              • VHDLocations
        • Template
          • EnterMaintenance
          • ExitMaintenance
          • LicenseKey
          • Optimization
            • Registry
            • WindowsComponent
            • WindowsScheduledTask
            • WindowsService
          • RecreateDesktops
          • Status
          • Version
          • VersionStatus
        • Optimization
          • Predefined
            • WindowsComponent
            • WindowsScheduledTask
            • WindowsService
        • VDI Default Settings
          • AppPackageAssigned
          • AutoUpgrade
            • Messages
          • Optimization
            • Registry
            • WindowsComponent
            • WindowsScheduledTask
            • WindowsService
          • FSLogix
            • General
            • OfficeContainer
              • CCDLocations
              • UserExclusion
              • UserInclusion
              • VHDLocations
            • ProfileContainer
              • CCDLocations
              • FolderExclusion
              • FolderInclusion
              • UserExclusion
              • UserInclusion
              • VHDLocations
    • Farm settings
      • Administrator Sessions
        • Current Admin Permissions
        • Logoff
        • Logon
      • Administrators
        • Custom Permission
        • Move to Group
        • Power Permission
      • Farm
      • Invitation Emails
        • Invite
      • Licensing
        • Activate
        • Deactivate
      • Mailbox
        • Test
      • Performance Monitor
      • Printing and Scanning
      • Reporting
      • Settings
        • Apply
        • Export
        • Import
      • WebService
        • Settings
          • Import Certificate
        • Version
    • Site settings
      • AD Integration
        • Validate
      • Application Packages
        • Tags
        • Application Package Available Versions
      • Clients
      • Connection and Authentication
        • Connection Settings
          • Clear Session Cache
        • Connection Allowed Devices
        • Custom Routes
      • CPU Optimization
      • FSLogix
        • Profile Container
          • Upload Installer
      • Load Balancing
      • Logon Hours
        • Criteria
          • Devices
          • Gateway IPs
          • Hardware IDs
          • IPs
          • OSes
          • Security Principals
          • Themes
        • Day Plan
        • Order
      • MFA
        • Check Connection
        • Criteria
          • Devices
          • Gateway IPs
          • Hardware IDs
          • IPs
          • OSes
          • Security Principals
        • Deepnet
        • Duplicate
        • Email OTP
        • Radius
        • Radius Attributes
        • Radius Auto Info
        • Safenet
        • TOTP
        • Validate AD Access
        • MFA Default Settings
          • Criteria
            • Devices
            • Gateway IPs
            • Hardware IDs
            • IPs
            • OSes
            • Security Principals
        • Details
      • Notifications
        • Events
        • Resources
        • Notification Scripts
      • Printing
        • Auto Install Fonts
      • Proxy
      • Scanning
      • System
      • Template
      • Tenant Broker
        • Join
        • Status
        • Settings
        • Unjoin
      • URL Redirection
        • Entry
      • Windows Device Groups
        • Inbound Port
    • Publishing
      • PubIished tems
      • Client Filters
      • Copy
      • Filter
      • Folders
        • Sort
      • Gateway Filters
      • Icon
      • IP Filters
      • MAC Filters
      • Move
      • OS Filters
      • Preferred Route
      • Rules
        • Criteria
          • Devices
          • Gateway IPs
          • Hardware IDs
          • IPs
          • OSes
          • Security Principals
          • Themes
      • Status
      • User Filters
      • Apps
        • AVD
        • File Extensions
        • RDS
          • Server Attribute
        • VDI
        • Local
      • Desktops
        • AVD
        • RDS
        • VDI
      • Publised resources Default Settings
    • Policies
      • Assignment
      • Duplicate
      • Export
      • Gateway Filters
      • Import
      • MAC Filters
      • Order
      • Rules
        • Criteria
          • Gateway IPs
          • Hardware IDs
          • IPs
          • OSes
          • Security Principals
      • Secondary Connections
      • User Group
    • RD Sessions
    • Help and support
      • Helpdesk Email Settings
      • Support
        • Download Report
        • Send Support Request
        • Send System Report
        • Overwrite Support Actions
  • Examples
    • Basic Sample
    • RDS Sample
    • Publishing Sample
    • Connection Broker and Secure Gateway Sample
    • Licensing Sample
Powered by GitBook

© 2025 Parallels International GmbH. All rights reserved.

On this page

Was this helpful?

Export as PDF
  1. API reference
  2. Site settings
  3. MFA

Radius Attributes

PreviousRadiusNextRadius Auto Info

Was this helpful?

  • GETGet Attribute
  • POSTAdd Attribute
  • DELETEDelete Attribute

Get Attribute

get

Retrieve a Radius Attribute List.

Path parameters
idinteger · int32Required

The ID of a MFA for which to retrieve the Radius Attribute.

Responses
200
Success
application/json; api-version=1.0
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
get
GET /api/MFA/{id}/RadiusAttr HTTP/1.1
Host: 
Accept: */*
{
  "vendorID": 1,
  "attributeID": 1,
  "attributeType": [
    "0 = Number",
    "1 = String",
    "2 = IP",
    "3 = Time"
  ],
  "radiusAttrName": "text",
  "vendor": "text",
  "value": "text"
}

Add Attribute

post

Add a new Radius Attribute.

Path parameters
idinteger · int32Required

MFA settings

Body

Add MFA RADIUS attribute

vendorIDinteger · int32Required

RADIUS attribute vendor ID

attributeIDinteger · int32Required

RADIUS attribute ID

valuestring | nullableRequired

RADIUS attribute value The value has many forms:IP, Number, String, and Time. When setting the time it is expected that the time value is in epoch time.

radiusAttrNamestring | nullableRequired

RADIUS attribute name

vendorstring | nullableRequired

RADIUS attribute vendor name

attributeTypestring · enumRequired

RADIUS attribute type

Possible values:
Responses
201
Created
application/json; api-version=1.0
401
Unauthorized
application/json; api-version=1.0
409
Conflict
application/json; api-version=1.0
post
POST /api/MFA/{id}/RadiusAttr HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 149

{
  "vendorID": 1,
  "attributeID": 1,
  "value": "text",
  "radiusAttrName": "text",
  "vendor": "text",
  "attributeType": [
    "0 = Number",
    "1 = String",
    "2 = IP",
    "3 = Time"
  ]
}
{
  "vendorID": 1,
  "attributeID": 1,
  "attributeType": [
    "0 = Number",
    "1 = String",
    "2 = IP",
    "3 = Time"
  ],
  "radiusAttrName": "text",
  "vendor": "text",
  "value": "text"
}

Delete Attribute

delete

Delete a Radius Attribute from a site.

Path parameters
idinteger · int32Required

The ID of a RadiusAttr to remove from the site.

Body
vendorIDinteger · int32Required

RADIUS attribute vendor ID

attributeIDinteger · int32Required

RADIUS attribute ID

valuestring | nullableRequired

RADIUS attribute value The value has many forms:IP, Number, String, and Time. When setting the time it is expected that the time value is in epoch time.

radiusAttrNamestring | nullableRequired

RADIUS attribute name

vendorstring | nullableRequired

RADIUS attribute vendor name

attributeTypestring · enumRequired

RADIUS attribute type

Possible values:
Responses
204
No Content
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
delete
DELETE /api/MFA/{id}/RadiusAttr HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 149

{
  "vendorID": 1,
  "attributeID": 1,
  "value": "text",
  "radiusAttrName": "text",
  "vendor": "text",
  "attributeType": [
    "0 = Number",
    "1 = String",
    "2 = IP",
    "3 = Time"
  ]
}

No content