Skip to content
DataMiner DoJo

More results...

Generic selectors
Exact matches only
Search in title
Search in content
Post Type Selectors
Search in posts
Search in pages
Search in posts
Search in pages
Log in
Menu
  • Updates & Insights
  • Questions
  • Learning
    • E-learning Courses
    • Empower Replay: Limited Edition
    • Tutorials
    • Open Classroom Training
    • Certification
      • DataMiner Fundamentals
      • DataMiner Configurator
      • DataMiner Automation
      • Scripts & Connectors Developer: HTTP Basics
      • Scripts & Connectors Developer: SNMP Basics
      • Visual Overview – Level 1
      • Verify a certificate
    • Video Library
    • Books We Like
    • >> Go to DataMiner Docs
  • Expert Center
    • Solutions & Use Cases
      • Solutions
      • Use Case Library
    • Markets & Industries
      • Media production
      • Government & defense
      • Content distribution
      • Service providers
      • Partners
      • OSS/BSS
    • Agile
      • Agile Webspace
      • Everything Agile
        • The Agile Manifesto
        • Best Practices
        • Retro Recipes
      • Methodologies
        • The Scrum Framework
        • Kanban
        • Extreme Programming
      • Roles
        • The Product Owner
        • The Agile Coach
        • The Quality & UX Coach (QX)
    • DataMiner DevOps Professional Program
      • About the DevOps Program
      • DataMiner DevOps Support
  • Downloads
  • More
    • DataMiner Releases & Updates
    • Feature Suggestions
    • Climb the leaderboard!
    • Swag Shop
    • Contact
    • Global Feedback Survey
  • PARTNERS
    • All Partners
    • Technology Partners
    • Strategic Partner Program
    • Deal Registration
  • >> Go to dataminer.services

Best practice to store API credentials used in Automation script?

Solved23.55K views14th July 2023API Automation security
8
Ruben Vandepitte [SLC] [DevOps Advocate]2.32K 14th June 2022 0 Comments

In case a DataMiner Automation script directly accesses an external API which is secured by user credentials or an API key, what is the best practice to store these?

We want to avoid including them in the script in plain-text.

Thanks!

Marieke Goethals [SLC] [DevOps Catalyst] Selected answer as best 14th July 2023

3 Answers

  • Active
  • Voted
  • Newest
  • Oldest
4
Tom Waterbley [SLC] [DevOps Catalyst]8.89K Posted 14th June 2022 1 Comment

The preferred way is to do the communication in a connector, as Thijs already mentioned. If that’s not desired, storing the credentials in “Windows Credential Manager” could be an option. See https://www.techradar.com/news/what-is-windows-credential-manager.

Those credentials can then be retrieved in the automation script: https://stackoverflow.com/questions/17741424/retrieve-credentials-from-windows-credentials-store-using-c-sharp.

Marieke Goethals [SLC] [DevOps Catalyst] Selected answer as best 14th July 2023
Ruben Vandepitte [SLC] [DevOps Advocate] commented 14th June 2022

Thanks for the suggestion. Worth looking into!

2
Thijs Vanovenacker [SLC] [DevOps Advocate]2.21K Posted 14th June 2022 2 Comments

Hi Ruben,
It’s actually preferred to always use a protocol to handle all the API communication between DataMiner and any data source.

That way it allows you to store your user credentials safely inside your element- data.

Can you elaborate more on why you would interact with the external API directly from an automation script?

Thijs Vanovenacker [SLC] [DevOps Advocate] Posted new comment 14th June 2022
Ruben Vandepitte [SLC] [DevOps Advocate] commented 14th June 2022

This is one of the main use cases of the new GQI Custom Data feature No need for a ‘middle-man’ connector. GQI can get the data directly from the source.

Thijs Vanovenacker [SLC] [DevOps Advocate] commented 14th June 2022

Note that there is already a feature suggestion in order to support your case. Feel free to upvote it: https://community.dataminer.services/new-feature-suggestions/option-to-link-a-credential-library-to-an-automation-script/

1
Jarno Lernou [SLC] [DevOps Enabler]5.03K Posted 14th June 2022 1 Comment

I would say from the top of my head, the built-in credential library would be the best fit to have this functionality, but as far as I know, it only supports SNMP credentials.

Would it be an option to use an element for communication purposes?

Gellynck Jens [SLC] Posted new comment 14th June 2022
Gellynck Jens [SLC] commented 14th June 2022

Note it’s currently not possible to retrieve the secrets stored in a credential library from an automation script.

Please login to be able to comment or post an answer.

My DevOps rank

DevOps Members get more insights on their profile page.

My user earnings

0 Dojo credits

Spend your credits in our swag shop.

0 Reputation points

Boost your reputation, climb the leaderboard.

Promo banner DataMiner DevOps Professiona Program
DataMiner Integration Studio (DIS)
Empower Katas
Privacy Policy • Terms & Conditions • Contact

© 2025 Skyline Communications. All rights reserved.

DOJO Q&A widget

Can't find what you need?

? Explore the Q&A DataMiner Docs