Jobs

In Cerby, jobs are the automated workflows performed server-side by the Cerby agent either through API requests or interactions on a headless browser. The goal of these jobs is to protect user accounts and manage user access to seat-based and paid social apps. A job object contains information about the type of automation job, the provider, if it can be retried, the user who created the job, the job status, and other relevant attributes.

A job object is created in Cerby when you perform any of the following actions:

• Trigger manually any of the following supported automated tasks for managed accounts through the Cerby web app:

  • Update password

  • Turn on or off multi-factor authentication (MFA)

  • Update email address

  • Update phone number

  • Check MFA status

• Trigger automatically, based on a workspace policy, any of the supported automated tasks for managed accounts.

• Trigger manually any of the following supported automated tasks for business hub integrations through the Cerby web app:

  • Check for updates

  • Add a user

  • Update a user’s role

  • Remove a user

  • Monitor partners

  • Manage partner assets

• Trigger automatically, based on a user deprovisioning event, the automated task to remove a user from an integration.

• Trigger any of the supported automated tasks for integrations through the Cerby API.

With the Cerby API, you can retrieve specific jobs by providing their ID. To learn more about automated jobs or tasks.

Important: You can only retrieve jobs if you have the workspace Admin, Super Admin, or Owner role. Your permissions are determined by your API key based on Cerby’s RBAC system.

Retrieve a job by ID

get

With a GET request to the /jobs/{id} endpoint, you can retrieve the information of a job by providing its ID.

Important: The API scope required to use this endpoint is Read automated jobs.

Path parameters

idstringRequired

The unique identifier of the job.

Responses

200

OK — The requested job JSON object.

application/json

401

Unauthorized - User is not authorized to perform the request.

application/json

404

Not found - Resource not found.

application/json

get

/jobs/{id}

HTTPcURLJavaScriptPython

GET /api/v1/jobs/{id} HTTP/1.1
Host: my-workspace.cerby.com
Accept: */*

{
  "data": {
    "id": "a2c3b0cc-abcd-a09d-abcd-e047ffe91234",
    "type": "job",
    "attributes": {
      "account": {
        "entity": "account",
        "id": "123455cc-abcd-1234-abcd-e047ffe9abcd",
        "name": "Discord",
        "provider": "discord_tenant"
      },
      "canRetry": false,
      "createdAt": "2024-08-29T19:31:21.563000+00:00",
      "createdBy": {
        "id": "abcde0cc-abcd-1234-abcd-e047ffe12345",
        "name": "Joe Doe"
      },
      "errorDetails": {},
      "hasMoreDetails": false,
      "response": {},
      "status": "finished",
      "trigger": "manual",
      "updatedAt": "2024-08-29T19:31:22.750000+00:00",
      "workflowType": "proxy_account_roles_update"
    }
  },
  "links": {
    "self": "/api/v1/jobs/a2c3b0cc-abcd-a09d-abcd-e047ffe91234"
  },
  "meta": {}
}