{"swagger":"2.0","info":{"description":"Possui serviços para operar sob os usuários dos sistemas da instituição.","title":"Serviços de Usuário","contact":{"name":"Superintendência de Informática da UFRN - SINFO","url":"http://www.info.ufrn.br","email":"api@info.ufrn.br"}},"host":"api.ufrn.br","basePath":"/usuario/v1","tags":[{"name":"usuarios","description":"Serviço que opera sob os dados de usuários dos sistemas da instituição."}],"paths":{"/usuarios":{"get":{"tags":["usuarios"],"summary":"Retorna os usuários dos sistemas da instituição.","operationId":"buscarUsuariosUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"id-usuario","in":"query","description":"Identificador do usuário","required":true,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"name":"nome","in":"query","description":"Nome do usuário","required":false,"type":"string"},{"name":"cpf-cnpj","in":"query","description":"CPF ou CNPJ do usuário","required":false,"type":"integer","format":"int64"},{"name":"id-unidade","in":"query","description":"Identificador da unidade do usuário","required":false,"type":"integer","format":"int32"},{"name":"login","in":"query","description":"Login do usuário","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"ativo","in":"query","description":"Indica se o usuário está ativo ou não","required":false,"type":"boolean"},{"name":"id-institucional","in":"query","description":"Id ou lista de ids (separados por vírgula) institucionais aos quais os usuários pertençam","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"name":"id-servidor","in":"query","description":"Id ou lista de ids servidores(separados por vírgula)","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"name":"limit","in":"query","description":"limit de rows da requisição","required":false,"type":"integer","format":"int32"},{"name":"offset","in":"query","description":"offset da consulta","required":false,"type":"integer","format":"int32"},{"name":"order-asc","in":"query","description":"Campos de ordenação ASC","required":false,"type":"string"},{"name":"order-desc","in":"query","description":"Campos de ordenação DESC","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/UsuarioDTO"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/usuarios/info":{"get":{"tags":["usuarios"],"summary":"Retorna as informações do usuário logado.","operationId":"buscarUsuarioInfoUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UsuarioDTO"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/usuarios/{id-usuario}":{"get":{"tags":["usuarios"],"summary":"Retorna um usuário pelo seu identificador.","operationId":"buscarUsuarioUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"id-usuario","in":"path","description":"Identificador do usuário","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UsuarioDTO"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/usuarios/{id-usuario}/emails":{"get":{"tags":["usuarios"],"summary":"Retorna todos os e-mails associados a um usuário pelo seu identificador.","operationId":"buscarUsuarioEmailsUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"id-usuario","in":"path","description":"Identificador do usuário","required":true,"type":"integer","format":"int64"},{"name":"ativo","in":"query","description":"Indica se buscará apenas e-mails ativos ou não","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EmailDTO"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}}},"definitions":{"ResponseEntity":{"type":"object","properties":{"body":{"type":"object"},"statusCode":{"type":"string","enum":["100","101","102","103","200","201","202","203","204","205","206","207","208","226","300","301","302","303","304","305","307","308","400","401","402","403","404","405","406","407","408","409","410","411","412","413","414","415","416","417","418","419","420","421","422","423","424","426","428","429","431","500","501","502","503","504","505","506","507","508","509","510","511"]}}},"UsuarioDTO":{"type":"object","required":["ativo","chave-foto","cpf-cnpj","email","id-foto","id-unidade","id-usuario","login","nome-pessoa","url-foto"],"properties":{"ativo":{"type":"boolean","example":false,"description":"Indica se o usuário está ativo ou não."},"chave-foto":{"type":"string","description":"Chave da foto do usuário."},"cpf-cnpj":{"type":"integer","format":"int64","description":"CPF/CNPJ do usuário"},"email":{"type":"string","description":"Email do usuário."},"id-foto":{"type":"integer","format":"int64","description":"Identificador da foto do usuário"},"id-institucional":{"type":"integer","format":"int64","description":"Identificação institucional do usuário"},"id-unidade":{"type":"integer","format":"int32","description":"Identificador da unidade"},"id-usuario":{"type":"integer","format":"int64","description":"Identificador do usuário"},"login":{"type":"string","description":"Login do usuário"},"nome-pessoa":{"type":"string","description":"Nome do usuário"},"url-foto":{"type":"string","description":"Link da foto do usuário"}},"description":"Representa um usuário dos sistemas da instituição."},"EmailDTO":{"type":"object","required":["email","id-usuario","nome-pessoa"],"properties":{"ativo":{"type":"boolean","example":false,"description":"Indica se o e-mail do usuário esta ativo."},"email":{"type":"string","description":"Email do usuário."},"id-usuario":{"type":"integer","format":"int64","description":"Identificador do usuário"},"nome-pessoa":{"type":"string","description":"Nome do usuário"},"principal":{"type":"boolean","example":false,"description":"Indica se o e-mail do usuário foi informado como principal."},"validado":{"type":"boolean","example":false,"description":"Indica se o e-mail do usuário foi validado."}},"description":"Representa um e-mail de usuário dos sistemas da instituição."}}}