SAML IDPs

PreviousVersionStatus NextDuplicate

Last updated 11 months ago

Was this helpful?

List

Retrieve information about one or multiple SAML IDP configurations.

get

/api/SAMLIDP

Query parameters

SiteIdinteger · int32

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

Namestring

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-03-16T19:35:49.552Z",
    "timeLastMod": "2025-03-16T19:35:49.552Z",
    "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

Create a new SAML IDP configuration.

post

/api/SAMLIDP

Body

hoststring | nullablerequired

<para type="description">Host name of gateway</para> <para type="description">This specified gateway will receive the calls for SP URLs.</para>

namestring | nullablerequired

<para type="description">The name of the target SAMLIDP.</para> <para type="description">This must be the actual SAMLIDP name used in the RAS farm.</para>

siteIdinteger · int32

<para type="description">Site ID in which to create the specified SAMLIDP.</para> <para type="description">If the parameter is omitted, the site ID of the Licensing Server will be used.</para>

enabledboolean | nullable

<para type="description">Enable or disable the SAMLIDP upon creation.</para> <para type="description">If the parameter is omitted, the SAMLIDP is initialised as Disabled.</para>

descriptionstring | nullable

<para type="description">A user-defined SAMLIDP description.</para>

themeIdinteger · int32 | nullable

<para type="description">Use SAMLIDP with a theme</para>

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-03-16T19:35:49.552Z",
  "timeLastMod": "2025-03-16T19:35:49.552Z",
  "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

Get

Retrieve information about a particular SAML IDP configuration by ID.

get

/api/SAMLIDP/{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-03-16T19:35:49.552Z",
  "timeLastMod": "2025-03-16T19:35:49.552Z",
  "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

Update

Modify properties of a SAML IDP configuration.

put

/api/SAMLIDP/{id}

Path parameters

idinteger · int32required

The ID of the SAML IDP configuration to modify.

Body

enabledboolean | nullable

<para type="description">Enable or disable the specified SAMLIDP in a site.</para>

namestring | nullable

<para type="description">The new name of the target SAMLIDP.</para>

descriptionstring | nullable

<para type="description">A user-defined SAMLIDP description.</para>

themeIdinteger · int32 | nullable

<para type="description">Specifies the SAMLIDP theme</para>

idpEntityIDstring | nullable

<para type="description">The IDP entity ID</para>

idpCertificatestring | nullable

<para type="description">The IDP certificate</para>

logonURLstring | nullable

<para type="description">The logon URL</para>

logoutURLstring | nullable

<para type="description">The logout URL</para>

allowUnencryptedAssertionboolean | nullable

<para type="description">Allow unencrypted assertion</para>

hoststring | nullable

<para type="description">Host name of gateway</para> <para type="description">This specified gateway will receive the calls for SP URLs.</para>

spCertificatestring | nullable

<para type="description">Specifies the service provider certificate</para>

attributeTypestring · enum

<para type="synopsis">SAML Attributes</para> <para type="description"></para>

Options: 0 = UserPrincipalName,1 = ImmutableID,2 = SID,3 = sAMAccountName,4 = Custom

attributeEnabledboolean | nullable

<para type="description">Enable or disable an attribute of a specified SAMLIDP</para>

attributeSAMLstring | nullable

<para type="description">Specifies the SAMLIDP attribute.</para>

attributeADstring | nullable

<para type="description">Specifies the AD attribute.</para>

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 body

No Content

Delete

Remove a SAML IDP configuration from a site.

delete

/api/SAMLIDP/{id}

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 body

No Content