Contents

Documentation

Management API

This document will describe the main technical characteristics to integrate the PassByME management service.

Overview

The Management API lets developers integrate with PassByME’s platform at a low level. The API has methods for creating, retrieving, updating, and deleting the core objects in the PassByME system.

In addition, developers can write applications that programmatically read or update their account settings; and retrieve reports and other information.

 

First Step

You'll need a PassByME account, and a certificate to access the management API from your application. Sign Up using the web-based administration interface, and register a new organization if you haven’t registered before. If you have already registered into the PassByME service, please log in as an administrator with your previously created credential data (username/password) and your PassByME ready mobile device.

To access the PassByME service URL you should have a valid authentication certificate and key (PFX file). The PassByME management service URL can be used only with a valid authentication certificate, which you can acquire after the registration process is finished successfully.

Add management key to your account:

Log into your administration page.
Select the ‘Access Keys’ menu.
Click on Add access key button.
Select Management Key option as Access key type.
Choose a name for your new management key (Access key name).
Optionally you can use your own PKCS# 10 request. This way the PassByME system will not store your private key.
Click on Save button.

Now the newly created management key should be listed inside the Management Certificates section.

Download PFX:

Log into your administration page.
Select the ‘Access Keys’ menu.
Add a management key to your account if you do not have any (see above).
Click on the lock icon belonging to any of the organization's management certificates (section Management Certificates).
Choose ‘Download PFX’ option.

If during key generation no external PKCS# 10 request were used, this certificate have a software-based private key inside the downloaded PFX. Otherwise the downloaded PFX contains only the public key, and the proper usage of the private key is the user's responsibility. The PFX file is protected with a passphrase, which can be printed on the administration website. Note that the certificate can be downloaded in PEM format as well.

Important! The authentication certificate identifies the registered ORGANIZATION in the PassByME service.

This API is available for FREE up to 10 users!

Check out PassByME REST API client libraries and sample source code for Java, C#, Node.js and PHP.

 

Search Criteria as Input Parameters

Some methods’ parameters must be provided in the URL query string as URL-encoded. Some of the query parameters are the same as DataTables table plug-in jQuery uses for easier integration purposes. The list of the query parameter keys:

Query parameter keyDescriptionMandatory, Default Value
lengthThe maximum number of records to be returned.optional
Default: 1000
startOffset. The number of records to skip from the result.optional
Default: 0
search[value]The value to be used for filtering records. If this value is a substring of the userId, applicationId, applicationName or progress the record will be included. The value null or empty string means no filtering.optional
columns[<n>][data]The name of JSON key used as the <n>th column data source.optional
order[<n>][column]Column to which ordering should be applied. This is an index reference to the columns array (columns[<n>][data]) of information that is also submitted to the server.optional
order[<n>][columnName]Column to which ordering should be applied. This is the name of the column’s data source.optional
order[<n>][dir]Ordering direction for this column. It will be asc or desc to indicate ascending ordering or descending ordering, respectively.optional
Default: asc

User

Create User

Creates a new PassByME user with a specific user identifier. Note: this function does not automatically create a new enrollment for the newly created user. To create new enrollments for users see: Create Enrollment.
post
/rest/users

Parameters

json
in request body.
FieldMandatoryDescription
userIdRequired

The PassByME ID of a user.

emailOptional

Email address of the user.

fullNameRequired

Full name of the user.

phoneNumberOptional

The phone number of the user.

Request example

/rest/users
{"userId":"john.doe@passbyme.com","email":"john.doe@passbyme.com","fullName":"John Doe","phoneNumber":"12345678"}

Success response format

FieldTypeDescription
oidString

The globally unique identifier of the user.

identityString

The full identifier of the user which is unique inside the organization.

shortIdentityString

The short alias of the identifier of the user.

fullNameString

The full name of the user.

emailString (optional)

The registered email address of the user.

phoneNumberString (optional)

The registered phone number of the user.

disabledBoolean

True if the user is disabled, false otherwise. Disabled users receive no authentication message. Other messaging are still available.

Success response

HTTP/1.0 200 OK
{"oid":"1.3.6.1.4.1.21528.3.3.3.1588","identity":"1.3.6.1.4.1.21528.3.3.3.1588","shortIdentity":"3.3.1588","fullName":"John Doe","email":"john.doe@passbyme.com","phoneNumber":"1212345678","disabled":false}
 

Get Users

Returns the list of users. For query parameters see Search Criteria as Input Parameters.
get
/rest/users

Parameters

None.

Success response format

FieldTypeDescription
recordsFilteredString

Number of records match the search criteria.

recordsTotalString

The number of total records.

dataArray

A JSON encoded array that contains the list of users.

FieldTypeDescription
oidString

The globally unique identifier of the user.

identityString

The full identifier of the user which is unique inside the organization.

shortIdentityString

The short alias of the identifier of the user.

fullNameString

The full name of the user.

emailString (optional)

The registered email address of the user.

phoneNumberString (optional)

The registered phone number of the user.

disabledBoolean

True if the user is disabled, false otherwise. Disabled users receive no authentication message. Other messaging are still available.

Success response

HTTP/1.0 200 OK
{"recordsFiltered":"1","recordsTotal":"1","data":[{"oid":"1.3.6.1.4.1.21528.3.3.3.1588","identity":"1.3.6.1.4.1.21528.3.3.3.1588","shortIdentity":"3.3.1588","fullName":"John Doe","email":"john.doe@passbyme.com","phoneNumber":"1212345678","disabled":false}]}
 

Get the Number of Users

Retrieve the number of users in the account.
get
/rest/users/count

Parameters

None.

Success response format

FieldTypeDescription
String

The number of users in JSON string format.

Success response

HTTP/1.0 200 OK
"12"
 

Get User by OID

Find the user with the given OID.
get
/rest/users/:id

Parameters

query string
FieldMandatoryDescription
idRequired

A globally unique identifier of a user or the full identifier of the user which is unique inside the organization.

Request example

/rest/users/1.3.6.1.4.1.21528.3.3.3.1588

Success response format

FieldTypeDescription
oidString

The globally unique identifier of the user.

identityString

The full identifier of the user which is unique inside the organization.

shortIdentityString

The short alias of the identifier of the user.

fullNameString

The full name of the user.

emailString (optional)

The registered email address of the user.

phoneNumberString (optional)

The registered phone number of the user.

disabledBoolean

True if the user is disabled, false otherwise. Disabled users receive no authentication message. Other messaging are still available.

Success response

HTTP/1.0 200 OK
{"oid":"1.3.6.1.4.1.21528.3.3.3.1588","identity":"1.3.6.1.4.1.21528.3.3.3.1588","shortIdentity":"3.3.1588","fullName":"John Doe","email":"john.doe@passbyme.com","phoneNumber":"1212345678","disabled":false}
 

Delete User

Deletes the user with the given OID from the system.
delete
/rest/users/:oid

Parameters

query string
FieldMandatoryDescription
oidRequired

A globally unique identifier of a user.

Request example

/rest/users/1.3.6.1.4.1.21528.3.3.3.1588

Success response format

FieldTypeDescription
String

The global unique identifier of the deleted user.

Success response

HTTP/1.0 200 OK
"1.3.6.1.4.1.21528.3.3.3.1588"
 

Modify User

Change user's data with the given OID.
put
/rest/users/:oid

Parameters

query string
FieldMandatoryDescription
oidRequired

A globally unique identifier of a user.

json
in request body.
FieldMandatoryDescription
emailOptional

The new email address of the user.

fullNameRequired

The new full name of the user.

phoneNumberOptional

The new phone number of the user.

disabledOptional

True if the user is disabled, false otherwise. Disabled users receive no authentication message. Other messaging are still available.

The preferred way to change user's data is to get the original first then do the modifications on it and finally send the modified JSON object as a part of the request body.

Request example

/rest/users/1.3.6.1.4.1.21528.3.3.3.1588
{"email":"john.doe@passbyme.com","fullName":"John Doe","phoneNumber":"12345678","disabled":false,"disabled":false}

Success response format

FieldTypeDescription
String

The global unique identifier of the modified user.

Success response

HTTP/1.0 200 OK
"1.3.6.1.4.1.21528.3.3.3.1588"
 

Create User Enrollment

Create a new enrollment for the given user.
post
/rest/users/:oid/enrollments

Parameters

query string
FieldMandatoryDescription
oidRequired

A globally unique identifier of a user.

Request example

/rest/users/1.3.6.1.4.1.21528.3.3.3.1588/enrollments

Success response format

FieldTypeDescription
enrollmentIdString

The unique Id of the enrollment.

expireDateString (ISO 8601)

The expiry date of the current enrollment.

stateString (ACTIVE, USED or EXPIRED)

State of the enrollment. For a new enrollment is should be always ACTIVE.

sentBoolean

Determines whether the enrollment was sent to the user’s email.

deviceConfigUrlString (URL)

An URL pointing to the device configuration. The URL is sent to the user’s phone in a QR code during device enrollment.

Success response

HTTP/1.0 200 OK
{"enrollmentId":"9V45pdVWTIREkXWa","expireDate":"2018-02-26T15:54:22.696Z","state":"ACTIVE","sent":false,"deviceConfigUrl":"https://passbyme.com/deviceConfig/1.3.6.1.4.1.21528.3.3.3.1588/URPvk4EuqVJSUfB3?expireDate/u003d2015-04-23T10%3A24%3A22.893Z"}
 

List Enrollments of User

Returns the active enrollments of the given user.
get
deprecated
/rest/users/:oid/enrollments

Parameters

query string
FieldMandatoryDescription
oidRequired

A globally unique identifier of a user.

