akeyless

package module
v2.20.3 Latest Latest
Warning

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

 Go to latest Published: Nov 29, 2022 License: Apache-2.0 Imports: 22 Imported by: 4

README

Go API client for akeyless

The purpose of this application is to provide access to Akeyless API.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 2.0
  • Package version: 2.20.3
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit http://akeyless.io

To install this package, use:

go get github.com/akeylesslabs/akeyless-go/v2

Getting Started

Please follow the installation procedure and then run the following:

package main

import (
	"context"
	"errors"
	"fmt"
	"log"

	"github.com/akeylesslabs/akeyless-go/v2"
)

func main() {
	ctx := context.Background()
	client := akeyless.NewAPIClient(&akeyless.Configuration{
		Servers: []akeyless.ServerConfiguration{
			{
				// default: public API Gateway
				URL: "https://api.akeyless.io",

				// use port 8081 exposed by the deployment:
				// URL: "https://gateway.company.com:8081",

				// use port 8080 exposed by the deployment with /v2 prefix:
				// URL: "https://gateway.company.com:8080/v2",
			},
		},
	}).V2Api

	authBody := akeyless.NewAuthWithDefaults()
	authBody.AdminEmail = akeyless.PtrString("foobar@example.com")
	authBody.AdminPassword = akeyless.PtrString("strong-password")

	var apiErr akeyless.GenericOpenAPIError

	authOut, _, err := client.Auth(ctx).Body(*authBody).Execute()
	if err != nil {
		if errors.As(err, &apiErr) {
			log.Fatalln("authentication failed:", string(apiErr.Body()))
		}
		log.Fatalln("authentication failed:", err)
	}

	token := authOut.GetToken()

	csBody := akeyless.CreateSecret{
		Name:  "my-secret",
		Value: "some-value",
		Token: &token,
	}
	_, _, err = client.CreateSecret(ctx).Body(csBody).Execute()
	if err != nil {
		if errors.As(err, &apiErr) {
			log.Fatalln("can't create secret:", string(apiErr.Body()))
		}
		log.Fatalln("can't create secret:", err)
	}

	gsvBody := akeyless.GetSecretValue{
		Names: []string{"my-secret"},
		Token: &token,
	}
	gsvOut, _, err := client.GetSecretValue(ctx).Body(gsvBody).Execute()
	if err != nil {
		if errors.As(err, &apiErr) {
			log.Fatalln("can't get secret value:", string(apiErr.Body()))
		}
		log.Fatalln("can't get secret value:", err)
	}

	fmt.Println(gsvOut["my-secret"])
}

Documentation for API Endpoints

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

