Authentication

Make a key

Keys are made in Yet, in Preferences → API keys, at your company’s address (acme.yet.com.br/preferences/keys) — by anyone of the company. Give it a name — what it is for — and copy it: it is shown this once. Yet keeps only its first characters, to tell it apart, and a hash.

yet_acme_6bffe638db8b02483be16f2407d7ddce0aeea792ed9446d6

A key says which company it is of — yet_<company>_<secret> — so the SDKs and the Terraform provider find your company’s addresses from it alone.

Use it

Send it in the Authorization header, as a bearer token, on every request:

curl https://cloud.yet.com.br/v1/me \
  -H "Authorization: Bearer $YET_API_KEY"

The SDKs, the provider and the CLI read it from the environment:

export YET_API_KEY=yet_acme_6bffe638…

Who a key is

A key acts as the person who made it. It can do what they can, in every product, and nothing more:

• In Cloud, their role — viewer, developer or admin, everywhere or by environment — decides what the key may see and change.
• In Settings and IAM, only a key of someone who runs the company’s Settings gets in.
• What a key does is recorded under its person, in IAM’s activity.

Addresses

Each product answers at its own address; your key works at all of them.

On a Yet of your own, the same names under its domain: YET_BASE_DOMAIN tells the tools which.

Revoke a key

Delete it in Preferences → API keys, or with the API. The company’s admins see everyone’s keys in Settings → IAM, and revoke any — there or with the IAM API. A key stops working at once.