> For the complete documentation index, see [llms.txt](https://api-docs.myhappyforce.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.myhappyforce.com/docs/api-reference/sso-config-resource.md).

# Sso Config Resource

## POST /api/v1/company/sso/saml2

> Configure SAML2 SSO

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"SAML2SSOConfigRequest":{"type":"object","properties":{"emailDomains":{"type":"array","items":{"type":"string"},"uniqueItems":true},"idpMetadataUrl":{"type":"string"},"idpMetadataXml":{"type":"string"},"spEntityId":{"type":"string"},"nameIdFormat":{"type":"string"},"mandatory":{"type":"boolean"}}},"SSOConfigResponse":{"type":"object","properties":{"protocol":{"type":"string","enum":["SAML2","OIDC"]},"enabled":{"type":"boolean"},"mandatory":{"type":"boolean"},"emailDomains":{"type":"array","items":{"type":"string"},"uniqueItems":true},"registrationId":{"type":"string"},"ssoInitiationUrl":{"type":"string"},"spMetadataUrl":{"type":"string"}}}}},"paths":{"/api/v1/company/sso/saml2":{"post":{"tags":["sso-config-resource"],"summary":"Configure SAML2 SSO","operationId":"configureSaml2","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SAML2SSOConfigRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SSOConfigResponse"}}}}}}}}}
```

## POST /api/v1/company/sso/oidc

> Configure OIDC SSO

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"OIDCSSOConfigRequest":{"type":"object","properties":{"emailDomains":{"type":"array","items":{"type":"string"},"uniqueItems":true},"issuerUri":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}},"authorizationUri":{"type":"string"},"tokenUri":{"type":"string"},"jwkSetUri":{"type":"string"},"userInfoUri":{"type":"string"},"userNameAttribute":{"type":"string"},"mandatory":{"type":"boolean"}}},"SSOConfigResponse":{"type":"object","properties":{"protocol":{"type":"string","enum":["SAML2","OIDC"]},"enabled":{"type":"boolean"},"mandatory":{"type":"boolean"},"emailDomains":{"type":"array","items":{"type":"string"},"uniqueItems":true},"registrationId":{"type":"string"},"ssoInitiationUrl":{"type":"string"},"spMetadataUrl":{"type":"string"}}}}},"paths":{"/api/v1/company/sso/oidc":{"post":{"tags":["sso-config-resource"],"summary":"Configure OIDC SSO","operationId":"configureOidc","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/OIDCSSOConfigRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SSOConfigResponse"}}}}}}}}}
```

## GET /api/v1/company/sso

> Get current SSO configuration

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"SSOConfigResponse":{"type":"object","properties":{"protocol":{"type":"string","enum":["SAML2","OIDC"]},"enabled":{"type":"boolean"},"mandatory":{"type":"boolean"},"emailDomains":{"type":"array","items":{"type":"string"},"uniqueItems":true},"registrationId":{"type":"string"},"ssoInitiationUrl":{"type":"string"},"spMetadataUrl":{"type":"string"}}}}},"paths":{"/api/v1/company/sso":{"get":{"tags":["sso-config-resource"],"summary":"Get current SSO configuration","operationId":"getConfig","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SSOConfigResponse"}}}}}}}}}
```

## DELETE /api/v1/company/sso

> Remove SSO configuration

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}}},"paths":{"/api/v1/company/sso":{"delete":{"tags":["sso-config-resource"],"summary":"Remove SSO configuration","operationId":"deleteConfig","responses":{"204":{"description":"No Content"}}}}}}
```
