Follow

GetAccount

Last updated 2016-08-10 20:41:34 UTC

The GetAccount operation may be used to get an account's details. This operation requires an AuthenticationToken returned from AuthenticateUser, which in turn requires passing of an active AssureSign username and password.

The GetAccount operation requires knowledge of the following:

  • the AssureSign account ContextIdentifier for the account (this is exposed in the AssureSign administrative application account settings). The ContextIdentifier is in the form of a global unique identifier (GUID).
  • an AuthenticationToken, returned from a successful call to AuthenticateUser

Sample XML

<?xml version="1.0" encoding="utf-8"?> 
<GetAccount xmlns="https://www.assuresign.net/Services/DocumentNOW/Accounts">
  <Request ContextIdentifier="8d17c44a-458d-455b-b240-fc6dba5cf1db" AuthenticationToken="[authentication token]" />
</GetAccount>

The SOAP Action header is

https://www.assuresign.net/Services/DocumentNOW/Accounts/IAccountService/GetAccount

The returned result will include:

  • a Success flag indicating whether or not the account was retrieved successfully

If the call is successful, the result will also include:

  • the ContextIdentifier of the account
  • the Name of the account
  • the DisplayName of the account used for branding purposes
  • the name of the AccountGroup to which the accounted is assigned
  • an Inactive flag should the account be disabled
  • user Roles within the account
  • The names of AccountTemplates defined within the account (for example, used in a CreateAccount operation)
  • The names of AccountGroups defined within the account (for example, used in a CreateAccount operation)

The GetAccountResult should be checked for the presence of an Exceptions element, which may contain multiple AccountException items.

Sample XML response is presented here:

<?xml version="1.0" encoding="utf-8"?> 
<GetAccountResponse xmlns="https://www.assuresign.net/Services/DocumentNOW/Accounts">
  <GetAccountResult ContextIdentifier="8d17c44a-458d-455b-b240-fc6dba5cf1db" Name="Acme" DisplayName="Acme, Inc." AccountGroup="All" Inactive="false" Success="true">
    <Roles>
      <Role>Administrator</Role>
      <Role>Power User</Role>
      <Role>Limited User</Role>
    </Roles>
    <AccountTemplates>
      <AccountTemplate>Account Template 1</AccountTemplate>
    </AccountTemplates>
    <AccountGroups>
      <AccountGroup>Account Group 1</AccountGroup>
    </AccountGroups>
    <Exceptions />
  </GetAccountResult>
</GetAccountResponse>
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Article is closed for comments.