{
  "opencollection": "1.0.0",
  "info": {
    "name": "Beyond Identity Secure Access Applications Credential Binding Jobs API",
    "version": "1.7.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Credential Binding Jobs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Credential Binding Jobs for an Identity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/identities/:identity_id/credential-binding-jobs",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "name": "realm_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a realm."
              },
              {
                "name": "identity_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for an identity."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of items returned per page. The response will include at most this many results but may include fewer. If this value is omitted, the response will return the default number of results allowed by the method.\n"
              },
              {
                "name": "page_token",
                "value": "",
                "type": "query",
                "description": "Token to retrieve the subsequent page of the previous request. All other parameters to the list endpoint should match the original request that provided this token unless otherwise specified.\n"
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of items to skip. This is the zero-based index of the first result.\n"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To list all credential binding jobs for an identity, send a GET request to\n`/v1/tenants/$TENANT_ID/realms/$REALM_ID/identities/$IDENTITY_ID/credential-binding-jobs`.\n`$IDENTITY_ID` may be a wildcard (`-`) to request all credential binding\njobs across all identities within the realm.\n\nThe response will contain at most 200 items and may contain a page token to\nquery the remaining items. If page size is not specified, the response will\ncontain 20 items. There is no defined ordering of the list of c"
        },
        {
          "info": {
            "name": "Create a New Credential Binding Job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/identities/:identity_id/credential-binding-jobs",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "name": "realm_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a realm."
              },
              {
                "name": "identity_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for an identity."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To create an identity, send a POST request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/identities/$IDENTITY_ID/credential-binding-jobs`. Values in the request body for read-only fields will be ignored.\n"
        },
        {
          "info": {
            "name": "Retrieve an Existing Credential Binding Job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/identities/:identity_id/credential-binding-jobs/:credential_binding_job_id",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "name": "realm_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a realm."
              },
              {
                "name": "identity_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for an identity."
              },
              {
                "name": "credential_binding_job_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a credential binding job."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filter to constrain the response. The response will only include resources matching this filter. Filters follow the SCIM grammar from [RFC-7644 Section 3.4.2.2](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2). Supported filters attributes:\n`state`: the state of the credential binding job.\n`delivery_method`: the delivery method used for the credential binding job.\n"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To retrieve an existing credential binding job, send a GET request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/identities/$IDENTITY_ID/credential-binding-jobs/$CREDENTIAL_BINDING_JOB_ID`.\n"
        },
        {
          "info": {
            "name": "Revocation of an active credential binding job.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/identities/:identity_id/credential-binding-jobs/:credential_binding_job_id:revoke",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "name": "realm_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a realm."
              },
              {
                "name": "identity_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for an identity."
              },
              {
                "name": "credential_binding_job_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a credential binding job."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "To revoke an active credential binding job, send a POST request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/identities/$IDENTITY_ID/credential-binding-jobs/$CREDENTIAL_BINDING_JOB_ID:revoke`.\nThis endpoint invalidates a pending credential binding job, preventing a credential from being enrolled for the associated identity. If the specified job has already been completed, the revocation attempt will fail.\n"
        },
        {
          "info": {
            "name": "Create a New Batch Credential Binding Job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/batch-credential-binding-jobs",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "name": "realm_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a realm."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To create a new batch credential binding job, send a POST request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/batch-credential-binding-jobs`.\nValues in the request body for read-only fields will be ignored.\nA maximum of 1000 credential binding jobs can be created in a single batch.\nEach realm can have up to 1000 credential binding jobs in the batch queue at any given time.\n"
        },
        {
          "info": {
            "name": "Retrieve an Existing Batch Credential Binding Job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/batch-credential-binding-jobs/:batch_credential_binding_job_id",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "name": "realm_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a realm."
              },
              {
                "name": "batch_credential_binding_job_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a batch credential binding job."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To retrieve an existing batch credential binding job, send a GET request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/identities/$IDENTITY_ID/credential-binding-jobs/batch/$BATCH_CREDENTIAL_BINDING_JOB_ID`.\n"
        },
        {
          "info": {
            "name": "List Results of a Batch Credential Binding Job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-us.beyondidentity.com/v1/tenants/:tenant_id/realms/:realm_id/batch-credential-binding-jobs/:batch_credential_binding_job_id:listResults",
            "params": [
              {
                "name": "tenant_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a tenant."
              },
              {
                "name": "realm_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a realm."
              },
              {
                "name": "batch_credential_binding_job_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a batch credential binding job."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "To list the results of a batch credential binding job, send a GET request to `/v1/tenants/$TENANT_ID/realms/$REALM_ID/batch-credential-binding-jobs/$BATCH_CREDENTIAL_BINDING_JOB_ID:listResults`.\n"
        }
      ]
    }
  ],
  "bundled": true
}