Sso Config Resource
Authorizations
SessionIdstringRequired
SessionId
Body
emailDomainsstring[]Optional
idpMetadataUrlstringOptional
idpMetadataXmlstringOptional
spEntityIdstringOptional
nameIdFormatstringOptional
mandatorybooleanOptional
Responses
200
OK
*/*
protocolstring · enumOptionalPossible values:
enabledbooleanOptional
mandatorybooleanOptional
emailDomainsstring[]Optional
registrationIdstringOptional
ssoInitiationUrlstringOptional
spMetadataUrlstringOptional
post/api/v1/company/sso/saml2
POST /api/v1/company/sso/saml2 HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 132
{
"emailDomains": [
"text"
],
"idpMetadataUrl": "text",
"idpMetadataXml": "text",
"spEntityId": "text",
"nameIdFormat": "text",
"mandatory": true
}200
OK
{
"protocol": "SAML2",
"enabled": true,
"mandatory": true,
"emailDomains": [
"text"
],
"registrationId": "text",
"ssoInitiationUrl": "text",
"spMetadataUrl": "text"
}Authorizations
SessionIdstringRequired
SessionId
Body
emailDomainsstring[]Optional
issuerUristringOptional
clientIdstringOptional
clientSecretstringOptional
scopesstring[]Optional
authorizationUristringOptional
tokenUristringOptional
jwkSetUristringOptional
userInfoUristringOptional
userNameAttributestringOptional
mandatorybooleanOptional
Responses
200
OK
*/*
protocolstring · enumOptionalPossible values:
enabledbooleanOptional
mandatorybooleanOptional
emailDomainsstring[]Optional
registrationIdstringOptional
ssoInitiationUrlstringOptional
spMetadataUrlstringOptional
post/api/v1/company/sso/oidc
POST /api/v1/company/sso/oidc HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 230
{
"emailDomains": [
"text"
],
"issuerUri": "text",
"clientId": "text",
"clientSecret": "text",
"scopes": [
"text"
],
"authorizationUri": "text",
"tokenUri": "text",
"jwkSetUri": "text",
"userInfoUri": "text",
"userNameAttribute": "text",
"mandatory": true
}200
OK
{
"protocol": "SAML2",
"enabled": true,
"mandatory": true,
"emailDomains": [
"text"
],
"registrationId": "text",
"ssoInitiationUrl": "text",
"spMetadataUrl": "text"
}Authorizations
SessionIdstringRequired
SessionId
Responses
200
OK
*/*
protocolstring · enumOptionalPossible values:
enabledbooleanOptional
mandatorybooleanOptional
emailDomainsstring[]Optional
registrationIdstringOptional
ssoInitiationUrlstringOptional
spMetadataUrlstringOptional
get/api/v1/company/sso
GET /api/v1/company/sso HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*
200
OK
{
"protocol": "SAML2",
"enabled": true,
"mandatory": true,
"emailDomains": [
"text"
],
"registrationId": "text",
"ssoInitiationUrl": "text",
"spMetadataUrl": "text"
}Last updated