indykite

package module

v0.25.0 Latest Latest Go to latest Published: May 3, 2024 License: Apache-2.0 Imports: 0 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/indykite/indykite-sdk-go

Links

Open Source Insights

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.

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

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

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.

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

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

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".

Source Files ¶

View all Source files

doc.go

Directories ¶

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

Path	Synopsis
authorization Package authorization implements the IndyKite Authorization Service API Client.	Package authorization implements the IndyKite Authorization Service API Client.
config Package config implement the Configuration Management Client.	Package config implement the Configuration Management Client.
errors Package errors provides a convenient way to deal with SDK errors.	Package errors provides a convenient way to deal with SDK errors.
examples
authorization
authorization/cmd Package cmd implements the CLI commands.	Package cmd implements the CLI commands.
config
config/cmd Package cmd implements the CLI commands.	Package cmd implements the CLI commands.
helpers
helpers/cmd Package cmd implements the CLI commands.	Package cmd implements the CLI commands.
identity
identity/cmd Package cmd implements the CLI commands.	Package cmd implements the CLI commands.
ingest
ingest/cmd Package cmd implements the CLI commands.	Package cmd implements the CLI commands.
knowledge
knowledge/cmd Package cmd implements the CLI commands.	Package cmd implements the CLI commands.
oauth2
oauth2/cmd Package cmd implements the CLI commands.	Package cmd implements the CLI commands.
tda
tda/cmd Package cmd implements the CLI commands.	Package cmd implements the CLI commands.
gen
indykite/auditsink/v1beta1
indykite/authorization/v1beta1
indykite/config/v1beta1
indykite/identity/v1beta1
indykite/identity/v1beta2
indykite/ingest/v1beta2
indykite/ingest/v1beta3
indykite/knowledge/objects/v1beta1
indykite/knowledge/v1beta1
indykite/knowledge/v1beta2
indykite/objects/v1beta1 Package objectsv1beta1 is generated from proto package.	Package objectsv1beta1 is generated from proto package.
indykite/objects/v1beta2
indykite/tda/v1beta1
grpc 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.
helpers Package helpers implements the helpers.	Package helpers implements the helpers.
identity Package identity implements the IndyKite Identity Service API Client.	Package identity implements the IndyKite Identity Service API Client.
ingest Package ingest implements the IndyKite Ingest Service API Client.	Package ingest implements the IndyKite Ingest Service API Client.
knowledge Package knowledge implements the IndyKite Identity Knowledge API Client.	Package knowledge implements the IndyKite Identity Knowledge API Client.
oauth2 Package oauth2 implements helper functions for implementing OAuth2 Applications for provider.	Package oauth2 implements helper functions for implementing OAuth2 Applications for provider.
tda Package tda implements the IndyKite TrustedDataAccess Service API Client.	Package tda implements the IndyKite TrustedDataAccess Service API Client.
test 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.
ingest/v1beta3 Package ingest is a generated GoMock package.	Package ingest is a generated GoMock package.
knowledge/v1beta1 Package knowledge is a generated GoMock package.	Package knowledge is a generated GoMock package.
knowledge/v1beta2 Package knowledge is a generated GoMock package.	Package knowledge is a generated GoMock package.
tda/v1beta1 Package tda is a generated GoMock package.	Package tda is a generated GoMock package.