GET /users/reset-password
Bearer auth

request OTP code to change password

Query parameters

  • sendMethode string

    SMS or EMAIL

  • email string

Responses

  • 200

    OK

    Hide headers attributes Show headers attributes
    • Cross-Origin-Embedder-Policy string
    • Cross-Origin-Opener-Policy string
    • Cross-Origin-Resource-Policy string
    • Origin-Agent-Cluster string
    • Referrer-Policy string
    • Strict-Transport-Security string
    • X-Content-Type-Options string
    • X-DNS-Prefetch-Control string
    • X-Download-Options string
    • X-Frame-Options string
    • X-Permitted-Cross-Domain-Policies string
    • X-XSS-Protection integer
    • Access-Control-Allow-Origin string
    • Access-Control-Allow-Credentials boolean
    • Retry-After number
    • X-RateLimit-Limit integer
    • X-RateLimit-Remaining integer
    • X-RateLimit-Reset string
    • x-powered-by string
    • Content-Type string
    • Content-Length integer
    • ETag string
    • Date string
    • Connection string
    • Keep-Alive string
  • 400

    Bad Request

    Hide headers attributes Show headers attributes
    • Cross-Origin-Embedder-Policy string
    • Cross-Origin-Opener-Policy string
    • Cross-Origin-Resource-Policy string
    • Origin-Agent-Cluster string
    • Referrer-Policy string
    • Strict-Transport-Security string
    • X-Content-Type-Options string
    • X-DNS-Prefetch-Control string
    • X-Download-Options string
    • X-Frame-Options string
    • X-Permitted-Cross-Domain-Policies string
    • X-XSS-Protection integer
    • Access-Control-Allow-Origin string
    • Access-Control-Allow-Credentials boolean
    • Retry-After number
    • X-RateLimit-Limit integer
    • X-RateLimit-Remaining integer
    • X-RateLimit-Reset string
    • x-powered-by string
    • Content-Type string
    • Content-Length integer
    • ETag string
    • Date string
    • Connection string
    • Keep-Alive string
GET /users/reset-password 
curl \
 -X GET swift.croissant-rouge.org.tn/api/v1/users/reset-password \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
# Headers
Cross-Origin-Embedder-Policy: require-corp
Cross-Origin-Opener-Policy: same-origin
Cross-Origin-Resource-Policy: same-origin
Origin-Agent-Cluster: ?1
Referrer-Policy: no-referrer
Strict-Transport-Security: max-age=15552000; includeSubDomains
X-Content-Type-Options: nosniff
X-DNS-Prefetch-Control: off
X-Download-Options: noopen
X-Frame-Options: SAMEORIGIN
X-Permitted-Cross-Domain-Policies: none
X-XSS-Protection: 0
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Retry-After: 76.566
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 89
X-RateLimit-Reset: Sun Oct 29 2023 14:47:36 GMT+0100 (Central European Standard Time)
x-powered-by: TUNISIAN RED CRESSCENT
Content-Type: application/json; charset=utf-8
Content-Length: 146
ETag: W/"92-34cintec0K/4cKiF/Vy9p7KWey0"
Date: Sun, 29 Oct 2023 13:46:35 GMT
Connection: keep-alive
Keep-Alive: timeout=5

# Payload
{
  "code": 200,
  "message": {
    "RESPONSE_TEXT": "Vous recevrez le code TOTP si un utilisateur est trouvé.",
    "RESPONSE_CODE": "RESET_PASSWORD_SENT_MESSAGE"
  }
}
Response examples (200) 
# Headers
Cross-Origin-Embedder-Policy: require-corp
Cross-Origin-Opener-Policy: same-origin
Cross-Origin-Resource-Policy: same-origin
Origin-Agent-Cluster: ?1
Referrer-Policy: no-referrer
Strict-Transport-Security: max-age=15552000; includeSubDomains
X-Content-Type-Options: nosniff
X-DNS-Prefetch-Control: off
X-Download-Options: noopen
X-Frame-Options: SAMEORIGIN
X-Permitted-Cross-Domain-Policies: none
X-XSS-Protection: 0
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Retry-After: 76.566
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 89
X-RateLimit-Reset: Sun Oct 29 2023 14:47:36 GMT+0100 (Central European Standard Time)
x-powered-by: TUNISIAN RED CRESSCENT
Content-Type: application/json; charset=utf-8
Content-Length: 146
ETag: W/"92-34cintec0K/4cKiF/Vy9p7KWey0"
Date: Sun, 29 Oct 2023 13:46:35 GMT
Connection: keep-alive
Keep-Alive: timeout=5

# Payload
{}
Response examples (400) 
# Headers
Cross-Origin-Embedder-Policy: require-corp
Cross-Origin-Opener-Policy: same-origin
Cross-Origin-Resource-Policy: same-origin
Origin-Agent-Cluster: ?1
Referrer-Policy: no-referrer
Strict-Transport-Security: max-age=15552000; includeSubDomains
X-Content-Type-Options: nosniff
X-DNS-Prefetch-Control: off
X-Download-Options: noopen
X-Frame-Options: SAMEORIGIN
X-Permitted-Cross-Domain-Policies: none
X-XSS-Protection: 0
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Retry-After: 565.825
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 98
X-RateLimit-Reset: Mon Oct 30 2023 02:46:38 GMT+0100 (Central European Standard Time)
x-powered-by: TUNISIAN RED CRESSCENT
Content-Type: application/json; charset=utf-8
Content-Length: 161
ETag: W/"a1-rghxaUPHQQbNPuuZBo6agHtFD6U"
Date: Mon, 30 Oct 2023 01:37:12 GMT
Connection: keep-alive
Keep-Alive: timeout=5

# Payload
{
  "code": 400,
  "message": {
    "RESPONSE_TEXT": "Oups! Il semblerait que l'identifiant de l'utilisateur fourni est incorrect.",
    "RESPONSE_CODE": "UNVALID_USER_ID_MESSAGE"
  }
}
Response examples (400) 
# Headers
Cross-Origin-Embedder-Policy: require-corp
Cross-Origin-Opener-Policy: same-origin
Cross-Origin-Resource-Policy: same-origin
Origin-Agent-Cluster: ?1
Referrer-Policy: no-referrer
Strict-Transport-Security: max-age=15552000; includeSubDomains
X-Content-Type-Options: nosniff
X-DNS-Prefetch-Control: off
X-Download-Options: noopen
X-Frame-Options: SAMEORIGIN
X-Permitted-Cross-Domain-Policies: none
X-XSS-Protection: 0
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Retry-After: 565.825
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 98
X-RateLimit-Reset: Mon Oct 30 2023 02:46:38 GMT+0100 (Central European Standard Time)
x-powered-by: TUNISIAN RED CRESSCENT
Content-Type: application/json; charset=utf-8
Content-Length: 161
ETag: W/"a1-rghxaUPHQQbNPuuZBo6agHtFD6U"
Date: Mon, 30 Oct 2023 01:37:12 GMT
Connection: keep-alive
Keep-Alive: timeout=5

# Payload
{}