ジャンプ先

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

セッションの作成

post

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

このメソッドではユーザーのセッションが作成されます。userId以外に何も指定されない場合は、デフォルト値が使用されます。UserIdは必須パラメータです。

リクエスト

本文()

セッションを検索するための詳細な問合せ基準。

ルート・スキーマ : 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"
        }
    }
}

レスポンス

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

• application/json

200 レスポンス

作成されたセッションはレスポンスで返されます。

本文()

ルート・スキーマ : 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"
        }
    }
}

400 レスポンス

不正なリクエスト。入力データにエラーがあります。

404 レスポンス

見つかりません。セッションでエラーは発生しませんでしたが、作成されたセッションが取得できないか見つかりませんでした。

500 レスポンス

予期しないエラー

本文()

ルート・スキーマ : Error

タイプ: object

ソースを表示

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

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