Update SAML application secret

PATCH /api/saml-applications/{id}/secrets/{secretId}
OAuth2

Update the status of a signing certificate.

Path parameters

  • id string Required

    The unique identifier of the saml application.

  • secretId string Required

    The unique identifier of the secret.

application/json

Body Required

  • active boolean Required

    Whether the certificate is active.

Responses

  • 200 application/json

    The signing certificate was updated successfully.

    Hide response attributes Show response attributes object
    • id string Required

      Minimum length is 1, maximum length is 21.

    • certificate string Required

      Minimum length is 1.

    • createdAt number Required
    • expiresAt number Required
    • active boolean Required
    • fingerprints object Required

      Additional properties are allowed.

      Hide fingerprints attribute Show fingerprints attribute object
      • sha256 object Required

        Additional properties are allowed.

        Hide sha256 attributes Show sha256 attributes object
  • 400

    Invalid request body.

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    The SAML application or certificate was not found.

PATCH /api/saml-applications/{id}/secrets/{secretId} 
curl \
 --request PATCH https://[tenant_id].logto.app/api/saml-applications/{id}/secrets/{secretId} \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"active":true}'
Request examples 
{
  "active": true
}
Response examples (200) 
{
  "id": "string",
  "certificate": "string",
  "createdAt": 42.0,
  "expiresAt": 42.0,
  "active": true,
  "fingerprints": {
    "sha256": {
      "formatted": "string",
      "unformatted": "string"
    }
  }
}