-
Notifications
You must be signed in to change notification settings - Fork 11
SOAP Service Methods
PowerAuth Server documentation has been moved to: https://developers.wultra.com/docs/develop/powerauth-server/SOAP-Service-Methods
Please use the new developer portal to access documentation.
This is a reference documentation of the methods published by the PowerAuth Server SOAP service. It reflects the SOAP service methods as they are defined in the WSDL file.
Following methods are published using the service:
- System Status
- Application Management
- Activation Management
- Signature Verification
- Offline Signatures
- Token Based Authentication
- Vault Unlocking
- Signature Audit Log
- Activation History
- Integration Management
- Callback URL Management
- End-To-End Encryption
Methods used for getting the PowerAuth Server system status.
Get the server status information.
GetSystemStatusRequest
- no attributes
GetSystemStatusResponse
| Type | Name | Description |
|---|---|---|
String |
status |
A constant value "OK". |
String |
applicationName |
A name of the application, the default value is powerauth. The value may be overriden by settingpowerauth.service.applicationName property. |
String |
applicationDisplayName |
A human readable name of the application, default value is "PowerAuth Server". The value may be overriden by setting powerauth.service.applicationDisplayName property. |
String |
applicationEnvironment |
An identifier of the environment, by default, the value is empty. The value may be overriden by setting powerauth.service.applicationEnvironment property. |
String |
version |
Version of PowerAuth server. |
String |
buildTime |
Timestamp when the powerauth-server.war file was built. |
DateTime |
timestamp |
A current system timestamp. |
Get the list of all error codes that PowerAuth Server can return.
GetErrorCodeListRequest
| Type | Name | Description |
|---|---|---|
String |
language |
Language code (ISO). |
GetErrorCodeListResponse
| Type | Name | Description |
|---|---|---|
Error[] |
errors |
A collection of errors. |
GetErrorCodeListResponse.Error
| Type | Name | Description |
|---|---|---|
String |
code |
A code of the error. |
String |
value |
A localized message for the error code. |
Methods related to the management of applications and application versions.
Get list of all applications that are present in this PowerAuth Server instance.
GetApplicationListRequest
- no attributes
GetApplicationListResponse
| Type | Name | Description |
|---|---|---|
Application[] |
applications |
A collection of application objects |
GetApplicationListRequest.Application
| Type | Name | Description |
|---|---|---|
Long |
id |
An application ID |
String |
applicationName |
Application name |
Get detail of application with given ID, including the list of versions.
GetApplicationDetailRequest
| Type | Name | Description |
|---|---|---|
Long |
applicationId |
An identifier of an application |
GetApplicationDetailResponse
| Type | Name | Description |
|---|---|---|
Long |
applicationId |
An identifier of an application |
String |
applicationName |
An application name |
String |
masterPublicKey |
Base64 encoded master public key |
Version[] |
versions |
Collection of application versions |
GetApplicationDetailResponse.Version
| Type | Name | Description |
|---|---|---|
Long |
applicationVersionId |
An identifier of an application version |
String |
applicationVersionName |
An application version name, for example "1.0.3" |
String |
applicationKey |
An application key associated with this version |
String |
applicationSecret |
An application secret associated with this version |
Boolean |
supported |
Flag indicating if this application is supported |
Create a new application with given name.
CreateApplicationRequest
| Type | Name | Description |
|---|---|---|
String |
applicationName |
An application name |
CreateApplicationResponse
| Type | Name | Description |
|---|---|---|
Long |
applicationId |
An identifier of an application |
String |
applicationName |
An application name |
Create a new application version with given name for a specified application.
CreateApplicationVersionRequest
| Type | Name | Description |
|---|---|---|
Long |
applicationId |
An identifier of an application |
String |
applicationVersionName |
An application version name |
CreateApplicationVersionResponse
| Type | Name | Description |
|---|---|---|
Long |
applicationVersionId |
An identifier of an application version |
String |
applicationVersionName |
An application version name |
String |
applicationKey |
An application key associated with this version |
String |
applicationSecret |
An application secret associated with this version |
Boolean |
supported |
Flag indicating if this application is supported |
Mark application version with given ID as "unsupported". Signatures constructed using application key and application secret associated with this versions will be rejected as invalid.
UnsupportApplicationVersionRequest
| Type | Name | Description |
|---|---|---|
Long |
applicationVersionId |
An identifier of an application version |
UnsupportApplicationVersionResponse
| Type | Name | Description |
|---|---|---|
Long |
applicationVersionId |
An identifier of an application version |
Boolean |
supported |
Flag indicating if this application is supported |
Mark application version with given ID as "supported". Signatures constructed using application key and application secret associated with this versions will be evaluated the standard way.
SupportApplicationVersionRequest
| Type | Name | Description |
|---|---|---|
Long |
applicationVersionId |
An identifier of an application version |
SupportApplicationVersionResponse
| Type | Name | Description |
|---|---|---|
Long |
applicationVersionId |
An identifier of an application version |
Boolean |
supported |
Flag indicating if this application is supported |
Methods related to activation management.
Get the list of all activations for given user and application ID. If no application ID is provided, return list of all activations for given user.
GetActivationListForUserRequest
| Type | Name | Description |
|---|---|---|
String |
userId |
An identifier of a user |
Long |
applicationId |
An identifier of an application |
GetActivationListForUserResponse
| Type | Name | Description |
|---|---|---|
String |
userId |
An identifier of a user |
Activation[] |
activations |
A collection of activations for given user |
GetActivationListForUserResponse.Activation
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
ActivationStatus |
activationStatus |
An activation status |
String |
blockedReason |
Reason why activation was blocked (default: NOT_SPECIFIED) |
String |
activationName |
An activation name |
String |
extras |
Any custom attributes |
DateTime |
timestampCreated |
A timestamp when the activation was created |
DateTime |
timestampLastUsed |
A timestamp when the activation was last used |
String |
userId |
An identifier of a user |
Long |
applicationId |
An identifier fo an application |
String |
applicationName |
An application name |
Create (initialize) a new application for given user and application. After calling this method, a new activation record is created in CREATED state.
InitActivationRequest
| Type | Name | Description |
|---|---|---|
String |
userId |
An identifier of a user |
Long |
applicationId |
An identifier of an application |
DateTime |
timestampActivationExpire |
Timestamp after when the activation cannot be completed anymore |
Long |
maxFailureCount |
How many failures are allowed for this activation |
InitActivationResponse
| Type | Name | Description |
|---|---|---|
String |
activationId |
A long UUID4 identifier of an activation |
String |
activationIdShort |
A short (5+5 characters from Base32) identifier of an activation |
String |
activationOTP |
An activation OTP (5+5 characters from Base32) |
String |
activationSignature |
A signature of the activation data using Master Server Private Key |
String |
userId |
An identifier of a user |
Long |
applicationId |
An identifier of an application |
Assure a key exchange between PowerAuth Client and PowerAuth Server and prepare the activation with given ID to be committed. Only activations in CREATED state can be prepared. After successfully calling this method, activation is in OTP_USED state.
PrepareActivationRequest
| Type | Name | Description |
|---|---|---|
String |
activationIdShort |
A short (5+5 characters from Base32) identifier of an activation |
String |
activationName |
A visual identifier of the activation |
String |
extras |
Any extra parameter object |
String |
activationNonce |
A base64 encoded activation nonce |
String |
ephemeralPublicKey |
A base64 encoded ephemeral public key |
String |
encryptedDevicePublicKey |
A base64 encoded encrypted device public key |
String |
applicationKey |
An application key |
String |
applicationSignature |
An application signature |
PrepareActivationResponse
| Type | Name | Description |
|---|---|---|
String |
activationId |
A long UUID4 identifier of an activation |
String |
activationNonce |
A base64 encoded activation nonce |
String |
ephemeralPublicKey |
A base64 encoded ephemeral public key |
String |
encryptedServerPublicKey |
A base64 encoded encrypted server public key |
String |
encryptedServerPublicKeySignature |
A base64 encoded signature of the activation data using Master Server Private Key |
Create an activation for given user and application, with provided maximum number of failed attempts and expiration timestamp, including a key exchange between PowerAuth Client and PowerAuth Server. Prepare the activation to be committed later. After successfully calling this method, activation is in OTP_USED state.
CreateActivationRequest
| Type | Name | Description |
|---|---|---|
String |
userId |
User ID |
Long |
applicationId |
Application ID |
DateTime |
timestampActivationExpire |
Timestamp after when the activation cannot be completed anymore |
Long |
maxFailureCount |
How many failures are allowed for this activation |
String |
identity |
An identity identifier string for this activation |
String |
activationName |
A visual identifier of the activation |
String |
extras |
Any extra parameter object |
String |
activationNonce |
A base64 encoded activation nonce |
String |
ephemeralPublicKey |
A base64 encoded ephemeral public key |
String |
encryptedDevicePublicKey |
A base64 encoded encrypted device public key |
String |
applicationKey |
An application key |
String |
applicationSignature |
An application signature |
CreateActivationResponse
| Type | Name | Description |
|---|---|---|
String |
activationId |
A long UUID4 identifier of an activation |
String |
activationNonce |
A base64 encoded activation nonce |
String |
ephemeralPublicKey |
A base64 encoded ephemeral public key |
String |
encryptedServerPublicKey |
A base64 encoded encrypted server public key |
String |
encryptedServerPublicKeySignature |
A base64 encoded signature of the activation data using Master Server Private Key |
Commit activation with given ID. Only non-expired activations in OTP_USED state can be committed. After successful commit, activation is in ACTIVE state.
CommitActivationRequest
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
CommitActivationResponse
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
Boolean |
activated |
Flag indicating if the activation was committed |
Get status information and all important details for activation with given ID.
GetActivationStatusRequest
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
GetActivationStatusResponse
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
ActivationStatus |
activationStatus |
An activation status |
String |
blockedReason |
Reason why activation was blocked (default: NOT_SPECIFIED) |
String |
activationName |
An activation name |
String |
userId |
An identifier of a user |
String |
extras |
Any custom attributes |
Long |
applicationId |
An identifier fo an application |
String |
encryptedStatusBlob |
An encrypted blob with status information |
DateTime |
timestampCreated |
A timestamp when the activation was created |
DateTime |
timestampLastUsed |
A timestamp when the activation was last used |
String |
activationIdShort |
A short (5+5 characters from Base32) identifier of an activation |
String |
activationOTP |
An activation OTP (5+5 characters from Base32) |
String |
activationSignature |
A signature of the activation data using Master Server Private Key |
Remove activation with given ID. This operation is irreversible. Activations can be removed in any state. After successfully calling this method, activation is in REMOVED state.
RemoveActivationRequest
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
RemoveActivationResponse
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
Boolean |
removed |
Flag indicating if the activation was removed |
Block activation with given ID. Activations can be blocked in ACTIVE state only. After successfully calling this method, activation is in BLOCKED state.
BlockActivationRequest
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
String |
reason |
Reason why activation is being blocked (default: NOT_SPECIFIED) |
BlockActivationResponse
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
ActivationStatus |
activationStatus |
An activation status |
String |
blockedReason |
Reason why activation was blocked (default: NOT_SPECIFIED) |
Unblock activation with given ID. Activations can be unblocked in BLOCKED state only. After successfully calling this method, activation is in ACTIVE state and failed attempt counter is set to 0.
UnblockActivationRequest
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
UnblockActivationResponse
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
ActivationStatus |
activationStatus |
An activation status |
Methods related to signature verification.
Verify signature correctness for given activation, application key, data and signature type.
VerifySignatureRequest
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
String |
applicationKey |
An key (identifier) of an application, associated with given application version |
String |
data |
Base64 encoded data for the signature |
String |
signature |
PowerAuth signature |
SignatureType |
signatureType |
PowerAuth signature type |
VerifySignatureResponse
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
String |
userId |
An identifier of a user |
Long |
applicationId |
An identifier of the application |
SignatureType |
signatureType |
Type of the signature that was used for the computation of the signature. |
ActivationStatus |
activationStatus |
An activation status |
String |
blockedReason |
Reason why activation was blocked (default: NOT_SPECIFIED) |
Integer |
remainingAttempts |
How many attempts are left for authentication using this activation |
Boolean |
signatureValid |
Indicates if the signature was correctly validated or if it was invalid (incorrect) |
Verify asymmetric ECDSA signature correctness for given activation and data.
VerifyECDSASignatureRequest
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
String |
data |
Base64 encoded data for the signature |
String |
signature |
Base64 encoded ECDSA signature |
VerifyECDSASignatureResponse
| Type | Name | Description |
|---|---|---|
Boolean |
signatureValid |
Indicates if the ECDSA signature was correctly validated or if it was invalid (incorrect) |
Create a data payload used as a challenge for personalized off-line signatures.
CreatePersonalizedOfflineSignaturePayloadRequest
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
String |
data |
Data for the signature, for normalized value see the Offline Signatures QR code documentation |
CreatePersonalizedOfflineSignaturePayloadResponse
| Type | Name | Description |
|---|---|---|
String |
offlineData |
Data for QR code in format: {DATA}\n{NONCE}\n{KEY_SERVER_PRIVATE_INDICATOR}{ECDSA_SIGNATURE}
|
String |
nonce |
Random cryptographic nonce, 16B encoded in Base64, same nonce as in offlineData (available separately for easy access) |
Create a data payload used as a challenge for non-personalized off-line signatures.
CreateNonPersonalizedOfflineSignaturePayloadRequest
| Type | Name | Description |
|---|---|---|
String |
applicationId |
An identifier of an application |
String |
data |
Data for the signature, for normalized value see the Offline Signatures QR code documentation |
CreateNonPersonalizedOfflineSignaturePayloadResponse
| Type | Name | Description |
|---|---|---|
String |
offlineData |
Data for QR code in format: {DATA}\n{NONCE}\n{KEY_MASTER_SERVER_PRIVATE_INDICATOR}{ECDSA_SIGNATURE}
|
String |
nonce |
Random cryptographic nonce, 16B encoded in Base64, same nonce as in offlineData (available separately for easy access) |
Verify off-line signature of provided data.
VerifyOfflineSignatureRequest
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
String |
data |
Base64 encoded data for the signature, normalized data for signatures. |
String |
signature |
Actual signature value. |
SignatureType |
signatureType |
Type of the signature |
VerifyOfflineSignatureResponse
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
String |
userId |
An identifier of a user |
Long |
applicationId |
An identifier of the application |
SignatureType |
signatureType |
Type of the signature that was used for the computation of the signature. |
ActivationStatus |
activationStatus |
An activation status |
String |
blockedReason |
Reason why activation was blocked (default: NOT_SPECIFIED) |
Integer |
remainingAttempts |
How many attempts are left for authentication using this activation |
Boolean |
signatureValid |
Indicates if the signature was correctly validated or if it was invalid (incorrect) |
Create a new token for the simple token-based authentication.
CreateTokenRequest
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation. |
SignatureType |
signatureType |
Type of the signature (factors) used for token creation. |
String |
ephemeralPublicKey |
Ephemeral public key used for request/response encryption. Base64 encoded bytes of the encoded public key. |
CreateTokenResponse
| Type | Name | Description |
|---|---|---|
String |
mac |
Data MAC value, Base64 encoded. |
String |
encryptedData |
Encrypted data, Base64 encoded bytes. |
Validate token digest used for the simple token-based authentication.
ValidateTokenRequest
| Type | Name | Description |
|---|---|---|
String |
tokenId |
An identifier of the token. |
String |
tokenDigest |
Digest computed during the token based authentication. |
String |
nonce |
Cryptographic nonce. Random 16B, Base64 encoded. |
Long |
timestamp |
Token digest timestamp, Unix timestamp format. |
ValidateTokenResponse
| Type | Name | Description |
|---|---|---|
Boolean |
tokenValid |
Information about the validation result - if true, token digest was valid. |
String |
activationId |
An identifier of an activation |
String |
userId |
An identifier of a user |
Long |
applicationId |
An identifier of the application |
SignatureType |
signatureType |
Type of the signature that was used for the computation of the signature. |
Remove token with given ID.
RemoveTokenRequest
| Type | Name | Description |
|---|---|---|
String |
tokenId |
An identifier of the token. |
RemoveTokenResponse
| Type | Name | Description |
|---|---|---|
Boolean |
removed |
True in case token was removed, false in case token with given ID was already not present. |
Methods related to secure vault.
Get the encrypted vault unlock key upon successful authentication using PowerAuth Signature.
VaultUnlockRequest
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
String |
applicationKey |
An key (identifier) of an application, associated with given application version |
String |
data |
Base64 encoded data for the signature |
String |
signature |
PowerAuth signature |
SignatureType |
signatureType |
PowerAuth signature type |
String |
reason |
Reason why vault is being unlocked (default: NOT_SPECIFIED) |
VaultUnlockResponse
| Type | Name | Description |
|---|---|---|
String |
activationId |
An identifier of an activation |
String |
userId |
An identifier of a user |
ActivationStatus |
activationStatus |
An activation status |
String |
blockedReason |
Reason why activation was blocked (default: NOT_SPECIFIED) |
Integer |
remainingAttempts |
How many attempts are left for authentication using this activation |
Boolean |
signatureValid |
Indicates if the signature was correctly validated or if it was invalid (incorrect) |
String |
encryptedVaultEncryptionKey |
Encrypted key for vault unlocking |
Methods related to signature auditing.
Get the signature audit log for given user, application and date range. In case no application ID is provided, event log for all applications is returned.
SignatureAuditRequest
| Type | Name | Description |
|---|---|---|
String |
userId |
An identifier of a user |
Long |
applicationId |
An identifier of an application |
DateTime |
timestampFrom |
Timestamp from which to fetch the log |
DateTime |
timestampTo |
Timestamp to which to fetch the log |
SignatureAuditResponse
| Type | Name | Description |
|---|---|---|
Item[] |
items |
Collection of signature audit logs |
SignatureAuditResponse.Item
| Type | Name | Description |
|---|---|---|
Long |
id |
Record ID |
String |
userId |
An identifier of a user |
Long |
applicationId |
An identifier of an application |
String |
activationId |
An identifier of an activation |
Long |
activationCounter |
A counter value at the moment of a signature verification |
ActivationStatus |
activationStatus |
An activation status at the moment of a signature verification |
KeyValueMap |
additionalInfo |
Key-value map with additional information |
String |
dataBase64 |
A base64 encoded data sent with the signature |
SignatureType |
signatureType |
Requested signature type |
String |
signature |
Submitted value of a signature |
String |
note |
Extra info about the result of the signature verification |
Boolean |
valid |
Flag indicating if the provided signature was valid |
DateTime |
timestampCreated |
Timestamp when the record was created |
Get activation status change log.
Get the status change log for given activation and date range.
ActivationHistoryRequest
| Type | Name | Description |
|---|---|---|
String |
activationId |
Activation ID |
DateTime |
timestampFrom |
Timestamp from which to fetch the changes |
DateTime |
timestampTo |
Timestamp to which to fetch the changes |
ActivationHistoryResponse
| Type | Name | Description |
|---|---|---|
Item[] |
items |
Collection of activation change logs |
ActivationHistoryResponse.Item
| Type | Name | Description |
|---|---|---|
Long |
id |
Change ID |
String |
activationId |
An identifier of an activation |
ActivationStatus |
activationStatus |
An activation status at the moment of a signature verification |
DateTime |
timestampCreated |
Timestamp when the record was created |
Methods used for managing integration credentials for PowerAuth Server.
Create a new integration with given name, automatically generate credentials for the integration.
CreateIntegrationRequest
| Type | Name | Description |
|---|---|---|
String |
name |
New integration name. |
CreateIntegrationResponse
| Type | Name | Description |
|---|---|---|
String |
id |
Integration identifier (UUID4). |
String |
name |
A name of the integration. |
String |
clientToken |
An integration client token (serves as a "username"). |
String |
clientSecret |
An integration client secret (serves as a "password"). |
Get the list of all integrations that are configured on the server instance.
GetIntegrationListRequest
- no attributes
GetIntegrationListResponse
| Type | Name | Description |
|---|---|---|
Item[] |
items |
Collection of integration records. |
GetIntegrationListResponse.Item
| Type | Name | Description |
|---|---|---|
String |
id |
Integration identifier (UUID4). |
String |
name |
A name of the integration. |
String |
clientToken |
An integration client token (serves as a "username"). |
String |
clientSecret |
An integration client secret (serves as a "password"). |
Remove integration with given ID.
RemoveIntegrationRequest
| Type | Name | Description |
|---|---|---|
String |
id |
ID of an integration to be removed. |
RemoveIntegrationResponse
| Type | Name | Description |
|---|---|---|
String |
id |
ID of an integration to be removed. |
Boolean |
removed |
Flag specifying if an integration was removed or not. |
Creates a callback URL with given parameters.
CreateCallbackUrlRequest
| Type | Name | Description |
|---|---|---|
Long |
applicationId |
Associated application ID. |
String |
name |
Callback URL name, for visual identification. |
String |
callbackUrl |
Callback URL that should be notified about activation status updates. |
CreateCallbackUrlResponse
| Type | Name | Description |
|---|---|---|
String |
id |
Callback URL identifier (UUID4). |
Long |
applicationId |
Associated application ID. |
String |
name |
Callback URL name, for visual identification. |
String |
callbackUrl |
Callback URL that should be notified about activation status updates. |
Get the list of all callbacks for given application.
GetCallbackUrlListRequest
| Type | Name | Description |
|---|---|---|
Long |
applicationId |
Application ID for which to fetch callback URLs. |
GetCallbackUrlListResponse
| Type | Name | Description |
|---|---|---|
CallbackUrlList[] |
callbackUrlList |
Callback URL list. |
GetCallbackUrlListResponse.CallbackUrlList
| Type | Name | Description |
|---|---|---|
String |
id |
Callback URL identifier (UUID4). |
Long |
applicationId |
Associated application ID. |
String |
name |
Callback URL name, for visual identification. |
String |
callbackUrl |
Callback URL that should be notified about activation status updates. |
Remove callback URL with given ID.
RemoveCallbackUrlRequest
| Type | Name | Description |
|---|---|---|
String |
id |
ID of an callback URL to be removed. |
RemoveCallbackUrlResponse
| Type | Name | Description |
|---|---|---|
String |
id |
ID of an callback URL to be removed. |
Boolean |
removed |
Flag specifying if a callback URL was removed or not. |
Methods used for establishing a context for end-to-end encryption.
Establishes a context required for performing a non-personalized (application specific) end-to-end encryption.
GetNonPersonalizedEncryptionKeyRequest
| Type | Name | Description |
|---|---|---|
String |
applicationKey |
Application version identification |
String |
sessionIndex |
Random session index used to generate session based key, in case null is provided, encryptionKeyIndex will be autogenerated in response. |
String |
ephemeralPublicKey |
Ephemeral public key used for deriving a shared secret. |
GetNonPersonalizedEncryptionKeyResponse
| Type | Name | Description |
|---|---|---|
String |
applicationKey |
Application version identification |
Long |
applicationId |
Application ID associated with provided version |
String |
encryptionKeyIndex |
Session index used to generate session based key. |
String |
encryptionKey |
Derived key used as a base for ad-hoc key derivation. |
String |
ephemeralPublicKey |
Ephemeral public key used for deriving a shared secret. |
Establishes a context required for performing a personalized (activation specific) end-to-end encryption.
GetPersonalizedEncryptionKeyRequest
| Type | Name | Description |
|---|---|---|
String |
activationId |
Activation ID |
String |
sessionIndex |
Random session index used to generate session based key, in case null is provided, encryptionKeyIndex will be autogenerated in response. |
GetPersonalizedEncryptionKeyResponse
| Type | Name | Description |
|---|---|---|
String |
activationId |
Activation ID |
String |
encryptionKeyIndex |
Session index used to generate session based key. |
String |
encryptionKey |
Derived key used as a base for ad-hoc key derivation. |
This chapter lists all enums used by PowerAuth Server SOAP service.
-
ActivationStatus- Represents the status of activation, one of the following values:- CREATED
- OTP_USED
- ACTIVE
- BLOCKED
- REMOVED
-
SignatureType- Represents the type of the signature, one of the following values:- POSSESSION
- KNOWLEDGE
- BIOMETRY
- POSSESSION_KNOWLEDGE
- POSSESSION_BIOMETRY
- POSSESSION_KNOWLEDGE_BIOMETRY
This chapter lists complex types used by PowerAuth Server SOAP service.
-
KeyValueMap- Represents a map for storing key-value entries:- entry - list of entries (0..n)
- key - String-based key
- value - String-based value
- entry - list of entries (0..n)
When adding documentation for a new method, use this template:
Lorem ipsum description.
RequestObject
| Type | Name | Description |
|---|---|---|
Long |
applicationId |
Lorem ipsum |
ResponseObject
| Type | Name | Description |
|---|---|---|
Long |
applicationVersionId |
Lorem ipsum |
If you need any assistance, do not hesitate to drop us a line at [email protected].
Deployment Tutorials
Integration Tutorials
Reference Manual
Additional Topics