Extend a Session
Changed onCalling this endpoint extends the given session ID. If session.earliest_possible_extend is set it will only extend the session after the specified time has passed.
This endpoint returns per default a 204 No Content response on success. Older Ory Network projects may return a 200 OK response with the session in the body. Returning the session as part of the response will be deprecated in the future and should not be relied upon.
This endpoint ignores consecutive requests to extend the same session and returns a 404 error in those scenarios. This endpoint also returns 404 errors if the session does not exist.
Retrieve the session ID from the /sessions/whoami endpoint / toSession SDK method.
Request
- Base URL/ (relative, and the document was published on a file host, not at the API’s origin)
- URL/admin/sessions/{id}/extend
- AuthAPI key in header Authorization
Path parameters
ID is the session's ID.
Response
session
Example response
{
"tokenized": "tokenized",
"expires_at": "2000-01-23T04:56:07.000+00:00",
"devices": [
{
"location": "location",
"id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"ip_address": "ip_address",
"user_agent": "user_agent"
},
{
"location": "location",
"id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"ip_address": "ip_address",
"user_agent": "user_agent"
}
],
"authentication_methods": [
{
"completed_at": "2000-01-23T04:56:07.000+00:00",
"method": "password",
"provider": "provider",
"organization": "organization",
"aal": "aal0"
},
{
"completed_at": "2000-01-23T04:56:07.000+00:00",
"method": "password",
"provider": "provider",
"organization": "organization",
"aal": "aal0"
}
],
"authenticator_assurance_level": null,
"identity": {
"traits": "",
"credentials": {
"key": {
"updated_at": "2000-01-23T04:56:07.000+00:00",
"identifiers": [
"identifiers",
"identifiers"
],
"created_at": "2000-01-23T04:56:07.000+00:00",
"type": "password",
"config": "{}",
"version": 0
}
},
"state_changed_at": "2000-01-23T04:56:07.000+00:00",
"created_at": "2000-01-23T04:56:07.000+00:00",
"external_id": "external_id",
"recovery_addresses": [
{
"updated_at": "2000-01-23T04:56:07.000+00:00",
"created_at": "2000-01-23T04:56:07.000+00:00",
"id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"value": "value",
"via": "via"
},
{
"updated_at": "2000-01-23T04:56:07.000+00:00",
"created_at": "2000-01-23T04:56:07.000+00:00",
"id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"value": "value",
"via": "via"
}
],
"metadata_admin": "",
"updated_at": "2000-01-23T04:56:07.000+00:00",
"verifiable_addresses": [
{
"updated_at": "2014-01-01T23:28:56.782Z",
"verified_at": "2000-01-23T04:56:07.000+00:00",
"verified": true,
"created_at": "2014-01-01T23:28:56.782Z",
"id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"value": "value",
"status": "status",
"via": "email"
},
{
"updated_at": "2014-01-01T23:28:56.782Z",
"verified_at": "2000-01-23T04:56:07.000+00:00",
"verified": true,
"created_at": "2014-01-01T23:28:56.782Z",
"id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"value": "value",
"status": "status",
"via": "email"
}
],
"organization_id": "organization_id",
"schema_id": "schema_id",
"schema_url": "schema_url",
"id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"state": "active",
"metadata_public": ""
},
"authenticated_at": "2000-01-23T04:56:07.000+00:00",
"active": true,
"id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"issued_at": "2000-01-23T04:56:07.000+00:00"
}Changes
- breaking
the response property
///became optional for the status - warning
added the new
passkeyenum value to the//response property for the response status - warning
added the new
profileenum value to the//response property for the response status - warning
added the new
samlenum value to the//response property for the response status - info
added the optional property
/to the response with the status - info
removed the
v0.6_legacy_sessionenum value from the//response property for the response status
- breaking
- warning
added the new
samlenum value to the///response property for the response status - info
added the success response with the status
- warning