Users: Difference between revisions
Jump to navigation
Jump to search
api>Admin |
m 1 revision imported |
(No difference)
|
Latest revision as of 06:27, 17 October 2023
This operation get users authorizated by api client in Safe Stamper.
URL
https://www.safestamper.com/api/users
Parameters
- sharedkey: Your API client shared key
- signature: Parameters signature, as explained in Signature parameter
- page: Page number to return (optional, defaults to 1)
Returns
A JSON object with the following fields:
- pageSize: Maximum number of users per page
- count: Total number of users
- pageTotal: Total number of pages
- list: array of JSON with the user auth data
- authkey: Authkey value
- authorized: State of authkey (true|false).
- state: State of Safe Stamper user (ACTIVE|DISABLED)
- userCode: Safe Stamper code of the authorizing user.
- userMail: Mail of the authorizing user.
- userName: Full name of the authorizing user.
- accountType: Account type of the authorizing user (BASIC|PREMIUM).
- userType: User type of the authorizing user (INDIVIDUAL|ORGANIZATION|OPERATOR).
- mainUserAuthkey: Authkey of main user for authorized operators.
- availableCertificates: Available certification credits to use web static, mail, file and photo services.
- availableNavigations: Available certification credits to use browsing session services.
- availableTimestamps: Available timestamp credits to use tsa services.
- maxCertificateSize: Máx size in bytes for certificates
- maxCertificateSizeMb: Máx size in MB for certificates
HTTP Errors
- 403 Forbidden: the sharedkey is not valid
Example
REQUEST:
https://www.safestamper.com/api/users ?sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh &signature=35e157d8539fd66ca385fabb8967d4e8f180056f
RESPONSE (actual response has no line breaks or indentation):
{ "pageSize":50, "count":1, "pageTotal":1, "list":[ { "accountType":"PREMIUM", "authkey":"0021d81c-e4a5-4869-8384-2fd70cdb58ec", "authorized":true, "availableCertificates":50, "availableNavigations":3, "availableTimestamps":10, "maxCertificateSize":"22500000" "maxCertificateSizemB":"15" "state":"ACTIVE", "userCode":"1612020000541", "userMail" : "apitest@safecreative.org", "userName":"Api User Test" "userType":"INDIVIDUAL" } ] }