Toggle SAML IdP
Turn a SAML IdP on or off without changing its settings. Turning it off hides its button and signs out everyone who signs in with it, at once, in every region: ask first, naming its linked_users. Turning it on shows the button again; it needs the endpoint_saml feature on the plan of the account that owns the endpoint (Enterprise), and is refused while the endpoint is paused. Turning off always works, so an account whose plan no longer includes SAML can still switch its IdPs off. In the dashboard: Turn off on the IdP's row.
Needs the endpoints:update permission.
Path parameters
uuid string (uuid) Req
The endpoint's
uuid from /endpoints.idp_uuid string (uuid) Req
The IdP's
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
enabled boolean Req
true turns it on, false turns it off and signs its users out.Response (200 OK)
uuid string (uuid)
The IdP.
enabled boolean
As saved.
signed_out_users integer
How many users were signed out.
Errors
400 Bad Request
Invalid JSON, or
enabled is missing (enabled is required: true or false).401 Unauthorized
Missing auth.
403 Forbidden
Caller lacks the
endpoints:update permission, or, to turn it on, the plan doesn't include SAML single sign-on ("entitlement_required": "endpoint_saml").404 Not Found
Endpoint doesn't exist or doesn't belong to the calling account, or the IdP isn't this endpoint's (
SAML IdP not found).409 Conflict
Turning it on while the endpoint is paused.
503 Service Unavailable
SAML single sign-on isn't available yet. Try again in a few minutes.Request — turn it off
curl -X PUT "https://api.ngris.com/v1/endpoints/019bb1e4-e785-77d2-9966-c3cff31d0a0e/saml/idps/019c6a2e-4b10-7c3d-9e21-5a7f0b8c1d23/toggle" \
-H "X-API-KEY: <your_api_key>" \
-H "Content-Type: application/json" \
-d '{"enabled": false}'
CLI
ngris api saml-idps set-enabled 019bb1e4-e785-77d2-9966-c3cff31d0a0e 019c6a2e-4b10-7c3d-9e21-5a7f0b8c1d23 --enabled=false
Response
{
"uuid": "019c6a2e-4b10-7c3d-9e21-5a7f0b8c1d23",
"enabled": false,
"signed_out_users": 12
}
Was this helpful?