RXrxfoodapp
partner-admin

Rotate a confidential client's secret

The new client_secret is returned exactly once. overlap_hours keeps the superseded secret working for that long so the partner can deploy without an outage; it defaults to 0 (immediate cutover), which is the correct behaviour when rotating because of a suspected leak.

post/admin/partners/{partner_id}/oauth-clients/{client_pk}/rotate-secret

Request

  • Base URL
    https://api.rxfoodapp.com/api
  • URL
    https://api.rxfoodapp.com/api/admin/partners/{partner_id}/oauth-clients/{client_pk}/rotate-secret
  • Auth
    HTTP bearer

Path parameters

partner_idinteger required
client_pkinteger required

Request body

overlap_hoursnumber

Response

Secret rotated

active_grant_countinteger
allow_refresh_tokenboolean
allowed_scopesstring[]
client_idstring
client_secretstring

Returned once, at creation and at rotation only

client_typestring
created_timestring date-time nullable
display_namestring
has_logoboolean

Whether an RxFood-hosted logo has been uploaded

has_secretboolean
homepage_urlstring nullable
idinteger
is_activeboolean
partner_idinteger
previous_secret_expires_atstring date-time nullable

When the superseded secret stops being accepted

privacy_policy_urlstring nullable
redirect_urisstring[]
require_hospital_membershipboolean
secret_rotated_timestring date-time nullable
updated_timestring date-time nullable

Changes

No recorded changes to this operation across all 19 revisions of this API.