Skip to content
Authrim

Start aggregate metadata batch create.

POST
/api/admin/saml-metadata/previews/{previewId}/batch-create
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/saml-metadata/previews/example/batch-create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "entityIds": [ "https://idp.example.com/metadata" ], "providerType": "saml_idp", "enabled": true }'

Starts an asynchronous provider creation job from selected EntityDescriptor entries in an aggregate metadata preview. When enabled is false and identityMapping is omitted, mixed IdP and SP selections are registered as disabled providers so each provider can be mapped and enabled later.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
previewId
required
string

Aggregate metadata preview id.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
entityIds
required
Array<string>
providerType
string
Allowed values: saml_idp saml_sp
samlProfile
string
attributePresetId
string
identityMapping
object
fieldMappingSetId
required
string
fieldMappingVersionId
string
destinationNamespace
string
destinationFieldPolicies

Per-SP release mode for every attribute in the active SAML Destination Profile.

object
key
additional properties
string
Allowed values: required optional hidden
key
additional properties
enabled

Defaults to true. Set false to register selected entities without identityMapping for later per-provider setup; this deferred-setup mode also accepts mixed IdP and SP selections.

boolean
Example 
{
  "entityIds": [
    "https://idp.example.com/metadata"
  ],
  "providerType": "saml_idp",
  "enabled": true
}

Responses

Section titled “ Responses ”

202

Section titled “202 ”

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

400

Section titled “400 ”

The selected entities, provider role, Mapping Set, enabled-state requirement, or per-SP destination field policy is invalid. No asynchronous batch is started.

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