SAML IDPs
Retrieve information about one or multiple SAML IDP configurations.
Site ID from which to retrieve the SAML IDP configurations (optional).
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.
GET /api/SAMLIDP HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-08T08:29:10.635Z",
"timeLastMod": "2025-07-08T08:29:10.635Z",
"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 a new SAML IDP configuration.
Create a new SAMLIDP
Host name of gateway This specified gateway will receive the calls for SP URLs.
The name of the target SAMLIDP. This must be the actual SAMLIDP name used in the RAS farm.
Site ID in which to create the specified SAMLIDP. If the parameter is omitted, the site ID of the Licensing Server will be used.
Enable or disable the SAMLIDP upon creation. If the parameter is omitted, the SAMLIDP is initialised as Disabled.
A user-defined SAMLIDP description.
Use SAMLIDP with a theme
POST /api/SAMLIDP HTTP/1.1
Host:
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": "2025-07-08T08:29:10.635Z",
"timeLastMod": "2025-07-08T08:29:10.635Z",
"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"
}
}
}
Retrieve information about a particular SAML IDP configuration by ID.
The ID of a SAML IDP configuration for which to retrieve the information.
GET /api/SAMLIDP/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-08T08:29:10.635Z",
"timeLastMod": "2025-07-08T08:29:10.635Z",
"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"
}
}
}
Modify properties of a SAML IDP configuration.
The ID of the SAML IDP configuration to modify.
Update a SAMLIDP settings
Enable or disable the specified SAMLIDP in a site.
The new name of the target SAMLIDP.
A user-defined SAMLIDP description.
Specifies the SAMLIDP theme
The IDP entity ID
The IDP certificate
The logon URL
The logout URL
Allow unencrypted assertion
Host name of gateway This specified gateway will receive the calls for SP URLs.
Specifies the service provider certificate
SAML Attributes
Enable or disable an attribute of a specified SAMLIDP
Specifies the SAMLIDP attribute.
Specifies the AD attribute.
PUT /api/SAMLIDP/{id} HTTP/1.1
Host:
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
Remove a SAML IDP configuration from a site.
The ID of a SAML IDP configuration to remove from the site.
DELETE /api/SAMLIDP/{id} HTTP/1.1
Host:
Accept: */*
No content
Was this helpful?