Referência da API

👥 Usuários

POST /v2/api/external/{apiId}/createUser

CreateUser

{"openapi":"3.0.3","info":{"title":"Miró Connect One — API Externa","version":"v4.x.x.x"},"tags":[{"name":"👥 Usuários"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Miró Connect One do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Miró Connect One, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Miró Connect One.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/createUser":{"post":{"tags":["👥 Usuários"],"summary":"CreateUser","operationId":"CreateUser","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email do usuário"},"password":{"type":"string","description":"Senha do usuário (mínimo 8 caracteres)"},"name":{"type":"string","description":"Nome completo do usuário"},"profile":{"type":"string","description":"Perfil do usuário (admin, user)"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

GET /v2/api/external/{apiId}/getUserStatus

GetUserStatus

{"openapi":"3.0.3","info":{"title":"Miró Connect One — API Externa","version":"v4.x.x.x"},"tags":[{"name":"👥 Usuários"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Miró Connect One do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Miró Connect One, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Miró Connect One.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/getUserStatus":{"get":{"tags":["👥 Usuários"],"summary":"GetUserStatus","operationId":"GetUserStatus","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"userId","in":"query","required":false,"description":"ID do usuário","schema":{"type":"integer"}}],"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

GET /v2/api/external/{apiId}/listUsers

ListUsers

{"openapi":"3.0.3","info":{"title":"Miró Connect One — API Externa","version":"v4.x.x.x"},"tags":[{"name":"👥 Usuários"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Miró Connect One do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Miró Connect One, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Miró Connect One.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/listUsers":{"get":{"tags":["👥 Usuários"],"summary":"ListUsers","operationId":"ListUsers","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"pageNumber","in":"query","required":false,"description":"Número da página","schema":{"type":"integer"}}],"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

POST /v2/api/external/{apiId}/updateUser

UpdateUser

{"openapi":"3.0.3","info":{"title":"Miró Connect One — API Externa","version":"v4.x.x.x"},"tags":[{"name":"👥 Usuários"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Miró Connect One do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Miró Connect One, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do tenant (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Miró Connect One.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/updateUser":{"post":{"tags":["👥 Usuários"],"summary":"UpdateUser","operationId":"UpdateUser","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"integer","description":"ID do usuário que será atualizado"},"name":{"type":"string","description":"Nome completo do usuário (opcional)"},"email":{"type":"string","description":"Email do usuário (opcional)"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}