前のトピック: 組織の作成次のトピック: 組織キャッシュのリフレッシュ


組織の更新

updateOrg 操作では、以下の組織情報を更新できます。

注: updateOrgRequest には、タスクの実行に必要な前述のリストの要素に加えて、リポジトリ(ディレクトリ サービスまたは AuthMinder データベース)設定およびユーザ属性マッピングの要素が含まれます。 組織の作成後には、リポジトリ タイプおよび関連する設定は変更できません。 そのため、組織の更新時には、これらの要素は適用されません。 これらの要素は、設定していても考慮されません

このセクションでは、組織の更新に関する以下のトピックについて説明します。

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

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

AuthMinder データベース内の組織を更新するには、updateOrgRequest メッセージを使用します。 以下の表に、このリクエスト メッセージの要素のリストを示します。

注: この表では、組織情報の更新に使用できる要素のみを示しています。 リポジトリ タイプ(repositoryDetails)設定、ユーザ属性マッピング(mappingDetails)設定、およびステータスなどの、適用できないその他の追加の updateOrgRequest 要素は無視できます。

要素

必須

説明

orgName

はい

更新される必要がある組織の名前。

displayName

いいえ

組織のわかりやすい名前。

description

いいえ

管理者が組織を容易に識別するのに役立つ組織の説明。

customAttribute

いいえ

ユーザまたは組織の追加情報を設定するために使用できる、名前と値のペア。

clientTxId

いいえ

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

Web サービスの起動

組織を更新する方法

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

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

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

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

要素

説明

udsTransactionID

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

authToken

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

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