Skip to main content

 

OutSystems 11オンラインヘルプ

 

OutSystems

Users API

このAPIは、ユーザーとそのロールやグループを管理できるUsersアプリケーションで利用できる機能のサブセットへのアクセスを提供します。

Users APIはUserシステムエンティティとGroupシステムエンティティを管理しますが、それらに対する追加ロジックも含みます。

このAPIを使用するには、Development環境の[References]ウィンドウを使用してUsersモジュールを参照します。

概要

ウィジェット 説明
ChangePassword ユーザーパスワードを変更できます。
EditMyInfo
アクション 説明
EncryptPassword 特定のユーザー名とパスワードに対する暗号化されたパスワードを返します。これは、UserシステムエンティティのPasswordアトリビュートに保持されている値です。
GetEffectiveUserProviderEspaceId 有効なユーザープロバイダのeSpace識別子を返します。通常はUsers eSpaceIdを返し、アップグレードシナリオではEnterpriseManager eSpaceIdを返します。
Group_CreateNew 新しいシステムグループを作成します。呼び出すには、UserManagerロールが必要です。
Group_Delete システムグループを削除します。呼び出すには、UserManagerロールが必要です。
Group_Update システムグループを更新します。呼び出すには、UserManagerロールが必要です。
IPAddress_GetBlockedStatus IPアドレスのブロック状態を返します。
IPAddress_GetBlocks IPアドレスのブロック状態を返します。このアドレスのブロックがない場合、リストは空になります。IPアドレスが指定されていない場合、ブロックされているすべてのIPアドレスの情報が返されます。
IPAddress_Unblock 指定されたIPアドレスのブロック期間を終了し、ユーザーがそのアドレスにログインできるようにします。
UseActiveDirectoryAuthentication Active Directoryを認証に使用するかどうかを判定するUsersの構成を返します。
UseIntegratedAuthentication 統合認証を使用してログインするかどうかを判定するUsersの構成を返します。
UseLDAPAuthentication Active Directoryを認証に使用するかどうかを判定するUsersの構成を返します。
User_CanChangePassword ユーザーがパスワードを変更できるかどうかを確認します。Active Directoryユーザーの場合はFalseです。
User_Create 新しいユーザーを作成します。呼び出すには、UserManagerロールが必要です。
ユーザー名が繰り返された場合は失敗します。
User_CreateOrUpdate ユーザーを作成または更新します。呼び出すには、UserManagerロールが必要です。
User_DeleteIfNoRoles ロールが割り当てられていない場合、ユーザーを削除します。
User_GetBlockedStatus 指定されたIPアドレスのユーザーのブロック状態とブロック理由に関する情報を返します。IPアドレスが指定されていない場合、ユーザーがログインを試行した最後のIPアドレスを確認します。
User_GetIdByUsername ユーザー名で指定した特定のユーザーのユーザー識別子を返します。
User_GetLastFailedLoginAttempts 最後に失敗したログイン試行のリストを返します(IPアドレスごとに1レコード)。User_UnblockまたはIPaddress_Unblockを呼び出すときにこの情報を使用できます。
User_GetName ログインユーザーの名前を返します。
User_GetUnifiedLoginUrl カスタム統合ログインパターンに使用するURLを返します。統合Windows認証パターンを含みます。
User_IsExternalUser
User_Login 資格情報としてユーザー名とパスワードを使用してログインするアクション。
User_Logout 現在のユーザーをログアウトします。ログアウトプロセス中にセッション変数がクリアされます。
User_Unblock 指定されたユーザーのブロック期間を終了し、ユーザーがブロックされていたすべてのIPアドレスにログインできるようにします。
User_Update 特定のユーザーを更新します。
ストラクチャ 説明
LoginAttemptPublic 公開されているログイン試行レコードストラクチャを表します。
静的エンティティ 説明
LoginAttemptResult LoginAttemptレコードのResult列に表示される可能性がある代替値。
MenuItem メニューWebブロックパラメータで使用するメニュー項目。
ロール 説明
UserManager

ウィジェット

ChangePassword

ユーザーパスワードを変更できます。

入力

UserId
型: 任意。User Identifier。

EditMyInfo

アクション

EncryptPassword

特定のユーザー名とパスワードに対する暗号化されたパスワードを返します。これは、UserシステムエンティティのPasswordアトリビュートに保持されている値です。

入力

Username
型: 必須。Text。
Password
型: 必須。Text。

出力

EncryptedPassword
型: Text。

GetEffectiveUserProviderEspaceId

有効なユーザープロバイダのeSpace識別子を返します。通常はUsers eSpaceIdを返し、アップグレードシナリオではEnterpriseManager eSpaceIdを返します。

出力

EspaceId
型: Espace Identifier。

Group_CreateNew

新しいシステムグループを作成します。呼び出すには、UserManagerロールが必要です。

入力

Group
型: 必須。Group。

出力

GroupId
型: Group Identifier。

Group_Delete

システムグループを削除します。呼び出すには、UserManagerロールが必要です。

入力

GroupId
型: 必須。Group Identifier。

Group_Update

システムグループを更新します。呼び出すには、UserManagerロールが必要です。

入力

Group
型: 必須。Group。

IPAddress_GetBlockedStatus

IPアドレスのブロック状態を返します。

入力

IPAddress
型: 必須。Text。
ブロック状態を評価するIPアドレス。

出力

LoginAttemptResult
型: LoginAttemptResult
指定されたIPアドレスのブロック状態。

IPAddress_GetBlocks

IPアドレスのブロック状態を返します。このアドレスのブロックがない場合、リストは空になります。IPアドレスが指定されていない場合、ブロックされているすべてのIPアドレスの情報が返されます。

