Update Organization Saml Settings

puthttps://app.fossa.com/api/organizations/{id}/saml

Update SAML SSO settings for an organization

Path parameters

idintegerrequired

Request body (required) · application/json

entryPointstringrequired

Identity Provider Single Sign On URL

certstringrequired

X.509 Certificate from the identity provider

audiencestringrequired

Audience URI / SP Entity ID

orgRoleManagementenum

Whether Organization Roles should be managed by FOSSA, the Identity Provider, or both

fossaidpmixed
teamRoleManagementenum

Whether Teams and Team Roles should be managed by FOSSA, the Identity Provider, or both

fossaidp_teams_fossa_rolesidpmixed
createMissingTeamsboolean

Whether to automatically create teams that are specified in SAML attributes but don't exist in the organization yet

Responses

200OK
idinteger
organizationIdinteger
entryPointstring
certstring
audiencestring
orgRoleManagementenum
fossaidpmixed
teamRoleManagementenum
fossaidp_teams_fossa_rolesidpmixed
createMissingTeamsboolean
callbackUrlstring
loginUrlstring
audienceUrlstring
createdAtstring <date-time>
updatedAtstring <date-time>
400Bad Request
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

401Unauthorized
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

403Forbidden
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

404NotFound
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

Try this endpoint

Build a request and run it against app.fossa.com.

Bearer

Stored in this browser for 24 hours. Try It uses a docs proxy for CORS and does not store tokens server-side.

PUT https://app.fossa.com/api/organizations/1/saml
curl --request PUT \  --url 'https://app.fossa.com/api/organizations/1/saml' \  --header 'accept: application/json' \  --header 'authorization: Bearer YOUR_API_TOKEN' \  --header 'content-type: application/json' \  --data '{  "entryPoint": "https://sso.example.com/saml2/idp",  "cert": "-----BEGIN CERTIFICATE-----\nMIIFczCCA1ugAwIBAgIVANqq2WZ8FdYKSTIb0z2si06t2TnhMA0GCSqGSIb3DQEB\nCwUAMHMxCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDTzEQMA4GA1UEBxMHQm91bGRl\n...\n-----END CERTIFICATE-----",  "audience": "http://localhost:9578/account/saml/1/6a817616-7f73-4381-96f5-01e35908ed80",  "orgRoleManagement": "mixed",  "teamRoleManagement": "idp_teams_fossa_roles",  "createMissingTeams": true}'

Real request. Mutating methods can change data.

Click Try It to run a request and see the response here.
Enter a Bearer token before running this request.

Path params

idintegerrequired
application/json