[toc]
On this page
Two credentials, two purposes
Personal Settings › API Token holds two things that are easy to confuse:
| Credential | What it does | Needs a sign-in |
|---|---|---|
| Personal API Token | Authenticates you to the CupixWorks API | It is you |
| SiteView presigned URL credential (Client ID and Client Secret) | Generates links that open a SiteView without signing in at all | No |
One proves who you are. The other lets you hand out access that does not need a who.
Your personal API token
The card shows the token with Copy and Generate New Token. The page carries its own warning: keep your API token secure, as it can be used to access your data in CupixWorks.
It is personal
It is not a team credential. Anything built on your token acts as you and reaches what you can reach. If you leave the team, whatever depends on it stops working.
Regenerating invalidates the old token at once
One action issues a new token and kills the old one, and the confirmation says so: Regenerating will invalidate your existing token, so you will need to reset any services that use it. Anything running on the old token stops working at that moment, so reset those services as part of the same job, not afterwards.
One token, no name, no scope, always readable
- You get a single token. You cannot create a second one for a second purpose, name it, or limit what it may reach.
- The value is on this page whenever you open it, rather than shown once at creation. That is the intended design.
- The practical consequence: anyone who can open your Personal Settings can read your token. Treat an unlocked screen as a leaked credential.
The SiteView presigned URL credential
A second card, with Create credentials. Its own description: used for generating presigned SiteView URLs that allow access without login. Keep the Client Secret secure.
Read that before using it. A presigned URL is access without authentication: anyone holding the link is in. That is the point of the feature and also its whole risk.
Separate from the API token, both ways
- The Client ID and Client Secret are reissued on their own. Reissuing them invalidates the previous pair, the same way regenerating the API token invalidates the old token.
- Regenerating your API token does not touch the presigned pair. They are two credentials, not two views of one.
The secret is readable; reissuing is what needs thought
Both the Client ID and the Client Secret can be read and copied from this page whenever you need them, so there is no one-time moment you have to catch.
What needs thought is reissuing. A new pair invalidates the previous one at once, and every presigned URL you have already handed out stops working. Those links are usually out in other people's hands, so reissue deliberately, and expect to send new links as well.