cjones/immich
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
fb6253d2d117f08471e482efd1263d951533b6bc
immich/mobile-v2/openapi/README.md
shenlong-tanwen 11cef4ec9a 🚀
2025-02-26 08:58:18 +05:30

428 lines
28 KiB
Markdown
Raw Blame History

# openapi (EXPERIMENTAL)
Immich API
This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.102.3
- Build package: org.openapitools.codegen.languages.DartDioClientCodegen
## Requirements
* Dart 2.15.0+ or Flutter 2.8.0+
* Dio 5.0.0+ (https://pub.dev/packages/dio)
## Installation & Usage
### pub.dev
To use the package from [pub.dev](https://pub.dev), please include the following in pubspec.yaml
```yaml
dependencies:
openapi: 1.0.0
```
### Github
If this Dart package is published to Github, please include the following in pubspec.yaml
```yaml
dependencies:
openapi:
git:
url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
#ref: main
```
### Local development
To use the package from your local drive, please include the following in pubspec.yaml
```yaml
dependencies:
openapi:
path: /path/to/openapi
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```dart
import 'package:openapi/openapi.dart';
final api = Openapi().getAPIKeyApi();
final APIKeyCreateDto aPIKeyCreateDto = ; // APIKeyCreateDto |
try {
final response = await api.createApiKey(aPIKeyCreateDto);
print(response);
} catch on DioException (e) {
print("Exception when calling APIKeyApi->createApiKey: $e\n");
}
```
## Documentation for API Endpoints
All URIs are relative to */api*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
[*APIKeyApi*](doc/APIKeyApi.md) | [**createApiKey**](doc/APIKeyApi.md#createapikey) | **POST** /api-key |
[*APIKeyApi*](doc/APIKeyApi.md) | [**deleteApiKey**](doc/APIKeyApi.md#deleteapikey) | **DELETE** /api-key/{id} |
[*APIKeyApi*](doc/APIKeyApi.md) | [**getApiKey**](doc/APIKeyApi.md#getapikey) | **GET** /api-key/{id} |
[*APIKeyApi*](doc/APIKeyApi.md) | [**getApiKeys**](doc/APIKeyApi.md#getapikeys) | **GET** /api-key |
[*APIKeyApi*](doc/APIKeyApi.md) | [**updateApiKey**](doc/APIKeyApi.md#updateapikey) | **PUT** /api-key/{id} |
[*ActivityApi*](doc/ActivityApi.md) | [**createActivity**](doc/ActivityApi.md#createactivity) | **POST** /activity |
[*ActivityApi*](doc/ActivityApi.md) | [**deleteActivity**](doc/ActivityApi.md#deleteactivity) | **DELETE** /activity/{id} |
[*ActivityApi*](doc/ActivityApi.md) | [**getActivities**](doc/ActivityApi.md#getactivities) | **GET** /activity |
[*ActivityApi*](doc/ActivityApi.md) | [**getActivityStatistics**](doc/ActivityApi.md#getactivitystatistics) | **GET** /activity/statistics |
[*AlbumApi*](doc/AlbumApi.md) | [**addAssetsToAlbum**](doc/AlbumApi.md#addassetstoalbum) | **PUT** /album/{id}/assets |
[*AlbumApi*](doc/AlbumApi.md) | [**addUsersToAlbum**](doc/AlbumApi.md#adduserstoalbum) | **PUT** /album/{id}/users |
[*AlbumApi*](doc/AlbumApi.md) | [**createAlbum**](doc/AlbumApi.md#createalbum) | **POST** /album |
[*AlbumApi*](doc/AlbumApi.md) | [**deleteAlbum**](doc/AlbumApi.md#deletealbum) | **DELETE** /album/{id} |
[*AlbumApi*](doc/AlbumApi.md) | [**getAlbumCount**](doc/AlbumApi.md#getalbumcount) | **GET** /album/count |
[*AlbumApi*](doc/AlbumApi.md) | [**getAlbumInfo**](doc/AlbumApi.md#getalbuminfo) | **GET** /album/{id} |
[*AlbumApi*](doc/AlbumApi.md) | [**getAllAlbums**](doc/AlbumApi.md#getallalbums) | **GET** /album |
[*AlbumApi*](doc/AlbumApi.md) | [**removeAssetFromAlbum**](doc/AlbumApi.md#removeassetfromalbum) | **DELETE** /album/{id}/assets |
[*AlbumApi*](doc/AlbumApi.md) | [**removeUserFromAlbum**](doc/AlbumApi.md#removeuserfromalbum) | **DELETE** /album/{id}/user/{userId} |
[*AlbumApi*](doc/AlbumApi.md) | [**updateAlbumInfo**](doc/AlbumApi.md#updatealbuminfo) | **PATCH** /album/{id} |
[*AssetApi*](doc/AssetApi.md) | [**checkBulkUpload**](doc/AssetApi.md#checkbulkupload) | **POST** /asset/bulk-upload-check |
[*AssetApi*](doc/AssetApi.md) | [**checkExistingAssets**](doc/AssetApi.md#checkexistingassets) | **POST** /asset/exist |
[*AssetApi*](doc/AssetApi.md) | [**deleteAssets**](doc/AssetApi.md#deleteassets) | **DELETE** /asset |
[*AssetApi*](doc/AssetApi.md) | [**getAllAssets**](doc/AssetApi.md#getallassets) | **GET** /asset |
[*AssetApi*](doc/AssetApi.md) | [**getAllUserAssetsByDeviceId**](doc/AssetApi.md#getalluserassetsbydeviceid) | **GET** /asset/device/{deviceId} |
[*AssetApi*](doc/AssetApi.md) | [**getAssetInfo**](doc/AssetApi.md#getassetinfo) | **GET** /asset/{id} |
[*AssetApi*](doc/AssetApi.md) | [**getAssetSearchTerms**](doc/AssetApi.md#getassetsearchterms) | **GET** /asset/search-terms |
[*AssetApi*](doc/AssetApi.md) | [**getAssetStatistics**](doc/AssetApi.md#getassetstatistics) | **GET** /asset/statistics |
[*AssetApi*](doc/AssetApi.md) | [**getAssetThumbnail**](doc/AssetApi.md#getassetthumbnail) | **GET** /asset/thumbnail/{id} |
[*AssetApi*](doc/AssetApi.md) | [**getCuratedLocations**](doc/AssetApi.md#getcuratedlocations) | **GET** /asset/curated-locations |
[*AssetApi*](doc/AssetApi.md) | [**getCuratedObjects**](doc/AssetApi.md#getcuratedobjects) | **GET** /asset/curated-objects |
[*AssetApi*](doc/AssetApi.md) | [**getMapMarkers**](doc/AssetApi.md#getmapmarkers) | **GET** /asset/map-marker |
[*AssetApi*](doc/AssetApi.md) | [**getMemoryLane**](doc/AssetApi.md#getmemorylane) | **GET** /asset/memory-lane |
[*AssetApi*](doc/AssetApi.md) | [**getRandom**](doc/AssetApi.md#getrandom) | **GET** /asset/random |
[*AssetApi*](doc/AssetApi.md) | [**runAssetJobs**](doc/AssetApi.md#runassetjobs) | **POST** /asset/jobs |
[*AssetApi*](doc/AssetApi.md) | [**searchAssets**](doc/AssetApi.md#searchassets) | **GET** /assets |
[*AssetApi*](doc/AssetApi.md) | [**serveFile**](doc/AssetApi.md#servefile) | **GET** /asset/file/{id} |
[*AssetApi*](doc/AssetApi.md) | [**updateAsset**](doc/AssetApi.md#updateasset) | **PUT** /asset/{id} |
[*AssetApi*](doc/AssetApi.md) | [**updateAssets**](doc/AssetApi.md#updateassets) | **PUT** /asset |
[*AssetApi*](doc/AssetApi.md) | [**updateStackParent**](doc/AssetApi.md#updatestackparent) | **PUT** /asset/stack/parent |
[*AssetApi*](doc/AssetApi.md) | [**uploadFile**](doc/AssetApi.md#uploadfile) | **POST** /asset/upload |
[*AuditApi*](doc/AuditApi.md) | [**getAuditDeletes**](doc/AuditApi.md#getauditdeletes) | **GET** /audit/deletes |
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**changePassword**](doc/AuthenticationApi.md#changepassword) | **POST** /auth/change-password |
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**login**](doc/AuthenticationApi.md#login) | **POST** /auth/login |
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**logout**](doc/AuthenticationApi.md#logout) | **POST** /auth/logout |
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**signUpAdmin**](doc/AuthenticationApi.md#signupadmin) | **POST** /auth/admin-sign-up |
[*AuthenticationApi*](doc/AuthenticationApi.md) | [**validateAccessToken**](doc/AuthenticationApi.md#validateaccesstoken) | **POST** /auth/validateToken |
[*DownloadApi*](doc/DownloadApi.md) | [**downloadArchive**](doc/DownloadApi.md#downloadarchive) | **POST** /download/archive |
[*DownloadApi*](doc/DownloadApi.md) | [**downloadFile**](doc/DownloadApi.md#downloadfile) | **POST** /download/asset/{id} |
[*DownloadApi*](doc/DownloadApi.md) | [**getDownloadInfo**](doc/DownloadApi.md#getdownloadinfo) | **POST** /download/info |
[*FaceApi*](doc/FaceApi.md) | [**getFaces**](doc/FaceApi.md#getfaces) | **GET** /face |
[*FaceApi*](doc/FaceApi.md) | [**reassignFacesById**](doc/FaceApi.md#reassignfacesbyid) | **PUT** /face/{id} |
[*FileReportApi*](doc/FileReportApi.md) | [**fixAuditFiles**](doc/FileReportApi.md#fixauditfiles) | **POST** /report/fix |
[*FileReportApi*](doc/FileReportApi.md) | [**getAuditFiles**](doc/FileReportApi.md#getauditfiles) | **GET** /report |
[*FileReportApi*](doc/FileReportApi.md) | [**getFileChecksums**](doc/FileReportApi.md#getfilechecksums) | **POST** /report/checksum |
[*JobApi*](doc/JobApi.md) | [**getAllJobsStatus**](doc/JobApi.md#getalljobsstatus) | **GET** /jobs |
[*JobApi*](doc/JobApi.md) | [**sendJobCommand**](doc/JobApi.md#sendjobcommand) | **PUT** /jobs/{id} |
[*LibraryApi*](doc/LibraryApi.md) | [**createLibrary**](doc/LibraryApi.md#createlibrary) | **POST** /library |
[*LibraryApi*](doc/LibraryApi.md) | [**deleteLibrary**](doc/LibraryApi.md#deletelibrary) | **DELETE** /library/{id} |
[*LibraryApi*](doc/LibraryApi.md) | [**getAllLibraries**](doc/LibraryApi.md#getalllibraries) | **GET** /library |
[*LibraryApi*](doc/LibraryApi.md) | [**getLibrary**](doc/LibraryApi.md#getlibrary) | **GET** /library/{id} |
[*LibraryApi*](doc/LibraryApi.md) | [**getLibraryStatistics**](doc/LibraryApi.md#getlibrarystatistics) | **GET** /library/{id}/statistics |
[*LibraryApi*](doc/LibraryApi.md) | [**removeOfflineFiles**](doc/LibraryApi.md#removeofflinefiles) | **POST** /library/{id}/removeOffline |
[*LibraryApi*](doc/LibraryApi.md) | [**scanLibrary**](doc/LibraryApi.md#scanlibrary) | **POST** /library/{id}/scan |
[*LibraryApi*](doc/LibraryApi.md) | [**updateLibrary**](doc/LibraryApi.md#updatelibrary) | **PUT** /library/{id} |
[*LibraryApi*](doc/LibraryApi.md) | [**validate**](doc/LibraryApi.md#validate) | **POST** /library/{id}/validate |
[*MemoryApi*](doc/MemoryApi.md) | [**addMemoryAssets**](doc/MemoryApi.md#addmemoryassets) | **PUT** /memories/{id}/assets |
[*MemoryApi*](doc/MemoryApi.md) | [**createMemory**](doc/MemoryApi.md#creatememory) | **POST** /memories |
[*MemoryApi*](doc/MemoryApi.md) | [**deleteMemory**](doc/MemoryApi.md#deletememory) | **DELETE** /memories/{id} |
[*MemoryApi*](doc/MemoryApi.md) | [**getMemory**](doc/MemoryApi.md#getmemory) | **GET** /memories/{id} |
[*MemoryApi*](doc/MemoryApi.md) | [**removeMemoryAssets**](doc/MemoryApi.md#removememoryassets) | **DELETE** /memories/{id}/assets |
[*MemoryApi*](doc/MemoryApi.md) | [**searchMemories**](doc/MemoryApi.md#searchmemories) | **GET** /memories |
[*MemoryApi*](doc/MemoryApi.md) | [**updateMemory**](doc/MemoryApi.md#updatememory) | **PUT** /memories/{id} |
[*OAuthApi*](doc/OAuthApi.md) | [**finishOAuth**](doc/OAuthApi.md#finishoauth) | **POST** /oauth/callback |
[*OAuthApi*](doc/OAuthApi.md) | [**linkOAuthAccount**](doc/OAuthApi.md#linkoauthaccount) | **POST** /oauth/link |
[*OAuthApi*](doc/OAuthApi.md) | [**redirectOAuthToMobile**](doc/OAuthApi.md#redirectoauthtomobile) | **GET** /oauth/mobile-redirect |
[*OAuthApi*](doc/OAuthApi.md) | [**startOAuth**](doc/OAuthApi.md#startoauth) | **POST** /oauth/authorize |
[*OAuthApi*](doc/OAuthApi.md) | [**unlinkOAuthAccount**](doc/OAuthApi.md#unlinkoauthaccount) | **POST** /oauth/unlink |
[*PartnerApi*](doc/PartnerApi.md) | [**createPartner**](doc/PartnerApi.md#createpartner) | **POST** /partner/{id} |
[*PartnerApi*](doc/PartnerApi.md) | [**getPartners**](doc/PartnerApi.md#getpartners) | **GET** /partner |
[*PartnerApi*](doc/PartnerApi.md) | [**removePartner**](doc/PartnerApi.md#removepartner) | **DELETE** /partner/{id} |
[*PartnerApi*](doc/PartnerApi.md) | [**updatePartner**](doc/PartnerApi.md#updatepartner) | **PUT** /partner/{id} |
[*PersonApi*](doc/PersonApi.md) | [**createPerson**](doc/PersonApi.md#createperson) | **POST** /person |
[*PersonApi*](doc/PersonApi.md) | [**getAllPeople**](doc/PersonApi.md#getallpeople) | **GET** /person |
[*PersonApi*](doc/PersonApi.md) | [**getPerson**](doc/PersonApi.md#getperson) | **GET** /person/{id} |
[*PersonApi*](doc/PersonApi.md) | [**getPersonAssets**](doc/PersonApi.md#getpersonassets) | **GET** /person/{id}/assets |
[*PersonApi*](doc/PersonApi.md) | [**getPersonStatistics**](doc/PersonApi.md#getpersonstatistics) | **GET** /person/{id}/statistics |
[*PersonApi*](doc/PersonApi.md) | [**getPersonThumbnail**](doc/PersonApi.md#getpersonthumbnail) | **GET** /person/{id}/thumbnail |
[*PersonApi*](doc/PersonApi.md) | [**mergePerson**](doc/PersonApi.md#mergeperson) | **POST** /person/{id}/merge |
[*PersonApi*](doc/PersonApi.md) | [**reassignFaces**](doc/PersonApi.md#reassignfaces) | **PUT** /person/{id}/reassign |
[*PersonApi*](doc/PersonApi.md) | [**updatePeople**](doc/PersonApi.md#updatepeople) | **PUT** /person |
[*PersonApi*](doc/PersonApi.md) | [**updatePerson**](doc/PersonApi.md#updateperson) | **PUT** /person/{id} |
[*SearchApi*](doc/SearchApi.md) | [**getAssetsByCity**](doc/SearchApi.md#getassetsbycity) | **GET** /search/cities |
[*SearchApi*](doc/SearchApi.md) | [**getExploreData**](doc/SearchApi.md#getexploredata) | **GET** /search/explore |
[*SearchApi*](doc/SearchApi.md) | [**getSearchSuggestions**](doc/SearchApi.md#getsearchsuggestions) | **GET** /search/suggestions |
[*SearchApi*](doc/SearchApi.md) | [**search**](doc/SearchApi.md#search) | **GET** /search |
[*SearchApi*](doc/SearchApi.md) | [**searchMetadata**](doc/SearchApi.md#searchmetadata) | **POST** /search/metadata |
[*SearchApi*](doc/SearchApi.md) | [**searchPerson**](doc/SearchApi.md#searchperson) | **GET** /search/person |
[*SearchApi*](doc/SearchApi.md) | [**searchPlaces**](doc/SearchApi.md#searchplaces) | **GET** /search/places |
[*SearchApi*](doc/SearchApi.md) | [**searchSmart**](doc/SearchApi.md#searchsmart) | **POST** /search/smart |
[*ServerInfoApi*](doc/ServerInfoApi.md) | [**getServerConfig**](doc/ServerInfoApi.md#getserverconfig) | **GET** /server-info/config |
[*ServerInfoApi*](doc/ServerInfoApi.md) | [**getServerFeatures**](doc/ServerInfoApi.md#getserverfeatures) | **GET** /server-info/features |
[*ServerInfoApi*](doc/ServerInfoApi.md) | [**getServerInfo**](doc/ServerInfoApi.md#getserverinfo) | **GET** /server-info |
[*ServerInfoApi*](doc/ServerInfoApi.md) | [**getServerStatistics**](doc/ServerInfoApi.md#getserverstatistics) | **GET** /server-info/statistics |
[*ServerInfoApi*](doc/ServerInfoApi.md) | [**getServerVersion**](doc/ServerInfoApi.md#getserverversion) | **GET** /server-info/version |
[*ServerInfoApi*](doc/ServerInfoApi.md) | [**getSupportedMediaTypes**](doc/ServerInfoApi.md#getsupportedmediatypes) | **GET** /server-info/media-types |
[*ServerInfoApi*](doc/ServerInfoApi.md) | [**getTheme**](doc/ServerInfoApi.md#gettheme) | **GET** /server-info/theme |
[*ServerInfoApi*](doc/ServerInfoApi.md) | [**pingServer**](doc/ServerInfoApi.md#pingserver) | **GET** /server-info/ping |
[*SessionsApi*](doc/SessionsApi.md) | [**deleteAllSessions**](doc/SessionsApi.md#deleteallsessions) | **DELETE** /sessions |
[*SessionsApi*](doc/SessionsApi.md) | [**deleteSession**](doc/SessionsApi.md#deletesession) | **DELETE** /sessions/{id} |
[*SessionsApi*](doc/SessionsApi.md) | [**getSessions**](doc/SessionsApi.md#getsessions) | **GET** /sessions |
[*SharedLinkApi*](doc/SharedLinkApi.md) | [**addSharedLinkAssets**](doc/SharedLinkApi.md#addsharedlinkassets) | **PUT** /shared-link/{id}/assets |
[*SharedLinkApi*](doc/SharedLinkApi.md) | [**createSharedLink**](doc/SharedLinkApi.md#createsharedlink) | **POST** /shared-link |
[*SharedLinkApi*](doc/SharedLinkApi.md) | [**getAllSharedLinks**](doc/SharedLinkApi.md#getallsharedlinks) | **GET** /shared-link |
[*SharedLinkApi*](doc/SharedLinkApi.md) | [**getMySharedLink**](doc/SharedLinkApi.md#getmysharedlink) | **GET** /shared-link/me |
[*SharedLinkApi*](doc/SharedLinkApi.md) | [**getSharedLinkById**](doc/SharedLinkApi.md#getsharedlinkbyid) | **GET** /shared-link/{id} |
[*SharedLinkApi*](doc/SharedLinkApi.md) | [**removeSharedLink**](doc/SharedLinkApi.md#removesharedlink) | **DELETE** /shared-link/{id} |
[*SharedLinkApi*](doc/SharedLinkApi.md) | [**removeSharedLinkAssets**](doc/SharedLinkApi.md#removesharedlinkassets) | **DELETE** /shared-link/{id}/assets |
[*SharedLinkApi*](doc/SharedLinkApi.md) | [**updateSharedLink**](doc/SharedLinkApi.md#updatesharedlink) | **PATCH** /shared-link/{id} |
[*SyncApi*](doc/SyncApi.md) | [**getAllForUserFullSync**](doc/SyncApi.md#getallforuserfullsync) | **GET** /sync/full-sync |
[*SyncApi*](doc/SyncApi.md) | [**getDeltaSync**](doc/SyncApi.md#getdeltasync) | **GET** /sync/delta-sync |
[*SystemConfigApi*](doc/SystemConfigApi.md) | [**getConfig**](doc/SystemConfigApi.md#getconfig) | **GET** /system-config |
[*SystemConfigApi*](doc/SystemConfigApi.md) | [**getConfigDefaults**](doc/SystemConfigApi.md#getconfigdefaults) | **GET** /system-config/defaults |
[*SystemConfigApi*](doc/SystemConfigApi.md) | [**getMapStyle**](doc/SystemConfigApi.md#getmapstyle) | **GET** /system-config/map/style.json |
[*SystemConfigApi*](doc/SystemConfigApi.md) | [**getStorageTemplateOptions**](doc/SystemConfigApi.md#getstoragetemplateoptions) | **GET** /system-config/storage-template-options |
[*SystemConfigApi*](doc/SystemConfigApi.md) | [**updateConfig**](doc/SystemConfigApi.md#updateconfig) | **PUT** /system-config |
[*SystemMetadataApi*](doc/SystemMetadataApi.md) | [**getAdminOnboarding**](doc/SystemMetadataApi.md#getadminonboarding) | **GET** /system-metadata/admin-onboarding |
[*SystemMetadataApi*](doc/SystemMetadataApi.md) | [**getReverseGeocodingState**](doc/SystemMetadataApi.md#getreversegeocodingstate) | **GET** /system-metadata/reverse-geocoding-state |
[*SystemMetadataApi*](doc/SystemMetadataApi.md) | [**updateAdminOnboarding**](doc/SystemMetadataApi.md#updateadminonboarding) | **POST** /system-metadata/admin-onboarding |
[*TagApi*](doc/TagApi.md) | [**createTag**](doc/TagApi.md#createtag) | **POST** /tag |
[*TagApi*](doc/TagApi.md) | [**deleteTag**](doc/TagApi.md#deletetag) | **DELETE** /tag/{id} |
[*TagApi*](doc/TagApi.md) | [**getAllTags**](doc/TagApi.md#getalltags) | **GET** /tag |
[*TagApi*](doc/TagApi.md) | [**getTagAssets**](doc/TagApi.md#gettagassets) | **GET** /tag/{id}/assets |
[*TagApi*](doc/TagApi.md) | [**getTagById**](doc/TagApi.md#gettagbyid) | **GET** /tag/{id} |
[*TagApi*](doc/TagApi.md) | [**tagAssets**](doc/TagApi.md#tagassets) | **PUT** /tag/{id}/assets |
[*TagApi*](doc/TagApi.md) | [**untagAssets**](doc/TagApi.md#untagassets) | **DELETE** /tag/{id}/assets |
[*TagApi*](doc/TagApi.md) | [**updateTag**](doc/TagApi.md#updatetag) | **PATCH** /tag/{id} |
[*TimelineApi*](doc/TimelineApi.md) | [**getTimeBucket**](doc/TimelineApi.md#gettimebucket) | **GET** /timeline/bucket |
[*TimelineApi*](doc/TimelineApi.md) | [**getTimeBuckets**](doc/TimelineApi.md#gettimebuckets) | **GET** /timeline/buckets |
[*TrashApi*](doc/TrashApi.md) | [**emptyTrash**](doc/TrashApi.md#emptytrash) | **POST** /trash/empty |
[*TrashApi*](doc/TrashApi.md) | [**restoreAssets**](doc/TrashApi.md#restoreassets) | **POST** /trash/restore/assets |
[*TrashApi*](doc/TrashApi.md) | [**restoreTrash**](doc/TrashApi.md#restoretrash) | **POST** /trash/restore |
[*UserApi*](doc/UserApi.md) | [**createProfileImage**](doc/UserApi.md#createprofileimage) | **POST** /user/profile-image |
[*UserApi*](doc/UserApi.md) | [**createUser**](doc/UserApi.md#createuser) | **POST** /user |
[*UserApi*](doc/UserApi.md) | [**deleteProfileImage**](doc/UserApi.md#deleteprofileimage) | **DELETE** /user/profile-image |
[*UserApi*](doc/UserApi.md) | [**deleteUser**](doc/UserApi.md#deleteuser) | **DELETE** /user/{id} |
[*UserApi*](doc/UserApi.md) | [**getAllUsers**](doc/UserApi.md#getallusers) | **GET** /user |
[*UserApi*](doc/UserApi.md) | [**getMyUserInfo**](doc/UserApi.md#getmyuserinfo) | **GET** /user/me |
[*UserApi*](doc/UserApi.md) | [**getProfileImage**](doc/UserApi.md#getprofileimage) | **GET** /user/profile-image/{id} |
[*UserApi*](doc/UserApi.md) | [**getUserById**](doc/UserApi.md#getuserbyid) | **GET** /user/info/{id} |
[*UserApi*](doc/UserApi.md) | [**restoreUser**](doc/UserApi.md#restoreuser) | **POST** /user/{id}/restore |
[*UserApi*](doc/UserApi.md) | [**updateUser**](doc/UserApi.md#updateuser) | **PUT** /user |
## Documentation For Models
- [APIKeyCreateDto](doc/APIKeyCreateDto.md)
- [APIKeyCreateResponseDto](doc/APIKeyCreateResponseDto.md)
- [APIKeyResponseDto](doc/APIKeyResponseDto.md)
- [APIKeyUpdateDto](doc/APIKeyUpdateDto.md)
- [ActivityCreateDto](doc/ActivityCreateDto.md)
- [ActivityResponseDto](doc/ActivityResponseDto.md)
- [ActivityStatisticsResponseDto](doc/ActivityStatisticsResponseDto.md)
- [AddUsersDto](doc/AddUsersDto.md)
- [AdminOnboardingUpdateDto](doc/AdminOnboardingUpdateDto.md)
- [AlbumCountResponseDto](doc/AlbumCountResponseDto.md)
- [AlbumResponseDto](doc/AlbumResponseDto.md)
- [AllJobStatusResponseDto](doc/AllJobStatusResponseDto.md)
- [AssetBulkDeleteDto](doc/AssetBulkDeleteDto.md)
- [AssetBulkUpdateDto](doc/AssetBulkUpdateDto.md)
- [AssetBulkUploadCheckDto](doc/AssetBulkUploadCheckDto.md)
- [AssetBulkUploadCheckItem](doc/AssetBulkUploadCheckItem.md)
- [AssetBulkUploadCheckResponseDto](doc/AssetBulkUploadCheckResponseDto.md)
- [AssetBulkUploadCheckResult](doc/AssetBulkUploadCheckResult.md)
- [AssetDeltaSyncResponseDto](doc/AssetDeltaSyncResponseDto.md)
- [AssetFaceResponseDto](doc/AssetFaceResponseDto.md)
- [AssetFaceUpdateDto](doc/AssetFaceUpdateDto.md)
- [AssetFaceUpdateItem](doc/AssetFaceUpdateItem.md)
- [AssetFaceWithoutPersonResponseDto](doc/AssetFaceWithoutPersonResponseDto.md)
- [AssetFileUploadResponseDto](doc/AssetFileUploadResponseDto.md)
- [AssetIdsDto](doc/AssetIdsDto.md)
- [AssetIdsResponseDto](doc/AssetIdsResponseDto.md)
- [AssetJobName](doc/AssetJobName.md)
- [AssetJobsDto](doc/AssetJobsDto.md)
- [AssetOrder](doc/AssetOrder.md)
- [AssetResponseDto](doc/AssetResponseDto.md)
- [AssetStatsResponseDto](doc/AssetStatsResponseDto.md)
- [AssetTypeEnum](doc/AssetTypeEnum.md)
- [AudioCodec](doc/AudioCodec.md)
- [AuditDeletesResponseDto](doc/AuditDeletesResponseDto.md)
- [BulkIdResponseDto](doc/BulkIdResponseDto.md)
- [BulkIdsDto](doc/BulkIdsDto.md)
- [CLIPConfig](doc/CLIPConfig.md)
- [CLIPMode](doc/CLIPMode.md)
- [CQMode](doc/CQMode.md)
- [ChangePasswordDto](doc/ChangePasswordDto.md)
- [CheckExistingAssetsDto](doc/CheckExistingAssetsDto.md)
- [CheckExistingAssetsResponseDto](doc/CheckExistingAssetsResponseDto.md)
- [Colorspace](doc/Colorspace.md)
- [CreateAlbumDto](doc/CreateAlbumDto.md)
- [CreateAssetDto](doc/CreateAssetDto.md)
- [CreateLibraryDto](doc/CreateLibraryDto.md)
- [CreateProfileImageDto](doc/CreateProfileImageDto.md)
- [CreateProfileImageResponseDto](doc/CreateProfileImageResponseDto.md)
- [CreateTagDto](doc/CreateTagDto.md)
- [CreateUserDto](doc/CreateUserDto.md)
- [CuratedLocationsResponseDto](doc/CuratedLocationsResponseDto.md)
- [CuratedObjectsResponseDto](doc/CuratedObjectsResponseDto.md)
- [DeleteUserDto](doc/DeleteUserDto.md)
- [DownloadArchiveInfo](doc/DownloadArchiveInfo.md)
- [DownloadInfoDto](doc/DownloadInfoDto.md)
- [DownloadResponseDto](doc/DownloadResponseDto.md)
- [EntityType](doc/EntityType.md)
- [ExifResponseDto](doc/ExifResponseDto.md)
- [FaceDto](doc/FaceDto.md)
- [FileChecksumDto](doc/FileChecksumDto.md)
- [FileChecksumResponseDto](doc/FileChecksumResponseDto.md)
- [FileReportDto](doc/FileReportDto.md)
- [FileReportFixDto](doc/FileReportFixDto.md)
- [FileReportItemDto](doc/FileReportItemDto.md)
- [ImageFormat](doc/ImageFormat.md)
- [JobCommand](doc/JobCommand.md)
- [JobCommandDto](doc/JobCommandDto.md)
- [JobCountsDto](doc/JobCountsDto.md)
- [JobName](doc/JobName.md)
- [JobSettingsDto](doc/JobSettingsDto.md)
- [JobStatusDto](doc/JobStatusDto.md)
- [LibraryResponseDto](doc/LibraryResponseDto.md)
- [LibraryStatsResponseDto](doc/LibraryStatsResponseDto.md)
- [LibraryType](doc/LibraryType.md)
- [LogLevel](doc/LogLevel.md)
- [LoginCredentialDto](doc/LoginCredentialDto.md)
- [LoginResponseDto](doc/LoginResponseDto.md)
- [LogoutResponseDto](doc/LogoutResponseDto.md)
- [MapMarkerResponseDto](doc/MapMarkerResponseDto.md)
- [MapTheme](doc/MapTheme.md)
- [MemoryCreateDto](doc/MemoryCreateDto.md)
- [MemoryLaneResponseDto](doc/MemoryLaneResponseDto.md)
- [MemoryResponseDto](doc/MemoryResponseDto.md)
- [MemoryType](doc/MemoryType.md)
- [MemoryUpdateDto](doc/MemoryUpdateDto.md)
- [MergePersonDto](doc/MergePersonDto.md)
- [MetadataSearchDto](doc/MetadataSearchDto.md)
- [ModelType](doc/ModelType.md)
- [OAuthAuthorizeResponseDto](doc/OAuthAuthorizeResponseDto.md)
- [OAuthCallbackDto](doc/OAuthCallbackDto.md)
- [OAuthConfigDto](doc/OAuthConfigDto.md)
- [OnThisDayDto](doc/OnThisDayDto.md)
- [PartnerResponseDto](doc/PartnerResponseDto.md)
- [PathEntityType](doc/PathEntityType.md)
- [PathType](doc/PathType.md)
- [PeopleResponseDto](doc/PeopleResponseDto.md)
- [PeopleUpdateDto](doc/PeopleUpdateDto.md)
- [PeopleUpdateItem](doc/PeopleUpdateItem.md)
- [PersonCreateDto](doc/PersonCreateDto.md)
- [PersonResponseDto](doc/PersonResponseDto.md)
- [PersonStatisticsResponseDto](doc/PersonStatisticsResponseDto.md)
- [PersonUpdateDto](doc/PersonUpdateDto.md)
- [PersonWithFacesResponseDto](doc/PersonWithFacesResponseDto.md)
- [PlacesResponseDto](doc/PlacesResponseDto.md)
- [QueueStatusDto](doc/QueueStatusDto.md)
- [ReactionLevel](doc/ReactionLevel.md)
- [ReactionType](doc/ReactionType.md)
- [RecognitionConfig](doc/RecognitionConfig.md)
- [ReverseGeocodingStateResponseDto](doc/ReverseGeocodingStateResponseDto.md)
- [ScanLibraryDto](doc/ScanLibraryDto.md)
- [SearchAlbumResponseDto](doc/SearchAlbumResponseDto.md)
- [SearchAssetResponseDto](doc/SearchAssetResponseDto.md)
- [SearchExploreItem](doc/SearchExploreItem.md)
- [SearchExploreResponseDto](doc/SearchExploreResponseDto.md)
- [SearchFacetCountResponseDto](doc/SearchFacetCountResponseDto.md)
- [SearchFacetResponseDto](doc/SearchFacetResponseDto.md)
- [SearchResponseDto](doc/SearchResponseDto.md)
- [SearchSuggestionType](doc/SearchSuggestionType.md)
- [ServerConfigDto](doc/ServerConfigDto.md)
- [ServerFeaturesDto](doc/ServerFeaturesDto.md)
- [ServerInfoResponseDto](doc/ServerInfoResponseDto.md)
- [ServerMediaTypesResponseDto](doc/ServerMediaTypesResponseDto.md)
- [ServerPingResponse](doc/ServerPingResponse.md)
- [ServerStatsResponseDto](doc/ServerStatsResponseDto.md)
- [ServerThemeDto](doc/ServerThemeDto.md)
- [ServerVersionResponseDto](doc/ServerVersionResponseDto.md)
- [SessionResponseDto](doc/SessionResponseDto.md)
- [SharedLinkCreateDto](doc/SharedLinkCreateDto.md)
- [SharedLinkEditDto](doc/SharedLinkEditDto.md)
- [SharedLinkResponseDto](doc/SharedLinkResponseDto.md)
- [SharedLinkType](doc/SharedLinkType.md)
- [SignUpDto](doc/SignUpDto.md)
- [SmartInfoResponseDto](doc/SmartInfoResponseDto.md)
- [SmartSearchDto](doc/SmartSearchDto.md)
- [SystemConfigDto](doc/SystemConfigDto.md)
- [SystemConfigFFmpegDto](doc/SystemConfigFFmpegDto.md)
- [SystemConfigImageDto](doc/SystemConfigImageDto.md)
- [SystemConfigJobDto](doc/SystemConfigJobDto.md)
- [SystemConfigLibraryDto](doc/SystemConfigLibraryDto.md)
- [SystemConfigLibraryScanDto](doc/SystemConfigLibraryScanDto.md)
- [SystemConfigLibraryWatchDto](doc/SystemConfigLibraryWatchDto.md)
- [SystemConfigLoggingDto](doc/SystemConfigLoggingDto.md)
- [SystemConfigMachineLearningDto](doc/SystemConfigMachineLearningDto.md)
- [SystemConfigMapDto](doc/SystemConfigMapDto.md)
- [SystemConfigNewVersionCheckDto](doc/SystemConfigNewVersionCheckDto.md)
- [SystemConfigOAuthDto](doc/SystemConfigOAuthDto.md)
- [SystemConfigPasswordLoginDto](doc/SystemConfigPasswordLoginDto.md)
- [SystemConfigReverseGeocodingDto](doc/SystemConfigReverseGeocodingDto.md)
- [SystemConfigServerDto](doc/SystemConfigServerDto.md)
- [SystemConfigStorageTemplateDto](doc/SystemConfigStorageTemplateDto.md)
- [SystemConfigTemplateStorageOptionDto](doc/SystemConfigTemplateStorageOptionDto.md)
- [SystemConfigThemeDto](doc/SystemConfigThemeDto.md)
- [SystemConfigTrashDto](doc/SystemConfigTrashDto.md)
- [SystemConfigUserDto](doc/SystemConfigUserDto.md)
- [TagResponseDto](doc/TagResponseDto.md)
- [TagTypeEnum](doc/TagTypeEnum.md)
- [ThumbnailFormat](doc/ThumbnailFormat.md)
- [TimeBucketResponseDto](doc/TimeBucketResponseDto.md)
- [TimeBucketSize](doc/TimeBucketSize.md)
- [ToneMapping](doc/ToneMapping.md)
- [TranscodeHWAccel](doc/TranscodeHWAccel.md)
- [TranscodePolicy](doc/TranscodePolicy.md)
- [UpdateAlbumDto](doc/UpdateAlbumDto.md)
- [UpdateAssetDto](doc/UpdateAssetDto.md)
- [UpdateLibraryDto](doc/UpdateLibraryDto.md)
- [UpdatePartnerDto](doc/UpdatePartnerDto.md)
- [UpdateStackParentDto](doc/UpdateStackParentDto.md)
- [UpdateTagDto](doc/UpdateTagDto.md)
- [UpdateUserDto](doc/UpdateUserDto.md)
- [UsageByUserDto](doc/UsageByUserDto.md)
- [UserAvatarColor](doc/UserAvatarColor.md)
- [UserDto](doc/UserDto.md)
- [UserResponseDto](doc/UserResponseDto.md)
- [UserStatus](doc/UserStatus.md)
- [ValidateAccessTokenResponseDto](doc/ValidateAccessTokenResponseDto.md)
- [ValidateLibraryDto](doc/ValidateLibraryDto.md)
- [ValidateLibraryImportPathResponseDto](doc/ValidateLibraryImportPathResponseDto.md)
- [ValidateLibraryResponseDto](doc/ValidateLibraryResponseDto.md)
- [VideoCodec](doc/VideoCodec.md)
## Documentation For Authorization
Authentication schemes defined for the API:
### bearer
- **Type**: HTTP Bearer Token authentication (JWT)
### cookie
- **Type**: API key
- **API key parameter name**: immich_access_token
- **Location**:
### api_key
- **Type**: API key
- **API key parameter name**: x-api-key
- **Location**: HTTP header
## Author
Reference in New Issue View Git Blame Copy Permalink