BEbeyondidentity
Binding Jobs

Create a new credential binding job

To create a binding job, send a POST request to /v2/binding-jobs. Values in the request body for read-only attributes get ignored.

post/v2/binding-jobs

Request

Request body

ttl_secondsinteger

Number of seconds until the binding job expires. This must be between 1 minute (60 seconds) and 15 minutes (900 seconds). This field is used only if the expire_time on the requested binding job is unspecified. This field defaults to 1 minute (60 seconds).

Example request

{
  "binding_job": {
    "id": "0fa1df25-af74-41a9-80bb-9e12762657ae",
    "tenant_id": "acme-corp",
    "user_id": "0e3b7222-5c36-4e16-af1f-c0f3be5c57d7",
    "issuer_user_id": "14505aae-4892-4c6c-9341-404b0a027cd1",
    "delivery_method": "SHORT_CODE",
    "state": "PENDING",
    "short_code_delivery_details": {
      "expire_time": "2022-08-12T05:53:07.119Z"
    }
  }
}

Response

The response is a JSON object containing standard group attributes.

idstring

A unique identifier for the binding job that is automatically generated on creation. This field is immutable and read-only.

tenant_idstring

A unique identifier for the tenant that is set automatically on creation. This field is immutable and read-only.

user_idstring

ID of the user to which the credential should be bound.

issuer_user_idstring

ID of the user "issuing" (creating) this binding job. May be the same as user_id, if this binding job was created as part of a self-service flow.

delivery_methodstring

Method by which the binding job is to be delivered to the end user. The only supported method is SHORT_CODE. New methods may be added later. This field is immutable and read-only.

statestring

Indicates the state of the binding job. This field is read-only. Possible values are:

  • PENDING: The binding job is pending.
  • CLAIMED: The short code has been claimed by the end user. This does NOT mean that the binding job was successful, only that the one time short code was claimed.
  • SUCCESS: The binding job was successful.

Example response

{
  "id": "0fa1df25-af74-41a9-80bb-9e12762657ae",
  "tenant_id": "acme-corp",
  "user_id": "0e3b7222-5c36-4e16-af1f-c0f3be5c57d7",
  "issuer_user_id": "14505aae-4892-4c6c-9341-404b0a027cd1",
  "delivery_method": "SHORT_CODE",
  "state": "PENDING",
  "short_code_delivery_details": {
    "expire_time": "2022-08-12T05:53:07.119Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.