SAML IDPs

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

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

/api/SAMLIDP

HTTPcURLJavaScriptPython

GET /api/SAMLIDP HTTP/1.1
Accept: */*

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2026-03-10T22:03:28.795Z",
    "timeLastMod": "2026-03-10T22:03:28.795Z",
    "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"
      }
    }
  }
]

Create

post

Create a new SAML IDP configuration.

Body

application/json; api-version=1.0

Create a new SAMLIDP

hoststring · nullableRequired

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

namestring · min: 1 · max: 255 · 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

201

Created

application/json; api-version=1.0

IDP The server or authorization authority that the client can use to authenticate

idinteger · int32Optional

ID of the object.

adminCreatestring · nullableOptional

User who created the object.

adminLastModstring · nullableOptional

User who last modified the object.

timeCreatestring · date-timeOptional

Time when the object was created.

timeLastModstring · date-timeOptional

Time when the object was last modified.

enabledbooleanOptional

Whether the IDP is enabled or not.

namestring · nullableOptional

Name of the IDP

siteIdinteger · int32Optional

Site ID

descriptionstring · nullableOptional

Description of the IDP

themeIdinteger · int32Optional

The theme ID associated with this SAML configuration

idpEntityIDstring · nullableOptional

IDP entity ID

idpCertificatestring · nullableOptional

IDP certificate

logonURLstring · nullableOptional

Logon URL

logoutURLstring · nullableOptional

Logout URL

allowUnencryptedAssertionbooleanOptional

Allow unencrypted assertion

hoststring · nullableOptional

Specifies the host name

spEntityIDstring · nullableOptional

Sends a unique ID as a parameter of the SAML token.

spReplyURLstring · nullableOptional

Specifies where to receive the SAML token.

spLogonURLstring · nullableOptional

Specifies where to redirect users so that they can authenticate.

spLogoutURLstring · nullableOptional

Specifies where to redirect users so that they can deauthenticate.

spCertificatestring · nullableOptional

Specifies the service provider certificate

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

/api/SAMLIDP

HTTPcURLJavaScriptPython

POST /api/SAMLIDP HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 88

{
  "host": "text",
  "name": "text",
  "siteId": 1,
  "enabled": true,
  "description": "text",
  "themeId": 1
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2026-03-10T22:03:28.795Z",
  "timeLastMod": "2026-03-10T22:03:28.795Z",
  "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"
    }
  }
}

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

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

/api/SAMLIDP/{id}

HTTPcURLJavaScriptPython

GET /api/SAMLIDP/{id} HTTP/1.1
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2026-03-10T22:03:28.795Z",
  "timeLastMod": "2026-03-10T22:03:28.795Z",
  "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"
    }
  }
}

Update

put

Modify properties of a SAML IDP configuration.

Path parameters

idinteger · int32Required

The ID of the SAML IDP configuration to modify.

Body

application/json; api-version=1.0

Update a SAMLIDP settings

enabledboolean · nullableOptional

Enable or disable the specified SAMLIDP in a site.

namestring · min: 1 · max: 255 · nullableOptional

The new name of the target SAMLIDP.

descriptionstring · nullableOptional

A user-defined SAMLIDP description.

themeIdinteger · int32 · nullableOptional

Specifies the SAMLIDP theme

idpEntityIDstring · min: 1 · max: 255 · nullableOptional

The IDP entity ID

idpCertificatestring · min: 1 · max: 255 · nullableOptional

The IDP certificate

logonURLstring · nullableOptional

The logon URL

logoutURLstring · nullableOptional

The logout URL

allowUnencryptedAssertionboolean · nullableOptional

Allow unencrypted assertion

hoststring · min: 1 · max: 255 · nullableOptional

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

spCertificatestring · min: 1 · max: 255 · nullableOptional

Specifies the service provider certificate

attributeTypestring · enumOptional

SAML Attributes

Possible values:

attributeEnabledboolean · nullableOptional

Enable or disable an attribute of a specified SAMLIDP

attributeSAMLstring · min: 1 · max: 255 · nullableOptional

Specifies the SAMLIDP attribute.

attributeADstring · min: 1 · max: 255 · nullableOptional

Specifies the AD attribute.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/SAMLIDP/{id}

HTTPcURLJavaScriptPython

PUT /api/SAMLIDP/{id} HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 387

{
  "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"
}

No content

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

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

/api/SAMLIDP/{id}

HTTPcURLJavaScriptPython

DELETE /api/SAMLIDP/{id} HTTP/1.1
Accept: */*

No content