Request example

/rest/users/1.3.6.1.4.1.21528.3.3.3.1588/enrollments

Success response format

FieldTypeDescription
dataArray

A JSON encoded array that contains the list of enrollments of the given user.

FieldTypeDescription
enrollmentIdString

The unique Id of the enrollment.

expireDateString (ISO 8601)

The expiry date of the current enrollment.

stateString (ACTIVE, USED or EXPIRED)

State of the enrollment.

sentBoolean

Determines whether the enrollment was sent to the user’s email.

deviceConfigUrlString (URL)

An URL pointing to the device configuration. The URL is sent to the user’s phone in a QR code during device enrollment.

Success response

HTTP/1.0 200 OK
{"data":[{"enrollmentId":"9V45pdVWTIREkXWa","expireDate":"2018-02-26T15:54:22.696Z","state":"ACTIVE","sent":false,"deviceConfigUrl":"https://passbyme.com/deviceConfig/1.3.6.1.4.1.21528.3.3.3.1588/URPvk4EuqVJSUfB3?expireDate\\u003d2015-04-23T10%3A24%3A22.893Z"}]}
 

List Active Enrollments of User

Returns the active enrollments of the given user.
get
/rest/users/:oid/enrollments/active

Parameters

query string
FieldMandatoryDescription
oidRequired

A globally unique identifier of a user.

Request example

/rest/users/1.3.6.1.4.1.21528.3.3.3.1588/enrollments/active

Success response format

FieldTypeDescription
dataArray

A JSON encoded array that contains the list of active enrollments of the given user.

FieldTypeDescription
enrollmentIdString

The unique Id of the enrollment.

expireDateString (ISO 8601)

The expiry date of the current enrollment.

stateString (ACTIVE, USED or EXPIRED)

State of the enrollment.

sentBoolean

Determines whether the enrollment was sent to the user’s email.

deviceConfigUrlString (URL)

An URL pointing to the device configuration. The URL is sent to the user’s phone in a QR code during device enrollment.

Success response

HTTP/1.0 200 OK
{"data":[{"enrollmentId":"9V45pdVWTIREkXWa","expireDate":"2018-02-26T15:54:22.696Z","state":"ACTIVE","sent":false,"deviceConfigUrl":"https://passbyme.com/deviceConfig/1.3.6.1.4.1.21528.3.3.3.1588/URPvk4EuqVJSUfB3?expireDate\\u003d2015-04-23T10%3A24%3A22.893Z"}]}
 

Details of User's Enrollment

Returns the details of the given user's given enrollment.
get
/rest/users/:oid/enrollments/:enrollmentId

Parameters

query string
FieldMandatoryDescription
oidRequired

A globally unique identifier of a user.

enrollmentIdRequired

A globally unique identifier of a user enrollment.

Request example

/rest/users/1.3.6.1.4.1.21528.3.3.3.1588/enrollments/ovgfqEwrAF

Success response format

FieldTypeDescription
enrollmentIdString

The unique Id of the enrollment.

expireDateString (ISO 8601)

The expiry date of the current enrollment.

stateString (ACTIVE, USED or EXPIRED)

State of the enrollment.

sentBoolean

Determines whether the enrollment was sent to the user’s email.

deviceConfigUrlString (URL)

An URL pointing to the device configuration. The URL is sent to the user’s phone in a QR code during device enrollment.

deviceIdString

The deviceId of the corresponding device, if any. Set only for USED enrollments.

Success response

HTTP/1.0 200 OK
{"enrollmentId":"ovgfqEwrAF","expireDate":"2018-02-26T15:54:22.696Z","state":"ACTIVE","sent":false,"deviceConfigUrl":"https://passbyme.com/deviceConfig/1.3.6.1.4.1.21528.3.3.3.1588/URPvk4EuqVJSUfB3?expireDate/u003d2015-04-23T10%3A24%3A22.893Z","deviceId":null}
 

Download Enrollment

Downloads the enrollment of a given user in pdf format.
get
/download/users/:oid/enrollments/:enrollmentId/pdf

Parameters

query string
FieldMandatoryDescription
oidRequired

A globally unique identifier of a user.

enrollmentIdRequired

The ID of the enrollment.

Request example

/download/users/1.3.6.1.4.1.21528.3.3.3.1588/enrollments/Ot5pL2mkRVO6LYav/pdf

Success response format

FieldTypeDescription
PDF

The downloadable enrollment sheet in pdf format.

Success response

HTTP/1.0 200 OK
"<PDF bytes>"
 

Send Enrollment in Email

Send the specified enrollment pdf document to the owner user via e-mail (if configured). The user's e-mail address is used as recipient.
post
/rest/users/:oid/enrollments/:enrollmentId/pdfviaemail

Parameters

query string
FieldMandatoryDescription
oidRequired

A globally unique identifier of a user.

enrollmentIdRequired

The ID of the enrollment.

Request example

/rest/users/1.3.6.1.4.1.21528.3.3.3.1588/enrollments/Ot5pL2mkRVO6LYav/pdfviaemail

Success response format

FieldTypeDescription
String

The ID of the enrollment.

Success response

HTTP/1.0 200 OK
"Ot5pL2mkRVO6LYav"
 

Delete Enrollment

Deletes the specified enrollment of the given user.
delete
/rest/users/:oid/enrollments/:enrollmentId

Parameters

query string
FieldMandatoryDescription
oidRequired

A globally unique identifier of a user.

enrollmentIdRequired

The ID of the enrollment.

Request example

/rest/users/1.3.6.1.4.1.21528.3.3.3.1588/enrollments/Ot5pL2mkRVO6LYav

Success response format

FieldTypeDescription
String

The ID of the enrollment.

Success response

HTTP/1.0 200 OK
"Ot5pL2mkRVO6LYav"
 

Create LoginName

Adds a new userId (alias) for the specified PassByME user. Returns the new userId
post
/rest/loginNames/:oid

Parameters

query string
FieldMandatoryDescription
oidRequired

The oid (globally unique identifier) or the user who receives the alias.

json
in request body.
FieldMandatoryDescription
userIdRequired

The new PassByME ID of the user.

Request example

/rest/loginNames/1.3.6.1.4.1.21528.3.3.3.1588
{"userId":"alias01"}

Success response format

FieldTypeDescription
userIdString

The new PassByME ID the user received.

oidString

The globally unique identifier of a user.

Success response

HTTP/1.0 200 OK
{"userId":"alias01","oid":"1.3.6.1.4.1.21528.3.3.3.112"}
 

Get LoginNames of User

Returns the list of aliases of the given user.
get
/rest/loginNames/:oid

Parameters

query string
FieldMandatoryDescription
oidRequired

The globally unique identifier of a user.

Request example

/rest/loginNames/1.3.6.1.4.1.21528.3.3.3.1588

Success response format

FieldTypeDescription
dataArray

A JSON encoded array that contains the list of aliases.

FieldTypeDescription
userIdString

The LoginName of the user.

oidString

The globally unique identifier of a user.

Success response

HTTP/1.0 200 OK
{"data":[{"userId":"alias01","oid":"1.3.6.1.4.1.21528.3.3.3.112"}]}
 

Get LoginName by userId

Find the alias with the given userId.
get
/rest/loginNames?userId=:userId

Parameters

query string
FieldMandatoryDescription
userIdRequired

One of the LoginNames of the user.

Request example

/rest/loginNames?userId=user01

Success response format

FieldTypeDescription
userIdString

The LoginName of the user.

oidString

The globally unique identifier of the user.

Success response

HTTP/1.0 200 OK
{"userId":"alias01","oid":"1.3.6.1.4.1.21528.3.3.3.112"}
 

Delete LoginName

Deletes the specified LoginName of the given user.
delete
/rest/loginNames?oid=:oid&userId=:userId

Parameters

query string
FieldMandatoryDescription
oidRequired

The globally unique identifier of the user.

userIdRequired

The LoginName of the user we want to delete.

Request example

/rest/loginNames?oid=1.3.6.1.4.1.21528.3.3.3.112&userId=alias01

Success response format

FieldTypeDescription
String

The deleted LoginName of the user.

Success response

HTTP/1.0 200 OK
"alias01"
 

Generate User Report

Generates a detailed report of the organization's users with their current status and last activities. The generated report is stored and returned from cache for three hours.
get
/rest/reports/user

Parameters

Request example

/rest/reports/user

Success response format

FieldTypeDescription
organizationIdString

The identifier of the organization.

reportIdString

The identifier of the report type.

createdAtObject

The time when the report was generated.

FieldTypeDescription
secondsinteger

The number of seconds from the epoch of 1970-01-01T00:00:00Z

nanosinteger

The number of nanoseconds, later along the time-line, from the seconds field. This is always positive, and never exceeds 999,999,999

reportDataString

The CSV report in BASE64 encoded form.

Success response

HTTP/1.0 200 OK
{"organizationId":"1.3.6.1.4.1.21528.3.3.2.1.28459","reportId":"user","createdAt":[{"seconds":"1539775916","nanos":"291000000"}],"reportData":"nVsbCBuY...sLCx0cnVlDQo="}
 

Download User Report as CSV

Returns the generated/cached user report as application/csv. Generates a detailed report of the organization's users with their current status and last activities. The generated report is stored and returned from cache for three hours.
get
/download/reports/user

Parameters

Request example

/download/reports/user

Success response format

FieldTypeDescription
application/csv

The downloadable report.

Success response

HTTP/1.0 200 OK
"<bytes>"
 

Admin

Get Admins

Returns the list of administrators.
get
/rest/administrators

Parameters

None.

Success response format

FieldTypeDescription
dataArray

