マスタ管理者（MA）は、システムのデフォルト組織の詳細を設定します。 通常、組織を指定せずに管理者の作成またはユーザの登録を行うと、それらはこのデフォルトの組織内に作成されます。 デフォルト組織の詳細を取得するには、retrieveDefaultOrg 操作を使用します。
このセクションでは、デフォルト組織の詳細を取得するための以下の手順について説明します。
デフォルト組織の情報を取得するには、retrieveDefaultOrgRequest メッセージを使用します。 以下の表に、このリクエスト メッセージの要素のリストを示します。
|
要素 |
必須 |
説明 |
|---|---|---|
|
clientTxId |
いいえ |
呼び出し元アプリケーションが含めることができる一意のトランザクション識別子。 この識別子は、関連するトランザクションの追跡に役立ちます。 |
デフォルト組織情報を取得する方法
この操作では、トランザクション識別子、認証トークン、およびデフォルト組織の詳細が含まれる retrieveDefaultOrgResponse メッセージが返されます。 レスポンス メッセージの詳細については、以下のセクションを参照してください。
retrieveDefaultOrgResponse レスポンス メッセージでは、SOAP エンベロープ ヘッダでトランザクション識別子、認証トークン、およびその他の詳細が返されます。 SOAP 本文には、成功したトランザクションではデフォルト組織の詳細が含まれ、エラーがある場合はエラー レスポンスが含まれます。
成功したトランザクションで返される要素の詳細については、以下の表を参照してください。 エラーがある場合は、付録「例外コードおよびエラー コード」を参照してください。
|
要素 |
説明 |
|---|---|
|
ヘッダ要素 |
|
|
udsTransactionID |
UDS を使用して実行されたトランザクションの一意の識別子。 |
|
authToken |
Web サービスにアクセスするための認証情報の検証が成功した場合に返される認証トークン。 このトークンによって、その Web サービスへの後続のアクセスでは認証情報を提示する必要がなくなります。 デフォルトでは、認証トークンは 1 日間有効で、その後は認証が再度必要になります。 |
|
本文要素 |
|
|
orgName |
組織の一意の名前。 |
|
displayName |
組織のわかりやすい名前。 |
|
repositoryDetails |
組織に属するユーザのアカウントが存在するリポジトリ。
|
|
dateCreated |
組織が作成された日時のタイムスタンプ。 |
|
dateModified |
組織設定が最後に変更された日時のタイムスタンプ。 |
|
description |
組織を管理する管理者が組織を識別するのに役立つ組織の説明。 |
|
status |
データベース内のデフォルト組織のステータス。
|
|
preferredLocale |
組織に対して設定されているロケール。 ロケールを指定しない場合は、デフォルト ロケールは en-US に設定されます。 |
|
customAttribute |
組織に対して設定されているカスタム属性の、名前と値のペア。 |
|
Copyright © 2014 CA Technologies.
All rights reserved.
|
|