Home / Help centre / Authentication & logins
Authentication & logins
How do I give the scanner AI guidance on how to use a credential?
Tick Header (token / API key) or OAuth 2.0 on the role, find the optional AI guidance box, write one plain instruction per line, such as what the credential is and how to treat it, then click Save. Never paste the secret itself into the guidance.
Steps
- Open the role in Authentication. The AI guidance box sits inside the Header (token / API key) block and the OAuth 2.0 block, so tick one of them.
- Find AI guidance (one step per line, optional).
- Write each instruction on its own line, in plain words. Say what the credential is and how to treat it.
- Press Save.
Good to know
The product docs say each role can take free-text AI guidance. It is optional. The placeholder lines show the style:
- Name the key: Treat this as an admin API key.
- Explain how to send it: Send it on every API request as-is; do not refresh it.
- For OAuth: Re-mint the token rather than reusing an expired one.
Good guidance is short, true and specific to the credential. Skip secrets. The key itself has its own field, so keep it out of this box.
Keep each line to one idea. A short line is easy to read and hard to misread. Aim for what a new teammate would need to know on day one.
Guidance helps the scanner use the credential well, and it costs nothing to leave it empty when the credential needs no explanation. It does not widen what the role can reach. For more samples, read AI guidance examples. Setup of the credential itself is in the API key header guide and the OAuth 2.0 guide.
Related questions
- What kind of instructions belong in a role's AI guidance?
- How do I authenticate the scanner with an API key header?
- How do I set up OAuth 2.0 client credentials for a role?
- Which login methods does Cyberlop support for scanning behind a login?
- What is an authentication role?
How to scan behind login in Cyberlop with authentication roles
Step-by-step, with annotated screenshots.
Updated · Back to the help centre
Still stuck?
Tell us what you see on screen and an engineer will help you sort it out.