入力

IPAddress
型: 任意。Text。
現在のブロック状態を取得するIPアドレス。

出力

BlockedAddresses
型: LoginAttemptPublic List。
指定されたIPアドレス(入力が指定されていない場合はすべてのIPアドレス)に関連するブロックされたログイン試行。

IPAddress_Unblock

指定されたIPアドレスのブロック期間を終了し、ユーザーがそのアドレスにログインできるようにします。

入力

IPAddress
型: 必須。Text。
ブロックを解除するIPアドレス。

UseActiveDirectoryAuthentication

Active Directoryを認証に使用するかどうかを判定するUsersの構成を返します。

出力

IsActive
型: Boolean。

UseIntegratedAuthentication

統合認証を使用してログインするかどうかを判定するUsersの構成を返します。

出力

IsActive
型: Boolean。

UseLDAPAuthentication

Active Directoryを認証に使用するかどうかを判定するUsersの構成を返します。

出力

IsActive
型: Boolean。

User_CanChangePassword

ユーザーがパスワードを変更できるかどうかを確認します。Active Directoryユーザーの場合はFalseです。

入力

UserId
型: 必須。User Identifier。

出力

IsAllowed
型: Boolean。

User_Create

新しいユーザーを作成します。呼び出すには、UserManagerロールが必要です。
ユーザー名が繰り返された場合は失敗します。

入力

User
型: 必須。User。

出力

UserId
型: User Identifier。

User_CreateOrUpdate

ユーザーを作成または更新します。呼び出すには、UserManagerロールが必要です。

入力

User
型: 必須。User。

出力

UserId
型: User Identifier。

User_DeleteIfNoRoles

ロールが割り当てられていない場合、ユーザーを削除します。

入力

UserId
型: 必須。User Identifier。

User_GetBlockedStatus

指定されたIPアドレスのユーザーのブロック状態とブロック理由に関する情報を返します。IPアドレスが指定されていない場合、ユーザーがログインを試行した最後のIPアドレスを確認します。

入力

Username
型: 必須。Text。
ブロック/ブロック解除状態に関する情報を取得するユーザーのユーザー名。
IPAddress
型: 任意。Text。
ブロック/ブロック解除状態に関する情報を取得するIPアドレス。

出力

LoginAttemptResult
型: LoginAttemptResult
指定されたユーザー名のブロック状態および理由。

User_GetIdByUsername

ユーザー名で指定した特定のユーザーのユーザー識別子を返します。

入力

Username
型: 必須。Text。

出力

UserId
型: User Identifier。

User_GetLastFailedLoginAttempts

最後に失敗したログイン試行のリストを返します(IPアドレスごとに1レコード)。User_UnblockまたはIPaddress_Unblockを呼び出すときにこの情報を使用できます。

入力

Username
型: 必須。Text。
失敗したログイン試行を取得するユーザーのユーザー名。
Since
型: 任意。Date Time。
この日時より後のログイン試行のみが取得されます。

出力

LoginAttempt
型: LoginAttemptPublic List。
指定されたユーザー名の最後に失敗したログイン試行のリスト。

User_GetName

ログインユーザーの名前を返します。

出力

Name
型: Text。

User_GetUnifiedLoginUrl

カスタム統合ログインパターンに使用するURLを返します。統合Windows認証パターンを含みます。

入力

OriginalUrl
型: 必須。Text。

出力

Url
型: Text。

User_IsExternalUser

入力

UserId
型: 必須。User Identifier。

出力

IsExternal
型: Boolean。

User_Login

資格情報としてユーザー名とパスワードを使用してログインするアクション。

入力

Username
型: 必須。Text。
ユーザーのユーザー名。
Password
型: 必須。Text。
ユーザーのパスワード(暗号化されていない必要があります)。
RememberLogin
型: 必須。Boolean。
Trueの場合、ログインは10日間保持されます。

User_Logout

現在のユーザーをログアウトします。ログアウトプロセス中にセッション変数がクリアされます。

User_Unblock

指定されたユーザーのブロック期間を終了し、ユーザーがブロックされていたすべてのIPアドレスにログインできるようにします。

入力

Username
型: 必須。Text。
ブロックが解除され、指定されたIPアドレスから再度ログインできるようになるユーザーのユーザー名。
IPAddress
型: 任意。Text。
ブロックが解除され、指定されたユーザーが再びログインできるようになるIPアドレス。

User_Update

特定のユーザーを更新します。

入力

User
型: 必須。User。

ストラクチャ

LoginAttemptPublic

公開されているログイン試行レコードストラクチャを表します。

アトリビュート

Instant
型: Date Time。
Success
型: Boolean。
IPAddress
型: Text (45)。
UsernameFailureCount
型: Integer。
IPAddressFailureCount
型: Integer。
RequestKey
型: Text (36)。
UserAgent
型: Text (200)。
Visitor
型: Text (36)。
Result
型: Text。

静的エンティティ

LoginAttemptResult

LoginAttemptレコードのResult列に表示される可能性がある代替値。

アトリビュート

Id
型: Text (50)。

レコード

  • InvalidLDAPAuthentication
  • BlockedIP
  • Unblocked
  • LoggedIn
  • BlockedUser
  • InvalidADAuthentication
  • InvalidUser
  • InvalidPassword

MenuItem

メニューWebブロックパラメータで使用するメニュー項目。

アトリビュート

Id
型: Integer。
Order
型: Integer。
Caption
型: Text (50)。

レコード

  • Applications
  • Users
  • Groups
  • Was this article helpful?