Endpoint
/api/v2/tenants/{tenantId}/integrations/install/OKTA
Path Parameters
tenantIdstring
categorystring
displayNamestring
singleSignOnAuthenticationobject
Child Parameters
- singleSignOnAuthentication.certificate
- Certificate issued by the SSO system.
- singleSignOnAuthentication.issueURL
- URL of the SSO.
- singleSignOnAuthentication.logoutUrl
- URL displayed when user logouts.
- singleSignOnAuthentication.redirectionUrl
- Redirection URL.
- singleSignOnAuthentication.type
- Type of authentication.
uninstallReasonstring
{
"singleSignOnAuthentication": {
"certificate": "MIIDrTCCAxagAwIBAgIBADANBgkqhkiG9w0BAQQFADCBnDEbMBkGA1UEChMSVGhlIFNhbXBsZSBDb21wYW55MRQwEgYDVQQLEwtDQSBEaXZpc2lvbjEcMBoGCSqGSIb3DQEJARYNY2FAc2FtcGxlLmNvbTETMBEGA1UEBxMKTWV0cm9wb2xpczERMA8GA1UECBMITmV3IFlvcmsxCzAJBgNVBAYTAlVTMRQwEgYDVQQDEwtUU0MgUm9vdCBDQTAeFw0wMTEyMDgwNDI3MDVaFw0wMjEyMDgwNDI3MDVaMIGcMRswGQYDVQQKExJUaGUgU2FtcGxlIENvbXBhbnkxFDASBgNVBAsTC0NBIERpdmlzaW9uMRwwGgYJKoZIhvcNAQkBFg1jYUBzYW1wbGUuY29tMRMwEQYDVQQHEwpNZXRyb3BvbGlzMREwDwYDVQQIEwhOZXcgWW9yazELMAkGA1UEBhMCVVMxFDASBgNVBAMTC1RTQyBSb290IENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDaiAwfKB6ZBtnTRTIo6ddomt0S9ec0NcuvtJogt0s9dXpHowh98FCDjnLtCi8du6LDTZluhlOtTFARPlV/LVnpsbyMCXMsG2qpdjJop+XIBdvoCz2HpGXjUmym8WLqt+coWwJqUSwiEba74JG93v7TU+Xcvc005MWnxmKZzDR3QIDAQABo4H8MIH5MAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFGvyytrBtEquMX2dreysixMlPMMIHJBgNVHSMEgcEwgb6AFGvyytrBtEquMX2dreysixMlPMoYGipIGfMIGcMRswGQYDVQQKExJUaGUgU2FtcGxlIENvbXBhbnkxFDASBgNVBAsTC0NBIERpdmlzaW9uMRwwGgYJKoZIhvcNAQkBFg1jYUBzYW1wbGUuY29tMRMwEQYDVQQHEwpNZXRyb3BvbGlzMREwDwYDVQQIEwhOZXcgWW9yazELMAkGA1UEBhMCVVMxFDASBgNVBAMTC1RTQyBSb290IENBggEAMA0GCSqGSIb3DQEBBAUAA4GBABclymJfsPOUazNQO8aIaxwVbXWS+8AFEkMMRx6O68ICAMubQBvs8Buz3ALXhqYeFS5G13pW2ZnAlSdTkSTKkE5wGZ1RYSfyiEKXb+uOKhDN9LnajDzaMPkNDU2NDXDzSqHk9ZiE1boQaMzjNLu+KabTLpmL9uXvFA/i+gdenFHv",
"issuerUrl": "https://localhost.com",
"logoutUrl": "https://localhost.com",
"redirectionUrl": "https://localhost.com",
"type": "Okta"
}
}
{
"category": "SSO",
"displayName": "testSSOIntg",
"singleSignOnAuthentication": {
"certificate": "MIIDrTCCAxagAwIBAgIBADANBgkqhkiG9w0BAQQFADCBnDEbMBkGA1UEChMSVGhlIFNhbXBsZSBDb21wYW55MRQwEgYDVQQLEwtDQSBEaXZpc2lvbjEcMBoGCSqGSIb3DQEJARYNY2FAc2FtcGxlLmNvbTETMBEGA1UEBxMKTWV0cm9wb2xpczERMA8GA1UECBMITmV3IFlvcmsxCzAJBgNVBAYTAlVTMRQwEgYDVQQDEwtUU0MgUm9vdCBDQTAeFw0wMTEyMDgwNDI3MDVaFw0wMjEyMDgwNDI3MDVaMIGcMRswGQYDVQQKExJUaGUgU2FtcGxlIENvbXBhbnkxFDASBgNVBAsTC0NBIERpdmlzaW9uMRwwGgYJKoZIhvcNAQkBFg1jYUBzYW1wbGUuY29tMRMwEQYDVQQHEwpNZXRyb3BvbGlzMREwDwYDVQQIEwhOZXcgWW9yazELMAkGA1UEBhMCVVMxFDASBgNVBAMTC1RTQyBSb290IENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDaiAwfKB6ZBtnTRTIo6ddomt0S9ec0NcuvtJogt0s9dXpHowh98FCDjnLtCi8du6LDTZluhlOtTFARPlV/LVnpsbyMCXMsG2qpdjJop+XIBdvoCz2HpGXjUmym8WLqt+coWwJqUSwiEba74JG93v7TU+Xcvc005MWnxmKZzDR3QIDAQABo4H8MIH5MAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFGvyytrBtEquMX2dreysixMlPMMIHJBgNVHSMEgcEwgb6AFGvyytrBtEquMX2dreysixMlPMoYGipIGfMIGcMRswGQYDVQQKExJUaGUgU2FtcGxlIENvbXBhbnkxFDASBgNVBAsTC0NBIERpdmlzaW9uMRwwGgYJKoZIhvcNAQkBFg1jYUBzYW1wbGUuY29tMRMwEQYDVQQHEwpNZXRyb3BvbGlzMREwDwYDVQQIEwhOZXcgWW9yazELMAkGA1UEBhMCVVMxFDASBgNVBAMTC1RTQyBSb290IENBggEAMA0GCSqGSIb3DQEBBAUAA4GBABclymJfsPOUazNQO8aIaxwVbXWS+8AFEkMMRx6O68ICAMubQBvs8Buz3ALXhqYeFS5G13pW2ZnAlSdTkSTKkE5wGZ1RYSfyiEKXb+uOKhDN9LnajDzaMPkNDU2NDXDzSqHk9ZiE1boQaMzjNLu+KabTLpmL9uXvFA/i+gdenFHv",
"issuerUrl": "https://localhost.com",
"logoutUrl": "https://localhost.com",
"redirectionUrl": "https://localhost.com",
"type": "CUSTOM"
}
}
Responses
OK
idstring
singleSignOnAuthenticationobject
Child Parameters
- singleSignOnAuthentication.certificate
- Certificate issued by the SSO system.
- singleSignOnAuthentication.issueURL
- URL of the SSO.
- singleSignOnAuthentication.logoutUrl
- URL displayed when user logouts.
- singleSignOnAuthentication.redirectionUrl
- Redirection URL.
- singleSignOnAuthentication.type
- Type of authentication.
ssoInstalledobject
Child Parameters
- ssoInstalled.category
- SSO as Category.
- ssoInstalled.displayName
- Display name of SSO.
- ssoInstalled.installedBy
- SSO installed by.
- ssoInstalled.installedTime
- SSO installed time.
- ssoInstalled.status
- status of the Integration.
{
"id": "INTG-70ba0f52-cef2-45a6-b46c-526c80afa85c",
"integration": {
"id": "OKTA",
"name": "Okta"
},
"singleSignOnAuthentication": {
"issuerUrl": "https://localhost.com",
"logoutUrl": "https://localhost.com",
"redirectionUrl": "https://localhost.com",
"type": "Okta"
}
}
{
"displayName": "testSSOIntg",
"id": "INTG-4d3042af-af4e-4fa0-9629-b23ab6d745da",
"integration": {
"id": "CUSTOM",
"multipleInstallations": true,
"name": "custom"
},
"singleSignOnAuthentication": {
"issuerUrl": "https://localhost.com",
"logoutUrl": "https://localhost.com",
"redirectionUrl": "https://localhost.com",
"type": "Other"
}
}