Skip to content

Fundacred - API Renovação (1.1)

Documentação para a API renewal-api

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Infra Fundacred
infra@fundacred.org.br
Languages
Servers
Mock server
https://docs.fundacred.org.br/_mock/renewal-api/openapi/
TST
https://tst-api.fundacred.org.br/auth-server/
HML
https://hml-api.fundacred.org.br/auth-server/
PRD
https://api.fundacred.org.br/auth-server/

Autenticação

Login, Logout e validação de sessão

Operations

Refresh

Renovação de tokens JWT

Operations

Cadastro

Operações relacionadas ao usuário e perfil

Operations

signUp

Request

Cadastro de novo usuário

Bodyapplication/jsonrequired
emailstringrequired
usuariostringrequired
senhastringrequired
nomestringrequired
sobrenomestring
perfisArray of strings
cod_grupo_iesstring
gruposArray of strings
Items Enum"SystemGroupEnum.PORTAL_IES(name=Portal IES)""SystemGroupEnum.PORTAL_ESTUDANTE(name=Portal Estudante)"
curl -i -X POST \
  https://docs.fundacred.org.br/_mock/renewal-api/openapi/signup \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "usuario": "string",
    "senha": "string",
    "nome": "string",
    "sobrenome": "string",
    "perfis": [
      "string"
    ],
    "cod_grupo_ies": "string",
    "grupos": [
      "SystemGroupEnum.PORTAL_IES(name=Portal IES)"
    ]
  }'

Responses

Sucesso criar um novo usuário

Body*/*
idstring
emailstring
usuariostring
regrasArray of strings
atributosobject
gruposArray of strings
ativostring

getUserDetails

Request

Busca dados do usuário pelo id

Path
userIdstringrequired
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/openapi/user/{userId}'

Responses

Sucesso ao retornar dados do usuário

Body*/*
idstring
usernamestring
enabledboolean
emailVerifiedboolean
firstNamestring
lastNamestring
emailstring

deleteUser

Request

Remove um usuário

Path
userIdstringrequired
curl -i -X DELETE \
  'https://docs.fundacred.org.br/_mock/renewal-api/openapi/user/{userId}'

Responses

Usuário removido com sucesso

Health & Error

Operations