gridy-python-client

Requirements.

Python 3.7+

Installation & Usage

pip install

Install directly from Github using:

pip install git+https://github.com/gridy.io/gridy-python-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/gridy.io/gridy-python-client.git)

Then import the package:

import gridyapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import gridyapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

Python

import gridyapi_client
from gridyapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.gridy.io
# See configuration.py for a list of all supported configuration parameters.
configuration = gridyapi_client.Configuration(
    host="https://api.gridy.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API User Id
configuration.api_user = os.environ["GRIDY_API_USER"]

# Configure API User Secret
configuration.api_secret = os.environ["GRIDY_API_SECRET"]

# Enter a context with an instance of the API client
with gridyapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = gridyapi_client.GridyIDServiceApi(api_client)
    api_request = {
                      "id": < Your ownreference >,
                      "utctime": < UTC Timestamp >,
                      "apiUser": < Your Api User ID >,
                      "type": 150,
                      "body": {
                            "gridyUser": "< User Email Address >",
                            "challengeType": < "UserKeyAndPattern" | "UserKeyPatternAndPin" | "UserKeyAndUserPin" | "UserKeyAndUserFace" | "UserKeyAndUserVoice" >,
                            "challengeExpiry": < "ThreeMins" | "FiveMins" | "TenMins" | "FifteenMins" | "ThirtyMins" | "SixtyMins" >,
                            "enableQRCode": < true | false >,
                            "enableAutoVerify": < true | false >,
                            "profile": "<Your Assigned User Profile Reference>",
                            "status": "NEW"
                        }
                  }  # ApiRequest | The JSON body of the request. Contains the Gridy ID challenge request.

    try:
        # Send or Cancel a Gridy ID MFA challenge request.
        api_response = api_instance.challenge(api_request)
        print("The response of GridyIDServiceApi->challenge:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling GridyIDServiceApi->challenge: %s\n" % e)

Documentation & Examples for API Endpoints

All URIs are relative to https://api.gridy.io

Class	Method	HTTP request	Description
GridyIdServiceApi	challenge	POST /v1/svc/challenge	Send or Cancel a Gridy ID MFA challenge request.
GridyIdServiceApi	verify	POST /v1/svc/verify	Verify a Gridy ID authentication code
GridyIdServiceApi	status	POST /v1/svc/status	Check a Gridy ID MFA challenge status
GridyIdServiceApi	time	POST /v1/svc/time	Get current UTC time
GridyIdServiceApi	blocked	POST /v1/svc/blocked	Check API User defined Blocked Rule