2
0
Files
bot/apps/docs/contribute/the-forge/auth.mdx
Baptiste Arnaud 65f4fb0d7a 📝 Add Contribute docs
2024-01-03 16:29:41 +01:00

33 lines
657 B
Plaintext

---
title: Auth
---
## Encrypted credentials
<ResponseField name="type" type="'encryptedCredentials'" required>
The authentication type.
</ResponseField>
<ResponseField name="name" type="string" required>
The name of the credentials. I.e. `Twitter account`, `OpenAI account`, `Stripe
keys`, etc.
</ResponseField>
<ResponseField name="schema" type="z.ZodObject<any>" required>
The schema of the data that needs to be stored. See [Options](./options) for
more information.
Example:
```ts
option.object({
apiKey: option.string.layout({
isRequired: true,
label: 'API key',
withVariableButton: false,
}),
})
```
</ResponseField>