Authenticators endpoint

Using this endpoint you can rename and delete authenticators. Renaming is done with the PATCH command, and deletion with the DELETE command.

Rename an authenticator

HTTP request

PATCH https://{instance}.mauth.nevis.cloud/api/v1/authenticators/{authenticatorId}

Path parameters

Parameter	Type	Required/Optional	Description
authenticatorId	UUID	required	The unique identifier of the authenticator to change the name for.

Request body parameters

Parameter	Type	Required/Optional	Description
name	string	required	The new name of the authenticator, so it can be distinguished if multiple authenticators are used.

Example HTTP request

cURL

cURL code sample for changing an authenticator name

# Set $authenticator_id
curl "https://$instance.mauth.nevis.cloud/api/v1/authenticators/$authenticator_id" \
  -X PATCH \
  -H "Authorization: Bearer $access_key" \
  -H 'Content-Type: application/json' \
  -d "{ \"name\":\"$name\" }"

Python 3

Python code sample for changing an authenticator name

authenticator_id = 'f3ef70fc-9231-48f8-8e81-8eef7826d594'
data = {'name':name}
resp = requests.patch(f'https://{instance}.mauth.nevis.cloud/api/v1/authenticators/{authenticator_id}',
                      headers = {'authorization': f'Bearer {access_key}'},
                      json = data)
print(resp.json())

HTTP response

Field	Type	Description
authenticatorId	UUID	Unique identifier of this authenticator.
name	string	The name of the authenticator provided by the user.
type	enum	Defines the mobile platform for mobile authenticators. The value is ios for iOS, and android for Android.
enrolledAt	string	The date when the authenticator was registered.
updatedAt	string	The date when the authenticator was last updated.
authenticatorType	enum	Determines the type of the authenticator. The value can be appor fido2.
state	enum	Indicates the state of the authenticator.
uaf	DICT	If present, this field contains data related to the FIDO UAF authenticator. Only applicable if the authenticatorType is app.
uaf.userAgent	string	Optional user agent. The client application sends the userAgent when a FIDO UAF authenticator is registered or used for authentication.
uaf.deviceRef	UUID	Unique identifier of the physical device. This value will not change other than in specific scenarios: Can the Device Ref of the authenticator change?
uaf.userDisabledPushNotification	boolean	Indicates if a user is disabled (true) or enabled (false) notifications for their application. When disabled, push authentication is not possible.
lastLoginDateSuccess	string	The date of the last successfull login with this authenticator.
lastLoginDateFailure	string	The date of the last failed login with this authenticator.

note

The lastLoginDateSuccess and lastLoginDateFailure fields are only updated on FIDO2 authenticators.

Example HTTP response

Authenticator updated

200 OK: Authenticator is updated.

{
  "authenticatorId": "f3ef70fc-9231-48f8-8e81-8eef7826d594",
  "name": "Personal Phone",
  "type": "ios",
  "enrolledAt": "2020-10-09T08:44:36Z",
  "updatedAt": "2020-10-09T08:44:36Z",
  "authenticatorType": "app",
  "state": "active",
  "uaf": {
    "userAgent": "NMASDK/3.3.2.447 (iPhone13,2; iPhoneOS 16.6) ch.nevis.accessapp.muvonda/2.7.20812.812",
    "deviceRef": "be4b7fe8-1785-4818-9550-bb8cd7153fff",
    "userDisabledPushNotification": false
  }
}

{
  "authenticatorId": "e312772c-c9d0-4746-aa10-5dba62ae7da0",
  "name": "fido2 auth",
  "authenticatorType": "fido2",
  "state": "active",
  "enrolledAt": "2023-02-27T14:46:54Z",
  "updatedAt": "2023-07-11T14:14:31Z",
  "fido2": {
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.0.0 Safari/537.36",
    "rpId": "my-instance-a12345.mauth.nevis.cloud",
    "aaguid": "00000000-0000-0000-0000-000000000000",
    "userVerificationRequirement": "preferred",
    "attestationConveyancePreference": "none",
    "residentKeyRequirement": "discouraged"
  },
  "lastLoginDateSuccess": "2024-04-30T12:33:42Z",
  "lastLoginDateFailure": "2024-04-30T12:20:15Z"
}

Authenticator not found

404 Not found: No authenticator with provided authenticatorId exists.

caution

In setups where multiple application backends are used with a single app, authenticators should only be renamed through the app, not the API. This is to avoid a mismatch between the name of the same authenticator on the different backends.

Delete an authenticator

An authenticator is deleted by its unique, permanent authenticatorId. After deleting an authenticator, the user can no longer use this authenticator for authentication.

Irreversible Destructive Action

This action is destructive and cannot be reversed.

HTTP request

DELETE https://{instance}.mauth.nevis.cloud/api/v1/authenticators/{authenticatorId}

Path parameters

Parameter	Type	Required/Optional	Description
authenticatorId	UUID	required	Unique identifier of the authenticator to delete.

Example HTTP request

cURL

Code sample for deleting an authenticator name

# Set $authenticator_id
curl "https://$instance.mauth.nevis.cloud/api/v1/authenticators/$authenticator_id" \
  -X DELETE \
  -H "Authorization: Bearer $access_key"

Python 3

Code sample for deleting an authenticator name

authenticator_id = 'f3ef70fc-9231-48f8-8e81-8eef7826d594'
resp = requests.delete(f'https://{instance}.mauth.nevis.cloud/api/v1/authenticators/{authenticator_id}',
                       headers = {'authorization': f'Bearer {access_key}'})
print(resp.status_code) # => 204

HTTP response

204 No Content: Authenticator is successfully deleted.

404 Not found: No authenticator with provided authenticatorId exists.

No response body is returned in case of successful deletion.