README.md in auth-armor-0.1.1 vs README.md in auth-armor-0.1.2
- old
+ new
@@ -35,32 +35,32 @@
To send an Auth request to the a mobile device or security key, call the `auth_request` method with the following arguments
```ruby
AuthArmor::Client.auth_request(
- auth_profile_id: "AUTH_PROFILE_ID",
+ nickname: "NICKNAME",
action_name: "Login",
short_msg: "This is a test message",
)
```
### Auth Request for Mobile Device
```ruby
AuthArmor::Client.auth_request(
- auth_profile_id: "AUTH_PROFILE_ID",
+ nickname: "NICKNAME",
action_name: "Login",
short_msg: "This is a test message",
accepted_auth_methods: "mobiledevice"
)
```
### Auth Request for Mobile Device when Biometrics are enforced
```ruby
AuthArmor::Client.auth_request(
- auth_profile_id: "AUTH_PROFILE_ID",
+ nickname: "NICKNAME",
action_name: "Login",
short_msg: "This is a test message",
accepted_auth_methods: "mobiledevice",
forcebiometric: true
)
@@ -68,11 +68,11 @@
### Auth Request for Security Key
```ruby
AuthArmor::Client.auth_request(
- auth_profile_id: "AUTH_PROFILE_ID",
+ nickname: "NICKNAME",
action_name: "Login",
short_msg: "This is a test message",
accepted_auth_methods: "securitykey"
)
```
@@ -82,10 +82,16 @@
- `forcebiometric` - this is false by default. It is only applicable if one of the `accepted_auth_methods` is `mobiledevice`
- `accepted_auth_methods` - this can either be `mobiledevice` or `securitykey`. If neither is provided, both auth methods are acceptable.
+- `nonce` - An optional value that is signed and returned in the request. This helps validate the response was from your request and no one has done a man-in-the-middle attack.
+
- `timeout_in_seconds` - this is the amount of time you want to allow the auth to be valid before it expires. The min is 15, and max is 300. If not provided, the default time for the project is used.
+
+- `latitude` - this is the latitude where the request originated from.
+
+- `langitude` - this is the longitude where the request originated from. If provided, location details will show in the push message about the origin of the request.
## Invite Request
To generate an invite, call the `invite_request` method with a `nickname`