Enrollment endpoints
GetEnrollmentURL
GetEnrollmentURL(System String,System.Int32,System.String)
Gets the self-enrollment URL for a given user's provisioning task.
Parameters
Param: userName: User with the task.
Param: taskID: Task ID for the specific provisioning task.
Param: organization: Organization the user is in.
Returns:
- Self-enrollment URL for the specific provisioning task
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/GetEnrollmentURL"
<?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>
<GetEnrollmentURL xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<taskID>int</taskID>
<organization>string</organization>
</GetEnrollmentURL>
</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>
<GetEnrollmentURLResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetEnrollmentURLResult>string</GetEnrollmentURLResult>
</GetEnrollmentURLResponse>
</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>
<GetEnrollmentURL xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<taskID>int</taskID>
<organization>string</organization>
</GetEnrollmentURL>
</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>
<GetEnrollmentURLResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetEnrollmentURLResult>string</GetEnrollmentURLResult>
</GetEnrollmentURLResponse>
</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/GetEnrollmentURL?userName=string&taskID=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"?>
<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/GetEnrollmentURL HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
userName=string&taskID=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>
GetFileForShortCode
GetFileForShortCode(System.String,System.String,System.String@)
Provides the token files for download for any mobile devices. The short code will be passed as a parameter to the web page that uses this function. The resource URL is the web directory in which support files for mobile tokens (such as the Blackberry JAuthenticator.jar) is located. Pass in null to use the default resource URL.
Parameters
Param: shortCode: Short code that was used when the page was requested
Param: resourceURL: web directory in which support files for mobile tokens (such as the Blackberry JAuthenticator.jar) is located. Pass in null to use the default resource URL.
Param: fileName: File name for the returned file
Returns
- File to deliver to the client that is requesting it
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/GetFileForShortCode"
<?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>
<GetFileForShortCode xmlns="http://www.cryptocard.com/blackshield/">
<shortCode>string</shortCode>
<resourceURL>string</resourceURL>
</GetFileForShortCode>
</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>
<GetFileForShortCodeResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetFileForShortCodeResult>base64Binary</GetFileForShortCodeResult>
<fileName>string</fileName>
</GetFileForShortCodeResponse>
</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>
<GetFileForShortCode xmlns="http://www.cryptocard.com/blackshield/">
<shortCode>string</shortCode>
<resourceURL>string</resourceURL>
</GetFileForShortCode>
</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>
<GetFileForShortCodeResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetFileForShortCodeResult>base64Binary</GetFileForShortCodeResult>
<fileName>string</fileName>
</GetFileForShortCodeResponse>
</soap12:Body>
</soap12:Envelope>
GetSelfEnrollmentPolicy
GetSelfEnrollmentPolicy(System.String)
Gets the self-enrollment policy that affects the given enrollment request
Parameter
Param: enrollmentCode: Enrollment code
Returns
- SelfEnrollment policy
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/GetSelfEnrollmentPolicy"
<?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>
<GetSelfEnrollmentPolicy xmlns="http://www.cryptocard.com/blackshield/">
<enrollmentCode>string</enrollmentCode>
</GetSelfEnrollmentPolicy>
</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>
<GetSelfEnrollmentPolicyResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetSelfEnrollmentPolicyResult>
<BaseURL>string</BaseURL>
<CodeFormat>NUMERIC_ONLY or ALPHA_ONLY or ALPHA_NUMERIC</CodeFormat>
<ReservationTTL>int</ReservationTTL>
<NumberOfAttempts>int</NumberOfAttempts>
<EditablePhoneEmail>boolean</EditablePhoneEmail>
<RequireDescription>boolean</RequireDescription>
<ShowListAsDropDown>boolean</ShowListAsDropDown>
<NumberOfDaysBeforeExpiryToWarn>int</NumberOfDaysBeforeExpiryToWarn>
<ShowMultiDeviceInstructions>boolean</ShowMultiDeviceInstructions>
<ShowQRCode>boolean</ShowQRCode>
</GetSelfEnrollmentPolicyResult>
</GetSelfEnrollmentPolicyResponse>
</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>
<GetSelfEnrollmentPolicy xmlns="http://www.cryptocard.com/blackshield/">
<enrollmentCode>string</enrollmentCode>
</GetSelfEnrollmentPolicy>
</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>
<GetSelfEnrollmentPolicyResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetSelfEnrollmentPolicyResult>
<BaseURL>string</BaseURL>
<CodeFormat>NUMERIC_ONLY or ALPHA_ONLY or ALPHA_NUMERIC</CodeFormat>
<ReservationTTL>int</ReservationTTL>
<NumberOfAttempts>int</NumberOfAttempts>
<EditablePhoneEmail>boolean</EditablePhoneEmail>
<RequireDescription>boolean</RequireDescription>
<ShowListAsDropDown>boolean</ShowListAsDropDown>
<NumberOfDaysBeforeExpiryToWarn>int</NumberOfDaysBeforeExpiryToWarn>
<ShowMultiDeviceInstructions>boolean</ShowMultiDeviceInstructions>
<ShowQRCode>boolean</ShowQRCode>
</GetSelfEnrollmentPolicyResult>
</GetSelfEnrollmentPolicyResponse>
</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/GetSelfEnrollmentPolicy?enrollmentCode=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"?>
<SelfEnrollmentPolicy xmlns="http://www.cryptocard.com/blackshield/">
<BaseURL>string</BaseURL>
<CodeFormat>NUMERIC_ONLY or ALPHA_ONLY or ALPHA_NUMERIC</CodeFormat>
<ReservationTTL>int</ReservationTTL>
<NumberOfAttempts>int</NumberOfAttempts>
<EditablePhoneEmail>boolean</EditablePhoneEmail>
<RequireDescription>boolean</RequireDescription>
<ShowListAsDropDown>boolean</ShowListAsDropDown>
<NumberOfDaysBeforeExpiryToWarn>int</NumberOfDaysBeforeExpiryToWarn>
<ShowMultiDeviceInstructions>boolean</ShowMultiDeviceInstructions>
<ShowQRCode>boolean</ShowQRCode>
</SelfEnrollmentPolicy>
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/GetSelfEnrollmentPolicy HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
enrollmentCode=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<SelfEnrollmentPolicy xmlns="http://www.cryptocard.com/blackshield/">
<BaseURL>string</BaseURL>
<CodeFormat>NUMERIC_ONLY or ALPHA_ONLY or ALPHA_NUMERIC</CodeFormat>
<ReservationTTL>int</ReservationTTL>
<NumberOfAttempts>int</NumberOfAttempts>
<EditablePhoneEmail>boolean</EditablePhoneEmail>
<RequireDescription>boolean</RequireDescription>
<ShowListAsDropDown>boolean</ShowListAsDropDown>
<NumberOfDaysBeforeExpiryToWarn>int</NumberOfDaysBeforeExpiryToWarn>
<ShowMultiDeviceInstructions>boolean</ShowMultiDeviceInstructions>
<ShowQRCode>boolean</ShowQRCode>
</SelfEnrollmentPolicy>
ProcessEnrollment
ProcessEnrollment(System.String,System.String,System.Nullable{System.Int32},System.String,System.Nullable{TV.TokenValidator.ReturnCode}@,System.String@,System.String@,ControlLibrary.Enrollment.ProvisioningInformation@,ControlLibrary.Enrollment.TokenFileInformation@,ControlLibrary.Enrollment.CustomTokenInformation@)
Enroll a provisioned token to a user. To begin, call with the enrollment code. Return codes will prompt for more information for next call or end in a terminating state.
For GOLD and GOLD-compatible tokens, use the ProcessEnrollmentWithHost function instead.
Parameters
Param: Code: Enrollment code provided to the user; generally part of the URL in the e-mail that we send out.
Param: Serial: Serial of the token. Only required if prompted by this function to get it from the user.
Param: hostNumber: Host number for multi host tokens. Provide only if prompted for.
Param: OTP: OTP to authenticate with. Only required if prompted to authenticate by this function.
Param: ResultCode: Authentication result. See TestToken return codes for their meanings.
Param: AuthenticationState: Authentication state. Pass in null unless replying to a continue authentication, where you will pass in what you receive.
Param: AuthenticationChallenge: Challenge message from authentication. See TestToken for details.
Param: Info: Provides information about the provisioning request; used with the return code to process the next step.
Param: TokenInfo: Provides a software token and all information pertaining to it. Load the token to continue.
Param: CustomInfo: Provides information about a custom token including an enrollment image and instructions to present to the user.
Returns
| Error | Process cannot continue. Unexpected input or server issue. |
| Success | Enrollment has completed and the user can authenticate with their token |
| CodeDoesNotExist | The code provided cannot be found. Prompt the user to ensure it has been entered correctly, if they entered it manually. |
| ProvisioningNotActive | The code entered was found, but it is not available for use at this time |
| NotEnoughTokens | The account does not have enough tokens of the type required to process this enrollment |
| RequiresSerial | A serial number for a hardware token is required. Call again with the serial number. |
| InvalidSerial | The serial number provided by the user is not valid for provisioning |
| TokenDoesNotExist | The serial number that has been provided does not exist in the system. |
| TokenNotAssignable | A token cannot be assigned to the user. They may have an existing token that is not compatible. |
| RequiresAuthentication | Call again with the next OTP from the token |
| FailedAuthentication | The OTP provided was not valid. Another attempt can be made. |
| ContinueAuthentication | A challenge has been provided. Prompt for a response and call again with the response in the OTP field. |
| TooManyAttempts | There have been too many failed attempts to authenticate. This provisioning task has been locked. |
| OutsideOfTimeWindow | This provisioning task cannot be used at this time. |
| SelectSoftwareTarget | Prompt the user to select a token target to install their token to. Targets are available by calling: GetTokenTargets(String code). Select a target by calling: SelectEnrollmentSoftwareType |
| SendSMS | You must call SendEnrollmentSMS once for each SMS message in the ProvisioningInfo Info. Default values will be used if not overridden in the call to SendEnrollmentSMS. |
| SendEMail | You must call SendEnrollmentEMail once for each e-mail message in the ProvisioningInfo Info. Default values will be used if not overridden in the call to SendEnrollmentEMail. |
| RequiresCustomEnrollment | Present the image and instructions in the CustomInfo and call again with the OTP/Authentication code in the OTP field |
| FailedCustomEnrollment | The custom enrollment information provided was not valid. Another attempt can be made. |
| ChoosePassword | Call again with a password in the OTP field. Must meet the requirements in the ProvisioningInfo Info. |
| DoesNotMeetRequirements | Password does not meet the requirements in the ProvisioningInfo object. Try again. |
| ProvisioningLocked | The provisioning code provided is for a locked provisioning task and cannot be used at this time |
| ProvisioningExpired | The provisioning code provided is for an expired provisioning task and cannot be used at this time |
| ProvisioningCancelled | The provisioning code provided is for a cancelled provisioning task and cannot be used at this time |
| ProvisioningCompleted | The provisioning code provided is for an already completed provisioning task and cannot be used at this time |
| OutOfBand | The user has been SMS or e-mailed an out of band validation code. Prompt them for this and provide it in the OTP field. |
| RequiresHost | The user is enrolling a GOLD token and must provide the host number they are attempting to enroll |
| OutOfBandNotAvailable | The provisioning task requires out of band validation, but it cannot be processed at this time |
Example
This example shows how to use ProcessEnrollment in a custom flow (assuming that the enrollment code exists).
-
Call ProcessEnrollment and pass the enrollment code as the first parameter (the Serial and OTP parameters can be null). Assuming the code is correct, it will set the EncryptionKey of the assigned GrIDsure token to the challenge string (in UTF8 encoding), and return EnrollmentResult.RequiresCustomEnrollment. It will also return the grid image in CustomInfo.EnrollmentImage.
The challenge string represents the characters in the grid that are shown to the user for choosing their pattern. For example, for a 5x5 grid the challenge string might be ABCDEFGHIJKLMNOPQRSTUVWXY, where A would be in the top left cell and Y would be in the bottom right cell (shown in the example that follows).
A B C D E
F G H I J
K L M N O
P Q R S T
U V W X Y
-
Retrieve the token using one of the GetToken methods.
-
Extract the challenge string from the token (EncryptionKey) and prompt the user to choose their pattern.
-
Call ProcessEnrollment again, providing the enrollment code and serial number, and pass the chosen pattern in the OTP parameter.
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/ProcessEnrollment"
<?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>
<ProcessEnrollment xmlns="http://www.cryptocard.com/blackshield/">
<Code>string</Code>
<Serial>string</Serial>
<OTP>string</OTP>
<AuthenticationState>string</AuthenticationState>
</ProcessEnrollment>
</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>
<ProcessEnrollmentResponse xmlns="http://www.cryptocard.com/blackshield/">
<ProcessEnrollmentResult>Error or Success or CodeDoesNotExist or ProvisioningNotActive or NotEnoughTokens or TokenDoesNotExist or TokenNotAssignable or RequiresSerial or RequiresAuthentication or FailedAuthentication or ContinueAuthentication or TooManyAttempts or OutsideOfTimeWindow or SelectSoftwareTarget or SendSMS or SendEMail or RequiresCustomEnrollment or FailedCustomEnrollment or ChoosePassword or DoesNotMeetRequirements or ProvisioningLocked or ProvisioningExpired or ProvisioningCancelled or ProvisioningCompleted or EditablePhoneEmail or OutOfBand or RequiresHost or OutOfBandNotAvailable or InvalidSerial or DisplayInstruction or UserDoesNotExist or TokenLoadError or RequiresScan</ProcessEnrollmentResult>
<ResultCode>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</ResultCode>
<AuthenticationState>string</AuthenticationState>
<AuthenticationChallenge>string</AuthenticationChallenge>
<Info>
<InitialPIN>string</InitialPIN>
<PINSide>NONE or TOKEN or SERVER or BOTH</PINSide>
<PINType>NONE or USER_CHANGEABLE or SERVER_CHANGEABLE or FIXED</PINType>
<TokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</TokenType>
<SMSMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</SMSMessages>
<EMailMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</EMailMessages>
<MobileNumberAndPhoneEditable>boolean</MobileNumberAndPhoneEditable>
<MinimumLength>int</MinimumLength>
<MaximumLength>int</MaximumLength>
<MinimumComplexityRequired>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</MinimumComplexityRequired>
<RequiresCustomSetup>boolean</RequiresCustomSetup>
<TokenProvided>boolean</TokenProvided>
<UserName>string</UserName>
<ShortCode>string</ShortCode>
</Info>
<TokenInfo>
<TransportPIN>string</TransportPIN>
<Serial>string</Serial>
<FileName>string</FileName>
<FileData>base64Binary</FileData>
<NextChallenge>string</NextChallenge>
</TokenInfo>
<CustomInfo>
<EnrollmentInstructions>string</EnrollmentInstructions>
<EnrollmentImage>base64Binary</EnrollmentImage>
<ImageExtension>string</ImageExtension>
<CustomTypeImage>base64Binary</CustomTypeImage>
<CustomTypeImageExtension>string</CustomTypeImageExtension>
</CustomInfo>
</ProcessEnrollmentResponse>
</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.
Response:
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>
<ProcessEnrollment xmlns="http://www.cryptocard.com/blackshield/">
<Code>string</Code>
<Serial>string</Serial>
<OTP>string</OTP>
<AuthenticationState>string</AuthenticationState>
</ProcessEnrollment>
</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>
<ProcessEnrollmentResponse xmlns="http://www.cryptocard.com/blackshield/">
<ProcessEnrollmentResult>Error or Success or CodeDoesNotExist or ProvisioningNotActive or NotEnoughTokens or TokenDoesNotExist or TokenNotAssignable or RequiresSerial or RequiresAuthentication or FailedAuthentication or ContinueAuthentication or TooManyAttempts or OutsideOfTimeWindow or SelectSoftwareTarget or SendSMS or SendEMail or RequiresCustomEnrollment or FailedCustomEnrollment or ChoosePassword or DoesNotMeetRequirements or ProvisioningLocked or ProvisioningExpired or ProvisioningCancelled or ProvisioningCompleted or EditablePhoneEmail or OutOfBand or RequiresHost or OutOfBandNotAvailable or InvalidSerial or DisplayInstruction or UserDoesNotExist or TokenLoadError or RequiresScan</ProcessEnrollmentResult>
<ResultCode>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</ResultCode>
<AuthenticationState>string</AuthenticationState>
<AuthenticationChallenge>string</AuthenticationChallenge>
<Info>
<InitialPIN>string</InitialPIN>
<PINSide>NONE or TOKEN or SERVER or BOTH</PINSide>
<PINType>NONE or USER_CHANGEABLE or SERVER_CHANGEABLE or FIXED</PINType>
<TokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</TokenType>
<SMSMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</SMSMessages>
<EMailMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</EMailMessages>
<MobileNumberAndPhoneEditable>boolean</MobileNumberAndPhoneEditable>
<MinimumLength>int</MinimumLength>
<MaximumLength>int</MaximumLength>
<MinimumComplexityRequired>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</MinimumComplexityRequired>
<RequiresCustomSetup>boolean</RequiresCustomSetup>
<TokenProvided>boolean</TokenProvided>
<UserName>string</UserName>
<ShortCode>string</ShortCode>
</Info>
<TokenInfo>
<TransportPIN>string</TransportPIN>
<Serial>string</Serial>
<FileName>string</FileName>
<FileData>base64Binary</FileData>
<NextChallenge>string</NextChallenge>
</TokenInfo>
<CustomInfo>
<EnrollmentInstructions>string</EnrollmentInstructions>
<EnrollmentImage>base64Binary</EnrollmentImage>
<ImageExtension>string</ImageExtension>
<CustomTypeImage>base64Binary</CustomTypeImage>
<CustomTypeImageExtension>string</CustomTypeImageExtension>
</CustomInfo>
</ProcessEnrollmentResponse>
</soap12:Body>
</soap12:Envelope>
ProcessEnrollmentWithHost
ProcessEnrollmentWithHost(System.String,System.String,System.Nullable{System.Int32},System.String,System.Nullable{TV.TokenValidator.ReturnCode}@,System.String@,System.String@,ControlLibrary.Enrollment.ProvisioningInformation@,ControlLibrary.Enrollment.TokenFileInformation@,ControlLibrary.Enrollment.CustomTokenInformation
Enroll a provisioned GOLD token to a user. Each GOLD token can hold up to 10 hosts or tokens. For GOLD tokens, the host profile can be defined. Host is used to identify the host number for the GOLD token. To begin, call with the enrollment code. Return codes will prompt for more information for next call or end in a terminating state.
Use this function with GOLD and GOLD-compatible tokens only. For all other tokens, use the ProcessEnrollment function instead.
See the ProcessEnrollment function for a description of parameters and return statements.
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/ProcessEnrollmentWithHost"
<?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>
<ProcessEnrollmentWithHost xmlns="http://www.cryptocard.com/blackshield/">
<Code>string</Code>
<Serial>string</Serial>
<hostNumber>int</hostNumber>
<OTP>string</OTP>
<AuthenticationState>string</AuthenticationState>
</ProcessEnrollmentWithHost>
</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>
<ProcessEnrollmentWithHostResponse xmlns="http://www.cryptocard.com/blackshield/">
<ProcessEnrollmentWithHostResult>Error or Success or CodeDoesNotExist or ProvisioningNotActive or NotEnoughTokens or TokenDoesNotExist or TokenNotAssignable or RequiresSerial or RequiresAuthentication or FailedAuthentication or ContinueAuthentication or TooManyAttempts or OutsideOfTimeWindow or SelectSoftwareTarget or SendSMS or SendEMail or RequiresCustomEnrollment or FailedCustomEnrollment or ChoosePassword or DoesNotMeetRequirements or ProvisioningLocked or ProvisioningExpired or ProvisioningCancelled or ProvisioningCompleted or EditablePhoneEmail or OutOfBand or RequiresHost or OutOfBandNotAvailable or InvalidSerial or DisplayInstruction or UserDoesNotExist or TokenLoadError or RequiresScan</ProcessEnrollmentWithHostResult>
<ResultCode>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</ResultCode>
<AuthenticationState>string</AuthenticationState>
<AuthenticationChallenge>string</AuthenticationChallenge>
<Info>
<InitialPIN>string</InitialPIN>
<PINSide>NONE or TOKEN or SERVER or BOTH</PINSide>
<PINType>NONE or USER_CHANGEABLE or SERVER_CHANGEABLE or FIXED</PINType>
<TokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</TokenType>
<SMSMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</SMSMessages>
<EMailMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</EMailMessages>
<MobileNumberAndPhoneEditable>boolean</MobileNumberAndPhoneEditable>
<MinimumLength>int</MinimumLength>
<MaximumLength>int</MaximumLength>
<MinimumComplexityRequired>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</MinimumComplexityRequired>
<RequiresCustomSetup>boolean</RequiresCustomSetup>
<TokenProvided>boolean</TokenProvided>
<UserName>string</UserName>
<ShortCode>string</ShortCode>
</Info>
<TokenInfo>
<TransportPIN>string</TransportPIN>
<Serial>string</Serial>
<FileName>string</FileName>
<FileData>base64Binary</FileData>
<NextChallenge>string</NextChallenge>
</TokenInfo>
<CustomInfo>
<EnrollmentInstructions>string</EnrollmentInstructions>
<EnrollmentImage>base64Binary</EnrollmentImage>
<ImageExtension>string</ImageExtension>
<CustomTypeImage>base64Binary</CustomTypeImage>
<CustomTypeImageExtension>string</CustomTypeImageExtension>
</CustomInfo>
</ProcessEnrollmentWithHostResponse>
</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>
<ProcessEnrollmentWithHost xmlns="http://www.cryptocard.com/blackshield/">
<Code>string</Code>
<Serial>string</Serial>
<hostNumber>int</hostNumber>
<OTP>string</OTP>
<AuthenticationState>string</AuthenticationState>
</ProcessEnrollmentWithHost>
</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>
<ProcessEnrollmentWithHostResponse xmlns="http://www.cryptocard.com/blackshield/">
<ProcessEnrollmentWithHostResult>Error or Success or CodeDoesNotExist or ProvisioningNotActive or NotEnoughTokens or TokenDoesNotExist or TokenNotAssignable or RequiresSerial or RequiresAuthentication or FailedAuthentication or ContinueAuthentication or TooManyAttempts or OutsideOfTimeWindow or SelectSoftwareTarget or SendSMS or SendEMail or RequiresCustomEnrollment or FailedCustomEnrollment or ChoosePassword or DoesNotMeetRequirements or ProvisioningLocked or ProvisioningExpired or ProvisioningCancelled or ProvisioningCompleted or EditablePhoneEmail or OutOfBand or RequiresHost or OutOfBandNotAvailable or InvalidSerial or DisplayInstruction or UserDoesNotExist or TokenLoadError or RequiresScan</ProcessEnrollmentWithHostResult>
<ResultCode>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</ResultCode>
<AuthenticationState>string</AuthenticationState>
<AuthenticationChallenge>string</AuthenticationChallenge>
<Info>
<InitialPIN>string</InitialPIN>
<PINSide>NONE or TOKEN or SERVER or BOTH</PINSide>
<PINType>NONE or USER_CHANGEABLE or SERVER_CHANGEABLE or FIXED</PINType>
<TokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</TokenType>
<SMSMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</SMSMessages>
<EMailMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</EMailMessages>
<MobileNumberAndPhoneEditable>boolean</MobileNumberAndPhoneEditable>
<MinimumLength>int</MinimumLength>
<MaximumLength>int</MaximumLength>
<MinimumComplexityRequired>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</MinimumComplexityRequired>
<RequiresCustomSetup>boolean</RequiresCustomSetup>
<TokenProvided>boolean</TokenProvided>
<UserName>string</UserName>
<ShortCode>string</ShortCode>
</Info>
<TokenInfo>
<TransportPIN>string</TransportPIN>
<Serial>string</Serial>
<FileName>string</FileName>
<FileData>base64Binary</FileData>
<NextChallenge>string</NextChallenge>
</TokenInfo>
<CustomInfo>
<EnrollmentInstructions>string</EnrollmentInstructions>
<EnrollmentImage>base64Binary</EnrollmentImage>
<ImageExtension>string</ImageExtension>
<CustomTypeImage>base64Binary</CustomTypeImage>
<CustomTypeImageExtension>string</CustomTypeImageExtension>
</CustomInfo>
</ProcessEnrollmentWithHostResponse>
</soap12:Body>
</soap12:Envelope>
SelectEnrollmentSoftwareType
SelectEnrollmentSoftwareType(System.String,ControlLibrary.Enrollment.SoftwareType,ControlLibrary.Enrollment.ProvisioningInformation@,ControlLibrary.Enrollment.TokenFileInformation@)
Selects the kind of deployment to use for software token provisioning.
Parameters
Param: enrollmentCode: Enrollment code
Param: type: The token type to select: iPhone, Android, Blackberry, Windows7Phone, MP, MacOSX
Param: pInfo: Information about the provision request
Param: tfInfo: Information about the token if the target you have selected gives you a token file.
Returns
A table with the following columns:
| Error | Process cannot continue. Unexpected input or server issue. |
| Success | Enrollment has completed and the user can authenticate with their token |
| CodeDoesNotExist | The code provided cannot be found. Prompt the user to ensure it has been entered correctly, if they entered it manually. |
| TokenDoesNotExist | The serial number that has been provided does not exist in the system |
| DoesNotMeetRequirements | Password does not meet the requirements in the ProvisioningInfo object. Try again. |
| SendSMS | You must call SendEnrollmentSMS once for each SMS message in the ProvisioningInfo Info. Default values will be used if not overridden in the call to SendEnrollmentSMS. |
| SendEMail | You must call SendEnrollmentEMail once for each e-mail message in the ProvisioningInfo Info. Default values will be used if not overridden in the call to SendEnrollmentEMail. |
| RequiresAuthentication | Call again with the next OTP from the token |
| TokenNotAssignable | A token cannot be assigned to the user. They may have an existing token that is not compatible. |
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/SelectEnrollmentSoftwareType"
<?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>
<SelectEnrollmentSoftwareType xmlns="http://www.cryptocard.com/blackshield/">
<enrollmentCode>string</enrollmentCode>
<type>JavaPhoneOTA or JavaPhoneUSBEmail or JavaPhoneUSB or iPhone or Android or Blackberry or Windows7Phone or MP or MacOSX or SecureFlashDrive</type>
</SelectEnrollmentSoftwareType>
</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>
<SelectEnrollmentSoftwareTypeResponse xmlns="http://www.cryptocard.com/blackshield/">
<SelectEnrollmentSoftwareTypeResult>Error or Success or CodeDoesNotExist or ProvisioningNotActive or NotEnoughTokens or TokenDoesNotExist or TokenNotAssignable or RequiresSerial or RequiresAuthentication or FailedAuthentication or ContinueAuthentication or TooManyAttempts or OutsideOfTimeWindow or SelectSoftwareTarget or SendSMS or SendEMail or RequiresCustomEnrollment or FailedCustomEnrollment or ChoosePassword or DoesNotMeetRequirements or ProvisioningLocked or ProvisioningExpired or ProvisioningCancelled or ProvisioningCompleted or EditablePhoneEmail or OutOfBand or RequiresHost or OutOfBandNotAvailable or InvalidSerial or DisplayInstruction or UserDoesNotExist or TokenLoadError or RequiresScan</SelectEnrollmentSoftwareTypeResult>
<pInfo>
<InitialPIN>string</InitialPIN>
<PINSide>NONE or TOKEN or SERVER or BOTH</PINSide>
<PINType>NONE or USER_CHANGEABLE or SERVER_CHANGEABLE or FIXED</PINType>
<TokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</TokenType>
<SMSMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</SMSMessages>
<EMailMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</EMailMessages>
<MobileNumberAndPhoneEditable>boolean</MobileNumberAndPhoneEditable>
<MinimumLength>int</MinimumLength>
<MaximumLength>int</MaximumLength>
<MinimumComplexityRequired>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</MinimumComplexityRequired>
<RequiresCustomSetup>boolean</RequiresCustomSetup>
<TokenProvided>boolean</TokenProvided>
<UserName>string</UserName>
<ShortCode>string</ShortCode>
</pInfo>
<tfInfo>
<TransportPIN>string</TransportPIN>
<Serial>string</Serial>
<FileName>string</FileName>
<FileData>base64Binary</FileData>
<NextChallenge>string</NextChallenge>
</tfInfo>
</SelectEnrollmentSoftwareTypeResponse>
</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>
<SelectEnrollmentSoftwareType xmlns="http://www.cryptocard.com/blackshield/">
<enrollmentCode>string</enrollmentCode>
<type>JavaPhoneOTA or JavaPhoneUSBEmail or JavaPhoneUSB or iPhone or Android or Blackberry or Windows7Phone or MP or MacOSX or SecureFlashDrive</type>
</SelectEnrollmentSoftwareType>
</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>
<SelectEnrollmentSoftwareTypeResponse xmlns="http://www.cryptocard.com/blackshield/">
<SelectEnrollmentSoftwareTypeResult>Error or Success or CodeDoesNotExist or ProvisioningNotActive or NotEnoughTokens or TokenDoesNotExist or TokenNotAssignable or RequiresSerial or RequiresAuthentication or FailedAuthentication or ContinueAuthentication or TooManyAttempts or OutsideOfTimeWindow or SelectSoftwareTarget or SendSMS or SendEMail or RequiresCustomEnrollment or FailedCustomEnrollment or ChoosePassword or DoesNotMeetRequirements or ProvisioningLocked or ProvisioningExpired or ProvisioningCancelled or ProvisioningCompleted or EditablePhoneEmail or OutOfBand or RequiresHost or OutOfBandNotAvailable or InvalidSerial or DisplayInstruction or UserDoesNotExist or TokenLoadError or RequiresScan</SelectEnrollmentSoftwareTypeResult>
<pInfo>
<InitialPIN>string</InitialPIN>
<PINSide>NONE or TOKEN or SERVER or BOTH</PINSide>
<PINType>NONE or USER_CHANGEABLE or SERVER_CHANGEABLE or FIXED</PINType>
<TokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</TokenType>
<SMSMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</SMSMessages>
<EMailMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</EMailMessages>
<MobileNumberAndPhoneEditable>boolean</MobileNumberAndPhoneEditable>
<MinimumLength>int</MinimumLength>
<MaximumLength>int</MaximumLength>
<MinimumComplexityRequired>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</MinimumComplexityRequired>
<RequiresCustomSetup>boolean</RequiresCustomSetup>
<TokenProvided>boolean</TokenProvided>
<UserName>string</UserName>
<ShortCode>string</ShortCode>
</pInfo>
<tfInfo>
<TransportPIN>string</TransportPIN>
<Serial>string</Serial>
<FileName>string</FileName>
<FileData>base64Binary</FileData>
<NextChallenge>string</NextChallenge>
</tfInfo>
</SelectEnrollmentSoftwareTypeResponse>
</soap12:Body>
</soap12:Envelope>
SendEnrollmentEMail
SendEnrollmentEMail(System.String,ControlLibrary.Enrollment.MessageType,System.String,System.String,System.String,System.String,ControlLibrary.Enrollment.ProvisioningInformation@)
Sends any email messages that you were told to send when either selecting the software token type or while processing the enrollment.
The message and mobile are optional and defaults will be used if they are not provided.
The short code URL is a URL of a web site that the user may be redirected to from their mobile device. If you provide this URL, the page indicated must take a post parameter of 'sc' for the short code. This page should then send the contents of the file provided by GetFileForShortCode.
Parameters
Param: enrollmentCode: Enrollment code
Param: type: Message type you were prompted to send
Param: message: Optional override of the default message
Param: mobileNumber: Optional override of the users email if permitted.
Param: shortCodeURL: URL is a URL of a web site that the user may be redirected to from the email they receive. If you provide this URL, the page indicated must take a post parameter of 'sc' for the short code. This page should then send the contents of the file provided by GetFileForShortCode().
Param: pInfo: Information about the provisioning task. May contain a subsequent message to send
Returns
A table with the following columns:
| Success | |
| Failure | |
| SendSMS | Call SendEnrollmentSMS with the SMS message in the pInfo parameter |
| SendEMail | Call this function again with the email message in the pInfo parameter |
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/SendEnrollmentEMail"
<?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>
<SendEnrollmentEMail xmlns="http://www.cryptocard.com/blackshield/">
<enrollmentCode>string</enrollmentCode>
<type>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</type>
<subject>string</subject>
<message>string</message>
<email>string</email>
<shortCodeURL>string</shortCodeURL>
</SendEnrollmentEMail>
</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>
<SendEnrollmentEMailResponse xmlns="http://www.cryptocard.com/blackshield/">
<SendEnrollmentEMailResult>Success or Failure or SendSMS or SendEMail</SendEnrollmentEMailResult>
<pInfo>
<InitialPIN>string</InitialPIN>
<PINSide>NONE or TOKEN or SERVER or BOTH</PINSide>
<PINType>NONE or USER_CHANGEABLE or SERVER_CHANGEABLE or FIXED</PINType>
<TokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</TokenType>
<SMSMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</SMSMessages>
<EMailMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</EMailMessages>
<MobileNumberAndPhoneEditable>boolean</MobileNumberAndPhoneEditable>
<MinimumLength>int</MinimumLength>
<MaximumLength>int</MaximumLength>
<MinimumComplexityRequired>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</MinimumComplexityRequired>
<RequiresCustomSetup>boolean</RequiresCustomSetup>
<TokenProvided>boolean</TokenProvided>
<UserName>string</UserName>
<ShortCode>string</ShortCode>
</pInfo>
</SendEnrollmentEMailResponse>
</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>
<SendEnrollmentEMail xmlns="http://www.cryptocard.com/blackshield/">
<enrollmentCode>string</enrollmentCode>
<type>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</type>
<subject>string</subject>
<message>string</message>
<email>string</email>
<shortCodeURL>string</shortCodeURL>
</SendEnrollmentEMail>
</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>
<SendEnrollmentEMailResponse xmlns="http://www.cryptocard.com/blackshield/">
<SendEnrollmentEMailResult>Success or Failure or SendSMS or SendEMail</SendEnrollmentEMailResult>
<pInfo>
<InitialPIN>string</InitialPIN>
<PINSide>NONE or TOKEN or SERVER or BOTH</PINSide>
<PINType>NONE or USER_CHANGEABLE or SERVER_CHANGEABLE or FIXED</PINType>
<TokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</TokenType>
<SMSMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</SMSMessages>
<EMailMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</EMailMessages>
<MobileNumberAndPhoneEditable>boolean</MobileNumberAndPhoneEditable>
<MinimumLength>int</MinimumLength>
<MaximumLength>int</MaximumLength>
<MinimumComplexityRequired>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</MinimumComplexityRequired>
<RequiresCustomSetup>boolean</RequiresCustomSetup>
<TokenProvided>boolean</TokenProvided>
<UserName>string</UserName>
<ShortCode>string</ShortCode>
</pInfo>
</SendEnrollmentEMailResponse>
</soap12:Body>
</soap12:Envelope>
SendEnrollmentSMS
SendEnrollmentSMS(System.String,ControlLibrary.Enrollment.MessageType,System.String,System.String,System.String,ControlLibrary.Enrollment.ProvisioningInformation@)
Sends any SMS messages that you were told to send when either selecting the software token type or while processing the enrollment.
The message and mobile are optional and defaults will be used if they are not provided.
The short code URL is a URL of a web site that the user may be redirected to from their mobile device. If you provide this URL, the page indicated must take a post parameter of sc for the short code. This page should then send the contents of the file provided by GetFileForShortCode.
Parameters
Param: enrollmentCode: Enrollment code
Param: type: Message type you were prompted to send
Param: message: Optional override of the default message
Param: mobileNumber: Optional override of the users mobile number if permitted.
Param: shortCodeURL: URL is a URL of a web site that the user may be redirected to from their mobile device. If you provide this URL, the page indicated must take a post parameter of 'sc' for the short code. This page should then send the contents of the file provided by GetFileForShortCode()
Param: pInfo: Information about the provisioning task. May contain a subsequent message to send
Returns
A table with the following columns:
| Success | |
| Failure | |
| SendSMS | Call this function again with the SMS message in the pInfo parameter |
| SendEMail | Call SendEnrollmentEMail with the email message in the pInfo parameter |
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/SendEnrollmentSMS"
<?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>
<SendEnrollmentSMS xmlns="http://www.cryptocard.com/blackshield/">
<enrollmentCode>string</enrollmentCode>
<type>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</type>
<message>string</message>
<mobileNumber>string</mobileNumber>
<shortCodeURL>string</shortCodeURL>
</SendEnrollmentSMS>
</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>
<SendEnrollmentSMSResponse xmlns="http://www.cryptocard.com/blackshield/">
<SendEnrollmentSMSResult>Success or Failure or SendSMS or SendEMail</SendEnrollmentSMSResult>
<pInfo>
<InitialPIN>string</InitialPIN>
<PINSide>NONE or TOKEN or SERVER or BOTH</PINSide>
<PINType>NONE or USER_CHANGEABLE or SERVER_CHANGEABLE or FIXED</PINType>
<TokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</TokenType>
<SMSMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</SMSMessages>
<EMailMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</EMailMessages>
<MobileNumberAndPhoneEditable>boolean</MobileNumberAndPhoneEditable>
<MinimumLength>int</MinimumLength>
<MaximumLength>int</MaximumLength>
<MinimumComplexityRequired>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</MinimumComplexityRequired>
<RequiresCustomSetup>boolean</RequiresCustomSetup>
<TokenProvided>boolean</TokenProvided>
<UserName>string</UserName>
<ShortCode>string</ShortCode>
</pInfo>
</SendEnrollmentSMSResponse>
</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>
<SendEnrollmentSMS xmlns="http://www.cryptocard.com/blackshield/">
<enrollmentCode>string</enrollmentCode>
<type>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</type>
<message>string</message>
<mobileNumber>string</mobileNumber>
<shortCodeURL>string</shortCodeURL>
</SendEnrollmentSMS>
</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>
<SendEnrollmentSMSResponse xmlns="http://www.cryptocard.com/blackshield/">
<SendEnrollmentSMSResult>Success or Failure or SendSMS or SendEMail</SendEnrollmentSMSResult>
<pInfo>
<InitialPIN>string</InitialPIN>
<PINSide>NONE or TOKEN or SERVER or BOTH</PINSide>
<PINType>NONE or USER_CHANGEABLE or SERVER_CHANGEABLE or FIXED</PINType>
<TokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</TokenType>
<SMSMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</SMSMessages>
<EMailMessages>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
<MessageInformation>
<MessageType>iPhoneEmail or JavaPhoneOTASMS or JavaPhoneUSBEmail or BlackberrySoftwarePINEmail or BlackberryTokenEmail or WindowsPhoneEmail or AndroidEmail or MacOSXEmail or DSKPPEmail</MessageType>
<DefaultSubject>string</DefaultSubject>
<DefaultMessage>string</DefaultMessage>
<DefaultRecipient>string</DefaultRecipient>
<ShortCodeURL>string</ShortCodeURL>
</MessageInformation>
</EMailMessages>
<MobileNumberAndPhoneEditable>boolean</MobileNumberAndPhoneEditable>
<MinimumLength>int</MinimumLength>
<MaximumLength>int</MaximumLength>
<MinimumComplexityRequired>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</MinimumComplexityRequired>
<RequiresCustomSetup>boolean</RequiresCustomSetup>
<TokenProvided>boolean</TokenProvided>
<UserName>string</UserName>
<ShortCode>string</ShortCode>
</pInfo>
</SendEnrollmentSMSResponse>
</soap12:Body>
</soap12:Envelope>
