Deprecated BSIDCA endpoints
Deprecated endpoints are no longer supported and may also no longer be functional.
ICE token endpoints
AllocateICE - DEPRECATED
Deprecated endpoints are no longer supported and may also no longer be functional.
AllocateICE(System.Int32,DataLayer.Entity.Transaction.BillingStyle,System.String)
Allocate ICE capacity to a child account. ICE tokens will automatically be allocated to the child account if required and available to be allocated.
Parameters
Param: quantity: ICE Capacity to allocate
Param: billingStyle: Billing style of the allocation: Allocation, Activation, Authentication or Transfer
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/AllocateICE"
<?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>
<AllocateICE xmlns="http://www.cryptocard.com/blackshield/">
<quantity>int</quantity>
<billingStyle>Allocation or Activation or Authentication or Transfer</billingStyle>
<toOrganization>string</toOrganization>
</AllocateICE>
</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>
<AllocateICEResponse xmlns="http://www.cryptocard.com/blackshield/">
<AllocateICEResult>boolean</AllocateICEResult>
</AllocateICEResponse>
</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>
<AllocateICE xmlns="http://www.cryptocard.com/blackshield/">
<quantity>int</quantity>
<billingStyle>Allocation or Activation or Authentication or Transfer</billingStyle>
<toOrganization>string</toOrganization>
</AllocateICE>
</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>
<AllocateICEResponse xmlns="http://www.cryptocard.com/blackshield/">
<AllocateICEResult>boolean</AllocateICEResult>
</AllocateICEResponse>
</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/AllocateICE?quantity=string&billingStyle=string&toOrganization=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/AllocateICE HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
quantity=string&billingStyle=string&toOrganization=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>
DeallocateICE - DEPRECATED
Deprecated endpoints are no longer supported and may also no longer be functional.
DeallocateICE(System.Int32,System.String,System.String)
De-allocate ICE capacity from a child account.
Parameters
Param: quantity: Capacity to de-allocate
Param: fromOrganization: Account to de-allocate from
Param: intoContainer: Container to move any tokens into
Returns
- True if 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/DeallocateICE"
<?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>
<DeallocateICE xmlns="http://www.cryptocard.com/blackshield/">
<quantity>int</quantity>
<fromOrganization>string</fromOrganization>
<intoContainer>string</intoContainer>
</DeallocateICE>
</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>
<DeallocateICEResponse xmlns="http://www.cryptocard.com/blackshield/">
<DeallocateICEResult>boolean</DeallocateICEResult>
</DeallocateICEResponse>
</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>
<DeallocateICE xmlns="http://www.cryptocard.com/blackshield/">
<quantity>int</quantity>
<fromOrganization>string</fromOrganization>
<intoContainer>string</intoContainer>
</DeallocateICE>
</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>
<DeallocateICEResponse xmlns="http://www.cryptocard.com/blackshield/">
<DeallocateICEResult>boolean</DeallocateICEResult>
</DeallocateICEResponse>
</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/DeallocateICE?quantity=string&fromOrganization=string&intoContainer=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/DeallocateICE HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
quantity=string&fromOrganization=string&intoContainer=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>
MobilePASS endpoints
GetTokenFile - DEPRECATED
Deprecated endpoints are no longer supported and may also no longer be functional.
GetTokenFile(System.String,System.String,System.String@)
Gets a token file. Used for issuing MP tokens that are assigned to users. NOTE: Calling this function will re-initialize the MP on the server.
Parameters
Param: serial: Serial number of the token to download.
Param: organization: Account
Param: fileName: Will return the name that the file should have. If so desired, another name can be used, but the extension must be kept.
Returns
Token file - To be used, the user will require the initial PIN (or transport PIN for tokens with no PIN)
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/GetTokenFile"
<?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>
<GetTokenFile xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<organization>string</organization>
</GetTokenFile>
</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>
<GetTokenFileResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenFileResult>base64Binary</GetTokenFileResult>
<fileName>string</fileName>
</GetTokenFileResponse>
</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>
<GetTokenFile xmlns="http://www.cryptocard.com/blackshield/">
<serial>string</serial>
<organization>string</organization>
</GetTokenFile>
</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>
<GetTokenFileResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetTokenFileResult>base64Binary</GetTokenFileResult>
<fileName>string</fileName>
</GetTokenFileResponse>
</soap12:Body>
</soap12:Envelope>
RSA SecurID endpoints
AllocateRSA - DEPRECATED
Deprecated endpoints are no longer supported and may also no longer be functional.
AllocateRSA(System.Collections.Generic.List{System.String},DataLayer.Entity.Transaction.BillingStyle,System.Boolean,System.Boolean,System.String)
Allocate RSA SecurID tokens to a child account
Parameters
Param: serials: List of serial numbers to allocate
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/AllocateRSA"
<?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>
<AllocateRSA xmlns="http://www.cryptocard.com/blackshield/">
<serials>
<string>string</string>
<string>string</string>
</serials>
<billingStyle>Allocation or Activation or Authentication or Transfer</billingStyle>
<withCapacity>boolean</withCapacity>
<isSale>boolean</isSale>
<toOrganization>string</toOrganization>
</AllocateRSA>
</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>
<AllocateRSAResponse xmlns="http://www.cryptocard.com/blackshield/">
<AllocateRSAResult>boolean</AllocateRSAResult>
</AllocateRSAResponse>
</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>
<AllocateRSA xmlns="http://www.cryptocard.com/blackshield/">
<serials>
<string>string</string>
<string>string</string>
</serials>
<billingStyle>Allocation or Activation or Authentication or Transfer</billingStyle>
<withCapacity>boolean</withCapacity>
<isSale>boolean</isSale>
<toOrganization>string</toOrganization>
</AllocateRSA>
</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>
<AllocateRSAResponse xmlns="http://www.cryptocard.com/blackshield/">
<AllocateRSAResult>boolean</AllocateRSAResult>
</AllocateRSAResponse>
</soap12:Body>
</soap12:Envelope>
DeallocateRSA - DEPRECATED
Deprecated endpoints are no longer supported and may also no longer be functional.
DeallocateRSA(System.Collections.Generic.List{System.String},System.Boolean,System.String,System.String)
De-allocate RSA SecurID tokens from a child account.
Parameters
Param: serials: List of serials to de-allocate from the child account
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/DeallocateRSA"
<?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>
<DeallocateRSA xmlns="http://www.cryptocard.com/blackshield/">
<serials>
<string>string</string>
<string>string</string>
</serials>
<isSale>boolean</isSale>
<intoContainer>string</intoContainer>
<fromOrganization>string</fromOrganization>
</DeallocateRSA>
</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>
<DeallocateRSAResponse xmlns="http://www.cryptocard.com/blackshield/">
<DeallocateRSAResult>boolean</DeallocateRSAResult>
</DeallocateRSAResponse>
</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>
<DeallocateRSA xmlns="http://www.cryptocard.com/blackshield/">
<serials>
<string>string</string>
<string>string</string>
</serials>
<isSale>boolean</isSale>
<intoContainer>string</intoContainer>
<fromOrganization>string</fromOrganization>
</DeallocateRSA>
</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>
<DeallocateRSAResponse xmlns="http://www.cryptocard.com/blackshield/">
<DeallocateRSAResult>boolean</DeallocateRSAResult>
</DeallocateRSAResponse>
</soap12:Body>
</soap12:Envelope>
Shibboleth endpoints
AddShibbolethNode - DEPRECATED
Deprecated endpoints are no longer supported and may also no longer be functional.
AddShibbolethNode(BlackShield.BSIDCA.ShibbolethNode,System.String,System.String,System.String)
Adds a Shibboleth service provider. This function is available only if Shibboleth is available for a virtual server. It does not apply to Application Management.
Parameters
Param: node: ShibbolethNode to add
Param: entityIdString: Metadata that specifies the unique URI identifier of the SAML entity whose metadata is described by the element's contents.
Param: locationString: Metadata required URI attribute that specifies the location of the endpoint. The allowable syntax of this URI depends on the protocol binding.
Param: organization: Account
Returns
- True if added
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/AddShibbolethNode"
<?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>
<AddShibbolethNode xmlns="http://www.cryptocard.com/blackshield/">
<node>
<AuthenticationFlowID>int</AuthenticationFlowID>
<IdFirstEnabled>boolean</IdFirstEnabled>
<RiskBasedAuthenticationEnabled>boolean</RiskBasedAuthenticationEnabled>
<RememberMeLabel>string</RememberMeLabel>
<ForgetMeLabel>string</ForgetMeLabel>
<RememberMeHelpText>string</RememberMeHelpText>
<OrText>string</OrText>
<SignInText>string</SignInText>
<SignOutText>string</SignOutText>
<SAMLMetaData>string</SAMLMetaData>
<LogoImage>base64Binary</LogoImage>
<LogoImageExtension>string</LogoImageExtension>
<CSS>string</CSS>
<ButtonImage>base64Binary</ButtonImage>
<ButtonImageExtension>string</ButtonImageExtension>
<PageTitle>string</PageTitle>
<Icon>base64Binary</Icon>
<Header>string</Header>
<ButtonText>string</ButtonText>
<LoginMessage>string</LoginMessage>
<UserNameLabel>string</UserNameLabel>
<PasswordLabel>string</PasswordLabel>
<FriendlyName>string</FriendlyName>
<SpAttributes>
<ServiceProviderAttribute>
<AttributeName>string</AttributeName>
<AttributeValue>string</AttributeValue>
<AttributeType>UserId or Name or LastName or FirstName or EmailAddress or Alias1 or Alias2 or Groups or UPN or Custom or UserObjectGUID or SamlAccount or Alias3 or Alias4 or Custom1 or Custom2 or Custom3</AttributeType>
</ServiceProviderAttribute>
<ServiceProviderAttribute>
<AttributeName>string</AttributeName>
<AttributeValue>string</AttributeValue>
<AttributeType>UserId or Name or LastName or FirstName or EmailAddress or Alias1 or Alias2 or Groups or UPN or Custom or UserObjectGUID or SamlAccount or Alias3 or Alias4 or Custom1 or Custom2 or Custom3</AttributeType>
</ServiceProviderAttribute>
</SpAttributes>
<ModifiedBy>string</ModifiedBy>
<ModifiedByOrganization>string</ModifiedByOrganization>
<EnableOtpPush>boolean</EnableOtpPush>
<PushOrManualOtpSelectorText>string</PushOrManualOtpSelectorText>
<PushOtpButtonText>string</PushOtpButtonText>
<ManualOtpButtonText>string</ManualOtpButtonText>
<PushOtpProcessingText>string</PushOtpProcessingText>
<PushOtpCancellationText>string</PushOtpCancellationText>
<PushOtpCancellationLink>string</PushOtpCancellationLink>
<PushOtpAuthenticatingText>string</PushOtpAuthenticatingText>
<RelyingPartyID>string</RelyingPartyID>
<ResourceName>string</ResourceName>
<ModifiedTime>string</ModifiedTime>
</node>
<entityIdString>string</entityIdString>
<locationString>string</locationString>
<organization>string</organization>
</AddShibbolethNode>
</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>
<AddShibbolethNodeResponse xmlns="http://www.cryptocard.com/blackshield/">
<AddShibbolethNodeResult>boolean</AddShibbolethNodeResult>
</AddShibbolethNodeResponse>
</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>
<AddShibbolethNode xmlns="http://www.cryptocard.com/blackshield/">
<node>
<AuthenticationFlowID>int</AuthenticationFlowID>
<IdFirstEnabled>boolean</IdFirstEnabled>
<RiskBasedAuthenticationEnabled>boolean</RiskBasedAuthenticationEnabled>
<RememberMeLabel>string</RememberMeLabel>
<ForgetMeLabel>string</ForgetMeLabel>
<RememberMeHelpText>string</RememberMeHelpText>
<OrText>string</OrText>
<SignInText>string</SignInText>
<SignOutText>string</SignOutText>
<SAMLMetaData>string</SAMLMetaData>
<LogoImage>base64Binary</LogoImage>
<LogoImageExtension>string</LogoImageExtension>
<CSS>string</CSS>
<ButtonImage>base64Binary</ButtonImage>
<ButtonImageExtension>string</ButtonImageExtension>
<PageTitle>string</PageTitle>
<Icon>base64Binary</Icon>
<Header>string</Header>
<ButtonText>string</ButtonText>
<LoginMessage>string</LoginMessage>
<UserNameLabel>string</UserNameLabel>
<PasswordLabel>string</PasswordLabel>
<FriendlyName>string</FriendlyName>
<SpAttributes>
<ServiceProviderAttribute>
<AttributeName>string</AttributeName>
<AttributeValue>string</AttributeValue>
<AttributeType>UserId or Name or LastName or FirstName or EmailAddress or Alias1 or Alias2 or Groups or UPN or Custom or UserObjectGUID or SamlAccount or Alias3 or Alias4 or Custom1 or Custom2 or Custom3</AttributeType>
</ServiceProviderAttribute>
<ServiceProviderAttribute>
<AttributeName>string</AttributeName>
<AttributeValue>string</AttributeValue>
<AttributeType>UserId or Name or LastName or FirstName or EmailAddress or Alias1 or Alias2 or Groups or UPN or Custom or UserObjectGUID or SamlAccount or Alias3 or Alias4 or Custom1 or Custom2 or Custom3</AttributeType>
</ServiceProviderAttribute>
</SpAttributes>
<ModifiedBy>string</ModifiedBy>
<ModifiedByOrganization>string</ModifiedByOrganization>
<EnableOtpPush>boolean</EnableOtpPush>
<PushOrManualOtpSelectorText>string</PushOrManualOtpSelectorText>
<PushOtpButtonText>string</PushOtpButtonText>
<ManualOtpButtonText>string</ManualOtpButtonText>
<PushOtpProcessingText>string</PushOtpProcessingText>
<PushOtpCancellationText>string</PushOtpCancellationText>
<PushOtpCancellationLink>string</PushOtpCancellationLink>
<PushOtpAuthenticatingText>string</PushOtpAuthenticatingText>
<RelyingPartyID>string</RelyingPartyID>
<ResourceName>string</ResourceName>
<ModifiedTime>string</ModifiedTime>
</node>
<entityIdString>string</entityIdString>
<locationString>string</locationString>
<organization>string</organization>
</AddShibbolethNode>
</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>
<AddShibbolethNodeResponse xmlns="http://www.cryptocard.com/blackshield/">
<AddShibbolethNodeResult>boolean</AddShibbolethNodeResult>
</AddShibbolethNodeResponse>
</soap12:Body>
</soap12:Envelope>
RemoveShibbolethNode - DEPRECATED
Deprecated endpoints are no longer supported and may also no longer be functional.
RemoveShibbolethNode(System.String,System.String)
Removes a Shibboleth service provider.
Parameters
Param: node: ShibbolethNode to remove
Param: relyingId: The URL that the Shibboleth agent uses to communicate with SAS PCE/STA regarding any changes related to the addition or removal of a service provider.
Param: organization: Account
Returns
- True if 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/RemoveShibbolethNode"
<?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>
<RemoveShibbolethNode xmlns="http://www.cryptocard.com/blackshield/">
<relyingId>string</relyingId>
<organization>string</organization>
</RemoveShibbolethNode>
</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>
<RemoveShibbolethNodeResponse xmlns="http://www.cryptocard.com/blackshield/">
<RemoveShibbolethNodeResult>boolean</RemoveShibbolethNodeResult>
</RemoveShibbolethNodeResponse>
</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>
<RemoveShibbolethNode xmlns="http://www.cryptocard.com/blackshield/">
<relyingId>string</relyingId>
<organization>string</organization>
</RemoveShibbolethNode>
</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>
<RemoveShibbolethNodeResponse xmlns="http://www.cryptocard.com/blackshield/">
<RemoveShibbolethNodeResult>boolean</RemoveShibbolethNodeResult>
</RemoveShibbolethNodeResponse>
</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/RemoveShibbolethNode?relyingId=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/RemoveShibbolethNode HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
relyingId=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>
SIM token endpoints
ReprovisionAllSIMTokens - DEPRECATED
Deprecated endpoints are no longer supported and may also no longer be functional.
ReprovisionAllSIMTokens(System.String,System.String)
Reprovision all of a SIM's tokens. Only reprovisions tokens that belong to the given organization or any of their descendants.
Parameters
Param: userName: MSISDN to reprovision tokens to.
Param: organization: Organization the user is in
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/ReprovisionAllSIMTokens"
<?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>
<ReprovisionAllSIMTokens xmlns="http://www.cryptocard.com/blackshield/">
<MSISDN>string</MSISDN>
<organization>string</organization>
</ReprovisionAllSIMTokens>
</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>
<ReprovisionAllSIMTokensResponse xmlns="http://www.cryptocard.com/blackshield/">
<ReprovisionAllSIMTokensResult>boolean</ReprovisionAllSIMTokensResult>
</ReprovisionAllSIMTokensResponse>
</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>
<ReprovisionAllSIMTokens xmlns="http://www.cryptocard.com/blackshield/">
<MSISDN>string</MSISDN>
<organization>string</organization>
</ReprovisionAllSIMTokens>
</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>
<ReprovisionAllSIMTokensResponse xmlns="http://www.cryptocard.com/blackshield/">
<ReprovisionAllSIMTokensResult>boolean</ReprovisionAllSIMTokensResult>
</ReprovisionAllSIMTokensResponse>
</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/ReprovisionAllSIMTokens?MSISDN=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/ReprovisionAllSIMTokens HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
MSISDN=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>
RevokeAllSIMTokens - DEPRECATED
Deprecated endpoints are no longer supported and may also no longer be functional.
RevokeAllSIMTokens(System.String,System.String)
Revokes all of a SIM's tokens. Only revokes tokens that belong to the given organization or any of their descendants.
Parameters
Param: userName: MSISDN to revoke tokens from
Param: organization: Organization the user is in
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/RevokeAllSIMTokens"
<?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>
<RevokeAllSIMTokens xmlns="http://www.cryptocard.com/blackshield/">
<MSISDN>string</MSISDN>
<organization>string</organization>
</RevokeAllSIMTokens>
</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>
<RevokeAllSIMTokensResponse xmlns="http://www.cryptocard.com/blackshield/">
<RevokeAllSIMTokensResult>boolean</RevokeAllSIMTokensResult>
</RevokeAllSIMTokensResponse>
</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>
<RevokeAllSIMTokens xmlns="http://www.cryptocard.com/blackshield/">
<MSISDN>string</MSISDN>
<organization>string</organization>
</RevokeAllSIMTokens>
</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>
<RevokeAllSIMTokensResponse xmlns="http://www.cryptocard.com/blackshield/">
<RevokeAllSIMTokensResult>boolean</RevokeAllSIMTokensResult>
</RevokeAllSIMTokensResponse>
</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/RevokeAllSIMTokens?MSISDN=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/RevokeAllSIMTokens HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
MSISDN=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>
User endpoints
AddSamlUserExtension - DEPRECATED
Deprecated endpoints are no longer supported and may also no longer be functional.
AddSamlExtension(DataLayer.Entity.SAMLUserExtension,System.String,System.String)
Adds a SAML service to a user. This function is available only if Shibboleth is available for a virtual server. It does not apply to Application Management.
Parameters
Param: extension: SAML user extension to add
Param: userName: User Name
Param: organization: Account
Returns
- True if added
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/AddSamlUserExtension"
<?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>
<AddSamlUserExtension xmlns="http://www.cryptocard.com/blackshield/">
<ext>
<Mode>None or UserID or Email or Custom</Mode>
<CustomValue>string</CustomValue>
<Status>Active or Disabled or Overwritten</Status>
<ModifiedBy>string</ModifiedBy>
<ModifiedByOrganization>string</ModifiedByOrganization>
<RelyingPartyID>string</RelyingPartyID>
<ModifiedTime>string</ModifiedTime>
</ext>
<userId>string</userId>
<organization>string</organization>
</AddSamlUserExtension>
</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>
<AddSamlUserExtensionResponse xmlns="http://www.cryptocard.com/blackshield/">
<AddSamlUserExtensionResult>boolean</AddSamlUserExtensionResult>
</AddSamlUserExtensionResponse>
</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>
<AddSamlUserExtension xmlns="http://www.cryptocard.com/blackshield/">
<ext>
<Mode>None or UserID or Email or Custom</Mode>
<CustomValue>string</CustomValue>
<Status>Active or Disabled or Overwritten</Status>
<ModifiedBy>string</ModifiedBy>
<ModifiedByOrganization>string</ModifiedByOrganization>
<RelyingPartyID>string</RelyingPartyID>
<ModifiedTime>string</ModifiedTime>
</ext>
<userId>string</userId>
<organization>string</organization>
</AddSamlUserExtension>
</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>
<AddSamlUserExtensionResponse xmlns="http://www.cryptocard.com/blackshield/">
<AddSamlUserExtensionResult>boolean</AddSamlUserExtensionResult>
</AddSamlUserExtensionResponse>
</soap12:Body>
</soap12:Envelope>