Please Note:

User endpoints

AddSamlUserExtension

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 SAS 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>

AddUser

AddUser(DataLayer.Entity.User,System.String)

Adds a new user to the given organization. User name must be unique in the organization to which it is added.

Parameters

Param: user: User object to add

Param: organization: Account

Returns

True if the user was 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/AddUser"

<?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>
    <AddUser 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>
    <organization>string</organization>
    </AddUser>
</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>
    <AddUserResponse xmlns="http://www.cryptocard.com/blackshield/">
    <AddUserResult>boolean</AddUserResult>
    </AddUserResponse>
</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>
    <AddUser 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>
    <organization>string</organization>
    </AddUser>
</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>
    <AddUserResponse xmlns="http://www.cryptocard.com/blackshield/">
    <AddUserResult>boolean</AddUserResult>
    </AddUserResponse>
</soap12:Body>
</soap12:Envelope>

AddUserWithAlias

AddUserWithAlias(DataLayer.Entity.User,System.Collections.Generic.List{System.String},System.String)

Adds a new user with alias to the given organization. User name must be unique in the organization to which it is added.

Parameters

Param: user: User object to add

Param: Alias: Alias

Param: organization: Account

Returns

True if the user was 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/AddUserWithAlias"

<?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>
    <AddUserWithAlias 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>
    <Alias>
        <string>string</string>
        <string>string</string>
    </Alias>
    <organization>string</organization>
    </AddUserWithAlias>
</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>
    <AddUserWithAliasResponse xmlns="http://www.cryptocard.com/blackshield/">
    <AddUserWithAliasResult>boolean</AddUserWithAliasResult>
    </AddUserWithAliasResponse>
</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>
    <AddUserWithAlias 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>
    <Alias>
        <string>string</string>
        <string>string</string>
    </Alias>
    <organization>string</organization>
    </AddUserWithAlias>
</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>
    <AddUserWithAliasResponse xmlns="http://www.cryptocard.com/blackshield/">
    <AddUserWithAliasResult>boolean</AddUserWithAliasResult>
    </AddUserWithAliasResponse>
</soap12:Body>
</soap12:Envelope>

GetUser

GetUser(System.String,System.String)

Gets a user.

Parameters

Param: userName: User name of the user to get.

Param: organization: Account

Returns

The user

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

<?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>
    <GetUser xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <organization>string</organization>
    </GetUser>
  </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>
    <GetUserResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetUserResult>
        <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>
      </GetUserResult>
    </GetUserResponse>
  </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>
    <GetUser xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <organization>string</organization>
    </GetUser>
  </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>
    <GetUserResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetUserResult>
        <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>
      </GetUserResult>
    </GetUserResponse>
  </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/GetUser?userName=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com

Response:

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

<?xml version="1.0" encoding="utf-8"?>
<User xmlns="http://www.cryptocard.com/blackshield/">
  <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>

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/GetUser HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

userName=string&organization=string

Response:

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

<?xml version="1.0" encoding="utf-8"?>
<User xmlns="http://www.cryptocard.com/blackshield/">
  <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>

GetUserAlias

GetUserAlias(System.String,System.String)

Gets a user's alias.

Parameters

Param: userName: User name of the user to get.

Param: organization: Account

Returns

The user's alias

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

<?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>
    <GetUserAlias xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <organization>string</organization>
    </GetUserAlias>
  </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>
    <GetUserAliasResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetUserAliasResult>
        <string>string</string>
        <string>string</string>
      </GetUserAliasResult>
    </GetUserAliasResponse>
  </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>
    <GetUserAlias xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <organization>string</organization>
    </GetUserAlias>
  </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>
    <GetUserAliasResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetUserAliasResult>
        <string>string</string>
        <string>string</string>
      </GetUserAliasResult>
    </GetUserAliasResponse>
  </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/GetUserAlias?userName=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com

Response:

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

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

HTTP POST sample

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

Request:

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

userName=string&organization=string

Response:

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

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

GetUserInOperatorOrganization

GetUserInOperatorOrganization(System.String)

Gets a user in the same organization as the current operator.

Parameter

Param: userName: User name of the user to get.

Returns

The user

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

