User Authentication API
Create Authentication Token
Authenticate a user by supplying their login credentials.
If successful, the response consists of access token and refresh token. Access tokens carry the necessary information to access a resource directly. Refresh tokens carry the information necessary to get a new access token.
Whenever the user wants to access a protected route or resource, the user agent should send the access token, typically in the Authorization header using the Bearer schema.
The content of the header should look like the following: **Authorization: Bearer "accessToken"
The server’s protected routes will check for a valid token in the Authorization header, and if it’s present, the user will be allowed to access protected resources.
Since tokens are credentials, great care must be taken to prevent security issues. In general, you should not keep tokens longer than required.
The access token is being created with a validity time of 15 minutes. When access token is expired you should ask for new one and send to the server refresh token.
Certificate Authentication
If certificate authentication is enabled the response will be a 307 status code with a Location header. The Location will contain a URL to POST the same request. This URL will require TLS client authentication.
Once a success status code is returned, the original URL should be used. The TLS client authenticaiton URL is only needed when accuiring the access token.
HTTP request
POST /auth/pwd HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json;charset=UTF-8
Host: localhost:8080
{
"username": "airone",
"password": "admin1"
}HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"accessToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhaXJvbmUiLCJBdXRob3JpdGllcyI6WyJST0xFX1VTRVIiXSwiZXhwIjoxNTUwODUyMDI4LCJpYXQiOjE1NTA4NTE0Mjh9.cLPBNj7I0txdx1OCjNg6my4-6LvdBo2rGLzDMA9WGQQvkBVMjlCrsPKOB_DyMfz4VlU4_GAjiYaeuH0XV_TvhA",
"refreshToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhaXJvbmUiLCJBdXRob3JpdGllcyI6WyJST0xFX1JFRlJFU0hfVE9LRU4iXSwiZXhwIjoxNTYwODUxNDI4LCJpYXQiOjE1NTA4NTE0Mjh9.ofrvk_TSVrAihcTrRd4P_acoXXmlCoslhR6K-hoB0KjdvAE8nR603KQ4b8JAd8Xq2ll6ob4FqmiGWDjiSQmy_w"
}Request fields
| Variable | Type | Optional |
|---|---|---|
|
|
false |
|
|
false |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Access Token |
|
|
Refresh Token |
Refresh Authentication Token
Create new access token using the refresh token. This prevents the need for the original authentication credentials.
HTTP request
POST /auth/refresh HTTP/1.1
Accept: application/json;charset=UTF-8
Host: localhost:8080
eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhaXJvbmUiLCJBdXRob3JpdGllcyI6WyJST0xFX1JFRlJFU0hfVE9LRU4iXSwiZXhwIjoxNTYwODUzNDU1LCJpYXQiOjE1NTA4NTM0NTV9.NaMR18SYxvmvGX5v46fwuhNVYaK6mPKTpakh4orV3_cNIO4YrHb-_bujOhbVxZILlrJ4SJz0bEjuTqBGnNno1AHTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"accessToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhaXJvbmUiLCJBdXRob3JpdGllcyI6WyJST0xFX1VTRVIiXSwiZXhwIjoxNTUwODU0MTE0LCJpYXQiOjE1NTA4NTM1MTR9.tCUrUTMrDMCBtA9TZvYmtuHMlGIM01zMfMdHT3nGhuol5H01YVTv8hf_r7FKIuwiUzjC5isc7xf_ZM8YR5fbtA"
}Request parameters
| Parameter | Description | Optional |
|---|---|---|
|
Refresh token |
false |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Access Token |
Reset Password Request
Request a password reset for the specified user. The user will be sent an email with a link to page to complete the password reset. The link will contain an password reset authorization code.
The response contains true if the password reset was successfully requested and an email has been sent. If the email had been requested within the past 15 minutes the response will contain false.
HTTP request
POST /auth/reset?login=test_login HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 4
trueQuery parameters
| Parameter | Description |
|---|---|
|
Login |
Reset Password
Reset a user’s password to a new password. The reset is authorized if the code field in the request matches the most recent code sent by a request to reset the password.
HTTP request
POST /auth/update HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 155
Host: localhost:8080
{
"updatedPassword" : {
"newPassword" : "password1",
"repeatedNewPassword" : "password1"
},
"code" : "bed76301-92ff-413b-9f7a-bb876183cb79"
}HTTP response
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersRequest fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
code |
String |
code |
false |
|
updatedPassword |
Object |
Updated Password |
false |
|
updatedPassword.newPassword |
String |
Min length of the password is managed on ecosystem level. Must not be empty |
New Password. Other password policy requirements (like min length) managed on ecosystem level. |
false |
updatedPassword.repeatedNewPassword |
String |
Min length of the password is managed on ecosystem level. Must not be empty |
Repeated New Password. Other password policy requirements (like min length) managed on ecosystem level. |
false |
Check Verification Code
Checks if a verification code is valid. The response contains true if the verification code is valid and false otherwise.
HTTP request
POST /auth/validate-code?code=bed76301-92ff-413b-9f7a-bb876183cb79 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 4
trueQuery parameters
| Parameter | Description |
|---|---|
|
Check if the verification code has expired |
System API
Get password min length
Return password minimal length.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/system/properties/passwd-min-len?ecoSystemId=1&organizationId=1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 1
3Query parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
Set ecosystem password min length
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/passwd-min-len HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 19
Host: localhost:8080
{
"value" : "9"
}HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
value |
String |
Must be at least 3. |
Minimum allowed password length. By default is "3". |
false |
Set organization password min length
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/organizations/1/passwd-min-len HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 19
Host: localhost:8080
{
"value" : "9"
}HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
value |
String |
Must be at least 3. |
Minimum allowed password length. By default is "3". |
false |
Get password restrictions
User must be authenticated as admin or user.
HTTP request
GET /api/v2/system/properties/passwd-restrictions?ecoSystemId=1&organizationId=1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 144
{
"upperAndLowerCasesEnabled" : false,
"lettersAndNumbersEnabled" : false,
"specialCharactersEnabled" : false,
"passwordMinLength" : 5
}Query parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Enabled/Disabled upper and lower case password restriction. |
|
|
Enabled/Disabled letter and number password restriction. |
|
|
Enabled/Disabled special character password restriction. |
|
|
Minimum allowed password length for ecosystem. By default is "3". |
Set password restrictions
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/passwd-restrictions HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 142
Host: localhost:8080
{
"upperAndLowerCasesEnabled" : true,
"lettersAndNumbersEnabled" : false,
"specialCharactersEnabled" : true,
"passwordMinLength" : 6
}HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
upperAndLowerCasesEnabled |
Boolean |
Enables/Disables upper and lower case password restriction. |
false |
|
lettersAndNumbersEnabled |
Boolean |
Enables/Disables letter and number password restriction. |
false |
|
specialCharactersEnabled |
Boolean |
Enables/Disables special character password restriction. |
false |
|
passwordMinLength |
Number |
Minimum allowed password length for ecosystem. By default is "3". |
false |
Get ecosystem 2FA status
Return is 2FA enable for selected ecosystem
User must be authenticated as admin or user.
HTTP request
GET /api/v2/system/properties/2fa-status?ecoSystemId=1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 5
falseQuery parameters
| Parameter | Description |
|---|---|
|
EcosystemID |
Set ecosystem 2FA enable
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/2fa-status HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 4
Host: localhost:8080
trueHTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Get ecosystem batch duplicates verification
Return is batch duplicates verification for selected ecosystem
User must be authenticated as admin or user.
HTTP request
GET /api/v2/system/properties/ecosystems/1/batch-duplicates-verification HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 4
truePath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Set ecosystem batch duplicates verification
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/batch-duplicates-verification HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 4
Host: localhost:8080
trueHTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Get ecosystem support message enable
Return is support message enable for selected ecosystem
User must be authenticated as admin or user.
HTTP request
GET /api/v2/system/properties/ecosystems/1/support-message-status HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 4
truePath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Set ecosystem support message enable
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/support-message-status HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 4
Host: localhost:8080
trueHTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Get ecosystem support name
Return support name for selected ecosystem
User must be authenticated as admin or user.
HTTP request
GET /api/v2/system/properties/ecosystems/1/support-name HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 12
Support_namePath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Set ecosystem support name
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/support-name HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 13
Host: localhost:8080
Supportname45HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Get ecosystem support email
Return support email for selected ecosystem
User must be authenticated as admin or user.
HTTP request
GET /api/v2/system/properties/ecosystems/1/support-email HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 17
support@email.comPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Set ecosystem support email
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/support-email HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 17
Host: localhost:8080
support@email.comHTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Get ecosystem support phone
Return support phone for selected ecosystem
User must be authenticated as admin or user.
HTTP request
GET /api/v2/system/properties/ecosystems/1/support-phone HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 13
1-888-888-888Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Set ecosystem support phone
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/support-phone HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 16
Host: localhost:8080
+38 800 888 8888HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Get ecosystem invite for user without certificate
Return state of "send invite during login by user without certificate"
User must be authenticated as admin or user.
HTTP request
GET /api/v2/system/properties/ecosystems/1/invite-for-user-without-certificate HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 4
truePath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Set ecosystem invite for user without certificate
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/invite-for-user-without-certificate HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 4
Host: localhost:8080
trueHTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Get ecosystem enrollment code lifetime
Return state of "ecosystem enrollment code lifetime"
User must be authenticated as admin or user.
HTTP request
GET /api/v2/system/properties/ecosystems/1/enrollment-code-lifetime HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 2
30Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Set ecosystem enrollment code lifetime
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/enrollment-code-lifetime HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 2
Host: localhost:8080
30HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Set batch archive TTL ecosystem level
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/batch-archive-ttl HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 2
Host: localhost:8080
30HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Set batch archive TTL profile level
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/organizations/1/templates/1/batch-archive-ttl HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 2
Host: localhost:8080
30HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Template ID |
Reset batch archive TTL profile level
Resets batch archive TTL to default.
User must be authenticated as admin.
HTTP request
DELETE /api/v2/system/properties/ecosystems/1/organizations/1/templates/1/batch-archive-ttl HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Template ID |
Get batch TTL
Return number of days archive is available
User must be authenticated as admin or user.
HTTP request
GET /api/v2/system/properties/ecosystems/1/batch-archive-ttl?organizationId=1&templateId=1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 2
Host: localhost:8080
30HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 2
30Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Query parameters
| Parameter | Description |
|---|---|
|
Organization ID |
|
Template ID |
Get ecosystem maximum failed login attempts
Return ecosystem maximum failed login attempts.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/system/properties/ecosystems/1/maximum-login-attempts HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 2
10Query parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Set ecosystem maximum failed login attempts
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/maximum-login-attempts HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 2
Host: localhost:8080
10HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Get batch extension
Return extension/extensions that will be used in downloaded CSR batch certificate extensions.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/system/properties/ecosystems/1/batch-extension-request?organizationId=1&templateId=1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 72
{
"pemEnabled" : true,
"derEnabled" : true,
"p7bEnabled" : false
}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Query parameters
| Parameter | Description |
|---|---|
|
Organization ID |
|
Template ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Enabled/Disabled .pem extension. |
|
|
Enabled/Disabled .der extension. |
|
|
Enabled/Disabled .p7b. |
Set batch extension
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/organizations/1/templates/1/batch-extension-request HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 72
Host: localhost:8080
{
"pemEnabled" : true,
"derEnabled" : true,
"p7bEnabled" : false
}HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Template ID |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
pemEnabled |
Boolean |
Enables/Disables .pem extension. |
false |
|
derEnabled |
Boolean |
Enables/Disables .der extension. |
false |
|
p7bEnabled |
Boolean |
Enables/Disables .p7b. |
false |
Reset batch extensions
Resets extensions to default.
User must be authenticated as admin.
HTTP request
DELETE /api/v2/system/properties/ecosystems/1/organizations/1/templates/1/batch-extension-request HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Template ID |
Get PKCS 12 password minimum length
User must be authenticated as admin or user.
Returns minimum length for PKCS 12 password on ecosystem or profile level.
HTTP request
GET /api/v2/system/properties/pkcs12-passwd-min-len?ecoSystemId=1&organizationId=1&templateId=1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 1
8Query parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Template ID |
Set PKCS 12 password minimum length on Ecosystem level
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/pkcs12-passwd-min-len HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 2
Host: localhost:8080
11HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Set PKCS 12 password minimum length on Profile level
User must be authenticated as admin.
HTTP request
PUT /api/v2/system/properties/ecosystems/1/organizations/1/templates/1/pkcs12-passwd-min-len HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 2
Host: localhost:8080
11HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Template ID |
Reset PKCS 12 password minimum length on Profile level
Resets PKCS 12 password minimum length to default(for Ecosystem).
User must be authenticated as admin.
HTTP request
DELETE /api/v2/system/properties/ecosystems/1/organizations/1/templates/1/pkcs12-passwd-min-len HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Template ID |
Get system version
User must be authenticated as admin or user.
HTTP request
GET /api/v2/system/version HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 32
{
"iotVersion" : "21.04.0.1"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
IOT version |
Ecosystem API
Get ecosystems
Get available ecosystems.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/ecosystems HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 67
[ {
"id" : 1,
"name" : "Ecosystem_name",
"capacity" : 200
} ]Response fields
| Path | Type | Description |
|---|---|---|
|
|
Ecosystem ID |
|
|
Ecosystem Name |
|
|
Ecosystem Capacity |
Get ecosystem
Get ecosystem.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/ecosystems/1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 63
{
"id" : 1,
"name" : "Ecosystem_name",
"capacity" : 200
}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Ecosystem ID |
|
|
Ecosystem Name |
|
|
Ecosystem Capacity |
Get ecosystem statistics
Ecosystem statistic.
User must be authenticated as admin.
HTTP request
GET /api/v2/ecosystems/1/statistics HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 273
{
"capacity" : 20,
"balance" : 30,
"used" : 10,
"ordered" : [ {
"dt" : "2024-03-27T12:52:47.031558072-04:00",
"total" : 5,
"devices" : 8
} ],
"issued" : [ {
"dt" : "2024-03-27T12:52:47.031582262-04:00",
"total" : 3,
"devices" : 6
} ]
}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
EcoSystem Capacity |
|
|
EcoSystem Balance |
|
|
EcoSystem Used Balance |
|
|
Total Ordered Chart Point |
|
|
Ordered Devices Chart Point |
|
|
Ordered.DateTime.Year |
|
|
Total Issued Chart Point |
|
|
Issued Devices Chart Point |
|
|
Issued.DateTime.Year |
Get ecosystem balance
View ecosystem balance.
User must be authenticated as admin.
HTTP request
GET /api/v2/ecosystems/1/balance HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 3
100Get notification count
Counts the number of existed notifications.
User must be authenticated as admin or user.
HTTP request
HEAD /api/v2/ecosystems/1/notifications?filter=subject%3Dtest%20subject&filter=status%3DPROCESSING HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Access-Control-Expose-Headers: X-Total-Count, X-Offset
x-total-count: 1Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
Query parameters
| Parameter | Description |
|---|---|
|
a filter list where each element is represented by a key, an operator, and a value (<key><operator><value>). The key can take the following values: |
Response headers
| Name | Description |
|---|---|
|
Total count. |
Get notifications list
View list available of user notifications.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/ecosystems/1/notifications?page=1&size=1&sort=id,asc&filter=id%3D1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 227
[ {
"id" : 1,
"ecosystemId" : 1,
"subject" : "Notification Subject",
"status" : "DONE",
"created" : "2024-03-27T12:52:46.442680802Z",
"createdBy" : "admin",
"notificationsSent" : 5,
"errorCode" : "UNDEFINED"
} ]Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
Query parameters
| Parameter | Description |
|---|---|
|
Page number. If not set the value by default is 0 |
|
Size of requested list. If not set the value by default is 300 |
|
sort field ASC/DESC: |
|
A filter list where each element is represented by a key, an operator, and a value (<key><operator><value>). The key can take the following values: |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Notification ID |
|
|
Ecosystem Id |
|
|
Notification Subject |
|
|
Notification Status. Could be one of the value: |
|
|
Notification Created Time |
|
|
Author of Notification |
|
|
Count of Sent Notifications |
|
|
Error Code |
Create notification
Create user notifications.
User must be authenticated as admin.
HTTP request
POST /api/v2/ecosystems/1/notifications HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 95
Host: localhost:8080
{
"subject" : "test subject",
"message" : "test message",
"organizations" : [ 1, 2, 3 ]
}HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: /api/v2/ecosystems/1/notifications/1Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
subject |
String |
Must not be empty. |
Notification Subject |
false |
message |
String |
Must not be empty |
Notification Message |
false |
organizations |
Array |
Must not be empty |
List of Organizations |
false |
Create notification preview
Creates preview before sending notification.
User must be authenticated as admin.
HTTP request
POST /api/v2/ecosystems/1/notification-preview HTTP/1.1
Content-Type: application/json;charset=utf-8
Content-Length: 95
Host: localhost:8080
{
"subject" : "subject text",
"message" : "message text",
"organizations" : [ 1, 2, 3 ]
}HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 62
{
"subject" : "subject text",
"message" : "message text"
}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
subject |
String |
Must not be empty. |
Subject text |
false |
message |
String |
Must not be empty |
Message text |
false |
organizations |
Array |
Must not be empty |
List of organizations which will receive the notification |
false |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Subject text |
|
|
Message text |
Get notification by id
Return notification info with requested id.
User must be authenticated as admin.
HTTP request
GET /api/v2/ecosystems/1/notifications/1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 290
{
"id" : 1,
"ecosystemId" : 1,
"subject" : "subject text",
"message" : "message text",
"status" : "DONE",
"created" : "2024-03-27T12:52:46.142336158-04:00",
"createdBy" : "admin_login",
"notificationsSent" : 15,
"errorCode" : "UNDEFINED",
"organizations" : [ 1, 2, 3 ]
}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Notification Id |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Notification Id |
|
|
Ecosystem Id |
|
|
Subject text |
|
|
Message text |
|
|
Status of notification |
|
|
Date notification was created |
|
|
User login created notification |
|
|
Number of sent notifications |
|
|
errorCode |
|
|
List of organizations which received the notification |
In case of error, system will respond with error status and message. See Error Responses for more details
Search templates
Search for available templates.
User must be authenticated as admin.
HTTP request
GET /api/v2/ecosystems/1/templates?filter=status%3DACTIVE&filter=name%3DAeroMac HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 365
[ {
"id" : 1,
"ecosystemId" : 1,
"name" : "Template_name",
"caId" : "Fp3tPE9-v_OKWB-AAAAAA==",
"caName" : "IotMgrAdmin:IotMgrCa",
"algorithms" : [ "RSA:2048" ],
"generatorKeyType" : {
"alg" : "RSA",
"keySize" : [ "256" ]
},
"createdDate" : "2024-03-27T12:52:46.763436757-04:00",
"modifiedDate" : "2024-03-27T12:52:46.763451888-04:00"
} ]Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Query parameters
| Parameter | Description |
|---|---|
|
filter: a filter list where each element is represented by a key, an operator, and a value (<key><operator><value>), for example "name=AeroMac" or "status=ACTIVE". The key can take the following values: name. |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
CA Name |
|
|
CA Id |
|
|
Template creation date |
|
|
Template name |
|
|
Template id |
|
|
Ecosystem id |
|
|
Template modified date |
|
|
Algorithm |
|
|
Key size |
|
|
Algorithms |
Get template
Get template.
User must be authenticated as admin.
HTTP request
GET /api/v2/ecosystems/1/templates/1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 474
{
"id" : 1,
"ecosystemId" : 1,
"name" : "Template_name",
"caId" : "Fp3tPE9-v_OKWB-AAAAAA==",
"caName" : "IotMgrAdmin:IotMgrCa",
"algorithms" : [ "RSA:2048" ],
"generatorKeyType" : {
"alg" : "RSA",
"keySize" : [ "256" ]
},
"createdDate" : "2024-03-27T12:52:46.515803215-04:00",
"modifiedDate" : "2024-03-27T12:52:46.515819656-04:00",
"allowedKeyTypes" : [ {
"alg" : "RSA",
"keySize" : [ "256" ]
} ],
"template" : "Template_pattern"
}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Template ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Template pattern |
|
|
CA name |
|
|
CA id |
|
|
Template creation date |
|
|
Template name |
|
|
Template id |
|
|
Ecosystem id |
|
|
Template modified date |
|
|
Allowed key types algorithms |
|
|
Allowed key types size |
|
|
Algorithm |
|
|
Key size |
|
|
Key Algorithm Info |
More details about filtering rules see in this chapter
In case of error, system will respond with error status and message. See Error Responses for more details
Search organizations
View a list of all Organizations.
User must be authenticated as admin.
HTTP request
GET /api/v2/ecosystems/1/organizations?page=1&size=1&sort=organizationName,asc&filter=orgStatus%3DACTIVE HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 267
[ {
"id" : 0,
"organizationName" : "Test org name",
"ecosystemId" : 10,
"address" : "Org Address",
"primaryContactName" : "Contact Name",
"primaryContactEmail" : "test@email.test",
"primaryContactPhone" : "+38 012 345 6789",
"orgStatus" : "ACTIVE"
} ]Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Query parameters
| Parameter | Description |
|---|---|
|
Page number. If not set the value by default is 0 |
|
Size. If not set the value by default is 300 |
|
sort fields ASC/DESC: |
|
A filter list where each element is represented by a key, an operator, and a value (<key><operator><value>), for example "orgStatus=ACTIVE". The key can take the following values: |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Organization ID |
|
|
Organization Name |
|
|
Organization Address |
|
|
Primary Contact Name |
|
|
Primary Contact Email |
|
|
Primary Contact Phone |
|
|
Ecosystem ID |
|
|
Organization Status |
Get organizations count
Get organizations count.
User must be authenticated as admin.
HTTP request
HEAD /api/v2/ecosystems/1/organizations?filter=orgStatus%3DACTIVE HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Access-Control-Expose-Headers: X-Total-Count, X-Offset
x-total-count: 1Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Query parameters
| Parameter | Description |
|---|---|
|
A filter list where each element is represented by a key, an operator, and a value (<key><operator><value>), for example "orgStatus=ACTIVE". The key can take the following values: |
Response headers
| Name | Description |
|---|---|
|
Total count. |
Get organization by organization id
Get organization by "organizationId".
User must be authenticated as admin or user.
HTTP request
GET /api/v2/ecosystems/1/organizations/1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 733
{
"id" : 0,
"organizationName" : "Test org name",
"ecosystemId" : 10,
"address" : "Org Address",
"primaryContactName" : "Contact Name",
"primaryContactEmail" : "test@email.test",
"primaryContactPhone" : "+38 012 345 6789",
"profiles" : [ {
"id" : 4,
"templateId" : 4,
"name" : "ECC Device Certificate",
"algorithms" : [ "EC:P-256" ],
"caName" : "IotMgrAdmin:IotMgrCa",
"caId" : "Fp3tPE9-v_OKWB-AAAAAA==",
"generatorKeyType" : {
"alg" : "RSA",
"keySize" : [ "256" ]
}
} ],
"organizationParameters" : {
"OrganizationName" : "Org",
"HostManufacturerNumber" : "1020",
"CountryName" : "US",
"LocalityName" : "New York",
"StateOrProvinceName" : "NY"
}
}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Organization ID |
|
|
Organization Name |
|
|
Organization Address |
|
|
Primary Contact Name |
|
|
Primary Contact Email |
|
|
Primary Contact Phone |
|
|
Ecosystem ID |
|
|
Profile ID |
|
|
Template Id |
|
|
Profile Name |
|
|
Profile used algorithms |
|
|
CA name |
|
|
CA Id |
|
|
Algorithm |
|
|
Key size |
|
|
Organization scope parameters |
|
|
Organization Parameters HostManufacturerNumber |
|
|
Organization Parameters OrganizationName |
|
|
Organization Parameters LocalityName |
|
|
Organization Parameters StateOrProvinceName |
|
|
Organization Parameters CountryName |
Get organization related vars
Searching profile variables info for specific organization.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/ecosystems/1/organizations/1/vars HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 506
[ {
"name" : "Profile_var_name",
"group" : "Subject",
"description" : "Profile_var_description",
"format" : "BINARY",
"scope" : [ "BATCH" ],
"profileVarCsrField" : "Profile_var_name.1",
"generators" : [ "HEXDECIMAL" ],
"defaultValue" : "defaultValue",
"required" : "MANDATORY",
"allowed" : [ ],
"hasMultiValueSeparator" : true,
"profileVarValidationRuleInfo" : {
"regex" : "^(.*)$",
"minValue" : 10,
"maxValue" : 20,
"message" : "Value format is not correct"
}
} ]Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Profile Name |
|
|
Profile Group |
|
|
Description |
|
|
Format |
|
|
Scope |
|
|
Profile variable CSR field |
|
|
Generators |
|
|
Default Value |
|
|
Required |
|
|
Allowed Values |
|
|
Has Multi Value Separator. Property shows ability to submit multiple values, separated by comma |
|
|
Value Validation Rules |
|
|
Regular Expression |
|
|
Minimal Value |
|
|
Maximum Value |
|
|
Detailed Message |
Get profile variable validation rules
Get profile variable validation rules by reference name.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/ecosystems/1/organizations/1/ref-var-validation-rules/test_var HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 107
{
"regex" : "^(.*)$",
"minValue" : 10,
"maxValue" : 20,
"message" : "Value format is not correct"
}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Reference name |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Regular Expression |
|
|
Minimal Value |
|
|
Maximum Value |
|
|
Detailed Message |
Create new organization
Create new organization.
User must be authenticated as admin.
HTTP request
POST /api/v2/ecosystems/1/organizations HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 189
Host: localhost:8080
{
"organizationName" : "ACTIVE",
"address" : "Street 1",
"primaryContactName" : "John",
"primaryContactEmail" : "j.smith@example.com",
"primaryContactPhone" : "+38 012 345 6789"
}HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: /api/v2/ecosystems/1/organizations/0Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
organizationName |
String |
Must not be empty. |
Organization name |
false |
address |
String |
Must not be empty. |
Organization address |
false |
primaryContactName |
String |
Must not be empty. |
Primary Contact Name |
false |
primaryContactEmail |
String |
Must be a well-formed email address. |
Primary Contact Email |
false |
primaryContactPhone |
String |
Must match the regular expression: Must not be empty. |
Primary Contact Phone |
false |
Update organization parameters
Update parameters for selected organization.
User must be authenticated as admin.
HTTP request
PUT /api/v2/ecosystems/1/organizations/1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 378
Host: localhost:8080
{
"address" : "Street 1",
"primaryContactName" : "John",
"primaryContactEmail" : "j.smith@example.com",
"primaryContactPhone" : "+38 012 345 6789",
"orgStatus" : "ACTIVE",
"organizationParameters" : {
"OrganizationName" : "Org",
"HostManufacturerNumber" : "1",
"CountryName" : "US",
"LocalityName" : "New York",
"StateOrProvinceName" : "NY"
}
}HTTP response
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
address |
String |
Must not be empty. |
Organization address |
false |
primaryContactName |
String |
Must not be empty. |
Primary Contact Name |
false |
primaryContactEmail |
String |
Must be a well-formed email address. |
Primary Contact Email |
false |
primaryContactPhone |
String |
Must match the regular expression: Must not be empty. |
Primary Contact Phone |
false |
orgStatus |
String |
Must not be empty. |
Organization Status |
false |
organizationParameters |
Object |
OrganizationParameters |
true |
|
organizationParameters.HostManufacturerNumber |
String |
Organization Parameters HostManufacturerNumber |
true |
|
organizationParameters.OrganizationName |
String |
Organization Parameters OrganizationName |
true |
|
organizationParameters.LocalityName |
String |
Organization Parameters LocalityName |
true |
|
organizationParameters.StateOrProvinceName |
String |
Organization Parameters StateOrProvinceName |
true |
|
organizationParameters.CountryName |
String |
Organization Parameters CountryName |
true |
More details about filtering rules see in this chapter
In case of error, system will respond with error status and message. See Error Responses for more details
Get profile by profile id
Get profile by profile id.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/ecosystems/1/organizations/1/profiles/10 HTTP/1.1
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 341
{
"id" : 1,
"templateId" : 1,
"name" : "Profile_name",
"algorithms" : [ "RSA:2048" ],
"caName" : "IotMgrAdmin:IotMgrCa",
"caId" : "Fp3tPE9-v_OKWB-AAAAAA==",
"generatorKeyType" : {
"alg" : "RSA",
"keySize" : [ "256" ]
},
"allowedKeyTypes" : [ {
"alg" : "RSA",
"keySize" : [ "256" ]
} ],
"json" : "Json"
}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Profile ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Profile ID |
|
|
Template ID |
|
|
Profile Name |
|
|
Allowed key types algorithms |
|
|
Allowed key types size |
|
|
Algorithm |
|
|
Key size |
|
|
Json |
|
|
CA Name |
|
|
CA Id |
|
|
Key Algorithm Info |
Get profile variable information
Get profile variables information for specific profile.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/ecosystems/1/organizations/1/profiles/10/variables HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 789
{
"compositionInfo" : [ {
"name" : "commonName",
"format" : "{vCommonNameSerial}{vCommonName}",
"mode" : "string",
"required" : "MANDATORY",
"csrField" : "commonName.1",
"minLength" : 5
} ],
"profileVariableInfo" : [ {
"name" : "Profile_var_name",
"group" : "Subject",
"description" : "Profile_var_description",
"format" : "BINARY",
"scope" : [ "BATCH" ],
"profileVarCsrField" : "Profile_var_name.1",
"generators" : [ "HEXDECIMAL" ],
"defaultValue" : "defaultValue",
"required" : "MANDATORY",
"allowed" : [ ],
"hasMultiValueSeparator" : true,
"profileVarValidationRuleInfo" : {
"regex" : "^(.*)$",
"minValue" : 10,
"maxValue" : 20,
"message" : "Value format is not correct"
}
} ]
}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Profile ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Composed Variable Name |
|
|
Composed Variable Format |
|
|
Composed Variable Mode |
|
|
Composed Variable Mandatory Flag |
|
|
Composed Variable CSR Field |
|
|
Composed Variable Min Length |
|
|
Variable Name |
|
|
Variable Group |
|
|
Description |
|
|
Format |
|
|
Scope |
|
|
Profile variable CSR field |
|
|
Generators |
|
|
Default Value |
|
|
Required |
|
|
Allowed Values |
|
|
Has Multi Value Separator. Property shows ability to submit multiple values, separated by comma |
|
|
Value Validation Rules |
|
|
Regular Expression |
|
|
Minimal Value |
|
|
Maximum Value |
|
|
Detailed Message |
Search profiles
Get available profiles list.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/ecosystems/1/organizations/1/profiles?userId=1&statusList=ACTIVE&filter=name%3DDOCSIS31_%2345 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 248
[ {
"id" : 1,
"templateId" : 1,
"name" : "Profile_name",
"algorithms" : [ "RSA:2048" ],
"caName" : "IotMgrAdmin:IotMgrCa",
"caId" : "Fp3tPE9-v_OKWB-AAAAAA==",
"generatorKeyType" : {
"alg" : "RSA",
"keySize" : [ "256" ]
}
} ]Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
Query parameters
| Parameter | Description |
|---|---|
|
User ID |
|
Status List |
|
A filter list where each element is represented as a key, an operator and a value(for example "name=DOC").
The key can take only one value: |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Profile ID |
|
|
Template ID |
|
|
Profile name |
|
|
Algorithms |
|
|
CA Name |
|
|
CA ID |
|
|
Algorithm |
|
|
Key size |
Create profile
Create profile.
User must be authenticated as admin.
HTTP request
POST /api/v2/ecosystems/1/organizations/1/profiles HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 1
Host: localhost:8080
1HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: /api/v2/ecosystems/1/organizations/1/profiles/1Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
Request body
1Template ID is used as request body payload.
Update profile balance
Update balance on specific profile.
User must be authenticated as admin.
HTTP request
PUT /api/v2/ecosystems/1/organizations/1/profiles/1/balance HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 2
Host: localhost:8080
20HTTP response
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Profile ID |
Request body
20New balance value is used as request body payload.
Update profile status
Update status on specific profile.
User must be authenticated as admin.
HTTP request
PUT /api/v2/ecosystems/1/organizations/1/profiles/1/enabled HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 4
Host: localhost:8080
trueHTTP response
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Profile ID |
Request body
trueBoolean value is used as request body payload.
Update profile Json
Update Json data for specific profile.
User must be authenticated as admin.
HTTP request
PUT /api/v2/ecosystems/1/organizations/1/profiles/1/json HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Profile ID |
Download CA chain Zip
Download CA chain Zip for specific profile.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/ecosystems/1/templates/1/ca-chain HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Template ID |
In case of error, system will respond with error status and message. See Error Responses for more details
Get certificates count
Get certificates count.
User must be authenticated as user.
HTTP request
HEAD /api/v2/ecosystems/1/organizations/1/certificates?filter=batchId%3D1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Access-Control-Expose-Headers: X-Total-Count, X-Offset
x-total-count: 1Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
Query parameters
| Parameter | Description |
|---|---|
|
A filter list where each element is represented by a key, an operator, and a value (<key><operator><value>), for example "batchId=5". The key can take the following values: |
Response headers
| Name | Description |
|---|---|
|
Total count. |
Get certificates list
Find Certificate Using 'commonName' and 'serialNumber'.
User must be authenticated as user.
HTTP request
GET /api/v2/ecosystems/1/organizations/1/certificates?filter=status%3DREADY_FOR_DOWNLOAD&page=1&size=1&sort=id,asc HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 310
[ {
"id" : "d24b02a8-c351-4972-82b4-a7a219303552",
"orgId" : 1,
"batchId" : 1,
"batchSource" : 0,
"name" : "Certificate_name",
"certSerial" : "1",
"status" : "READY_FOR_DOWNLOAD",
"commonName" : "common_name",
"subject" : "subject",
"certCreated" : "2024-03-27T12:52:46.992014508-04:00"
} ]Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
Query parameters
| Parameter | Description |
|---|---|
|
A filter list where each element is represented by a key, an operator, and a value (<key><operator><value>), for example "batchId=5". The key can take the following values: |
|
Page number. If not set the value by default is 0 |
|
Size. If not set the value by default is 500 |
|
sort field ASC/DESC: |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Certificate ID |
|
|
Certificate name |
|
|
Organization ID |
|
|
Batch ID |
|
|
Batch Source |
|
|
Certificate serial number |
|
|
Certificate status |
|
|
Certificate common name |
|
|
Certificate subject |
|
|
Certificate creation date |
Revoke Certificates
Revoke certificates using 'reasonCode'.
User must be authenticated as admin or user.
HTTP request
PATCH /api/v2/ecosystems/1/organizations/1/certificates HTTP/1.1
Content-Type: application/json;charset=utf-8
Content-Length: 160
Host: localhost:8080
{
"certIds" : [ "78c9576e-cea9-45c7-ab71-dcae01364c97", "f59823e7-e836-41ef-838e-204415086522", "dc6ebd96-c6f6-481c-a035-7aa3c04bf6e2" ],
"reasonCode" : 0
}HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
certIds |
Array |
Certificate IDs |
false |
|
reasonCode |
Number |
Must be at least 0. |
Must be code from RFC 5280. If not set the value by default is 0 |
false |
Create Single Certificate Preview
View certificate preview.
User must be authenticated as admin or user.
HTTP request
POST /api/v2/ecosystems/1/organizations/1/certificates-preview HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 180
Host: localhost:8080
{
"profileId" : 1,
"p12pwd" : "123",
"validate" : true,
"variables" : [ {
"id" : 1,
"name" : "certParameterInfoName",
"value" : "certParameterInfoValue"
} ]
}HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 88
{
"requestValid" : false,
"errors" : [ ],
"orgVars" : { },
"requestVars" : { }
}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
profileId |
Number |
Must be positive or zero |
Profile Id |
false |
p12pwd |
String |
p 12 Password |
false |
|
validate |
Boolean |
Validate |
true |
|
variables[] |
Array |
CertRequestInfo> |
CertRequestInfo |
false |
variables[].id |
Number |
id |
false |
|
variables[].name |
String |
name |
false |
|
variables[].value |
String |
value |
false |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
checks if request is valid |
|
|
Organization Vars |
|
|
Request Vars |
|
|
returns list of errors |
Create Single Certificate
Create single certificate.
User must be authenticated as user or admin.
HTTP request
POST /api/v2/ecosystems/1/organizations/1/certificates HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 180
Host: localhost:8080
{
"profileId" : 1,
"p12pwd" : "123",
"validate" : null,
"variables" : [ {
"id" : 1,
"name" : "certParameterInfoName",
"value" : "certParameterInfoValue"
} ]
}HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: /api/v2/ecosystems/1/organizations/1/certificates/00000000-0000-0001-0000-000000000001Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
profileId |
Number |
Must be positive or zero |
Profile Id |
false |
p12pwd |
String |
p 12 Password |
false |
|
variables[] |
Array |
CertRequestInfo> |
CertRequestInfo |
false |
variables[].id |
Number |
id |
false |
|
variables[].name |
String |
name |
false |
|
variables[].value |
String |
value |
false |
Create Single Certificate Preview From File
Create Single Certificate Preview From File.
User must be authenticated as admin or user.
HTTP request
POST /api/v2/ecosystems/1/organizations/1/certificates-preview/file HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: localhost:8080
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=files; filename=testCsr.pem
Content-Type: application/json
org/springframework/restdocs/files/testCsr.pem
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=certRequest; filename=certRequest
Content-Type: application/json
{"profileId":1591,"variables":[{"id":0,"name":"name", "value":"Value"}],"validate":true}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 88
{
"requestValid" : false,
"errors" : [ ],
"orgVars" : { },
"requestVars" : { }
}Request part-certrequest-body
{"profileId":1591,"variables":[{"id":0,"name":"name", "value":"Value"}],"validate":true}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
Request part-certrequest-fields
| Path | Type | Description |
|---|---|---|
|
|
Profile Id |
|
|
Validate |
|
|
CertParameterInfo |
|
|
id |
|
|
name |
|
|
value |
Request part-files-body
org/springframework/restdocs/files/testCsr.pemResponse fields
| Path | Type | Description |
|---|---|---|
|
|
checks if request is valid |
|
|
Organization Vars |
|
|
Request Vars |
|
|
returns list of errors |
Create Single Certificate From File
Create Single Certificate From File.
User must be authenticated as admin or user.
HTTP request
POST /api/v2/ecosystems/1/organizations/1/certificates/file HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: localhost:8080
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=files; filename=testCsr.pem
Content-Type: application/json
org/springframework/restdocs/files/testCsr.pem
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=certRequest; filename=certRequest
Content-Type: application/json
{"profileId":1591,"variables":[{"id":0,"name":"name", "value":"Value"}]}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: /api/v2/ecosystems/1/organizations/1/certificates/ecdbd9c2-bc10-4a82-a4cd-81ad43889dd6Request part-certrequest-body
{"profileId":1591,"variables":[{"id":0,"name":"name", "value":"Value"}]}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
Request part-certrequest-fields
| Path | Type | Description |
|---|---|---|
|
|
Profile Id |
|
|
CertParameterInfo |
|
|
id |
|
|
name |
|
|
value |
Request part-files-body
org/springframework/restdocs/files/testCsr.pemGet Single Certificate Info By Certificate Id
View certificate information by certificate id.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/ecosystems/1/organizations/1/certificates/eb4b3e71-5b61-4ce5-888e-d52bd9a753a1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 340
{
"id" : "dac817d0-37e9-420c-ba37-11928f17d64a",
"orgId" : 1,
"batchId" : 1,
"batchSource" : 0,
"name" : "Single Cert Name",
"certSerial" : "Single Cert Serial",
"status" : "READY_FOR_DOWNLOAD",
"commonName" : "Single Cert Common Name",
"subject" : "Single Cert Subject",
"certCreated" : "2024-02-27T12:52:46.8453919Z"
}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
|
Certificate Id |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Certificate Id |
|
|
Organization Id |
|
|
Batch Id |
|
|
Batch Source |
|
|
Certificate Name |
|
|
Certificate Serial Number |
|
|
Status. Could be one of the value: |
|
|
Single Cert Common Name |
|
|
Single Cert Subject |
|
|
Creation Time |
Download Single Certificate
Download Single Certificate.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/ecosystems/1/organizations/1/certificates/08b738b2-95f1-44f1-b773-b2f5ba2f220e/download?include=PEM&include=DER&include=P7B HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
|
Certificate Id |
Query parameters
| Parameter | Description |
|---|---|
|
List of certificate formats that will be included in to result (only for certificates created from CSR file). Can take following values: |
More details about filtering rules see in this chapter
In case of error, system will respond with error status and message. See Error Responses for more details
Create Batch Preview
View batch preview.
User must be authenticated as admin or user.
HTTP request
POST /api/v2/ecosystems/1/organizations/1/batch-preview HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 908
Host: localhost:8080
{
"profileId" : 1,
"batchType" : "SINGLE",
"batchName" : "Batch Name",
"variables" : [ {
"id" : 0,
"name" : "AeroMACSDeviceClass",
"generatorSetting" : {
"generatorType" : "MAC",
"startValue" : "0",
"step" : 2
},
"value" : "Aircraft"
}, {
"id" : 1,
"name" : "Duration",
"generatorSetting" : {
"generatorType" : "MAC",
"startValue" : "0",
"step" : 2
},
"value" : "y1"
}, {
"id" : 1,
"name" : "CommonName",
"generatorSetting" : {
"generatorType" : "MAC",
"startValue" : "0",
"step" : 2
},
"value" : "00:00:00:00:00:00"
}, {
"id" : 1,
"name" : "ou",
"generatorSetting" : {
"generatorType" : "MAC",
"startValue" : "0",
"step" : 2
},
"value" : "reflects the end customer"
} ],
"batchSize" : 1,
"p12pwd" : "p12Password",
"validate" : true
}HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 134
{
"name" : "batch_name",
"requestValid" : false,
"errors" : [ ],
"batchVars" : { },
"orgVars" : { },
"requestVars" : [ ]
}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
profileId |
Number |
Must be positive or zero |
Profile Id |
false |
batchType |
String |
Batch Type. Could be one of the value: |
false |
|
batchName |
String |
Must not be empty. |
Batch name |
false |
variables[] |
Array |
BatchRequestVariableInfo> |
BatchRequestVariableInfo |
false |
variables[].name |
String |
name |
false |
|
variables[].generatorSetting |
Object |
GeneratorSettingInfo |
GeneratorSettingInfo |
false |
variables[].value |
String |
value |
false |
|
batchSize |
Number |
Must be at least 1. |
Batch size |
false |
p12pwd |
String |
p 12 Password |
false |
|
validate |
Boolean |
Validate |
false |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
name |
|
|
Batch Vars |
|
|
Organization Vars |
|
|
Request Vars |
|
|
checks if request is valid |
|
|
returns list of errors |
Get batch count
View batch count.
User must be authenticated as admin or user.
HTTP request
HEAD /api/v2/ecosystems/1/organizations/1/batches?filter=status%3DBROKEN HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Access-Control-Expose-Headers: X-Total-Count, X-Offset
x-total-count: 1Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
Query parameters
| Parameter | Description |
|---|---|
|
A filter list where each element is represented by a key, an operator, and a value (<key><operator><value>), for example "id=5". The key can take the following values: |
Response headers
| Name | Description |
|---|---|
|
Total count. |
Get batches
View list available organization batches.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/ecosystems/1/organizations/1/batches?page=1&size=1&sort=id,asc&filter=id%3D5 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 313
[ {
"id" : 1,
"orgId" : 1,
"profileId" : 1,
"creationDate" : "2024-03-27T12:52:46.397941784Z",
"size" : 1,
"status" : "READY_FOR_DOWNLOAD",
"batchName" : "batch_name",
"downloadedAt" : null,
"downloadable" : true,
"userId" : 2,
"numOfSuccess" : 1,
"numOfFailures" : 0,
"batchSrc" : 2
} ]Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
Query parameters
| Parameter | Description |
|---|---|
|
Page number. If not set the value by default is 0 |
|
Size. If not set the value by default is 300 |
|
sort field ASC/DESC: |
|
A filter list where each element is represented by a key, an operator, and a value (<key><operator><value>), for example "id=5". The key can take the following values: |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Batch ID |
|
|
Organization Id |
|
|
profile Id |
|
|
Creation Date |
|
|
Size |
|
|
Status. Takes following states: |
|
|
Batch Name |
|
|
Downloaded At |
|
|
Is Batch Downloadable |
|
|
User ID |
|
|
Number of success |
|
|
Number of failures |
|
|
batchSrc |
Create batch
Create new batch.
User must be authenticated as admin or user.
HTTP request
POST /api/v2/ecosystems/1/organizations/1/batches HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 600
Host: localhost:8080
{
"profileId" : 1,
"batchType" : "SINGLE",
"batchName" : "Batch Name",
"variables" : [ {
"id" : 0,
"name" : "AeroMACSDeviceClass",
"generatorSetting" : null,
"value" : "Aircraft"
}, {
"id" : 1,
"name" : "Duration",
"generatorSetting" : null,
"value" : "y1"
}, {
"id" : 1,
"name" : "CommonName",
"generatorSetting" : null,
"value" : "00:00:00:00:00:00"
}, {
"id" : 1,
"name" : "ou",
"generatorSetting" : null,
"value" : "reflects the end customer"
} ],
"batchSize" : 1,
"p12pwd" : "p12Password",
"validate" : true
}HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: /api/v2/ecosystems/1/organizations/1/batches/1Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
profileId |
Number |
Must be positive or zero |
Profile Id |
false |
batchType |
String |
Batch Type. Could be one of the value: |
false |
|
batchName |
String |
Must not be empty. |
Batch name |
false |
variables[] |
Array |
BatchRequestVariableInfo> |
BatchRequestVariableInfo |
false |
variables[].id |
Number |
id |
false |
|
variables[].name |
String |
name |
false |
|
variables[].generatorSetting |
Null |
GeneratorSettingInfo |
GeneratorSettingInfo |
false |
variables[].value |
String |
value |
false |
|
batchSize |
Number |
Must be at least 1. |
Batch size |
false |
p12pwd |
String |
p 12 Password |
false |
Create Batch From File
Create Batch From File.
User must be authenticated as admin or user.
HTTP request
POST /api/v2/ecosystems/1/organizations/1/batches/file HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: localhost:8080
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=files; filename=testCsv.csv
Content-Type: application/csv
org/springframework/restdocs/files/testCsv.csv
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=batchRequest; filename=csrBatchRequest
Content-Type: application/json
{"batchName":"commonName.csv","profileId":1591,"batchType":"CSV","p12pwd":"123","variables":[{"id":0,"name":"name", "generatorSetting": {"generatorType":"HEXDECIMAL","startValue":0,"step":2}, "value":"Value"}],"batchSize":1000,"validate":true}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: /api/v2/ecosystems/1/organizations/1/batches/1Request part-batchrequest-body
{"batchName":"commonName.csv","profileId":1591,"batchType":"CSV","p12pwd":"123","variables":[{"id":0,"name":"name", "generatorSetting": {"generatorType":"HEXDECIMAL","startValue":0,"step":2}, "value":"Value"}],"batchSize":1000,"validate":true}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
Request part-batchrequest-fields
| Path | Type | Description |
|---|---|---|
|
|
Profile Id |
|
|
Batch Type. Could be one of the value: |
|
|
Batch name |
|
|
BatchRequestVariableInfo |
|
|
id |
|
|
name |
|
|
GeneratorSettingInfo |
|
|
GeneratorTypeInfo. Could be one of the value: |
|
|
Start Value For Steps |
|
|
step |
|
|
value |
|
|
Batch size |
|
|
p 12 Password |
|
|
Validate |
Request part-files-body
org/springframework/restdocs/files/testCsv.csvGet batch info by batch id
View batch information by batch id.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/ecosystems/1/organizations/1/batches/1?page=1&size=1&sort=id,asc HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 579
{
"id" : 1,
"orgId" : 1,
"profileId" : 1,
"creationDate" : "2024-03-27T12:52:46.975742229Z",
"size" : 1,
"status" : "READY_FOR_DOWNLOAD",
"batchName" : "batch_name",
"downloadedAt" : null,
"downloadable" : true,
"userId" : 2,
"numOfSuccess" : 1,
"numOfFailures" : 0,
"batchSrc" : 2,
"profileName" : "AeroMACsTest02",
"caName" : "IotMgrAdmin:IotMgrCa",
"rejectReason" : "",
"userIdRejectedBy" : 0,
"userLoginRejectedBy" : "qwerty",
"userLogin" : "qwerty",
"properties" : {
"AeroMACSDeviceClass" : "Aircraft",
"Duration" : "y1"
}
}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
|
Batch Id |
Query parameters
| Parameter | Description |
|---|---|
|
page number |
|
size |
|
sort field ASC/DESC: |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Batch Id |
|
|
Organization Id |
|
|
profile Id |
|
|
Creation Date |
|
|
Duration |
|
|
Size |
|
|
Status. Could be one of the value: |
|
|
Batch Name |
|
|
Downloaded At |
|
|
Is Batch Downloadable |
|
|
User ID |
|
|
Number of success |
|
|
Number of failures |
|
|
batchSrc |
|
|
profileName |
|
|
caName |
|
|
rejectReason |
|
|
userIdRejectedBy |
|
|
userLoginRejectedBy |
|
|
userLogin |
|
|
Properties map |
|
|
AeroMACSDeviceClass |
Reject Batch
Allows you to reject a batch by batch id and specify the reason for rejection.
User must be authenticated as admin or user.
HTTP request
PATCH /api/v2/ecosystems/1/organizations/1/batches/1 HTTP/1.1
Content-Type: text/html;charset=utf-8
Accept: text/html
Content-Length: 15
Host: localhost:8080
"Reject reason"HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
|
Batch Id |
Request body
"Reject reason"Text value is used as request body payload.
Update Batch Status
Allows to REJECT or REVOKE a batch by batchId.
User must be authenticated as admin or user.
HTTP request
PATCH /api/v2/ecosystems/1/organizations/1/batches/1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 87
Host: localhost:8080
{
"reasonCode" : 1,
"message" : "Revoke reason",
"batchUpdateAction" : "REVOKE"
}HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
|
Batch Id |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
message |
String |
Size must be between 0 and 512 inclusive |
Reason of the reject batch must be included in the message field. |
false |
reasonCode |
Number |
Must be at least 0. |
Must be code from RFC 5280. If not set the value by default is 0 |
false |
batchUpdateAction |
String |
Must be chosen any of the options: |
false |
Download Zip
Download batch zip.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/ecosystems/1/organizations/1/batches/1/zip?include=PEM&include=DER&include=P7B HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
|
Batch Id |
Query parameters
| Parameter | Description |
|---|---|
|
List of certificate formats that will be included in the zip (only for batches created from CSR file). Can take following values: |
More details about batch statuses see in this chapter
More details about filtering rules see in this chapter
In case of error, system will respond with error status and message. See Error Responses for more details
User API
Search users
Search for available users.
User must be authenticated as admin.
HTTP request
GET /api/v2/users?filter=id%3D5&page=1&size=10&sort=id,asc&excludeNonAssignable=false HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 171
[ {
"id" : 1,
"accountId" : 1,
"firstName" : "John",
"lastName" : "Smith",
"phone" : "+38 800 555 3535",
"email" : "js@domain.dom",
"login" : "johnsmith"
} ]Query parameters
| Parameter | Description |
|---|---|
|
filter: a filter list where each element is represented by a key, an operator, and a value (<key><operator><value>), for example "id=5". The key can take the following values: id, ecosystemId, organizationId, login, firstName, lastName, phone, email, userRole, searchLine. searchLine - is a generic word that will be used in the 'like' filter, applied to user first name, last name, login and email through the logical operator 'OR'. |
|
Page number. If not set the value by default is 0 |
|
Size. If not set the value by default is 300 |
|
sort field ASC/DESC: login, email, firstName, lastName |
|
If true, ecoadmins from the current ecosystem and users from the current organization are EXCLUDED. The default value is "false" |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
User ID |
|
|
Login |
|
|
First Name |
|
|
Last Name |
|
|
Phone |
|
|
|
|
|
Account ID |
Count the number of users
Count the number of users suitable for search request.
You can check if the username already exist providing only "ecosystemId" and "login" parameters.
User must be authenticated as admin or user.
HTTP request
HEAD /api/v2/users?filter=searchLine%3DSmith&excludeNonAssignable=false HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Access-Control-Expose-Headers: X-Total-Count, X-Offset
x-total-count: 1Query parameters
| Parameter | Description |
|---|---|
|
filter: a filter list where each element is represented by a key, an operator, and a value (<key><operator><value>), for example "id=5". The key can take the following values: id, ecosystemId, organizationId, login, firstName, lastName, phone, email, userRole, searchLine.searchLine - is a generic word that will be used in the 'like' filter, applied to user first name, last name, login and email through the logical operator 'OR' |
|
If true, ecoadmins from the current ecosystem and users from the current organization are EXCLUDED. The default value is "false" |
Response headers
| Name | Description |
|---|---|
|
Total count. |
Create user
Create new user.
User must be authenticated as admin.
HTTP request
POST /api/v2/users HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 216
Host: localhost:8080
{
"ecosystemId" : 1,
"firstName" : "John",
"lastName" : "Smith",
"phone" : "+38 050 492 4110",
"email" : "johnsmith@example.com",
"credentials" : {
"login" : "admin",
"password" : "Admin123"
}
}HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: /api/v2/users/1Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
ecosystemId |
Number |
Eco system ID |
false |
|
firstName |
String |
Must match the regular expression: Must not be empty |
User first name |
false |
lastName |
String |
Must match the regular expression: Must not be empty |
User last name |
false |
phone |
String |
Must match the regular expression: Must not be empty. |
User phone |
false |
String |
Must be a well-formed email address. |
false |
||
credentials |
Object |
User credentials |
false |
|
credentials.login |
String |
Login must be unique for whole system. Must not be empty. |
User login |
false |
credentials.password |
String |
Min length of the password is managed on ecosystem level. Must not be empty. |
User password. Other password policy requirements (like min length) managed on ecosystem level. |
false |
Remove user
Remove user by user id.
User must be authenticated as admin.
HTTP request
DELETE /api/v2/users/1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
User ID |
Get user detail
Get user by user id.
User must be authenticated as admin.
HTTP request
GET /api/v2/users/1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 526
{
"id" : 1,
"accountId" : 1,
"firstName" : "John",
"lastName" : "Smith",
"phone" : "+38 800 555 3535",
"email" : "js@domain.dom",
"login" : "login1",
"userPrivileges" : [ {
"id" : 1,
"userRole" : "USER",
"ecosystemId" : 0,
"organizationId" : 1,
"accessibleProfiles" : [ 1 ]
} ],
"lastLoggedDate" : "2024-03-27T12:52:50.213026645-04:00",
"lastLoggedRemoteHost" : null,
"inviteSent" : "2024-03-27T12:52:50.213029885-04:00",
"lastPassChange" : "2024-03-27T12:52:50.213032755-04:00"
}Path parameters
| Parameter | Description |
|---|---|
|
User ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Last logged date |
|
|
Last logged remote host |
|
|
Lash password change |
|
|
Account ID |
|
|
User ID |
|
|
First Name |
|
|
Last Name |
|
|
Phone |
|
|
|
|
|
Login |
|
|
User Privileges List<UserRoleDetailInfo> |
|
|
UserRoleDetailInfo.id |
|
|
UserRoleDetailInfo.UserRoles (USER, ORG_ADMIN, ECO_ADMIN; |
|
|
UserRoleDetailInfo.Ecosystem ID |
|
|
UserRoleDetailInfo.Organization ID |
|
|
UserRoleDetailInfo.Set<Long> Accessible Profiles |
|
|
Time when user got last invite to get 2FA certificate |
Get System Access Perm
Get System Access Perm.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/users/1/system-access-perm HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 204
[ {
"userId" : 0,
"ecoSystemId" : 0,
"ecoSystemName" : "ecosystem",
"hasAdministrativePermissionInEcosystem" : false,
"manageableOrganizations" : [ ],
"userAccessInsideOrganizations" : [ ]
} ]Path parameters
| Parameter | Description |
|---|---|
|
User ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
User ID |
|
|
Eco System Id |
|
|
Eco System Name |
|
|
Is User Has Administrative Permission In Ecosystem |
|
|
List Manageable Organizations Ids |
|
|
List User Access Inside Organizations Ids |
Update user
Updates user details by user id.
User must be authenticated as admin.
email in this request can be changed for user with USER or absent role.
HTTP request
PUT /api/v2/users/1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 112
Host: localhost:8080
{
"firstName" : "John",
"lastName" : "Smith",
"phone" : "+38 800 555 3536",
"email" : "jsm@domain.dom"
}HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
User ID |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
firstName |
String |
Must match the regular expression: Must not be empty |
First Name |
false |
lastName |
String |
Must match the regular expression: Must not be empty |
Last Name |
false |
phone |
String |
Must match the regular expression: Must not be empty. |
Phone |
false |
String |
Must be a well-formed email address. |
false |
Update User Profiles
Update user profiles parameters.
User must be authenticated as admin.
HTTP request
PUT /api/v2/users/1/organizations/1/profiles HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 8
Host: localhost:8080
[ 1, 2 ]HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
User ID |
|
Organization ID |
Update credentials
Update password.
User must be authenticated as admin.
HTTP request
PUT /api/v2/users/1/credentials HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 104
Host: localhost:8080
{
"currentPassword" : "test334!",
"newPassword" : "QW12esdf",
"repeatedNewPassword" : "QW12esdf"
}HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 4
truePath parameters
| Parameter | Description |
|---|---|
|
User ID |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
currentPassword |
String |
Min length of the password is managed on ecosystem level. Must not be empty |
Current Password. Other password policy requirements (like min length) managed on ecosystem level. |
false |
newPassword |
String |
Min length of the password is managed on ecosystem level. Must not be empty |
New Password |
false |
repeatedNewPassword |
String |
Min length of the password is managed on ecosystem level. Must not be empty |
Repeated New Password. Other password policy requirements (like min length) managed on ecosystem level. |
false |
Update user role
Update role for specific user.
User must be authenticated as admin.
HTTP request
POST /api/v2/users/1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 70
Host: localhost:8080
{
"userRole" : "USER",
"ecosystemId" : 1,
"organizationId" : 1
}HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
User ID |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
userRole |
Varies |
User Role |
false |
|
ecosystemId |
Number |
Ecosystem ID |
false |
|
organizationId |
Number |
Organization ID |
false |
Update email
Updates user email.
Changes the email only for currently logged user.
After changing email user receives notification letter.
User must be authenticated as admin or user.
HTTP request
PUT /api/v2/users/1/email HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 64
Host: localhost:8080
{
"email" : "j.smith@example.com",
"password" : "QW12esdf"
}HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
User ID |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
String |
Must be a well-formed email address. |
false |
||
password |
String |
Must match the regular expression: Must not be empty |
Password |
false |
Remove User Role
Remove user role.
User must be authenticated as admin.
HTTP request
DELETE /api/v2/users/1/organizations/1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
User ID |
|
Organization ID |
Get User Organizations
View a list of all organization where user assigned to.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/users/1/organizations?ecosystemId=1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 80
[ {
"id" : 1,
"organizationName" : "Test org name",
"ecosystemId" : 10
} ]Path parameters
| Parameter | Description |
|---|---|
|
User ID |
Query parameters
| Parameter | Description |
|---|---|
|
EcoSystem ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Organization Id |
|
|
Organization Name |
|
|
Ecosystem Id |
Search user certificates
Searching for user available certificates.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/users/1/certificates HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 112
[ {
"id" : "123456",
"serialNumber" : "654321",
"creationDate" : "2024-03-27T12:52:50.314727067-04:00"
} ]Path parameters
| Parameter | Description |
|---|---|
|
User ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Certificate Id |
|
|
Serial number |
|
|
Creation date |
Invite User
Inviting user to create auth certificate.
User must be authenticated as admin or user.
HTTP request
POST /api/v2/users/1/certificates HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
User ID |
Revoke user certificates
Revoking user specific certificate.
User must be authenticated as admin or user.
HTTP request
DELETE /api/v2/users/1/certificates/1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
User ID |
|
Certificate ID |
More details about filtering rules see in this chapter
In case of error, system will respond with error status and message. See Error Responses for more details
Statistic API
Get profile management items
Searching for available profile management items for specific organization.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/statistics/ecosystems/1/organizations/1/profiles HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 290
[ {
"templateId" : 1,
"profileId" : 1,
"caId" : "Fp3tPE9-v_OKWB-AAAAAA==",
"caName" : "IotMgrAdmin:IotMgrCa",
"enabled" : true,
"balance" : 10,
"usedBalance" : 5,
"availableBalance" : 5,
"revokedNumber" : 0,
"profileName" : "Profile_name",
"templateChanged" : true
} ]Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Template ID |
|
|
Profile ID |
|
|
CA ID |
|
|
CA Name |
|
|
Enabled/Disabled |
|
|
Balance |
|
|
Used balance |
|
|
Available balance |
|
|
Revoked Certificates Number in profile |
|
|
Profile name |
|
|
Template Changed |
Get profile management item
Searching for specific profile management item for specific organization.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/statistics/ecosystems/1/organizations/1/profiles/1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 286
{
"templateId" : 1,
"profileId" : 1,
"caId" : "Fp3tPE9-v_OKWB-AAAAAA==",
"caName" : "IotMgrAdmin:IotMgrCa",
"enabled" : true,
"balance" : 10,
"usedBalance" : 5,
"availableBalance" : 5,
"revokedNumber" : 0,
"profileName" : "Profile_name",
"templateChanged" : true
}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Profile ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Template ID |
|
|
Profile ID |
|
|
CA ID |
|
|
CA name |
|
|
Enabled/Disabled |
|
|
Balance |
|
|
Used balance |
|
|
Available balance |
|
|
Revoked Certificates Number in profile |
|
|
Profile name |
|
|
Template Changed |
Get template statistics
Statistics for all templates.
User must be authenticated as admin.
HTTP request
GET /api/v2/statistics/ecosystems/1/template-statistics HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 179
[ {
"templateId" : 7,
"templateName" : "3mSmartRapClientCertProfileWBARegAuth_#73",
"balance" : 10000,
"used" : 250,
"revokedNumber" : 0,
"availableBalance" : 9750
} ]Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Template Id |
|
|
Template Name |
|
|
Balance of template |
|
|
Balance of used certificates |
|
|
Revoked number of certificates |
|
|
Available number of certificates |
Get ordered and issued certificates report
Statistic for Ordered/Issued certificates.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/statistics/ecosystems/1/organizations/1/profiles/1/ordered-issued-report HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 35
{
"ordered" : 5,
"issued" : 5
}Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Profile ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
Number of ordered certificates |
|
|
Number of issued certificates |
Get batch audit log for batch
Searching for batch audit logs for specific batch id.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/statistics/ecosystems/1/organizations/1/batches/1/batch-audit-log HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 274
[ {
"id" : "b01e39e5-5ea8-4a36-a387-bc2dcfffd3c6",
"auditLogAction" : "DOWNLOAD",
"batchId" : 1,
"orgId" : 1,
"userId" : 1,
"userLogin" : "user_login",
"ts" : "2024-03-27T12:52:48.044818972-04:00",
"status" : "READY_FOR_DOWNLOAD",
"message" : "message"
} ]Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Batch ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
ID |
|
|
Audit log action |
|
|
Batch ID |
|
|
Organization ID |
|
|
User ID |
|
|
User login |
|
|
Time stamp |
|
|
Batch status |
|
|
Message |
Get certificate audit log for batch
Searching for certificate audit logs for specific batch id.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/statistics/ecosystems/1/organizations/1/batches/1/cert-audit-log?filter=status%3DBROKEN&page=1&size=1&sort=id,asc HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 293
[ {
"id" : "cd8c5987-e9d3-4e40-a902-e203917b4ea9",
"batchId" : 1,
"certId" : "99e28f40-9227-4f13-a1e5-7502cc66e7d9",
"time" : "2024-03-27T12:52:48.10181581-04:00",
"status" : "ABORTED",
"message" : "message",
"name" : "name",
"serialNumber" : "123456",
"certIndexPos" : 1
} ]Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Batch ID |
Query parameters
| Parameter | Description |
|---|---|
|
filter: a filter list where each element is represented by a key, an operator, and a value (<key><operator><value>), for example "id=5". The key can take the following values: certIndexPos, name, serialNumber, time, status, showSuccessfulOnly, showFailedOnly.status takes following states: PENDING, READY_FOR_DOWNLOAD, REMOVED_AFTER_EXPIRATION, REVOKED, REJECTED, ABORTED, BROKEN, READY_FOR_DOWNLOAD_ISSUED_PARTIALLY |
|
Page number. If not set the value by default is 0 |
|
Size. If not set the value by default is 300 |
|
sort field ASC/DESC: certIndexPos, name, serialNumber, time, action, status |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
ID |
|
|
Batch ID |
|
|
Certificate ID |
|
|
Time |
|
|
Serial number |
|
|
Name |
|
|
Batch status |
|
|
Message |
|
|
Certificate index position |
Get certificate audit log by certificate ID
Searching for certificate audit logs by certificate id.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/statistics/ecosystems/1/organizations/1/certificates/43bcc0be-0612-4bfb-aaf1-0039e8ea5b71/cert-audit-log HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 294
[ {
"id" : "2cf082a9-6df9-431e-8ce2-47d77bcbce81",
"batchId" : 1,
"certId" : "c56b45f6-480e-4e23-8ad1-474c053143bf",
"time" : "2024-03-27T12:52:48.116341078-04:00",
"status" : "ABORTED",
"message" : "message",
"name" : "name",
"serialNumber" : "123456",
"certIndexPos" : 1
} ]Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Certificate ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
ID |
|
|
Batch ID |
|
|
Certificate ID |
|
|
Time |
|
|
Serial number |
|
|
Name |
|
|
Certificate status |
|
|
Message |
|
|
Certificate index position |
Get certificate audit log count for batch
Get certificate audit logs count.
User must be authenticated as admin or user.
HTTP request
HEAD /api/v2/statistics/ecosystems/1/organizations/1/batches/1/cert-audit-log?filter=batchId%3D1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Access-Control-Expose-Headers: X-Total-Count, X-Offset
x-total-count: 1Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
|
Organization ID |
|
Batch ID |
Query parameters
| Parameter | Description |
|---|---|
|
filter: a filter list where each element is represented by a key, an operator, and a value (<key><operator><value>), for example "batchId=5". The key can take the following values: batchId, name, commonName, nameOrSubject, certSerial, certCreated, status. nameOrSubject - is a generic word that will be used in the 'like' filter, applied to 'name' and 'commonName' fields through the logical operator 'OR'. |
Response headers
| Name | Description |
|---|---|
|
Total count. |
Get all certificate audit reports
Searching for all available certificate audit reports within specific ecosystem id.
User must be authenticated as admin.
HTTP request
GET /api/v2/statistics/ecosystems/1/cert-audit-report HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Range: 0-1/1
Content-Type: application/json
Content-Length: 244
[ {
"reportId" : 1,
"requestedBy" : "ADMIN",
"requestedDate" : "2024-03-27T12:52:48.076866636-04:00",
"reportDescription" : "Organization Name: 3M Company Date From: 2019-01-01 Date From: 2020-03-24 ",
"reportStatus" : "GENERATED"
} ]Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem ID |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
reportId |
|
|
Login of the user who created the report |
|
|
Report creation date |
|
|
Report Description (Organization Name, Date From, Date To) |
|
|
Report Status (UNDEFINED, GENERATED, ERROR) |
Download Log Report
Downloads log report in CSV.
User must be authenticated as admin.
HTTP request
GET /api/v2/statistics/ecosystems/1/cert-audit-report/1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Report Id |
Create certificate audit log report
User must be authenticated as admin.
HTTP request
POST /api/v2/statistics/ecosystems/1/cert-audit-report HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 235
Host: localhost:8080
{
"startDate" : "2024-03-26T12:52:48.13712587-04:00",
"endDate" : "2024-03-27T12:52:48.137172421-04:00",
"dateCertStatusFilter" : "By creation date",
"templateId" : 1,
"organizationId" : 1,
"certificateStatus" : "REVOKED"
}HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Range: 0-0/0Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
Request fields
| Path | Type | Constraints | Description | Optional |
|---|---|---|---|---|
templateId |
Number |
Template Id |
true |
|
organizationId |
Number |
Organization Id |
true |
|
certificateStatus |
String |
Filter by CREATED, READY_FOR_DOWNLOAD(ISSUED), REVOKED or BROKEN certificate statuses. |
true |
|
dateCertStatusFilter |
String |
Must not be null |
Has 3 parameters: 'By creation date', 'By issuing date', 'By revocation date'. Mandatory parameter. Used as filter that searches certificates by chosen parameter. 'By creation date': searches certificates by creation time. 'By issuing date': searches certificates by issued time. 'By revocation date': searches certificates by revoked time. |
false |
startDate |
Varies |
Must not be null |
Start Date |
false |
endDate |
Varies |
Must not be null |
End Date |
false |
Remove certificate audit report
Remove specific certificate audit report.
User must be authenticated as admin.
HTTP request
DELETE /api/v2/statistics/ecosystems/1/cert-audit-report/1 HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Range: 0-1/1Path parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Report Id |
Download Certificate Audit Log
Download log in CSV.
User must be authenticated as admin or user.
HTTP request
GET /api/v2/statistics/ecosystems/1/organizations/1/batches/1/cert-audit-log-csv?filter=status%3DBROKEN&sort=id,asc HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8080HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-HeadersPath parameters
| Parameter | Description |
|---|---|
|
Ecosystem Id |
|
Organization Id |
|
Batch Id |
Query parameters
| Parameter | Description |
|---|---|
|
filter: a filter list where each element is represented by a key, an operator, and a value (<key><operator><value>), for example "id=5". The key can take the following values: certIndexPos, name, serialNumber, time, status, showSuccessfulOnly, showFailedOnly.status takes following states: PENDING, READY_FOR_DOWNLOAD, REMOVED_AFTER_EXPIRATION, REVOKED, REJECTED, ABORTED, BROKEN, READY_FOR_DOWNLOAD_ISSUED_PARTIALLY |
|
sort field ASC/DESC: certIndexPos, name, serialNumber, time, action, status |
More details about batch statuses see in this chapter
More details about filtering rules see in this chapter
In case of error, system will respond with error status and message. See Error Responses for more details
Error Responses
Error Response Structure.
As result of an error, system returns HTTP response containing HTTP error code
and result body with the following structure (JSON):
| Parameter | Type | Description |
|---|---|---|
status |
HttpStatus |
HTTP Response Status Code |
code |
ErrorCode |
IOT Error code |
message |
String |
General error message about nature of error |
details |
String |
Detailed information about error represented as list |
Example with Validation Error
{
"status": 400,
"code": "1000",
"message": "Validation Error.",
"details": [
"Password must contain a digit! (Value: 'y')",
"First Name must be only 1-50 letters without spaces (Value: 'Test1')",
"Phone minimal length must be 5 numbers! (Value: 'e')",
"Telephone number should contain only +-()0123456789 symbols
and have 5 - 20 characters. (Value: 'e')",
"Phone minimum length must be 5 numbers! (Value: 'e')",
"Wrong format! Please use one of the following:
+XX XX XXX XXXX, (XXX) XXX XXXX, +XX-XXXX-XXXXXX. (Value: 'e')",
"Last Name must be only 1-50 letters without spaces (Value: 'Test1')",
"Password minimal length must be 4 symbols!"
]
}
Filtering Rules
Supported Operations:
| Syntax | Description |
|---|---|
= |
Equals |
!= |
Not Equals |
? |
Like |
!? |
Not Like |
> |
Greater Than |
>= |
Greater Or Equals |
< |
Less Than |
⇐ |
Less Or Equals |
filter=or |
Or |
*Multiple filters are joined with AND by default.
Batch Statuses
| Status | Description |
|---|---|
Pending Creation |
Pending when all certs from batch will be created |
Pending Issue |
Pending when all certs from batch will be issued |
Batch Issued Partly |
Part of certificates are created and issued successfully and ready to be downloaded, but some certificates have not been generated because of some errors |
Ready For Download |
All certificates are generated and ready to be downloaded |
Zip removed after expiration |
Batch was removed after expiration lifetime |
Processing Reject |
System rejecting all certificates from batch |
Processing Revoke |
System revoking all certificates from batch |
Rejected |
Batch was rejected for reasons given by the user. This is available only if batch has status Ready For Download or Batch Issued Partly and before downloading the batch. The balance will be restored |
Revoked |
Batch was revoked for reasons given by the user. This is available if batch has status Zip removed after expiration or Ready For Download or Batch Issued Partly, but only after downloading batch. The balance will not be restored |
Broken |
Batch was broken due to some errors (like "Batch type is UNDEFINED" or "Batch size does not correspond actual number of entries in file" or "Batch type is not supported") |