Skip to content
Authrim

Get tenant directory connectors

GET
/api/admin/tenants/{tenantId}/directory-connectors
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/tenants/example/directory-connectors \
  --header 'Authorization: Bearer <token>'

Returns Wordwarden Directory Connector configuration for LDAP/AD password verification.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
tenantId
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Directory connector configuration for a tenant.

Media type application/json
object
tenantId
required
string
enabled
required
boolean
default_connector_id
required
string
/^[a-zA-Z0-9_-]{1,64}$/
auto_provision
required
boolean
connectors
required
Array<object>
<= 20 items
object
id
required
string
/^[a-zA-Z0-9_-]{1,64}$/
transport
required

Direct sends HTTPS requests to Wordwarden; relay uses outbound WebSocket registration from Wordwarden to Authrim.

string
Allowed values: direct relay
endpoint_url

Required for direct transport. Omitted or empty for relay transport.

string format: uri
<= 2048 characters
auth_mode
required
string
Allowed values: hmac
connector_id
required

Immutable Wordwarden connector identifier used for protocol, subject links, relay, fleet state, and audit records.

string
/^wwcon_[a-zA-Z0-9]{16}$/
key_id
required
string
>= 1 characters <= 128 characters
secret_ref
required
string
/^(env:(AUTHRIM_WORDWARDEN_|WORDWARDEN_)[A-Z0-9_]+|managed:[a-zA-Z0-9_-]{1,64})$/
timeouts
required
object
request_ms
required
integer
>= 100 <= 30000
key
additional properties
relay
required
object
verify_timeout_ms
required
integer
default: 5000 >= 100 <= 30000
max_pending_requests
required
integer
default: 16 >= 1 <= 256
challenge_ttl_ms
required
integer
default: 30000 >= 5000 <= 300000
auth_failure_rate_limit_per_minute
required
integer
default: 10 >= 1 <= 100
auth_failure_block_ms
required
integer
default: 300000 >= 1000 <= 3600000
secret_rotation_grace_ms
required
integer
default: 300000 <= 86400000
key
additional properties
heartbeat
required
object
key_id
required

Active heartbeat HMAC key identifier. Empty until heartbeat is configured.

string
<= 128 characters
secret_ref
required

Active heartbeat HMAC secret reference. Heartbeat uses a key separate from password verification.

string
/^(|env:(AUTHRIM_WORDWARDEN_|WORDWARDEN_)[A-Z0-9_]+)$/
previous_key_id
required

Previous heartbeat key identifier during rotation.

string
<= 128 characters
previous_secret_ref
required

Previous heartbeat secret reference during rotation.

string
/^(|env:(AUTHRIM_WORDWARDEN_|WORDWARDEN_)[A-Z0-9_]+)$/
interval_ms
required
integer
default: 300000 >= 30000 <= 86400000
stale_after_ms
required
integer
default: 900000 >= 60000 <= 604800000
retention_days
required
integer
default: 14 >= 1 <= 90
version_mismatch_policy
required
string
default: warn
Allowed values: warn block
expected_version
required

Optional exact Wordwarden version expected for this connector. Empty disables exact-version mismatch detection.

string
"" <= 64 characters
minimum_version
required

Optional minimum accepted Wordwarden version. Empty disables minimum-version mismatch detection.

string
"" <= 64 characters
unhealthy_threshold
required
integer
default: 1 >= 1 <= 10
stale_detection_grace_ms
required
integer
0 <= 86400000
key
additional properties
attribute_names
required
Array<string>
<= 32 items
key
additional properties
key
additional properties
Example 
{
  "tenantId": "tenant_123",
  "connectors": [
    {
      "id": "campus",
      "transport": "relay",
      "auth_mode": "hmac",
      "connector_id": "wwcon_8K4M2Q9F7D3H6P1X",
      "key_id": "kid-active",
      "secret_ref": "env:WORDWARDEN_SECRET",
      "timeouts": {
        "request_ms": 2500
      },
      "relay": {
        "verify_timeout_ms": 5000,
        "max_pending_requests": 16,
        "challenge_ttl_ms": 30000,
        "auth_failure_rate_limit_per_minute": 10,
        "auth_failure_block_ms": 300000,
        "secret_rotation_grace_ms": 300000
      },
      "attribute_names": [
        "mail",
        "displayName"
      ]
    }
  ]
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}