<?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>
    <GetUserInOperatorOrganization xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
    </GetUserInOperatorOrganization>
  </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>
    <GetUserInOperatorOrganizationResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetUserInOperatorOrganizationResult>
        <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>
      </GetUserInOperatorOrganizationResult>
    </GetUserInOperatorOrganizationResponse>
  </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>
    <GetUserInOperatorOrganization xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
    </GetUserInOperatorOrganization>
  </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>
    <GetUserInOperatorOrganizationResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetUserInOperatorOrganizationResult>
        <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>
      </GetUserInOperatorOrganizationResult>
    </GetUserInOperatorOrganizationResponse>
  </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/GetUserInOperatorOrganization?userName=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"?>
<User xmlns="http://www.cryptocard.com/blackshield/">
  <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>

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/GetUserInOperatorOrganization HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

userName=string

Response:

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

<?xml version="1.0" encoding="utf-8"?>
<User xmlns="http://www.cryptocard.com/blackshield/">
  <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>

GetUsers

GetUsers(System.String,System.String,DataLayer.Entity.AuthMethod,System.String,System.Int32,System.Int32,System.String)

Gets a table of user information matching the provided filters.

Parameters

Param: userName: User Name (Wild card support, optional)

Param: lastName: Last Name (Wild card support, optional)

Param: authMethod: Authentication method: Any, Token, Password, External Credentials, Token Or Password, None

Param: container: Container (Wild card support, optional)

Param: firstRecord: First record to return

Param: pageSize: Number of records to return

Param: organization: Account

Returns

Lastname
Firstname
userid
custom1
authmethod
attributes
authstate
container
isDormant

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

<?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>
    <GetUsers xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <lastName>string</lastName>
      <authMethod>Any or Token or Password or ExternalCredentials or TokenOrPassword or None</authMethod>
      <container>string</container>
      <firstRecord>int</firstRecord>
      <pageSize>int</pageSize>
      <organization>string</organization>
    </GetUsers>
  </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>
    <GetUsersResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetUsersResult>xmlxml</GetUsersResult>
    </GetUsersResponse>
  </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>
    <GetUsers xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <lastName>string</lastName>
      <authMethod>Any or Token or Password or ExternalCredentials or TokenOrPassword or None</authMethod>
      <container>string</container>
      <firstRecord>int</firstRecord>
      <pageSize>int</pageSize>
      <organization>string</organization>
    </GetUsers>
  </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>
    <GetUsersResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetUsersResult>xmlxml</GetUsersResult>
    </GetUsersResponse>
  </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/GetUsers?userName=string&lastName=string&authMethod=string&container=string&firstRecord=string&pageSize=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"?>
<DataTable xmlns="http://www.cryptocard.com/blackshield/">xmlxml</DataTable>

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/GetUsers HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

userName=string&lastName=string&authMethod=string&container=string&firstRecord=string&pageSize=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"?>
<DataTable xmlns="http://www.cryptocard.com/blackshield/">xmlxml</DataTable>

GetUsersForContainer

GetUsersForContainer(System.String,System.String)

Get a list of users in the container

Parameters

Param: containerName: Container to return users in

Param: organization: Account

Returns

A table with the following columns:

Lastname
Firstname
Username
custom1

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

<?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>
    <GetUsersForContainer xmlns="http://www.cryptocard.com/blackshield/">
      <containerName>string</containerName>
      <organization>string</organization>
    </GetUsersForContainer>
  </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>
    <GetUsersForContainerResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetUsersForContainerResult>xmlxml</GetUsersForContainerResult>
    </GetUsersForContainerResponse>
  </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>
    <GetUsersForContainer xmlns="http://www.cryptocard.com/blackshield/">
      <containerName>string</containerName>
      <organization>string</organization>
    </GetUsersForContainer>
  </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>
    <GetUsersForContainerResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetUsersForContainerResult>xmlxml</GetUsersForContainerResult>
    </GetUsersForContainerResponse>
  </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/GetUsersForContainer?containerName=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"?>
<DataTable xmlns="http://www.cryptocard.com/blackshield/">xmlxml</DataTable>

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/GetUsersForContainer HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

containerName=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"?>
<DataTable xmlns="http://www.cryptocard.com/blackshield/">xmlxml</DataTable>

GetUsersForGroup

GetUsersForGroup(System.String,System.Boolean,DataLayer.Entity.GroupKind,System.String,System.String,System.String)

Gets a list of users based on search criteria. Can search for all members of a group or all users who are not a member of a given group.

Parameters

Param: groupName: Name of the group

Param: isAMember: If they are a member or not

Param: kind: Read Only, Writable or Both

Param: userName: User Name filter

Param: lastName: Last Name filter

Param: organization: Account

