- Início
- API Enriched
- Referência da API
- 🔑 API de Autenticação
🔑 API de Autenticação
Gerenciamento de identidade com integração de provedores, políticas de acesso e controle do ciclo de vida de credenciais.
- Categoria: Plataforma
- Complexidade: simples
- Caminhos: 14 | Schemas: 38
- Nível: Standard
- Domínios relacionados:
system,users
Casos de Uso
Seção intitulada “Casos de Uso”- Configurar mecanismos de autenticação
- Gerenciar provedores OIDC e OAuth
- Configurar provisionamento de usuários SCIM
- Gerenciar credenciais de API e acesso
- Configurar políticas de cadastro de contas
Recursos Principais
Seção intitulada “Recursos Principais”- authentication_policy: Política de autenticação para acesso de usuários e API
- token: Token de API para acesso programático
- api_credential: Credencial de API para autenticação de serviços
Endpoints
Seção intitulada “Endpoints”| Método | Caminho | Descrição |
|---|---|---|
| POST | /api/web/namespaces/system/bulk_revoke/api_credentials | Revogar credenciais de API em massa. |
| POST | /api/web/namespaces/system/bulk_revoke/service_credentials | Revogar credencial de serviço em massa. |
| POST | /api/web/namespaces/{namespace}/activate/api_credentials | Ativar credencial de API. |
| POST | /api/web/namespaces/{namespace}/activate/service_credentials | Ativar credencial de serviço de API. |
| GET | /api/web/namespaces/{namespace}/api_credentials | Listar Credenciais de API. |
| POST | /api/web/namespaces/{namespace}/api_credentials | Criar Credenciais de API. |
| GET | /api/web/namespaces/{namespace}/api_credentials/{name} | Obter Credenciais de API. |
| POST | /api/web/namespaces/{namespace}/renew/api_credentials | Renovar credencial de API. |
| POST | /api/web/namespaces/{namespace}/renew/service_credentials | Renovar credencial de serviço de API. |
| POST | /api/web/namespaces/{namespace}/revoke/api_credentials | Revogar credencial de API. |
| POST | /api/web/namespaces/{namespace}/revoke/scim_token | Revogar credencial de API SCIM. |
| POST | /api/web/namespaces/{namespace}/revoke/service_credentials | Revogar credencial de serviço. |
| GET | /api/web/namespaces/{namespace}/scim_token | Obter Token SCIM. |
| POST | /api/web/namespaces/{namespace}/scim_token | Criar/Recriar token de API SCIM. |
| GET | /api/web/namespaces/{namespace}/service_credentials | Listar credenciais de serviço. |
| POST | /api/web/namespaces/{namespace}/service_credentials | Criar credenciais de serviço. |
| GET | /api/web/namespaces/{namespace}/service_credentials/{name} | Obter Credencial de Serviço. |
| PUT | /api/web/namespaces/{namespace}/service_credentials/{name} | Substituir credenciais de serviço. |