Hardware token endpoints
AllocateHardware
AllocateHardware(System.Collections.Generic.List{System.String},DataLayer.Entity.Token.TokenType,DataLayer.Entity.Transaction.BillingStyle,System.Boolean,System.Boolean,System.String)
Allocate hardware tokens to a child account. This includes KT, RB and OATH tokens.
Parameters
Param: serials: List of serial numbers to allocate
Param: tokenType: Token type of the allocation
Param: billingStyle: Billing style of the allocation: Allocation, Activation, Authentication or Transfer
Param: withCapacity: True to automatically add license capacity with the tokens
Param: isSale: True if this is a sale, false for rental.
Param: toOrganization: Account to allocate to
Returns
- True if allocated successfully
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/AllocateHardware"
<?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>
<AllocateHardware xmlns="http://www.cryptocard.com/blackshield/">
<serials>
<string>string</string>
<string>string</string>
</serials>
<tokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</tokenType>
<billingStyle>Allocation or Activation or Authentication or Transfer</billingStyle>
<withCapacity>boolean</withCapacity>
<isSale>boolean</isSale>
<toOrganization>string</toOrganization>
</AllocateHardware>
</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>
<AllocateHardwareResponse xmlns="http://www.cryptocard.com/blackshield/">
<AllocateHardwareResult>boolean</AllocateHardwareResult>
</AllocateHardwareResponse>
</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>
<AllocateHardware xmlns="http://www.cryptocard.com/blackshield/">
<serials>
<string>string</string>
<string>string</string>
</serials>
<tokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</tokenType>
<billingStyle>Allocation or Activation or Authentication or Transfer</billingStyle>
<withCapacity>boolean</withCapacity>
<isSale>boolean</isSale>
<toOrganization>string</toOrganization>
</AllocateHardware>
</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>
<AllocateHardwareResponse xmlns="http://www.cryptocard.com/blackshield/">
<AllocateHardwareResult>boolean</AllocateHardwareResult>
</AllocateHardwareResponse>
</soap12:Body>
</soap12:Envelope>
DeallocateHardware
DeallocateHardware(System.Collections.Generic.List{System.String},DataLayer.Entity.Token.TokenType,ControlLibrary.AccountsControl.TokensSelection,System.Boolean,System.String,System.String)
De-allocate hardware tokens from a child account. This includes KT, RB and OATH tokens.
Parameters
Param: serials: List of serials to de-allocate from the child account
Param: tokenType: Token type to de-allocate
Param: deallocationState: State to return tokens to: ReturntoInventory_Initialized, ReturntoInventory_NotInitialized, Faulty, Lost
Param: isSale: True if tokens are being sold back up the chain.
Param: intoContainer: Container to place the tokens into
Param: fromOrganization: Account to move tokens from
Returns:
- True if tokens are de-allocated
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/DeallocateHardware"
<?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>
<DeallocateHardware xmlns="http://www.cryptocard.com/blackshield/">
<serials>
<string>string</string>
<string>string</string>
</serials>
<tokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</tokenType>
<deallocationState>ReturntoInventory_Initialized or ReturntoInventory_NotInitialized or Faulty or Lost</deallocationState>
<isSale>boolean</isSale>
<intoContainer>string</intoContainer>
<fromOrganization>string</fromOrganization>
</DeallocateHardware>
</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>
<DeallocateHardwareResponse xmlns="http://www.cryptocard.com/blackshield/">
<DeallocateHardwareResult>boolean</DeallocateHardwareResult>
</DeallocateHardwareResponse>
</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>
<DeallocateHardware xmlns="http://www.cryptocard.com/blackshield/">
<serials>
<string>string</string>
<string>string</string>
</serials>
<tokenType>KT or RB or MP or LEGACY or SMS or OATH or CUSTOM or GOLD or eToken or MobilePASS or GoogleAuthenticator</tokenType>
<deallocationState>ReturntoInventory_Initialized or ReturntoInventory_NotInitialized or Faulty or Lost</deallocationState>
<isSale>boolean</isSale>
<intoContainer>string</intoContainer>
<fromOrganization>string</fromOrganization>
</DeallocateHardware>
</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>
<DeallocateHardwareResponse xmlns="http://www.cryptocard.com/blackshield/">
<DeallocateHardwareResult>boolean</DeallocateHardwareResult>
</DeallocateHardwareResponse>
</soap12:Body>
</soap12:Envelope>
