Install SSO integration

This endpoint is used to install a SSO integration.

Leave Feedback

URL

GET https://api.opsramp.com/api/v2/tenants/{tenantId}/integrations/install/{intgId}

Sample URLs

https://api.opsramp.com/api/v2/tenants/client_8/integrations/install/OKTA

Parameters

FieldData TypeDescription
displayNameStringName used to identify the integration where the integration type is selected as OTHER.

singleSignOnAuthentication

  • type
  • issueURL
  • redirectionUrl
  • logoutUrl
  • certificate
String
  • Type of authentication.
  • URL of the SSO.
  • Redirection URL.
  • URL displayed when user logouts.
  • Certificate issued by the SSO system.

 

uninstallReason

String(Optional) Reason for uninstalling the integration.

Status code

200 OK

Install integration using Okta type SSO authentication

Sample request

{
      "singleSignOnAuthentication" : {
		"type" : "Okta",
		"issuerUrl" : "https://localhost.com",
		"redirectionUrl" : "https://localhost.com",
		"logoutUrl" : "https://localhost.com",
		"certificate" : "MIIDrTCCAxagAwIBAgIBADANBgkqhkiG9w0BAQQFADCBnDEbMBkGA1UEChMSVGhlIFNhbXBsZSBDb21wYW55MRQwEgYDVQQLEwtDQSBEaXZpc2lvbjEcMBoGCSqGSIb3DQEJARYNY2FAc2FtcGxlLmNvbTETMBEGA1UEBxMKTWV0cm9wb2xpczERMA8GA1UECBMITmV3IFlvcmsxCzAJBgNVBAYTAlVTMRQwEgYDVQQDEwtUU0MgUm9vdCBDQTAeFw0wMTEyMDgwNDI3MDVaFw0wMjEyMDgwNDI3MDVaMIGcMRswGQYDVQQKExJUaGUgU2FtcGxlIENvbXBhbnkxFDASBgNVBAsTC0NBIERpdmlzaW9uMRwwGgYJKoZIhvcNAQkBFg1jYUBzYW1wbGUuY29tMRMwEQYDVQQHEwpNZXRyb3BvbGlzMREwDwYDVQQIEwhOZXcgWW9yazELMAkGA1UEBhMCVVMxFDASBgNVBAMTC1RTQyBSb290IENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDaiAwfKB6ZBtnTRTIo6ddomt0S9ec0NcuvtJogt0s9dXpHowh98FCDjnLtCi8du6LDTZluhlOtTFARPlV/LVnpsbyMCXMsG2qpdjJop+XIBdvoCz2HpGXjUmym8WLqt+coWwJqUSwiEba74JG93v7TU+Xcvc005MWnxmKZzDR3QIDAQABo4H8MIH5MAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFGvyytrBtEquMX2dreysixMlPMMIHJBgNVHSMEgcEwgb6AFGvyytrBtEquMX2dreysixMlPMoYGipIGfMIGcMRswGQYDVQQKExJUaGUgU2FtcGxlIENvbXBhbnkxFDASBgNVBAsTC0NBIERpdmlzaW9uMRwwGgYJKoZIhvcNAQkBFg1jYUBzYW1wbGUuY29tMRMwEQYDVQQHEwpNZXRyb3BvbGlzMREwDwYDVQQIEwhOZXcgWW9yazELMAkGA1UEBhMCVVMxFDASBgNVBAMTC1RTQyBSb290IENBggEAMA0GCSqGSIb3DQEBBAUAA4GBABclymJfsPOUazNQO8aIaxwVbXWS+8AFEkMMRx6O68ICAMubQBvs8Buz3ALXhqYeFS5G13pW2ZnAlSdTkSTKkE5wGZ1RYSfyiEKXb+uOKhDN9LnajDzaMPkNDU2NDXDzSqHk9ZiE1boQaMzjNLu+KabTLpmL9uXvFA/i+gdenFHv"
	}
}

Sample response

