Skip to content
Authrim

Get aggregate metadata batch status.

GET
/api/admin/saml-metadata/batches/{batchId}
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/saml-metadata/batches/example \
  --header 'Authorization: Bearer <token>'

Returns the status, progress counters, and per-entity results for an aggregate SAML metadata batch-create job.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
batchId
required
string

Aggregate metadata batch id.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Aggregate metadata batch creation status.

Media type application/json
object
batchId
required
string
tenantId
required
string
status
required
string
Allowed values: pending running completed failed
total
required
integer
processed
required
integer
succeeded
required
integer
failed
required
integer
startedAt
required
integer
completedAt
integer
results
required
Array<object>
object
entityId
required
string
success
required
boolean
providerId
string
providerType
string
Allowed values: saml_idp saml_sp
name
string
error
string
error
string
Example 
{
  "batchId": "batch_123",
  "tenantId": "tenant_123",
  "status": "running",
  "total": 10,
  "processed": 2,
  "succeeded": 2,
  "failed": 0,
  "startedAt": 1770000000000,
  "results": [
    {
      "entityId": "https://sp.example.com/metadata",
      "success": true,
      "providerId": "saml_provider_123",
      "providerType": "saml_sp",
      "name": "Example SP"
    }
  ]
}