akeyless

Akeyless - the Ruby gem for the Akeyless API

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

This SDK is automatically generated by the OpenAPI Generator project:

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

To install this gem, use:

gem install akeyless

Getting started

require 'akeyless'

# default: public API Gateway
config = Akeyless::Configuration.new

# use port 8081 exposed by the deployment:
config.server_index = nil
config.scheme = 'https'
config.host =  'gateway.company.com:8081'

# use port 8080 exposed by the deployment with /v2 prefix: 
config.server_index = nil
config.scheme = 'https'
config.host =  'gateway.company.com:8080/v2'


api = Akeyless::V2Api.new(Akeyless::ApiClient.new(config))

# auth using email and password
body = Akeyless::Auth.new
body.admin_email = '[email protected]'
body.admin_password = 'strong-password'
body.access_type = "password"

result = api.auth(body)
token = result.token

# get secret value using the token
body = Akeyless::GetSecretValue.new
body.token = token
body.names = ['my-secret']
result = api.get_secret_value(body)

Documentation for API Endpoints

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

Class Method HTTP request Description
Akeyless::V2Api assoc_role_auth_method POST /assoc-role-am
Akeyless::V2Api assoc_target_item POST /assoc-target-item
Akeyless::V2Api auth POST /auth
Akeyless::V2Api configure POST /configure
Akeyless::V2Api connect POST /connect
Akeyless::V2Api create_artifactory_target POST /create-artifactory-target
Akeyless::V2Api create_auth_method POST /create-auth-method
Akeyless::V2Api create_auth_method_awsiam POST /create-auth-method-aws-iam
Akeyless::V2Api create_auth_method_azure_ad POST /create-auth-method-azure-ad
Akeyless::V2Api create_auth_method_cert POST /create-auth-method-cert
Akeyless::V2Api create_auth_method_gcp POST /create-auth-method-gcp
Akeyless::V2Api create_auth_method_huawei POST /create-auth-method-huawei
Akeyless::V2Api create_auth_method_k8_s POST /create-auth-method-k8s
Akeyless::V2Api create_auth_method_ldap POST /create-auth-method-ldap
Akeyless::V2Api create_auth_method_o_auth2 POST /create-auth-method-oauth2
Akeyless::V2Api create_auth_method_oidc POST /create-auth-method-oidc
Akeyless::V2Api create_auth_method_saml POST /create-auth-method-saml
Akeyless::V2Api create_auth_method_universal_identity POST /create-auth-method-universal-identity
Akeyless::V2Api create_aws_target POST /create-aws-target
Akeyless::V2Api create_azure_target POST /create-azure-target
Akeyless::V2Api create_certificate POST /create-certificate
Akeyless::V2Api create_classic_key POST /create-classic-key
Akeyless::V2Api create_db_target POST /create-db-target
Akeyless::V2Api create_dfc_key POST /create-dfc-key
Akeyless::V2Api create_dockerhub_target POST /create-dockerhub-target
Akeyless::V2Api create_dynamic_secret POST /create-dynamic-secret
Akeyless::V2Api create_eks_target POST /create-eks-target
Akeyless::V2Api create_event_forwarder POST /create-event-forwarder
Akeyless::V2Api create_gcp_target POST /create-gcp-target
Akeyless::V2Api create_github_target POST /create-github-target
Akeyless::V2Api create_gke_target POST /create-gke-target
Akeyless::V2Api create_key POST /create-key
Akeyless::V2Api create_native_k8_s_target POST /create-k8s-target
Akeyless::V2Api create_ping_target POST /create-ping-target
Akeyless::V2Api create_pki_cert_issuer POST /create-pki-cert-issuer
Akeyless::V2Api create_rabbit_mq_target POST /create-rabbitmq-target
Akeyless::V2Api create_role POST /create-role
Akeyless::V2Api create_rotated_secret POST /create-rotated-secret
Akeyless::V2Api create_salesforce_target POST /create-salesforce-target
Akeyless::V2Api create_secret POST /create-secret
Akeyless::V2Api create_ssh_cert_issuer POST /create-ssh-cert-issuer
Akeyless::V2Api create_ssh_target POST /create-ssh-target
Akeyless::V2Api create_tokenizer POST /create-tokenizer
Akeyless::V2Api create_web_target POST /create-web-target
Akeyless::V2Api createldap_target POST /create-ldap-target
Akeyless::V2Api decrypt POST /decrypt
Akeyless::V2Api decrypt_gpg POST /decrypt-gpg
Akeyless::V2Api decrypt_pkcs1 POST /decrypt-pkcs1
Akeyless::V2Api decrypt_with_classic_key POST /decrypt-with-classic-key
Akeyless::V2Api delete_auth_method POST /delete-auth-method
Akeyless::V2Api delete_auth_methods POST /delete-auth-methods
Akeyless::V2Api delete_event_forwarder POST /delete-event-forwarder
Akeyless::V2Api delete_item POST /delete-item
Akeyless::V2Api delete_items POST /delete-items
Akeyless::V2Api delete_role POST /delete-role
Akeyless::V2Api delete_role_association POST /delete-assoc
Akeyless::V2Api delete_role_rule POST /delete-role-rule
Akeyless::V2Api delete_roles POST /delete-roles
Akeyless::V2Api delete_target POST /delete-target
Akeyless::V2Api delete_target_association POST /delete-assoc-target-item
Akeyless::V2Api delete_targets POST /delete-targets
Akeyless::V2Api describe_item POST /describe-item
Akeyless::V2Api describe_permissions POST /describe-permissions
Akeyless::V2Api describe_sub_claims POST /describe-sub-claims
Akeyless::V2Api detokenize POST /detokenize
Akeyless::V2Api encrypt POST /encrypt
Akeyless::V2Api encrypt_gpg POST /encrypt-gpg
Akeyless::V2Api encrypt_with_classic_key POST /encrypt-with-classic-key
Akeyless::V2Api export_classic_key POST /export-classic-key
Akeyless::V2Api gateway_create_k8_s_auth_config POST /gateway-create-k8s-auth-config
Akeyless::V2Api gateway_create_migration POST /gateway-create-migration
Akeyless::V2Api gateway_create_producer_artifactory POST /gateway-create-producer-artifactory
Akeyless::V2Api gateway_create_producer_aws POST /gateway-create-producer-aws
Akeyless::V2Api gateway_create_producer_azure POST /gateway-create-producer-azure
Akeyless::V2Api gateway_create_producer_cassandra POST /gateway-create-producer-cassandra
Akeyless::V2Api gateway_create_producer_certificate_automation POST /gateway-create-producer-certificate-automation
Akeyless::V2Api gateway_create_producer_custom POST /gateway-create-producer-custom
Akeyless::V2Api gateway_create_producer_dockerhub POST /gateway-create-producer-dockerhub
Akeyless::V2Api gateway_create_producer_eks POST /gateway-create-producer-eks
Akeyless::V2Api gateway_create_producer_gcp POST /gateway-create-producer-gcp
Akeyless::V2Api gateway_create_producer_github POST /gateway-create-producer-github
Akeyless::V2Api gateway_create_producer_gke POST /gateway-create-producer-gke
Akeyless::V2Api gateway_create_producer_hana_db POST /gateway-create-producer-hanadb
Akeyless::V2Api gateway_create_producer_ldap POST /gateway-create-producer-ldap
Akeyless::V2Api gateway_create_producer_mongo POST /gateway-create-producer-mongo
Akeyless::V2Api gateway_create_producer_mssql POST /gateway-create-producer-mssql
Akeyless::V2Api gateway_create_producer_my_sql POST /gateway-create-producer-mysql
Akeyless::V2Api gateway_create_producer_native_k8_s POST /gateway-create-producer-k8s
Akeyless::V2Api gateway_create_producer_oracle_db POST /gateway-create-producer-oracle
Akeyless::V2Api gateway_create_producer_ping POST /gateway-create-producer-ping
Akeyless::V2Api gateway_create_producer_postgre_sql POST /gateway-create-producer-postgresql
Akeyless::V2Api gateway_create_producer_rabbit_mq POST /gateway-create-producer-rabbitmq
Akeyless::V2Api gateway_create_producer_rdp POST /gateway-create-producer-rdp
Akeyless::V2Api gateway_create_producer_redshift POST /gateway-create-producer-redshift
Akeyless::V2Api gateway_create_producer_snowflake POST /gateway-create-producer-snowflake
Akeyless::V2Api gateway_delete_allowed_management_access POST /gateway-delete-allowed-management-access
Akeyless::V2Api gateway_delete_k8_s_auth_config POST /gateway-delete-k8s-auth-config
Akeyless::V2Api gateway_delete_migration POST /gateway-delete-migration
Akeyless::V2Api gateway_delete_producer POST /gateway-delete-producer
Akeyless::V2Api gateway_get_config POST /gateway-get-config
Akeyless::V2Api gateway_get_k8_s_auth_config POST /gateway-get-k8s-auth-config
Akeyless::V2Api gateway_get_ldap_auth_config POST /gateway-get-ldap-auth-config
Akeyless::V2Api gateway_get_migration POST /gateway-get-migration
Akeyless::V2Api gateway_get_producer POST /gateway-get-producer
Akeyless::V2Api gateway_get_tmp_users POST /gateway-get-producer-tmp-creds
Akeyless::V2Api gateway_list_allowed_management_access POST /gateway-list-allowed-management-access
Akeyless::V2Api gateway_list_migration POST /gateway-list-migration
Akeyless::V2Api gateway_list_producers POST /gateway-list-producers
Akeyless::V2Api gateway_migrate_personal_items POST /gateway-migrate-personal-items
Akeyless::V2Api gateway_revoke_tmp_users POST /gateway-revoke-producer-tmp-creds
Akeyless::V2Api gateway_start_producer POST /gateway-start-producer
Akeyless::V2Api gateway_status_migration POST /gateway-migration-status
Akeyless::V2Api gateway_stop_producer POST /gateway-stop-producer
Akeyless::V2Api gateway_sync_migration POST /gateway-sync-migration
Akeyless::V2Api gateway_update_item POST /gateway-update-item
Akeyless::V2Api gateway_update_k8_s_auth_config POST /gateway-update-k8s-auth-config
Akeyless::V2Api gateway_update_ldap_auth_config POST /gateway-update-ldap-auth-config
Akeyless::V2Api gateway_update_migration POST /gateway-update-migration
Akeyless::V2Api gateway_update_producer_artifactory POST /gateway-update-producer-artifactory
Akeyless::V2Api gateway_update_producer_aws POST /gateway-update-producer-aws
Akeyless::V2Api gateway_update_producer_azure POST /gateway-update-producer-azure
Akeyless::V2Api gateway_update_producer_cassandra POST /gateway-update-producer-cassandra
Akeyless::V2Api gateway_update_producer_certificate_automation POST /gateway-update-producer-certificate-automation
Akeyless::V2Api gateway_update_producer_custom POST /gateway-update-producer-custom
Akeyless::V2Api gateway_update_producer_dockerhub POST /gateway-update-producer-dockerhub
Akeyless::V2Api gateway_update_producer_eks POST /gateway-update-producer-eks
Akeyless::V2Api gateway_update_producer_gcp POST /gateway-update-producer-gcp
Akeyless::V2Api gateway_update_producer_github POST /gateway-update-producer-github
Akeyless::V2Api gateway_update_producer_gke POST /gateway-update-producer-gke
Akeyless::V2Api gateway_update_producer_hana_db POST /gateway-update-producer-hana
Akeyless::V2Api gateway_update_producer_ldap POST /gateway-update-producer-ldap
Akeyless::V2Api gateway_update_producer_mongo POST /gateway-update-producer-mongo
Akeyless::V2Api gateway_update_producer_mssql POST /gateway-update-producer-mssql
Akeyless::V2Api gateway_update_producer_my_sql POST /gateway-update-producer-mysql
Akeyless::V2Api gateway_update_producer_native_k8_s POST /gateway-update-producer-k8s
Akeyless::V2Api gateway_update_producer_oracle_db POST /gateway-update-producer-oracle
Akeyless::V2Api gateway_update_producer_ping POST /gateway-update-producer-ping
Akeyless::V2Api gateway_update_producer_postgre_sql POST /gateway-update-producer-postgresql
Akeyless::V2Api gateway_update_producer_rabbit_mq POST /gateway-update-producer-rabbitmq
Akeyless::V2Api gateway_update_producer_rdp POST /gateway-update-producer-rdp
Akeyless::V2Api gateway_update_producer_redshift POST /gateway-update-producer-redshift
Akeyless::V2Api gateway_update_producer_snowflake POST /gateway-update-producer-snowflake
Akeyless::V2Api gateway_update_tls_cert POST /gateway-update-tls-cert
Akeyless::V2Api gateway_update_tmp_users POST /gateway-update-producer-tmp-creds
Akeyless::V2Api get_account_logo POST /get-account-logo
Akeyless::V2Api get_account_settings POST /get-account-settings
Akeyless::V2Api get_auth_method POST /get-auth-method
Akeyless::V2Api get_certificate_value POST /get-certificate-value
Akeyless::V2Api get_dynamic_secret_value POST /get-dynamic-secret-value
Akeyless::V2Api get_event_forwarder POST /get-event-forwarder
Akeyless::V2Api get_kube_exec_creds POST /get-kube-exec-creds
Akeyless::V2Api get_pki_certificate POST /get-pki-certificate
Akeyless::V2Api get_role POST /get-role
Akeyless::V2Api get_rotated_secret_value POST /get-rotated-secret-value
Akeyless::V2Api get_rsa_public POST /get-rsa-public
Akeyless::V2Api get_secret_value POST /get-secret-value
Akeyless::V2Api get_ssh_certificate POST /get-ssh-certificate
Akeyless::V2Api get_tags POST /get-tags
Akeyless::V2Api get_target POST /get-target
Akeyless::V2Api get_target_details POST /get-target-details
Akeyless::V2Api kmip_client_delete_rule POST /kmip-client-delete-rule
Akeyless::V2Api kmip_client_set_rule POST /kmip-client-set-rule
Akeyless::V2Api kmip_create_client POST /kmip-create-client
Akeyless::V2Api kmip_delete_client POST /kmip-delete-client
Akeyless::V2Api kmip_delete_server DELETE /kmip-delete-environment
Akeyless::V2Api kmip_describe_client POST /kmip-get-client
Akeyless::V2Api kmip_describe_server POST /kmip-get-environment
Akeyless::V2Api kmip_list_clients POST /kmip-list-clients
Akeyless::V2Api kmip_move_server POST /kmip-move-environment
Akeyless::V2Api kmip_renew_client_certificate POST /kmip-renew-client
Akeyless::V2Api kmip_renew_server_certificate POST /kmip-renew-environment
Akeyless::V2Api kmip_server_setup POST /kmip-create-environment
Akeyless::V2Api kmip_set_server_state POST /kmip-set-environment-state
Akeyless::V2Api list_auth_methods POST /list-auth-methods
Akeyless::V2Api list_gateways POST /list-gateways
Akeyless::V2Api list_items POST /list-items
Akeyless::V2Api list_roles POST /list-roles
Akeyless::V2Api list_shared_items POST /list-shared-items
Akeyless::V2Api list_sra_bastions POST /list-sra-bastions
Akeyless::V2Api list_targets POST /list-targets
Akeyless::V2Api move_objects POST /move-objects
Akeyless::V2Api raw_creds POST /raw-creds
Akeyless::V2Api refresh_key POST /refresh-key
Akeyless::V2Api request_access POST /request-access
Akeyless::V2Api reverse_rbac POST /reverse-rbac
Akeyless::V2Api revoke_creds POST /revoke-creds
Akeyless::V2Api rollback_secret POST /rollback-secret
Akeyless::V2Api rotate_key POST /rotate-key
Akeyless::V2Api rotate_secret POST /gateway-rotate-secret
Akeyless::V2Api set_item_state POST /set-item-state
Akeyless::V2Api set_role_rule POST /set-role-rule
Akeyless::V2Api share_item POST /share-item
Akeyless::V2Api sign_gpg POST /sign-gpg
Akeyless::V2Api sign_jwt_with_classic_key POST /sign-jwt-with-classic-key
Akeyless::V2Api sign_pkcs1 POST /sign-pkcs1
Akeyless::V2Api sign_pki_cert_with_classic_key POST /sign-pki-cert-with-classic-key
Akeyless::V2Api static_creds_auth POST /static-creds-auth
Akeyless::V2Api tokenize POST /tokenize
Akeyless::V2Api uid_create_child_token POST /uid-create-child-token
Akeyless::V2Api uid_generate_token POST /uid-generate-token
Akeyless::V2Api uid_list_children POST /uid-list-children
Akeyless::V2Api uid_revoke_token POST /uid-revoke-token
Akeyless::V2Api uid_rotate_token POST /uid-rotate-token
Akeyless::V2Api update_account_settings POST /update-account-settings
Akeyless::V2Api update_artifactory_target POST /update-artifactory-target
Akeyless::V2Api update_assoc POST /update-assoc
Akeyless::V2Api update_auth_method POST /update-auth-method
Akeyless::V2Api update_auth_method_awsiam POST /update-auth-method-aws-iam
Akeyless::V2Api update_auth_method_azure_ad POST /update-auth-method-azure-ad
Akeyless::V2Api update_auth_method_cert POST /update-auth-method-cert
Akeyless::V2Api update_auth_method_gcp POST /update-auth-method-gcp
Akeyless::V2Api update_auth_method_k8_s POST /update-auth-method-k8s
Akeyless::V2Api update_auth_method_ldap POST /update-auth-method-ldap
Akeyless::V2Api update_auth_method_o_auth2 POST /update-auth-method-oauth2
Akeyless::V2Api update_auth_method_oidc POST /update-auth-method-oidc
Akeyless::V2Api update_auth_method_saml POST /update-auth-method-saml
Akeyless::V2Api update_auth_method_universal_identity POST /update-auth-method-universal-identity
Akeyless::V2Api update_aws_target POST /update-aws-target
Akeyless::V2Api update_aws_target_details POST /update-aws-target-details
Akeyless::V2Api update_azure_target POST /update-azure-target
Akeyless::V2Api update_certificate_value POST /update-certificate-value
Akeyless::V2Api update_db_target POST /update-db-target
Akeyless::V2Api update_db_target_details POST /update-db-target-details
Akeyless::V2Api update_dockerhub_target POST /update-dockerhub-target
Akeyless::V2Api update_eks_target POST /update-eks-target
Akeyless::V2Api update_event_forwarder POST /update-event-forwarder
Akeyless::V2Api update_gcp_target POST /update-gcp-target
Akeyless::V2Api update_github_target POST /update-github-target
Akeyless::V2Api update_gke_target POST /update-gke-target
Akeyless::V2Api update_item POST /update-item
Akeyless::V2Api update_ldap_target POST /update-ldap-target
Akeyless::V2Api update_ldap_target_details POST /update-ldap-target-details
Akeyless::V2Api update_native_k8_s_target POST /update-k8s-target
Akeyless::V2Api update_ping_target POST /update-ping-target
Akeyless::V2Api update_pki_cert_issuer POST /update-pki-cert-issuer
Akeyless::V2Api update_rabbit_mq_target POST /update-rabbitmq-target
Akeyless::V2Api update_rabbit_mq_target_details POST /update-rabbitmq-target-details
Akeyless::V2Api update_rdp_target_details POST /update-rdp-target-details
Akeyless::V2Api update_role POST /update-role
Akeyless::V2Api update_rotated_secret POST /update-rotated-secret
Akeyless::V2Api update_rotation_settings POST /update-rotation-settingsrotate-key
Akeyless::V2Api update_salesforce_target POST /update-salesforce-target
Akeyless::V2Api update_secret_val POST /update-secret-val
Akeyless::V2Api update_ssh_cert_issuer POST /update-ssh-cert-issuer
Akeyless::V2Api update_ssh_target POST /update-ssh-target
Akeyless::V2Api update_ssh_target_details POST /update-ssh-target-details
Akeyless::V2Api update_target POST /update-target
Akeyless::V2Api update_target_details POST /update-target-details
Akeyless::V2Api update_web_target POST /update-web-target
Akeyless::V2Api update_web_target_details POST /update-web-target-details
Akeyless::V2Api upload_rsa POST /upload-rsa
Akeyless::V2Api validate_token POST /validate-token
Akeyless::V2Api verify_gpg POST /verify-gpg
Akeyless::V2Api verify_jwt_with_classic_key POST /verify-jwt-with-classic-key
Akeyless::V2Api verify_pkcs1 POST /verify-pkcs1
Akeyless::V2Api verify_pki_cert_with_classic_key POST /verify-pki-cert-with-classic-key

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.