Skip to content

Revoke Access Code

POST/web/v1/workspaces/{workspaceId}/institutions/{institutionBizId}/portals/portal-types/{portalType}/access-code/revoke WEB

Revokes the access code for the specified portal type. After revocation, the access code can no longer be used for authentication.

Required Headers

HeaderExample ValueDescription
Content-Typeapplication/jsonRequest content type
Acceptapplication/jsonExpected response type
X-Client-HashClient device fingerprint
Accept-Languageen, zh, zh-Hant, ja, viResponse language (default: en)
AuthorizationBearerJWT access token

Request Parameters

Path Parameters

NameTypeRequiredInDescription
workspaceIdstringRequiredpathWorkspace business ID
institutionBizIdstringRequiredpathInstitution business ID
portalTypeintegerRequiredpathPortal type code (e.g., 10010101=system, 10010102=tenant)

Success Response

Success 200
{
  "code": "2000",
  "message": "SUCCESS",
  "data": null
}

Error Responses

CodeDescription
4010Unauthorized (invalid or missing JWT token)
4040Portal or access code not found

Notes

  • This operation is irreversible. A new access code must be generated after revocation.
  • Both the primary and rotating codes (if any) are revoked.

SlaunchX Internal Documentation