/v1/auth/methodsDiscover configured authentication methods
operation ID: get_v1_auth_methods
Overview
Discover configured authentication methods. The authentication API establishes identity and manages the roles, grants, sessions, and service credentials used for authorization.
When to use it
- Use it when an application needs to discover configured authentication methods.
- Use it when a client needs to sign in, inspect its identity, or an administrator needs to manage access.
Quick example
Set the base URL and replace generated identifiers or credentials with values from your installation.
cURL
curl --request GET \
--url "$ORDINATE_URL/v1/auth/methods"Expected output · 200
Bounded authentication discovery without provider configuration
Example 200 output
{
"auth_mode": "disabled",
"login_methods": [
"local"
]
}The cURL request supplies the documented path and query values and asks OrdinateDB to discover configured authentication methods. The documented 200 response is bounded authentication discovery without provider configuration.
How it works
OrdinateDB resolves a session or bearer credential to a principal, then evaluates roles, capabilities, and resource scope for each protected operation.
Reference
- Required capability
- anonymous
- Authorization scope
- none
Parameters
No parameters.
Request body
This operation has no request body.
Responses
200Bounded authentication discovery without provider configuration
application/json
auth_modestringrequiredlogin_methodsarrayrequired- unique items
array
stringvalues: local · oidc
Example 200 output
{
"auth_mode": "disabled",
"login_methods": [
"local"
]
}Code examples
These examples are generated from the source contract. Replace the base URL, credentials, identifiers, and minimal generated values for your instance.
JavaScript
const ordinateUrl = "http://localhost:8080";
const token = "<bearer-token>";
const response = await fetch(`${ordinateUrl}/v1/auth/methods`, {
method: "GET"
});
if (!response.ok) {
throw new Error(`OrdinateDB returned ${response.status}: ${await response.text()}`);
}
const data = await response.json();
console.log(data);Related topics
- Authentication guide — Understand the prerequisite concepts and transport behavior for this operation.
- REST endpoint index — Find other operations in Authentication.