Skip to main content
POST
Deactivate an API client
Deactivation is permanent; to restore access, create a new API client. Your API client must have access to every organization the deactivated API client can act on. Answers the API client as it is after the change, with status DEACTIVATED. The secret is never returned.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

appClientId
string<uuid>
required

ID of the API client to deactivate: its id, not its clientId.

Format: UUID

Response

Successful response

An API client: a machine credential for calling Portão 3 APIs.

id
string<uuid>
required

ID of the API client. Use it to deactivate the client.

Example:

"43230779-2cfb-4525-a40c-77fbf15e68f0"

clientId
string
required

Public identifier of the API client. Send it, with the client secret, to POST /auth/sign-in to get an access token.

Example:

"prod-client-v2"

description
string
required

Display name of the API client.

Example:

"ERP Integration"

realm
string<uuid>
required

ID of the realm the API client belongs to.

Example:

"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"

organizations
object[]
required

Organizations the API client can act on.

status
enum<string>
required

ACTIVE clients can authenticate. DEACTIVATED clients can no longer authenticate; deactivation is permanent.

Available options:
ACTIVE,
DEACTIVATED
Example:

"DEACTIVATED"

createdAt
string<date-time>
required

When the API client was created.

Example:

"2026-10-13T18:43:50.746Z"

updatedAt
string<date-time>
required

When the API client last changed (for example, when it was deactivated).

Example:

"2026-10-20T14:05:12.381Z"

createdBy
string<uuid>
required

ID of the user or API client that created this API client.

Example:

"f1235202-71e0-49ef-a8ba-939b8d3ec945"

updatedBy
string<uuid>
required

ID of the user or API client that last changed this API client.

Example:

"f1235202-71e0-49ef-a8ba-939b8d3ec945"