IBM Security Access Manager for Enterprise Single Sign-On バージョン 8.2

Java API クラス

IMS ブリッジは、クラス encentuate.bridges.provisioning.ProvisioningBridge を通じてサード・パーティーの ID プロビジョニング・システムと連動します。

ProvisioningBridge (コンストラクター)

クラスのコンストラクターです。

public ProvisioningBridge(String configFile)
throws ProvisioningBridgeException

パラメーター:
configFile

IMS Server の構成ファイルの絶対パス名。
スロー:
ProvisioningBridgeException

構成ファイルの読み取り中にエラーが発生した場合は、この例外がスローされ、エラー・コードは BAD_CONFIGURATION になります。

パラメーター:
serverId

IMS ブリッジが実行されているサーバーの大/小文字を区別しない ID。このパラメーターは、IMS ブリッジが IMS Server にログオンするための共有秘密鍵の一部として、IMS Server で事前構成されます。

serverPassword

この共有秘密鍵に対応する大/小文字を区別するパスワード。
スロー:
ProvisioningBridgeException
ログオンが失敗した場合は、以下のエラー・コードが示されます。
- INVALID_LOGIN
  serverId と serverPassword のペアが事前構成されたどの共有秘密鍵とも一致しない場合、またはこのサーバーの IP が IMS Server で事前構成されたものと一致しない場合。
- ACCESS_DENIED
  ログオン・アカウントに IMS Server プロビジョニング・サービスへのアクセス権限がない場合。
- REMOTE_EXCEPTION
  IMS Server SOAP サービスを呼び出したときに例外が発生した場合。

ログアウト

セッションの最後に、IMS Server からログアウトします。

public void logout()

パラメーター:
なし

createImsAccount

このメソッドは、指定されたユーザー名と初期パスワードを使用して IMS Server 上にアカウントを作成します。ユーザー属性は必要に応じて指定しますが、これは、デプロイメントに複数の Active Directory ドメインがあるかどうかによって決まります。IMS Server アカウントは、その他すべてのプロビジョニング・タスクに必要です。

public void createImsAccount(String imsUserId, String initialPassword)
throws ProvisioningBridgeException
public void createImsAccount(String imsUserId,String initialPassword, 
Hashtable userAttrs)
throws ProvisioningBridgeException

パラメーター:
imsUserId

IMS Server 上の新しいアカウントのユーザー名。ユーザーの基本エンタープライズ ID と同じ名前を使用します。複数の AD ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName です。例: example.com¥user1。

initialPassword

新しいアカウントに対して IMS Server 上で設定される初期パスワード。

userAttrs
名前と値のペア形式のユーザー属性を含むハッシュ・テーブル。このパラメーターは、デプロイメントに複数の AD ドメインがある場合に指定します。現在サポートされているユーザー属性を以下に示します。
- userPrincipalName (オプション)
  このパラメーターは、ユーザー・アカウントの UPN です (エンタープライズ・ディレクトリーが AD の場合にのみ役立ちます)。
- domainDnsName
  このパラメーターは、エンタープライズ・ディレクトリーの DNS ドメイン名です。
- samAccountName
  このパラメーターは、AD ユーザー・アカウントの sAMAccountName です (エンタープライズ・ディレクトリーが AD の場合にのみ役立ちます)。
- directoryId (オプション)
  このパラメーターは、ユーザー・アカウントを保持するエンタープライズ・ディレクトリーの ID です。このパラメーターは、IMS Server でエンタープライズ・ディレクトリーが 1 つしか構成されていない場合はオプションです。
スロー:
ProvisioningBridgeException
IMS Server 上に新しいアカウントを作成できなかった場合は、以下のエラー・コードが示されます。
- AUTHENTICATION_NEEDED
  IMS ブリッジが IMS Server にログオンする前にこのメソッドが呼び出された場合。
- USER_IS_REGISTERED
  IMS Server 上に imsUserId が存在する場合。
- USER_IS_REVOKED
  imsUserId が登録されているが、既に取り消されている場合。

deleteImsAccount