A JSON encoded array that contains the list of administrators.

FieldTypeDescription
userIdString

The registered e-mail address of the administrator.

fullNameString

The full name of the administrator.

phoneNumberString

The phone number of the administrator.

oidstring

The oid of the administrator.

failedLoginAttemptsint

The failed login attempts number.

Success response

HTTP/1.0 200 OK
{"data":[{"userId":"admin@passbyme.com","fullName":"Admin","phoneNumber":"12345678","oid":"1.2.3.4.5.6.7","failedLoginAttempts":"1"}]}
 

Create Invitations

This command create an invitation code. With invitations you can create new organizations.
post
/rest/invitations

Parameters

None.

Success response format

FieldTypeDescription
expiryDateString (ISO 8601)

End date of the of the invitation codes validity.

codeString

The invitation code.

Success response

HTTP/1.0 200 OK
{"expiryDate":"2017-02-26T03:51:38.340Z","code":"sSnj6R9NP8SyANbm"}
 

Get Invitations

Returns the list of active invitations.
get
/rest/invitations

Parameters

None.

Success response format

FieldTypeDescription
dataArray

A JSON encoded array that contains the list of invitations.

FieldTypeDescription
expiryDateString (ISO 8601)

End date of the of the invitation codes validity.

codeString

The invitation code.

Success response

HTTP/1.0 200 OK
{"data":[{"expiryDate":"2017-02-26T03:51:38.340Z","code":"sSnj6R9NP8SyANbm"}]}
 

Delete Invitation

Deletes an invitation code.
delete
/rest/invitations/:invitationCode

Parameters

query string
FieldMandatoryDescription
invitationCodeRequired

The invitation code to be deleted

Request example

/rest/invitations/sSnj6R9NP8SyANbm

Success response

HTTP/1.0 200 OK
 

Create Enrollment

Create a new enrollment for the given administrator.
post
/rest/administrators/:userId/enrollments

Parameters

query string
FieldMandatoryDescription
userIdRequired

The userId (registered e-mail address) of the administrator.

Request example

/rest/administrators/admin01@passbyme.com/enrollments

Success response format

FieldTypeDescription
enrollmentIdString

The unique Id of the enrollment.

expireDateString (ISO 8601)

The expiry date of the current enrollment.

stateString (ACTIVE, USED or EXPIRED)

State of the enrollment. For a new enrollment it should be always ACTIVE.

sentBoolean

Determines whether the enrollment was sent to the user’s email.

deviceConfigUrlString (URL)

An URL pointing to the device configuration. The URL is sent to the user’s phone in a QR code during device enrollment.

Success response

HTTP/1.0 200 OK
{"enrollmentId":"9V45pdVWTIREkXWa","expireDate":"2018-02-26T15:54:22.696Z","state":"ACTIVE","sent":false,"deviceConfigUrl":"https://passbyme.com/deviceConfig/1.3.6.1.4.1.21528.3.3.3.1588/URPvk4EuqVJSUfB3?expireDate\\u003d2015-04-23T10%3A24%3A22.893Z"}
 

List Active Enrollments of Administrator

Returns the active enrollments of the given administrator
get
deprecated
/rest/administrators/:userId/enrollments

Parameters

query string
FieldMandatoryDescription
userIdRequired

The userID (registered e-mail address) of the administrator

Request example

/rest/administrators/admin01@gmail.com/enrollments

Success response format

FieldTypeDescription
dataArray

A JSON encoded array of EnrollmentData objects that contains the list of enrollments.

FieldTypeDescription
enrollmentIdString

The unique Id of the enrollment.

expireDateString (ISO 8601)

The expiry date of the current enrollment.

stateString (ACTIVE, USED or EXPIRED)

State of the enrollment.

sentBoolean

Determines whether the enrollment was sent to the user’s email.

deviceConfigUrlString (URL)

An URL pointing to the device configuration. The URL is sent to the user’s phone in a QR code during device enrollment.

Success response

HTTP/1.0 200 OK
{"data":[{"enrollmentId":"9V45pdVWTIREkXWa","expireDate":"2018-02-26T15:54:22.696Z","state":"ACTIVE","sent":false,"deviceConfigUrl":"https://passbyme.com/deviceConfig/1.3.6.1.4.1.21528.3.3.3.1588/URPvk4EuqVJSUfB3?expireDate\\u003d2015-04-23T10%3A24%3A22.893Z"}]}
 

List Active Enrollments of Administrator

Returns the active enrollments of the given administrator
get
/rest/administrators/:userId/enrollments/active

Parameters

query string
FieldMandatoryDescription
userIdRequired

The userID (registered e-mail address) of the administrator

Request example

/rest/administrators/admin01@gmail.com/enrollments/active

Success response format

FieldTypeDescription
dataArray

A JSON encoded array of EnrollmentData objects that contains the list of enrollments.

FieldTypeDescription
enrollmentIdString

The unique Id of the enrollment.

expireDateString (ISO 8601)

The expiry date of the current enrollment.

stateString (ACTIVE, USED or EXPIRED)

State of the enrollment.

sentBoolean

Determines whether the enrollment was sent to the user’s email.

deviceConfigUrlString (URL)

An URL pointing to the device configuration. The URL is sent to the user’s phone in a QR code during device enrollment.

Success response

HTTP/1.0 200 OK
{"data":[{"enrollmentId":"9V45pdVWTIREkXWa","expireDate":"2018-02-26T15:54:22.696Z","state":"ACTIVE","sent":false,"deviceConfigUrl":"https://passbyme.com/deviceConfig/1.3.6.1.4.1.21528.3.3.3.1588/URPvk4EuqVJSUfB3?expireDate\\u003d2015-04-23T10%3A24%3A22.893Z"}]}
 

Details of Admin's Enrollment

Returns the details of the given admin's given enrollment.
get
/rest/administrators/:userId/enrollments/:enrollmentId

Parameters

query string
FieldMandatoryDescription
userIdRequired

The userID (registered e-mail address) of the administrator

enrollmentIdRequired

A globally unique identifier of a user enrollment.

Request example

/rest/administrators/admin01@gmail.com/enrollments/ovgfqEwrAF

Success response format

FieldTypeDescription
enrollmentIdString

The unique Id of the enrollment.

expireDateString (ISO 8601)

The expiry date of the current enrollment.

stateString (ACTIVE, USED or EXPIRED)

State of the enrollment.

sentBoolean

Determines whether the enrollment was sent to the admin’s email.

deviceConfigUrlString (URL)

An URL pointing to the device configuration. The URL is sent to the admin’s phone in a QR code during device enrollment.

deviceIdString

The deviceId of the corresponding device, if any. Set only for USED enrollments.

Success response

HTTP/1.0 200 OK
{"enrollmentId":"ovgfqEwrAF","expireDate":"2018-02-26T15:54:22.696Z","state":"ACTIVE","sent":false,"deviceConfigUrl":"https://passbyme.com/deviceConfig/1.3.6.1.4.1.21528.3.3.3.1588/URPvk4EuqVJSUfB3?expireDate/u003d2015-04-23T10%3A24%3A22.893Z","deviceId":null}
 

Download Enrollment

Downloads the enrollment in PDF format.
get
/download/administrators/:userId/enrollments/:enrollmentId/pdf

Parameters

query string
FieldMandatoryDescription
userIdRequired

The registered e-mail address of the administrator.

enrollmentIdRequired

The unique Id of the enrollment.

Request example

/download/administrators/admin01@passbyme.com/enrollments/Ot5pL2mkRVO6LYav/pdf

Success response format

FieldTypeDescription
PDF

The downloadable enrollment sheet in pdf format.

Success response

HTTP/1.0 200 OK
"<PDF bytes>"
 

Send Enrollment

Send the specified enrollment pdf document to the owner administrator via e-mail. The administrator's userId is used as recipient.
post
/rest/administrators/:userId/enrollments/:enrollmentId/pdfviaemail

Parameters

query string
FieldMandatoryDescription
userIdRequired

The userId (registered e-mail address) of the administrator.

enrollmentIdRequired

The unique Id of the enrollment.

Request example

/rest/administrators/admin01@passbyme.com/enrollments/Ot5pL2mkRVO6LYav/pdfviaemail

Success response format

FieldTypeDescription
String

The unique Id of the sent enrollment.

Success response

HTTP/1.0 200 OK
"Ot5pL2mkRVO6LYav"
 

Delete Enrollment

Deletes the given administrator's enrollment specified by the enrollmentId.
delete
/rest/administrators/:userId/enrollments/:enrollmentId

Parameters

query string
FieldMandatoryDescription
userIdRequired

The userId (registered e-mail address) of the administrator.

enrollmentIdRequired

The unique Id of the enrollment.

Request example

/rest/administrators/admin01@passbyme.com/enrollments/Ot5pL2mkRVO6LYav

Success response format

FieldTypeDescription
String

The unique Id of the sent enrollment.

Success response

HTTP/1.0 200 OK
"Ot5pL2mkRVO6LYav"
 

Role of Admin

Returns the current role of the given admin in the organization.
get
/rest/administrators/:userId/role

Parameters

query string
FieldMandatoryDescription
userIdRequired

The userID (registered e-mail address) of the administrator

Request example

/rest/administrators/admin01@gmail.com/role

Success response format

FieldTypeDescription
idString

The unique Id of the current role.

Success response

HTTP/1.0 200 OK
{"id":"UserManager"}
 

Modify Role

Change the current role of the given admin in the organization. One can query the list of available roles using the proper API call (see below in section Organization).
put
/rest/administrators/:userId/role

Parameters

query string
FieldMandatoryDescription
userIdRequired

The userID (registered e-mail address) of the administrator

