Password Retrieval Sessions

Link: https://support.brilliantdirectories.com/support/solutions/articles/12000108137

← Back to API Reference | Getting Started

Password Retrieval Sessions

Password Retrieval Sessions store temporary authentication tokens generated when a member requests a password reset. Each session links a member's user token to a session token that is emailed to the member. When the member clicks the reset link, the session token is validated and then consumed. Sessions are automatically managed by the platform's password recovery workflow.

Model name in URL: password_retrieval_sessions — DB table: password_retrieval_sessions

The Password Retrieval Session Object

FieldTypeDescription
retrieval_session_idintegerUnique session ID (primary key, read-only)
user_tokenstringUnique token identifying the member who requested the password reset (corresponds to the member's user token field); max 255 characters; unique per session required on create
retrieval_session_tokenstringThe secret token included in the password reset email link; validated when the member clicks the link; max 255 characters required on create

List Password Retrieval Sessions

GET /api/v2/password_retrieval_sessions/get

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/password_retrieval_sessions/get?limit=25" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "retrieval_session_id": "1",
      "user_token": "f5945dfe74212cffc1c1be1d5d272bb8",
      "retrieval_session_token": "2b5832c4a459fba50a0476c18c5e3bb2"
    },
    {
      "retrieval_session_id": "2",
      "user_token": "512540730795896b0232ddb0d69a0550",
      "retrieval_session_token": "c22c2583250a87ceb7aa491413de4234"
    }
  ],
  "total": "5",
  "current_page": 1,
  "total_pages": 1
}

Retrieve a Password Retrieval Session

GET /api/v2/password_retrieval_sessions/get/{retrieval_session_id}

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/password_retrieval_sessions/get/1" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "retrieval_session_id": "1",
      "user_token": "f5945dfe74212cffc1c1be1d5d272bb8",
      "retrieval_session_token": "2b5832c4a459fba50a0476c18c5e3bb2"
    }
  ],
  "total": "1",
  "current_page": 1,
  "total_pages": 1
}

Create a Password Retrieval Session

POST /api/v2/password_retrieval_sessions/create

Example Request

Copy
curl -X POST "https://www.yourdomain.com/api/v2/password_retrieval_sessions/create" \
  -H "X-Api-Key: your-api-key-here" \
  -d "user_token=abc123testtoken456def789" \
  -d "retrieval_session_token=xyz987sessiontoken654abc"

Example Response

Copy
{
  "status": "success",
  "message": {
    "retrieval_session_id": "6",
    "user_token": "abc123testtoken456def789",
    "retrieval_session_token": "xyz987sessiontoken654abc"
  }
}

Update a Password Retrieval Session

PUT /api/v2/password_retrieval_sessions/update

Example Request

Copy
curl -X PUT "https://www.yourdomain.com/api/v2/password_retrieval_sessions/update" \
  -H "X-Api-Key: your-api-key-here" \
  -d "retrieval_session_id=6" \
  -d "retrieval_session_token=newtoken789xyz321abc"

Example Response

Copy
{
  "status": "success",
  "message": {
    "retrieval_session_id": "6",
    "user_token": "abc123testtoken456def789",
    "retrieval_session_token": "newtoken789xyz321abc"
  }
}

Delete a Password Retrieval Session

DELETE /api/v2/password_retrieval_sessions/delete

Example Request

Copy
curl -X DELETE "https://www.yourdomain.com/api/v2/password_retrieval_sessions/delete" \
  -H "X-Api-Key: your-api-key-here" \
  -d "retrieval_session_id=6"

Example Response

Copy
{
  "status": "success",
  "message": "password_retrieval_sessions record was deleted"
}