Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Sso Config Resource

Configure SAML2 SSO

post
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"
}

Configure OIDC SSO

post
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"
}

Get current SSO configuration

get
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"
}

Remove SSO configuration

delete
Authorizations
SessionIdstringRequired

SessionId

Responses
204

No Content

No content

delete/api/v1/company/sso
DELETE /api/v1/company/sso HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*
204

No Content

No content

Last updated