このメソッドは、IMS Server からユーザー・アカウントを削除し、そのユーザーの資格情報 Wallet を削除します。この呼び出しの後、同じユーザー名のアカウントを作成できます。

public void deleteImsAccount(String imsUserId)
throws ProvisioningBridgeException

パラメーター:
imsUserId

IMS Server 上の新しいアカウントのユーザー名。ユーザーの基本エンタープライズ ID と同じ名前を使用します。複数の AD ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName です。例: example.com¥user1。
スロー:
ProvisioningBridgeException
削除が失敗した場合は、以下のエラー・コードが示されます。
- AUTHENTICATION_NEEDED
  IMS ブリッジが IMS Server にログオンする前にこのメソッドが呼び出された場合。
- REMOTE_EXCEPTION
  IMS Server サービスの呼び出しが失敗した場合。
- USER_IS_REVOKED
  imsUserId が IMS Server 上で取り消された場合。

revokeImsAccount

このメソッドは、IMS Server からユーザー・アカウントを取り消して、そのユーザーの資格情報 Wallet を削除します。取り消されたアカウントと同じユーザー名で IMS Server ユーザー・アカウントを作成することはできません。

public void revokeImsAccount(String imsUserId)
throws ProvisioningBridgeException

パラメーター
imsUserId

IMS Server 上の新しいアカウントのユーザー名。ユーザーの基本エンタープライズ ID と同じ名前を使用します。複数の AD ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName です。例: example.com¥user1。
スロー:
ProvisioningBridgeException
取り消しが失敗した場合は、以下のエラー・コードが示されます。
- AUTHENTICATION_NEEDED
  IMS ブリッジが IMS Server にログオンする前にこのメソッドが呼び出された場合。
- REMOTE_EXCEPTION
  IMS Server サービスの呼び出しが失敗した場合。

getRegistrationStatus

このメソッドは、IMS Server でのユーザー・アカウントの登録状況を戻します。

public int getRegistrationStatus(String imsUserId)
throws ProvisioningBridgeExceptions

パラメーター:
imsUserId

IMS Server 上の新しいアカウントのユーザー名。ユーザーの基本エンタープライズ ID と同じ名前を使用します。複数の AD ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName です。例: example.com¥user1。
戻り:
ResultCode.USER_NOT_REGISTERED

ユーザーが IMS Server で見つかりません。

ResultCode.USER_IS_REGISTERED

ユーザーが IMS Server で見つかり、登録されています。

ResultCode.USER_IS_REVOKED

ユーザーが IMS Server で見つかりましたが、取り消されています。

ResultCode.DATASTORE_EXCP

データベース・アクセス・エラーが発生しました。

ResultCode.NOT_OK

何らかのエラーのために、メソッドが登録状況を戻すことができませんでした。
スロー:
ProvisioningBridgeException
呼び出しが失敗した場合は、以下のエラー・コードが示されます。
- AUTHENTICATION_NEEDED
  IMS ブリッジが IMS Server にログオンする前にこのメソッドが呼び出された場合。
- ProvisioningBridgeErrorCode.REMOTE_EXCEPTION
  この呼び出しの成功を妨げるエラーがサーバーで発生した場合。

addAppAccountData

このメソッドは、アプリケーション・アカウント・データをユーザーの資格情報 Wallet に追加します。このアカウントが Wallet 内に存在していないことが必要です。

public void addAppAccountData(String imsUserId, String appId, String appUserId,
String appPassword)  
throws ProvisioningBridgeExceptiong

パラメーター:
imsUserId

IMS Server 上の新しいアカウントのユーザー名。ユーザーの基本エンタープライズ ID と同じ名前を使用します。複数の AD ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName です。例: example.com¥user1。

appId

このアカウント・データが属するアプリケーションのプロビジョニング・システムの固有の ID。

appUserId

追加するアプリケーション・アカウント・データのユーザー名。

appPassword

追加するアプリケーション・アカウント・データのパスワード。
スロー:
ProvisioningBridgeException
アプリケーション・アカウント・データをユーザーの Wallet に設定できない場合は、以下のエラー・コードが示される場合があります。
- AUTHENTICATION_NEEDED
  IMS ブリッジが IMS Server にログオンする前にこのメソッドが呼び出された場合。
