The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Akeyless Plugin

View this plugin on the Plugins site

withAkeyless: Akeyless Plugin

  • akeylessSecrets (optional)
      Array / List of Nested Object
    • path : String
      The full name of the secret
    • secretValues
        Array / List of Nested Object
      • secretKey : String
        Enter the key name from the JSON secret to retrieve its value. To retrieve all keys, enter 'data'.
      • envVar : String (optional)
      • isRequired : boolean (optional)
        If checked, if a Key that does not exist in the item is set, it will fail
  • akeylessPKIIssuers (optional)
      Array / List of Nested Object
    • path : String
      The full name of the certificate issuer
    • name : String
    • certUserName : String
    • publicKey : String
    • csrBase64 : String
    • ttl : long
      Updated certificate lifetime (must be less than the Certificate Issuer default TTL)
    • secretValues
        Array / List of Nested Object
      • secretKey : String
        Enter the key name from the JSON secret to retrieve its value. To retrieve all keys, enter 'data'.
      • envVar : String (optional)
      • isRequired : boolean (optional)
        If checked, if a Key that does not exist in the item is set, it will fail
  • akeylessSSHIssuers (optional)
      Array / List of Nested Object
    • path : String
      The full name of the certificate issuer
    • name : String
    • certUserName : String
    • publicKey : String
    • ttl : long
      Updated certificate lifetime (must be less than the Certificate Issuer default TTL)
    • secretValues
        Array / List of Nested Object
      • secretKey : String
        Enter the key name from the JSON secret to retrieve its value. To retrieve all keys, enter 'data'.
      • envVar : String (optional)
      • isRequired : boolean (optional)
        If checked, if a Key that does not exist in the item is set, it will fail
  • configuration (optional)
      Nested Object
    • akeylessCredential (optional)
        Nested Choice of Objects
      • $class: 'AccessKeyCredentialsImpl'
        • scope
          Determines where this credential can be used.
          System
          This credential is only available to the object on which the credential is associated. Typically you would use system-scoped credentials for things like email auth, agent connection, etc, i.e. where the Jenkins instance itself is using the credential. Unlike the global scope, this significantly restricts where the credential can be used, thereby providing a higher degree of confidentiality to the credential.
          Global
          This credential is available to the object on which the credential is associated and all objects that are children of that object. Typically you would use global-scoped credentials for things that are needed by jobs.

          In general, a credential is defined in one place (e.g., the credentials configuration page under "Manage Jenkins") and then used in another place (e.g., when connecting to a new SSH build agent). The scope allows you to say "this credential is only used by these places" by looking at the relationship between the two locations.

          • Values: SYSTEM, GLOBAL, USER
        • id : String
          An internal unique ID by which these credentials are identified from jobs and other configuration. Normally left blank, in which case an ID will be generated, which is fine for jobs created using visual forms. Useful to specify explicitly when using credentials from scripted configuration.
        • description : String
          An optional description to help tell similar credentials apart.
        • accessId : String (optional)
        • accessKey (optional)
          • Type: class hudson.util.Secret
        • context (optional)
            Nested Choice of Objects
        • path : String (optional)
      • $class: 'AkeylessCertCredentials'
        • scope
          Determines where this credential can be used.
          System
          This credential is only available to the object on which the credential is associated. Typically you would use system-scoped credentials for things like email auth, agent connection, etc, i.e. where the Jenkins instance itself is using the credential. Unlike the global scope, this significantly restricts where the credential can be used, thereby providing a higher degree of confidentiality to the credential.
          Global
          This credential is available to the object on which the credential is associated and all objects that are children of that object. Typically you would use global-scoped credentials for things that are needed by jobs.

          In general, a credential is defined in one place (e.g., the credentials configuration page under "Manage Jenkins") and then used in another place (e.g., when connecting to a new SSH build agent). The scope allows you to say "this credential is only used by these places" by looking at the relationship between the two locations.

          • Values: SYSTEM, GLOBAL, USER
        • id : String
          An internal unique ID by which these credentials are identified from jobs and other configuration. Normally left blank, in which case an ID will be generated, which is fine for jobs created using visual forms. Useful to specify explicitly when using credentials from scripted configuration.
        • description : String
          An optional description to help tell similar credentials apart.
        • accessId : String (optional)
        • certificate : String (optional)
        • context (optional)
            Nested Choice of Objects
        • path : String (optional)
        • privateKey (optional)
          • Type: class hudson.util.Secret
      • $class: 'AkeylessCloudCredentials'
        • scope
          Determines where this credential can be used.
          System
          This credential is only available to the object on which the credential is associated. Typically you would use system-scoped credentials for things like email auth, agent connection, etc, i.e. where the Jenkins instance itself is using the credential. Unlike the global scope, this significantly restricts where the credential can be used, thereby providing a higher degree of confidentiality to the credential.
          Global
          This credential is available to the object on which the credential is associated and all objects that are children of that object. Typically you would use global-scoped credentials for things that are needed by jobs.

          In general, a credential is defined in one place (e.g., the credentials configuration page under "Manage Jenkins") and then used in another place (e.g., when connecting to a new SSH build agent). The scope allows you to say "this credential is only used by these places" by looking at the relationship between the two locations.

          • Values: SYSTEM, GLOBAL, USER
        • id : String
          An internal unique ID by which these credentials are identified from jobs and other configuration. Normally left blank, in which case an ID will be generated, which is fine for jobs created using visual forms. Useful to specify explicitly when using credentials from scripted configuration.
        • description : String
          An optional description to help tell similar credentials apart.
        • accessId : String (optional)
        • cloudType : String (optional)
        • context (optional)
            Nested Choice of Objects
        • path : String (optional)
      • $class: 'AkeylessK8SCredentials'
        • scope
          Determines where this credential can be used.
          System
          This credential is only available to the object on which the credential is associated. Typically you would use system-scoped credentials for things like email auth, agent connection, etc, i.e. where the Jenkins instance itself is using the credential. Unlike the global scope, this significantly restricts where the credential can be used, thereby providing a higher degree of confidentiality to the credential.
          Global
          This credential is available to the object on which the credential is associated and all objects that are children of that object. Typically you would use global-scoped credentials for things that are needed by jobs.

          In general, a credential is defined in one place (e.g., the credentials configuration page under "Manage Jenkins") and then used in another place (e.g., when connecting to a new SSH build agent). The scope allows you to say "this credential is only used by these places" by looking at the relationship between the two locations.

          • Values: SYSTEM, GLOBAL, USER
        • id : String
          An internal unique ID by which these credentials are identified from jobs and other configuration. Normally left blank, in which case an ID will be generated, which is fine for jobs created using visual forms. Useful to specify explicitly when using credentials from scripted configuration.
        • description : String
          An optional description to help tell similar credentials apart.
        • accessId : String (optional)
        • configName : String (optional)
        • context (optional)
            Nested Choice of Objects
        • gatewayUrl : String (optional)
        • path : String (optional)
        • serviceAccountToken (optional)
          • Type: class hudson.util.Secret
      • $class: 'AkeylessUniversalIdCredentials'
        • scope
          Determines where this credential can be used.
          System
          This credential is only available to the object on which the credential is associated. Typically you would use system-scoped credentials for things like email auth, agent connection, etc, i.e. where the Jenkins instance itself is using the credential. Unlike the global scope, this significantly restricts where the credential can be used, thereby providing a higher degree of confidentiality to the credential.
          Global
          This credential is available to the object on which the credential is associated and all objects that are children of that object. Typically you would use global-scoped credentials for things that are needed by jobs.

          In general, a credential is defined in one place (e.g., the credentials configuration page under "Manage Jenkins") and then used in another place (e.g., when connecting to a new SSH build agent). The scope allows you to say "this credential is only used by these places" by looking at the relationship between the two locations.

          • Values: SYSTEM, GLOBAL, USER
        • id : String
          An internal unique ID by which these credentials are identified from jobs and other configuration. Normally left blank, in which case an ID will be generated, which is fine for jobs created using visual forms. Useful to specify explicitly when using credentials from scripted configuration.
        • description : String
          An optional description to help tell similar credentials apart.
        • context (optional)
            Nested Choice of Objects
        • path : String (optional)
        • token (optional)
          • Type: class hudson.util.Secret
    • akeylessCredentialId : String (optional)
    • akeylessUrl : String (optional)
    • disableChildPoliciesOverride : boolean (optional)
    • policies : String (optional)
    • skipSslVerification : boolean (optional)
    • timeout : int (optional)

