コンテンツにスキップ
Authrim

Create a tenant export request

POST
/api/admin/tenant-backups/exports
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/tenant-backups/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "idempotencyKey": "example", "selection": { "settings": true, "users": true, "admin": true, "artifacts": true, "logs": { "audit": true, "other": true, "sensitive": true, "period": 7 } } }'

Requires admin:backups:read, admin:backups:manage, admin:backups:export and a human Admin session with MFA authenticated within five minutes. Selecting sensitive log details also requires admin:backups:sensitive. At least one category must be selected. The server fixes the authenticated tenant, canonical issuer and running product version. The same idempotency key may retry only the same request and actor. Creates a durable operation waiting for its wrapped content key; it does not return a completed artifact.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
idempotencyKey
required
string
/^[A-Za-z0-9_.:-]{1,256}$/
selection
required
object
settings
required
boolean
users
required
boolean
admin
required
boolean
artifacts
required
boolean
logs
required
object
audit
required
boolean
other
required
boolean
sensitive
required
boolean
period
required
One of:
integer
Allowed values: 7 30 90
key
additional properties
key
additional properties
key
additional properties

Responses

Section titled “ Responses ”

201

Section titled “201 ”

The export request exists. Retries return the current operation state.

Media type application/json
object
id
required
string
kind
required
string
Allowed value: export
state
required
string
Allowed values: queued running waiting ready completed failed cancelling cancelled
phase
required
string
revision
required
integer
key
additional properties
Example 
{
  "kind": "export",
  "state": "queued"
}

400

Section titled “400 ”

The request was rejected.

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

403

Section titled “403 ”

The request was rejected.

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

409

Section titled “409 ”

The request was rejected.

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

413

Section titled “413 ”

The request body exceeds 4096 bytes.

503

Section titled “503 ”

Required backup storage, key service, or audit service is unavailable. Missing artifact storage returns backup_storage_unavailable.

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