BEbeyondidentity
Credential Binding Jobs

Create a New Batch Credential Binding Job

Changed on

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.

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

Request

Path parameters

tenant_idstring required
Example:000176d94fd7b4d1

A unique identifier for a tenant.

realm_idstring required
Example:19a95130480dfa79

A unique identifier for a realm.

Request body

batch_credential_binding_jobSchema required(unresolved $ref)

Response

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

idstring

ID of the batch credential binding job. This is automatically generated on creation. This field is immutable and output-only.

tenant_idstring

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_idstring

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_idsstring[] required

The list of identities associated with the batch credential binding job.

statestring

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.

create_timestring date-time

Timestamp of when the batch credential binding job was created. This field is immutable and output-only.

update_timestring date-time

Timestamp of when the batch credential binding job was updated. This field is immutable and output-only.

Changes