アプリケーションキーサービス
アプリケーションキーを使用する際に役立つサービスがいくつか用意されています。
アプリケーションキーサービス
サービス名
説明
GetExpirationDate
アプリケーションキーの有効期限を返します。
GetKeyID
アプリケーションキーのキー ID を返します。
GetUserName
アプリケーションキーに関連付けられているユーザー名を返します。
IsExpired
アプリケーションキーの有効期限が切れている場合に true を返します。
ResetExpirationDatetoDefault
ユーザー管理サブシステムのコンフィギュレーションで有効期限をデフォルトに設定します。
SetClientName
アプリケーションキーのクライアント名を設定します。
SetExpirationDate
アプリケーションキーの有効期限を設定します。DATETIME ベースタイプを受け入れ、値をただちに永続化します。
SetIPWhitelist
アプリケーションキーの IP ホワイトリストを設定します。
SetUserName
アプリケーションキーに関連付けるユーザー名を設定します。
ユーザーサービス
サービス名
説明
DeleteApplicationKeys
指定したユーザーに関連付けられているアプリケーションキーを削除します。アプリケーションキーを削除するには、少なくとも 1 つのパラメータ (expiredKeys または unexpiredKeys) の値として true を指定します。アプリケーションキーを削除するには、両方のパラメータの値として true を指定します。
DoesApplicationKeyWithKeyIdExist
ユーザーに関連付けられている指定されたキー ID が存在する場合は、true を返します。
GetApplicationKeyExpirationInfo
ユーザーに関連付けられているアプリケーションキー有効期限の情報を取得します。いずれかのアプリケーションキーを返すには少なくとも 1 つのパラメータ (expiredKeys または unexpiredKeys) に true を指定し、すべてのアプリケーションキーを返す場合は両方のパラメータに true を指定します。
ApplicationKeyExpirationInfo のデータシェイプを返します。
ユーザー管理サブシステム
サービス名
説明
DeleteApplicationKeys
指定したユーザーに関連付けられているアプリケーションキーを削除します。いずれかのアプリケーションキーを削除するには少なくとも 1 つのパラメータに true を指定し、すべてのアプリケーションキーを削除する場合は両方のパラメータに true を指定します。
DoesApplicationKeyWithKeyIdExist
ユーザーに関連付けられている指定されたキー ID が存在する場合は、true を返します。
GetApplicationKeyExpirationInfo
指定したユーザーに関連付けられているアプリケーションキー情報を取得します。いずれかのアプリケーションキーを返すには少なくとも 1 つのパラメータ (expiredKeys または unexpiredKeys) に true を指定し、すべてのアプリケーションキーを返す場合は両方のパラメータに true を指定する必要があります。
エンティティサービス
サービス名
説明
CreateApplicationKey
新しいアプリケーションキーを作成します。
DeleteApplicationKey
アプリケーションキーを削除します。
関連リンク