---
title: "Create a New Batch Credential Binding Job"
method: POST
path: "/v1/tenants/{tenant_id}/realms/{realm_id}/batch-credential-binding-jobs"
tags: ["Credential Binding Jobs"]
---

# Create a New Batch Credential Binding Job

`POST /v1/tenants/{tenant_id}/realms/{realm_id}/batch-credential-binding-jobs`

## Request

- Base URL: `https://api-us.beyondidentity.com`
- URL: `https://api-us.beyondidentity.com/v1/tenants/{tenant_id}/realms/{realm_id}/batch-credential-binding-jobs`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/docs/v1/tenants/:tenant_id/realms/:realm_id/batch-credential-binding-jobs/post.ts> (a function with typed inputs; its response is checked against the schema)

To create a new batch credential binding job, send a POST request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/batch-credential-binding-jobs`.
Values in the request body for read-only fields will be ignored.
A maximum of 1000 credential binding jobs can be created in a single batch.
Each realm can have up to 1000 credential binding jobs in the batch queue at any given time.

## Path parameters

- `tenant_id` string, required
- `realm_id` string, required

## Request body

- object: Request for CreateBatchCredentialBindingJob.
  - `batch_credential_binding_job` Schema, required (unresolved $ref)

## Response `200`

The response will be a JSON object containing the standard attributes associated with a credential binding job.

- object: A batch credential binding job manages the binding of credentials for multiple identities in a batch operation.
  - `id` string: ID of the batch credential binding job. This is automatically generated on creation. This field is immutable and output-only.
  - `tenant_id` string: ID of the tenant associated with the batch credential binding job. This is automatically set on creation. This field is immutable and output-only.
  - `realm_id` string: ID of the realm associated with the batch credential binding job. This is automatically set on creation. This field is immutable and output-only.
  - `identity_ids` string[], required: The list of identities associated with the batch credential binding job.
  - `state` string: The current state of the batch credential binding job. `RUNNING` indicates that the batch credential binding job is currently running. `FAILED` indicates that the batch credential binding job has failed. `PARTIAL_SUCCESS` indicates that the batch credential binding job has completed with some failures. `SUCCESS` indicates that the batch credential binding job has completed successfully. This field is immutable and output-only.
  - `state_commentary` object: Commentary on the current state of the batch credential binding job. This field provides error information for each identity for which a credential binding job was attempted. This field is immutable and output-only.
    - `errors` object: Per-identity error information. This contains a mapping of identity ID to error context. It will contain any errors encountered while creating an enrollment job for an entity. This field is immutable and output-only.
  - `create_time` string, date-time: Timestamp of when the batch credential binding job was created. This field is immutable and output-only.
  - `update_time` string, date-time: Timestamp of when the batch credential binding job was updated. This field is immutable and output-only.
  - `job_template` object, required: A batch credential binding job template provides a template for the credential binding jobs created via a batch.
    - `post_binding_redirect_uri` string: The URI to which the caller will be redirected after successfully binding a credential to an identity. This field is optional. If not specified, the authenticator will not attempt to redirect to a new location after binding.
    - `authenticator_config` object: Representation of an authenticator configuration. This prescribes how an identity may authenticate themselves with Beyond Identity.
      - `config` union: An object specifying the settings for the supported authenticator type. The Hosted Web authenticator configuration is not supported in this field. It must be created separately and then referenced by its ID in the `authenticator_config_id` field.
        - 0 (unresolved $ref)
        - 2 (unresolved $ref)
    - `authenticator_config_id` string: The ID of the authenticator configuration to be used to build the credential binding job. This field is immutable.
    - `expire_time` string, date-time: A timestamp that represents when the credential binding link associated with the credential binding job will expire. This field is immutable and read-only.

## Other responses

- `401`: Unauthorized.
- `403`: Forbidden.
- `429`: Too many requests. The error details will include the current total number of enrollments in the batch, the maximum allowed queue size, and the amount by which the limit was exceeded.
- `500`: Server error.

## Changes

- **2026-11-06** `42f3cac49392`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/changes/v1/tenants/:tenant_id/realms/:realm_id/batch-credential-binding-jobs/post.md)

---

[API](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api.md) - [All operations](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/llms.txt) - [OpenAPI document](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/revisions/42f3cac49392?raw)