- USER_NOT_REGISTERED
  imsUserId が IMS Server 上で登録されていない場合。
- USER_IS_REVOKED
  imsUserId が IMS Server 上で取り消された場合。
- ACCOUNT_ALREADY_EXISTS
  アカウント・データが存在する場合。
- UNKNOWN_AUTH_SERVICE
  appId が IMS Server 上の有効なアプリケーション ID にマップしなかった場合。
- ProvisioningBridgeErrorCode.REMOTE_EXCEPTION
  この呼び出しの成功を妨げるエラーがサーバーで発生した場合。

updateAppAccountData

このメソッドは、ユーザーの資格情報 Wallet でアプリケーション・アカウント・データを更新します。このアカウントが Wallet に存在している必要があります。

public void updateAppAccountData(String imsUserId, String appId, 
String appUserId,String appPassword)throws ProvisioningBridgeException

パラメーター:
imsUserId

IMS Server 上の新しいアカウントのユーザー名。ユーザーの基本エンタープライズ ID と同じ名前を使用します。複数の AD ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName です。例: example.com¥user1。

appId

このアカウント・データが属するアプリケーションのプロビジョニング・システムの固有の ID。

appUserId

更新するアプリケーション・アカウント・データのユーザー名。

appPassword

更新するアプリケーション・アカウント・データのパスワード。
スロー:
ProvisioningBridgeException
アプリケーション・アカウント・データをユーザーの Wallet に設定できない場合は、以下のエラー・コードが示される場合があります。
- AUTHENTICATION_NEEDED
  IMS ブリッジが IMS Server にログオンする前にこのメソッドが呼び出された場合。
- USER_NOT_REGISTERED
  imsUserId が IMS Server 上で登録されていない場合。
- USER_IS_REVOKED
  imsUserId が IMS Server 上で取り消された場合。
- ACCOUNT_NOT_FOUND
  アカウント・データが存在しない場合。
- UNKNOWN_AUTH_SERVICE
  appId が IMS Server 上の有効なアプリケーション ID にマップしなかった場合。
- ProvisioningBridgeErrorCode.REMOTE_EXCEPTION
  この呼び出しの成功を妨げるエラーがサーバーで発生した場合。

deleteAppAccountData

このメソッドは、IMS Server でユーザーの資格情報 Wallet からアプリケーション・アカウント・データを削除します。

public void deleteAppAccountData(String imsUserId, String appId, 
String appUserId)
throws ProvisioningBridgeException

パラメーター:
imsUserId

IMS Server 上の新しいアカウントのユーザー名。ユーザーの基本エンタープライズ ID と同じ名前を使用します。複数の AD ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName です。例: example.com¥user1。

appId

このアカウント・データが属するアプリケーションのプロビジョニング・システムの固有の ID。

appUserId

削除するアプリケーション・アカウント・データのユーザー名。
スロー:
ProvisioningBridgeException
アプリケーション・アカウント・データをユーザーの Wallet に設定できない場合は、以下のエラー・コードが示される場合があります。
- AUTHENTICATION_NEEDED
  IMS ブリッジが IMS Server にログオンする前にこのメソッドが呼び出された場合。
- USER_NOT_REGISTERED
  imsUserId が IMS Server 上で登録されていない場合。
- USER_IS_REVOKED
  imsUserId が IMS Server 上で取り消された場合。
- UNKNOWN_AUTH_SERVICE
  appId が IMS Server 上の有効なアプリケーション ID にマップしなかった場合。
- ProvisioningBridgeErrorCode.REMOTE_EXCEPTION
  この呼び出しの成功を妨げるエラーがサーバーで発生した場合。

getUserAccounts

このメソッドは、ユーザーの資格情報 Wallet にあるアカウントのリストを戻します。パスワード・アカウントおよびプロビジョンされたアカウントが戻されます。

public List getUserAccounts(String imsUserId)
throws ProvisioningBridgeException

パラメーター:
imsUserId

