Certification campaign event payload

Edit online

You can use the following certification campaign event payloads to trigger asynchronous workflows and synchronizations for event notification webhooks and APIs.

The following table lists the attributes that are contained in certification campaign event.

Table 1. Cert campaign attributes
Name Data type Description
data.action String The action performed by a user for the resource.
data.api_grant_type String The grant-type in the JWT.
data.applicationid String Supplemental information to define the target of the action. Used by resources: application, entitlement.
data.applicationname String The application name is the target for the resources: application, entitlement.
data.applications String The applications to be reviewed in the campaign.
data.assignee_id String Specifies the ID of the assignee.
data.assignee_realm String Specifies the realm of the assignee.
data.assignee_type String Specifies whether the assignment is for a user or group.
data.assignee_username String Specifies the name of the assignee.
data.campaign_id String The unique identifier of the campaign.
data.campaign_name String Specifies the campaign name.
data.campaign_type String Specifies whether the campaign is for a user entitlement, group entitlement or account.
data.cause String Specifies the error message.
data.configurationname String Specifies the campaign configuration name.
data.currentstatus String Specifies the state of campaign instance.
data.finerStatus String Specifies Account finer status. It can have one of the following values: authorized, compliant, matched, non-compliant, unauthorized, unmanaged, unmatch, or unmatched.
data.id String Specifies data set record ID.
data.instance_id String The unique identifier of the campaign instance.
data.isreviewerlastactionautomatic Boolean Specifies whether the reviewer last action was automatic.
data.justification String Specifies justification for the assignment.
data.name String Specifies campaign instance name.
data.numberofrecordstoreview String Specifies total number of assignments for review.
data.optionalrev_id String Specifies the optional reviewer for the campaign configuration.
data.owner_id String Specifies the owner for campaign configuration.
data.performedby_id String The user ID that performed the action on the instance.
data.performedby_type String Specifies type of user who has performed action on instance. For example, system, API, or user.
data.resource String Specifies resource for the audit action. For example, campaign, instance, or assignment.
data.reviewer_id String The unique identifier of the reviewer.
data.reviewer_username String Specifies the name of the reviewer.
data.reviewerlastaction String Specifies last operation of the reviewer.
data.reviewerlastactiontime String Specifies time when the last operation performed by the reviewer.
data.target String Specifies the target for the campaign configuration.
data.target_type String Specifies target type for the campaign configuration. It can be entitlement or account.
data.targetid String It can be an account ID or an entitlement IDd depending on the data.target_type.
data.tenant_id Specifies tenant for which campaign configuration created.
data.timeclosed String Specifies time when config instance closed.
data.timestarted String Specifies time when config instance last time started.

Example

The following code is a sample payload. Use the Events APIs to get the actual attributes. See https://docs.verify.ibm.com/verify/reference/getallevents and https://docs.verify.ibm.com/verify/docs/pulling-event-data.

{
    "data": {
      "tenant_id": "tenant name.ibmcloudsecurity.com",
      "performedby_type": "system",
      "targetid": "11111111-1111-1111-1111-111111111111",
      "resource": "assignment",
      "campaign_type": "userassignment",
      "target_type": "entitlement",
      "reviewer_realm": "cloudIdentityRealm",
      "cause": "The assignment has not been processed",
      "isreviewerlastactionautomatic": false,
      "assignee_realm": "cloudIdentityRealm",
      "reviewerlastaction": "none",
      "target": "Basic access",
      "applicationname": "Office 365",
      "campaign_name": "Test 1:1:1 campaign",
      "assignee_type": "user",
      "instance_id": "22222222-2222-2222-2222-222222222222",
      "reviewer_id": "50WNARX3HF",
      "action": "notprocessedatsignoff",
      "id": "33333333-3333-3333-3333-333333333333",
      "applicationid": "4444444444444444444",
      "assignee_username": "testuser-admin",
      "campaign_id": "55555555555555555555555555555555",
      "assignee_id": "6666666666",
      "reviewer_username": "testuser-owner"
    },
    "year": 2023,
    "event_type": "cert_campaign",
    "month": 1,
    "indexed_at": 1674752403007,
    "tenantid": "77777777-7777-7777-7777-777777777777",
    "tenantname": "tenant name.ibmcloudsecurity.com",
    "correlationid": "CORR_ID-88888888-8888-8888-8888-888888888888",
    "servicename": "certmgr",
    "id": "99999999-9999-9999-9999-999999999999",
    "time": 1674752402521,
    "day": 26
  }