🔑 Authentication API
Identity management with provider integration, access policies, and credential lifecycle control.
- Category: Platform
- Complexity: simple
- Paths: 14 | Schemas: 38
- Tier: Standard
- Related domains:
system,users
Use Cases
Section titled “Use Cases”- Configure authentication mechanisms
- Manage OIDC and OAuth providers
- Configure SCIM user provisioning
- Manage API credentials and access
- Configure account signup policies
Primary Resources
Section titled “Primary Resources”- authentication_policy: Authentication policy for user and API access
- token: API token for programmatic access
- api_credential: API credential for service authentication
Endpoints
Section titled “Endpoints”| Method | Path | Description |
|---|---|---|
| POST | /api/web/namespaces/system/bulk_revoke/api_credentials | Bulk Revoke API credentials. |
| POST | /api/web/namespaces/system/bulk_revoke/service_credentials | Bulk Revoke service credential. |
| POST | /api/web/namespaces/{namespace}/activate/api_credentials | Activate API credential. |
| POST | /api/web/namespaces/{namespace}/activate/service_credentials | Activate API service credential. |
| GET | /api/web/namespaces/{namespace}/api_credentials | List API Credentials. |
| POST | /api/web/namespaces/{namespace}/api_credentials | Create API Credentials. |
| GET | /api/web/namespaces/{namespace}/api_credentials/{name} | GET API Credentials. |
| POST | /api/web/namespaces/{namespace}/renew/api_credentials | Renew API credential. |
| POST | /api/web/namespaces/{namespace}/renew/service_credentials | Renew API service credential. |
| POST | /api/web/namespaces/{namespace}/revoke/api_credentials | Revoke API credential. |
| POST | /api/web/namespaces/{namespace}/revoke/scim_token | Revoke SCIM API credential. |
| POST | /api/web/namespaces/{namespace}/revoke/service_credentials | Revoke Service credential. |
| GET | /api/web/namespaces/{namespace}/scim_token | GET Scim Token. |
| POST | /api/web/namespaces/{namespace}/scim_token | Create/RE-create SCIM API token. |
| GET | /api/web/namespaces/{namespace}/service_credentials | List service credentials. |
| POST | /api/web/namespaces/{namespace}/service_credentials | Create service credentials. |
| GET | /api/web/namespaces/{namespace}/service_credentials/{name} | GET Service Credential. |
| PUT | /api/web/namespaces/{namespace}/service_credentials/{name} | Replace service credentials. |