データベース内のユーザの現在のステータスを知るには、getUserStatus 操作を使用する必要があります。
このセクションでは、ユーザ ステータスの確認に関する以下のトピックについて説明します。
以下の表に、getUserStatusRequest メッセージの要素のリストを示します。
|
要素 |
必須 |
説明 |
|---|---|---|
|
userId/orgName |
いいえ |
ユーザが属する組織の名前。 注： 組織名が渡されない場合、その操作ではデフォルトの組織が使用されます。 |
|
userId/userName |
はい |
システムでユーザを識別するための一意の識別子。 |
|
userId/userRefId |
いいえ |
1 人のユーザが実行したさまざまな操作を追跡するために参照用として使用される識別子。 |
|
clientTxId |
いいえ |
呼び出し元アプリケーションが含めることができる一意のトランザクション識別子。 この識別子は、関連するトランザクションの追跡に役立ちます。 |
ユーザ ステータスを確認する方法
この操作では、トランザクション識別子、認証トークン、およびユーザの詳細およびステータスが含まれる getUserStatusResponse メッセージが返されます。 レスポンス メッセージの詳細については、以下のセクションを参照してください。
getUserstatusResponse レスポンス メッセージでは、SOAP エンベロープ ヘッダでトランザクション識別子および認証トークンが返されます。 SOAP 本文には、成功したトランザクションではユーザの詳細およびステータスが含まれ、エラーがある場合はエラー レスポンスが含まれます。
以下の表に、成功したトランザクションで返される要素に関する詳細情報を示します。 エラーがある場合は、付録「エラー コード」を参照してください。
|
要素 |
説明 |
|---|---|
|
ヘッダ要素 |
|
|
udsTransactionID |
UDS を使用して実行されたトランザクションの一意の識別子。 |
|
authToken |
Web サービスにアクセスするための認証情報の検証が成功した場合に返される認証トークン。 このトークンによって、その Web サービスへの後続のアクセスでは認証情報を提示する必要がなくなります。 デフォルトでは、認証トークンは 1 日間有効で、その後は認証が再度必要になります。 |
|
本文要素 |
|
|
userId/orgName |
ユーザが属する組織の名前です。 |
|
userId/userName |
システムでユーザを識別するための一意の識別子。 |
|
userId/userRefId |
1 人のユーザが実行したさまざまな操作を追跡するために参照用として使用される識別子。 |
|
status |
ユーザのステータス。 サポートされている値は以下のとおりです。
|
|
Copyright © 2014 CA Technologies.
All rights reserved.
|
|