Jump to

• Request
• Response

Create a session

post

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

This method creates a session for the user. Default values are used if none other than userId are provided. UserId is a mandatory parameter.

Request

Body ()

Detailed query criterion for searching the sessions.

Root Schema : SessionData

Type: object

Show Source

• clientIp(optional): string
  Client IP Address for the session.
• createTime(optional): string(date-time)
  Time at which session was created.
• expiryTime(optional): string(date-time)
  Expiry Time for the session.
• idStoreName(optional): string
  Session Identifier where user is located for this session.
• isImpersonating(optional): boolean
  Indicator if this is impersonating user session.
• lastAccessTime(optional): string(date-time)
  Last Access Time for session.
• sessionId(optional): string
  Session Identifier for querying the session.
• sessionIndex(optional): string
  Unique session identified generated by OAM session engine.
• updateTime(optional): string(date-time)
  Update Time for session.
• userAttributes(optional): object UserAttributes
  Additional Properties Allowed: NameValueAttribute

  Collection of Name Value pair attributes
• userId: string
  User Id with which session is associated.

{
    "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"
        }
    },
    "required":[
        "userId"
    ]
}

Nested Schema : UserAttributes

Type: object

Additional Properties Allowed

Show Source

• object NameValueAttribute

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

Collection of Name Value pair attributes

Show Source

• default(optional): object NameValueAttribute

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

Nested Schema : NameValueAttribute

Type: object

Show Source

• attrName(optional): string
  Attribute Name
• attrValue(optional): string
  Attribute Value

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Created session is returned in the response.

Body ()

Root Schema : SessionData

Type: object

Show Source

• clientIp(optional): string
  Client IP Address for the session.
• createTime(optional): string(date-time)
  Time at which session was created.
• expiryTime(optional): string(date-time)
  Expiry Time for the session.
• idStoreName(optional): string
  Session Identifier where user is located for this session.
• isImpersonating(optional): boolean
  Indicator if this is impersonating user session.
• lastAccessTime(optional): string(date-time)
  Last Access Time for session.
• sessionId(optional): string
  Session Identifier for querying the session.
• sessionIndex(optional): string
  Unique session identified generated by OAM session engine.
• updateTime(optional): string(date-time)
  Update Time for session.
• userAttributes(optional): object UserAttributes
  Additional Properties Allowed: NameValueAttribute

  Collection of Name Value pair attributes
• userId: string
  User Id with which session is associated.

{
    "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"
        }
    },
    "required":[
        "userId"
    ]
}

Nested Schema : UserAttributes

Type: object

Additional Properties Allowed

Show Source

• object NameValueAttribute

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

Collection of Name Value pair attributes

Show Source

• default(optional): object NameValueAttribute

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

Nested Schema : NameValueAttribute

Type: object

Show Source

• attrName(optional): string
  Attribute Name
• attrValue(optional): string
  Attribute Value

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

400 Response

Bad Request. Error in input Data.

404 Response

Not Found. Session creation had no errors, but created session could not be reqrieved/found.

500 Response

Unexpected error

Body ()

Root Schema : Error

Type: object

Show Source

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

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

Back to Top