Returns

A table with the following columns:

Firstname
Lastname
Username
custom1

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

<?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>
    <GetUsersForGroup xmlns="http://www.cryptocard.com/blackshield/">
      <groupName>string</groupName>
      <isAMember>boolean</isAMember>
      <kind>ReadOnly or Writable or Both</kind>
      <userName>string</userName>
      <lastName>string</lastName>
      <organization>string</organization>
    </GetUsersForGroup>
  </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>
    <GetUsersForGroupResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetUsersForGroupResult>xmlxml</GetUsersForGroupResult>
    </GetUsersForGroupResponse>
  </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>
    <GetUsersForGroup xmlns="http://www.cryptocard.com/blackshield/">
      <groupName>string</groupName>
      <isAMember>boolean</isAMember>
      <kind>ReadOnly or Writable or Both</kind>
      <userName>string</userName>
      <lastName>string</lastName>
      <organization>string</organization>
    </GetUsersForGroup>
  </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>
    <GetUsersForGroupResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetUsersForGroupResult>xmlxml</GetUsersForGroupResult>
    </GetUsersForGroupResponse>
  </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/GetUsersForGroup?groupName=string&isAMember=string&kind=string&userName=string&lastName=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"?>
<DataTable xmlns="http://www.cryptocard.com/blackshield/">xmlxml</DataTable>

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/GetUsersForGroup HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

groupName=string&isAMember=string&kind=string&userName=string&lastName=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"?>
<DataTable xmlns="http://www.cryptocard.com/blackshield/">xmlxml</DataTable>

MoveUsers

MoveUsers(System.Collections.Generic.List{System.String},System.String,System.String)

Moves user and their tokens to a new container

Parameters

Param: userNames: User names of all users to move to the new container.

Param: newContainer: Name of an existing container to move the users to.

Param: organization: Account

Returns

True if the users are moved

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

<?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>
    <MoveUsers xmlns="http://www.cryptocard.com/blackshield/">
      <userNames>
        <string>string</string>
        <string>string</string>
      </userNames>
      <newContainer>string</newContainer>
      <organization>string</organization>
    </MoveUsers>
  </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>
    <MoveUsersResponse xmlns="http://www.cryptocard.com/blackshield/">
      <MoveUsersResult>boolean</MoveUsersResult>
    </MoveUsersResponse>
  </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>
    <MoveUsers xmlns="http://www.cryptocard.com/blackshield/">
      <userNames>
        <string>string</string>
        <string>string</string>
      </userNames>
      <newContainer>string</newContainer>
      <organization>string</organization>
    </MoveUsers>
  </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>
    <MoveUsersResponse xmlns="http://www.cryptocard.com/blackshield/">
      <MoveUsersResult>boolean</MoveUsersResult>
    </MoveUsersResponse>
  </soap12:Body>
</soap12:Envelope>

ProvisionUsers

ProvisionUsers(System.Collections.Generic.List{System.String},DataLayer.Entity.ProvisioningEntry.TokenOption,System.String,System.String)

Provisions a list of users a token of a given class. SMS tokens will be instantly provisioned, all other types will have provisioning tasks added for the users.

Parameters

Param: userNames: Names of the users to provision tokens to

Param: tokenClass: The type of token to provision: Software, Oath, SMS, Password, KT, RB, ICE, GOLD, eToken

Param: description: Provisioning task description

Param: organization: Account

Returns

A list in the same order as the user names provided:

FailedToAddToBatch	Failed to add user to provisioning task
EmailSent	Success
SMSSent	Success for SMS tokens
UserHasNoEmail	Can't provision to the user as they have no e-mail address
UserHasNoMobileNumber	Can't provision an SMS token, as they have no mobile number
FailedToSendEmail	Failed to send out the e-mail. Check e-mail settings for the account
FailedToSendSMS	Failed to send out an SMS. Check SMS settings for the account
FailedToSendSMS_NoCredits	The account does not have enough SMS credits to send the message
CouldntGetToken	Couldn't find an available SMS or MP token to use for SMS provisioning
CouldntAssignToken	User could not be assigned an SMS token
UserHasActiveToken	Cannot provision password as the user has an active token

SOAP 1.1 sample

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

Request:

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