{
    "id": "INTG-70ba0f52-cef2-45a6-b46c-526c80afa85c",
    "integration": {
                     "id": "OKTA",
                     "name": "Okta"
                   },
    "singleSignOnAuthentication": {
        "type": "Okta",
        "issuerUrl": "https://localhost.com",
        "redirectionUrl": "https://localhost.com",
        "logoutUrl": "https://localhost.com"
    }

}

Install integration using other types of SSO authentication

Sample request

{
	"displayName":"testSSOIntg",
	"singleSignOnAuthentication" : {
		"type" : "Other",
		"issuerUrl" : "https://localhost.com",
		"redirectionUrl" : "https://localhost.com",
		"logoutUrl" : "https://localhost.com",
		"certificate" : "MIIDrTCCAxagAwIBAgIBADANBgkqhkiG9w0BAQQFADCBnDEbMBkGA1UEChMSVGhlIFNhbXBsZSBDb21wYW55MRQwEgYDVQQLEwtDQSBEaXZpc2lvbjEcMBoGCSqGSIb3DQEJARYNY2FAc2FtcGxlLmNvbTETMBEGA1UEBxMKTWV0cm9wb2xpczERMA8GA1UECBMITmV3IFlvcmsxCzAJBgNVBAYTAlVTMRQwEgYDVQQDEwtUU0MgUm9vdCBDQTAeFw0wMTEyMDgwNDI3MDVaFw0wMjEyMDgwNDI3MDVaMIGcMRswGQYDVQQKExJUaGUgU2FtcGxlIENvbXBhbnkxFDASBgNVBAsTC0NBIERpdmlzaW9uMRwwGgYJKoZIhvcNAQkBFg1jYUBzYW1wbGUuY29tMRMwEQYDVQQHEwpNZXRyb3BvbGlzMREwDwYDVQQIEwhOZXcgWW9yazELMAkGA1UEBhMCVVMxFDASBgNVBAMTC1RTQyBSb290IENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDaiAwfKB6ZBtnTRTIo6ddomt0S9ec0NcuvtJogt0s9dXpHowh98FCDjnLtCi8du6LDTZluhlOtTFARPlV/LVnpsbyMCXMsG2qpdjJop+XIBdvoCz2HpGXjUmym8WLqt+coWwJqUSwiEba74JG93v7TU+Xcvc005MWnxmKZzDR3QIDAQABo4H8MIH5MAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFGvyytrBtEquMX2dreysixMlPMMIHJBgNVHSMEgcEwgb6AFGvyytrBtEquMX2dreysixMlPMoYGipIGfMIGcMRswGQYDVQQKExJUaGUgU2FtcGxlIENvbXBhbnkxFDASBgNVBAsTC0NBIERpdmlzaW9uMRwwGgYJKoZIhvcNAQkBFg1jYUBzYW1wbGUuY29tMRMwEQYDVQQHEwpNZXRyb3BvbGlzMREwDwYDVQQIEwhOZXcgWW9yazELMAkGA1UEBhMCVVMxFDASBgNVBAMTC1RTQyBSb290IENBggEAMA0GCSqGSIb3DQEBBAUAA4GBABclymJfsPOUazNQO8aIaxwVbXWS+8AFEkMMRx6O68ICAMubQBvs8Buz3ALXhqYeFS5G13pW2ZnAlSdTkSTKkE5wGZ1RYSfyiEKXb+uOKhDN9LnajDzaMPkNDU2NDXDzSqHk9ZiE1boQaMzjNLu+KabTLpmL9uXvFA/i+gdenFHv"
	}

}

Sample response

{
    "id": "INTG-4d3042af-af4e-4fa0-9629-b23ab6d745da",
    "displayName": "testIntg",
    "integration": {
        "id": "OTHER",
        "name": "Other"
    },
    "singleSignOnAuthentication": {
        "type": "Other",
        "issuerUrl": "https://localhost.com",
        "redirectionUrl": "https://localhost.com",
        "logoutUrl": "https://localhost.com"
    }
}