IMS Server 上の新しいアカウントのユーザー名。ユーザーの基本エンタープライズ ID と同じ名前を使用します。複数の AD ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName です。例: example.com¥user1。

appId

このアカウント・データが属するアプリケーションのプロビジョニング・システムの固有の ID。

appUserId

削除するアプリケーション・アカウント・データのユーザー名。
戻り:
アカウントのリストが戻されます。ユーザーがアカウントを持たない場合は、リストが空になります。それ以外の場合、リスト内の各エントリーは、Map オブジェクトのインスタンスになります。 Map オブジェクトには 1 つのアカウントについて選択した情報が含まれており、以下のキーが使用可能です。
- USER_ID
  アカウントのユーザー名。
- AUTHSVC_ID
  アカウントの認証サービス ID。
スロー:
ProvisioningBridgeException

呼び出しが失敗した場合は、以下のエラー・コードが示されます。
- AUTHENTICATION_NEEDED
  IMS ブリッジが IMS Server にログオンする前にこのメソッドが呼び出された場合。
- ProvisioningBridgeErrorCode.REMOTE_EXCEPTION
  この呼び出しの成功を妨げるエラーがサーバーで発生した場合。

getAllActiveUserIDs

このメソッドは、すべてのアクティブ・ユーザー・エンタープライズ ID のリストを戻します。

public List<String> getAllActiveUserIDs(String filter) 
throws ProvisioningBridgeException

パラメーター:
filter

アスタリスク (*) に設定すると、このパラメーターはすべてのユーザーを戻します。
注: アスタリスク (*) を使用して、任意の数の文字を表すこともできます。例えば、filter パラメーターを a*h に設定すると、「a」で始まり「h」で終わるすべての名前 (Ashish、Amitabh、Ajitabh など) が戻されます。
戻り:
アクティブ・ユーザー・エンタープライズ ID のリスト。
- List<String>
  アクティブ・ユーザー・エンタープライズ ID のリスト。
スロー:
ProvisioningBridgeException

呼び出しが失敗した場合は、以下のエラー・コードが示されます。
- AUTHENTICATION_NEEDED
  IMS ブリッジが IMS Server にログオンする前にこのメソッドが呼び出された場合。

resetPassword

このメソッドは、指定された IMS Server ユーザー ID のパスワードをリセットします。

注: API をプロビジョンすると SAM E-SSO パスワードのみがリセットされ、AD パスワードはリセットされません。

public int resetPassword(String imsUserId, String newPassword)
 throws ProvisioningBridgeException

前提条件:
このメソッドを呼び出す前に、「AccessAdmin」>「システム・ポリシー」>「サインアップ・ポリシー」>「合言葉の指定に関するオプション」にナビゲートします。値として「合言葉は必須ではない」を選択します。
パラメーター:
imsUserId

IMS Server 上の新しいアカウントのユーザー名。ユーザーの基本エンタープライズ ID と同じ名前を使用します。複数の AD ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName です。例: example.com¥user1。

newPassword

指定したユーザーの新しいパスワード。

戻り:
ResultCode.OK

パスワードが正常にリセットされた場合。

ResultCode.ILLEGAL_ARGUMENT

いずれかの引数がヌルまたは空である場合。

ResultCode.INVALID_ENCENTUATE_PASSWORD

パスワードがパスワード・ポリシーに従っていない場合。

ResultCode.SECRET_NOT_REQUIRED_DISABLED

IMS Server のセットアップ・ポリシー「合言葉の指定に関するオプション」が「合言葉は必須ではない」に設定されていない場合 (pid_secret_option=0)。

ResultCode.NO_AUTHENTICATOR_SOCI

システムがデータ・ストアからオーセンティケーター Soci を取得できない場合。

ResultCode.UNABLE_TO_DECRYPT_RANDOMIZED_SECRET

ランダム化された合言葉をシステムが暗号化解除できない場合。

ResultCode.GET_CIPHER_DATA_ERROR

システムが未加工の暗号化された CSK およびアルゴリズムを取得できない場合。

ResultCode.UNABLE_TO_DECRYPT_CSK

システムが CSK を暗号化解除できない場合。

