Skip to content

Latest commit

 

History

History
160 lines (110 loc) · 5.6 KB

README.md

File metadata and controls

160 lines (110 loc) · 5.6 KB
Raw

IndyKite Client Libraries for Go

IndyKite is a cloud identity platform built to secure and manage human & non-person (IoT) identities and their data. This repository contains the Golang Library packages for IndyKite Platform Client SDK.

Build codecov Go Report Card Go Reference FOSSA Status

import "github.com/indykite/indykite-sdk-go"

Documentation

In order to access to the platform you must first obtain AppAgent credentials or Service Account credentials. These credentials can be obtained either from the Admin Console or request one from your point of contact at IndyKite.

Requirements

  • Go version 1.21 or later
  • AppSpace, App, AppAgent, and AppAgent credentials for all APIs except for Config API
  • Service account credentials for Config API

Getting Started

Initial settings

  1. You need to have a configuration json file to be able to use the IndyKite Proto SDK. You can get it from your Indykite contact or from Indykite hub if you have access to it.

    Example configuration file:

{
  "appSpaceId": "gid:AAAAAimlBsA9X0Gnlv2UTituW4Q",
  "baseUrl": "https://jarvis.indykite.com",
  "applicationId": "gid:AAAABKiMFRKkFEiEn3c-izbz9sk",
  "appAgentId": "gid:AAAABUqz8GXJB0cDikdAH8ywz8I",
  "endpoint": "jarvis.indykite.com",
  "privateKeyJWK": {
    "kty": "EC",
    "d": "aa",
    "use": "sig",
    "crv": "P-256",
    "kid": "2e5lIxxb6obIwpok",
    "x": "6d83se2Eg",
    "y": "lshzMo",
    "alg": "ES256"
  },
  "privateKeyPKCS8Base64": "LS0tLS==",
  "privateKeyPKCS8": "-----BEGIN PRIVATE KEY-----\nM\n-----END PRIVATE KEY-----"
}

A token lifetime is 1h by default. You can change this time (from 2 minutes to 24h) by adding a tokenLifetime parameter.

It will have to be valid with: https://pkg.go.dev/time#ParseDuration.

Examples: 30m, 1.5h, 2h45m

Example in the json file:

{
 ...
  "privateKeyPKCS8": "-----BEGIN PRIVATE KEY-----\nM\n-----END PRIVATE KEY-----",
  "tokenLifetime": "30m"
}

Conditionally optional parameters:

  • baseUrl
  • defaultTenantId
  • endpoint

  1. You have two choices to set up the necessary credentials. You either pass the json to the INDYKITE_APPLICATION_CREDENTIALS environment variable or set the INDYKITE_APPLICATION_CREDENTIALS_FILE environment variable to the configuration file's path.

    1. on Linux and OSX

      export INDYKITE_APPLICATION_CREDENTIALS='{"appSpaceId":"00000000-0000-4000-a000-000000000000","appAgentId":"00000000-0000-4000-a000-000000000001","endpoint": "application.indykite.com","privateKeyJWK":{"kty":"EC","d": "abcdef","use": "sig","crv": "P-256","kid":"efghij","x":"klmnop","y":"qrstvw","alg":"ES256"}}'`

      or

      export INDYKITE_APPLICATION_CREDENTIALS_FILE=/Users/xx/configuration.json

    2. on Windows command line

      setex INDYKITE_APPLICATION_CREDENTIALS='{"appSpaceId":"00000000-0000-4000-a000-000000000000","appAgentId":"00000000-0000-4000-a000-000000000001","endpoint": "application.indykite.com","privateKeyJWK":{"kty":"EC","d": "abcdef","use": "sig","crv": "P-256","kid":"efghij","x":"klmnop","y":"qrstvw","alg":"ES256"}}'`

      or

      setex INDYKITE_APPLICATION_CREDENTIALS_FILE "C:\Users\xx\Documents\configuration.json"

Documentation

IndyKite documentation

Terminology

IndyKite glossary

SDK Development

Commit message follows commit guidelines

Roadmap

Checkout our roadmap on our issues page

Contributing

Contribution guidelines for this project

Support, Feedback, Connect with other developers

Feel free to file a bug, submit an issue or give us feedback on our issues page

Vulnerability Reporting

Responsible Disclosure

Changelog

Changelog

Contributers / Acknowledgements

Coming Soon!

What is IndyKite

IndyKite is a cloud identity platform built to secure and manage human & non-person (IoT) identities and their data. Based on open source standards, the cloud platform gives developers the ability to secure data and embed identity controls into their Web 3.0 applications. Empowering the world’s 23 million developers without the need to involve security and identity specialists.

License

This project is licensed under the terms of the Apache 2.0 license.