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

Criar credencial M2M

POST

/v1/credentials/create

Cria uma credencial (ID + secret) no grupo de usuários (Cognito) do ambiente informado e retorna {client_id, client_secret}.
Os escopos enviados são qualificados com o servidor de recursos (ex.: 'ms-api/api.read').
Escopo exigido: definido em REQUIRED_SCOPE_CREDENTIALS_CREATE (se configurado).

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/create' \
--header 'authorization;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ambiente": "producao",
    "nome": "cred-integracao-x",
    "scopes": [
        "agencias.read",
        "admin.logs.read"
    ]
}'

Response Example

200 - Exemplo 1

null

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