json
in request body.
FieldMandatoryDescription
idRequired

The new roleID to be set for the administrator

Request example

/rest/administrators/admin01@gmail.com/role
{"id":"Full"}

Success response format

FieldTypeDescription
String

The UserID of the modified administrator.

Success response

HTTP/1.0 200 OK
"admin01@gmail.com"
 

Delete Admin

Deletes the admin with the given userId from the system.
delete
/rest/administrators/:userId

Parameters

query string
FieldMandatoryDescription
userIdRequired

The globally unique identifier of the admin.

Request example

/rest/administrators/admin@example.com

Success response format

FieldTypeDescription
String

The global unique identifier of the deleted admin.

Success response

HTTP/1.0 200 OK
"admin@example.com"
 

Application

Create Application

Creates a new application registration. The new certificate can be based on either automatic key-generation or a CSR. Returns the identifier of the new application. A certificate is created for the application as well.
post
/rest/applications

Parameters

json
in request body.
FieldMandatoryDescription
nameRequired

Name of the application.

pkcs10RequestOptional

The CSR represented as a Base64 encoded PKCS#10. Key-pair is generated automatically if omitted.

Request example

/rest/applications
{"name":"application01","pkcs10Request":"-----BEGIN CERTIFICATE REQUEST-----[…]-----END CERTIFICATE REQUEST-----"}

Success response format

FieldTypeDescription
idString

The unique Id of the application.

nameString

The name of the application.

notAfterString (ISO 8601)

Expiration datetime of the application.

hasCustomIconBoolean

True, if the system stores a custom icon for the application

certificatesArray

A list of certificates

FieldTypeDescription
sha256thumbprintString

The certificate identifier.

notAfterString (ISO 8601)

The validity ending date of the certificate.

notBeforeString (ISO 8601)

The validity starting date of the certificate.

hasPrivateKeyBoolean

True, if the system stores the certificate’s private key.

statusString ("VALID" or "REVOKED")

The status of the certificate.

Success response

HTTP/1.0 200 OK
{"id":"1.3.6.1.4.1.21528.3.3.2.1.12117.2.12158","name":"application01","notAfter":"2023-01-29T13:18:27Z","hasCustomIcon":false,"certificates":[{"sha256thumbprint":"98pRTmtQazMwSvDOKQtaeZeigzqtmMP/=","notAfter":"2024-08-07T11:33:20Z","notBefore":"2019-08-09T11:33:20Z","hasPrivateKey":false,"status":"VALID"}]}
 

Get Applications

Returns the list of applications under your organization.
get
/rest/applications

Parameters

None.

Success response format

FieldTypeDescription
dataArray

A JSON encoded array that contains the list of applications.

FieldTypeDescription
idString

The unique Id of the application.

nameString

The name of the application.

notAfterString (ISO 8601)

Expiration datetime of the application.

hasCustomIconBoolean

True, if the system stores a custom icon for the application

certificatesArray

A list of certificates

{
sha256thumbprint : String
notAfter : String (ISO 8601)
notBefore : String (ISO 8601)
hasPrivateKey : Boolean
status : String ("VALID" or "REVOKED")
}

Success response

HTTP/1.0 200 OK
{"data":[{"id":"1.3.6.1.4.1.21528.3.3.2.1.12117.2.12158","name":"application01","notAfter":"2023-01-29T13:18:27Z","hasCustomIcon":false,"certificates":[{"sha256thumbprint":"98pRTmtQazMwSvDOKQtaeZeigzqtmMP/=","notAfter":"2024-08-07T11:33:20Z","notBefore":"2019-08-09T11:33:20Z","hasPrivateKey":false,"status":"VALID"}]}]}
 

Get Application by ID

Find the application with the given applicationId.
get
/rest/applications/:applicationId

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The id of the application.

Request example

/rest/applications/1.3.6.1.4.1.21528.3.3.3.1588

Success response format

FieldTypeDescription
dataArray

A JSON encoded array that contains the application data.

FieldTypeDescription
idString

The unique Id of the application.

nameString

The name of the application.

notAfterString (ISO 8601)

Expiration datetime of the application.

hasCustomIconBoolean

True, if the system stores a custom icon for the application

certificatesArray

A list of certificates

{
sha256thumbprint : String
notAfter : String (ISO 8601)
notBefore : String (ISO 8601)
hasPrivateKey : Boolean
status : String ("VALID" or "REVOKED")
}

Success response

HTTP/1.0 200 OK
{"data":[{"id":"1.3.6.1.4.1.21528.3.3.2.1.12117.2.12158","name":"application01","notAfter":"2023-01-29T13:18:27Z","hasCustomIcon":false,"certificates":[{"sha256thumbprint":"98pRTmtQazMwSvDOKQtaeZeigzqtmMP/=","notAfter":"2024-08-07T11:33:20Z","notBefore":"2019-08-09T11:33:20Z","hasPrivateKey":false,"status":"VALID"}]}]}
 

Delete Application

Remove the given application. The corresponding certificates will be revoked and deleted, and any running maintenance of the application will be closed, and all future maintenance of the application will be deleted.
delete
/rest/applications/:applicationId

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The id of the application.

Request example

/rest/applications/1.3.6.1.4.1.21528.3.3.2.100

Success response format

FieldTypeDescription
String

The id of the deleted application.

Success response

HTTP/1.0 200 OK
"1.3.6.1.4.1.21528.3.3.2.100"
 

Create new certificate for the application

Create new certificate for the application automatically. The old application certificate and private key remains to be valid.
post
/rest/applications/:applicationId/certificates

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The applicationId of the application to be modified.

Request example

/rest/applications/1.3.6.1.4.1.21528.3.3.2.100.1.1/certificates

Success response format

FieldTypeDescription
sha256thumbprintString

The certificate identifier.

notAfterString (ISO 8601)

The validity ending date of the certificate.

notBeforeString (ISO 8601)

The validity starting date of the certificate.

hasPrivateKeyBoolean

True, if the system stores the certificate’s private key.

statusString ("VALID" or "REVOKED")

The status of the certificate.

Success response

HTTP/1.0 200 OK
{"sha256thumbprint":"98pRTmtQazMwSvDOKQtaeZeigzqtmMP/=","notAfter":"2024-08-07T11:33:20Z","notBefore":"2019-08-09T11:33:20Z","hasPrivateKey":false,"status":"VALID"}
 

Create new certificate for the application using External CER

Create new certificate for the application using the given CSR. The old certificates remains to be valid. The system will not have the new certificate's private key.
post
/rest/applications/:applicationId/certificates

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The applicationId of the application to be modified.

json
in request body.
FieldMandatoryDescription
pkcs10RequestRequired

The CSR represented as a Base64 encoded PKCS#10.

Request example

/rest/applications/1.3.6.1.4.1.21528.3.3.2.100.1.1/certificates
{"pkcs10Request":"-----BEGIN CERTIFICATE REQUEST-----[…]-----END CERTIFICATE REQUEST-----"}

Success response format

FieldTypeDescription
sha256thumbprintString

The certificate identifier.

notAfterString (ISO 8601)

The validity ending date of the certificate.

notBeforeString (ISO 8601)

The validity starting date of the certificate.

hasPrivateKeyBoolean

True, if the system stores the certificate’s private key.

statusString ("VALID" or "REVOKED")

The status of the certificate.

Success response

HTTP/1.0 200 OK
{"sha256thumbprint":"98pRTmtQazMwSvDOKQtaeZeigzqtmMP/=","notAfter":"2024-08-07T11:33:20Z","notBefore":"2019-08-09T11:33:20Z","hasPrivateKey":false,"status":"VALID"}
 

Get certificate list of an application

Retrieve the certificate list of the application.
get
/rest/applications/:applicationId/certificates

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The id of the application.

Request example

/rest/applications/1.3.6.1.4.1.21528.3.3.3.1588/certificates

Success response format

FieldTypeDescription
dataArray

A JSON encoded array that contains the application's certificates.

FieldTypeDescription
sha256thumbprintString

The certificate identifier.

notAfterString (ISO 8601)

The validity ending date of the certificate.

notBeforeString (ISO 8601)

The validity starting date of the certificate.

hasPrivateKeyBoolean

True, if the system stores the certificate’s private key.

statusString ("VALID" or "REVOKED")

The status of the certificate.

Success response

HTTP/1.0 200 OK
{"data":[{"sha256thumbprint":"98pRTmtQazMwSvDOKQtaeZeigzqtmMP/=","notAfter":"2024-08-07T11:33:20Z","notBefore":"2019-08-09T11:33:20Z","hasPrivateKey":false,"status":"VALID"}]}
 

Get details of an application's certificate

Retrieve the details of an application's certificate.
get
/rest/applications/:applicationId/certificates/:certificateId

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The id of the application.

certificateIdRequired

The base64 url encoded sha256thumbprint of the certificate

Request example

/rest/applications/1.3.6.1.4.1.21528.3.3.3.1588/certificates/OThwUlRtdFFhek13U3ZET0tRdGFlWmVpZ3pxdG1NUC9JeXB

Success response format

FieldTypeDescription
sha256thumbprintString

The certificate identifier.

notAfterString (ISO 8601)

The validity ending date of the certificate.

notBeforeString (ISO 8601)

The validity starting date of the certificate.

hasPrivateKeyBoolean

True, if the system stores the certificate’s private key.

statusString ("VALID" or "REVOKED")

The status of the certificate.

Success response

HTTP/1.0 200 OK
{"sha256thumbprint":"98pRTmtQazMwSvDOKQtaeZeigzqtmMP/=","notAfter":"2024-08-07T11:33:20Z","notBefore":"2019-08-09T11:33:20Z","hasPrivateKey":false,"status":"VALID"}
 

