For the complete documentation index, see llms.txt. This page is also available as Markdown.

👥 Usuários

CreateUser

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo
emailstringOpcional

Email do usuário

Example: usuario@example.com
passwordstringOpcional

Senha do usuário (mínimo 8 caracteres)

Example: senha123
namestringOpcional

Nome completo do usuário

Example: Nome do Usuário
profilestringOpcional

Perfil do usuário (admin, user)

Example: user
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/createUser
POST /v2/api/external/{apiId}/createUser HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "email": "usuario@example.com",
  "password": "senha123",
  "name": "Nome do Usuário",
  "profile": "user"
}
{}

GetUserStatus

get
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Parâmetros de consulta
userIdintegerOpcional

ID do usuário

Example: 1
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
get/v2/api/external/{apiId}/getUserStatus
GET /v2/api/external/{apiId}/getUserStatus HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}

ListUsers

get
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Parâmetros de consulta
pageNumberintegerOpcional

Número da página

Example: 1
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
get/v2/api/external/{apiId}/listUsers
GET /v2/api/external/{apiId}/listUsers HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}

UpdateUser

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo
userIdintegerOpcional

ID do usuário que será atualizado

Example: 1
namestringOpcional

Nome completo do usuário (opcional)

Example: Nome Atualizado
emailstringOpcional

Email do usuário (opcional)

Example: novoemail@example.com
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/updateUser
POST /v2/api/external/{apiId}/updateUser HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "userId": 1,
  "name": "Nome Atualizado",
  "email": "novoemail@example.com"
}
{}

Atualizado

Isto foi útil?