ジャンプ先

• リクエスト
• レスポンス
• 例

指定した問合せパラメータに基づくセッションの削除。

delete

/oam/services/rest/access/api/v1/session

このAPIまたはメソッドは、セッションID、ユーザーIDまたはIDストアに属するすべてのセッションを削除するために使用できます。

リクエスト

問合せパラメータ

• idStore: string
  ユーザーが属するidStore。このパラメータは、userIdパラメータと組み合せて使用します。userIdパラメータを指定しないと、このパラメータは無視されます。
• sessionId(optional): string
  削除するセッションのID。このパラメータを指定すると、他の問合せパラメータは無視されます。
• userId: string
  セッションが削除されるユーザーのユーザーID (loginid)。sessionIdを指定しないと、このパラメータが使用されます。このパラメータを指定すると、idStoreParameterが指定されている場合にはそれも使用されます。

レスポンス

サポートされているメディア・タイプ

• application/json

200 レスポンス

削除されたセッションの配列(最大28セッション)が返されます。

本文()

ルート・スキーマ: schema

タイプ: array

ソースを表示

• [0]: object SessionData

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SessionData"
    }
}

ネストされたスキーマ : 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。

{
    "type":"object",
    "properties":{
        "sessionId":{
            "type":"string",
            "description":"Session Identifier for querying the session."
        },
        "sessionIndex":{
            "type":"string",
            "description":"Unique session identified generated by OAM session engine."
        },
        "createTime":{
            "type":"string",
            "format":"date-time",
            "description":"Time at which session was created."
        },
        "updateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Update Time for session."
        },
        "lastAccessTime":{
            "type":"string",
            "format":"date-time",
            "description":"Last Access Time for session."
        },
        "expiryTime":{
            "type":"string",
            "format":"date-time",
            "description":"Expiry Time for the session."
        },
        "userId":{
            "type":"string",
            "description":"User Id with which session is associated."
        },
        "clientIp":{
            "type":"string",
            "description":"Client IP Address for the session."
        },
        "idStoreName":{
            "type":"string",
            "description":"Session Identifier where user is located for this session."
        },
        "isImpersonating":{
            "type":"boolean",
            "description":"Indicator if this is impersonating user session."
        },
        "userAttributes":{
            "$ref":"#/definitions/UserAttributes"
        }
    }
}

ネストされたスキーマ : UserAttributes

タイプ: object

使用可能なその他のプロパティ

ソースを表示

• object NameValueAttribute

{
    "description":"Collection of Name Value pair attributes",
    "properties":{
        "default":{
            "$ref":"#/definitions/NameValueAttribute"
        }
    },
    "additionalProperties":{
        "$ref":"#/definitions/NameValueAttribute"
    }
}

名前と値のペア属性のコレクション

ソースを表示

• default: object NameValueAttribute

{
    "description":"Collection of Name Value pair attributes",
    "properties":{
        "default":{
            "$ref":"#/definitions/NameValueAttribute"
        }
    },
    "additionalProperties":{
        "$ref":"#/definitions/NameValueAttribute"
    }
}

ネストされたスキーマ : NameValueAttribute

タイプ: object

ソースを表示

• attrName: string
  属性名
• attrValue: string
  属性値

{
    "type":"object",
    "properties":{
        "attrName":{
            "type":"string",
            "description":"Attribute Name"
        },
        "attrValue":{
            "type":"string",
            "description":"Attribute Value"
        }
    }
}

404 レスポンス

セッションまたはユーザーが見つかりませでした。または、sessionIdまたはuserIdが指定されませんでした。

500 レスポンス

予期しないエラー

本文()

ルート・スキーマ : Error

タイプ: object

ソースを表示

• code: integer(int32)
• fields: string
• message: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        },
        "fields":{
            "type":"string"
        }
    }
}

例

cURLの例

これは、sessionIdを使用して1つのセッションを削除するサンプル・リクエストです。

curl -H "Content-Type: application/json" -H "Authorization: Basic <Base64 encoded auth header>" -X "DELETE" ???http://<HOST>:<PORT>/oam/services/rest/access/api/v1/session?sessionId= 3b844e4d-9019-4928-9dca-3ba2ebbf475d%7CU90idWYSK4hXcdo6LlVD2%2BJuHBLvbGtCbbhlfmoDvMA%3D???

リクエスト本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

<?xml version="1.0" encoding="UTF-8"?>
<SessionResults>
<totalRecords>1</totalRecords>
<sessions>
<sessionData>
<sessionId>3b844e4d-9019-4928-9dca-3ba2ebbf475d|U90idWYSK4hXcdo6LlVD2+JuHBLvbGtCbbhlfmoDvMA=</sessionId>
<createTime>2017-05-31T13:57:59.545-07:00</createTime>
<updateTime>2017-05-31T13:57:59.545-07:00</updateTime>
<lastAccessTime>2017-05-31T13:57:59.545-07:00</lastAccessTime>
<expiryTime>2017-05-31T21:57:59.545-07:00</expiryTime>
<userId>user5</userId>
<clientIp>5.6.7.8</clientIp>
<idStoreName>UserIdentityStore1</idStoreName>
<isImpersonating>false</isImpersonating>
</sessionData>
</sessions>
</SessionResults>

cURLの例

ユーザーが終了させられると、管理者はuserIdを使用(またはオプションでid-storeを使用)して、すべてのユーザーのセッションを検索し、すべてのセッションを削除できます。

これは、userIdを使用してユーザーのすべてのセッションを削除するサンプル・リクエストです。

curl -H "Content-Type: application/json" -H "Authorization: Basic <Base64 encoded auth header>" -X "DELETE" "http://<HOST>:<PORT>/oam/services/rest/access/api/v1/session?userId=user3"

リクエスト本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

<?xml version="1.0" encoding="UTF-8"?>
<SessionResults>
<totalRecords>2</totalRecords>
<sessions>
<sessionData>
<sessionId>32de23f1-9f53-47e7-b4d5-9d0376187241|c+4quN74tM7P6qvbYVqa6BQOg3RYHDsFT3PzPajvEzM=</sessionId>
<createTime>2017-05-31T13:56:35.426-07:00</createTime>
<updateTime>2017-05-31T13:56:35.426-07:00</updateTime>
<lastAccessTime>2017-05-31T13:56:35.426-07:00</lastAccessTime>
<expiryTime>2017-05-31T21:56:35.426-07:00</expiryTime>
<userId>user3</userId>
<clientIp>1.2.3.4</clientIp>
<idStoreName>UserIdentityStore1</idStoreName>
<isImpersonating>false</isImpersonating>
</sessionData>
<sessionData>
<sessionId>3e8fd79e-03b8-4c90-bf4d-964119460a0a|c+4quN74tM7P6qvbYVqa6BQOg3RYHDsFT3PzPajvEzM=</sessionId>
<createTime>2017-05-31T13:56:52.918-07:00</createTime>
<updateTime>2017-05-31T13:56:52.918-07:00</updateTime>
<lastAccessTime>2017-05-31T13:56:52.918-07:00</lastAccessTime>
<expiryTime>2017-05-31T21:56:52.918-07:00</expiryTime>
<userId>user3</userId>
<clientIp>5.6.7.8</clientIp>
<idStoreName>UserIdentityStore1</idStoreName>
<isImpersonating>false</isImpersonating>
</sessionData>
</sessions>
</SessionResults>