ResultCode.UNABLE_TO_ENCRYPT_CSK

システムが CSK を暗号化できない場合。

ResultCode.USER_NOT_REGISTERED

指定したユーザーがシステム・レコードに存在しない場合。

ResultCode.DATASTORE_EXCP

データ・ストア例外が生じた場合。
スロー:
ProvisioningBridgeException

呼び出しが失敗した場合は、以下のエラー・コードが示されます。
- AUTHENTICATION_NEEDED
  IMS ブリッジが IMS Server にログオンする前にこのメソッドが呼び出された場合。

addAccountCredentialWithAccountFields

このメソッドは、プロビジョンされたアカウント資格情報を複数のフィールドとともに追加します。

public int addAccountCredentialWithAccountFields(String sessionId,
         String enterpriseId, String authId, String accountType,
         NameValue[] accountFields)

パラメーター:
sessionID

プロビジョニング・エージェントのセッション ID。

enterpriseID

プロビジョンするユーザーの、エンタープライズ ID または IBM® Security Access Manager for Enterprise Single Sign-On ユーザー名。複数の Active Directory ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName にする必要があります。例: example.com¥user1。

authID

プロビジョンするユーザー・アカウントの認証サービス ID。

accountType

プロビジョンするアカウントのタイプ (Password、OTP、MAC、または Certificate)。

accountFields

適用するアカウント・データ項目テンプレート ID。アカウント・データ項目テンプレートは、個別のアカウント・データ項目のプロパティーを定義します。例: aditi_cipwd。アカウント・データ項目テンプレートについて詳しくは、「AccessStudio ガイド」を参照してください。

戻り:
DATASTORE_EXCEPTION

要求された認証サービスのロード中にデータベース・エラーが発生した場合。

UNKNOWN_AUTH_SERVICE

要求された認証サービスが存在しない場合。

INVALID_AUTH_SERVICE

要求された IMS DB 内の認証サービスが構文解析できない場合。

INVALID_ACCOUNT_DATA_TEMPLATE

authId 用に指定されたアカウント・データ・テンプレートが、入力として指定されたフィールドに一致しない場合。

BAD_INPUT_PARAMETERS

入力がヌルまたは空である場合。

USER_NOT_REGISTERED

ユーザーがまだ登録されていない場合。

UNSUPPORTED_AUTH_MECHANISM

認証サービスでパスワード認証がサポートされない場合。

UNKNOWN_DATA_STORAGE_TEMPLATE

認証サービス用のストレージ・テンプレートを取得するときにエラーが発生した場合。

UNKNOWN_ACCOUNT_DATA_TEMPLATE

認証サービス用のアカウント・データ・テンプレートを取得するときにエラーが発生した場合。

ACCOUNT_ALREADY_EXISTS

追加しようとしているアカウントがユーザーに存在する場合。

NOT_OK

アカウント・データの設定中に何らかのエラーが発生した場合。

addAccountCredentialWithSecondKey

このメソッドは、アカウント資格情報を username、password、および domain の 3 つのフィールドとともに追加します。

public int addAccountCredentialWithAccountFields(String sessionId,
         String enterpriseId, String authId, String accountType,
         NameValue[] accountFields)

パラメーター:
sessionID

プロビジョニング・エージェントのセッション ID。

enterpriseID

プロビジョンするユーザーの、エンタープライズ ID または IBM Security Access Manager for Enterprise Single Sign-On ユーザー名。複数の Active Directory ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName にする必要があります。例: example.com¥user1。

adminEntId

ユーザーを作成した管理者のエンタープライズ ID。

authID

プロビジョンするユーザー・アカウントの認証サービス ID。

accountType

プロビジョンするアカウントのタイプ (Password、OTP、MAC、または Certificate)。

username

追加するアカウントのユーザー名。

domain

追加するアカウントのドメイン。

accountFields

関連付けるアカウント・データ項目テンプレート ID。アカウント・データ項目テンプレートは、個別のアカウント・データ項目のプロパティーを定義します。例: aditi_cipwd。アカウント・データ項目テンプレートについて詳しくは、「AccessStudio ガイド」を参照してください。

