DKBSignDocs

API reference

GETRequires Bearer token

List MFA enrollments

/api/v1/companies/{company}/mfa-enrollments

Company-admin. Per-user MFA status (pending / enrolled), methods, metrics, and policy.

Path parameters

FieldTypeDescription
company
Required
stringPath parameter company.

Query parameters

This endpoint has no query parameters.

Request body

This endpoint does not accept a request body.

Responses

StatusMeaning
200MFA enrollments
401Missing or invalid Bearer token.

Request

curl
curl -X GET 'https://api.dkbsigns.com/api/v1/companies/company/mfa-enrollments' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN'

Response 200

json
{
  "items": [
    {
      "user_id": 4,
      "status": "enrolled",
      "methods": [
        "email"
      ]
    }
  ],
  "metrics": {
    "enrolled": 1,
    "pending": 0
  }
}