Class Method HTTP request Description
V2Api AssocRoleAuthMethod Post /assoc-role-am
V2Api AssocTargetItem Post /assoc-target-item
V2Api Auth Post /auth
V2Api Configure Post /configure
V2Api Connect Post /connect
V2Api CreateAWSTarget Post /create-aws-target
V2Api CreateArtifactoryTarget Post /create-artifactory-target
V2Api CreateAuthMethod Post /create-auth-method
V2Api CreateAuthMethodAWSIAM Post /create-auth-method-aws-iam
V2Api CreateAuthMethodAzureAD Post /create-auth-method-azure-ad
V2Api CreateAuthMethodCert Post /create-auth-method-cert
V2Api CreateAuthMethodGCP Post /create-auth-method-gcp
V2Api CreateAuthMethodHuawei Post /create-auth-method-huawei
V2Api CreateAuthMethodK8S Post /create-auth-method-k8s
V2Api CreateAuthMethodLDAP Post /create-auth-method-ldap
V2Api CreateAuthMethodOAuth2 Post /create-auth-method-oauth2
V2Api CreateAuthMethodOIDC Post /create-auth-method-oidc
V2Api CreateAuthMethodSAML Post /create-auth-method-saml
V2Api CreateAuthMethodUniversalIdentity Post /create-auth-method-universal-identity
V2Api CreateAzureTarget Post /create-azure-target
V2Api CreateClassicKey Post /create-classic-key
V2Api CreateDBTarget Post /create-db-target
V2Api CreateDFCKey Post /create-dfc-key
V2Api CreateDockerhubTarget Post /create-dockerhub-target
V2Api CreateDynamicSecret Post /create-dynamic-secret
V2Api CreateEKSTarget Post /create-eks-target
V2Api CreateGKETarget Post /create-gke-target
V2Api CreateGcpTarget Post /create-gcp-target
V2Api CreateGithubTarget Post /create-github-target
V2Api CreateKey Post /create-key
V2Api CreateNativeK8STarget Post /create-k8s-target
V2Api CreatePKICertIssuer Post /create-pki-cert-issuer
V2Api CreateRabbitMQTarget Post /create-rabbitmq-target
V2Api CreateRole Post /create-role
V2Api CreateRotatedSecret Post /create-rotated-secret
V2Api CreateSSHCertIssuer Post /create-ssh-cert-issuer
V2Api CreateSSHTarget Post /create-ssh-target
V2Api CreateSalesforceTarget Post /create-salesforce-target
V2Api CreateSecret Post /create-secret
V2Api CreateTokenizer Post /create-tokenizer
V2Api CreateWebTarget Post /create-web-target
V2Api CreateldapTarget Post /create-ldap-target
V2Api Decrypt Post /decrypt
V2Api DecryptPKCS1 Post /decrypt-pkcs1
V2Api DecryptWithClassicKey Post /decrypt-with-classic-key
V2Api DeleteAuthMethod Post /delete-auth-method
V2Api DeleteAuthMethods Post /delete-auth-methods
V2Api DeleteItem Post /delete-item
V2Api DeleteItems Post /delete-items
V2Api DeleteRole Post /delete-role
V2Api DeleteRoleAssociation Post /delete-assoc
V2Api DeleteRoleRule Post /delete-role-rule
V2Api DeleteRoles Post /delete-roles
V2Api DeleteTarget Post /delete-target
V2Api DeleteTargetAssociation Post /delete-assoc-target-item
V2Api DeleteTargets Post /delete-targets
V2Api DescribeItem Post /describe-item
V2Api DescribePermissions Post /describe-permissions
V2Api DescribeSubClaims Post /describe-sub-claims
V2Api Detokenize Post /detokenize
V2Api Encrypt Post /encrypt
V2Api EncryptWithClassicKey Post /encrypt-with-classic-key
V2Api ExportClassicKey Get /export-classic-key
V2Api GatewayAddAllowedManagementAccess Post /gateway-add-allow-management-access
V2Api GatewayCreateK8SAuthConfig Post /gateway-create-k8s-auth-config
V2Api GatewayCreateMigration Post /gateway-create-migration
V2Api GatewayCreateProducerArtifactory Post /gateway-create-producer-artifactory
V2Api GatewayCreateProducerAws Post /gateway-create-producer-aws
V2Api GatewayCreateProducerAzure Post /gateway-create-producer-azure
V2Api GatewayCreateProducerCassandra Post /gateway-create-producer-cassandra
V2Api GatewayCreateProducerCertificateAutomation Post /gateway-create-producer-certificate-automation
V2Api GatewayCreateProducerCustom Post /gateway-create-producer-custom
V2Api GatewayCreateProducerDockerhub Post /gateway-create-producer-dockerhub
V2Api GatewayCreateProducerEks Post /gateway-create-producer-eks
V2Api GatewayCreateProducerGcp Post /gateway-create-producer-gcp
V2Api GatewayCreateProducerGithub Post /gateway-create-producer-github
V2Api GatewayCreateProducerGke Post /gateway-create-producer-gke
V2Api GatewayCreateProducerHanaDb Post /gateway-create-producer-hanadb
V2Api GatewayCreateProducerLdap Post /gateway-create-producer-ldap
V2Api GatewayCreateProducerMSSQL Post /gateway-create-producer-mssql
V2Api GatewayCreateProducerMongo Post /gateway-create-producer-mongo
V2Api GatewayCreateProducerMySQL Post /gateway-create-producer-mysql
V2Api GatewayCreateProducerNativeK8S Post /gateway-create-producer-k8s
V2Api GatewayCreateProducerOracleDb Post /gateway-create-producer-oracle
V2Api GatewayCreateProducerPostgreSQL Post /gateway-create-producer-postgresql
V2Api GatewayCreateProducerRabbitMQ Post /gateway-create-producer-rabbitmq
V2Api GatewayCreateProducerRdp Post /gateway-create-producer-rdp
V2Api GatewayCreateProducerRedshift Post /gateway-create-producer-redshift
V2Api GatewayCreateProducerSnowflake Post /gateway-create-producer-snowflake
V2Api GatewayDeleteAllowedManagementAccess Post /gateway-delete-allowed-management-access
V2Api GatewayDeleteK8SAuthConfig Post /gateway-delete-k8s-auth-config
V2Api GatewayDeleteMigration Post /gateway-delete-migration
V2Api GatewayDeleteProducer Post /gateway-delete-producer
V2Api GatewayGetConfig Post /gateway-get-config
V2Api GatewayGetK8SAuthConfig Post /gateway-get-k8s-auth-config
V2Api GatewayGetLdapAuthConfig Post /gateway-get-ldap-auth-config
V2Api GatewayGetMigration Post /gateway-get-migration
V2Api GatewayGetProducer Post /gateway-get-producer
V2Api GatewayGetTmpUsers Post /gateway-get-producer-tmp-creds
V2Api GatewayListAllowedManagementAccess Post /gateway-list-allowed-management-access
V2Api GatewayListMigration Post /gateway-list-migration
V2Api GatewayListProducers Post /gateway-list-producers
V2Api GatewayMigratePersonalItems Post /gateway-migrate-personal-items
V2Api GatewayRevokeTmpUsers Post /gateway-revoke-producer-tmp-creds
V2Api GatewayStartProducer Post /gateway-start-producer
V2Api GatewayStatusMigration Post /gateway-migration-status
V2Api GatewayStopProducer Post /gateway-stop-producer
V2Api GatewaySyncMigration Post /gateway-sync-migration
V2Api GatewayUpdateItem Post /gateway-update-item
V2Api GatewayUpdateK8SAuthConfig Post /gateway-update-k8s-auth-config
V2Api GatewayUpdateLdapAuthConfig Post /gateway-update-ldap-auth-config
V2Api GatewayUpdateMigration Post /gateway-update-migration
V2Api GatewayUpdateProducerArtifactory Post /gateway-update-producer-artifactory
V2Api GatewayUpdateProducerAws Post /gateway-update-producer-aws
V2Api GatewayUpdateProducerAzure Post /gateway-update-producer-azure
V2Api GatewayUpdateProducerCassandra Post /gateway-update-producer-cassandra
V2Api GatewayUpdateProducerCertificateAutomation Post /gateway-update-producer-certificate-automation
V2Api GatewayUpdateProducerCustom Post /gateway-update-producer-custom
V2Api GatewayUpdateProducerDockerhub Post /gateway-update-producer-dockerhub
V2Api GatewayUpdateProducerEks Post /gateway-update-producer-eks
V2Api GatewayUpdateProducerGcp Post /gateway-update-producer-gcp
V2Api GatewayUpdateProducerGithub Post /gateway-update-producer-github
V2Api GatewayUpdateProducerGke Post /gateway-update-producer-gke
V2Api GatewayUpdateProducerHanaDb Post /gateway-update-producer-hana
V2Api GatewayUpdateProducerLdap Post /gateway-update-producer-ldap
V2Api GatewayUpdateProducerMSSQL Post /gateway-update-producer-mssql
V2Api GatewayUpdateProducerMongo Post /gateway-update-producer-mongo
V2Api GatewayUpdateProducerMySQL Post /gateway-update-producer-mysql
V2Api GatewayUpdateProducerNativeK8S Post /gateway-update-producer-k8s
V2Api GatewayUpdateProducerOracleDb Post /gateway-update-producer-oracle
V2Api GatewayUpdateProducerPostgreSQL Post /gateway-update-producer-postgresql
V2Api GatewayUpdateProducerRabbitMQ Post /gateway-update-producer-rabbitmq
V2Api GatewayUpdateProducerRdp Post /gateway-update-producer-rdp
V2Api GatewayUpdateProducerRedshift Post /gateway-update-producer-redshift
V2Api GatewayUpdateProducerSnowflake Post /gateway-update-producer-snowflake
V2Api GatewayUpdateTmpUsers Post /gateway-update-producer-tmp-creds
V2Api GetAccountLogo Post /get-account-logo
V2Api GetAccountSettings Post /get-account-settings
V2Api GetAuthMethod Post /get-auth-method
V2Api GetDynamicSecretValue Post /get-dynamic-secret-value
V2Api GetKubeExecCreds Post /get-kube-exec-creds
V2Api GetPKICertificate Post /get-pki-certificate
V2Api GetRSAPublic Post /get-rsa-public
V2Api GetRole Post /get-role
V2Api GetRotatedSecretValue Post /get-rotated-secret-value
V2Api GetSSHCertificate Post /get-ssh-certificate
V2Api GetSecretValue Post /get-secret-value
V2Api GetTags Post /get-tags
V2Api GetTarget Post /get-target
V2Api GetTargetDetails Post /get-target-details
V2Api KmipClientDeleteRule Post /kmip-client-delete-rule
V2Api KmipClientSetRule Post /kmip-client-set-rule
V2Api KmipCreateClient Post /kmip-create-client
V2Api KmipDeleteClient Post /kmip-delete-client
V2Api KmipDeleteServer Delete /kmip-delete-environment
V2Api KmipDescribeClient Post /kmip-get-client
V2Api KmipDescribeServer Post /kmip-get-environment
V2Api KmipListClients Post /kmip-list-clients
V2Api KmipMoveServer Post /kmip-move-environment
V2Api KmipRenewClientCertificate Post /kmip-renew-client
V2Api KmipRenewServerCertificate Post /kmip-renew-environment
V2Api KmipServerSetup Post /kmip-create-environment
V2Api KmipSetServerState Post /kmip-set-environment-state
V2Api ListAuthMethods Post /list-auth-methods
V2Api ListGateways Post /list-gateways
V2Api ListItems Post /list-items
V2Api ListRoles Post /list-roles
V2Api ListSRABastions Post /list-sra-bastions
V2Api ListTargets Post /list-targets
V2Api MoveObjects Post /move-objects
V2Api RawCreds Post /raw-creds
V2Api RefreshKey Post /refresh-key
V2Api ReverseRBAC Post /reverse-rbac
V2Api RevokeCreds Post /revoke-creds
V2Api RollbackSecret Post /rollback-secret
V2Api RotateKey Post /rotate-key
V2Api RotateSecret Post /gateway-rotate-secret
V2Api SetItemState Post /set-item-state
V2Api SetRoleRule Post /set-role-rule
V2Api ShareItem Post /share-item
V2Api SignJWTWithClassicKey Post /sign-jwt-with-classic-key
V2Api SignPKCS1 Post /sign-pkcs1
V2Api SignPKICertWithClassicKey Post /sign-pki-cert-with-classic-key
V2Api StaticCredsAuth Post /static-creds-auth
V2Api Tokenize Post /tokenize
V2Api UidCreateChildToken Post /uid-create-child-token
V2Api UidGenerateToken Post /uid-generate-token
V2Api UidListChildren Post /uid-list-children
V2Api UidRevokeToken Post /uid-revoke-token
V2Api UidRotateToken Post /uid-rotate-token
V2Api UpdateAWSTarget Post /update-aws-target
V2Api UpdateAWSTargetDetails Post /update-aws-target-details
V2Api UpdateAccountSettings Post /update-account-settings
V2Api UpdateArtifactoryTarget Post /update-artifactory-target
V2Api UpdateAssoc Post /update-assoc
V2Api UpdateAuthMethod Post /update-auth-method
V2Api UpdateAuthMethodAWSIAM Post /update-auth-method-aws-iam
V2Api UpdateAuthMethodAzureAD Post /update-auth-method-azure-ad
V2Api UpdateAuthMethodCert Post /update-auth-method-cert
V2Api UpdateAuthMethodGCP Post /update-auth-method-gcp
V2Api UpdateAuthMethodK8S Post /update-auth-method-k8s
V2Api UpdateAuthMethodLDAP Post /update-auth-method-ldap
V2Api UpdateAuthMethodOAuth2 Post /update-auth-method-oauth2
V2Api UpdateAuthMethodOIDC Post /update-auth-method-oidc
V2Api UpdateAuthMethodSAML Post /update-auth-method-saml
V2Api UpdateAuthMethodUniversalIdentity Post /update-auth-method-universal-identity
V2Api UpdateAzureTarget Post /update-azure-target
V2Api UpdateDBTarget Post /update-db-target
V2Api UpdateDBTargetDetails Post /update-db-target-details
V2Api UpdateDockerhubTarget Post /update-dockerhub-target
V2Api UpdateEKSTarget Post /update-eks-target
V2Api UpdateGKETarget Post /update-gke-target
V2Api UpdateGcpTarget Post /update-gcp-target
V2Api UpdateGithubTarget Post /update-github-target
V2Api UpdateItem Post /update-item
V2Api UpdateLdapTarget Post /update-ldap-target
V2Api UpdateLdapTargetDetails Post /update-ldap-target-details
V2Api UpdateNativeK8STarget Post /update-k8s-target
V2Api UpdatePKICertIssuer Post /update-pki-cert-issuer
V2Api UpdateRDPTargetDetails Post /update-rdp-target-details
V2Api UpdateRabbitMQTarget Post /update-rabbitmq-target
V2Api UpdateRabbitMQTargetDetails Post /update-rabbitmq-target-details
V2Api UpdateRole Post /update-role
V2Api UpdateRotatedSecret Post /update-rotated-secret
V2Api UpdateRotationSettings Post /update-rotation-settingsrotate-key
V2Api UpdateSSHCertIssuer Post /update-ssh-cert-issuer
V2Api UpdateSSHTarget Post /update-ssh-target
V2Api UpdateSSHTargetDetails Post /update-ssh-target-details
V2Api UpdateSalesforceTarget Post /update-salesforce-target
V2Api UpdateSecretVal Post /update-secret-val
V2Api UpdateTarget Post /update-target
V2Api UpdateTargetDetails Post /update-target-details
V2Api UpdateWebTarget Post /update-web-target
V2Api UpdateWebTargetDetails Post /update-web-target-details
V2Api UploadRSA Post /upload-rsa
V2Api ValidateToken Post /validate-token
V2Api VerifyJWTWithClassicKey Post /verify-jwt-with-classic-key
V2Api VerifyPKCS1 Post /verify-pkcs1
V2Api VerifyPKICertWithClassicKey Post /verify-pki-cert-with-classic-key

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

support@akeyless.io

Documentation

Documentation is too large to display.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.