Token endpoints
ActivateToken
ActivateToken(System.String,System.Boolean,System.String,System.String)
Activates a suspended token and optionally forces a PIN change/resets the current PIN.
Parameters
Param: serial: Token serial number to activate
Param: changePinOnFirstUse: True if the user is required to change their PIN during the next authentication.
Param: newPIN: Optional argument to set a new PIN for the token.
Param: organization: Account
Returns
| pinSuccess | Activating the token and setting new PIN for the token has successfully completed |
| deletestaticFail | Cannot delete assigned static password, so activating token has failed |
| newpinFail | Activating the token was successful, but setting new PIN for the token has failed |
| fail | Activating the token has failed for an unknown reason |
| success | The token has been activated |
| tokenNotFound | |
| tokenNotAssigned |
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/ActivateToken"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ActivateToken xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<changePinOnFirstUse>boolean</changePinOnFirstUse>
<newPIN>string</newPIN>
<organization>string</organization>
</ActivateToken>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ActivateTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<ActivateTokenResult>pinSuccess or deletestaticFail or newpinFail or fail or success or tokenNotFound or tokenNotAssigned</ActivateTokenResult>
</ActivateTokenResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<ActivateToken xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<changePinOnFirstUse>boolean</changePinOnFirstUse>
<newPIN>string</newPIN>
<organization>string</organization>
</ActivateToken>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<ActivateTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<ActivateTokenResult>pinSuccess or deletestaticFail or newpinFail or fail or success or tokenNotFound or tokenNotAssigned</ActivateTokenResult>
</ActivateTokenResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/ActivateToken?serial=string&changePinOnFirstUse=string&newPIN=string&organization=string HTTP/1.1
Host: cloud.eu.safenetid.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<activateResult xmlns="http://www.cryptocard.com/blackshield/">pinSuccess or deletestaticFail or newpinFail or fail or success or tokenNotFound or tokenNotAssigned</activateResult>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/ActivateToken HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
serial=string&changePinOnFirstUse=string&newPIN=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<activateResult xmlns="http://www.cryptocard.com/blackshield/">pinSuccess or deletestaticFail or newpinFail or fail or success or tokenNotFound or tokenNotAssigned</activateResult>
AssignToken
AssignToken(System.String,System.String,System.String)
Assigns a token to a user.
Parameters
Param: userName: User to assign the token to.
Param: serial: Serial of the token to assign.
Param: organization: Account
Returns
| Success | |
| Fail | Unknown failure | AlreadyHasCustomCR | The user already has a challenge response token that is incompatible with the token you are trying to assign |
| AlreadyHasSMSCR | The user already has a challenge response SMS token that is incompatible with the token you are trying to assign |
| ConflictingToken | The user already has a token that is not compatible with the token you are trying to assign. |
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/AssignToken"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AssignToken xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<serial>string</serial>
<organization>string</organization>
</AssignToken>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AssignTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<AssignTokenResult>Success or Fail or AlreadyHasCustomCR or AlreadyHasSMSCR or ConflictingToken or TokenHasBeenRestricted</AssignTokenResult>
</AssignTokenResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AssignToken xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<serial>string</serial>
<organization>string</organization>
</AssignToken>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AssignTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<AssignTokenResult>Success or Fail or AlreadyHasCustomCR or AlreadyHasSMSCR or ConflictingToken or TokenHasBeenRestricted</AssignTokenResult>
</AssignTokenResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/AssignToken?userName=string&serial=string&organization=string HTTP/1.1
Host: cloud.eu.safenetid.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<assignResult xmlns="http://www.cryptocard.com/blackshield/">Success or Fail or AlreadyHasCustomCR or AlreadyHasSMSCR or ConflictingToken or TokenHasBeenRestricted</assignResult>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/AssignToken HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
userName=string&serial=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<assignResult xmlns="http://www.cryptocard.com/blackshield/">Success or Fail or AlreadyHasCustomCR or AlreadyHasSMSCR or ConflictingToken or TokenHasBeenRestricted</assignResult>
ConfirmRequestToken
ConfirmRequestToken(System.Int32,System.String,System.String)
Mark a token request as confirmed.
Parameters
Param: requestID: Request ID to confirm
Param: userName:
Param: organization: Account
Returns
- True if confirmed
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/ConfirmRequestToken"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ConfirmRequestToken xmlns="http://www.cryptocard.com/blackshield/">
<requestID>int</requestID>
<userName>string</userName>
<organization>string</organization>
</ConfirmRequestToken>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ConfirmRequestTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<ConfirmRequestTokenResult>boolean</ConfirmRequestTokenResult>
</ConfirmRequestTokenResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<ConfirmRequestToken xmlns="http://www.cryptocard.com/blackshield/">
<requestID>int</requestID>
<userName>string</userName>
<organization>string</organization>
</ConfirmRequestToken>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<ConfirmRequestTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<ConfirmRequestTokenResult>boolean</ConfirmRequestTokenResult>
</ConfirmRequestTokenResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/ConfirmRequestToken?requestID=string&userName=string&organization=string HTTP/1.1
Host: cloud.eu.safenetid.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.cryptocard.com/blackshield/">boolean</boolean>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/ConfirmRequestToken HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
requestID=string&userName=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.cryptocard.com/blackshield/">boolean</boolean>
GetChallengeImage
GetChallengeImage(System.String,System.String)
Returns a JPG image for custom token challenges (if applicable).
Parameters
Param: userName: User to get the challenge for.
Param: organization: Account
Returns
A JPG image if the user has a token that returns challenge images.
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetChallengeImage"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetChallengeImage xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<organization>string</organization>
</GetChallengeImage>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetChallengeImageResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetChallengeImageResult>base64Binary</GetChallengeImageResult>
</GetChallengeImageResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetChallengeImage xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<organization>string</organization>
</GetChallengeImage>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetChallengeImageResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetChallengeImageResult>base64Binary</GetChallengeImageResult>
</GetChallengeImageResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/GetChallengeImage?userName=string&organization=string HTTP/1.1
Host: cloud.eu.safenetid.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<base64Binary xmlns="http://www.cryptocard.com/blackshield/">base64Binary</base64Binary>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/GetChallengeImage HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
userName=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<base64Binary xmlns="http://www.cryptocard.com/blackshield/">base64Binary</base64Binary>
GetFixSerial
GetFixSerial(System.String,System.String,System.String)
Converts a user input serial number into a server serial number using any custom type tokens that a user has as a reference point. Used when asking a user to input a serial number into a self service style web page.
Parameters
Param: userName: User Name of the user that is using the self service style page.
Param: serial: The serial as input by the user.
Param: organization: Account
Returns
The serial number as formatted to match any custom token the user has
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetFixSerial"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetFixSerial xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<serial>string</serial>
<organization>string</organization>
</GetFixSerial>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetFixSerialResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetFixSerialResult>string</GetFixSerialResult>
</GetFixSerialResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetFixSerial xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<serial>string</serial>
<organization>string</organization>
</GetFixSerial>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetFixSerialResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetFixSerialResult>string</GetFixSerialResult>
</GetFixSerialResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/GetFixSerial?userName=string&serial=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://www.cryptocard.com/blackshield/">string</string>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/GetFixSerial HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
userName=string&serial=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://www.cryptocard.com/blackshield/">string</string>
GetToken
GetToken(System.String,System.String)
Get a token.
Parameters
Param: serial: Serial number of the token.
Param: organization: Account
Returns
The token object
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetToken"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetToken xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<organization>string</organization>
</GetToken>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenResult>
<challengeIssued>boolean</challengeIssued>
<isICEToken>boolean</isICEToken>
<OwnerName>string</OwnerName>
<Organization>string</Organization>
<OwningOrganization>string</OwningOrganization>
<State>BASE_INVENTORY or NOT_INITIALIZED or REVOKED or INITIALIZED or CORRUPTED_INVENTORY or BASE_ALLOCATED or ALLOCATED or BASE_ASSIGNED or MANUALLY_ASSIGNED or ENROLLED_PIN_CHANGE or ENROLLMENT_PENDING or BASE_ACTIVE or ACTIVE_TOKEN or PIN_CHANGE or BASE_SUSPENDED or MANUAL_SUSPENSION or RULE_SUSPENSION or BASE_LOCKED or SERVER_LOCK or USER_LOCK or PIN_CHANGE_LOCK or CORRUPTED or BASE_LOST_FAILED or LOST_TOKEN or DAMAGED_TOKEN or BASE_DELETED or MANUAL_REMOVE or AUTO_REMOVE or BASE_PURGED or PURGED_TOKEN</State>
<PINSetDate>string</PINSetDate>
<ActivationTime>string</ActivationTime>
<UnlockTime>string</UnlockTime>
<StateSetDate>string</StateSetDate>
<LastAuthDate>string</LastAuthDate>
<LastSuccessDate>string</LastSuccessDate>
<Inittime>string</Inittime>
<Display>string</Display>
<OTPTTL>int</OTPTTL>
<OtpLength>int</OtpLength>
<ActivationCount>int</ActivationCount>
<EncryptionKey>base64Binary</EncryptionKey>
<NonHSMKey>base64Binary</NonHSMKey>
<ChallengeBase>base64Binary</ChallengeBase>
<AuthAttempts>int</AuthAttempts>
<Message>string</Message>
<LastChallengeDate>string</LastChallengeDate>
<ExpiryDate>string</ExpiryDate>
<IsTimeBased>boolean</IsTimeBased>
<TimeInterval>int</TimeInterval>
<AuthVersion>GOLD or CUSTOM or OATH or V4 or V5 or V6 or V7</AuthVersion>
<ContainerName>string</ContainerName>
<DeviceName>string</DeviceName>
</GetTokenResult>
</GetTokenResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetToken xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<organization>string</organization>
</GetToken>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenResult>
<challengeIssued>boolean</challengeIssued>
<isICEToken>boolean</isICEToken>
<OwnerName>string</OwnerName>
<Organization>string</Organization>
<OwningOrganization>string</OwningOrganization>
<State>BASE_INVENTORY or NOT_INITIALIZED or REVOKED or INITIALIZED or CORRUPTED_INVENTORY or BASE_ALLOCATED or ALLOCATED or BASE_ASSIGNED or MANUALLY_ASSIGNED or ENROLLED_PIN_CHANGE or ENROLLMENT_PENDING or BASE_ACTIVE or ACTIVE_TOKEN or PIN_CHANGE or BASE_SUSPENDED or MANUAL_SUSPENSION or RULE_SUSPENSION or BASE_LOCKED or SERVER_LOCK or USER_LOCK or PIN_CHANGE_LOCK or CORRUPTED or BASE_LOST_FAILED or LOST_TOKEN or DAMAGED_TOKEN or BASE_DELETED or MANUAL_REMOVE or AUTO_REMOVE or BASE_PURGED or PURGED_TOKEN</State>
<PINSetDate>string</PINSetDate>
<ActivationTime>string</ActivationTime>
<UnlockTime>string</UnlockTime>
<StateSetDate>string</StateSetDate>
<LastAuthDate>string</LastAuthDate>
<LastSuccessDate>string</LastSuccessDate>
<Inittime>string</Inittime>
<Display>string</Display>
<OTPTTL>int</OTPTTL>
<OtpLength>int</OtpLength>
<ActivationCount>int</ActivationCount>
<EncryptionKey>base64Binary</EncryptionKey>
<NonHSMKey>base64Binary</NonHSMKey>
<ChallengeBase>base64Binary</ChallengeBase>
<AuthAttempts>int</AuthAttempts>
<Message>string</Message>
<LastChallengeDate>string</LastChallengeDate>
<ExpiryDate>string</ExpiryDate>
<IsTimeBased>boolean</IsTimeBased>
<TimeInterval>int</TimeInterval>
<AuthVersion>GOLD or CUSTOM or OATH or V4 or V5 or V6 or V7</AuthVersion>
<ContainerName>string</ContainerName>
<DeviceName>string</DeviceName>
</GetTokenResult>
</GetTokenResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/GetToken?serial=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<Token xmlns="http://www.cryptocard.com/blackshield/">
<challengeIssued>boolean</challengeIssued>
<isICEToken>boolean</isICEToken>
<OwnerName>string</OwnerName>
<Organization>string</Organization>
<OwningOrganization>string</OwningOrganization>
<State>BASE_INVENTORY or NOT_INITIALIZED or REVOKED or INITIALIZED or CORRUPTED_INVENTORY or BASE_ALLOCATED or ALLOCATED or BASE_ASSIGNED or MANUALLY_ASSIGNED or ENROLLED_PIN_CHANGE or ENROLLMENT_PENDING or BASE_ACTIVE or ACTIVE_TOKEN or PIN_CHANGE or BASE_SUSPENDED or MANUAL_SUSPENSION or RULE_SUSPENSION or BASE_LOCKED or SERVER_LOCK or USER_LOCK or PIN_CHANGE_LOCK or CORRUPTED or BASE_LOST_FAILED or LOST_TOKEN or DAMAGED_TOKEN or BASE_DELETED or MANUAL_REMOVE or AUTO_REMOVE or BASE_PURGED or PURGED_TOKEN</State>
<PINSetDate>string</PINSetDate>
<ActivationTime>string</ActivationTime>
<UnlockTime>string</UnlockTime>
<StateSetDate>string</StateSetDate>
<LastAuthDate>string</LastAuthDate>
<LastSuccessDate>string</LastSuccessDate>
<Inittime>string</Inittime>
<Display>string</Display>
<OTPTTL>int</OTPTTL>
<OtpLength>int</OtpLength>
<ActivationCount>int</ActivationCount>
<EncryptionKey>base64Binary</EncryptionKey>
<NonHSMKey>base64Binary</NonHSMKey>
<ChallengeBase>base64Binary</ChallengeBase>
<AuthAttempts>int</AuthAttempts>
<Message>string</Message>
<LastChallengeDate>string</LastChallengeDate>
<ExpiryDate>string</ExpiryDate>
<IsTimeBased>boolean</IsTimeBased>
<TimeInterval>int</TimeInterval>
<AuthVersion>GOLD or CUSTOM or OATH or V4 or V5 or V6 or V7</AuthVersion>
<ContainerName>string</ContainerName>
<DeviceName>string</DeviceName>
</Token>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/GetToken HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
serial=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<Token xmlns="http://www.cryptocard.com/blackshield/">
<challengeIssued>boolean</challengeIssued>
<isICEToken>boolean</isICEToken>
<OwnerName>string</OwnerName>
<Organization>string</Organization>
<OwningOrganization>string</OwningOrganization>
<State>BASE_INVENTORY or NOT_INITIALIZED or REVOKED or INITIALIZED or CORRUPTED_INVENTORY or BASE_ALLOCATED or ALLOCATED or BASE_ASSIGNED or MANUALLY_ASSIGNED or ENROLLED_PIN_CHANGE or ENROLLMENT_PENDING or BASE_ACTIVE or ACTIVE_TOKEN or PIN_CHANGE or BASE_SUSPENDED or MANUAL_SUSPENSION or RULE_SUSPENSION or BASE_LOCKED or SERVER_LOCK or USER_LOCK or PIN_CHANGE_LOCK or CORRUPTED or BASE_LOST_FAILED or LOST_TOKEN or DAMAGED_TOKEN or BASE_DELETED or MANUAL_REMOVE or AUTO_REMOVE or BASE_PURGED or PURGED_TOKEN</State>
<PINSetDate>string</PINSetDate>
<ActivationTime>string</ActivationTime>
<UnlockTime>string</UnlockTime>
<StateSetDate>string</StateSetDate>
<LastAuthDate>string</LastAuthDate>
<LastSuccessDate>string</LastSuccessDate>
<Inittime>string</Inittime>
<Display>string</Display>
<OTPTTL>int</OTPTTL>
<OtpLength>int</OtpLength>
<ActivationCount>int</ActivationCount>
<EncryptionKey>base64Binary</EncryptionKey>
<NonHSMKey>base64Binary</NonHSMKey>
<ChallengeBase>base64Binary</ChallengeBase>
<AuthAttempts>int</AuthAttempts>
<Message>string</Message>
<LastChallengeDate>string</LastChallengeDate>
<ExpiryDate>string</ExpiryDate>
<IsTimeBased>boolean</IsTimeBased>
<TimeInterval>int</TimeInterval>
<AuthVersion>GOLD or CUSTOM or OATH or V4 or V5 or V6 or V7</AuthVersion>
<ContainerName>string</ContainerName>
<DeviceName>string</DeviceName>
</Token>
GetTokenChallenge
GetTokenChallenge(System.String,System.String,System.String,System.String@)
Gets a challenge to use for resyncing a token.
Parameters
Param: serial: Serial number of the token.
Param: userName: User the token is assigned to.
Param: organization: Account
Param: state: The challenge state.
Returns
Challenge string
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetTokenChallenge"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokenChallenge xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<userName>string</userName>
<organization>string</organization>
</GetTokenChallenge>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokenChallengeResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenChallengeResult>string</GetTokenChallengeResult>
<state>string</state>
</GetTokenChallengeResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokenChallenge xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<userName>string</userName>
<organization>string</organization>
</GetTokenChallenge>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokenChallengeResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenChallengeResult>string</GetTokenChallengeResult>
<state>string</state>
</GetTokenChallengeResponse>
</soap12:Body>
</soap12:Envelope>
GetTokenEventCounter
GetTokenEventCounter(System.string,System.string)
Gets the token event counter value for a token. For Event-Based tokens, pass in the serial number and the org name.
Parameters
Param: :serial: Serial number of the token.
Param: organization: Account
Returns
Token Event Counter - To be used, the user will require the serial number of the Token and the Organization
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetTokenEventCounter"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokenEventCounter xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<organization>string</organization>
</GetTokenEventCounter>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokenEventCounterResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenEventCounterResult>long</GetTokenEventCounterResult>
</GetTokenEventCounterResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokenEventCounter xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<organization>string</organization>
</GetTokenEventCounter>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokenEventCounterResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenEventCounterResult>long</GetTokenEventCounterResult>
</GetTokenEventCounterResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/GetTokenEventCounter?serial=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<long xmlns="http://www.cryptocard.com/blackshield/">long</long>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/GetTokenEventCounter HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
serial=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<long xmlns="http://www.cryptocard.com/blackshield/">long</long>
GetTokenRequestTable
GetTokenRequestTable(System.String)
Gets a table of token types that are requestable.
Parameter
Param: organization: Account
Returns
A table with the following columns:
-
text
-
tokentype
-
enable
-
subtarget
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetTokenRequestTable"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokenRequestTable xmlns="http://www.cryptocard.com/blackshield/">
<organization>string</organization>
</GetTokenRequestTable>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokenRequestTableResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenRequestTableResult>
<xsd:schema>schema</xsd:schema>xml</GetTokenRequestTableResult>
</GetTokenRequestTableResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokenRequestTable xmlns="http://www.cryptocard.com/blackshield/">
<organization>string</organization>
</GetTokenRequestTable>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokenRequestTableResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenRequestTableResult>
<xsd:schema>schema</xsd:schema>xml</GetTokenRequestTableResult>
</GetTokenRequestTableResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/GetTokenRequestTable?organization=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<DataSet xmlns="http://www.cryptocard.com/blackshield/">
<schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</DataSet>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/GetTokenRequestTable HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<DataSet xmlns="http://www.cryptocard.com/blackshield/">
<schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</DataSet>
GetTokenSubTargets
GetTokenSubTargets(DataLayer.Entity.Token.TokenTargets,System.String)
Gets a list of available sub targets for the desired software target.
Parameters
Param: target: Target to check sub targets for.
Param: code: ENrollment code
Returns
- List of sub targets for a given target type
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetTokenSubTargets"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokenSubTargets xmlns="http://www.cryptocard.com/blackshield/">
<target>HardDrive or SmartCard or SecureFlashDrive or MobilePhone or Blackberry or iPhone or Android or WindowsPhone7 or MacOSX or ChromeOs</target>
<code>string</code>
</GetTokenSubTargets>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokenSubTargetsResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenSubTargetsResult>
<TokenSubTarget>
<Image>base64Binary</Image>
<Title>string</Title>
<TargetText>string</TargetText>
<Description>string</Description>
<DownloadNotes>string</DownloadNotes>
<RemovalMessage>string</RemovalMessage>
</TokenSubTarget>
<TokenSubTarget>
<Image>base64Binary</Image>
<Title>string</Title>
<TargetText>string</TargetText>
<Description>string</Description>
<DownloadNotes>string</DownloadNotes>
<RemovalMessage>string</RemovalMessage>
</TokenSubTarget>
</GetTokenSubTargetsResult>
</GetTokenSubTargetsResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokenSubTargets xmlns="http://www.cryptocard.com/blackshield/">
<target>HardDrive or SmartCard or SecureFlashDrive or MobilePhone or Blackberry or iPhone or Android or WindowsPhone7 or MacOSX or ChromeOs</target>
<code>string</code>
</GetTokenSubTargets>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokenSubTargetsResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenSubTargetsResult>
<TokenSubTarget>
<Image>base64Binary</Image>
<Title>string</Title>
<TargetText>string</TargetText>
<Description>string</Description>
<DownloadNotes>string</DownloadNotes>
<RemovalMessage>string</RemovalMessage>
</TokenSubTarget>
<TokenSubTarget>
<Image>base64Binary</Image>
<Title>string</Title>
<TargetText>string</TargetText>
<Description>string</Description>
<DownloadNotes>string</DownloadNotes>
<RemovalMessage>string</RemovalMessage>
</TokenSubTarget>
</GetTokenSubTargetsResult>
</GetTokenSubTargetsResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/GetTokenSubTargets?target=string&code=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTokenSubTarget xmlns="http://www.cryptocard.com/blackshield/">
<TokenSubTarget>
<Image>base64Binary</Image>
<Title>string</Title>
<TargetText>string</TargetText>
<Description>string</Description>
<DownloadNotes>string</DownloadNotes>
<RemovalMessage>string</RemovalMessage>
</TokenSubTarget>
<TokenSubTarget>
<Image>base64Binary</Image>
<Title>string</Title>
<TargetText>string</TargetText>
<Description>string</Description>
<DownloadNotes>string</DownloadNotes>
<RemovalMessage>string</RemovalMessage>
</TokenSubTarget>
</ArrayOfTokenSubTarget>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/GetTokenSubTargets HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
target=string&code=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTokenSubTarget xmlns="http://www.cryptocard.com/blackshield/">
<TokenSubTarget>
<Image>base64Binary</Image>
<Title>string</Title>
<TargetText>string</TargetText>
<Description>string</Description>
<DownloadNotes>string</DownloadNotes>
<RemovalMessage>string</RemovalMessage>
</TokenSubTarget>
<TokenSubTarget>
<Image>base64Binary</Image>
<Title>string</Title>
<TargetText>string</TargetText>
<Description>string</Description>
<DownloadNotes>string</DownloadNotes>
<RemovalMessage>string</RemovalMessage>
</TokenSubTarget>
</ArrayOfTokenSubTarget>
GetTokenTargets
GetTokenTargets(System.String)
Gets a list of available targets for a software token when prompted to select a token target.
Parameters
Param: code: Enrollment code
Returns
- List of token targets available for this provisioning code
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetTokenTargets"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokenTargets xmlns="http://www.cryptocard.com/blackshield/">
<code>string</code>
</GetTokenTargets>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokenTargetsResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenTargetsResult>
<TokenTarget>
<Image>base64Binary</Image>
<TargetAllowed>boolean</TargetAllowed>
<Target>HardDrive or SmartCard or SecureFlashDrive or MobilePhone or Blackberry or iPhone or Android or WindowsPhone7 or MacOSX or ChromeOs</Target>
<TargetText>string</TargetText>
</TokenTarget>
<TokenTarget>
<Image>base64Binary</Image>
<TargetAllowed>boolean</TargetAllowed>
<Target>HardDrive or SmartCard or SecureFlashDrive or MobilePhone or Blackberry or iPhone or Android or WindowsPhone7 or MacOSX or ChromeOs</Target>
<TargetText>string</TargetText>
</TokenTarget>
</GetTokenTargetsResult>
</GetTokenTargetsResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokenTargets xmlns="http://www.cryptocard.com/blackshield/">
<code>string</code>
</GetTokenTargets>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokenTargetsResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenTargetsResult>
<TokenTarget>
<Image>base64Binary</Image>
<TargetAllowed>boolean</TargetAllowed>
<Target>HardDrive or SmartCard or SecureFlashDrive or MobilePhone or Blackberry or iPhone or Android or WindowsPhone7 or MacOSX or ChromeOs</Target>
<TargetText>string</TargetText>
</TokenTarget>
<TokenTarget>
<Image>base64Binary</Image>
<TargetAllowed>boolean</TargetAllowed>
<Target>HardDrive or SmartCard or SecureFlashDrive or MobilePhone or Blackberry or iPhone or Android or WindowsPhone7 or MacOSX or ChromeOs</Target>
<TargetText>string</TargetText>
</TokenTarget>
</GetTokenTargetsResult>
</GetTokenTargetsResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/GetTokenTargets?code=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTokenTarget xmlns="http://www.cryptocard.com/blackshield/">
<TokenTarget>
<Image>base64Binary</Image>
<TargetAllowed>boolean</TargetAllowed>
<Target>HardDrive or SmartCard or SecureFlashDrive or MobilePhone or Blackberry or iPhone or Android or WindowsPhone7 or MacOSX or ChromeOs</Target>
<TargetText>string</TargetText>
</TokenTarget>
<TokenTarget>
<Image>base64Binary</Image>
<TargetAllowed>boolean</TargetAllowed>
<Target>HardDrive or SmartCard or SecureFlashDrive or MobilePhone or Blackberry or iPhone or Android or WindowsPhone7 or MacOSX or ChromeOs</Target>
<TargetText>string</TargetText>
</TokenTarget>
</ArrayOfTokenTarget>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/GetTokenTargets HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
code=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTokenTarget xmlns="http://www.cryptocard.com/blackshield/">
<TokenTarget>
<Image>base64Binary</Image>
<TargetAllowed>boolean</TargetAllowed>
<Target>HardDrive or SmartCard or SecureFlashDrive or MobilePhone or Blackberry or iPhone or Android or WindowsPhone7 or MacOSX or ChromeOs</Target>
<TargetText>string</TargetText>
</TokenTarget>
<TokenTarget>
<Image>base64Binary</Image>
<TargetAllowed>boolean</TargetAllowed>
<Target>HardDrive or SmartCard or SecureFlashDrive or MobilePhone or Blackberry or iPhone or Android or WindowsPhone7 or MacOSX or ChromeOs</Target>
<TargetText>string</TargetText>
</TokenTarget>
</ArrayOfTokenTarget>
GetTokenTemplateForToken
GetTokenTemplateForToken(System.String,System.String)
Get the template settings for a token.
Parameters
Param: serial: Serial number of the token.
Param: organization: Account
Returns
Token template that describes the function of the token
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetTokenTemplateForToken"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokenTemplateForToken xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<organization>string</organization>
</GetTokenTemplateForToken>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokenTemplateForTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenTemplateForTokenResult>
<initialPIN>NONE or RANDOM or SET</initialPIN>
<otpMode>QUICKLOG or CHALLENGE_RESPONSE</otpMode>
<otpComplexity>DECIMAL or HEX or BASE32 or BASE64</otpComplexity>
<mask>NONE or PHONE</mask>
<PINComplexity>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</PINComplexity>
<PINReuse>boolean</PINReuse>
<MK2Algorithm>boolean</MK2Algorithm>
<allowTrivialPIN>boolean</allowTrivialPIN>
<allowBiometricPIN>boolean</allowBiometricPIN>
<display>boolean</display>
<manualOff>boolean</manualOff>
<DefaultTok>boolean</DefaultTok>
<TokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</TokenType>
<encryption>DES or AES or TRIPLE_DES or OATH or OATH256 or Oath512</encryption>
<InitialSetPIN>string</InitialSetPIN>
<OTPLen>int</OTPLen>
<MultipleOTPperCycle>boolean</MultipleOTPperCycle>
<PINSide>NONE or TOKEN or SERVER or BOTH</PINSide>
<MinPINLen>int</MinPINLen>
<MaxPINLen>int</MaxPINLen>
<PINType>NONE or USER_CHANGEABLE or SERVER_CHANGEABLE or FIXED</PINType>
<PINAttempts>int</PINAttempts>
<UserChangePIN>int</UserChangePIN>
<AutoOff>int</AutoOff>
<KeyLength>int</KeyLength>
<ModelNumber>int</ModelNumber>
<FirmwareVersion>string</FirmwareVersion>
<AuthVersion>GOLD or CUSTOM or OATH or V4 or V5 or V6 or V7</AuthVersion>
<RandomPINLength>int</RandomPINLength>
<CanUnlock>boolean</CanUnlock>
<TimeBased>boolean</TimeBased>
<TimeInterval>int</TimeInterval>
<OTPProtectiveSuspendDelay>TwoSeconds or TenSeconds or ThirtySeconds or SixtySeconds</OTPProtectiveSuspendDelay>
<ExtendedOptions>
<WizardInput>
<Name>string</Name>
<Title>string</Title>
<Value />
<Values xsi:nil="true" />
<DefaultValue />
<GroupNumber>int</GroupNumber>
<Example>string</Example>
<OptionallyEnabled>boolean</OptionallyEnabled>
<Optional>boolean</Optional>
<MaxCount>int</MaxCount>
<Delimiter>char</Delimiter>
<ListIndex>int</ListIndex>
<MinimumValue>int</MinimumValue>
<MaximumValue>int</MaximumValue>
</WizardInput>
<WizardInput>
<Name>string</Name>
<Title>string</Title>
<Value />
<Values xsi:nil="true" />
<DefaultValue />
<GroupNumber>int</GroupNumber>
<Example>string</Example>
<OptionallyEnabled>boolean</OptionallyEnabled>
<Optional>boolean</Optional>
<MaxCount>int</MaxCount>
<Delimiter>char</Delimiter>
<ListIndex>int</ListIndex>
<MinimumValue>int</MinimumValue>
<MaximumValue>int</MaximumValue>
</WizardInput>
</ExtendedOptions>
</GetTokenTemplateForTokenResult>
</GetTokenTemplateForTokenResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokenTemplateForToken xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<organization>string</organization>
</GetTokenTemplateForToken>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokenTemplateForTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenTemplateForTokenResult>
<initialPIN>NONE or RANDOM or SET</initialPIN>
<otpMode>QUICKLOG or CHALLENGE_RESPONSE</otpMode>
<otpComplexity>DECIMAL or HEX or BASE32 or BASE64</otpComplexity>
<mask>NONE or PHONE</mask>
<PINComplexity>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</PINComplexity>
<PINReuse>boolean</PINReuse>
<MK2Algorithm>boolean</MK2Algorithm>
<allowTrivialPIN>boolean</allowTrivialPIN>
<allowBiometricPIN>boolean</allowBiometricPIN>
<display>boolean</display>
<manualOff>boolean</manualOff>
<DefaultTok>boolean</DefaultTok>
<TokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</TokenType>
<encryption>DES or AES or TRIPLE_DES or OATH or OATH256 or Oath512</encryption>
<InitialSetPIN>string</InitialSetPIN>
<OTPLen>int</OTPLen>
<MultipleOTPperCycle>boolean</MultipleOTPperCycle>
<PINSide>NONE or TOKEN or SERVER or BOTH</PINSide>
<MinPINLen>int</MinPINLen>
<MaxPINLen>int</MaxPINLen>
<PINType>NONE or USER_CHANGEABLE or SERVER_CHANGEABLE or FIXED</PINType>
<PINAttempts>int</PINAttempts>
<UserChangePIN>int</UserChangePIN>
<AutoOff>int</AutoOff>
<KeyLength>int</KeyLength>
<ModelNumber>int</ModelNumber>
<FirmwareVersion>string</FirmwareVersion>
<AuthVersion>GOLD or CUSTOM or OATH or V4 or V5 or V6 or V7</AuthVersion>
<RandomPINLength>int</RandomPINLength>
<CanUnlock>boolean</CanUnlock>
<TimeBased>boolean</TimeBased>
<TimeInterval>int</TimeInterval>
<OTPProtectiveSuspendDelay>TwoSeconds or TenSeconds or ThirtySeconds or SixtySeconds</OTPProtectiveSuspendDelay>
<ExtendedOptions>
<WizardInput>
<Name>string</Name>
<Title>string</Title>
<Value />
<Values xsi:nil="true" />
<DefaultValue />
<GroupNumber>int</GroupNumber>
<Example>string</Example>
<OptionallyEnabled>boolean</OptionallyEnabled>
<Optional>boolean</Optional>
<MaxCount>int</MaxCount>
<Delimiter>char</Delimiter>
<ListIndex>int</ListIndex>
<MinimumValue>int</MinimumValue>
<MaximumValue>int</MaximumValue>
</WizardInput>
<WizardInput>
<Name>string</Name>
<Title>string</Title>
<Value />
<Values xsi:nil="true" />
<DefaultValue />
<GroupNumber>int</GroupNumber>
<Example>string</Example>
<OptionallyEnabled>boolean</OptionallyEnabled>
<Optional>boolean</Optional>
<MaxCount>int</MaxCount>
<Delimiter>char</Delimiter>
<ListIndex>int</ListIndex>
<MinimumValue>int</MinimumValue>
<MaximumValue>int</MaximumValue>
</WizardInput>
</ExtendedOptions>
</GetTokenTemplateForTokenResult>
</GetTokenTemplateForTokenResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/GetTokenTemplateForToken?serial=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<TokenTemplate xmlns="http://www.cryptocard.com/blackshield/">
<initialPIN>NONE or RANDOM or SET</initialPIN>
<otpMode>QUICKLOG or CHALLENGE_RESPONSE</otpMode>
<otpComplexity>DECIMAL or HEX or BASE32 or BASE64</otpComplexity>
<mask>NONE or PHONE</mask>
<PINComplexity>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</PINComplexity>
<PINReuse>boolean</PINReuse>
<MK2Algorithm>boolean</MK2Algorithm>
<allowTrivialPIN>boolean</allowTrivialPIN>
<allowBiometricPIN>boolean</allowBiometricPIN>
<display>boolean</display>
<manualOff>boolean</manualOff>
<DefaultTok>boolean</DefaultTok>
<TokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</TokenType>
<encryption>DES or AES or TRIPLE_DES or OATH or OATH256 or Oath512</encryption>
<InitialSetPIN>string</InitialSetPIN>
<OTPLen>int</OTPLen>
<MultipleOTPperCycle>boolean</MultipleOTPperCycle>
<PINSide>NONE or TOKEN or SERVER or BOTH</PINSide>
<MinPINLen>int</MinPINLen>
<MaxPINLen>int</MaxPINLen>
<PINType>NONE or USER_CHANGEABLE or SERVER_CHANGEABLE or FIXED</PINType>
<PINAttempts>int</PINAttempts>
<UserChangePIN>int</UserChangePIN>
<AutoOff>int</AutoOff>
<KeyLength>int</KeyLength>
<ModelNumber>int</ModelNumber>
<FirmwareVersion>string</FirmwareVersion>
<AuthVersion>GOLD or CUSTOM or OATH or V4 or V5 or V6 or V7</AuthVersion>
<RandomPINLength>int</RandomPINLength>
<CanUnlock>boolean</CanUnlock>
<TimeBased>boolean</TimeBased>
<TimeInterval>int</TimeInterval>
<OTPProtectiveSuspendDelay>TwoSeconds or TenSeconds or ThirtySeconds or SixtySeconds</OTPProtectiveSuspendDelay>
<ExtendedOptions>
<WizardInput>
<Name>string</Name>
<Title>string</Title>
<Value />
<Values>
<string>string</string>
<string>string</string>
</Values>
<DefaultValue />
<GroupNumber>int</GroupNumber>
<Example>string</Example>
<OptionallyEnabled>boolean</OptionallyEnabled>
<Optional>boolean</Optional>
<MaxCount>int</MaxCount>
<Delimiter>char</Delimiter>
<ListIndex>int</ListIndex>
<MinimumValue>int</MinimumValue>
<MaximumValue>int</MaximumValue>
</WizardInput>
<WizardInput>
<Name>string</Name>
<Title>string</Title>
<Value />
<Values>
<string>string</string>
<string>string</string>
</Values>
<DefaultValue />
<GroupNumber>int</GroupNumber>
<Example>string</Example>
<OptionallyEnabled>boolean</OptionallyEnabled>
<Optional>boolean</Optional>
<MaxCount>int</MaxCount>
<Delimiter>char</Delimiter>
<ListIndex>int</ListIndex>
<MinimumValue>int</MinimumValue>
<MaximumValue>int</MaximumValue>
</WizardInput>
</ExtendedOptions>
</TokenTemplate>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/GetTokenTemplateForToken HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
serial=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<TokenTemplate xmlns="http://www.cryptocard.com/blackshield/">
<initialPIN>NONE or RANDOM or SET</initialPIN>
<otpMode>QUICKLOG or CHALLENGE_RESPONSE</otpMode>
<otpComplexity>DECIMAL or HEX or BASE32 or BASE64</otpComplexity>
<mask>NONE or PHONE</mask>
<PINComplexity>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</PINComplexity>
<PINReuse>boolean</PINReuse>
<MK2Algorithm>boolean</MK2Algorithm>
<allowTrivialPIN>boolean</allowTrivialPIN>
<allowBiometricPIN>boolean</allowBiometricPIN>
<display>boolean</display>
<manualOff>boolean</manualOff>
<DefaultTok>boolean</DefaultTok>
<TokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</TokenType>
<encryption>DES or AES or TRIPLE_DES or OATH or OATH256 or Oath512</encryption>
<InitialSetPIN>string</InitialSetPIN>
<OTPLen>int</OTPLen>
<MultipleOTPperCycle>boolean</MultipleOTPperCycle>
<PINSide>NONE or TOKEN or SERVER or BOTH</PINSide>
<MinPINLen>int</MinPINLen>
<MaxPINLen>int</MaxPINLen>
<PINType>NONE or USER_CHANGEABLE or SERVER_CHANGEABLE or FIXED</PINType>
<PINAttempts>int</PINAttempts>
<UserChangePIN>int</UserChangePIN>
<AutoOff>int</AutoOff>
<KeyLength>int</KeyLength>
<ModelNumber>int</ModelNumber>
<FirmwareVersion>string</FirmwareVersion>
<AuthVersion>GOLD or CUSTOM or OATH or V4 or V5 or V6 or V7</AuthVersion>
<RandomPINLength>int</RandomPINLength>
<CanUnlock>boolean</CanUnlock>
<TimeBased>boolean</TimeBased>
<TimeInterval>int</TimeInterval>
<OTPProtectiveSuspendDelay>TwoSeconds or TenSeconds or ThirtySeconds or SixtySeconds</OTPProtectiveSuspendDelay>
<ExtendedOptions>
<WizardInput>
<Name>string</Name>
<Title>string</Title>
<Value />
<Values>
<string>string</string>
<string>string</string>
</Values>
<DefaultValue />
<GroupNumber>int</GroupNumber>
<Example>string</Example>
<OptionallyEnabled>boolean</OptionallyEnabled>
<Optional>boolean</Optional>
<MaxCount>int</MaxCount>
<Delimiter>char</Delimiter>
<ListIndex>int</ListIndex>
<MinimumValue>int</MinimumValue>
<MaximumValue>int</MaximumValue>
</WizardInput>
<WizardInput>
<Name>string</Name>
<Title>string</Title>
<Value />
<Values>
<string>string</string>
<string>string</string>
</Values>
<DefaultValue />
<GroupNumber>int</GroupNumber>
<Example>string</Example>
<OptionallyEnabled>boolean</OptionallyEnabled>
<Optional>boolean</Optional>
<MaxCount>int</MaxCount>
<Delimiter>char</Delimiter>
<ListIndex>int</ListIndex>
<MinimumValue>int</MinimumValue>
<MaximumValue>int</MaximumValue>
</WizardInput>
</ExtendedOptions>
</TokenTemplate>
GetToken
GetToken(System.String,System.String)
Get a token.
Parameters
Param: serial: Serial number of the token.
Param: organization: Account
Returns
The token object
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetToken"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetToken xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<organization>string</organization>
</GetToken>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenResult>
<challengeIssued>boolean</challengeIssued>
<isICEToken>boolean</isICEToken>
<OwnerName>string</OwnerName>
<Organization>string</Organization>
<OwningOrganization>string</OwningOrganization>
<State>BASE_INVENTORY or NOT_INITIALIZED or REVOKED or INITIALIZED or CORRUPTED_INVENTORY or BASE_ALLOCATED or ALLOCATED or BASE_ASSIGNED or MANUALLY_ASSIGNED or ENROLLED_PIN_CHANGE or ENROLLMENT_PENDING or BASE_ACTIVE or ACTIVE_TOKEN or PIN_CHANGE or BASE_SUSPENDED or MANUAL_SUSPENSION or RULE_SUSPENSION or BASE_LOCKED or SERVER_LOCK or USER_LOCK or PIN_CHANGE_LOCK or CORRUPTED or BASE_LOST_FAILED or LOST_TOKEN or DAMAGED_TOKEN or BASE_DELETED or MANUAL_REMOVE or AUTO_REMOVE or BASE_PURGED or PURGED_TOKEN</State>
<PINSetDate>string</PINSetDate>
<ActivationTime>string</ActivationTime>
<UnlockTime>string</UnlockTime>
<StateSetDate>string</StateSetDate>
<LastAuthDate>string</LastAuthDate>
<LastSuccessDate>string</LastSuccessDate>
<Inittime>string</Inittime>
<Display>string</Display>
<OTPTTL>int</OTPTTL>
<OtpLength>int</OtpLength>
<ActivationCount>int</ActivationCount>
<EncryptionKey>base64Binary</EncryptionKey>
<NonHSMKey>base64Binary</NonHSMKey>
<ChallengeBase>base64Binary</ChallengeBase>
<AuthAttempts>int</AuthAttempts>
<Message>string</Message>
<LastChallengeDate>string</LastChallengeDate>
<ExpiryDate>string</ExpiryDate>
<IsTimeBased>boolean</IsTimeBased>
<TimeInterval>int</TimeInterval>
<AuthVersion>GOLD or CUSTOM or OATH or V4 or V5 or V6 or V7</AuthVersion>
<ContainerName>string</ContainerName>
<DeviceName>string</DeviceName>
</GetTokenResult>
</GetTokenResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetToken xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<organization>string</organization>
</GetToken>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenResult>
<challengeIssued>boolean</challengeIssued>
<isICEToken>boolean</isICEToken>
<OwnerName>string</OwnerName>
<Organization>string</Organization>
<OwningOrganization>string</OwningOrganization>
<State>BASE_INVENTORY or NOT_INITIALIZED or REVOKED or INITIALIZED or CORRUPTED_INVENTORY or BASE_ALLOCATED or ALLOCATED or BASE_ASSIGNED or MANUALLY_ASSIGNED or ENROLLED_PIN_CHANGE or ENROLLMENT_PENDING or BASE_ACTIVE or ACTIVE_TOKEN or PIN_CHANGE or BASE_SUSPENDED or MANUAL_SUSPENSION or RULE_SUSPENSION or BASE_LOCKED or SERVER_LOCK or USER_LOCK or PIN_CHANGE_LOCK or CORRUPTED or BASE_LOST_FAILED or LOST_TOKEN or DAMAGED_TOKEN or BASE_DELETED or MANUAL_REMOVE or AUTO_REMOVE or BASE_PURGED or PURGED_TOKEN</State>
<PINSetDate>string</PINSetDate>
<ActivationTime>string</ActivationTime>
<UnlockTime>string</UnlockTime>
<StateSetDate>string</StateSetDate>
<LastAuthDate>string</LastAuthDate>
<LastSuccessDate>string</LastSuccessDate>
<Inittime>string</Inittime>
<Display>string</Display>
<OTPTTL>int</OTPTTL>
<OtpLength>int</OtpLength>
<ActivationCount>int</ActivationCount>
<EncryptionKey>base64Binary</EncryptionKey>
<NonHSMKey>base64Binary</NonHSMKey>
<ChallengeBase>base64Binary</ChallengeBase>
<AuthAttempts>int</AuthAttempts>
<Message>string</Message>
<LastChallengeDate>string</LastChallengeDate>
<ExpiryDate>string</ExpiryDate>
<IsTimeBased>boolean</IsTimeBased>
<TimeInterval>int</TimeInterval>
<AuthVersion>GOLD or CUSTOM or OATH or V4 or V5 or V6 or V7</AuthVersion>
<ContainerName>string</ContainerName>
<DeviceName>string</DeviceName>
</GetTokenResult>
</GetTokenResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/GetToken?serial=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<Token xmlns="http://www.cryptocard.com/blackshield/">
<challengeIssued>boolean</challengeIssued>
<isICEToken>boolean</isICEToken>
<OwnerName>string</OwnerName>
<Organization>string</Organization>
<OwningOrganization>string</OwningOrganization>
<State>BASE_INVENTORY or NOT_INITIALIZED or REVOKED or INITIALIZED or CORRUPTED_INVENTORY or BASE_ALLOCATED or ALLOCATED or BASE_ASSIGNED or MANUALLY_ASSIGNED or ENROLLED_PIN_CHANGE or ENROLLMENT_PENDING or BASE_ACTIVE or ACTIVE_TOKEN or PIN_CHANGE or BASE_SUSPENDED or MANUAL_SUSPENSION or RULE_SUSPENSION or BASE_LOCKED or SERVER_LOCK or USER_LOCK or PIN_CHANGE_LOCK or CORRUPTED or BASE_LOST_FAILED or LOST_TOKEN or DAMAGED_TOKEN or BASE_DELETED or MANUAL_REMOVE or AUTO_REMOVE or BASE_PURGED or PURGED_TOKEN</State>
<PINSetDate>string</PINSetDate>
<ActivationTime>string</ActivationTime>
<UnlockTime>string</UnlockTime>
<StateSetDate>string</StateSetDate>
<LastAuthDate>string</LastAuthDate>
<LastSuccessDate>string</LastSuccessDate>
<Inittime>string</Inittime>
<Display>string</Display>
<OTPTTL>int</OTPTTL>
<OtpLength>int</OtpLength>
<ActivationCount>int</ActivationCount>
<EncryptionKey>base64Binary</EncryptionKey>
<NonHSMKey>base64Binary</NonHSMKey>
<ChallengeBase>base64Binary</ChallengeBase>
<AuthAttempts>int</AuthAttempts>
<Message>string</Message>
<LastChallengeDate>string</LastChallengeDate>
<ExpiryDate>string</ExpiryDate>
<IsTimeBased>boolean</IsTimeBased>
<TimeInterval>int</TimeInterval>
<AuthVersion>GOLD or CUSTOM or OATH or V4 or V5 or V6 or V7</AuthVersion>
<ContainerName>string</ContainerName>
<DeviceName>string</DeviceName>
</Token>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/GetToken HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
serial=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<Token xmlns="http://www.cryptocard.com/blackshield/">
<challengeIssued>boolean</challengeIssued>
<isICEToken>boolean</isICEToken>
<OwnerName>string</OwnerName>
<Organization>string</Organization>
<OwningOrganization>string</OwningOrganization>
<State>BASE_INVENTORY or NOT_INITIALIZED or REVOKED or INITIALIZED or CORRUPTED_INVENTORY or BASE_ALLOCATED or ALLOCATED or BASE_ASSIGNED or MANUALLY_ASSIGNED or ENROLLED_PIN_CHANGE or ENROLLMENT_PENDING or BASE_ACTIVE or ACTIVE_TOKEN or PIN_CHANGE or BASE_SUSPENDED or MANUAL_SUSPENSION or RULE_SUSPENSION or BASE_LOCKED or SERVER_LOCK or USER_LOCK or PIN_CHANGE_LOCK or CORRUPTED or BASE_LOST_FAILED or LOST_TOKEN or DAMAGED_TOKEN or BASE_DELETED or MANUAL_REMOVE or AUTO_REMOVE or BASE_PURGED or PURGED_TOKEN</State>
<PINSetDate>string</PINSetDate>
<ActivationTime>string</ActivationTime>
<UnlockTime>string</UnlockTime>
<StateSetDate>string</StateSetDate>
<LastAuthDate>string</LastAuthDate>
<LastSuccessDate>string</LastSuccessDate>
<Inittime>string</Inittime>
<Display>string</Display>
<OTPTTL>int</OTPTTL>
<OtpLength>int</OtpLength>
<ActivationCount>int</ActivationCount>
<EncryptionKey>base64Binary</EncryptionKey>
<NonHSMKey>base64Binary</NonHSMKey>
<ChallengeBase>base64Binary</ChallengeBase>
<AuthAttempts>int</AuthAttempts>
<Message>string</Message>
<LastChallengeDate>string</LastChallengeDate>
<ExpiryDate>string</ExpiryDate>
<IsTimeBased>boolean</IsTimeBased>
<TimeInterval>int</TimeInterval>
<AuthVersion>GOLD or CUSTOM or OATH or V4 or V5 or V6 or V7</AuthVersion>
<ContainerName>string</ContainerName>
<DeviceName>string</DeviceName>
</Token>
GetTokens
GetTokens(System.Nullable{DataLayer.Entity.Token.TokenState},System.Nullable{DataLayer.Entity.Token.TokenType},System.String,System.String,System.String,System.Int32,System.Int32)
Gets a table of tokens based on the provided search criteria and filtered by State/Type/Serial/Container. Paging available.
Parameters
Param: state: Required token state. (Optional)
Param: type: Required token type. (Optional)
Param: serial: Serial number. (Wildcards supported, optional)
Param: container: Container the tokens are in. (Optional)
Param: organization: Account.
Param: startRecord: First record to return.
Param: pageSize: Number of records to return after first.
Returns
(Table of token information)
| Serial | |
| state | (as text) |
| stateSetDate | |
| userid | (if assigned) |
| orgName | |
| type | (as text) |
| container | |
| rented | (boolean) |
| hardwareInit | (boolean, true if it can be initialized in the console) |
| assignable | (boolean, true if the token can be directly assigned without enrollment) |
| ice | (boolean, true if the tokens is an ICE MP) |
| stateInt | token state as an int. Directly maps to the token state input of this function.) |
In case source organization is inventory free and token state is inventory, the API won't return the token list.
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetTokens"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokens xmlns="http://www.cryptocard.com/blackshield/">
<state>BASE_INVENTORY or NOT_INITIALIZED or REVOKED or INITIALIZED or CORRUPTED_INVENTORY or BASE_ALLOCATED or ALLOCATED or BASE_ASSIGNED or MANUALLY_ASSIGNED or ENROLLED_PIN_CHANGE or ENROLLMENT_PENDING or BASE_ACTIVE or ACTIVE_TOKEN or PIN_CHANGE or BASE_SUSPENDED or MANUAL_SUSPENSION or RULE_SUSPENSION or BASE_LOCKED or SERVER_LOCK or USER_LOCK or PIN_CHANGE_LOCK or CORRUPTED or BASE_LOST_FAILED or LOST_TOKEN or DAMAGED_TOKEN or BASE_DELETED or MANUAL_REMOVE or AUTO_REMOVE or BASE_PURGED or PURGED_TOKEN</state>
<type>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</type>
<serial>string</serial>
<container>string</container>
<organization>string</organization>
<startRecord>int</startRecord>
<pageSize>int</pageSize>
</GetTokens>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokensResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokensResult>xmlxml</GetTokensResult>
</GetTokensResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokens xmlns="http://www.cryptocard.com/blackshield/">
<state>BASE_INVENTORY or NOT_INITIALIZED or REVOKED or INITIALIZED or CORRUPTED_INVENTORY or BASE_ALLOCATED or ALLOCATED or BASE_ASSIGNED or MANUALLY_ASSIGNED or ENROLLED_PIN_CHANGE or ENROLLMENT_PENDING or BASE_ACTIVE or ACTIVE_TOKEN or PIN_CHANGE or BASE_SUSPENDED or MANUAL_SUSPENSION or RULE_SUSPENSION or BASE_LOCKED or SERVER_LOCK or USER_LOCK or PIN_CHANGE_LOCK or CORRUPTED or BASE_LOST_FAILED or LOST_TOKEN or DAMAGED_TOKEN or BASE_DELETED or MANUAL_REMOVE or AUTO_REMOVE or BASE_PURGED or PURGED_TOKEN</state>
<type>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</type>
<serial>string</serial>
<container>string</container>
<organization>string</organization>
<startRecord>int</startRecord>
<pageSize>int</pageSize>
</GetTokens>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokensResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokensResult>xmlxml</GetTokensResult>
</GetTokensResponse>
</soap12:Body>
</soap12:Envelope>
GetTokensByOwner
GetTokensByOwner(System.String,System.String)
Gets a list of serial numbers of all tokens assigned to a user.
Parameters
Param: userName: User name
Param: organization: Account
Returns
Token serial numbers
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetTokensByOwner"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokensByOwner xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<organization>string</organization>
</GetTokensByOwner>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTokensByOwnerResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokensByOwnerResult>
<string>string</string>
<string>string</string>
</GetTokensByOwnerResult>
</GetTokensByOwnerResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokensByOwner xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<organization>string</organization>
</GetTokensByOwner>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTokensByOwnerResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokensByOwnerResult>
<string>string</string>
<string>string</string>
</GetTokensByOwnerResult>
</GetTokensByOwnerResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/GetTokensByOwner?userName=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfString xmlns="http://www.cryptocard.com/blackshield/">
<string>string</string>
<string>string</string>
</ArrayOfString>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/GetTokensByOwner HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
userName=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfString xmlns="http://www.cryptocard.com/blackshield/">
<string>string</string>
<string>string</string>
</ArrayOfString>
GetTotalTokens
GetTotalTokens(System.Nullable{DataLayer.Entity.Token.TokenState},System.Nullable{DataLayer.Entity.Token.TokenType},System.String,System.String,System.String)
Gets the total number of tokens filtered by State/Type/Serial/Container. Used with GetTokens to assist with determining the number of tokens you want returned.
Parameters
Param: state: Required token state. (Optional)
Param: type: Required token type. (Optional)
Param: serial: Serial number. (Wildcards supported, optional)
Param: container: Container the tokens are in. (Optional)
Param: organization: Account.
Returns
Number of tokens that match the search criteria
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetTotalTokens"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTotalTokens xmlns="http://www.cryptocard.com/blackshield/">
<state>BASE_INVENTORY or NOT_INITIALIZED or REVOKED or INITIALIZED or CORRUPTED_INVENTORY or BASE_ALLOCATED or ALLOCATED or BASE_ASSIGNED or MANUALLY_ASSIGNED or ENROLLED_PIN_CHANGE or ENROLLMENT_PENDING or BASE_ACTIVE or ACTIVE_TOKEN or PIN_CHANGE or BASE_SUSPENDED or MANUAL_SUSPENSION or RULE_SUSPENSION or BASE_LOCKED or SERVER_LOCK or USER_LOCK or PIN_CHANGE_LOCK or CORRUPTED or BASE_LOST_FAILED or LOST_TOKEN or DAMAGED_TOKEN or BASE_DELETED or MANUAL_REMOVE or AUTO_REMOVE or BASE_PURGED or PURGED_TOKEN</state>
<type>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</type>
<serial>string</serial>
<container>string</container>
<organization>string</organization>
</GetTotalTokens>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTotalTokensResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTotalTokensResult>int</GetTotalTokensResult>
</GetTotalTokensResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTotalTokens xmlns="http://www.cryptocard.com/blackshield/">
<state>BASE_INVENTORY or NOT_INITIALIZED or REVOKED or INITIALIZED or CORRUPTED_INVENTORY or BASE_ALLOCATED or ALLOCATED or BASE_ASSIGNED or MANUALLY_ASSIGNED or ENROLLED_PIN_CHANGE or ENROLLMENT_PENDING or BASE_ACTIVE or ACTIVE_TOKEN or PIN_CHANGE or BASE_SUSPENDED or MANUAL_SUSPENSION or RULE_SUSPENSION or BASE_LOCKED or SERVER_LOCK or USER_LOCK or PIN_CHANGE_LOCK or CORRUPTED or BASE_LOST_FAILED or LOST_TOKEN or DAMAGED_TOKEN or BASE_DELETED or MANUAL_REMOVE or AUTO_REMOVE or BASE_PURGED or PURGED_TOKEN</state>
<type>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</type>
<serial>string</serial>
<container>string</container>
<organization>string</organization>
</GetTotalTokens>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetTotalTokensResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTotalTokensResult>int</GetTotalTokensResult>
</GetTotalTokensResponse>
</soap12:Body>
</soap12:Envelope>
ImportTokens
ImportTokens(System.Byte\[\],System.Boolean,System.Boolean,System.String,System.String)
Import a BTK file of tokens. Can optionally apply the server side PIN settings to all tokens with no PIN. Can optionally overwrite all existing tokens of the same serial number.
Parameters
Param: btkFileContents: The contents of the BTK file.
Param: mergeServerSidePINSettings: True to use the current token template server PIN settings for all tokens that have no PIN in the BTK file.
Param: overwriteExistingTokens: True to overwrite any tokens that already exist with the same serial number.
Param: destinationContainer: The container to import into.
Param: organization: Account
Returns
List of import results. One row per token that was in the BTK file:
| Serial | ||
| TypeName | (Name of the token type) | |
| Result | ||
| Added | New token was added | |
| Updated | Existing token was updated | |
| Failed | Token could not be loaded | |
| Purged | Existing token was deleted and the replacement token could not be added | |
| AlreadyExists | This token already exists in the system and overwrite was false | |
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/ImportTokens"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ImportTokens xmlns="http://www.cryptocard.com/blackshield/">
<btkFileContents>base64Binary</btkFileContents>
<mergeServerSidePINSettings>boolean</mergeServerSidePINSettings>
<overwriteExistingTokens>boolean</overwriteExistingTokens>
<destinationContainer>string</destinationContainer>
<organization>string</organization>
</ImportTokens>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ImportTokensResponse xmlns="http://www.cryptocard.com/blackshield/">
<ImportTokensResult>
<ImportedTokenResult>
<Result>Added or Updated or Failed or Purged or AlreadyExists</Result>
<Serial>string</Serial>
<TypeName>string</TypeName>
</ImportedTokenResult>
<ImportedTokenResult>
<Result>Added or Updated or Failed or Purged or AlreadyExists</Result>
<Serial>string</Serial>
<TypeName>string</TypeName>
</ImportedTokenResult>
</ImportTokensResult>
</ImportTokensResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<ImportTokens xmlns="http://www.cryptocard.com/blackshield/">
<btkFileContents>base64Binary</btkFileContents>
<mergeServerSidePINSettings>boolean</mergeServerSidePINSettings>
<overwriteExistingTokens>boolean</overwriteExistingTokens>
<destinationContainer>string</destinationContainer>
<organization>string</organization>
</ImportTokens>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<ImportTokensResponse xmlns="http://www.cryptocard.com/blackshield/">
<ImportTokensResult>
<ImportedTokenResult>
<Result>Added or Updated or Failed or Purged or AlreadyExists</Result>
<Serial>string</Serial>
<TypeName>string</TypeName>
</ImportedTokenResult>
<ImportedTokenResult>
<Result>Added or Updated or Failed or Purged or AlreadyExists</Result>
<Serial>string</Serial>
<TypeName>string</TypeName>
</ImportedTokenResult>
</ImportTokensResult>
</ImportTokensResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/ImportTokens?btkFileContents=string&btkFileContents=string&mergeServerSidePINSettings=string&overwriteExistingTokens=string&destinationContainer=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfImportedTokenResult xmlns="http://www.cryptocard.com/blackshield/">
<ImportedTokenResult>
<Result>Added or Updated or Failed or Purged or AlreadyExists</Result>
<Serial>string</Serial>
<TypeName>string</TypeName>
</ImportedTokenResult>
<ImportedTokenResult>
<Result>Added or Updated or Failed or Purged or AlreadyExists</Result>
<Serial>string</Serial>
<TypeName>string</TypeName>
</ImportedTokenResult>
</ArrayOfImportedTokenResult>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/ImportTokens HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
btkFileContents=string&btkFileContents=string&mergeServerSidePINSettings=string&overwriteExistingTokens=string&destinationContainer=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfImportedTokenResult xmlns="http://www.cryptocard.com/blackshield/">
<ImportedTokenResult>
<Result>Added or Updated or Failed or Purged or AlreadyExists</Result>
<Serial>string</Serial>
<TypeName>string</TypeName>
</ImportedTokenResult>
<ImportedTokenResult>
<Result>Added or Updated or Failed or Purged or AlreadyExists</Result>
<Serial>string</Serial>
<TypeName>string</TypeName>
</ImportedTokenResult>
</ArrayOfImportedTokenResult>
MoveTokens
MoveTokens(System.Collections.Generic.List{System.String},System.String,System.String)
Move tokens from one container to another. Assigned tokens can not be moved.
Parameters
Param: serials: List of serial numbers to be moved to the new container.
Param: newContainer: Container to move the tokens to.
Param: organization: Account
Returns
List of results, one per token, in the same order as the list of serials provided:
| Moved | |
| CantMoveOwned | (Token is assigned and cannot be moved) |
| Failed |
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/MoveTokens"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<MoveTokens xmlns="http://www.cryptocard.com/blackshield/">
<serials>
<string>string</string>
<string>string</string>
</serials>
<newContainer>string</newContainer>
<organization>string</organization>
</MoveTokens>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<MoveTokensResponse xmlns="http://www.cryptocard.com/blackshield/">
<MoveTokensResult>
<TokenMoveResult>Moved or CantMoveOwned or Failed or NotEnoughCapacity</TokenMoveResult>
<TokenMoveResult>Moved or CantMoveOwned or Failed or NotEnoughCapacity</TokenMoveResult>
</MoveTokensResult>
</MoveTokensResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<MoveTokens xmlns="http://www.cryptocard.com/blackshield/">
<serials>
<string>string</string>
<string>string</string>
</serials>
<newContainer>string</newContainer>
<organization>string</organization>
</MoveTokens>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<MoveTokensResponse xmlns="http://www.cryptocard.com/blackshield/">
<MoveTokensResult>
<TokenMoveResult>Moved or CantMoveOwned or Failed or NotEnoughCapacity</TokenMoveResult>
<TokenMoveResult>Moved or CantMoveOwned or Failed or NotEnoughCapacity</TokenMoveResult>
</MoveTokensResult>
</MoveTokensResponse>
</soap12:Body>
</soap12:Envelope>
RemoveToken
RemoveToken(System.String,System.String)
Remove a token from the system. This only applies to hardware tokens that you own.
Parameters
Param: serial: Serial of the token to remove.
Param: organization: Account
Returns
True if successful
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/RemoveToken"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RemoveToken xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<organization>string</organization>
</RemoveToken>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RemoveTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<RemoveTokenResult>boolean</RemoveTokenResult>
</RemoveTokenResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<RemoveToken xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<organization>string</organization>
</RemoveToken>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<RemoveTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<RemoveTokenResult>boolean</RemoveTokenResult>
</RemoveTokenResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/RemoveToken?serial=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.cryptocard.com/blackshield/">boolean</boolean>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/RemoveToken HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
serial=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.cryptocard.com/blackshield/">boolean</boolean>
RequestToken
RequestToken(System.String,DataLayer.Entity.ProvisioningEntry.TokenOption,System.Nullable{System.Int32},System.Nullable{DataLayer.Entity.Token.TokenTargets},System.String)
Request a token.
Parameters
Param: userName: User that is requesting the token
Param: tokenoption: Token type they are requesting
Param: modelnumber: Model No. for custom tokens: GrIDsure = 10001, SecurID = 10002, RADIUS = 10004
Param: MPTarget: MP target if requesting an MP and want to choose now instead of during enrollment. Options: HardDrive, Blackberry, iPhone, Android, WindowsPhone7, MacOSX
Param: organization: Account
Returns
- Request ID for the token request, or 0 for a failure
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/RequestToken"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RequestToken xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<tokenoption>Software or Custom or Oath or SMS or Password or KT or RB or ICE or GOLD or eToken or MobilePASS or GoogleAuthenticator</tokenoption>
<modelnumber>int</modelnumber>
<MPTarget>HardDrive or SmartCard or SecureFlashDrive or MobilePhone or Blackberry or iPhone or Android or WindowsPhone7 or MacOSX or ChromeOs</MPTarget>
<organization>string</organization>
</RequestToken>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RequestTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<RequestTokenResult>int</RequestTokenResult>
</RequestTokenResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<RequestToken xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<tokenoption>Software or Custom or Oath or SMS or Password or KT or RB or ICE or GOLD or eToken or MobilePASS or GoogleAuthenticator</tokenoption>
<modelnumber>int</modelnumber>
<MPTarget>HardDrive or SmartCard or SecureFlashDrive or MobilePhone or Blackberry or iPhone or Android or WindowsPhone7 or MacOSX or ChromeOs</MPTarget>
<organization>string</organization>
</RequestToken>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<RequestTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<RequestTokenResult>int</RequestTokenResult>
</RequestTokenResponse>
</soap12:Body>
</soap12:Envelope>
ResyncToken
ResyncToken(System.String,System.String,System.String,System.String,System.String)
Resyncs a token against a given challenge. For Timebased, OATH or SecurID tokens, pass in one OTP in the challenge, and the next OTP in the OTP. This does not work for RADIUS tokens.
Parameters
Param: serial: Serial of the token to resync.
Param: userName: User the token is assigned to.
Param: challenge: Challenge for quicklog tokens. First OTP for time based, OATH or SecurID tokens.
Param: OTP: OTP for quicklog tokens. Second OTP for time based, OATH or SecurID tokens.
Param: organization: Account
Returns
-
successful
-
fail
-
error
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/ResyncToken"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ResyncToken xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<userName>string</userName>
<challenge>string</challenge>
<OTP>string</OTP>
<organization>string</organization>
</ResyncToken>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ResyncTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<ResyncTokenResult>success or fail or error</ResyncTokenResult>
</ResyncTokenResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<ResyncToken xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<userName>string</userName>
<challenge>string</challenge>
<OTP>string</OTP>
<organization>string</organization>
</ResyncToken>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<ResyncTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<ResyncTokenResult>success or fail or error</ResyncTokenResult>
</ResyncTokenResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/ResyncToken?serial=string&userName=string&challenge=string&OTP=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<resyncResult xmlns="http://www.cryptocard.com/blackshield/">success or fail or error</resyncResult>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/ResyncToken HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
serial=string&userName=string&challenge=string&OTP=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<resyncResult xmlns="http://www.cryptocard.com/blackshield/">success or fail or error</resyncResult>
ResyncTokenUsingCounter
ResyncTokenUsingCounter(System.String,System.String,Long,System.String)
Updates token event counter against a given serial number of token. This works only for event-based tokens.
Parameter
Param: serial: Serial of the token to resync.
Param: organization: Account
Param: eventcounter: Token Counter number for which the OTP is being provided.
Param: OTP: OTP from the ID prove token for which the event counter is provided.
Returns
-
successful
-
fail
-
error
For resync, verify that the OTP validation range is between -1 and +2, as set in SAS. This range must be small to cover for security risks.
- If event counter value in database >= event counter value on token, SAS should not update the event counter in the database and resync should fail.
- If event counter value in database < event counter value on token, SAS should update the event counter in the database and resync should succeed.
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/ResyncTokenUsingCounter"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ResyncTokenUsingCounter xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<organization>string</organization>
<eventCounter>long</eventCounter>
<otp>string</otp>
</ResyncTokenUsingCounter>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ResyncTokenUsingCounterResponse xmlns="http://www.cryptocard.com/blackshield/">
<ResyncTokenUsingCounterResult>success or fail or error</ResyncTokenUsingCounterResult>
</ResyncTokenUsingCounterResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<ResyncTokenUsingCounter xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<organization>string</organization>
<eventCounter>long</eventCounter>
<otp>string</otp>
</ResyncTokenUsingCounter>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<ResyncTokenUsingCounterResponse xmlns="http://www.cryptocard.com/blackshield/">
<ResyncTokenUsingCounterResult>success or fail or error</ResyncTokenUsingCounterResult>
</ResyncTokenUsingCounterResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/ResyncTokenUsingCounter?serial=string&organization=string&eventCounter=string&otp=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<resyncResult xmlns="http://www.cryptocard.com/blackshield/">success or fail or error</resyncResult>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/ResyncTokenUsingCounter HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
serial=string&organization=string&eventCounter=string&otp=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<resyncResult xmlns="http://www.cryptocard.com/blackshield/">success or fail or error</resyncResult>
RevokeToken
RevokeToken(System.String,System.String,System.String,ControlLibrary.TokenControl.revokeSelection,System.Boolean,System.String)
Revoke an assigned token from a user.
Parameters
Param: serial: Serial number of the token. (Serial of "0" for static passwords)
Param: userName: User to revoke the token from.
Param: comment: Message to attach to the token.
Param: revokeMode: One of: ReturntoInventory_Initialized, ReturntoInventory_NotInitialized, Faulty, Lost
Param: revokeStaticPassword: True to also revoke the user's static password.
Param: organization: Account
Returns
| successRevokeTemp | Successfully revoked a static password |
| failRevokeTemp | Failed to revoke a static password |
| BothSuccess | Revoked the token and removed the static password |
| SuccessFail | Revoked the token but failed to revoke the static password |
| Success | Revoked the token |
| Fail | |
| LastAuth | User is an Operator or Account Manager. Their last authentication method cannot be removed |
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/RevokeToken"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RevokeToken xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<userName>string</userName>
<comment>string</comment>
<revokeMode>ReturntoInventory_Initialized or ReturntoInventory_NotInitialized or Faulty or Lost</revokeMode>
<revokeStaticPassword>boolean</revokeStaticPassword>
<organization>string</organization>
</RevokeToken>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RevokeTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<RevokeTokenResult>successRevokeTemp or failRevokeTemp or BothSuccess or SuccessFail or Success or Fail or LastAuth</RevokeTokenResult>
</RevokeTokenResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<RevokeToken xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<userName>string</userName>
<comment>string</comment>
<revokeMode>ReturntoInventory_Initialized or ReturntoInventory_NotInitialized or Faulty or Lost</revokeMode>
<revokeStaticPassword>boolean</revokeStaticPassword>
<organization>string</organization>
</RevokeToken>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<RevokeTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<RevokeTokenResult>successRevokeTemp or failRevokeTemp or BothSuccess or SuccessFail or Success or Fail or LastAuth</RevokeTokenResult>
</RevokeTokenResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/RevokeToken?serial=string&userName=string&comment=string&revokeMode=string&revokeStaticPassword=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<revokeResult xmlns="http://www.cryptocard.com/blackshield/">successRevokeTemp or failRevokeTemp or BothSuccess or SuccessFail or Success or Fail or LastAuth</revokeResult>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/RevokeToken HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
serial=string&userName=string&comment=string&revokeMode=string&revokeStaticPassword=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<revokeResult xmlns="http://www.cryptocard.com/blackshield/">successRevokeTemp or failRevokeTemp or BothSuccess or SuccessFail or Success or Fail or LastAuth</revokeResult>
SuspendToken
SuspendToken(System.String,ControlLibrary.TokenControl.suspendSelection,System.String,System.String,System.Boolean,System.String,System.Int32)
Suspends a user's token and optionally assigns a temporary static password.
Parameters
Param: serial: Serial of the token to suspend
Param: selection: Action you are taking: No_Static_Password, Accept_LDAP_Password (Direct LDAP Only), Set_Temp_Static_Password
Param: comment: Message to attach to the token.
Param: tempPassword: Temporary password if Set_Temp_Static_Password was specified.
Param: changePasswordOnFirstUse: True to force the user to change the password on first use.
Param: organization: Account
Param: passwordExpiryInMinutes: Number of minutes the password will be valid for. 0 for no expiry.
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/SuspendToken"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SuspendToken xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<selection>No_Static_Password or Accept_LDAP_Password or Set_Temp_Static_Password</selection>
<comment>string</comment>
<tempPassword>string</tempPassword>
<changePasswordOnFirstUse>boolean</changePasswordOnFirstUse>
<organization>string</organization>
<passwordExpiryInMinutes>int</passwordExpiryInMinutes>
</SuspendToken>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<SuspendTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<SuspendTokenResult>success or fail or pwSuccess or pwFail or formatFail or LastAuth or InvalidPasswordExpiry</SuspendTokenResult>
</SuspendTokenResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SuspendToken xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<selection>No_Static_Password or Accept_LDAP_Password or Set_Temp_Static_Password</selection>
<comment>string</comment>
<tempPassword>string</tempPassword>
<changePasswordOnFirstUse>boolean</changePasswordOnFirstUse>
<organization>string</organization>
<passwordExpiryInMinutes>int</passwordExpiryInMinutes>
</SuspendToken>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SuspendTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<SuspendTokenResult>success or fail or pwSuccess or pwFail or formatFail or LastAuth or InvalidPasswordExpiry</SuspendTokenResult>
</SuspendTokenResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/SuspendToken?serial=string&selection=string&comment=string&tempPassword=string&changePasswordOnFirstUse=string&organization=string&passwordExpiryInMinutes=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<suspendResult xmlns="http://www.cryptocard.com/blackshield/">success or fail or pwSuccess or pwFail or formatFail or LastAuth or InvalidPasswordExpiry</suspendResult>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/SuspendToken HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
serial=string&selection=string&comment=string&tempPassword=string&changePasswordOnFirstUse=string&organization=string&passwordExpiryInMinutes=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<suspendResult xmlns="http://www.cryptocard.com/blackshield/">success or fail or pwSuccess or pwFail or formatFail or LastAuth or InvalidPasswordExpiry</suspendResult>
TestToken
TestToken(System.String,System.String,System.String,System.String,System.String@,System.String@)
Tests a token for authentication. If the return code is not success or failure, all subsequent calls must include the state that was returned from the first call. Note that this API call is meant for testing purposes only, and not intended for regular production authentications. The Management API is not provided with the same level of service availability as authentication services.
Parameters
Param: userName: User name to test.
Param: organization: Account
Param: serial: Serial number of the token to test.
Param: OTP: OTP to test.
Param: state: Request state. Use null on new tests. If presented with a challenge/PIN change/outer window, you must pass back the value that was returned on the first call.
Param: challenge: Challenge message for return values that require it.
Returns
| AUTH_FAILURE | Authentication Failed |
| AUTH_SUCCESS | Authentication Success |
| CHALLENGE | A challenge has been returned in the challenge argument. Call this function again with the response in the OTP argument. |
| SERVER_PIN_PROVIDED | The server has initiated a PIN change. Your new PIN is in the challenge argument. Authenticate again using this new PIN. |
| USER_PIN_CHANGE | You are required call this function again providing a new PIN. |
| OUTER_WINDOW_AUTH | Your token is out of sync. You must call this function again with the next OTP. |
| CHANGE_STATIC_PASSWORD | You must call this function again and provide a new static password. |
| STATIC_CHANGE_FAILED | Password change failed. |
| PIN_CHANGE_FAILED | PIN change failed. |
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/TestToken"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<TestToken xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<organization>string</organization>
<serial>string</serial>
<OTP>string</OTP>
<state>string</state>
</TestToken>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<TestTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<TestTokenResult>AUTH_FAILURE or AUTH_SUCCESS or CHALLENGE or SERVER_PIN_PROVIDED or USER_PIN_CHANGE or OUTER_WINDOW_AUTH or CHANGE_STATIC_PASSWORD or STATIC_CHANGE_FAILED or PIN_CHANGE_FAILED or PUSH_OTP_REJECTED or PUSH_OTP_DISPATCHED</TestTokenResult>
<state>string</state>
<challenge>string</challenge>
</TestTokenResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<TestToken xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<organization>string</organization>
<serial>string</serial>
<OTP>string</OTP>
<state>string</state>
</TestToken>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<TestTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
<TestTokenResult>AUTH_FAILURE or AUTH_SUCCESS or CHALLENGE or SERVER_PIN_PROVIDED or USER_PIN_CHANGE or OUTER_WINDOW_AUTH or CHANGE_STATIC_PASSWORD or STATIC_CHANGE_FAILED or PIN_CHANGE_FAILED or PUSH_OTP_REJECTED or PUSH_OTP_DISPATCHED</TestTokenResult>
<state>string</state>
<challenge>string</challenge>
</TestTokenResponse>
</soap12:Body>
</soap12:Envelope>
