SingleSignOn Logout

این وب‌سرویس برای خروج کاربر از Single Sign-On و منقضی کردن Token مربوط به او در سیستم سپهر استفاده می‌شود.

به عنوان مثال، زمانی که کاربر در سایت شما روی دکمه خروج (Logout) کلیک می‌کند، می‌توانید این وب‌سرویس را فراخوانی کنید تا علاوه بر خروج کاربر از Session سایت شما، Token مربوط به او نیز در سیستم سپهر منقضی شود.

نکته: این وب‌سرویس Session مربوط به کاربر در سایت شما را حذف نمی‌کند. مدیریت و حذف Session داخلی سایت شما باید توسط خود سایت انجام شود.

API Endpoint

POST https://{SupplierWebsiteUrl}/api/IAM/Bot/SingleSignOn/Logout/V1

Request Parameters

Token

string

required

Token مربوط به کاربر که در فرآیند Single Sign-On پس از احراز هویت موفق کاربر در سپهر ایجاد و به callbackUrl سایت شما ارسال شده است.

با ارسال این Token، سیستم سپهر آن را منقضی کرده و Session/اعتبار مربوط به آن را در سمت سپهر خاتمه می‌دهد.

Sample Request

curl -X POST https://SepehrApiTest.ir/api/IAM/Bot/SingleSignOn/Logout/V1 \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip, deflate" \
  -d '{
  "Token": "1tyGPflYdMFQSrwmgwBFLevxrmsehYhqnlTIVER2"
}'

Response

در صورت موفقیت‌آمیز بودن عملیات، این وب‌سرویس با HTTP Status Code زیر پاسخ می‌دهد:

204 No Content

پاسخ این وب‌سرویس فاقد Body است.

Recommended Logout Flow

پیشنهاد می‌شود هنگام خروج کاربر از سایت، مراحل زیر انجام شود:

User
 │
 │ Click Logout
 ▼
Your Website
 │
 ├── Remove local session
 │
 └── POST Logout
          │
          │ Token
          ▼
      Sepehr API
          │
          ▼
     Token Invalidated

خلاصه فرآیند

کاربر در سایت شما روی Logout کلیک می‌کند.
Session مربوط به کاربر در سایت شما منقضی یا حذف می‌شود.
وب‌سرویس Logout با ارسال Token کاربر فراخوانی می‌شود.
سیستم سپهر Token را منقضی می‌کند.
در صورت موفقیت، پاسخ 204 No Content دریافت می‌شود.

نکته: بهتر است Logout در سایت شما مستقل از موفقیت یا عدم موفقیت درخواست به سرویس سپهر، Session داخلی کاربر را خاتمه دهد.