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
Detailed query criterion for searching the sessions.
Root Schema : SessionData
Type:
Show Source
object
-
clientIp:
string
Client IP Address for the session.
-
createTime:
string(date-time)
Time at which session was created.
-
expiryTime:
string(date-time)
Expiry Time for the session.
-
idStoreName:
string
Session Identifier where user is located for this session.
-
isImpersonating:
boolean
Indicator if this is impersonating user session.
-
lastAccessTime:
string(date-time)
Last Access Time for session.
-
sessionId:
string
Session Identifier for querying the session.
-
sessionIndex:
string
Unique session identified generated by OAM session engine.
-
updateTime:
string(date-time)
Update Time for session.
-
userAttributes:
object UserAttributes
Additional Properties Allowed: NameValueAttributeCollection of Name Value pair attributes
-
userId(required):
string
User Id with which session is associated.
Nested Schema : UserAttributes
Type:
object
Additional Properties Allowed
Show Source
Collection of Name Value pair attributes
Show Source
Nested Schema : NameValueAttribute
Type:
Show Source
object
-
attrName:
string
Attribute Name
-
attrValue:
string
Attribute Value
Response
Supported Media Types
- application/json
200 Response
Created session is returned in the response.
Root Schema : SessionData
Type:
Show Source
object
-
clientIp:
string
Client IP Address for the session.
-
createTime:
string(date-time)
Time at which session was created.
-
expiryTime:
string(date-time)
Expiry Time for the session.
-
idStoreName:
string
Session Identifier where user is located for this session.
-
isImpersonating:
boolean
Indicator if this is impersonating user session.
-
lastAccessTime:
string(date-time)
Last Access Time for session.
-
sessionId:
string
Session Identifier for querying the session.
-
sessionIndex:
string
Unique session identified generated by OAM session engine.
-
updateTime:
string(date-time)
Update Time for session.
-
userAttributes:
object UserAttributes
Additional Properties Allowed: NameValueAttributeCollection of Name Value pair attributes
-
userId(required):
string
User Id with which session is associated.
Nested Schema : UserAttributes
Type:
object
Additional Properties Allowed
Show Source
Collection of Name Value pair attributes
Show Source
Nested Schema : NameValueAttribute
Type:
Show Source
object
-
attrName:
string
Attribute Name
-
attrValue:
string
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