Revoke application certificate

Revoke the selected certificate of the application.
post
/rest/applications/:applicationId/certificates/:certificateId/revoke

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The id of the application.

certificateIdRequired

The base64 url encoded sha256thumbprint of the certificate

Request example

/rest/applications/1.3.6.1.4.1.21528.3.3.3.1588/certificates/OThwUlRtdFFhek13U3ZET0tRdGFlWmVpZ3pxdG1NUC9JeXB/revoke

Success response format

FieldTypeDescription
String

The id (sha256thumbprint) of the revoked certificate.

Success response

HTTP/1.0 200 OK
"98pRTmtQazMwSvDOKQtaeZeigzqtmMP/="
 

Download Application's Certificate in PFX Format

Downloads the application's certificate key store data in PFX format.
get
/download/applications/:applicationId/certificates/:certificateId/pfx

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The id of the application.

certificateIdRequired

The base64 url encoded sha256thumbprint of the certificate.

Request example

/download/applications/1.3.6.1.4.1.21528.3.3.2.100.1.1/certificates/OThwUlRtdFFhek13U3ZET0tRdGFlWmVpZ3pxdG1NUC9JeXB/pfx

Success response format

FieldTypeDescription
PFX

The PFX containing the certificate chain of the application referred. The PFX may contain the private key as well (if the certificate was not created using externally generated CSR)

Success response

HTTP/1.0 200 OK
"<PFX bytes>"
 

Download Password for Application's Certificate PFX

Downloads the password corresponding to the PFX of the selected application certificate.
get
/rest/applications/:applicationId/certificates/:certificateId/pfxpass

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The id of the application.

certificateIdRequired

The base64 url encoded sha256thumbprint of the certificate

Request example

/rest/applications/1.3.6.1.4.1.21528.3.3.2.100.1.1/certificates/OThwUlRtdFFhek13U3ZET0tRdGFlWmVpZ3pxdG1NUC9JeXB/pfxpass

Success response format

FieldTypeDescription
String

The password corresponding to the certificate's PFX in plain text.

Success response

HTTP/1.0 200 OK
"123456"
 

Download Application's Certificate in PEM Format

Downloads the application’s certificate in PEM format.
get
/download/applications/:applicationId/certificates/:certificateId/pem

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The id of the application.

certificateIdRequired

The base64 url encoded sha256thumbprint of the certificate

Request example

/download/applications/1.3.6.1.4.1.21528.3.3.2.100.1.1/certificates/OThwUlRtdFFhek13U3ZET0tRdGFlWmVpZ3pxdG1NUC9JeXB/pem

Success response format

FieldTypeDescription
PEM

The PEM containing the certificate chain of the application referred. The PEM may contain the private key as well (if the certificate was not created using externally generated CSR)

Success response

HTTP/1.0 200 OK
"<PEM bytes>"
 

Download Application's Key Store Data in PFX Format

Downloads the application’s key store data in PFX format.
get
deprecated
/download/applications/:applicationId/pfx

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The applicationId of the application to be downloaded.

Request example

/download/applications/1.3.6.1.4.1.21528.3.3.2.100.1.1/pfx

Success response format

FieldTypeDescription
PFX

The PFX containing the certificate chain of the application referred. The PFX may contain the private key as well (if the application was not created using externally generated CSR)

Success response

HTTP/1.0 200 OK
"<PFX bytes>"
 

Download Application's Key Store Data in PEM Format

Downloads the application’s key store data in PEM format.
get
deprecated
/download/applications/:applicationId/pem

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The applicationId of the application to be downloaded.

Request example

/download/applications/1.3.6.1.4.1.21528.3.3.2.100.1.1/pem

Success response format

FieldTypeDescription
PEM

The PEM containing the certificate chain of the application referred. The PEM may contain the private key as well (if the application was not created using externally generated CSR)

Success response

HTTP/1.0 200 OK
"<PEM bytes>"
 

Download Password for Application's PFX

Downloads the password corresponding to the applicaton’s PFX.
get
deprecated
/rest/applications/:applicationId/pfxpass

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The applicationId for which the data to be downloaded.

Request example

/rest/applications/1.3.6.1.4.1.21528.3.3.2.100.1.1/pfxpass

Success response format

FieldTypeDescription
String

The password corresponding to the application’s PFX in plain text.

Success response

HTTP/1.0 200 OK
"123456"
 

Download Application's Icon

Downloads the application’s icon in SVG format.
get
/download/applications/:applicationId/icon

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The applicationId of the application.

Request example

/download/applications/1.3.6.1.4.1.21528.3.3.2.100.1.1/icon

Success response format

FieldTypeDescription
svg+xml

The icon in svg+xml format

Success response

HTTP/1.0 200 OK
"<SVG bytes>"
 

Replace Application's Icon

Replace the application’s icon to the provided svg file.
post
/rest/applications/:applicationId/icon/replace

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The applicationId of the application.

multipart form
in request body.
FieldMandatoryDescription
applicationIconRequired

Valid svg file

Request example

/rest/applications/1.3.6.1.4.1.21528.3.3.2.100.1.1/icon/replace

Success response

HTTP/1.0 200 OK
 

Restore Application's Icon To Default

Restore the application’s icon to the system default icon.
post
/rest/applications/:applicationId/icon/restore

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The applicationId of the application.

Request example

/rest/applications/1.3.6.1.4.1.21528.3.3.2.100.1.1/icon/restore

Success response

HTTP/1.0 200 OK
 

Validate Application's Icon To Be Uploaded

Validate the provided svg file.
post
/rest/applications/:applicationId/icon/validate

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

The applicationId of the application.

multipart form
in request body.
FieldMandatoryDescription
applicationIconRequired

Svg file

Request example

/rest/applications/1.3.6.1.4.1.21528.3.3.2.100.1.1/icon/validate

Success response

HTTP/1.0 200 OK
 

Device

Get Devices

Returns all devices. For query parameters see Search Criteria as Input Parameters.
get
/rest/devices

Parameters

None.

Success response format

FieldTypeDescription
recordsFilteredInteger

Number of records match the search criteria.

recordsTotalInteger

The number of total records.

dataArray

A JSON encoded array that contains the list of device information.

FieldTypeDescription
oidString

The ID of the device.

vendorIdString

The vendor given unique identifier of the device.

deviceTypeString

The type of the device.

deviceNameString

The name of the device.

customerFullNameString

The full name of the customer.

apiVersionInteger

The API version supported by the PassByME client application.

applicationVersionString

The version of the PassByME client application.

deactivationPasswordString

This password can be used to delete the corresponding device via the self management interface.

certificatesDeviceCertificates

Certificates - Map of certificates of the identity enrolled into this device.
key - [userAuthUrl | deviceAuthUrl | userSignUrl | deviceSignUrl]
value - url from where the certificate can be downloaded

Success response

HTTP/1.0 200 OK
{"recordsFiltered":1,"recordsTotal":1,"data":[{"oid":"1.3.6.1.4.1.21528.3.3.2.1.12117.1.12118","vendorId":"vendorId1","deviceType":"ANDROID","deviceName":"John Doe phone","customerFullName":"John Doe","apiVersion":3,"applicationVersion":"2.3.0","deactivationPassword":"xftG2zhNTX","certificates":{"userAuthUrl":"https://admin.passbyme.com/register/rest/devices/dmVuZG9ySWQx/certificate/userAuth.cer","deviceAuthUrl":"https://admin.passbyme.com/register/rest/devices/dmVuZG9ySWQx/certificate/deviceAuth.cer","userSignUrl":"https://admin.passbyme.com/register/rest/devices/dmVuZG9ySWQx/certificate/userSign.cer","deviceSignUrl":"https://admin.passbyme.com/register/rest/devices/dmVuZG9ySWQx/certificate/deviceSign.cer"}}]}
 

Get User Devices

Returns the devices of the given user.
get
/rest/users/:oid/devices

Parameters

query string
FieldMandatoryDescription
oidRequired

The unique Id of the user.

Request example

/rest/users/1.3.6.1.4.1.21528.3.3.3.102/devices

Success response format

FieldTypeDescription
dataArray

A JSON encoded array that contains the list of device information.

FieldTypeDescription
oidString

The ID of the device.

vendorIdString

The vendor given unique identifier of the device.

deviceTypeString

The type of the device.

deviceNameString

The name of the device.

customerFullNameString

The full name of the customer.

apiVersionInteger

The API version supported by the PassByME client application.

applicationVersionString

The version of the PassByME client application.

deactivationPasswordString

This password can be used to delete the corresponding device via the self management interface.

certificatesDeviceCertificates

Certificates - Map of certificates of the identity enrolled into this device.
key - [userAuthUrl | deviceAuthUrl | userSignUrl | deviceSignUrl]
value - url from where the certificate can be downloaded

Success response

HTTP/1.0 200 OK
{"data":[{"oid":"1.3.6.1.4.1.21528.3.3.2.1.12117.1.12118","vendorId":"vendorId1","deviceType":"ANDROID","deviceName":"John Doe phone","customerFullName":"John Doe","apiVersion":3,"applicationVersion":"2.3.0","deactivationPassword":"xftG2zhNTX","certificates":{"userAuthUrl":"https://admin.passbyme.com/register/rest/devices/dmVuZG9ySWQx/certificate/userAuth.cer","deviceAuthUrl":"https://admin.passbyme.com/register/rest/devices/dmVuZG9ySWQx/certificate/deviceAuth.cer","userSignUrl":"https://admin.passbyme.com/register/rest/devices/dmVuZG9ySWQx/certificate/userSign.cer","deviceSignUrl":"https://admin.passbyme.com/register/rest/devices/dmVuZG9ySWQx/certificate/deviceSign.cer"}}]}
 

