Get Second Step
Whether the endpoint requires a second step of every user (a passkey or an authenticator app after the password or single sign-on), and the counts that say what requiring it changes. In the dashboard: Sign-in & access › Sign-in › Second step. Each user's own second step is second_step in List Users.
Path parameters
uuid string (uuid) Req
The endpoint's
uuid from /endpoints.An integer id in the path is refused with 400 integer_id_unsupported (see public IDs). Use the uuid.
Request body
None.
Response (200 OK)
endpoint_uuid string (uuid)
The endpoint.
required boolean
Every user must pass a second step. When false, the users who set one up are still asked.
users.total integer
Active users.
users.set_up integer
Users with a passkey or an authenticator app.
users.not_set_up integer
Users who set one up at their next sign-in once it's required, those without an email included.
users.not_set_up_without_email integer
Of those, users without an email: they need a setup link.
users.agent_made integer
Users made by
ngris http --basic-auth: they can't have a second step.users.sent_password_with_requests_30d integer
Users who sent their password with requests (
Authorization: Basic) in the last 30 days: those requests are refused once it's required.browsers_without_second_step integer
Browsers signed in without a second step: they sign in again once it's required.
providers_with_own_second_step array of strings (uuid)
The single sign-on providers marked
asks_own_second_step.Errors
401 Unauthorized
Missing auth.
403 Forbidden
Caller lacks the
endpoints:read permission in the active account.404 Not Found
Endpoint doesn't exist or doesn't belong to the calling account.
503 Service Unavailable
The second step isn't available yet.Request
curl "https://api.ngris.com/v1/endpoints/019bb1e4-e785-77d2-9966-c3cff31d0a0e/second-step" \
-H "X-API-KEY: <your_api_key>"
Response
{
"endpoint_uuid": "019bb1e4-e785-77d2-9966-c3cff31d0a0e",
"required": false,
"users": {
"total": 9,
"set_up": 2,
"not_set_up": 6,
"not_set_up_without_email": 1,
"agent_made": 1,
"sent_password_with_requests_30d": 1
},
"browsers_without_second_step": 5,
"providers_with_own_second_step": []
}
Was this helpful?