Upload a Notes ID File
Added by IBM contributorGordon Hegfield on April 8, 2016
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

This API allows applications to upload a Notes ID file to the SmartCloud Notes ID Vault.

The payload of the post action is the id file data. The content type must be application/octet-stream. The file size limit is 64 kilobytes. 

Method URI Description
POST /api/admin/users/idfile
Name Type Optional Description
string No Must be application/octet-string.
string Yes Controls the language used in response messages. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4 for details. Responses default to English (US).
string No Internet address of the target user. For example: X-HTTP-Query-Email: "john.doe@renovations.com"
string No Password used to unlock the ID File. For example: X-HTTP-Query-Password: "Pa88w0rd"
Content Type: application/json
Use the table below that represents the returned fields:
Name Type Optional Description
string Yes Text providing more detail about the response.
Code Description
OK. Indicates that the request was received successfully.
Bad Request. Returned when password length parameter is missing, ID file already exists, ID file does not match the specified user, ID file password is wrong or the ID file is corrupt.
Forbidden.Authenticated user is not permitted to access the /api/admin/users/<rfc821name>/id resource
User specified by the rfc821name URL parameter in /api/admin/users/<rfc821name>/id cannot be found.