ユーザのアカウントを追加するには、addUserAccount 操作を使用する必要があります。 このセクションでは、ユーザ アカウントを追加するための以下の手順について説明します。
以下の表に、addUserAccountRequest メッセージの要素のリストを示します。
|
要素 |
必須 |
説明 |
|---|---|---|
|
userId/orgName |
いいえ |
ユーザが属する組織の名前です。 注： 組織名が渡されない場合、その操作ではデフォルトの組織が使用されます。 |
|
userId/userName |
はい |
システムでユーザを識別するための一意の識別子。 |
|
userId/userRefId |
いいえ |
1 人のユーザが実行したさまざまな操作を追跡するために参照用として使用される識別子。 |
|
account/accountType |
はい |
アカウント ID を修飾し、アカウント ID の使用に関する追加コンテキストを指定する属性。 |
|
account/accountID |
いいえ |
ユーザ名に追加してユーザを識別するために使用される代替識別子。 アカウント ID はアカウントとも呼ばれます。 |
|
account/accountStatus |
いいえ |
アカウントのステータス。
|
|
account/accountIDAttribute |
いいえ |
システムでユーザを識別するために使用される代替識別子。 注： 1 人のユーザに対して渡すことができるアカウント ID は 3 つまでです。 |
|
account/dateCreated |
いいえ |
アカウント ID が作成された日時のタイムスタンプ。 |
|
account/dateModified |
いいえ |
アカウント ID が最後に変更された日時のタイムスタンプ。 |
|
account/accountCustomAttribute |
いいえ |
名前と値のペアで渡す追加のアカウント情報。
|
|
clientTxId |
いいえ |
呼び出し元アプリケーションが含めることができる一意のトランザクション識別子。 この識別子は、関連するトランザクションの追跡に役立ちます。 |
ユーザ アカウントを追加する方法
この操作では、トランザクション識別子、認証トークン、およびユーザ アカウントの詳細が含まれる addUserAccountResponse メッセージが返されます。 レスポンス メッセージの詳細については、以下のセクションを参照してください。
addUserAccountResponse レスポンス メッセージでは、SOAP エンベロープ ヘッダでトランザクション識別子および認証トークンが返されます。 これらの要素については以下の表で説明します。 操作が正常に実行されると、SOAP 本文で成功のメッセージが返されます。 エラーがある場合は、エラー レスポンスが返されます。 SOAP エラー メッセージの詳細については、付録「例外コードおよびエラー コード」を参照してください。
|
要素 |
説明 |
|---|---|
|
udsTransactionID |
UDS を使用して実行されたトランザクションの一意の識別子。 |
|
authToken |
Web サービスにアクセスするための認証情報の検証が成功した場合に返される認証トークン。 このトークンによって、その Web サービスへの後続のアクセスでは認証情報を提示する必要がなくなります。 デフォルトでは、認証トークンは 1 日間有効で、その後は認証が再度必要になります。 |
|
Copyright © 2014 CA Technologies.
All rights reserved.
|
|