戻り:
DATASTORE_EXCEPTION

要求された認証サービスのロード中にデータベース・エラーが発生した場合。

UNKNOWN_AUTH_SERVICE

要求された認証サービスが存在しない場合。

INVALID_AUTH_SERVICE

要求された IMS DB 内の認証サービスが構文解析できない場合。

INVALID_ACCOUNT_DATA_TEMPLATE

authId 用に指定されたアカウント・データ・テンプレートが、入力として指定されたフィールドに一致しない場合。

BAD_INPUT_PARAMETERS

入力がヌルまたは空である場合。

USER_NOT_REGISTERED

ユーザーがまだ登録されていない場合。

UNSUPPORTED_AUTH_MECHANISM

認証サービスでパスワード認証がサポートされない場合。

UNKNOWN_DATA_STORAGE_TEMPLATE

認証サービス用のストレージ・テンプレートを取得するときにエラーが発生した場合。

UNKNOWN_ACCOUNT_DATA_TEMPLATE

認証サービス用のアカウント・データ・テンプレートを取得するときにエラーが発生した場合。

ACCOUNT_ALREADY_EXISTS

追加しようとしているアカウントがユーザーに存在する場合。

NOT_OK

アカウント・データの設定中に何らかのエラーが発生した場合。

removeAccountCredentialWithAccountFields

このメソッドは、プロビジョンされたアカウント資格情報を複数のフィールドを使用して削除します。

public int removeAccountCredentialWithAccountFields(String sessionId,
         String enterpriseId, String authId, String accountType,
         NameValue[] accountFields)

パラメーター:
sessionID

プロビジョニング・エージェントのセッション ID。

enterpriseID

プロビジョンするユーザーの、エンタープライズ ID または IBM Security Access Manager for Enterprise Single Sign-On ユーザー名。複数の Active Directory ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName にする必要があります。例: example.com¥user1。

authID

プロビジョンするユーザー・アカウントの認証サービス ID。

accountType

プロビジョンするアカウントのタイプ (Password、OTP、MAC、または Certificate)。

accountFields

アカウント・データ項目テンプレート ID。アカウント・データ項目テンプレートは、個別のアカウント・データ項目のプロパティーを定義します。例: aditi_cipwd。アカウント・データ項目テンプレートについて詳しくは、「AccessStudio ガイド」を参照してください。

戻り:
DATASTORE_EXCEPTION

要求された認証サービスのロード中にデータベース・エラーが発生した場合。

UNKNOWN_AUTH_SERVICE

要求された認証サービスが存在しない場合。

INVALID_AUTH_SERVICE

要求された IMS DB 内の認証サービスが構文解析できない場合。

INVALID_ACCOUNT_DATA_TEMPLATE

authId 用に指定されたアカウント・データ・テンプレートが、入力として指定されたフィールドに一致しない場合。

BAD_INPUT_PARAMETERS

入力がヌルまたは空である場合。

USER_NOT_REGISTERED

ユーザーがまだ登録されていない場合。

UNSUPPORTED_AUTH_MECHANISM

認証サービスでパスワード認証がサポートされない場合。

UNKNOWN_DATA_STORAGE_TEMPLATE

認証サービス用のストレージ・テンプレートを取得するときにエラーが発生した場合。

UNKNOWN_ACCOUNT_DATA_TEMPLATE

認証サービス用のアカウント・データ・テンプレートを取得するときにエラーが発生した場合。

ACCOUNT_ALREADY_EXISTS

追加しようとしているアカウントがユーザーに存在する場合。

NOT_OK

アカウント・データの設定中に何らかのエラーが発生した場合。

removeAccountCredentialWithSecondKey

このメソッドは、アカウント資格情報を username、password、および domain の 3 つのフィールドを使用して削除します。そのアカウントが存在していることが必要です。

public int removeAccountCredentialWithSecondKey(String sessionId,
         String enterpriseId, String authId, String accountType,
         String username, String secondKey)

パラメーター:
sessionID

プロビジョニング・エージェントのセッション ID。

enterpriseID

