SAML IDPs

List

Retrieve information about one or multiple SAML IDP configurations.

GET/api/SAMLIDP

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

enabledboolean

Whether the IDP is enabled or not.

namenullable string

Name of the IDP

siteIdinteger (int32)

Site ID

descriptionnullable string

Description of the IDP

themeIdinteger (int32)

The theme ID associated with this SAML configuration

idpEntityIDnullable string

IDP entity ID

idpCertificatenullable string

IDP certificate

logonURLnullable string

Logon URL

logoutURLnullable string

Logout URL

allowUnencryptedAssertionboolean

Allow unencrypted assertion

hostnullable string

Specifies the host name

spEntityIDnullable string

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

spReplyURLnullable string

Specifies where to receive the SAML token.

spLogonURLnullable string

Specifies where to redirect users so that they can authenticate.

spLogoutURLnullable string

Specifies where to redirect users so that they can deauthenticate.

spCertificatenullable string

Specifies the service provider certificate

attributesSAMLIDPAttributes (object)

SAMLIDP Attributes

Request

JavaScriptCurlPython

const response = await fetch('/api/SAMLIDP', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T07:24:51.193Z",
    "timeLastMod": "2024-11-07T07:24:51.193Z",
    "enabled": false,
    "name": "text",
    "description": "text",
    "idpEntityID": "text",
    "idpCertificate": "text",
    "logonURL": "text",
    "logoutURL": "text",
    "allowUnencryptedAssertion": false,
    "host": "text",
    "spEntityID": "text",
    "spReplyURL": "text",
    "spLogonURL": "text",
    "spLogoutURL": "text",
    "spCertificate": "text",
    "attributes": {
      "userPrincipalName": {
        "enabled": false,
        "samlAttribute": "text",
        "adAttribute": "text"
      },
      "immutableID": {
        "enabled": false,
        "samlAttribute": "text",
        "adAttribute": "text"
      },
      "sid": {
        "enabled": false,
        "samlAttribute": "text",
        "adAttribute": "text"
      },
      "sAMAccountName": {
        "enabled": false,
        "samlAttribute": "text",
        "adAttribute": "text"
      },
      "custom": {
        "enabled": false,
        "samlAttribute": "text",
        "adAttribute": "text"
      }
    }
  }
]

Create

Create a new SAML IDP configuration.

POST/api/SAMLIDP

Body

application/json; api-version=1.0

SAML IDP configurations

host*nullable string

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

name*nullable string

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

siteIdinteger (int32)

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

enablednullable boolean

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

descriptionnullable string

A user-defined SAMLIDP description.

themeIdnullable integer (int32)

Use SAMLIDP with a theme

Response

201401409

Created

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

enabledboolean

Whether the IDP is enabled or not.

namenullable string

Name of the IDP

siteIdinteger (int32)

Site ID

descriptionnullable string

Description of the IDP

themeIdinteger (int32)

The theme ID associated with this SAML configuration

idpEntityIDnullable string

IDP entity ID

idpCertificatenullable string

IDP certificate

logonURLnullable string

Logon URL

logoutURLnullable string

Logout URL

allowUnencryptedAssertionboolean

Allow unencrypted assertion

hostnullable string

Specifies the host name

spEntityIDnullable string

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

spReplyURLnullable string

Specifies where to receive the SAML token.

spLogonURLnullable string

Specifies where to redirect users so that they can authenticate.

spLogoutURLnullable string

Specifies where to redirect users so that they can deauthenticate.

spCertificatenullable string

Specifies the service provider certificate

attributesSAMLIDPAttributes (object)

SAMLIDP Attributes

Request

JavaScriptCurlPython

