Update Session By ID
PUT {{apiPath}}/environments/{{envID}}/sessions/{{sessionID}}
Use PUT {{apiPath}}/environments/{{envID}}/sessions/{{sessionID}} to update an existing, unexpired session. A session token can't be updated by this request, only by Update Session By Session Token.
For complete property descriptions, see Sessions data model.
If user.id isn't specified, the lastSignOn object is null, and any values assigned here are ignored.
Prerequisites
- See Sessions for important overview information.
| Property | Type | Required? |
|---|---|---|
activeAt | Date | Required |
id | String | Required |
idleTimeoutInMinutes | Integer | Optional |
lastSignOn | Object | Required |
lastSignOn.authenticators | String | Required |
lastSignOn.remoteIp | String | Required |
lastSignOn.withAuthenticator | Map | Required |
lastSignOn.withAuthenticator.authenticator | String | Required |
lastSignOn.withAuthenticator.authenticator.at | Date | Required |
lastSignOn.withAuthenticator.authenticator.policy | Object | Required |
lastSignOn.withAuthenticator.authenticator.policy.id | String | Required |
lastSignOn.withAuthenticator.authenticator.policy.type | String | Required |
user.id | String | Optional |
userAgent | String | Required |
Request Body
{"activeAt"=>"{{$isoTimestamp}}", "idleTimeoutInMinutes"=>"72000", "lastSignOn"=>{"authenticators"=>["pwd"], "remoteIp"=>"174.1.62.19", "withAuthenticator"=>{"pwd"=>{"at"=>"2022-08-17T01:21:30.116Z", "policy"=>{"id"=>"{{passwordPolicyID}}", "type"=>"PINGONE"}}}}, "user"=>{"id"=>"{{userID}}"}, "userAgent"=>"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:103.0) Gecko/20100101 Firefox/103.0"}
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/sessions/ee14fe02-6b74-46b3-81f2-2de2a384fa1b"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/07e1ee43-9f56-4254-8cfb-1709b5ea8e24"}},"id":"ee14fe02-6b74-46b3-81f2-2de2a384fa1b","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"user":{"id":"07e1ee43-9f56-4254-8cfb-1709b5ea8e24"},"createdAt":"2022-10-04T17:10:30.531Z","activeAt":"2022-10-04T17:12:19.890Z","idleTimeoutInMinutes":72000,"userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:103.0) Gecko/20100101 Firefox/103.0","browser":{"name":"Firefox","version":"103.0"},"operatingSystem":{"name":"Mac OS X","version":"10.15"},"device":{"type":"Mac"},"locations":[{"at":"2022-08-17T01:21:30.116Z","remoteIp":"174.1.62.19","city":"port coquitlam","state":"british columbia","region":"west coast","country":"canada"},{"at":"2022-08-17T01:21:30.116Z","remoteIp":"174.1.62.19"}],"lastSignOn":{"remoteIp":"174.1.62.19","authenticators":["pwd"],"withAuthenticator":{"pwd":{"policy":{"id":"874d5c7d-5e1c-4e73-b2b5-dfe1453b02f5","type":"PINGONE"},"at":"2022-08-17T01:21:30.116Z"}},"policy":{"id":"874d5c7d-5e1c-4e73-b2b5-dfe1453b02f5","type":"PINGONE"},"at":"2022-08-17T01:21:30.116Z"},"expiresAt":"2022-11-23T17:12:19.890Z"}