Update SAML IdP
Replace a SAML IdP's settings. It is a full replace: send every setting, as Get SAML IdP answers them, with your changes. A setting left out is reset: the attributes to email, name and groups, the email domains and group rules to none, own_second_step to false. A metadata source left out keeps the current metadata. New metadata must name the same IdP (its entity ID): add another IdP as a new one. To turn it on or off, use Toggle SAML IdP. In the dashboard: Edit on the IdP's row.
Needs the endpoint_saml feature on the plan of the account that owns the endpoint (Enterprise) and the endpoints:update permission. Strict JSON decoding: unknown body fields return 400.
Path parameters
uuid from /endpoints.uuid from List SAML IdPs.An integer id in the path is refused with 400 integer_id_unsupported (see public IDs). Use the uuid.
Request body
The fields of Add SAML IdP: name and join_mode (required), metadata_url or metadata_xml (left out: the current metadata stays), email_domains, email_attribute, name_attribute, groups_attribute, group_roles and own_second_step.
Changed group rules apply at each user's next sign-in.
Response (200 OK)
The IdP, as Get SAML IdP answers it.
Errors
endpoints:update permission, or the plan doesn't include SAML single sign-on ("entitlement_required": "endpoint_saml").SAML IdP not found), or a rule names a role the endpoint doesn't have.the metadata names another IdP (another entity ID): add it as a new IdP instead), another IdP has this name, the endpoint has no address yet, or it is paused.The request is too large: paste at most 1 MiB of metadata, or give its URL.SAML single sign-on isn't available yet. Try again in a few minutes.