ユーザに対して作成されているすべてのアカウントの詳細を取得するには、listUserAccounts 操作を使用する必要があります。 このセクションでは、ユーザ アカウントの詳細の取得に関する以下のトピックについて説明します。
注： 特定のアカウントの詳細を取得する場合は、retrieveUserAccount 操作を使用します。 詳細については、「ユーザ アカウントの詳細の取得」を参照してください。
listUserAccountRequest メッセージの要素は addUserAccountRequest の要素と同じです。 詳細については、「ユーザ アカウントの追加」を参照してください。
ユーザ アカウントを取得する方法
この操作では、トランザクション識別子、認証トークン、およびユーザ アカウントの詳細が含まれる listUserAccountResponse メッセージが返されます。 レスポンス メッセージの詳細については、以下のセクションを参照してください。
listUserAccountResponse レスポンス メッセージでは、SOAP エンベロープ ヘッダでトランザクション識別子および認証トークンが返されます。 SOAP 本文には、成功したトランザクションではユーザ アカウントの詳細が含まれ、エラーがある場合はエラー レスポンスが含まれます。
成功したトランザクションで返される要素の詳細については、以下の表を参照してください。 エラーがある場合は、「エラー コード」を参照してください。
|
要素 |
説明 |
|
|---|---|---|
|
ヘッダ要素 |
||
|
udsTransactionID |
UDS を使用して実行されたトランザクションの一意の識別子。 |
|
|
authToken |
Web サービスにアクセスするための認証情報の検証が成功した場合に返される認証トークン。 このトークンによって、その Web サービスへの後続のアクセスでは認証情報を提示する必要がなくなります。 デフォルトでは、認証トークンは 1 日間有効で、その後は認証が再度必要になります。 |
|
|
本文要素 |
||
|
account/accountType |
アカウント ID を修飾し、アカウント ID の使用に関する追加コンテキストを指定する属性。 |
|
|
account/accountID |
ユーザ名に追加してユーザを識別するために使用される代替識別子。 アカウント ID はアカウントとも呼ばれます。 |
|
|
account/accountStatus |
アカウントのステータス。 サポートされている値は以下のとおりです。
|
|
|
account/accountIDAttribute |
システムでユーザを識別するために使用される代替識別子。 |
|
|
account/dateCreated |
アカウント ID が作成された日時のタイムスタンプ。 |
|
|
account/dateModified |
アカウント ID が最後に変更された日時のタイムスタンプ。 |
|
|
account/accountCustomAttribute |
名前と値のペアで渡す追加のアカウント情報。
|
|
|
Copyright © 2014 CA Technologies.
All rights reserved.
|
|