Catalisa.Building Blocks

API do IAM

22 endpoints em 8 recursos. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.

Ver a referência detalhada, com corpo de requisição e catálogo de erros →

38 endpoints

Usuários

/iam/api/v1/users11
  • POST/iam/api/v1/usersCria usuárioIAM_USERS_CREATE
  • POST/iam/api/v1/users/loginAutentica e emite par de tokensPública (com rate limit)
  • GET/iam/api/v1/usersLista usuários, paginadoIAM_USERS_READ
  • GET/iam/api/v1/users/:userIdBusca usuárioIAM_USERS_READ
  • PATCH/iam/api/v1/users/:userIdAtualiza usuárioIAM_USERS_UPDATE
  • DELETE/iam/api/v1/users/:userIdExclusão lógicaIAM_USERS_DELETE
  • GET/iam/api/v1/users/:userId/associationsOrganizações e papéis do usuárioIAM_ASSOCIATIONS_READ
  • POST/iam/api/v1/users/login/mfaSegundo passo do login: {challengeToken, code} ou {challengeToken, recoveryCode}Pública, com desafio (rate limit)
  • POST/iam/api/v1/users/login/mfa/enrollCadastro devido no login: devolve secret e otpauthUriPública, com desafio enroll
  • POST/iam/api/v1/users/login/mfa/enroll/confirmPrimeiro código: cadastra, entra e devolve os 10 códigos de recuperação (uma vez)Pública, com desafio enroll
  • POST/iam/api/v1/users/:userId/mfa/resetAdmin remove o fator de **outro** usuário, com {reason} obrigatório; revoga os refresh tokens dele. 202 com pedido quando a organização exige quatro olhosIAM_USERS_UPDATE + mesma organização

Segundo fator do próprio usuário

/iam/api/v1/mfa3
  • GET/iam/api/v1/mfaEstado: enrolled, pending, lockedUntil, recoveryCodesRemainingToken de usuário (não chave de API)
  • POST/iam/api/v1/mfa/totp/enrollCadastro voluntário: secret e otpauthUriToken de usuário
  • POST/iam/api/v1/mfa/totp/confirmPrimeiro código {code}; devolve os códigos de recuperaçãoToken de usuário

Organizações

/iam/api/v1/organizations7
  • POST/iam/api/v1/organizationsCria organizaçãoIAM_ORGANIZATIONS_CREATE
  • GET/iam/api/v1/organizationsLista organizaçõesIAM_ORGANIZATIONS_READ
  • GET/iam/api/v1/organizations/:organizationIdBusca organizaçãoIAM_ORGANIZATIONS_READ
  • PATCH/iam/api/v1/organizations/:organizationIdAtualiza organização (inclui mfaRequired)IAM_ORGANIZATIONS_UPDATE
  • DELETE/iam/api/v1/organizations/:organizationIdExclusão lógicaIAM_ORGANIZATIONS_DELETE
  • POST/iam/api/v1/organizations/:organizationId/client-secretGera ou rotaciona o segredo M2MIAM_ORGANIZATIONS_UPDATE
  • GET/iam/api/v1/organizations/:organizationId/membersLista membros: o vínculo (roleId, roleName) **e a pessoa** — email, status, mfaEnabled e lastLoginAt (última entrada concluída; null = nunca entrou). Nenhum segredoIAM_ASSOCIATIONS_READ

Papéis e permissões

/iam/api/v14
  • GET/iam/api/v1/rolesLista papéisIAM_ROLES_READ
  • GET/iam/api/v1/roles/:roleName/permissionsPermissões de um papelIAM_ROLES_READ
  • GET/iam/api/v1/permissionsPermissões da organização atualIAM_ROLES_READ
  • GET/iam/api/v1/permissions/allVocabulário completo da plataformaIAM_ROLES_READ

Associações

/iam/api/v1/associations2
  • POST/iam/api/v1/associationsVincula usuário a organização com papelIAM_ASSOCIATIONS_CREATE
  • DELETE/iam/api/v1/associationsRemove o vínculoIAM_ASSOCIATIONS_DELETE

Quatro olhos

8
  • GET/iam/api/v1/access-requests?filter[status]=PENDINGPedidos da organização do token (root: filter[organizationId]). status é o efetivo: pendente vencido aparece EXPIREDIAM_ASSOCIATIONS_READ
  • GET/iam/api/v1/access-requests/:requestIdUm pedidoIAM_ASSOCIATIONS_READ
  • POST/iam/api/v1/access-requests/:requestId/approveAprova ({ note? })pessoa; a do tipo (tabela acima)
  • POST/iam/api/v1/access-requests/:requestId/rejectRecusa ({ note? })pessoa; a do tipo
  • POST/iam/api/v1/access-requests/:requestId/cancelDesiste (só quem pediu)autor do pedido
  • GET/iam/api/v1/organizations/:organizationId/access-policy{ approvalRequired, source: 'house_default' \'organization', houseDefault, recommendation, eligibleApprovers, minApprovers, canEnable, canDisableImmediately }
  • PUT/iam/api/v1/organizations/:organizationId/access-policy{ approvalRequired: true \false \
  • POST/api-keys/api/v1/api-keys/from-request/:requestIdResgata a chave aprovada (201 com key, uma vez)autor + API_KEYS_CREATE

OAuth 2.0

/iam/oauth2
  • POST/iam/oauth/tokenclient_credentials ou refresh_tokenPública (com rate limit)
  • POST/iam/oauth/revokeRevoga um refresh tokenPública

Saúde

/iam/health1
  • GET/iam/healthSonda banco, criptografia e round-trip de JWT. 503 se algum falhar.