Update a directory migration campaign

PATCH

/api/admin/tenants/{tenantId}/directory-auth/migration/campaigns/{campaignId}

Code sample: Shell / cURL

curl --request PATCH \
  --url https://auth.example.com/api/admin/tenants/example/directory-auth/migration/campaigns/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Updates campaign policy, status, prompt mode, fallback mode, grace period, or target policy. Tenant-scoped admins need the directory authentication migration write permission.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

tenantId

required

string

campaignId

required

string

Request Body ^required

Media type application/json

object

Example ^generated

{}

Responses

200

Directory migration campaign 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"
}

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