Get Enrollment Device

Returns the device of the given enrollment if exists.
get
/rest/enrollment/:enrollmentId/device

Parameters

query string
FieldMandatoryDescription
enrollmentIdRequired

The unique Id of the enrollment.

Request example

/rest/enrollment/Ot5pL2mkRVO6LYav/device

Success response format

FieldTypeDescription
dataObject

A JSON encoded object that contains the device information.

FieldTypeDescription
oidString

The ID of the device.

vendorIdString

The vendor given unique identifier of the device.

deviceTypeString

The type of the device.

deviceNameString

The name of the device.

customerFullNameString

The full name of the customer.

apiVersionInteger

The API version supported by the PassByME client application.

applicationVersionString

The version of the PassByME client application.

deactivationPasswordString

This password can be used to delete the corresponding device via the self management interface.

certificatesDeviceCertificates

Certificates - Map of certificates of the identity enrolled into this device.
key - [userAuthUrl | deviceAuthUrl | userSignUrl | deviceSignUrl]
value - url from where the certificate can be downloaded

Success response

HTTP/1.0 200 OK
{"data":[{"oid":"1.3.6.1.4.1.21528.3.3.2.1.12117.1.12118","vendorId":"vendorId1","deviceType":"ANDROID","deviceName":"John Doe phone","customerFullName":"John Doe","apiVersion":3,"applicationVersion":"2.3.0","deactivationPassword":"xftG2zhNTX","certificates":{"userAuthUrl":"https://admin.passbyme.com/register/rest/devices/dmVuZG9ySWQx/certificate/userAuth.cer","deviceAuthUrl":"https://admin.passbyme.com/register/rest/devices/dmVuZG9ySWQx/certificate/deviceAuth.cer","userSignUrl":"https://admin.passbyme.com/register/rest/devices/dmVuZG9ySWQx/certificate/userSign.cer","deviceSignUrl":"https://admin.passbyme.com/register/rest/devices/dmVuZG9ySWQx/certificate/deviceSign.cer"}}]}
 

Get Admin Devices

Returns the devices of the given administrator.
get
/rest/administrators/:userId/devices

Parameters

query string
FieldMandatoryDescription
userIdRequired

The unique identifier of the administrator.

Request example

/rest/administrators/admin@passbyme.com/devices

Success response format

FieldTypeDescription
dataArray

A JSON encoded array that contains the list of device information.

FieldTypeDescription
oidString

The ID of the device.

vendorIdString

The vendor given unique identifier of the device.

deviceTypeString

The type of the device.

deviceNameString

The name of the device.

customerFullNameString

The full name of the customer.

apiVersionInteger

The API version supported by the PassByME client application.

applicationVersionString

The version of the PassByME client application.

deactivationPasswordString

This password can be used to delete the corresponding device via the self management interface.

certificatesDeviceCertificates

Certificates - Map of certificates of the identity enrolled into this device.
key - [USER_AUTH | USER_SIGN | DEVICE_AUTH | DEVICE_SIGN]
value - raw certificate in base64 string format

Success response

HTTP/1.0 200 OK
{"data":[{"oid":"1.3.6.1.4.1.21528.3.3.2.1.12117.1.12118","vendorId":"vendorId1","deviceType":"ANDROID","deviceName":"John Doe phone","customerFullName":"John Doe","apiVersion":3,"applicationVersion":"2.3.0","deactivationPassword":"xftG2zhNTX","certificates":{"userAuthUrl":"https://admin.passbyme.com/register/rest/devices/dmVuZG9ySWQx/certificate/userAuth.cer","deviceAuthUrl":"https://admin.passbyme.com/register/rest/devices/dmVuZG9ySWQx/certificate/deviceAuth.cer","userSignUrl":"https://admin.passbyme.com/register/rest/devices/dmVuZG9ySWQx/certificate/userSign.cer","deviceSignUrl":"https://admin.passbyme.com/register/rest/devices/dmVuZG9ySWQx/certificate/deviceSign.cer"}}]}
 

Delete Device

Remove the given device of the user or administrator. After delete PassByME authentication is not available.
post
/rest/devices/deactivations

Parameters

None.

Success response format

FieldTypeDescription
String

Empty JSON string.

Success response

HTTP/1.0 200 OK
 

Send Deactivation Password

Sends deactivation password via e-mail (if configured for user).
post
/rest/devices/deactivationpass

Parameters

json
in request body.
FieldMandatoryDescription
vendorIdRequired

The vendorId of the device which belongs to the deactivation password to send.

Request example

/rest/devices/deactivationpass
{"vendorId":"vendorIdOfDevice"}

Success response

HTTP/1.0 200 OK
 

Download device certificate

Retrieves one of the device certificates based on the type.
get
/download/devices/:vendorId/certificate/:certificateType

Parameters

query string
FieldMandatoryDescription
vendorIdRequired

The base64 url encoded vendorId of the device

certificateTypeRequired

One of the following values: userAuth.cer, deviceAuth.cer, userSign.cer, deviceSign.cer

Request example

/download/devices/vendorIdOfDevice/certificate/userAuth.cer

Success response format

FieldTypeDescription
X.509

The selected certificate in X.509 format

Success response

HTTP/1.0 200 OK
"<X.509 certificate bytes>"
 

Get certificates' details

Retrieves information for all the certificates used by the device.
get
/rest/devices/:vendorId/certificates

Parameters

query string
FieldMandatoryDescription
vendorIdRequired

The base64 url encoded vendorId of the device

Request example

/rest/devices/vendorIdOfDevice/certificates

Success response format

FieldTypeDescription
Array

A JSON encoded array that contains the list of certificate information.

FieldTypeDescription
typeString

The type of the device certificate

issuerDnString

Issuer of the certificate

subjectDnString

Subject of the certificate

notBeforeDatetime - start of validity.

The beginning of the certificate's validity period

notAfterDatetime - end of validity.

The end of the certificate's validity period

Success response

HTTP/1.0 200 OK
[{"type":"USER_SIGN","issuerDn":"CN=PassByMe CA1, OU=PassByMe IDP, O=Microsec Ltd., L=Budapest, C=HU","subjectDn":"C=HU, L=Budapest, CN=JD, SERIALNUMBER=1.3.6.1.4.1.2151.2.3","notBefore":"2018-03-08T07:46:11Z","notAfter":"2023-03-07T07:46:11Z"}]
 

Generate Device Report

Generates a detailed report of the organization's devices with their current status and last activities. The generated report is stored and returned from cache for three hours.
get
/rest/reports/device

Parameters

Request example

/rest/reports/device

Success response format

FieldTypeDescription
organizationIdString

The identifier of the organization.

reportIdString

The identifier of the report type.

createdAtObject

The time when the report was generated.

FieldTypeDescription
secondsinteger

The number of seconds from the epoch of 1970-01-01T00:00:00Z

nanosinteger

The number of nanoseconds, later along the time-line, from the seconds field. This is always positive, and never exceeds 999,999,999

reportDataString

The CSV report in BASE64 encoded form.

Success response

HTTP/1.0 200 OK
{"organizationId":"1.3.6.1.4.1.21528.3.3.2.1.28459","reportId":"device","createdAt":[{"seconds":"1539775916","nanos":"291000000"}],"reportData":"nVsbCBuY...sLCx0cnVlDQo="}
 

Download Device Report as CSV

Returns the generated/cached device report as application/csv. Generates a detailed report of the organization's devices with their current status and last activities. The generated report is stored and returned from cache for three hours.
get
/download/reports/user

Parameters

Request example

/download/reports/user

Success response format

FieldTypeDescription
application/csv

The downloadable report.

Success response

HTTP/1.0 200 OK
"<bytes>"
 

Organization

Get Organization

Returns organization details.
get
/rest/organization

Parameters

None.

Success response format

FieldTypeDescription
organizationIdString

The unique identifier of the organization.

nameString

The name of the organization.

pricingString ("Free", "Standard" or "Premium")

The account type of the organization.

upgradableBoolean

Indicates whether the organization’s pricing category is upgradable or not.

downgradableBoolean

Indicates whether the organization’s pricing category is downgradable or not.

emailString

The registered contact email of the organization.

enrollmentExpirationHoursInteger

The expiration of the generated enrollment sheets in hours.

invitationExpirationHoursInteger

The expiration of the generated invitations in hours.

confirmationLetterEnabledBoolean

Determines whether confirmation letter sending is enabled.

pricingExpirationString (ISO 8601)

The time when the actual pricing expire.

isCommercialBoolean

Indicates wheter the organization is commercial or not.

Success response

HTTP/1.0 200 OK
{"organizationId":"1.2.3.4","name":"Test Org.","pricing":"Free","upgradable":false,"downgradable":false,"email":"support@passbyme.com","enrollmentExpirationHours":24,"invitationExpirationHours":12,"confirmationLetterEnabled":true,"pricingExpiration":true,"isCommercial":false}
 

Get Organization Callback

Returns organization callback params.
get
/rest/organization/callback

Parameters

None.

Success response format

FieldTypeDescription
organizationIdString

The unique identifier of the organization.

callbackRetryCountInteger

Defines the count of status callback calls.

callbackRetryDelayInteger

Defines the time between 2 status callback.

Success response

HTTP/1.0 200 OK
{"organizationId":"1.2.3.4","callbackRetryCount":15,"callbackRetryDelay":30}
 

Update Organization

Updates organization details.
put
/rest/organization

Parameters

json
in request body.
FieldMandatoryDescription
emailRequired