wrap([$class: 'AkeylessBuildWrapper']): Akeyless Plugin

  • akeylessSecrets
      Array / List of Nested Object
    • path : String
      The full name of the secret
    • secretValues
        Array / List of Nested Object
      • secretKey : String
        Enter the key name from the JSON secret to retrieve its value. To retrieve all keys, enter 'data'.
      • envVar : String (optional)
      • isRequired : boolean (optional)
        If checked, if a Key that does not exist in the item is set, it will fail
  • akeylessPKIIssuers
      Array / List of Nested Object
    • path : String
      The full name of the certificate issuer
    • name : String
    • certUserName : String
    • publicKey : String
    • csrBase64 : String
    • ttl : long
      Updated certificate lifetime (must be less than the Certificate Issuer default TTL)
    • secretValues
        Array / List of Nested Object
      • secretKey : String
        Enter the key name from the JSON secret to retrieve its value. To retrieve all keys, enter 'data'.
      • envVar : String (optional)
      • isRequired : boolean (optional)
        If checked, if a Key that does not exist in the item is set, it will fail
  • akeylessSSHIssuers
      Array / List of Nested Object
    • path : String
      The full name of the certificate issuer
    • name : String
    • certUserName : String
    • publicKey : String
    • ttl : long
      Updated certificate lifetime (must be less than the Certificate Issuer default TTL)
    • secretValues
        Array / List of Nested Object
      • secretKey : String
        Enter the key name from the JSON secret to retrieve its value. To retrieve all keys, enter 'data'.
      • envVar : String (optional)
      • isRequired : boolean (optional)
        If checked, if a Key that does not exist in the item is set, it will fail
  • configuration (optional)
      Nested Object
    • akeylessCredential (optional)
        Nested Choice of Objects
      • $class: 'AccessKeyCredentialsImpl'
        • scope
          Determines where this credential can be used.
          System
          This credential is only available to the object on which the credential is associated. Typically you would use system-scoped credentials for things like email auth, agent connection, etc, i.e. where the Jenkins instance itself is using the credential. Unlike the global scope, this significantly restricts where the credential can be used, thereby providing a higher degree of confidentiality to the credential.
          Global
          This credential is available to the object on which the credential is associated and all objects that are children of that object. Typically you would use global-scoped credentials for things that are needed by jobs.

          In general, a credential is defined in one place (e.g., the credentials configuration page under "Manage Jenkins") and then used in another place (e.g., when connecting to a new SSH build agent). The scope allows you to say "this credential is only used by these places" by looking at the relationship between the two locations.

          • Values: SYSTEM, GLOBAL, USER
        • id : String
          An internal unique ID by which these credentials are identified from jobs and other configuration. Normally left blank, in which case an ID will be generated, which is fine for jobs created using visual forms. Useful to specify explicitly when using credentials from scripted configuration.
        • description : String
          An optional description to help tell similar credentials apart.
        • accessId : String (optional)
        • accessKey (optional)
          • Type: class hudson.util.Secret
        • context (optional)
            Nested Choice of Objects
        • path : String (optional)
      • $class: 'AkeylessCertCredentials'
        • scope
          Determines where this credential can be used.
          System
          This credential is only available to the object on which the credential is associated. Typically you would use system-scoped credentials for things like email auth, agent connection, etc, i.e. where the Jenkins instance itself is using the credential. Unlike the global scope, this significantly restricts where the credential can be used, thereby providing a higher degree of confidentiality to the credential.
          Global
          This credential is available to the object on which the credential is associated and all objects that are children of that object. Typically you would use global-scoped credentials for things that are needed by jobs.

          In general, a credential is defined in one place (e.g., the credentials configuration page under "Manage Jenkins") and then used in another place (e.g., when connecting to a new SSH build agent). The scope allows you to say "this credential is only used by these places" by looking at the relationship between the two locations.

          • Values: SYSTEM, GLOBAL, USER
        • id : String
          An internal unique ID by which these credentials are identified from jobs and other configuration. Normally left blank, in which case an ID will be generated, which is fine for jobs created using visual forms. Useful to specify explicitly when using credentials from scripted configuration.
        • description : String
          An optional description to help tell similar credentials apart.
        • accessId : String (optional)
        • certificate : String (optional)
        • context (optional)
            Nested Choice of Objects
        • path : String (optional)
        • privateKey (optional)
          • Type: class hudson.util.Secret
      • $class: 'AkeylessCloudCredentials'
        • scope
          Determines where this credential can be used.
          System
          This credential is only available to the object on which the credential is associated. Typically you would use system-scoped credentials for things like email auth, agent connection, etc, i.e. where the Jenkins instance itself is using the credential. Unlike the global scope, this significantly restricts where the credential can be used, thereby providing a higher degree of confidentiality to the credential.
          Global
          This credential is available to the object on which the credential is associated and all objects that are children of that object. Typically you would use global-scoped credentials for things that are needed by jobs.

          In general, a credential is defined in one place (e.g., the credentials configuration page under "Manage Jenkins") and then used in another place (e.g., when connecting to a new SSH build agent). The scope allows you to say "this credential is only used by these places" by looking at the relationship between the two locations.

          • Values: SYSTEM, GLOBAL, USER
        • id : String
          An internal unique ID by which these credentials are identified from jobs and other configuration. Normally left blank, in which case an ID will be generated, which is fine for jobs created using visual forms. Useful to specify explicitly when using credentials from scripted configuration.
        • description : String
          An optional description to help tell similar credentials apart.
        • accessId : String (optional)
        • cloudType : String (optional)
        • context (optional)
            Nested Choice of Objects
        • path : String (optional)
      • $class: 'AkeylessK8SCredentials'
        • scope
          Determines where this credential can be used.
          System
          This credential is only available to the object on which the credential is associated. Typically you would use system-scoped credentials for things like email auth, agent connection, etc, i.e. where the Jenkins instance itself is using the credential. Unlike the global scope, this significantly restricts where the credential can be used, thereby providing a higher degree of confidentiality to the credential.
          Global
          This credential is available to the object on which the credential is associated and all objects that are children of that object. Typically you would use global-scoped credentials for things that are needed by jobs.

          In general, a credential is defined in one place (e.g., the credentials configuration page under "Manage Jenkins") and then used in another place (e.g., when connecting to a new SSH build agent). The scope allows you to say "this credential is only used by these places" by looking at the relationship between the two locations.

          • Values: SYSTEM, GLOBAL, USER
        • id : String
          An internal unique ID by which these credentials are identified from jobs and other configuration. Normally left blank, in which case an ID will be generated, which is fine for jobs created using visual forms. Useful to specify explicitly when using credentials from scripted configuration.
        • description : String
          An optional description to help tell similar credentials apart.
        • accessId : String (optional)
        • configName : String (optional)
        • context (optional)
            Nested Choice of Objects
        • gatewayUrl : String (optional)
        • path : String (optional)
        • serviceAccountToken (optional)
          • Type: class hudson.util.Secret
      • $class: 'AkeylessUniversalIdCredentials'
        • scope
          Determines where this credential can be used.
          System
          This credential is only available to the object on which the credential is associated. Typically you would use system-scoped credentials for things like email auth, agent connection, etc, i.e. where the Jenkins instance itself is using the credential. Unlike the global scope, this significantly restricts where the credential can be used, thereby providing a higher degree of confidentiality to the credential.
          Global
          This credential is available to the object on which the credential is associated and all objects that are children of that object. Typically you would use global-scoped credentials for things that are needed by jobs.

          In general, a credential is defined in one place (e.g., the credentials configuration page under "Manage Jenkins") and then used in another place (e.g., when connecting to a new SSH build agent). The scope allows you to say "this credential is only used by these places" by looking at the relationship between the two locations.

          • Values: SYSTEM, GLOBAL, USER
        • id : String
          An internal unique ID by which these credentials are identified from jobs and other configuration. Normally left blank, in which case an ID will be generated, which is fine for jobs created using visual forms. Useful to specify explicitly when using credentials from scripted configuration.
        • description : String
          An optional description to help tell similar credentials apart.
        • context (optional)
            Nested Choice of Objects
        • path : String (optional)
        • token (optional)
          • Type: class hudson.util.Secret
    • akeylessCredentialId : String (optional)
    • akeylessUrl : String (optional)
    • disableChildPoliciesOverride : boolean (optional)
    • policies : String (optional)
    • skipSslVerification : boolean (optional)
    • timeout : int (optional)

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.