@autional/api-secret
v0.4.1
Published
Autional Secret API — auto-generated TypeScript client from secret-service
Readme
@autional/api-secret
Autional Secret API — auto-generated TypeScript client from secret-service (18 functions).
Auto-generated by
python sdk/scripts/generate-api-packages.py. Do not edit by hand.
Functions
| Function | Method | Path | Description |
|----------|--------|------|-------------|
| getAdminSecrets(client, params?) | GET | /admin/secrets | 列出密钥 |
| postAdminSecrets(client, data: StoreSecretRequest) | POST | /admin/secrets | 创建密钥 |
| postAdminSecretsBatchDelete(client, data: BatchRevokeRequest) | POST | /admin/secrets/batch-delete | 批量删除密钥 |
| postAdminSecretsBatchRevoke(client, data: BatchRevokeRequest) | POST | /admin/secrets/batch-revoke | 批量吊销密钥 |
| getAdminSecretsDetail(client, params?) | GET | /admin/secrets/detail | 获取密钥详情 |
| getAdminSecretsEncryptionKeys(client) | GET | /admin/secrets/encryption-keys | 获取加密密钥列表 |
| deleteAdminSecretsItemKeyByKey(client, key: string) | DELETE | /admin/secrets/item/key/{key} | 删除密钥 |
| getAdminSecretsJwtKeys(client) | GET | /admin/secrets/jwt/keys | 列出 JWT 密钥 |
| deleteAdminSecretsPolicy(client) | DELETE | /admin/secrets/policy | 删除密钥策略 |
| getAdminSecretsPolicy(client) | GET | /admin/secrets/policy | 获取密钥策略 |
| putAdminSecretsPolicy(client, data: SecretPolicyRequest) | PUT | /admin/secrets/policy | 更新密钥策略 |
| postAdminSecretsRevoke(client, params?) | POST | /admin/secrets/revoke | 吊销密钥 |
| postAdminSecretsRotate(client, data: RotateSecretRequest, params?) | POST | /admin/secrets/rotate | 轮换密钥 |
| postAdminSecretsUpdate(client, data: UpdateSecretRequest, params?) | POST | /admin/secrets/update | 更新密钥元数据 |
| getAdminSecretsVersions(client, params?) | GET | /admin/secrets/versions | 列出密钥版本 |
| postAdminSecretsVersionsValue(client, data: SecretVersionQuery, params?) | POST | /admin/secrets/versions/value | 获取版本密钥值 |
| getSecretPublicJwtPublicKey(client) | GET | /secret/public/jwt/public-key | 获取 JWT 验证公钥 |
| getSecretPublicTransmissionPublicKey(client) | GET | /secret/public/transmission/public-key | 获取密码传输公钥 |
Install
npm install @autional/core @autional/api-secretQuick Start
import { Autional, browserPlatform } from '@autional/core';
import { getAdminSecretsPolicy } from '@autional/api-secret';
const autional = new Autional({
appId: 'my-app',
issuer: 'https://auth.example.com', // your Autional server URL
platform: browserPlatform,
});
await autional.initialize();
// 返回值已由 ApiClient 解包为载荷(不是 { code, data, message } 信封)
const result = await getAdminSecretsPolicy(autional.api);
console.log(result);Conventions
- Every function takes the
ApiClientas its first argument (autional.api). - Field names convert automatically:
camelCaseat the call site,snake_caseon the wire. - Return values are unwrapped payloads, not
{ code, data, message }envelopes.
See the root SDK README for tokens, refresh, and OAuth flows.
