前のトピック: 組織キャッシュのリフレッシュ次のトピック: 組織の詳細の取得


デフォルト組織の詳細の取得

マスタ管理者(MA)は、システムにデフォルト組織を設定します。 通常、組織を指定せずに管理者の作成またはユーザの登録を行うと、それらはこのデフォルトの組織内に作成されます。 デフォルト組織の詳細を取得するには、retrieveDefaultOrg 操作を使用します。

このセクションでは、デフォルト組織の詳細の取得に関する以下のトピックについて説明します。

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

デフォルト組織の情報を取得するには、retrieveDefaultOrgRequest を使用します。 以下の表に、このリクエスト メッセージの要素のリストを示します。

要素

必須

説明

clientTxId

いいえ

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

Web サービスの起動

デフォルト組織情報を取得する方法

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

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

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

retrieveDefaultOrgResponse レスポンス メッセージでは、SOAP エンベロープ ヘッダでトランザクション識別子および認証トークンが返されます。 SOAP 本文には、成功したトランザクションではデフォルト組織の詳細が含まれ、エラーがある場合はエラー レスポンスが含まれます。

以下の表に、成功したトランザクションで返される要素に関する情報を示します。 エラーがある場合は、付録「エラー コード」を参照してください。

要素

説明

ヘッダ要素

udsTransactionID

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

authToken

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

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

本文要素

orgName

組織の一意の名前。

displayName

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

repositoryDetails

組織に属するユーザのアカウントが存在するリポジトリ。 サポートされている値は以下のとおりです。

  • ARUSER
  • LDAP

dateCreated

組織が作成された日時のタイムスタンプ。

dateModified

組織が最後に変更された日時のタイムスタンプ。

description

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

status

データベース内のデフォルト組織のステータス。 サポートされている値は以下のとおりです。

  • INITIAL
  • ACTIVE
  • INACTIVE
  • DELETED

preferredLocale

組織に対して設定されるロケール。 ロケールを指定しない場合は、デフォルト ロケールである en-US が設定されます。

customAttribute

組織に対して設定されているカスタム属性の、名前と値のペア。