Email address of the organization.

nameRequired

The name of the organization.

enrollmentExpirationHoursRequired

The expiration of the generated enrollment sheets in hours.

invitationExpirationHoursRequired

The expiration of the generated invitations in hours.

confirmationLetterEnabledRequired

Determines whether confirmation letter sending is enabled to users.

Request example

/rest/organization
{"email":"organization@passbyme.com","name":"Re-named organization","enrollmentExpirationHours":24,"invitationExpirationHours":12,"confirmationLetterEnabled":true}

Success response

HTTP/1.0 200 OK
 

Update Organization Callback

Updates organization callback params.
put
/rest/organization/callback

Parameters

json
in request body.
FieldMandatoryDescription
callbackRetryCountRequired

Defines the count of status callback calls.

callbackRetryDelayRequired

Defines the time between 2 status callback.

Request example

/rest/organization/callback
{"callbackRetryCount":15,"callbackRetryDelay":30}

Success response

HTTP/1.0 200 OK
 

Get Account Limitation

Receive the current account pricing of the organization.
get
/rest/organization/pricing

Parameters

None.

Success response format

FieldTypeDescription
maxNumberOfUsersInteger

The maximum number of users allowed to exist in the account.

maxNumberOfAdminsInteger

The maximum number of administrators allowed to exist in the account.

daysOfActivityLogInteger

How many days of the activity log is stored and accessible.

maxNumberOfDevicesPerUserInteger

The maximum number of devices a user can enroll for PassByME.

hasManagementAPIboolean

Tells if the management API is enabled or not

hasUserDisablingAPIboolean

Tells if the orgainzation has disabled user function or not

creditPerUserInteger

Credit limit for users

Success response

HTTP/1.0 200 OK
{"maxNumberOfUsers":10,"maxNumberOfAdmins":2,"daysOfActivityLog":1,"maxNumberOfDevicesPerUser":20,"hasManagementAPI":true,"hasUserDisablingAPI":true,"creditPerUser":0}
 

Get Available Roles

Retrieve the list of roles available to be set for an administrator in the current organization.
get
/rest/organization/roles

Parameters

None.

Success response format

FieldTypeDescription
Array

A JSON encoded array that contains the list of users.

FieldTypeDescription
idString

The unique Id of role

Success response

HTTP/1.0 200 OK
[{"id":"UserManager"}]
 

Get Organization Info

Retrieve the custom settings of the current organization.
get
/rest/organization/info

Parameters

None.

Success response format

FieldTypeDescription
enrollmentSchemeString (optional)

Custom scheme for the enrollment urls.

fcmCredentialString (optional)

API key for google FCM service.

apnsEnvironmentApnsEnvironment

"PROD" if the used APNS service certificate is for production use, "SANDBOX" if it is for testing, "DEFAULT" if it is in default state of the organization.

iOSCertificationString (optional)

PKCS12 binary package of the certificate for APNS service.

iOSPasswordString (optional)

Password for certificate of the APNS service.

iOSDnString (optional)

DN taken out from the APNS certificate.

minimumRequiredAndroidAppVersionString (optional)

Minimum required Android app version. If the application is below this version, it is required to update.

minimumRequiredIosAppVersionString (optional)

Minimum required iOS app version. If the application is below this version, it is required to update.

Success response

HTTP/1.0 200 OK
{"enrollmentScheme":"pbm","fcmCredential":"aSDF783sd","apnsEnvironment":"PROD","iOSCertification":"MIIZ0gIBAzCCGYwGCSqGSIb3DQEHAaCCGX0Eghl5MIIZdT[...]","iOSPassword":"123456","iOSDn":"CN=Apple Worldwide Developer Relations Certification Authority, OU=Apple Worldwide Developer Relations, O=Apple Inc., C=US","minimumRequiredAndroidAppVersion":"1.2.3","minimumRequiredIosAppVersion":"1.2.3"}
 

Update Custom Enrollment Scheme

Updates the custom enrollment scheme.
post
/rest/organization/info/enrollmentScheme

Parameters

json
in request body.
FieldMandatoryDescription
enrollmentSchemeOptional

Custom scheme for the enrollment urls.

Request example

/rest/organization/info/enrollmentScheme
{"enrollmentScheme":"pbm"}

Success response

HTTP/1.0 200 OK
 

Update Android Firebase Cloud Messaging Credential

Updates the Android Firebase Cloud Messaging credential.
post
/rest/organization/info/fcmCredential

Parameters

json
in request body.
FieldMandatoryDescription
fcmCredentialOptional

API key for google FCM service.

Request example

/rest/organization/info/fcmCredential
{"fcmCredential":"aSDF783sd"}

Success response

HTTP/1.0 200 OK
 

Update Apple Push Notification Service Environment

Updates the Apple Push Notification Service environment.
post
/rest/organization/info/apnsEnvironment

Parameters

json
in request body.
FieldMandatoryDescription
apnsEnvironmentRequired

"PROD" if the used APNS service certificate is for production use, "SANDBOX" if it is for testing, "DEFAULT" if it is in default state of the organization.

Request example

/rest/organization/info/apnsEnvironment
{"apnsEnvironment":"PROD"}

Success response

HTTP/1.0 200 OK
 

Update Apple Push Notification Service Certification

Updates the Apple Push Notification Service certification.
post
/rest/organization/info/apnsCertification

Parameters

multipart form
in request body.
FieldMandatoryDescription
iOSCertificationRequired

PKCS12 binary package of the certificate for APNS service.

iOSPasswordRequired

Password for certificate of the APNS service.

Request example

/rest/organization/info/apnsCertification

Success response

HTTP/1.0 200 OK
 

Update Apple Push Notification Service Bundle Id

Updates the Apple Push Notification Service bundle id.
post
/rest/organization/info/apnsBundleId

Parameters

json
in request body.
FieldMandatoryDescription
apnsBundleIdRequired

The custom bundle id for Apple Push Notification Service

Request example

/rest/organization/info/apnsBundleId
{"apnsBundleId":"com.test"}

Success response

HTTP/1.0 200 OK
 

Update Minimum Required Android App Version

Updates minimum required Android app version.
post
/rest/organization/info/minimumRequiredAndroidAppVersion

Parameters

json
in request body.
FieldMandatoryDescription
versionOptional

Minimum required Android app version. If the application is below this version, it is required to update.

Request example

/rest/organization/info/minimumRequiredAndroidAppVersion
{"version":"1.2.3"}

Success response

HTTP/1.0 200 OK
 

Update Minimum Required iOS App Version

Updates minimum required iOS app version.
post
/rest/organization/info/minimumRequiredIosAppVersion

Parameters

json
in request body.
FieldMandatoryDescription
versionOptional

Minimum required iOS app version. If the application is below this version, it is required to update.

Request example

/rest/organization/info/minimumRequiredIosAppVersion
{"version":"1.2.3"}

Success response

HTTP/1.0 200 OK
 

Reset Custom Enrollment Scheme

Resets the custom enrollment scheme to default.
delete
/rest/organization/info/enrollmentScheme

Parameters

None.

Success response

HTTP/1.0 200 OK
 

Reset Android Firebase Cloud Messaging Credential

Resets the Android Firebase Cloud Messaging credential to default.
delete
/rest/organization/info/fcmCredential

Parameters

None.

Success response

HTTP/1.0 200 OK
 

Reset Apple Push Notification Service Environment

Resets the Apple Push Notification Service environment to default.
delete
/rest/organization/info/apnsEnvironment

Parameters

None.

Success response

HTTP/1.0 200 OK
 

Reset Apple Push Notification Service Certification

Resets the Apple Push Notification Service certification to default.
delete
/rest/organization/info/apnsCertification

Parameters

None.

Success response

HTTP/1.0 200 OK
 

Reset Apple Push Notification Service Bundle Id

Resets the Apple Push Notification Service bundle id to default.
delete
/rest/organization/info/apnsBundleId

Parameters

None.

Success response

HTTP/1.0 200 OK
 

Reset Minimum Required Android App Version

Resets the minimum required Android app version to default.
delete
/rest/organization/info/minimumRequiredAndroidAppVersion

Parameters

None.

Success response

HTTP/1.0 200 OK
 

Reset Minimum Required iOS App Version

Resets the minimum required iOS app version to default.
delete
/rest/organization/info/minimumRequiredIosAppVersion

Parameters

None.

Success response

HTTP/1.0 200 OK
 

Messaging Activity Management

Get List of Messaging Activity

Returns list of second factor messages. For query parameters see Search Criteria as Input Parameters.
get
/rest/messagehistory

Parameters

None.

Success response format

FieldTypeDescription
recordsFilteredInteger

Number of records match the search criteria.

recordsTotalInteger

The number of total records.

dataArray

A JSON encoded array of Message objects

FieldTypeDescription
messageIdMessageId

The alias of the messages current representation.

messageTypeString ("message", "esign", "authorization", "oneTimePassword", "configurationUpdate" or "identification")

The type of the message.

subjectString

The subject of the Message

senderApplicationIdString

The id of the application

senderApplicationNameString

The name of the application (optional, not provided if the application has been deleted)

submitDateString (ISO 8601)

Datetime - start of activity.

expirationString (ISO 8601)

Datetime - end of activity

callbackUrlString

The callback url of the message if set (optional)

Success response

HTTP/1.0 200 OK
{"recordsFiltered":1,"recordsTotal":1,"data":[{"messageId":"@e2e-1.3.6.1.4.1.21528.2.2.1.10001.2.100-BsvhCiCG","messageType":"message","subject":"test subject","senderApplicationId":"1.3.6.1.4.1.21528.2.2.1.10001.2.100","senderApplicationName":"activity-tester-app","submitDate":"2017-08-30T12:21:13.451Z","expiration":"2017-08-30T12:22:13.445Z","callbackUrl":"http://callbackdomain/callbackurl"}]}
 