プロビジョンするユーザーの、エンタープライズ ID または IBM Security Access Manager for Enterprise Single Sign-On ユーザー名。複数の Active Directory ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName にする必要があります。例: example.com¥user1。

authID

プロビジョンするユーザー・アカウントの認証サービス ID。

accountType

プロビジョンするアカウントのタイプ (Password、OTP、MAC、または Certificate)。

username

追加するアカウントのユーザー名。

domain

追加するアカウントのドメイン。

戻り:
DATASTORE_EXCEPTION

要求された認証サービスのロード中にデータベース・エラーが発生した場合。

UNKNOWN_AUTH_SERVICE

要求された認証サービスが存在しない場合。

INVALID_AUTH_SERVICE

要求された IMS DB 内の認証サービスが構文解析できない場合。

INVALID_ACCOUNT_DATA_TEMPLATE

authId 用に指定されたアカウント・データ・テンプレートが、入力として指定されたフィールドに一致しない場合。

BAD_INPUT_PARAMETERS

入力がヌルまたは空である場合。

USER_NOT_REGISTERED

ユーザーがまだ登録されていない場合。

UNSUPPORTED_AUTH_MECHANISM

認証サービスでパスワード認証がサポートされない場合。

UNKNOWN_DATA_STORAGE_TEMPLATE

認証サービス用のストレージ・テンプレートを取得するときにエラーが発生した場合。

UNKNOWN_ACCOUNT_DATA_TEMPLATE

認証サービス用のアカウント・データ・テンプレートを取得するときにエラーが発生した場合。

ACCOUNT_ALREADY_EXISTS

追加しようとしているアカウントがユーザーに存在する場合。

NOT_OK

アカウント・データの設定中に何らかのエラーが発生した場合。

setAccountCredentialWithAccountFields

このメソッドは、プロビジョンされたアカウント資格情報を複数のフィールドとともに設定します。

public int setAccountCredentialWithAccountFields(String sessionId,
         String enterpriseId, String authId, String accountType,
         NameValue[] accountFields)

パラメーター:
sessionID

プロビジョニング・エージェントのセッション ID。

enterpriseID

プロビジョンするユーザーの、エンタープライズ ID または IBM Security Access Manager for Enterprise Single Sign-On ユーザー名。複数の Active Directory ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName にする必要があります。例: example.com¥user1。

authID

プロビジョンするユーザー・アカウントの認証サービス ID。

accountType

プロビジョンするアカウントのタイプ (Password、OTP、MAC、または Certificate)。

accountFields

アカウント・データ項目テンプレート ID。アカウント・データ項目テンプレートは、個別のアカウント・データ項目のプロパティーを定義します。例: aditi_cipwd。アカウント・データ項目テンプレートについて詳しくは、「AccessStudio ガイド」の『アカウント・データ項目テンプレート』のセクションを参照してください。

戻り:
DATASTORE_EXCEPTION

要求された認証サービスのロード中にデータベース・エラーが発生した場合。

UNKNOWN_AUTH_SERVICE

要求された認証サービスが存在しない場合。

INVALID_AUTH_SERVICE

要求された IMS DB 内の認証サービスが構文解析できない場合。

INVALID_ACCOUNT_DATA_TEMPLATE

authId 用に指定されたアカウント・データ・テンプレートが、入力として指定されたフィールドに一致しない場合。

BAD_INPUT_PARAMETERS

入力がヌルまたは空である場合。

USER_NOT_REGISTERED

ユーザーがまだ登録されていない場合。

UNSUPPORTED_AUTH_MECHANISM

認証サービスでパスワード認証がサポートされない場合。

UNKNOWN_DATA_STORAGE_TEMPLATE

認証サービス用のストレージ・テンプレートを取得するときにエラーが発生した場合。

UNKNOWN_ACCOUNT_DATA_TEMPLATE

認証サービス用のアカウント・データ・テンプレートを取得するときにエラーが発生した場合。

ACCOUNT_ALREADY_EXISTS

追加しようとしているアカウントがユーザーに存在する場合。

NOT_OK

アカウント・データの設定中に何らかのエラーが発生した場合。