<?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>
    <ProvisionUsers xmlns="http://www.cryptocard.com/blackshield/">
      <userNames>
        <string>string</string>
        <string>string</string>
      </userNames>
      <tokenClass>Software or Custom or Oath or SMS or Password or KT or RB or ICE or GOLD or eToken or MobilePASS or GoogleAuthenticator</tokenClass>
      <description>string</description>
      <organization>string</organization>
    </ProvisionUsers>
  </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>
    <ProvisionUsersResponse xmlns="http://www.cryptocard.com/blackshield/">
      <ProvisionUsersResult>
        <ProvisioningResult>FailedToAddToBatch or EmailSent or SMSSent or UserHasNoEmail or UserHasNoMobileNumber or FailedToSendEmail or FailedToSendSMS or FailedToSendSMS_NoCredits or CouldntGetToken or CouldntAssignToken or UserHasActiveToken or ProvisionSuccess</ProvisioningResult>
        <ProvisioningResult>FailedToAddToBatch or EmailSent or SMSSent or UserHasNoEmail or UserHasNoMobileNumber or FailedToSendEmail or FailedToSendSMS or FailedToSendSMS_NoCredits or CouldntGetToken or CouldntAssignToken or UserHasActiveToken or ProvisionSuccess</ProvisioningResult>
      </ProvisionUsersResult>
    </ProvisionUsersResponse>
  </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>
    <ProvisionUsers xmlns="http://www.cryptocard.com/blackshield/">
      <userNames>
        <string>string</string>
        <string>string</string>
      </userNames>
      <tokenClass>Software or Custom or Oath or SMS or Password or KT or RB or ICE or GOLD or eToken or MobilePASS or GoogleAuthenticator</tokenClass>
      <description>string</description>
      <organization>string</organization>
    </ProvisionUsers>
  </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>
    <ProvisionUsersResponse xmlns="http://www.cryptocard.com/blackshield/">
      <ProvisionUsersResult>
        <ProvisioningResult>FailedToAddToBatch or EmailSent or SMSSent or UserHasNoEmail or UserHasNoMobileNumber or FailedToSendEmail or FailedToSendSMS or FailedToSendSMS_NoCredits or CouldntGetToken or CouldntAssignToken or UserHasActiveToken or ProvisionSuccess</ProvisioningResult>
        <ProvisioningResult>FailedToAddToBatch or EmailSent or SMSSent or UserHasNoEmail or UserHasNoMobileNumber or FailedToSendEmail or FailedToSendSMS or FailedToSendSMS_NoCredits or CouldntGetToken or CouldntAssignToken or UserHasActiveToken or ProvisionSuccess</ProvisioningResult>
      </ProvisionUsersResult>
    </ProvisionUsersResponse>
  </soap12:Body>
</soap12:Envelope>

RemoveUser

RemoveUser(System.String,System.String,ControlLibrary.TokenControl.revokeSelection,System.String)

Removes an existing user and revokes their tokens.

Parameters

Param: userName: User name of the user to remove

Param: organization: Account

Param: tokenOption: One of: ReturntoInventory_Initialized, ReturntoInventory_NotInitialized, Faulty, Lost

Param: comment: Message to attach to the tokens that are being revoked

Returns

Deleted
FailedToDeassignTokens
FailedToRemoveUser
UnknownError

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

<?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>
    <RemoveUser xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <organization>string</organization>
      <tokenOption>ReturntoInventory_Initialized or ReturntoInventory_NotInitialized or Faulty or Lost</tokenOption>
      <comment>string</comment>
    </RemoveUser>
  </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>
    <RemoveUserResponse xmlns="http://www.cryptocard.com/blackshield/">
      <RemoveUserResult>Deleted or FailedToDeassignTokens or FailedToRemoveUser or UnknownError</RemoveUserResult>
    </RemoveUserResponse>
  </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>
    <RemoveUser xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <organization>string</organization>
      <tokenOption>ReturntoInventory_Initialized or ReturntoInventory_NotInitialized or Faulty or Lost</tokenOption>
      <comment>string</comment>
    </RemoveUser>
  </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>
    <RemoveUserResponse xmlns="http://www.cryptocard.com/blackshield/">
      <RemoveUserResult>Deleted or FailedToDeassignTokens or FailedToRemoveUser or UnknownError</RemoveUserResult>
    </RemoveUserResponse>
  </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/RemoveUser?userName=string&organization=string&tokenOption=string&comment=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"?>
<UserDeleteResult xmlns="http://www.cryptocard.com/blackshield/">Deleted or FailedToDeassignTokens or FailedToRemoveUser or UnknownError</UserDeleteResult>

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/RemoveUser HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

