Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

Thales Logo

All

  • All
back

BSIDCA endpoints

Operator endpoints

search

Operator endpoints

AddExternalOperator

AddExternalOperator(System.string,System.string,System.string,Generic.List{System.String})

Adds an external operator using a delegation code for external management of another account.

Parameters

Param: delegationCode: Delegation code used to add external operator

Param: organization: Organization that consumes the delegation code to add an external operator

Param: roleName: (Optional) Name of the role used for the external operator; default, "Operator"

Param: containers: String list of containers that the operator will have access to (this parameter is optional if the role defined in roleName is an account manager)

Returns

  • True if added successfully; otherwise False

SOAP 1.1 sample

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/AddExternalOperator"

<?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>
    <AddExternalOperator xmlns="http://www.cryptocard.com/blackshield/">
    <delegationCode>string</delegationCode>
    <organization>string</organization>
    <roleName>string</roleName>
    <containers>
        <string>string</string>
        <string>string</string>
    </containers>
    </AddExternalOperator>
</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>
    <AddExternalOperatorResponse xmlns="http://www.cryptocard.com/blackshield/">
    <AddExternalOperatorResult>boolean</AddExternalOperatorResult>
    </AddExternalOperatorResponse>
</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>
    <AddExternalOperator xmlns="http://www.cryptocard.com/blackshield/">
    <delegationCode>string</delegationCode>
    <organization>string</organization>
    <roleName>string</roleName>
    <containers>
        <string>string</string>
        <string>string</string>
    </containers>
    </AddExternalOperator>
</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>
    <AddExternalOperatorResponse xmlns="http://www.cryptocard.com/blackshield/">
    <AddExternalOperatorResult>boolean</AddExternalOperatorResult>
    </AddExternalOperatorResponse>
</soap12:Body>
</soap12:Envelope>

AddOperator

AddOperator(DataLayer.Entity.User,DataLayer.Entity.ProvisioningEntry.TokenOption,System.Nullable{System.Int32},System.String)

Adds an operator to a child account. If the account is a service provider, the created operator will have administrator permissions on the account as well.

Parameters

Param: user: User to add as an operator. Must be a new user.

Param: tokenType: The type of token/password to provision to the user.

Param: modelNumber: Model Number for custom tokens. GrIDsure = 10001, SecurID = 10002, RADIUS = 10004

Param: organization: Account

Returns:

  • Success

  • UnknownError

  • UserAlreadyExists

  • FailedToCreateUser

  • FailedToProvision

  • EmailAddressAlreadyInUse

  • FailedToSendEnrollmentEmail

  • NotEnoughSMSTokens

  • FailedToSendSMSMessage

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/AddOperator"

<?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>
    <AddOperator xmlns="http://www.cryptocard.com/blackshield/">
    <user>
        <Groups>
        <Group>
            <GroupName>string</GroupName>
            <Description>string</Description>
            <ReadOnly>boolean</ReadOnly>
            <Empty>boolean</Empty>
        </Group>
        <Group>
            <GroupName>string</GroupName>
            <Description>string</Description>
            <ReadOnly>boolean</ReadOnly>
            <Empty>boolean</Empty>
        </Group>
        </Groups>
        <PreferredLanguage>int</PreferredLanguage>
        <PasswordSetDate>string</PasswordSetDate>
        <PasswordExpiryDate>string</PasswordExpiryDate>
        <PasswordAttemptCount>int</PasswordAttemptCount>
        <UserName>string</UserName>
        <FirstName>string</FirstName>
        <Lastname>string</Lastname>
        <Address1>string</Address1>
        <City>string</City>
        <State>string</State>
        <Country>string</Country>
        <Zip>string</Zip>
        <Email>string</Email>
        <Telephone>string</Telephone>
        <Countrycode>string</Countrycode>
        <Extension>string</Extension>
        <Mobile>string</Mobile>
        <Fax>string</Fax>
        <Locked>boolean</Locked>
        <CustomAttributes>
        <string>string</string>
        <string>string</string>
        </CustomAttributes>
        <UnlockAt>string</UnlockAt>
        <Message>string</Message>
        <TempPasswordEnabled>boolean</TempPasswordEnabled>
        <TempPasswordChangeReq>boolean</TempPasswordChangeReq>
        <ContainerName>string</ContainerName>
        <UseExternalCredentials>boolean</UseExternalCredentials>
        <IsAccountDormant>boolean</IsAccountDormant>
    </user>
    <tokenType>Software or Custom or Oath or SMS or Password or KT or RB or ICE or GOLD or eToken or MobilePASS or GoogleAuthenticator</tokenType>
    <modelNumber>int</modelNumber>
    <organization>string</organization>
    </AddOperator>
</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>
    <AddOperatorResponse xmlns="http://www.cryptocard.com/blackshield/">
    <AddOperatorResult>Success or UnknownError or UserAlreadyExists or FailedToCreateUser or FailedToProvision or EmailAddressAlreadyInUse or FailedToSendEnrollmentEmail or NotEnoughSMSTokens or FailedToSendSMSMessage or AliasEqualsUserName</AddOperatorResult>
    </AddOperatorResponse>
