ID4i HTTP API
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
ID4i HTTP API
| method | path | what the vendor says it does |
|---|---|---|
POST | /account/password | Request password reset Requesting a reset for a new password. Accounts |
PUT | /account/password | Verify password reset Setting a new password and verifying the request to set the password. Accounts |
POST | /account/registration | Register user Registering a new user. Accounts |
PUT | /account/registration | Complete registration Completing a registration e.g. for invited users. Finish registration with a username an |
POST | /account/verification | Verify registration Verifies a new user registration. Accounts |
GET | /api/v1/apikeys | Find API key by organization Finding all API key assigned to the specified organization in a paginated manner. |
POST | /api/v1/apikeys | Create API key Creation of a new API key. Api Keys |
GET | /api/v1/apikeys/privileges | List all privileges Listing all possible API key privileges. Api Keys |
GET | /api/v1/apikeys/{key} | Show API key Showing the details of an API key. Api Keys |
PUT | /api/v1/apikeys/{key} | Update API keys API keys can be updated with new labels, and be activated and deactivated. The secret or UUID |
DELETE | /api/v1/apikeys/{key} | Delete API key Deletion of an API key. Api Keys |
GET | /api/v1/apikeys/{key}/privileges | List privileges Api Keys |
POST | /api/v1/apikeys/{key}/privileges | Add privilege Api Keys |
DELETE | /api/v1/apikeys/{key}/privileges | Remove privilege Api Keys |
GET | /api/v1/apikeys/{key}/privileges/{privilege}/id4ns | ID4ns of a privilege Listing ID4ns of a id4n concerning privilege Api Keys |
POST | /api/v1/apikeys/{key}/privileges/{privilege}/id4ns | Add ID4ns of a privilege Api Keys |
DELETE | /api/v1/apikeys/{key}/privileges/{privilege}/id4ns | Remove id4ns of a privilege Api Keys |
GET | /api/v1/billing/{organizationId} | Get billing amount of services for a given organization Billing |
GET | /api/v1/billing/{organizationId}/positions | Get billing positions for a given organization Billing |
GET | /api/v1/changelog/organization/{organizationId}/ | List change log entries of an organization Listing change log entries of the specified organization id. Auditi |
POST | /api/v1/collections | Create collection Collections |
GET | /api/v1/collections/{id4n} | Find collection Collections |
PATCH | /api/v1/collections/{id4n} | Update collection Update collection changing only the given values Collections |
DELETE | /api/v1/collections/{id4n} | Delete collection Collections |
GET | /api/v1/collections/{id4n}/elements | List contents of the collection Collections |
POST | /api/v1/collections/{id4n}/elements | Add elements to collection Collections |
DELETE | /api/v1/collections/{id4n}/elements | Remove elements from collection Collections |
GET | /api/v1/countries | List countries Organizations |
GET | /api/v1/documents/{id4n} | List documents Listing all documents of an id4n Storage |
GET | /api/v1/documents/{id4n}/{organizationId} | List organization specific documents Listing documents of an id4n seen by a specified organization Storage |
POST | /api/v1/documents/{id4n}/{organizationId} | Create an document for an id4n The documents' mime type is suggested on octet-stream data. Otherwise the speci |
PUT | /api/v1/documents/{id4n}/{organizationId} | Put an document for an id4n Creating or overwriting an existing document Storage |
GET | /api/v1/documents/{id4n}/{organizationId}/{fileName} | Read document contents Storage |
DELETE | /api/v1/documents/{id4n}/{organizationId}/{fileName} | Delete a document Storage |
GET | /api/v1/documents/{id4n}/{organizationId}/{fileName}/metadata | Retrieve a document (meta-data only, no content) Storage |
PATCH | /api/v1/documents/{id4n}/{organizationId}/{fileName}/metadata | Update a document Storage |
POST | /api/v1/guids | Create GUID(s) Creating one or more GUIDs with a specified length. Guids |
GET | /api/v1/guids/withoutCollection | Retrieve GUIDs not in any collection Guids |
GET | /api/v1/guids/{id4n} | Retrieve GUID information Guids |
PATCH | /api/v1/guids/{id4n} | Change GUID information. Allows ownership transfer. Guids |
and 65 more operation(s) in this specification, all searchable.
specification origin: https://backend.id4i.de/docs/swagger.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.