SAML IDPs | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Get

get

Retrieve information about a particular SAML IDP configuration by ID.

Path parameters

idinteger · int32required

The ID of a SAML IDP configuration for which to retrieve the information.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/SAMLIDP/{id}'

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:32:38.364Z",
  "timeLastMod": "2025-04-06T01:32:38.364Z",
  "enabled": true,
  "name": "text",
  "siteId": 1,
  "description": "text",
  "themeId": 1,
  "idpEntityID": "text",
  "idpCertificate": "text",
  "logonURL": "text",
  "logoutURL": "text",
  "allowUnencryptedAssertion": true,
  "host": "text",
  "spEntityID": "text",
  "spReplyURL": "text",
  "spLogonURL": "text",
  "spLogoutURL": "text",
  "spCertificate": "text",
  "attributes": {
    "userPrincipalName": {
      "enabled": true,
      "samlAttribute": "text",
      "adAttribute": "text"
    },
    "immutableID": {
      "enabled": true,
      "samlAttribute": "text",
      "adAttribute": "text"
    },
    "sid": {
      "enabled": true,
      "samlAttribute": "text",
      "adAttribute": "text"
    },
    "sAMAccountName": {
      "enabled": true,
      "samlAttribute": "text",
      "adAttribute": "text"
    },
    "custom": {
      "enabled": true,
      "samlAttribute": "text",
      "adAttribute": "text"
    }
  }
}

Success

Delete

delete

Remove a SAML IDP configuration from a site.

Path parameters

idinteger · int32required

The ID of a SAML IDP configuration to remove from the site.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/SAMLIDP/{id}'

204

401

404

No Content

List

get

Retrieve information about one or multiple SAML IDP configurations.

Query parameters

SiteIdinteger · int32optional

Site ID from which to retrieve the SAML IDP configurations (optional).

Namestringoptional

The name of the SAML IDP configuration for which to retrieve the information. This must be the actual SAML IDP configuration name used in the RAS connections.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/SAMLIDP'

200

401

404

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-04-06T01:32:38.364Z",
    "timeLastMod": "2025-04-06T01:32:38.364Z",
    "enabled": true,
    "name": "text",
    "siteId": 1,
    "description": "text",
    "themeId": 1,
    "idpEntityID": "text",
    "idpCertificate": "text",
    "logonURL": "text",
    "logoutURL": "text",
    "allowUnencryptedAssertion": true,
    "host": "text",
    "spEntityID": "text",
    "spReplyURL": "text",
    "spLogonURL": "text",
    "spLogoutURL": "text",
    "spCertificate": "text",
    "attributes": {
      "userPrincipalName": {
        "enabled": true,
        "samlAttribute": "text",
        "adAttribute": "text"
      },
      "immutableID": {
        "enabled": true,
        "samlAttribute": "text",
        "adAttribute": "text"
      },
      "sid": {
        "enabled": true,
        "samlAttribute": "text",
        "adAttribute": "text"
      },
      "sAMAccountName": {
        "enabled": true,
        "samlAttribute": "text",
        "adAttribute": "text"
      },
      "custom": {
        "enabled": true,
        "samlAttribute": "text",
        "adAttribute": "text"
      }
    }
  }
]

Success

Create

post

Create a new SAML IDP configuration.

Body

Create a new SAMLIDP

hoststring | nullablerequired

Host name of gateway This specified gateway will receive the calls for SP URLs.

namestring | nullablerequired

The name of the target SAMLIDP. This must be the actual SAMLIDP name used in the RAS farm.

siteIdinteger · int32optional

Site ID in which to create the specified SAMLIDP. If the parameter is omitted, the site ID of the Licensing Server will be used.

enabledboolean | nullableoptional

Enable or disable the SAMLIDP upon creation. If the parameter is omitted, the SAMLIDP is initialised as Disabled.

descriptionstring | nullableoptional

A user-defined SAMLIDP description.

themeIdinteger · int32 | nullableoptional

Use SAMLIDP with a theme

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/SAMLIDP' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "host": "text",
    "name": "text",
    "siteId": 1,
    "enabled": true,
    "description": "text",
    "themeId": 1
  }'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:32:38.364Z",
  "timeLastMod": "2025-04-06T01:32:38.364Z",
  "enabled": true,
  "name": "text",
  "siteId": 1,
  "description": "text",
  "themeId": 1,
  "idpEntityID": "text",
  "idpCertificate": "text",
  "logonURL": "text",
  "logoutURL": "text",
  "allowUnencryptedAssertion": true,
  "host": "text",
  "spEntityID": "text",
  "spReplyURL": "text",
  "spLogonURL": "text",
  "spLogoutURL": "text",
  "spCertificate": "text",
  "attributes": {
    "userPrincipalName": {
      "enabled": true,
      "samlAttribute": "text",
      "adAttribute": "text"
    },
    "immutableID": {
      "enabled": true,
      "samlAttribute": "text",
      "adAttribute": "text"
    },
    "sid": {
      "enabled": true,
      "samlAttribute": "text",
      "adAttribute": "text"
    },
    "sAMAccountName": {
      "enabled": true,
      "samlAttribute": "text",
      "adAttribute": "text"
    },
    "custom": {
      "enabled": true,
      "samlAttribute": "text",
      "adAttribute": "text"
    }
  }
}

Created

Update

put

Modify properties of a SAML IDP configuration.

Path parameters

idinteger · int32required

The ID of the SAML IDP configuration to modify.

Body

Update a SAMLIDP settings

enabledboolean | nullableoptional

Enable or disable the specified SAMLIDP in a site.

namestring | nullableoptional

The new name of the target SAMLIDP.

descriptionstring | nullableoptional

A user-defined SAMLIDP description.

themeIdinteger · int32 | nullableoptional

Specifies the SAMLIDP theme

idpEntityIDstring | nullableoptional

The IDP entity ID

idpCertificatestring | nullableoptional

The IDP certificate

logonURLstring | nullableoptional

The logon URL

logoutURLstring | nullableoptional

The logout URL

allowUnencryptedAssertionboolean | nullableoptional

Allow unencrypted assertion

hoststring | nullableoptional

Host name of gateway This specified gateway will receive the calls for SP URLs.

spCertificatestring | nullableoptional

Specifies the service provider certificate

attributeTypestring · enumoptional

SAML Attributes

Available options:

attributeEnabledboolean | nullableoptional

Enable or disable an attribute of a specified SAMLIDP

attributeSAMLstring | nullableoptional

Specifies the SAMLIDP attribute.

attributeADstring | nullableoptional

Specifies the AD attribute.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/SAMLIDP/{id}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "enabled": true,
    "name": "text",
    "description": "text",
    "themeId": 1,
    "idpEntityID": "text",
    "idpCertificate": "text",
    "logonURL": "text",
    "logoutURL": "text",
    "allowUnencryptedAssertion": true,
    "host": "text",
    "spCertificate": "text",
    "attributeType": [
      "0 = UserPrincipalName",
      "1 = ImmutableID",
      "2 = SID",
      "3 = sAMAccountName",
      "4 = Custom"
    ],
    "attributeEnabled": true,
    "attributeSAML": "text",
    "attributeAD": "text"
  }'

204

401

404

No Content