const response = await fetch('/api/SAMLIDP', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "host": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

201401409

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:24:51.193Z",
  "timeLastMod": "2024-11-07T07:24:51.193Z",
  "enabled": false,
  "name": "text",
  "description": "text",
  "idpEntityID": "text",
  "idpCertificate": "text",
  "logonURL": "text",
  "logoutURL": "text",
  "allowUnencryptedAssertion": false,
  "host": "text",
  "spEntityID": "text",
  "spReplyURL": "text",
  "spLogonURL": "text",
  "spLogoutURL": "text",
  "spCertificate": "text",
  "attributes": {
    "userPrincipalName": {
      "enabled": false,
      "samlAttribute": "text",
      "adAttribute": "text"
    },
    "immutableID": {
      "enabled": false,
      "samlAttribute": "text",
      "adAttribute": "text"
    },
    "sid": {
      "enabled": false,
      "samlAttribute": "text",
      "adAttribute": "text"
    },
    "sAMAccountName": {
      "enabled": false,
      "samlAttribute": "text",
      "adAttribute": "text"
    },
    "custom": {
      "enabled": false,
      "samlAttribute": "text",
      "adAttribute": "text"
    }
  }
}

Get

Retrieve information about a particular SAML IDP configuration by ID.

GET/api/SAMLIDP/{id}

Path parameters

id*integer (int32)

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

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

enabledboolean

Whether the IDP is enabled or not.

namenullable string

Name of the IDP

siteIdinteger (int32)

Site ID

descriptionnullable string

Description of the IDP

themeIdinteger (int32)

The theme ID associated with this SAML configuration

idpEntityIDnullable string

IDP entity ID

idpCertificatenullable string

IDP certificate

logonURLnullable string

Logon URL

logoutURLnullable string

Logout URL

allowUnencryptedAssertionboolean

Allow unencrypted assertion

hostnullable string

Specifies the host name

spEntityIDnullable string

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

spReplyURLnullable string

Specifies where to receive the SAML token.

spLogonURLnullable string

Specifies where to redirect users so that they can authenticate.

spLogoutURLnullable string

Specifies where to redirect users so that they can deauthenticate.

spCertificatenullable string

Specifies the service provider certificate

attributesSAMLIDPAttributes (object)

SAMLIDP Attributes

Request

JavaScriptCurlPython

const response = await fetch('/api/SAMLIDP/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:24:51.193Z",
  "timeLastMod": "2024-11-07T07:24:51.193Z",
  "enabled": false,
  "name": "text",
  "description": "text",
  "idpEntityID": "text",
  "idpCertificate": "text",
  "logonURL": "text",
  "logoutURL": "text",
  "allowUnencryptedAssertion": false,
  "host": "text",
  "spEntityID": "text",
  "spReplyURL": "text",
  "spLogonURL": "text",
  "spLogoutURL": "text",
  "spCertificate": "text",
  "attributes": {
    "userPrincipalName": {
      "enabled": false,
      "samlAttribute": "text",
      "adAttribute": "text"
    },
    "immutableID": {
      "enabled": false,
      "samlAttribute": "text",
      "adAttribute": "text"
    },
    "sid": {
      "enabled": false,
      "samlAttribute": "text",
      "adAttribute": "text"
    },
    "sAMAccountName": {
      "enabled": false,
      "samlAttribute": "text",
      "adAttribute": "text"
    },
    "custom": {
      "enabled": false,
      "samlAttribute": "text",
      "adAttribute": "text"
    }
  }
}

Update

Modify properties of a SAML IDP configuration.

PUT/api/SAMLIDP/{id}

Path parameters

id*integer (int32)

The ID of the SAML IDP configuration to modify.

Body

application/json; api-version=1.0

SAML IDP configurations

enablednullable boolean

Enable or disable the specified SAMLIDP in a site.

namenullable string

The new name of the target SAMLIDP.

descriptionnullable string

A user-defined SAMLIDP description.

themeIdnullable integer (int32)

Specifies the SAMLIDP theme

idpEntityIDnullable string

The IDP entity ID

idpCertificatenullable string

The IDP certificate

logonURLnullable string

The logon URL

logoutURLnullable string

The logout URL

allowUnencryptedAssertionnullable boolean

Allow unencrypted assertion

hostnullable string

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

spCertificatenullable string

Specifies the service provider certificate

attributeTypeAttributeType (enum)

SAML Attributes

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

attributeEnablednullable boolean

Enable or disable an attribute of a specified SAMLIDP

attributeSAMLnullable string

Specifies the SAMLIDP attribute.

attributeADnullable string

Specifies the AD attribute.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/SAMLIDP/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

Remove a SAML IDP configuration from a site.

DELETE/api/SAMLIDP/{id}

Path parameters

id*integer (int32)

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

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/SAMLIDP/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}