Rotate a directory connector secret

POST

/api/admin/tenants/{tenantId}/directory-connectors/{connectorId}/secret/rotate

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/tenants/example/directory-connectors/example/secret/rotate \
  --header 'Authorization: Bearer <token>'

Rotates the Authrim-managed Wordwarden relay secret and keeps the previous secret usable during the connector rotation grace period.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

tenantId

required

string

connectorId

required

string

Responses

200

One-time directory connector secret response.

Media type application/json

object

connector_id

required

string

key_id

required

string

secret_ref

required

string

/^managed:[a-zA-Z0-9_-]{1,64}$/

secret

required

One-time secret value for Wordwarden. Authrim does not expose this value again.

string

/^wwsec_[A-Za-z0-9_-]+$/

previous_retire_after

One of:

string

string format: date-time

null

null

one_time_display

required

boolean

key

additional properties

Example

{
  "connector_id": "campus",
  "key_id": "kid_qd71R-9bG5n4FOhb",
  "secret_ref": "managed:campus",
  "secret": "wwsec_YfQagNc3ulbPvgG9v7HHBJVZLrQKZhbyQbsM7jXKxgY",
  "previous_retire_after": "2026-06-23T12:05:00.000Z",
  "one_time_display": true
}

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

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

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"
}

404

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"
}