Skip to main content
POST
/
api
/
org
/
getSAMLSettings
Get SAML settings
curl --request POST \
  --url https://api2.rhombussystems.com/api/org/getSAMLSettings \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'
{
  "error": true,
  "errorMsg": "<string>",
  "samlSettings": {
    "addUsersOnRoleMismatch": true,
    "enabled": true,
    "enabledForRhombusKey": true,
    "idpMetaDataXml": "<string>",
    "justInTimeAccountProvisioningEnabled": true,
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "registrationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "rhombusKeyAppSettings": {
      "bypassSaml": true,
      "credentialProvisioningRules": {
        "endDateProvisioner": {
          "type": "<string>",
          "value": 123
        },
        "maxMobileCredsAllowed": 123,
        "startDateProvisioner": {
          "type": "<string>",
          "value": 123
        }
      },
      "remoteUnlockEnabled": true,
      "rhombusKeyAccessEnabled": true
    },
    "teamName": "<string>"
  },
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for getting SAML settings (deprecated).

Response

200 - application/json

OK

Response object containing SAML settings (deprecated).

error
boolean | null
errorMsg
string | null
samlSettings
object

List of SAML settings to update

warningMsg
string | null