PingOne Platform APIs

User Sessions

Represents the user session associated with a flow. You can read all sessions, read a single session, or delete a single session associated with your user ID. Administrators can read all sessions for a specified user, read a single session for a specified user, or delete a user’s session for the environment or population for which they have administrator privileges.

Refer also to Sessions for interfaces on the Environment endpoint.

User session data model

Property Type Required? Mutable? Description

activeAt

Date

N/A

Read-only

The last user activity time on this session (such as, completing a flow, or an application activity like validating a token).

browser.name

String

N/A

Read-only

The name of the browser.

browser.version

String

N/A

Read-only

The version of the browser.

createdAt

Date

N/A

Read-only

The time the resource was created.

device.type

String

N/A

Read-only

The type of remote device.

environment.id

String

Required

Immutable

The UUID for the environment.

id

String

Required

Immutable

The UUID for the user session.

lastSignOn.at

String

N/A

Read-only

The last time the user signed on using one or more authenticators.

lastSignOn.remoteIp

String

N/A

Read-only

The IP address of the remote device used during the last sign-on.

locations

Object[ ]

N/A

Read-only

Contains the attributes identifying the user location. Only the last 5 locations are maintained.

location.at

Date

N/A

Read-only

The last time the user signed on.

location.remoteIp

String

N/A

Read-only

The IP address of the remote device used during the last sign-on.

location.city

String

N/A

Read-only

The city resolved from the IP address.

location.state

String

N/A

Read-only

The state resolved from the IP address.

location.region

String

N/A

Read-only

The region resolved from the IP address.

location.country

String

N/A

Read-only

The country resolved from the IP address.

operatingSystem.name

String

N/A

Read-only

The name of the operating system.

operatingSystem.version

String

N/A

Read-only

The operating system version.

user.id

String

Required

Immutable

The UUID for the user.

Response codes

Code Message

200

Successful operation.

201

Successfully created.

204

Successfully removed. No content.

400

The request could not be completed.

401

You do not have access to this resource.

403

You do not have permissions or are not licensed to make this request.

404

The requested resource was not found.