Previous Topic: Managing Account TypesNext Topic: Updating Account Types

CA AuthMinder Web Services Guide › Configuration Management Web Service › Managing Account Types › Creating Account Types

Creating Account Types

This section walks you through the following topics for creating account types:

Note: After you create an account type, you must refresh the system cache for the new account type to take effect. See "Refreshing the Organization Cache" for more information on how to refresh the cache.

Preparing the Request Message

The createAccountTypeRequest message is used to create account types in the AuthMinder database. The following table lists the elements of this request message:

Element

Mandatory

Description

accountType/name

Yes

The name of the account type that you want to create.

accountType/displayName

Yes

A descriptive name for the account type.

accountType/customAttribute

No

Name-value pairs that you can use to specify additional information related to account types.

targetAllOrgs

No

Indicates whether the account type should be assigned to all the organizations. Following are the supported values:

  • true: Account type is assigned to all the organizations.
  • false: Account type is assigned only to the organizations that are listed in the ListOfOrganizations element.

    Note: By default, the value of this element is set to false.

ListofOrganizations/Organization/

orgName

No

The name of the organization to which the account type must be assigned.

ListofOrganizations/Organization/

customAttribute

No

The custom attribute that you have set for the organization to which you want to assign the account type.

clientTxId

No

Unique transaction identifier that the calling application can include. This identifier helps in tracking the related transactions.

Invoking the Web Service

To create account types:

  1. (Optional) Include the authentication and authorization details in the header of the createAccountType operation. See chapter, "Managing Web Services Security" for more information on the header elements.
  2. Use the createAccountTypeRequest elements to set the account information.
  3. Use createAccountTypeRequest message and construct the input message by using the details obtained in preceding step.
  4. Invoke the createAccountType operation of the ArcotConfigRegistrySvc service to create the account type.

    This operation returns the createAccountTypeResponse message that includes the transaction identifier and the authentication token. See the following section for more information on the response message.

Interpreting the Response Message

The response message, createAccountTypeResponse, returns the transaction identifier and the authentication token in the SOAP envelope header. These elements are explained in the following table. The SOAP body returns a success message if the operation was performed successfully. If there are any errors, then the Fault response is returned. See appendix, "Error Codes" for more information on the SOAP error messages.

Element

Description

udsTransactionID

The unique identifier of the transaction that is performed using UDS.

authToken

The authentication token that is returned if the credential verification to access Web services was successful. This token eliminates the need for you to present the authentication credential for successive access to the Web services.

By default, the authentication token is valid for one day, after which you need to authenticate again.