indykite

package module
v0.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 4, 2023 License: Apache-2.0 Imports: 0 Imported by: 0

README

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"

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.20 or later
  • An 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 console 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-----"
}

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.

Documentation

Overview

Package indykite is the root of the packages used to access IndyKite Platform.

Debugging To see gRPC logs, set the environment variable GRPC_GO_LOG_SEVERITY_LEVEL. See https://pkg.go.dev/google.golang.org/grpc/grpclog for more information. For HTTP logging, set the GODEBUG environment variable to "http2debug=1" or "http2debug=2".

Directories

Path Synopsis
Package authorization implements the IndyKite Authorization Service API Client.
Package authorization implements the IndyKite Authorization Service API Client.
Package config implement the Configuration Management Client.
Package config implement the Configuration Management Client.
Package errors provides a convenient way to deal with SDK errors.
Package errors provides a convenient way to deal with SDK errors.
examples
authorization/cmd
Package cmd implements the CLI commands.
Package cmd implements the CLI commands.
config/cmd
Package cmd implements the CLI commands.
Package cmd implements the CLI commands.
identity/cmd
Package cmd implements the CLI commands.
Package cmd implements the CLI commands.
ingest/cmd
Package cmd implements the CLI commands.
Package cmd implements the CLI commands.
oauth2/cmd
Package cmd implements the CLI commands.
Package cmd implements the CLI commands.
gen
indykite/identity/v1beta1
Package identityv1beta1 is generated from proto package.
Package identityv1beta1 is generated from proto package.
indykite/identity/v1beta2
Package identityv1beta2 is generated from proto package.
Package identityv1beta2 is generated from proto package.
indykite/objects/v1beta1
Package objectsv1beta1 is generated from proto package.
Package objectsv1beta1 is generated from proto package.
Package grpc defines the helper functions to simplify the gRPC client connections.
Package grpc defines the helper functions to simplify the gRPC client connections.
config
Package config implements the standard client configuration file parser.
Package config implements the standard client configuration file parser.
internal
Package internal contains Dial settings and helpers
Package internal contains Dial settings and helpers
jwt
Package jwt implements an oauth2.JWTokenSource implementation.
Package jwt implements an oauth2.JWTokenSource implementation.
Package identity implements the IndyKite Identity Service API Client.
Package identity implements the IndyKite Identity Service API Client.
Package ingest implements the IndyKite Ingest Service API Client.
Package ingest implements the IndyKite Ingest Service API Client.
Package oauth2 implements helper functions for implementing OAuth2 Applications for provider.
Package oauth2 implements helper functions for implementing OAuth2 Applications for provider.
Package test contains helper functions for unit testing.
Package test contains helper functions for unit testing.
authorization/v1beta1
Package authorization is a generated GoMock package.
Package authorization is a generated GoMock package.
config/v1beta1
Package config is a generated GoMock package.
Package config is a generated GoMock package.
identity/v1beta2
Package identity is a generated GoMock package.
Package identity is a generated GoMock package.
ingest/v1beta2
Package ingest is a generated GoMock package.
Package ingest is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL