Connection and Authentication | Parallels REST API

Parallels REST API

SupportDocumentation

List

get

Retrieve a list of all the Trusted Domains.

Query parameters

SiteIdinteger · int32Optional

Site ID for which to retrieve all the Trusted Domains (optional)

Responses

application/json; api-version=1.0

string[]Optional

application/json; api-version=1.0

get

GET /api/ConnectionAuthentication/TrustedDomain HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

List

get

Retrieve a list of all the settings for RAS authentication

Query parameters

SiteIdinteger · int32Optional

Site ID for which to retrieve all the settings for RAS authentication (optional)

Responses

application/json; api-version=1.0

objectOptional

RAS Authentication Settings

application/json; api-version=1.0

get

GET /api/ConnectionAuthentication HTTP/1.1
Host: 
Accept: */*

{
  "authType": [
    "1 = UsernamePassword",
    "2 = SmartCard",
    "3 = UsernamePasswordOrSmartCard",
    "4 = Web",
    "8 = WebCredentials"
  ],
  "allTrustedDomains": true,
  "domain": "text",
  "useClientDomain": true,
  "forceNetBIOSCreds": true,
  "replicateSettings": true,
  "useChangePasswordURL": true,
  "changePasswordURL": "text",
  "siteId": 1
}

Update

put

Update RAS authentication settings

Query parameters

SiteIdinteger · int32Optional

ID of the site for which the RAS authentication settings will be updated

Body

Update the authentication settings

authTypestring[Flag] · enumOptional

Authentication Type

Available options:

allTrustedDomainsboolean | nullableOptional

Whether to use all trusted domains.

domainstring | nullableOptional

Domain name.

useClientDomainboolean | nullableOptional

Whether to use the client domain, if specified.

forceNetBIOSCredsboolean | nullableOptional

Whether to force clients to use NetBIOS credentials.

replicateSettingsboolean | nullableOptional

Whether to replicate settings to other sites.

useChangePasswordURLboolean | nullableOptional

Enable use custom link for the "Change domain password" option.

changePasswordURLstring | nullableOptional

Custom link for the "Change domain password" option.

Responses

application/json; api-version=1.0

put

PUT /api/ConnectionAuthentication HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 287

{
  "authType": [
    "1 = UsernamePassword",
    "2 = SmartCard",
    "3 = UsernamePasswordOrSmartCard",
    "4 = Web",
    "8 = WebCredentials"
  ],
  "allTrustedDomains": true,
  "domain": "text",
  "useClientDomain": true,
  "forceNetBIOSCreds": true,
  "replicateSettings": true,
  "useChangePasswordURL": true,
  "changePasswordURL": "text"
}

No content