Update directory authentication tenant policy

PUT

/api/admin/tenants/{tenantId}/directory-auth/policy

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/tenants/example/directory-auth/policy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email_code_fallback_mode": "migration_recovery" }'

Updates tenant-level Directory Authentication policy. Campaigns can still explicitly override the fallback mode through the migration campaign API.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

tenantId

required

string

Request Body ^required

Media type application/json

object

email_code_fallback_mode

required

string

Allowed values: migration_recovery directory_unavailable_recovery admin_invitation_only login_method disabled

key

additional properties

Responses

200

Directory authentication tenant policy updated.

Media type application/json

object

Example ^generated

{}

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