Skip to content

Roles & Profiles

Gridy Roles let you create & assign custom authorization roles & permissions to a User when they successfully complete a Gridy authentication challenge. All custom defined roles can be in any text format like JSON or XML up to 5 Kb in size.

You can assign a custom role to a User when requesting a new authentication challenge as part of the challenge request. See here for more details

Gridy Roles are managed via the CLI tool. See examples below for help creating custom defined authorization roles & profiles for your Users.

Settings

Enable Authorization Roles & Permissions

Create & Assign Authorization Roles & Permissions to Users ( default: true )

  java -jar gridy-admin-cli.jar roles --data '{"roles-enabled": true }'

View Authorization Roles & Permissions

View all authorization roles & permissions created

java -jar gridy-admin-cli.jar roles view

Add Authorization Role

Create a new autorization role & permissions ( default: None )

Total Roles

Account type No. of roles
Free10
Developers50
Business100
Community (onPremises)500
Managed500
White Label500
java -jar gridy-admin-cli.jar roles add --data '{
                            "name": "developer_1",
                            "role": "developer",
                            "group": "developer",
                            "permissions": "view_only"
                        }'

Remove Authorization Role

Remove an autorization role & permissions ( default: None )

java -jar gridy-admin-cli.jar roles remove --data '{ "name": "developer_1" } }'

Assign Authorization Role

Assigning a custom authorization role is done when requesting a new Gridy authentication challenge for a User.

An example assign the custom role in Challenge request body below to

{ 
 "id":<Your own reference>,
 "utctime": <UTC Timestamp>,
 "apiUser":<Your Api User ID>,
 "type":150,
 "body":{
   "gridyUser": "<User Email Address>",
   "challengeType": "UserKeyPatternAndPin",
   "challengeExpiry": "FifteenMins",
   "enableQRCode":true,
   "enableAutoVerify":false,
   "profile":"DEFAULT", <----- Assign Your Custom Profile Here
   "status":"NEW"
 }
}