---
title: "Extend a Session"
method: PATCH
path: "/admin/sessions/{id}/extend"
tags: ["identity"]
---

# Extend a Session

`PATCH /admin/sessions/{id}/extend`

Calling 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.

Retrieve the session ID from the `/sessions/whoami` endpoint / `toSession` SDK method.

## Path parameters

- `id` string, required

## Response `200`

session

- Session — A Session
  - `active` boolean — Active state. If false the session is no longer active.
  - `authenticated_at` string, date-time — The Session Authentication Timestamp When this session was authenticated at. If multi-factor authentication was used this is the time when the last factor was authenticated (e.g. the TOTP code challenge was completed).
  - `authentication_methods` SessionAuthenticationMethod[] — A list of authenticators which were used to authenticate the session.
    - `aal` 'aal0' | 'aal1' | 'aal2' | 'aal3' — The authenticator assurance level can be one of "aal1", "aal2", or "aal3". A higher number means that it is harder for an attacker to compromise the account. Generally, "aal1" implies that one authentication factor was used while AAL2 implies that two factors (e.g. password + TOTP) have been used. To learn more about these levels please head over to: https://www.ory.sh/kratos/docs/concepts/credentials
    - `completed_at` string, date-time — When the authentication challenge was completed.
    - `method` 'link_recovery' | 'code_recovery' | 'password' | 'code' | 'totp' | 'oidc' | 'webauthn' | 'lookup_secret' | 'v0.6_legacy_session'
    - `organization` string — The Organization id used for authentication
    - `provider` string — OIDC or SAML provider id used for authentication
  - `authenticator_assurance_level` 'aal0' | 'aal1' | 'aal2' | 'aal3' — The authenticator assurance level can be one of "aal1", "aal2", or "aal3". A higher number means that it is harder for an attacker to compromise the account. Generally, "aal1" implies that one authentication factor was used while AAL2 implies that two factors (e.g. password + TOTP) have been used. To learn more about these levels please head over to: https://www.ory.sh/kratos/docs/concepts/credentials
  - `devices` SessionDevice[] — Devices has history of all endpoints where the session was used
    - `id` string, uuid, required — Device record ID
    - `ip_address` string — IPAddress of the client
    - `location` string — Geo Location corresponding to the IP Address
    - `user_agent` string — UserAgent of the client
  - `expires_at` string, date-time — The Session Expiry When this session expires at.
  - `id` string, uuid, required — Session ID
  - `identity` Identity — An [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) represents a (human) user in Ory.
    - `created_at` string, date-time — CreatedAt is a helper struct field for gobuffalo.pop.
    - `credentials` object — Credentials represents all credentials that can be used for authenticating this identity.
    - `id` string, uuid, required — ID is the identity's unique identifier. The Identity ID can not be changed and can not be chosen. This ensures future compatibility and optimization for distributed stores such as CockroachDB.
    - `metadata_admin` unknown
    - `metadata_public` unknown
    - `organization_id` string, uuid4, nullable
    - `recovery_addresses` RecoveryIdentityAddress[] — RecoveryAddresses contains all the addresses that can be used to recover an identity.
      - `created_at` string, date-time — CreatedAt is a helper struct field for gobuffalo.pop.
      - `id` string, uuid, required
      - `updated_at` string, date-time — UpdatedAt is a helper struct field for gobuffalo.pop.
      - `value` string, required
      - `via` string, required
    - `schema_id` string, required — SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.
    - `schema_url` string, required — SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from. format: url
    - `state` 'active' | 'inactive' — State is the identity's state. This value has currently no effect. active StateActive inactive StateInactive
    - `state_changed_at` string, date-time
    - `traits` unknown, required
    - `updated_at` string, date-time — UpdatedAt is a helper struct field for gobuffalo.pop.
    - `verifiable_addresses` VerifiableIdentityAddress[] — VerifiableAddresses contains all the addresses that can be verified by the user.
      - `created_at` string, date-time — When this entry was created
      - `id` string, uuid — The ID
      - `status` string, required — VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema
      - `updated_at` string, date-time — When this entry was last updated
      - `value` string, required — The address value example foo@user.com
      - `verified` boolean, required — Indicates if the address has already been verified
      - `verified_at` string, date-time
      - `via` 'email' | 'sms', required — The delivery method
  - `issued_at` string, date-time — The Session Issuance Timestamp When this session was issued at. Usually equal or close to `authenticated_at`.
  - `tokenized` string — Tokenized is the tokenized (e.g. JWT) version of the session. It is only set when the `tokenize` query parameter was set to a valid tokenize template during calls to `/session/whoami`.

## Other responses

- `400` — errorGeneric
- `404` — errorGeneric
- `default` — errorGeneric

## Changes

- **2024-02-20** `4f071812f3ea` — 1 breaking, 6 warning, 3 info
  - the response property `identity` became optional for the status `200`
  - added the new `code` enum value to the `authentication_methods/items/method` response property for the response status `200`
  - added the new `code` enum value to the `identity/credentials/additionalProperties/type` response property for the response status `200`
  - added the new `code_recovery` enum value to the `identity/credentials/additionalProperties/type` response property for the response status `200`
  - …6 more
- **2023-08-31** `d10e7b267596` — 1 info
  - added the optional property `authentication_methods/items/provider` to the response with the `200` status
- **2022-12-02** `b6e5ffa30d4c` — 7 breaking, 1 warning, 5 info
  - the response property `identity/metadata_admin` became nullable for the status `200`
  - the response property `identity/metadata_public` became nullable for the status `200`
  - the response property `identity/verifiable_addresses/items/id` became optional for the status `200`
  - the `id` response's property type/format changed from `string`/`uuid4` to `string`/`uuid` for status `200`
  - …9 more
- **2022-06-01** `fca041c7721f` — 1 info
  - endpoint added
- **2021-05-05** `381c760af46e` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/ory/apis/ory-identities-api/changes/admin/sessions/:id/extend/patch.md)

---

[API](https://skmtc.dev/ory/apis/ory-identities-api.md) · [All operations](https://skmtc.dev/ory/apis/ory-identities-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ory/ory-identities-api/revisions/4f071812f3ea/schema)