👥 Usuários

CreateUser

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/createUser

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

emailstringOpcional

passwordstringOpcional

namestringOpcional

profilestringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/createUser

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/createUser HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "email": "[e-mail]",
  "password": "senha123",
  "name": "Nome do Usuário",
  "profile": "user"
}

200

Successful response

GetUserStatus

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/getUserStatus

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Parâmetros de consulta

userIdintegerOpcional

ID do usuário

Example: 1

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/getUserStatus

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/getUserStatus HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

ListUsers

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/listUsers

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Parâmetros de consulta

pageNumberintegerOpcional

Número da página

Example: 1

searchParamstringOpcional

Parâmetro de busca (opcional)

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/listUsers

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/listUsers HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

UpdateUser

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/updateUser

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

userIdnumberOpcional

namestringOpcional

emailstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/updateUser

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/updateUser HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "userId": 1,
  "name": "Nome Atualizado",
  "email": "[e-mail]"
}

200

Successful response