Expire an enrollment (admin or SOC)

PATCH

/api/admin/enrollments/{id}/expire

curl --request PATCH \
  --url https://example.com/api/admin/enrollments/example/expire \
  --header 'Content-Type: application/json' \
  --header 'X-Ssoossh-Key-Secret: <X-Ssoossh-Key-Secret>' \
  --data '{ "reason": "example" }'

Immediately marks an enrollment as expired, preventing future service certificate retrievals. The operation is idempotent.

Authorizations

• sessionCookie

Parameters

Path Parameters

id

required

string

Enrollment ID

Request Body^required

Expiry reason (required)

Media typeapplication/json

Expiry reason (required)

object

reason

required

Reason explains why the enrollment is being expired. Required and server-validated, like the user containment reasons.

string

Example ^generated

{
  "reason": "example"
}

Responses

200

Enrollment expired

Media typeapplication/json

object

key

additional properties

Example ^generated

{
  "additionalProperty": "example"
}

401

Not authenticated

Media typeapplication/json

object

data

Data is always null on an error response.

error

required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string

error_code

required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}

403

Not authorized as admin or SOC

Media typeapplication/json

object

data

Data is always null on an error response.

error

required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string

error_code

required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}

404

Enrollment not found

Media typeapplication/json

object

data

Data is always null on an error response.

error

required

Error is a human-readable message. Branch on the HTTP status rather than this string; it is for humans and logs.

string

error_code

required

ErrorCode is a machine-readable error classifier. One of the error_code constants from internal/apitypes; use this to decide whether to retry or branch on the failure mode.

string

Example

{
  "error": "certificate request \"9f1c…\" not found",
  "error_code": "not_found"
}