Account Settings

View and update API account settings.

API Account settings are managed using the CLI tool, view usage examples below

Usage

Display Name

Change the Name displayed to a User in a Gridy ID MFA challenge (default: none )

CLI

java -jar gridy-admin-cli.jar settings update --data '{ "display-name": "Your Display Name" }'

Display URL

Change the url displayed to a User in a Gridy ID MFA challenge (default: none )

CLI

java -jar gridy-admin-cli.jar settings update --data '{ "display-url": "Your Display Url" }'

Enable Auto Verify

Auto Verify Gridy ID MFA challenges

CLI

java -jar gridy-admin-cli.jar settings update --data '{ \"autoverify\": true/false }'

Accepted Challenge Types

Accepted Gridy MFA challenge types (default: all)

CLI

java -jar gridy-admin-cli.jar settings update --data '{ "challenge-types": [] }'

Default Challenge Type

Set a default Gridy ID MFA challenge type (default: none)

CLI

java -jar gridy-admin-cli.jar settings update all --data '{ "challenge-type": ''  }'

Max Auth Attempts

Set max failed authentication attempts before blocking a User account (default 10)

CLI

  java -jar gridy-admin-cli.jar settings update all --data '{ "max-attempts": 10  }'

Challenge QR Code

Enable Gridy ID MFA challenge QR codes (default true)

CLI

   java -jar gridy-admin-cli.jar settings update --data '{ "challenge-qrcode": true  }'

Challenge QR Code Logo

Add Your Logo to all Gridy ID MFA challenge QR codes (default: None)

You will need your QR Code Tool Image Ref ID to update your QR code logo. See QR Code Logo Tool for more help.

CLI

   java -jar gridy-admin-cli.jar settings update --data '{ "challenge-qrcode-logo": 'Image Ref ID'  }'

Challenge Expiry

Set Gridy ID MFA challenge default expiry time (default: 30 mins )

CLI

 java -jar gridy-admin-cli.jar settings update --data '{ "challenge-expiry": 30 }' 

Default Role

Assign an authorization role & permissions to your Gridy ID users after successful authentication (default: none )

CLI

 java -jar gridy-admin-cli.jar settings update --data '{ "default-role": "DEFAULT" }'

Time Zone

Set Time Zone (default: UTC )

CLI

java -jar gridy-admin-cli.jar settings update all --data '{ "timezone": "UTC"  }'

Country

Set ISO Country code (default: None )

CLI

java -jar gridy-admin-cli.jar settings update --data '{ \"country-code\": 'NA'  }'

Company Name

Set a Company Name (default: None )

CLI

java -jar gridy-admin-cli.jar account update --data '{ \"company-name\": 'Your Company Name'  }'

Company Address

Set a Company Address (default: None )

CLI

java -jar gridy-admin-cli.jar account update --data '{ "company-address": 'Your Company Address'  }'

Company Number

Set a Company Registered Number (default: None )

CLI

java -jar gridy-admin-cli.jar account update --data '{ "company-number": 'Company Number'  }'