前のトピック: アカウント タイプの作成次のトピック: アカウント タイプの取得


アカウント タイプの更新

アカウント タイプの情報、およびアカウント タイプが属している組織のリストを更新するには、updateAccountType 操作を使用します。

このセクションでは、既存のアカウント タイプの更新に関する以下のトピックについて説明します。

注: アカウント タイプを更新した後、新しいアカウント タイプを有効にするにはシステム キャッシュをリフレッシュする必要があります。 キャッシュをリフレッシュする方法の詳細については、「組織キャッシュのリフレッシュ」を参照してください。

リクエスト メッセージの準備

AuthMinder データベース内のアカウント タイプを更新するには、updateAccountTypeRequest メッセージを使用します。 以下の表に、このリクエスト メッセージの要素のリストを示します。

要素

必須

説明

name

はい

更新するアカウント タイプの名前。

displayName

いいえ

アカウント タイプのわかりやすい名。

customAttribute

いいえ

更新するユーザまたは組織の情報を持つ、名前と値のペア。

removeCustomAttribute

いいえ

アカウント タイプで削除するカスタム属性の名前。

targetAllOrgs

いいえ

更新されたアカウント タイプをすべての組織に割り当てる必要があるかどうかを示します。 サポートされている値は以下のとおりです。

  • true: 更新されたアカウント タイプはすべての組織に割り当てられます。
  • false: 更新されたアカウント タイプは、ListOfOrganizations 要素でリストされている組織にのみ割り当てられます。

    注: デフォルトでは、この要素の値は false に設定されています。

ListofOrganizations/orgName

いいえ

アカウント タイプを割り当てる必要がある組織の名前。

ListofOrganizations/customAttribute

いいえ

組織に対して指定しているカスタム属性。

RemoveOrganizations/orgName

いいえ

アカウント タイプとの関連付けを解除する組織の名前。

clientTxId

いいえ

呼び出し元アプリケーションが含めることができる一意のトランザクション識別子。 この識別子は、関連するトランザクションの追跡に役立ちます。

Web サービスの起動

アカウント タイプを更新する方法

  1. (オプション) updateAccountType 操作のヘッダに認証および許可の詳細を含めます。 ヘッダ要素の詳細については、「Web サービス セキュリティの管理」の章を参照してください。
  2. アカウント情報を設定するには、updateAccountTypeRequest 要素を使用します。
  3. updateAccountTypeRequest メッセージを使用して、前の手順で取得した詳細に従って入力メッセージを作成します。
  4. ArcotConfigRegistrySvc サービスの updateAccountType 操作を呼び出して、アカウント タイプを更新します。

    この操作では、トランザクション識別子および認証トークンが含まれる updateAccountTypeResponse メッセージが返されます。 レスポンス メッセージの詳細については、以下のセクションを参照してください。

レスポンス メッセージの解釈

updateAccountTypeResponse レスポンス メッセージでは、SOAP エンベロープ ヘッダでトランザクション識別子および認証トークンが返されます。 これらの要素については以下の表で説明します。 操作が正常に実行されると、SOAP 本文で成功のメッセージが返されます。 エラーがある場合は、エラー レスポンスが返されます。 SOAP エラー メッセージの詳細については、付録「エラー コード」を参照してください。

要素

説明

udsTransactionID

UDS を使用して実行されたトランザクションの一意の識別子。

authToken

Web サービスにアクセスするための認証情報の検証が成功した場合に返される認証トークン。 このトークンによって、その Web サービスへの後続のアクセスでは認証情報を提示する必要がなくなります。

デフォルトでは、認証トークンは 1 日間有効で、その後は認証が再度必要になります。