---
descriptions:
  password_reset:
    self: >-
      The corresponding [password reset](/reference/authkit/password-reset)
      object.
    object: Distinguishes the password reset object.
    id: The unique ID of the password reset object.
    user_id: The unique ID of the user.
    email: The email address of the user.
    password_reset_token: The token used to reset the password.
    password_reset_url: The URL where the user can reset their password.
    expires_at: The timestamp when the password reset token expires.
    created_at: The timestamp when the password reset token was created.
reference:
  curl:
    - url: /reference/authkit/password-reset
      key: password_reset
      id: password_reset
      title: password_reset
      properties:
        - key: id
          type: string
          description: (password_reset.id)
        - key: user_id
          type: string
          description: (password_reset.user_id)
        - key: email
          type: string
          description: (password_reset.email)
        - key: password_reset_token
          type: string
          description: (password_reset.password_reset_token)
        - key: password_reset_url
          type: string
          description: (password_reset.password_reset_url)
        - key: expires_at
          type: string
          description: (password_reset.expires_at)
        - key: created_at
          type: string
          description: (password_reset.created_at)
  js:
    - url: /reference/authkit/password-reset
      key: PasswordReset
      id: password_reset
      title: interface PasswordReset
      properties:
        - key: object
          type: '"password_reset"'
          description: (password_reset.object)
        - key: id
          type: string
          description: (password_reset.id)
        - key: userId
          type: string
          description: (password_reset.user_id)
        - key: email
          type: string
          description: (password_reset.email)
        - key: passwordResetToken
          type: string
          description: (password_reset.password_reset_token)
        - key: passwordResetUrl
          type: string
          description: (password_reset.password_reset_url)
        - key: expiresAt
          type: string
          description: (password_reset.expires_at)
        - key: createdAt
          type: string
          description: (password_reset.created_at)
  go:
    - url: /reference/authkit/password-reset
      key: PasswordReset
      id: password_reset
      title: usermanagement.PasswordReset
      properties:
        - key: ID
          type: string
          description: (password_reset.id)
        - key: UserId
          type: string
          description: (password_reset.user_id)
        - key: Email
          type: string
          description: (password_reset.email)
        - key: PasswordResetToken
          type: string
          description: (password_reset.password_reset_token)
        - key: PasswordResetUrl
          type: string
          description: (password_reset.password_reset_url)
        - key: ExpiresAt
          type: string
          description: (password_reset.expires_at)
        - key: CreatedAt
          type: string
          description: (password_reset.created_at)
  php:
    - url: /reference/authkit/password-reset
      key: PasswordReset
      id: password_reset
      title: WorkOS\Resource\PasswordReset
      properties:
        - key: object
          type: '"password_reset"'
          description: (password_reset.object)
        - key: id
          type: string
          description: (password_reset.id)
        - key: userId
          type: string
          description: (password_reset.user_id)
        - key: email
          type: string
          description: (password_reset.email)
        - key: passwordResetToken
          type: string
          description: (password_reset.password_reset_token)
        - key: passwordResetUrl
          type: string
          description: (password_reset.password_reset_url)
        - key: expiresAt
          type: string
          description: (password_reset.expires_at)
        - key: createdAt
          type: string
          description: (password_reset.created_at)
  python:
    - url: /reference/authkit/password-reset
      key: PasswordReset
      id: password_reset
      title: PasswordReset
      properties:
        - key: id
          type: str
          description: (password_reset.id)
        - key: user_id
          type: str
          description: (password_reset.user_id)
        - key: email
          type: str
          description: (password_reset.email)
        - key: password_reset_token
          type: str
          description: (password_reset.password_reset_token)
        - key: password_reset_url
          type: str
          description: (password_reset.password_reset_url)
        - key: expires_at
          type: str
          description: (password_reset.expires_at)
        - key: created_at
          type: str
          description: (password_reset.created_at)
  ruby:
    - url: /reference/authkit/password-reset
      key: PasswordReset
      id: password_reset
      title: class PasswordReset
      properties:
        - key: id
          type: String
          description: (password_reset.id)
        - key: user_id
          type: String
          description: (password_reset.user_id)
        - key: email
          type: String
          description: (password_reset.email)
        - key: password_reset_token
          type: String
          description: (password_reset.password_reset_token)
        - key: password_reset_url
          type: String
          description: (password_reset.password_reset_url)
        - key: expires_at
          type: String
          description: (password_reset.expires_at)
        - key: created_at
          type: String
          description: (password_reset.created_at)
  java:
    - url: /reference/authkit/password-reset
      key: PasswordReset
      id: password_reset
      title: class PasswordReset
      properties:
        - key: id
          type: String
          description: (password_reset.id)
        - key: userId
          type: String
          description: (password_reset.user_id)
        - key: email
          type: String
          description: (password_reset.email)
        - key: expiresAt
          type: String
          description: (password_reset.expires_at)
        - key: passwordResetToken
          type: String
          description: (password_reset.password_reset_token)
        - key: passwordResetUrl
          type: String
          description: (password_reset.password_reset_url)
        - key: createdAt
          type: String
          description: (password_reset.created_at)
originalPath: >-
  .tmp-workos-clone/packages/docs/content/reference/authkit/password-reset/index.mdx
---

# Password reset

Create a password reset token for a user and reset the user's password.

> When a user’s password is reset, all of their active sessions are revoked.

<CodeBlock
  title="Example Password reset"
  referenceId="password_reset"
  file="password-reset"
/>