setAccountCredentialWithSecondKey

このメソッドは、アカウント資格情報を username、password、および domain の 3 つのフィールドを使用して更新します。そのアカウントが存在していることが必要です。

public int setAccountCredentialWithSecondKey(String sessionId,
         String enterpriseId, String authId, String accountType,
         String username, String password, String secondKey)

パラメーター:
sessionID

プロビジョニング・エージェントのセッション ID。

enterpriseID

プロビジョンするユーザーの、エンタープライズ ID または IBM Security Access Manager for Enterprise Single Sign-On ユーザー名。複数の Active Directory ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName にする必要があります。例: example.com¥user1。

adminEntId

ユーザーを作成した管理者のエンタープライズ ID。

authID

プロビジョンするユーザー・アカウントの認証サービス ID。

accountType

プロビジョンするアカウントのタイプ (Password、OTP、MAC、または Certificate)。

username

追加するアカウントのユーザー名。

domain

追加するアカウントのドメイン。

戻り:
DATASTORE_EXCEPTION

要求された認証サービスのロード中にデータベース・エラーが発生した場合。

UNKNOWN_AUTH_SERVICE

要求された認証サービスが存在しない場合。

INVALID_AUTH_SERVICE

要求された IMS DB 内の認証サービスが構文解析できない場合。

INVALID_ACCOUNT_DATA_TEMPLATE

authId 用に指定されたアカウント・データ・テンプレートが、入力として指定されたフィールドに一致しない場合。

BAD_INPUT_PARAMETERS

入力がヌルまたは空である場合。

USER_NOT_REGISTERED

ユーザーがまだ登録されていない場合。

UNSUPPORTED_AUTH_MECHANISM

認証サービスでパスワード認証がサポートされない場合。

UNKNOWN_DATA_STORAGE_TEMPLATE

認証サービス用のストレージ・テンプレートを取得するときにエラーが発生した場合。

UNKNOWN_ACCOUNT_DATA_TEMPLATE

認証サービス用のアカウント・データ・テンプレートを取得するときにエラーが発生した場合。

ACCOUNT_ALREADY_EXISTS

追加しようとしているアカウントがユーザーに存在する場合。

NOT_OK

アカウント・データの設定中に何らかのエラーが発生した場合。

unlockAccount

このメソッドは、指定された IMS Server ユーザー ID のユーザーをアンロックします。

public int unlockAccount (String sessionId, String enterpriseId, 
         String adminEntId, String unlockEntDirAccount)

パラメーター:
sessionID

プロビジョニング・エージェントのセッション ID。

enterpriseID

プロビジョンするユーザーの、エンタープライズ ID または IBM Security Access Manager for Enterprise Single Sign-On ユーザー名。複数の Active Directory ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName にする必要があります。例: example.com¥user1。

adminEntId

ユーザーを作成した管理者のエンタープライズ ID。

戻り:
ResultCode.OK

パスワードが正常にリセットされた場合。

ResultCode.UNLOCK_WALLET

アカウントは正常にアンロックされましたが、エンタープライズ・ディレクトリー・アカウントのアンロックが失敗しました。

ResultCode.UNLOCK_ENTERPRISE

エンタープライズ・ディレクトリー・アカウントは正常にアンロックされましたが、アカウントのアンロックが失敗しました。

lockAccount

このメソッドは、指定された IMS Server ユーザー ID のユーザーをロックします。

public int lockAccount (String sessionId, String enterpriseId, String adminEntId)

パラメーター:
sessionID

プロビジョニング・エージェントのセッション ID。

enterpriseID

プロビジョンするユーザーの、エンタープライズ ID または IBM Security Access Manager for Enterprise Single Sign-On ユーザー名。複数の Active Directory ドメインがあるデプロイメントの場合、ユーザー名の形式は、dnsDomain¥sAMAccountName にする必要があります。例: example.com¥user1。

adminEntId

ユーザーを作成した管理者のエンタープライズ ID。

戻り:
ResultCode.OK

正常にロックされた場合。

ResultCode.NOT_OK

ロックが失敗した場合。

フィードバック