IvedaAI: Account
ivedaai_accountManage IvedaAI accounts and API keys: create, list, update, delete accounts, retrieve permissions, and handle API key operations.
Instructions
IvedaAI API — Account operations. Response JSON: "status" is the HTTP status code; "truncated"/"timedOut" flag a cut-off response.
GET /api/accounts — List accounts query: offset?:integer, page?:any, pageNumber?:integer, pageSize?:integer, paged?:boolean, size?:any, sort?:any, sort.sorted?:boolean, sort.unsorted?:boolean, unpaged?:boolean, nameContains?:string, userGroupId?:string, userGroupNameContains?:string, authenticationTypes?:string enum:Ldap|Local|OpenID, excludeSupremeAdmin?:boolean
POST /api/accounts — Create account body: AccountRequest — required: email, locale, name, password, userGroupId; ivedaai_get_schema for all fields
DELETE /api/accounts/{accountId} — Delete account by id path: accountId*:integer
GET /api/accounts/{accountId} — Find account by id path: accountId*:integer
PATCH /api/accounts/{accountId} — Patch account path: accountId*:integer body: AccountRequest — required: email, locale, name, password, userGroupId; ivedaai_get_schema for all fields NOTE: GET /api/accounts/{accountId} returns this field under a different key — userGroupId → userGroup.userGroupId. This endpoint has been confirmed to leave omitted fields alone, so this is for reading the value, not a warning about losing it.
PUT /api/accounts/{accountId} — Update account path: accountId*:integer body: AccountRequest — required: email, locale, name, password, userGroupId; ivedaai_get_schema for all fields NOTE: GET /api/accounts/{accountId} returns this field under a different key — userGroupId → userGroup.userGroupId. This endpoint refuses partial bodies outright, so the full object is required regardless.
GET /api/accounts/{accountId}/permissions — List account permissions path: accountId*:integer query: type?:string enum:Camera|FaceCategory|LicensePlateCategory
DELETE /api/accounts/api-keys — Delete API key in batch query: apiKeyIds*:string
GET /api/accounts/api-keys — Find all API keys for the account
POST /api/accounts/api-keys — Create API key for the specific account body: { isActive*:boolean, name?:string }
DELETE /api/accounts/api-keys/{keyId} — Delete API key path: keyId*:string
PATCH /api/accounts/api-keys/{keyId} — Patch API key path: keyId*:string body: { isActive*:boolean, name?:string }
GET /api/accounts/findByName — Find account by name query: accountName*:string
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | JSON request body, or form field values when uploading a file. | |
| file | No | Local file to upload, for operations that accept a file. | |
| path | No | Path parameters, e.g. { "cameraId": 12 } | |
| query | No | Query string parameters for this operation. | |
| operation | Yes | Which API operation to call, from the list in this tool's description. |