Account Structure

Use the Account structure to hold user names or group names. It has a flag to indicate whether the name is a user or a group.

The Account structure is used in the SecurityService Service.

Account Structure Fields

Fields Description

String accountName

Specifies an account name or group name.

int accountType

Specifies whether the account is a user or a group or both.

Use accountType when it is:

  • An input to a "non-query" SOAP function (for example, a parameter in calling updateCatalogItemACL() ).

    Or

  • An output from any SOAP function (for example, as returned data from getAccounts() ).

0 = user

1 = catalog group

2 = initblock user

3 = invalid or deleted account

int accountFindType

Specifies whether the account is a user or a group or both.

Use accountFindType when it is being used as an input to a "query" SOAP function (for example, as a parameter in calling getAccounts() ):

0 = find a user using name or GUID exact match

1 = find a catalog group using name or GUID exact match

2 = find a application role using name or GUID exact match

3 = find a user OR Catalog group OR application roles using name or GUID exact match

Note the following information for advanced use of this field. If accountFindType is greater than or equal to 4, the system treats the Name or GUID as a pattern.

4 = find all users using name or GUID pattern match

5 = find all catalog groups using name or GUID pattern match

6 = find all application roles using name or GUID pattern match

7 = find all users AND webcat groups AND application roles using name or GUID pattern match

Using this field in this way can be slow, and result in the system returning many records. When receiving an Account, both Name and GUID are set.

String GUID

Specifies the unique ID which identifies the account.