Administrator Activity Management

Get List of Admin Activity

Returns list of admin activities done on the admin dashboard. For query parameters see Search Criteria as Input Parameters.
get
/rest/adminactivities

Parameters

None.

Success response format

FieldTypeDescription
recordsFilteredInteger

Number of records match the search criteria.

recordsTotalInteger

The number of total records.

dataArray

A JSON encoded array of AdminUIActivity objects

FieldTypeDescription
messageIdMessageId

The alias of the messages current representation (if there is a message sent during activity).

creationDateString (ISO 8601)

Datetime - start of activity.

userIdString

The id of the admin

statusString

The status of the message (if there is a message connected to activity).

operationString ("LOGIN", "LOGOUT" or "ORGDELETE" )

The type of the operation.

Success response

HTTP/1.0 200 OK
{"recordsFiltered":1,"recordsTotal":1,"data":[{"messageId":"@e2e-1.3.6.1.4.1.21528.2.2.1.10001.2.100-BsvhCiCG","creationDate":"2017-08-30T12:21:13.451Z","userId":"john.doe@passbyme.com","status":"PENDING","operation":"LOGIN"}]}
 

Maintenance

Get List of Maintenance

Returns list of maintenance for the organization
get
Subject to change
/rest/maintenance

Parameters

None.

Success response format

FieldTypeDescription
dataArray

A JSON encoded array of Maintenance objects

FieldTypeDescription
idinteger

The maintenance id

scopeString (APPLICATION or ORGANIZATION)

The scope of the maintenance.

applicationIdString (optional)

The id of the application in the case of APPLICATION scope maintenance

applicationNameString (optional)

The name of the application in the case of APPLICATION scope maintenance. After application deletion it will not be present.

fromString (ISO 8601)

Start datetime of the maintenance.

toString (ISO 8601, optional)

End datetime of the maintenance if defined.

messagesArray

An array containing the messages for different languages. It must contain the messages in english at least. This messages will be shown for the devices during maintenance.

{
languageCode : String (ISO 639-2 language code)
subject : String
body : String
}

Success response

HTTP/1.0 200 OK
{"data":[{"id":"1","scope":"APPLICATION","applicationId":"1.3.6.1.4.1.21528.3.3.3.1588","applicationName":"1.3.6.1.4.1.21528.3.3.3.1588","from":"2020-01-29T13:18:27Z","to":"2023-01-29T13:18:27Z","messages":[{"languageCode":"eng","subject":"Maintenance","body":"Under maintenance - This application cannot accept any evidences during its maintenance."}]}]}
 

Get Maintenance

Returns a selected maintenance
get
Subject to change
/rest/maintenance/:id

Parameters

query string
FieldMandatoryDescription
idRequired

A globally unique identifier of a maintenance.

Request example

/rest/maintenance/1

Success response format

FieldTypeDescription
idinteger

The maintenance id

scopeString (APPLICATION or ORGANIZATION)

The scope of the maintenance.

applicationIdString (optional)

The id of the application in the case of APPLICATION scope maintenance

applicationNameString (optional)

The name of the application in the case of APPLICATION scope maintenance. After application deletion it will be missing.

fromString (ISO 8601)

Start datetime of the maintenance.

toString (ISO 8601, optional)

End datetime of the maintenance if defined.

messagesArray

An array containing the messages for different languages. It must contain the messages in english at least. This messages will be shown for the devices during maintenance.

FieldTypeDescription
languageCodeString (ISO 639-2 language code)

Language code of the message. English entry must be set, other entries are optional.

subjectString

Subject of the message

bodyString

Body of the message

Success response

HTTP/1.0 200 OK
{"id":"1","scope":"APPLICATION","applicationId":"1.3.6.1.4.1.21528.3.3.3.1588","applicationName":"1.3.6.1.4.1.21528.3.3.3.1588","from":"2020-01-29T13:18:27Z","to":"2023-01-29T13:18:27Z","messages":[{"languageCode":"eng","subject":"Maintenance","body":"Under maintenance - This application cannot accept any evidences during its maintenance."}]}
 

Get Maintenance of Application

Returns a list of maintenance for the selected application
get
Subject to change
/rest/maintenance/application/:applicationId

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

A globally unique identifier of the application.

Request example

/rest/maintenance/application/1.3.6.1.4.1.21528.3.3.3.1588

Success response format

FieldTypeDescription
dataArray

A JSON encoded array of Maintenance objects

FieldTypeDescription
idinteger

The maintenance id

scopeString (APPLICATION)

The scope of the maintenance.

applicationIdString

The id of the application

applicationNameString (optional)

The name of the application in the case of APPLICATION scope maintenance. After application deletion it will be missing.

fromString (ISO 8601)

Start datetime of the maintenance.

toString (ISO 8601, optional)

End datetime of the maintenance if defined.

messagesArray

An array containing the messages for different languages. It must contain the messages in english at least. This messages will be shown for the devices during maintenance.

{
languageCode : String (ISO 639-2 language code)
subject : String
body : String
}

Success response

HTTP/1.0 200 OK
{"data":[{"id":"1","scope":"APPLICATION","applicationId":"1.3.6.1.4.1.21528.3.3.3.1588","applicationName":"1.3.6.1.4.1.21528.3.3.3.1588","from":"2020-01-29T13:18:27Z","to":"2023-01-29T13:18:27Z","messages":[{"languageCode":"eng","subject":"Maintenance","body":"Under maintenance - This application cannot accept any evidences during its maintenance."}]}]}
 

Create Application Maintenance

Creates a new application maintenance
post
Subject to change
/rest/maintenance/application/:applicationId

Parameters

query string
FieldMandatoryDescription
applicationIdRequired

A globally unique identifier of the application.

json
in request body.
FieldMandatoryDescription
scopeRequired

The scope of the maintenance. Must be APPLICATION.

applicationIdRequired

The id of the application. Must be the same as the path parameter.

applicationNameOptional

The name of the application in the case of APPLICATION scope maintenance. After application deletion it will be missing.

messagesRequired

An array containing the messages for different languages. It must contain the messages in english at least. This messages will be shown for the devices during maintenance.

FieldMandatoryDescription
languageCodeRequired

Language code (ISO 639-2) of the message. English entry must be set, other entries are optional.

subjectRequired

Subject of the message

bodyRequired

Body of the message

Request example

/rest/maintenance/application/1.3.6.1.4.1.21528.3.3.3.1588
{"scope":"APPLICATION","applicationId":"1.3.6.1.4.1.21528.3.3.3.1588","applicationName":"1.3.6.1.4.1.21528.3.3.3.1588","messages":[{"languageCode":"eng","subject":"Maintenance","body":"Under maintenance - This application cannot accept any evidences during its maintenance."}]}

Success response format

FieldTypeDescription
idinteger

The maintenance id of the maintenance created

scopeString (APPLICATION)

The scope of the maintenance.

applicationIdString

The id of the application

applicationNameString (optional)

The name of the application in the case of APPLICATION scope maintenance. After application deletion it will be missing.

fromString (ISO 8601)

Start datetime of the maintenance.

toString (ISO 8601, optional)

End datetime of the maintenance if defined.

messagesArray

An array containing the messages for different languages. It must contain the messages in english at least. This messages will be shown for the devices during maintenance.

FieldTypeDescription
languageCodeString (ISO 639-2 language code)

Language code of the message. English entry must be set, other entries are optional.

subjectString

Subject of the message

bodyString

Body of the message

Success response

HTTP/1.0 200 OK
{"id":"13","scope":"APPLICATION","applicationId":"1.3.6.1.4.1.21528.3.3.3.1588","applicationName":"1.3.6.1.4.1.21528.3.3.3.1588","from":"2020-01-29T13:18:27Z","to":"2023-01-29T13:18:27Z","messages":[{"languageCode":"eng","subject":"Maintenance","body":"Under maintenance - This application cannot accept any evidences during its maintenance."}]}
 

Stop Maintenance

Stop maintenance immediately. Once stopped, the maintenance cannot be modified.
post
Subject to change
/rest/maintenance/:id

Parameters

query string
FieldMandatoryDescription
idRequired

A globally unique identifier of the maintenance.

Request example

/rest/maintenance/11

Success response format

FieldTypeDescription
idinteger

The maintenance id of the maintenance stopped

scopeString (APPLICATION or ORGANIZATION)

The scope of the maintenance.

applicationIdString (optional)

The id of the application

applicationNameString (optional)

The name of the application in the case of APPLICATION scope maintenance. After application deletion it will not be present.

fromString (ISO 8601)

Start datetime of the maintenance.

toString (ISO 8601)

The new ending datetime of the maintenance.

messagesArray

An array containing the messages for different languages. It must contain the messages in english at least. This messages will be shown for the devices during maintenance.

FieldTypeDescription
languageCodeString (ISO 639-2 language code)

Language code of the message. English entry must be set, other entries are optional.

subjectString

Subject of the message

bodyString

Body of the message

Success response

HTTP/1.0 200 OK
{"id":"13","scope":"APPLICATION","applicationId":"1.3.6.1.4.1.21528.3.3.3.1588","applicationName":"1.3.6.1.4.1.21528.3.3.3.1588","from":"2020-01-29T13:18:27Z","to":"2020-01-30T13:18:27Z","messages":[{"languageCode":"eng","subject":"Maintenance","body":"Under maintenance - This application cannot accept any evidences during its maintenance."}]}