REST API for Session Management in Oracle Access Manager

Retrieve Sessions based on provided query filter

post

/oam/services/rest/access/api/v1/sessions

The sessions endpoint returns information about the sessions. The response includes sessionId, user name, Identity Store, session create date, ip address and other details about each session..

Request

Query Parameters

idStore(optional): string

Identity Store name for the users, whose sessions are to be searched.
sessionId(optional): string

Session Id of the session if single session is to be queried.
userId(optional): string

User login id of the user, whose sessions are to be searched.

Detailed query criterion for searching the sessions.

Root Schema : SessionSearchQuery

Type: object

Show Source

clientIp(optional): string

Client IP Address query filter.
expiryTime(optional): string(date-time)

Expiry Time query filter.
fromIndex(optional): integer

Session from index for querying the session. This parameter is used in conjunction with the pageSize. This parameter is not used.
idStoreName(optional): string

Session Identifier for querying the session.
isImpersonating(optional): boolean

Session Identifier for querying the session.
lastAccessTime(optional): string(date-time)

Last Access Time query filter.
pageSize(optional): integer

PageSize desired for the output. This parmeter is not used.
sessionId(optional): string

Session Identifier for querying the session.
updateTime(optional): string(date-time)

Update Time query filter.
userAttributes(optional): object UserAttributes

Additional Properties Allowed: NameValueAttribute

Collection of Name Value pair attributes
userId(optional): string

User Id query filter.

{
    "type":"object",
    "properties":{
        "sessionId":{
            "type":"string",
            "description":"Session Identifier for querying the session."
        },
        "updateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Update Time query filter."
        },
        "lastAccessTime":{
            "type":"string",
            "format":"date-time",
            "description":"Last Access Time query filter."
        },
        "expiryTime":{
            "type":"string",
            "format":"date-time",
            "description":"Expiry Time query filter."
        },
        "userId":{
            "type":"string",
            "description":"User Id query filter."
        },
        "clientIp":{
            "type":"string",
            "description":"Client IP Address query filter."
        },
        "idStoreName":{
            "type":"string",
            "description":"Session Identifier for querying the session."
        },
        "isImpersonating":{
            "type":"boolean",
            "description":"Session Identifier for querying the session."
        },
        "pageSize":{
            "type":"integer",
            "description":"PageSize desired for the output. This parmeter is not used."
        },
        "fromIndex":{
            "type":"integer",
            "description":"Session from index for querying the session. This parameter is used in conjunction with the pageSize. This parameter is not used."
        },
        "userAttributes":{
            "$ref":"#/definitions/UserAttributes"
        }
    }
}

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"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A session result object that contains an array of sessions with maximum of 28 sessions is returned. It also contains other summary information.

Root Schema : SessionResults

Type: object

Show Source

firstLink(optional): string

Link(http(s)) to the first session page in the results.
nextLink(optional): string

Link(http(s)) to the next sessions page in the results.
previousLink(optional): string

Link(http(s)) to the previous sessions page in the results.
sessions(optional): object Sessions

Collections of SessionData Objects.
totalRecords(optional): integer

total number records available as a result of this query. This page may be only part of those total records.

{
    "type":"object",
    "properties":{
        "firstLink":{
            "type":"string",
            "description":"Link(http(s)) to the first session page in the results."
        },
        "previousLink":{
            "type":"string",
            "description":"Link(http(s)) to the previous sessions page in the results."
        },
        "nextLink":{
            "type":"string",
            "description":"Link(http(s)) to the next sessions page in the results."
        },
        "totalRecords":{
            "type":"integer",
            "description":"total number records available as a result of this query. This page may be only part of those total records."
        },
        "sessions":{
            "$ref":"#/definitions/Sessions"
        }
    }
}

Nested Schema : Sessions

Type: object

Collections of SessionData Objects.

Show Source

additionalProperties(optional): object SessionData
default(optional): object SessionData

{
    "description":"Collections of SessionData Objects.",
    "properties":{
        "default":{
            "$ref":"#/definitions/SessionData"
        },
        "additionalProperties":{
            "$ref":"#/definitions/SessionData"
        }
    }
}

Nested 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"
        }
    }
}

401 Response

Unauthorized

404 Response

Requested Data Not found

500 Response

Internal Server Error

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"
        }
    }
}

Examples

Use the userId to search for sessions pertaining to a particular user

If you have the clientIp, you can search for all the sessions coming from that client address.

Note:

Searching a session lists out only 28 sessions per query and the displayed search results are not paginated.

cURL Example

This is a sample request where the userId is provided to search for the sessions of a particular user.

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

Example of Request Body

The following example shows the contents of the response body in JSON format.

<?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 Example

This is a sample request where the clientIp is provided to search for all the sessions coming from that client address.

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

Example of Request Body

The following example shows the contents of the response body in JSON format.

<?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>