Estamos trabalhando nessa nova versão da documentação.
Para visitar a versão antiga: API Pipeimob - Postman.

Revogar credencial

POST

/v1/credentials/revoke

Revoga (remove) a credencial no grupo de usuários (Cognito) do ambiente informado.
Escopo exigido: definido em REQUIRED_SCOPE_CREDENTIALS_REVOKE.

Requisição

Authorization

JWT Bearer

Adicionar o parâmetro

Authorization

a Cabeçalhos

Exemplo:

Authorization: ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Correto

application/json

Successful Response

Body

🟠422Entidade não processável

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v1/credentials/revoke' \
--header 'authorization;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "client_id": "string",
    "ambiente": "producao"
}'

Response Example

200 - Exemplo 1

null

Modificado em 2025-10-20 11:59:10