identity
- GET /tenants/{id}/ldap-config
Get a tenant LDAP configuration
Returns the stored LDAP configuration for a tenant without the bind password.
- Parameters:
id (string) – Tenant ID
- Status Codes:
200 OK – LDAP configuration
400 Bad Request – tenant ID missing
404 Not Found – no LDAP configuration for this tenant
500 Internal Server Error – configuration could not be loaded
- Response JSON Object:
ldap_config.base_dn (string)
ldap_config.bind_password_set (boolean)
ldap_config.bind_principal (string)
ldap_config.created_at (string)
ldap_config.custom_user_filter (string)
ldap_config.dial_timeout (integer)
ldap_config.email_attribute (string)
ldap_config.firstname_attribute (string)
ldap_config.group_member_attribute (string)
ldap_config.group_membership_mode (string)
ldap_config.group_object (string)
ldap_config.group_search_base (string)
ldap_config.lastname_attribute (string)
ldap_config.nested_groups (boolean)
ldap_config.page_size (integer)
ldap_config.search_timeout (integer)
ldap_config.server_url (string)
ldap_config.tenant_id (string)
ldap_config.tls_ca_cert (string)
ldap_config.tls_mode (string)
ldap_config.tls_skip_verify (boolean)
ldap_config.updated_at (string)
ldap_config.user_memberof_attribute (string)
ldap_config.user_object (string)
ldap_config.user_search_base (string)
ldap_config.username_attribute (string)
- POST /tenants/{id}/ldap-config
Save a tenant LDAP configuration
Validates the request, checks LDAP connectivity, encrypts the bind password and saves the tenant LDAP configuration; POST is a deprecated alias of PUT.
- Parameters:
id (string) – Tenant ID
- Request JSON Object:
base_dn (string)
bind_password (string) – plaintext; encrypted before storage
bind_principal (string)
custom_user_filter (string)
dial_timeout (integer)
email_attribute (string)
firstname_attribute (string)
group_account_mapping (object)
group_member_attribute (string)
group_membership_mode (string)
group_object (string)
group_resolution_order[] (string)
group_search_base (string)
lastname_attribute (string)
nested_groups (boolean)
page_size (integer)
search_timeout (integer)
server_url (string)
tls_ca_cert (string)
tls_mode (string)
tls_skip_verify (boolean)
use_tls (boolean) – Deprecated - accepted for backward compat; ignored at runtime
user_memberof_attribute (string)
user_object (string)
user_search_base (string)
username_attribute (string)
- Status Codes:
200 OK – success message
400 Bad Request – tenant ID missing, invalid body, required fields missing or invalid custom filter
404 Not Found – tenant not found
500 Internal Server Error – tenant lookup, password encryption or save failed
502 Bad Gateway – LDAP connectivity check failed
- PUT /tenants/{id}/ldap-config
Save a tenant LDAP configuration
Validates the request, checks LDAP connectivity, encrypts the bind password and saves the tenant LDAP configuration; POST is a deprecated alias of PUT.
- Parameters:
id (string) – Tenant ID
- Request JSON Object:
base_dn (string)
bind_password (string) – plaintext; encrypted before storage
bind_principal (string)
custom_user_filter (string)
dial_timeout (integer)
email_attribute (string)
firstname_attribute (string)
group_account_mapping (object)
group_member_attribute (string)
group_membership_mode (string)
group_object (string)
group_resolution_order[] (string)
group_search_base (string)
lastname_attribute (string)
nested_groups (boolean)
page_size (integer)
search_timeout (integer)
server_url (string)
tls_ca_cert (string)
tls_mode (string)
tls_skip_verify (boolean)
use_tls (boolean) – Deprecated - accepted for backward compat; ignored at runtime
user_memberof_attribute (string)
user_object (string)
user_search_base (string)
username_attribute (string)
- Status Codes:
200 OK – success message
400 Bad Request – tenant ID missing, invalid body, required fields missing or invalid custom filter
404 Not Found – tenant not found
500 Internal Server Error – tenant lookup, password encryption or save failed
502 Bad Gateway – LDAP connectivity check failed
- POST /tenants/{id}/ldap-config/test
Test a tenant LDAP connection
Tests LDAP connectivity using the draft config in the body when server_url is set, otherwise the stored config.
- Parameters:
id (string) – Tenant ID
- Request JSON Object:
base_dn (string)
bind_password (string) – plaintext; encrypted before storage
bind_principal (string)
custom_user_filter (string)
dial_timeout (integer)
email_attribute (string)
firstname_attribute (string)
group_account_mapping (object)
group_member_attribute (string)
group_membership_mode (string)
group_object (string)
group_resolution_order[] (string)
group_search_base (string)
lastname_attribute (string)
nested_groups (boolean)
page_size (integer)
search_timeout (integer)
server_url (string)
tls_ca_cert (string)
tls_mode (string)
tls_skip_verify (boolean)
use_tls (boolean) – Deprecated - accepted for backward compat; ignored at runtime
user_memberof_attribute (string)
user_object (string)
user_search_base (string)
username_attribute (string)
- Status Codes:
200 OK – success message
400 Bad Request – tenant ID missing or draft config incomplete
404 Not Found – no stored LDAP configuration for this tenant
500 Internal Server Error – stored configuration could not be loaded or decrypted
502 Bad Gateway – LDAP connection test failed
- GET /tenants/{id}/oidc-config
Get a tenant OIDC configuration
Returns the stored OIDC configuration for a tenant.
- Parameters:
id (string) – Tenant ID
- Status Codes:
200 OK – OIDC configuration
400 Bad Request – tenant ID missing
404 Not Found – no OIDC configuration for this tenant
500 Internal Server Error – configuration could not be loaded
- Response JSON Object:
oidc_config.claim_mappings (string)
oidc_config.client_id (string)
oidc_config.client_secret_set (boolean)
oidc_config.created_at (string)
oidc_config.issuer (string)
oidc_config.prompt_mode (string)
oidc_config.redirect_uri (string)
oidc_config.scopes (string)
oidc_config.tenant_id (string)
oidc_config.updated_at (string)
- PUT /tenants/{id}/oidc-config
Save a tenant OIDC configuration
Validates issuer, redirect URI and claim mappings, encrypts the client secret and saves the tenant OIDC configuration.
- Parameters:
id (string) – Tenant ID
- Request JSON Object:
claim_mappings (string) – JSON: {“username”:”preferred_username”,…}
client_id (string) – (required)
client_secret (string) – required on create; omit on update to keep stored value
issuer (string) – (required)
prompt_mode (string) – PromptMode: nil = keep existing (or default “login” for new); “” = no prompt; “login” = force re-auth.
redirect_uri (string) – (required)
scopes (string) – space-separated; default “openid profile email”
- Status Codes:
200 OK – success message
400 Bad Request – tenant ID missing, invalid body, invalid URL, missing client secret or invalid claim mappings
404 Not Found – tenant not found
500 Internal Server Error – tenant lookup, secret encryption or save failed
- GET /tenants/{id}/oidc-config/registration-info
Get OIDC registration info (callback + post-logout redirect URIs)
- Parameters:
id (string) – Tenant ID
- Status Codes:
200 OK – OK
- POST /tenants/{id}/oidc-config/test
Validate a draft or stored tenant OIDC config without saving
- Parameters:
id (string) – Tenant ID
- Status Codes:
200 OK – OK
- GET /tenants/{id}/saml-config
Get a tenant SAML configuration
Returns the stored SAML SP configuration for a tenant.
- Parameters:
id (string) – Tenant ID
- Status Codes:
200 OK – SAML configuration
400 Bad Request – tenant ID missing
404 Not Found – no SAML configuration for this tenant
500 Internal Server Error – configuration could not be loaded
- Response JSON Object:
saml_config.allow_idp_initiated (boolean)
saml_config.attribute_mappings (string)
saml_config.created_at (string)
saml_config.entity_id (string)
saml_config.force_authn (boolean)
saml_config.idp_cert (string)
saml_config.idp_cert_not_after (string) – IdPCertNotAfter is the earliest IdP signing-cert expiry (RFC3339, UTC) parsed from the manual idp_cert or the metadata certs, so the UI can warn before an expiry silently breaks SAML logins. Empty when no cert could be parsed.
saml_config.idp_entity_id (string)
saml_config.idp_metadata_set (boolean)
saml_config.idp_metadata_url (string)
saml_config.idp_metadata_xml (string)
saml_config.nameid_format (string)
saml_config.slo_url (string)
saml_config.sp_cert (string)
saml_config.sso_url (string)
saml_config.tenant_id (string)
saml_config.updated_at (string)
- PUT /tenants/{id}/saml-config
Save a tenant SAML configuration
Saves the tenant SAML SP configuration, generating an SP key pair when none is stored.
- Parameters:
id (string) – Tenant ID
- Request JSON Object:
allow_idp_initiated (boolean) – nil = keep existing (or default false for new configs)
attribute_mappings (string) – JSON: {“username”:”uid”,…}
entity_id (string) – (required)
force_authn (boolean) – nil = keep existing (or default false for new configs)
idp_cert (string)
idp_entity_id (string) – required in manual mode; must match the IdP’s real issuer, no default
idp_metadata_url (string) – metadata document fetched server-side (SSRF-guarded)
idp_metadata_xml (string) – raw metadata document, pasted by the admin
nameid_format (string)
slo_url (string)
sso_url (string)
- Status Codes:
200 OK – saved SAML configuration
400 Bad Request – tenant ID missing or invalid body
404 Not Found – tenant not found
500 Internal Server Error – tenant lookup, key generation or save failed
- Response JSON Object:
saml_config.allow_idp_initiated (boolean)
saml_config.attribute_mappings (string)
saml_config.created_at (string)
saml_config.entity_id (string)
saml_config.force_authn (boolean)
saml_config.idp_cert (string)
saml_config.idp_cert_not_after (string) – IdPCertNotAfter is the earliest IdP signing-cert expiry (RFC3339, UTC) parsed from the manual idp_cert or the metadata certs, so the UI can warn before an expiry silently breaks SAML logins. Empty when no cert could be parsed.
saml_config.idp_entity_id (string)
saml_config.idp_metadata_set (boolean)
saml_config.idp_metadata_url (string)
saml_config.idp_metadata_xml (string)
saml_config.nameid_format (string)
saml_config.slo_url (string)
saml_config.sp_cert (string)
saml_config.sso_url (string)
saml_config.tenant_id (string)
saml_config.updated_at (string)
- POST /tenants/{id}/saml-config/test
Validate a draft or stored tenant SAML config without saving
- Parameters:
id (string) – Tenant ID
- Status Codes:
200 OK – OK