@autional/api-profile

Autional Profile API — auto-generated TypeScript client from profile-service (51 functions).

Auto-generated by python sdk/scripts/generate-api-packages.py. Do not edit by hand.

Functions

| Function | Method | Path | Description | |----------|--------|------|-------------| | getAdminProfiles(client, params?) | GET | /admin/profiles | 搜索用户资料 | | getAdminProfilesApprovalRequests(client) | GET | /admin/profiles/approval-requests | 查询待审批列表 | | postAdminProfilesApprovalRequests(client, data: ApprovalRequest) | POST | /admin/profiles/approval-requests | 创建审批请求 | | deleteAdminProfilesApprovalRequestsByApprovalRequests(client, requestId: string) | DELETE | /admin/profiles/approval-requests/{request_id} | 删除审批请求 | | postAdminProfilesApprovalRequestsApproveByApprovalRequests(client, requestId: string) | POST | /admin/profiles/approval-requests/{request_id}/approve | 批准审批请求 | | postAdminProfilesApprovalRequestsRejectByApprovalRequests(client, requestId: string, data: RejectApprovalBody) | POST | /admin/profiles/approval-requests/{request_id}/reject | 拒绝审批请求 | | postAdminProfilesBatchArchive(client, data: BatchRequest) | POST | /admin/profiles/batch-archive | 批量归档用户资料 | | postAdminProfilesBatchDelete(client, data: BatchRequest) | POST | /admin/profiles/batch-delete | 批量删除用户资料 | | postAdminProfilesBatchExport(client, data: BatchRequest) | POST | /admin/profiles/batch-export | 批量导出用户资料 | | getAdminProfilesFieldSchemas(client) | GET | /admin/profiles/field-schemas | 列出字段模板 | | postAdminProfilesFieldSchemas(client, data: FieldSchemaDTO) | POST | /admin/profiles/field-schemas | 创建字段模板 | | deleteAdminProfilesFieldSchemasByFieldSchemas(client, fieldKey: string) | DELETE | /admin/profiles/field-schemas/{field_key} | 删除字段模板 | | putAdminProfilesFieldSchemasByFieldSchemas(client, fieldKey: string, data: FieldSchemaDTO) | PUT | /admin/profiles/field-schemas/{field_key} | 更新字段模板 | | deleteAdminProfilesPolicy(client) | DELETE | /admin/profiles/policy | 删除租户资料策略 | | getAdminProfilesPolicy(client) | GET | /admin/profiles/policy | 获取租户资料策略 | | postAdminProfilesPolicy(client, data: ProfilePolicyDTO) | POST | /admin/profiles/policy | 创建租户资料策略 | | putAdminProfilesPolicy(client, data: ProfilePolicyDTO) | PUT | /admin/profiles/policy | 更新租户资料策略 | | getAdminProfilesStats(client) | GET | /admin/profiles/stats | 获取资料统计 | | deleteAdminProfilesVersionsByVersions(client, versionId: string) | DELETE | /admin/profiles/versions/{version_id} | 删除资料版本记录 | | deleteAdminProfilesWebhook(client) | DELETE | /admin/profiles/webhook | 删除 Webhook 配置 | | getAdminProfilesWebhook(client) | GET | /admin/profiles/webhook | 获取 Webhook 配置 | | postAdminProfilesWebhook(client, data: WebhookConfigDTO) | POST | /admin/profiles/webhook | 创建 Webhook 配置 | | putAdminProfilesWebhook(client, data: WebhookConfigDTO) | PUT | /admin/profiles/webhook | 更新 Webhook 配置 | | getAdminProfilesByProfiles(client, userId: string) | GET | /admin/profiles/{user_id} | 获取用户资料（管理端） | | postAdminProfilesArchiveByProfiles(client, userId: string, data: ArchiveProfileRequest) | POST | /admin/profiles/{user_id}/archive | 归档用户资料 | | putAdminProfilesAvatarByProfiles(client, userId: string, data: UpdateAvatarRequest) | PUT | /admin/profiles/{user_id}/avatar | 更新指定用户头像（管理端） | | getAdminProfilesExportByProfiles(client, userId: string, params?) | GET | /admin/profiles/{user_id}/export | 导出用户资料 | | getAdminProfilesVersionsByProfiles(client, userId: string) | GET | /admin/profiles/{user_id}/versions | 获取资料版本历史 | | getProfileAvatar(client) | GET | /profile/avatar | 快捷获取当前用户头像 | | putProfileAvatar(client, data: UpdateAvatarRequest) | PUT | /profile/avatar | 更新我的头像 | | getProfiles(client, params?) | GET | /profiles | 用户资料列表 | | deleteProfilesByProfiles(client, userId: string) | DELETE | /profiles/{user_id} | 删除用户资料 | | getProfilesByProfiles(client, userId: string) | GET | /profiles/{user_id} | 获取用户资料 | | putProfilesByProfiles(client, userId: string, data: UpdateProfileRequest) | PUT | /profiles/{user_id} | 创建或更新用户资料 | | putProfilesAvatarByProfiles(client, userId: string, data: UpdateAvatarRequest) | PUT | /profiles/{user_id}/avatar | 更新用户头像 | | getProfilesCompletenessByProfiles(client, userId: string) | GET | /profiles/{user_id}/completeness | 获取资料完成度 | | getProfilesConsentsByProfiles(client, userId: string) | GET | /profiles/{user_id}/consents | 查询用户同意记录 | | postProfilesConsentsByProfiles(client, userId: string, data: GrantConsentRequest) | POST | /profiles/{user_id}/consents | 授予数据收集同意 | | deleteProfilesConsentsByProfilesByConsents(client, userId: string, fieldKey: string) | DELETE | /profiles/{user_id}/consents/{field_key} | 撤销数据收集同意 | | getProfilesExportByProfiles(client, userId: string, params?) | GET | /profiles/{user_id}/export | 自助导出用户资料 | | getProfilesFieldsByProfiles(client, userId: string) | GET | /profiles/{user_id}/fields | 获取自定义字段 | | putProfilesFieldsByProfiles(client, userId: string, data: ProfileFieldsRequest) | PUT | /profiles/{user_id}/fields | 更新自定义字段 | | getProfilesPreferencesByProfiles(client, userId: string) | GET | /profiles/{user_id}/preferences | 获取用户偏好设置 | | putProfilesPreferencesByProfiles(client, userId: string, data: UpdatePreferencesRequest) | PUT | /profiles/{user_id}/preferences | 更新用户偏好设置 | | getProfilesPrivacyByProfiles(client, userId: string) | GET | /profiles/{user_id}/privacy | 获取隐私设置 | | putProfilesPrivacyByProfiles(client, userId: string, data: PrivacySettingsDTO) | PUT | /profiles/{user_id}/privacy | 更新隐私设置 | | getProfilesPrivacyImpactByProfiles(client, userId: string) | GET | /profiles/{user_id}/privacy-impact | 获取隐私影响评估 | | getProfilesPublicByProfiles(client, userId: string) | GET | /profiles/{user_id}/public | 获取公开资料 | | deleteProfilesTagsByProfiles(client, userId: string) | DELETE | /profiles/{user_id}/tags | 删除用户标签 | | postProfilesTagsByProfiles(client, userId: string, data: SetTagsRequest) | POST | /profiles/{user_id}/tags | 设置用户标签 | | postProfilesVersionsByProfiles(client, userId: string) | POST | /profiles/{user_id}/versions | 创建资料版本快照 |

Install

npm install @autional/core @autional/api-profile

Quick Start

import { Autional, browserPlatform } from '@autional/core';
import { getProfileAvatar } from '@autional/api-profile';

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 getProfileAvatar(autional.api);
console.log(result);

Conventions

• Every function takes the ApiClient as its first argument (autional.api).
• Field names convert automatically: camelCase at the call site, snake_case on the wire.
• Return values are unwrapped payloads, not { code, data, message } envelopes.

See the root SDK README for tokens, refresh, and OAuth flows.