akeyless-api-gateway - the Ruby library for AKEYLESS Vault API

RESTFull API for interacting with AKEYLESS Vault API

This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.1.1
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen For more information, please visit https://www.akeyless.io

Installation

Build a gem

To build the Ruby code into a gem:

gem build swagger_client.gemspec

Then either install the gem locally:

gem install ./swagger_client-1.0.0.gem

(for development, run gem install --dev ./swagger_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'swagger_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'swagger_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'swagger_client'

api_instance = SwaggerClient::DefaultApi.new

role_name = 'role_name_example' # String | The role name to associate

am_name = 'am_name_example' # String | The auth method name to associate

token = 'token_example' # String | Access token

opts = { 
  sub_claims: 'sub_claims_example' # String | key/val of sub claims, ex. group=admins,developers
}

begin
  #Create an association between role and auth method
  result = api_instance.assoc_role_am(role_name, am_name, token, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling DefaultApi->assoc_role_am: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://127.0.0.1:8080

Class	Method	HTTP request	Description
SwaggerClient::DefaultApi	assoc_role_am	POST /assoc-role-am	Create an association between role and auth method
SwaggerClient::DefaultApi	auth	POST /auth	Authenticate to the service and returns a token to be used as a profile to execute the CLI without the need for re-authentication
SwaggerClient::DefaultApi	configure	POST /configure	Configure client profile.
SwaggerClient::DefaultApi	create_auth_method	POST /create-auth-method	Create a new Auth Method in the account
SwaggerClient::DefaultApi	create_auth_method_aws_iam	POST /create-auth-method-aws-iam	Create a new Auth Method that will be able to authenticate using AWS IAM credentials
SwaggerClient::DefaultApi	create_auth_method_azure_ad	POST /create-auth-method-azure-ad	Create a new Auth Method that will be able to authenticate using Azure Active Directory credentials
SwaggerClient::DefaultApi	create_auth_method_ldap	POST /create-auth-method-ldap	Create a new Auth Method that will be able to authenticate using LDAP
SwaggerClient::DefaultApi	create_auth_method_oauth2	POST /create-auth-method-oauth2	Create a new Auth Method that will be able to authenticate using OpenId/OAuth2
SwaggerClient::DefaultApi	create_auth_method_saml	POST /create-auth-method-saml	Create a new Auth Method that will be able to authenticate using SAML
SwaggerClient::DefaultApi	create_dynamic_secret	POST /create-dynamic-secret	Creates a new dynamic secret item
SwaggerClient::DefaultApi	create_key	POST /create-key	Creates a new key
SwaggerClient::DefaultApi	create_pki_cert_issuer	POST /create-pki-cert-issuer	Creates a new PKI certificate issuer
SwaggerClient::DefaultApi	create_role	POST /create-role	Creates a new role
SwaggerClient::DefaultApi	create_secret	POST /create-secret	Creates a new secret item
SwaggerClient::DefaultApi	create_ssh_cert_issuer	POST /create-ssh-cert-issuer	Creates a new SSH certificate issuer
SwaggerClient::DefaultApi	decrypt	POST /decrypt	Decrypts ciphertext into plaintext by using an AES key
SwaggerClient::DefaultApi	decrypt_file	POST /decrypt-file	Decrypts a file by using an AES key
SwaggerClient::DefaultApi	decrypt_pkcs1	POST /decrypt-pkcs1	Decrypts a plaintext using RSA and the padding scheme from PKCS#1 v1.5
SwaggerClient::DefaultApi	delete_assoc	POST /delete-assoc	Delete an association between role and auth method
SwaggerClient::DefaultApi	delete_auth_method	POST /delete-auth-method	Delete the Auth Method
SwaggerClient::DefaultApi	delete_item	POST /delete-item	Delete an item or an item version
SwaggerClient::DefaultApi	delete_role	POST /delete-role	Delete a role
SwaggerClient::DefaultApi	delete_role_rule	POST /delete-role-rule	Delete a rule from a role
SwaggerClient::DefaultApi	describe_item	POST /describe-item	Returns the item details
SwaggerClient::DefaultApi	encrypt	POST /encrypt	Encrypts plaintext into ciphertext by using an AES key
SwaggerClient::DefaultApi	encrypt_file	POST /encrypt-file	Encrypts a file by using an AES key
SwaggerClient::DefaultApi	encrypt_pkcs1	POST /encrypt-pkcs1	Encrypts the given message with RSA and the padding scheme from PKCS#1 v1.5
SwaggerClient::DefaultApi	get_auth_method	POST /get-auth-method	Returns an information about the Auth Method
SwaggerClient::DefaultApi	get_cloud_identity	POST /get-cloud-identity	Get Cloud Identity Token (relevant only for access-type=azure_ad,aws_iam)
SwaggerClient::DefaultApi	get_dynamic_secret_value	POST /get-dynamic-secret-value	Get dynamic secret value
SwaggerClient::DefaultApi	get_kube_exec_creds	POST /get-kube-exec-creds	Get credentials for authentication with Kubernetes cluster based on a PKI Cert Issuer
SwaggerClient::DefaultApi	get_pki_certificate	POST /get-pki-certificate	Generates PKI certificate
SwaggerClient::DefaultApi	get_role	POST /get-role	Get role details
SwaggerClient::DefaultApi	get_rsa_public	POST /get-rsa-public	Obtain the public key from a specific RSA private key
SwaggerClient::DefaultApi	get_secret_value	POST /get-secret-value	Get static secret value
SwaggerClient::DefaultApi	get_ssh_certificate	POST /get-ssh-certificate	Generates SSH certificate
SwaggerClient::DefaultApi	help	POST /help	help text
SwaggerClient::DefaultApi	list_auth_methods	POST /list-auth-methods	Returns a list of all the Auth Methods in the account
SwaggerClient::DefaultApi	list_items	POST /list-items	Returns a list of all accessible items
SwaggerClient::DefaultApi	list_roles	POST /list-roles	Returns a list of all roles in the account
SwaggerClient::DefaultApi	reverse_rbac	POST /reverse-rbac	See which authentication methods have access to a particular object
SwaggerClient::DefaultApi	set_role_rule	POST /set-role-rule	Set a rule to a role
SwaggerClient::DefaultApi	sign_pkcs1	POST /sign-pkcs1	Calculates the signature of hashed using RSASSA-PKCS1-V1_5-SIGN from RSA PKCS#1 v1.5
SwaggerClient::DefaultApi	unconfigure	POST /unconfigure	Remove Configuration of client profile.
SwaggerClient::DefaultApi	update	POST /update	Update a new AKEYLESS CLI version
SwaggerClient::DefaultApi	update_item	POST /update-item	Update item name and metadata
SwaggerClient::DefaultApi	update_role	POST /update-role	Update role details
SwaggerClient::DefaultApi	update_secret_val	POST /update-secret-val	Update static secret value
SwaggerClient::DefaultApi	upload_pkcs12	POST /upload-pkcs12	Upload a PKCS#12 key and certificates
SwaggerClient::DefaultApi	upload_rsa	POST /upload-rsa	Upload RSA key
SwaggerClient::DefaultApi	verify_pkcs1	POST /verify-pkcs1	Verifies an RSA PKCS#1 v1.5 signature

Documentation for Models

• SwaggerClient::ErrorReplyObj
• SwaggerClient::ReplyObj

Documentation for Authorization

All endpoints do not require authorization.