userName=string&organization=string&tokenOption=string&comment=string

Response:

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

<?xml version="1.0" encoding="utf-8"?>
<UserDeleteResult xmlns="http://www.cryptocard.com/blackshield/">Deleted or FailedToDeassignTokens or FailedToRemoveUser or UnknownError</UserDeleteResult>

UpdateUser

UpdateUser(System.String,DataLayer.Entity.User,System.String)

Updates an existing user in the system.

Parameters

Param: userName: User name of the user to update. If changing the user name, this is the old user name. New user name is in the user object

Param: user: Updated user

Param: organization: Account

Returns

True if updated

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

<?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>
    <UpdateUser xmlns="http://www.cryptocard.com/blackshield/">
    <userName>string</userName>
    <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>
    <organization>string</organization>
    </UpdateUser>
</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>
    <UpdateUserResponse xmlns="http://www.cryptocard.com/blackshield/">
    <UpdateUserResult>boolean</UpdateUserResult>
    </UpdateUserResponse>
</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>
    <UpdateUser xmlns="http://www.cryptocard.com/blackshield/">
    <userName>string</userName>
    <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>
    <organization>string</organization>
    </UpdateUser>
</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>
    <UpdateUserResponse xmlns="http://www.cryptocard.com/blackshield/">
    <UpdateUserResult>boolean</UpdateUserResult>
    </UpdateUserResponse>
</soap12:Body>
</soap12:Envelope>

UpdateUserWithAlias

UpdateUserWithAlias(System.String,DataLayer.Entity.User,System.Collections.Generic.List{System.String},System.String)

Updates an existing user with alias in the system.

Parameters

Param: userName: User name of the user to update. If changing the user name, this is the old user name. New user name is in the user object

Param: user: Updated user

Param: Alias: Updated use' alias

Param: organization: Account

Returns

True if updated

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

<?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>
    <UpdateUserWithAlias xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <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>
      <Alias>
        <string>string</string>
        <string>string</string>
      </Alias>
      <organization>string</organization>
    </UpdateUserWithAlias>
  </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>
    <UpdateUserWithAliasResponse xmlns="http://www.cryptocard.com/blackshield/">
      <UpdateUserWithAliasResult>boolean</UpdateUserWithAliasResult>
    </UpdateUserWithAliasResponse>
  </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>
    <UpdateUserWithAlias xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <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>
      <Alias>
        <string>string</string>
        <string>string</string>
      </Alias>
      <organization>string</organization>
    </UpdateUserWithAlias>
  </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>
    <UpdateUserWithAliasResponse xmlns="http://www.cryptocard.com/blackshield/">
      <UpdateUserWithAliasResult>boolean</UpdateUserWithAliasResult>
    </UpdateUserWithAliasResponse>
  </soap12:Body>
</soap12:Envelope>

Suggest A Change

User endpoints

AddSamlUserExtension

Parameters

Returns

SOAP 1.1 sample

SOAP 1.2 sample

AddUser

Parameters

Returns

SOAP 1.1 sample

SOAP 1.2 sample

AddUserWithAlias

Parameters

Returns

SOAP 1.1 sample

SOAP 1.2 sample

GetUser

Parameters

Returns

SOAP 1.1 sample

SOAP 1.2 sample

HTTP GET sample

HTTP POST sample

GetUserAlias

Parameters

Returns

SOAP 1.1 sample

SOAP 1.2 sample

HTTP GET sample

HTTP POST sample

GetUserInOperatorOrganization

Parameter

Returns

SOAP 1.1 sample

SOAP 1.2 sample

HTTP GET sample

HTTP POST sample

GetUsers

Parameters

Returns

SOAP 1.1 sample

SOAP 1.2 sample

HTTP GET sample

HTTP POST sample

GetUsersForContainer

Parameters

Returns

SOAP 1.1 sample

SOAP 1.2 sample

HTTP GET sample

HTTP POST sample

GetUsersForGroup

Parameters

Returns

SOAP 1.1 sample

SOAP 1.2 sample

HTTP GET sample

HTTP POST sample

MoveUsers

Parameters

Returns

SOAP 1.1 sample

SOAP 1.2 sample

ProvisionUsers

Parameters

Returns

SOAP 1.1 sample

SOAP 1.2 sample

RemoveUser

Parameters

Returns

SOAP 1.1 sample

SOAP 1.2 sample

HTTP GET sample

HTTP POST sample

UpdateUser

Parameters

Returns

SOAP 1.1 sample