Unlink SAML
Stop a user signing in with their SAML IdP. The roles the IdP's groups gave them are removed, the roles you gave stay, and they are signed out at once, in every region. The user stays. List Users shows who signs in with which IdP (saml). In the dashboard: Unlink next to Signs in with <name> (SAML) on the user's page.
Needs the endpoints:update permission. It works whatever the plan, and on a paused endpoint.
Path parameters
uuid string (uuid) Req
The endpoint's
uuid from /endpoints.client_uuid string (uuid) Req
The user's
uuid from List Users. Resolved under this endpoint only.An integer id in the path is refused with 400 integer_id_unsupported (see public IDs). Use the uuid.
Request body
None.
Response (204 No Content)
No body.
Errors
401 Unauthorized
Missing auth.
403 Forbidden
Caller lacks the
endpoints:update permission in the active account.404 Not Found
Endpoint doesn't exist or doesn't belong to the calling account, the user doesn't belong to this endpoint (
endpoint user not found), or the user doesn't sign in with SAML (this endpoint user doesn't sign in with SAML).503 Service Unavailable
SAML single sign-on isn't available yet. Try again in a few minutes.Request
curl -X DELETE \
"https://api.ngris.com/v1/endpoints/019bb1e4-e785-77d2-9966-c3cff31d0a0e/rbac/clients/019b4b9d-d300-736b-8601-153b3d9f70ee/saml" \
-H "X-API-KEY: <your_api_key>"
CLI
ngris api endpoint-users saml-unlink 019bb1e4-e785-77d2-9966-c3cff31d0a0e 019b4b9d-d300-736b-8601-153b3d9f70ee
Was this helpful?