</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>
    <AddOperator xmlns="http://www.cryptocard.com/blackshield/">
    <user>
        <Groups>
        <Group>
            <GroupName>string</GroupName>
            <Description>string</Description>
            <ReadOnly>boolean</ReadOnly>
            <Empty>boolean</Empty>
        </Group>
        <Group>
            <GroupName>string</GroupName>
            <Description>string</Description>
            <ReadOnly>boolean</ReadOnly>
            <Empty>boolean</Empty>
        </Group>
        </Groups>
        <PreferredLanguage>int</PreferredLanguage>
        <PasswordSetDate>string</PasswordSetDate>
        <PasswordExpiryDate>string</PasswordExpiryDate>
        <PasswordAttemptCount>int</PasswordAttemptCount>
        <UserName>string</UserName>
        <FirstName>string</FirstName>
        <Lastname>string</Lastname>
        <Address1>string</Address1>
        <City>string</City>
        <State>string</State>
        <Country>string</Country>
        <Zip>string</Zip>
        <Email>string</Email>
        <Telephone>string</Telephone>
        <Countrycode>string</Countrycode>
        <Extension>string</Extension>
        <Mobile>string</Mobile>
        <Fax>string</Fax>
        <Locked>boolean</Locked>
        <CustomAttributes>
        <string>string</string>
        <string>string</string>
        </CustomAttributes>
        <UnlockAt>string</UnlockAt>
        <Message>string</Message>
        <TempPasswordEnabled>boolean</TempPasswordEnabled>
        <TempPasswordChangeReq>boolean</TempPasswordChangeReq>
        <ContainerName>string</ContainerName>
        <UseExternalCredentials>boolean</UseExternalCredentials>
        <IsAccountDormant>boolean</IsAccountDormant>
    </user>
    <tokenType>Software or Custom or Oath or SMS or Password or KT or RB or ICE or GOLD or eToken or MobilePASS or GoogleAuthenticator</tokenType>
    <modelNumber>int</modelNumber>
    <organization>string</organization>
    </AddOperator>
</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>
    <AddOperatorResponse xmlns="http://www.cryptocard.com/blackshield/">
    <AddOperatorResult>Success or UnknownError or UserAlreadyExists or FailedToCreateUser or FailedToProvision or EmailAddressAlreadyInUse or FailedToSendEnrollmentEmail or NotEnoughSMSTokens or FailedToSendSMSMessage or AliasEqualsUserName</AddOperatorResult>
    </AddOperatorResponse>
</soap12:Body>
</soap12:Envelope>

GetExternalOperators

GetExternalOperators(System.String)

Get a list of eternal operators in the given account.

Parameters

Param: organization: Account

Returns

  • List of external operator (account names)

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/GetExternalOperators"

<?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>
    <GetExternalOperators xmlns="http://www.cryptocard.com/blackshield/">
      <organization>string</organization>
    </GetExternalOperators>
  </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>
    <GetExternalOperatorsResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetExternalOperatorsResult>
        <string>string</string>
        <string>string</string>
      </GetExternalOperatorsResult>
    </GetExternalOperatorsResponse>
  </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>
    <GetExternalOperators xmlns="http://www.cryptocard.com/blackshield/">
      <organization>string</organization>
    </GetExternalOperators>
  </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>
    <GetExternalOperatorsResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetExternalOperatorsResult>
        <string>string</string>
        <string>string</string>
      </GetExternalOperatorsResult>
    </GetExternalOperatorsResponse>
  </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/GetExternalOperators?organization=string HTTP/1.1
Host: cloud.safenet-inc.com

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfString xmlns="http://www.cryptocard.com/blackshield/">
  <string>string</string>
  <string>string</string>
</ArrayOfString>

HTTP POST sample

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx/GetExternalOperators HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

organization=string

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfString xmlns="http://www.cryptocard.com/blackshield/">
  <string>string</string>
  <string>string</string>
</ArrayOfString>

GetOperators

GetOperators(System.String)

Get a list of operators in the given account.

Parameter

Param: organization: Account

Returns

  • List of operator names

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/GetOperators"

<?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>
    <GetOperators xmlns="http://www.cryptocard.com/blackshield/">
      <organization>string</organization>
    </GetOperators>
  </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>
    <GetOperatorsResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetOperatorsResult>
        <string>string</string>
        <string>string</string>
      </GetOperatorsResult>
    </GetOperatorsResponse>
  </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>
    <GetOperators xmlns="http://www.cryptocard.com/blackshield/">
      <organization>string</organization>
    </GetOperators>
  </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>
    <GetOperatorsResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetOperatorsResult>
        <string>string</string>
        <string>string</string>
      </GetOperatorsResult>
    </GetOperatorsResponse>
  </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/GetOperators?organization=string HTTP/1.1
Host: cloud.safenet-inc.com

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfString xmlns="http://www.cryptocard.com/blackshield/">
  <string>string</string>
  <string>string</string>
</ArrayOfString>

HTTP POST sample

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx/GetOperators HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

organization=string

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfString xmlns="http://www.cryptocard.com/blackshield/">
  <string>string</string>
  <string>string</string>
</ArrayOfString>

On this page