Schemas Postman

oAuth. Create/update device POST

# ENDPOINT
/model/oAuthDevice/putDb
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0 		M
# REQUEST BODY
# RESPONSE
# REQUEST arguments
Variable Name Type Format Usage Description
X-App-Sig X-App-Sig header string M
# REQUEST BODY
Schema: oAuthDevice
Type: object
Variable Name Type Format Usage Description
action Action string
Base64QrCodePng QR-Code PNG STRING
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
create_date Create Date string DATETIME The date entry was created on
create_user Create User string The username of ABS user who has created an entry
default_for_notifications Default for notifications boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
description description string Description of a given record
device_number device_number string
device_number_masked device_number_masked string
device_status device_status string
List of allowed values in field (value=>name):
  • 0
    active
  • 1
    blocked
  • 2
    deactivated
device_type device_type string
List of allowed values in field (value=>name):
  • 0
    email
  • 1
    http
  • 2
    mobile_application
  • 3
    phone
  • 4
    stomp
  • 5
    totp
form_title form_title string Service field
id id integer INT64 Record's sequence number generated in the system.
modify_date Modify Date string DATETIME The date entry was last modified on
modify_user Modify User string The username of ABS user who has made last changes to the entry
operation_system operation_system string
private_key Private key STRING
state state integer INT64 Record state for replication
uid uid string Unique record identifier which is used to distinguish between existing records
use_device_as_login Enable login with device number boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
version version integer INT64 Record version for replication
# REQUEST BODY EXAMPLE
# POSITIVE RESPONSE
Schema: oAuthDevice
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object data of Response
attribute: data
Variable Name Type Format Description
action Action string
Base64QrCodePng QR-Code PNG STRING
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
create_date Create Date string DATETIME The date entry was created on
create_user Create User string The username of ABS user who has created an entry
default_for_notifications Default for notifications boolean
description description string Description of a given record
device_number device_number string
device_number_masked device_number_masked string
device_status device_status string
device_type device_type string
form_title form_title string Service field
id id integer INT64 Record's sequence number generated in the system.
modify_date Modify Date string DATETIME The date entry was last modified on
modify_user Modify User string The username of ABS user who has made last changes to the entry
operation_system operation_system string
private_key Private key STRING
state state integer INT64 Record state for replication
uid uid string Unique record identifier which is used to distinguish between existing records
use_device_as_login Enable login with device number boolean
version version integer INT64 Record version for replication
# NEGATIVE RESPONSE
Schema: HeaderResponseStatusError
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object Empty object
# Other endpoints
Name Endpoint
Fetch Access / Refresh Token /oauth/v2/token
oAuth. Fetch role by request /api/oAuthRepresentativeRole/getData/oAuthRepresentativeRoleSearchRequest
IB Password Restore /oauth/v2/passwordRestore
IB Login /oauth/v2/login
IB Challenge /oauth/v2/challenge
IB Sign /oauth/v2/sign
oAuth. Change password by request /api/oAuthSecurity/changePassword/oAuthChangePasswordRequest
oAuth. Fetch device by request /api/oAuthDevice/getData/oAuthDeviceSearchRequest
oAuth. Set device status by Request /api/oAuthDevice/setDeviceStatus/oAuthDeviceStatusRequest
IB Password Restore Reset /oauth/v2/passwordRestoreReset
IB Password Restore Verification /oauth/v2/passwordRestoreVerification