指定された問合せフィルタに基づくセッションの取得
post
/oam/services/rest/access/api/v1/sessions
セッション・エンドポイントはセッションに関する情報を返します。応答には、sessionId、ユーザー名、アイデンティティ・ストア、セッション作成日、IPアドレスおよび各セッションの他の詳細が含まれます。
リクエスト
問合せパラメータ
- idStore(optional): string
セッションを検索するユーザーのアイデンティティ・ストア名。
- sessionId(optional): string
1つのセッションを問い合せる場合は、セッションのセッションID。
- userId(optional): string
セッションを検索するユーザーのユーザー・ログインID。
セッションを検索するための詳細な問合せ基準。
ルート・スキーマ : SessionSearchQuery
タイプ:
ソースを表示
object
- clientIp: string
クライアントIPアドレス問合せフィルタ。
- expiryTime: string(date-time)
有効期間問合せフィルタ。
- fromIndex: integer
セッションを問い合せるためのインデックスからのセッション。このパラメータは、pageSizeと組み合せて使用します。このパラメータは使用されていません。
- idStoreName: string
セッションを問い合せるためのセッション識別子。
- isImpersonating: boolean
セッションを問い合せるためのセッション識別子。
- lastAccessTime: string(date-time)
最終アクセス時刻問合せフィルタ。
- pageSize: integer
出力で使用するPageSize。このパラメータは使用されていません。
- sessionId: string
セッションを問い合せるためのセッション識別子。
- updateTime: string(date-time)
更新時刻問合せフィルタ。
- userAttributes: object UserAttributes
使用可能なその他のプロパティ: NameValueAttribute名前と値のペア属性のコレクション
- userId: string
ユーザーID問合せフィルタ。
レスポンス
サポートされているメディア・タイプ
- application/json
200 レスポンス
最大28セッションのセッションの配列を含むセッション結果オブジェクトが返されます。これには、その他のサマリー情報も含まれます。
ルート・スキーマ : SessionResults
タイプ:
ソースを表示
object
- firstLink: string
結果の最初のセッション・ページへのリンク(http(s))。
- nextLink: string
結果の次のセッション・ページへのリンク(http(s))。
- previousLink: string
結果の前のセッション・ページへのリンク(http(s))。
- sessions: object Sessions
SessionDataオブジェクトのコレクション。
- totalRecords: integer
この問合せの結果として使用可能な合計レコード数。このページはこれらの合計レコードの一部のみである場合があります。
ネストされたスキーマ : SessionData
タイプ:
ソースを表示
object
- clientIp: string
セッションのクライアントIPアドレス。
- createTime: string(date-time)
セッションが作成された時刻。
- expiryTime: string(date-time)
セッションの有効期間。
- idStoreName: string
このセッションのユーザーが存在するセッション識別子。
- isImpersonating: boolean
これが偽装ユーザー・セッションであるかどうかのインジケータ。
- lastAccessTime: string(date-time)
セッションの最終アクセス時刻。
- sessionId: string
セッションを問い合せるためのセッション識別子。
- sessionIndex: string
OAMセッション・エンジンによって生成された、一意に識別されるセッション。
- updateTime: string(date-time)
セッションの更新時刻。
- userAttributes: object UserAttributes
使用可能なその他のプロパティ: NameValueAttribute名前と値のペア属性のコレクション
- userId: string
セッションが関連付けられているユーザーID。
401 レスポンス
認可されていません
404 レスポンス
リクエストされたデータが見つかりません
500 レスポンス
内部サーバー・エラー
例
特定のユーザーに関連するセッションを検索するには、userIdを使用します
clientIpがわかる場合、そのクライアント・アドレスに由来するセッションをすべて検索することができます。
注意:
セッションを検索すると、問合せあたり28セッションのみリストされ、表示された探索結果はページ付けされません。
cURLの例
これは、特定のユーザーのセッションを検索するためにuserIdを指定したサンプル・リクエストです。
curl -H "Content-Type: application/json" -H "Authorization: Basic <Base64 encoded auth header>" -X POST -d '{"userId":"user2"}' http://<HOST>:<PORT>/oam/services/rest/access/api/v1/sessions
リクエスト本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
<?xml version="1.0" encoding="UTF-8"?> <SessionResults> <totalRecords>2</totalRecords> <sessions> <sessionData> <sessionId>53f96ca1-e65a-47ee-a758-a1cebb63f4b3|L+h1SktCgMtjnOnmIWL+gnpIstrT9hGuPD0beqGK5Cc=</sessionId> <createTime>2017-05-31T13:56:19.000-07:00</createTime> <updateTime>2017-05-31T13:56:19.000-07:00</updateTime> <lastAccessTime>2017-05-31T13:56:19.000-07:00</lastAccessTime> <userId>user2</userId> <clientIp>5.6.7.8</clientIp> <idStoreName>UserIdentityStore1</idStoreName> <isImpersonating>false</isImpersonating> </sessionData> <sessionData> <sessionId>a3d62e11-3f22-4336-b76c-e8f8cbd46306|L+h1SktCgMtjnOnmIWL+gnpIstrT9hGuPD0beqGK5Cc=</sessionId> <createTime>2017-05-31T13:55:43.000-07:00</createTime> <updateTime>2017-05-31T13:55:43.000-07:00</updateTime> <lastAccessTime>2017-05-31T13:55:43.000-07:00</lastAccessTime> <userId>user2</userId> <clientIp>1.2.3.4</clientIp> <idStoreName>UserIdentityStore1</idStoreName> <isImpersonating>false</isImpersonating> </sessionData> </sessions> </SessionResults>
cURLの例
これは、そのクライアント・アドレスからのすべてのセッションを検索するためにclientIpを指定したサンプル・リクエストです。curl -H "Content-Type: application/json" -H "Authorization: Basic <Base64 encoded auth header>" -X POST -d '{"clientIp":"1.2.3.4"}' http://<HOST>:<PORT>/oam/services/rest/access/api/v1/sessions
リクエスト本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
<?xml version="1.0" encoding="UTF-8"?> <SessionResults> <totalRecords>4</totalRecords> <sessions> <sessionData> <sessionId>a9cacf25-18cc-4d72-9237-e32394fa294e|U90idWYSK4hXcdo6LlVD2+JuHBLvbGtCbbhlfmoDvMA=</sessionId> <createTime>2017-05-31T13:57:32.000-07:00</createTime> <updateTime>2017-05-31T13:57:32.000-07:00</updateTime> <lastAccessTime>2017-05-31T13:57:32.000-07:00</lastAccessTime> <userId>user5</userId> <clientIp>1.2.3.4</clientIp> <idStoreName>UserIdentityStore1</idStoreName> <isImpersonating>false</isImpersonating> </sessionData> <sessionData> <sessionId>32de23f1-9f53-47e7-b4d5-9d0376187241|c+4quN74tM7P6qvbYVqa6BQOg3RYHDsFT3PzPajvEzM=</sessionId> <createTime>2017-05-31T13:56:35.000-07:00</createTime> <updateTime>2017-05-31T13:56:35.000-07:00</updateTime> <lastAccessTime>2017-05-31T13:56:35.000-07:00</lastAccessTime> <userId>user3</userId> <clientIp>1.2.3.4</clientIp> <idStoreName>UserIdentityStore1</idStoreName> <isImpersonating>false</isImpersonating> </sessionData> <sessionData> <sessionId>a3d62e11-3f22-4336-b76c-e8f8cbd46306|L+h1SktCgMtjnOnmIWL+gnpIstrT9hGuPD0beqGK5Cc=</sessionId> <createTime>2017-05-31T13:55:43.000-07:00</createTime> <updateTime>2017-05-31T13:55:43.000-07:00</updateTime> <lastAccessTime>2017-05-31T13:55:43.000-07:00</lastAccessTime> <userId>user2</userId> <clientIp>1.2.3.4</clientIp> <idStoreName>UserIdentityStore1</idStoreName> <isImpersonating>false</isImpersonating> </sessionData> <sessionData> <sessionId>c639fb4d-f467-4da3-88c8-0e6754d809a7|hUNJ4YlF30b5ycVlEq7iZ8LwFa8i9G5QhmKdkr3TizU=</sessionId> <createTime>2017-05-31T13:57:17.000-07:00</createTime> <updateTime>2017-05-31T13:57:17.000-07:00</updateTime> <lastAccessTime>2017-05-31T13:57:17.000-07:00</lastAccessTime> <userId>user4</userId> <clientIp>1.2.3.4</clientIp> <idStoreName>UserIdentityStore1</idStoreName> <isImpersonating>false</isImpersonating> </sessionData> </sessions> </SessionResults>