前のトピック: ユーザのステータスの確認次のトピック: ユーザの削除


ユーザのステータスの更新

データベース内のユーザの現在のステータスを変更するに、updateUserStatus 操作を使用する必要があります。

このセクションでは、ユーザ ステータスを更新するための以下の手順について説明します。

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

以下の表に、updateUserStatusRequest メッセージの要素のリストを示します。

要素

必須

説明

userId/orgName

いいえ

ユーザが属する組織の名前です。

注: 組織名が渡されない場合、その操作ではデフォルトの組織が使用されます。

userId/userName

はい

システムでユーザを識別するための一意の識別子。

userId/userRefId

いいえ

1 人のユーザが実行したさまざまな操作を追跡するために参照用として使用される識別子。

status

はい

ユーザに割り当てるステータス。

  • INITIAL
  • ACTIVE
  • INACTIVE

    注: ユーザの現在のステータスが DELETED である場合は、そのユーザのステータスを更新できません。

startLockTime

いいえ

ユーザを非アクティブにする日時のタイムスタンプ。

endLockTime

いいえ

非アクティブ ユーザをアクティブにする日時のタイムスタンプ。

clientTxId

いいえ

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

Web サービスの起動

ユーザ ステータスを更新する方法

  1. (オプション) updateUserStatus 操作のヘッダに認証および許可の詳細を含めます。 ヘッダ要素の詳細については、「Web サービス セキュリティの管理」を参照してください。
  2. updateUserStatusRequest 要素を使用して、この表に記載されているユーザの詳細を収集します。
  3. updateUserStatusRequest メッセージを使用して、前の手順で指定した詳細に従って入力メッセージを作成します。
  4. ArcorUserRegistrySvc サービスの updateUserStatus 操作を呼び出して、ユーザ ステータスを更新します。

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

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

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

要素

説明

udsTransactionID

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

authToken

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

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