The updateOrg operation enables you to update the following organization information:
Note: In addition to the elements that are required to perform the tasks mentioned in the preceding list, the updateOrgRequest contains other elements for repository (directory service or AuthMinder database) configuration and user attribute mapping. After you create an organization, you cannot change the repository type and the related settings. Therefore, these elements are not applicable when you update an organization. Even if you set these elements, they will not be considered.
This section walks you through the following topics for updating organizations:
Note: After you update an organization, you must refresh the system cache for the changes to take effect. See "Refreshing the Organization Cache" for more information on how to refresh the system cache.
The updateOrgRequest message is used to update organizations in the AuthMinder database. The following table lists the elements of this request message.
Note: This table lists only the elements that you can use to update the organization information. You can ignore other additional updateOrgRequest elements that are not applicable, such as repository type (repositoryDetails) configuration, user attribute mapping (mappingDetails) configuration, and status.
|
Element |
Mandatory |
Description |
|---|---|---|
|
orgName |
Yes |
The name of the organization that has to be updated. |
|
displayName |
No |
The descriptive name of the organization. |
|
description |
No |
A description for the organization that will help the administrators easily identify the organization. |
|
customAttribute |
No |
Name-value pairs that you can use to set any additional user or organization information. |
|
clientTxId |
No |
Unique transaction identifier that the calling application can include. This identifier helps in tracking the related transactions. |
To update an organization:
This operation returns the updateOrgResponse message that includes the transaction identifier and the authentication token. See the following section for more information on the response message.
The response message, updateOrgResponse, 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 "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. |
|
Copyright © 2013 CA.
All rights reserved.
|
|