Update

Update modifies an existing access review campaign. Use the update_mask to specify which fields to change.

POST /api/v1/access_review/{id}

Update

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.AccessReview.Update(ctx, operations.C1APIAccessreviewV1AccessReviewServiceUpdateRequest{
        ID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.AccessReviewServiceUpdateResponse != nil {
        // handle response
    }
}

200

{
  "accessReview": {
    "accessReview": {
      "accessReviewTemplateId": "<string>",
      "autoCloseCampaign": true,
      "autoGenerateReport": true,
      "autoResolve": true,
      "autoStartCampaign": true,
      "bindings": {},
      "campaignHealth": {
        "checkedAt": "2023-11-07T05:31:56Z",
        "phantomLockedCount": 123
      },
      "campaignInsights": {
        "markdown": "<string>"
      },
      "closedAt": "2023-11-07T05:31:56Z",
      "columnConfig": {
        "columns": []
      },
      "completionDate": "2023-11-07T05:31:56Z",
      "connectorSourcesFrozenAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdById": "<string>",
      "description": "<string>",
      "displayName": "<string>",
      "exclusionScope": {
        "appUserStatuses": [],
        "appUserTypes": []
      },
      "exemptCertifiedAccessConflicts": true,
      "expectedTicketCount": 123,
      "hasAccuracySupport": true,
      "id": "<string>",
      "inclusionScope": {
        "appUserStatuses": [],
        "appUserTypes": [],
        "managerIds": [
          "<string>"
        ],
        "multiUserProfileAttributes": {},
        "noAccountOwners": true,
        "userIds": [
          "<string>"
        ],
        "userStatuses": []
      },
      "multiApp": {
        "appEntitlementDetails": {},
        "appEntitlements": {}
      },
      "notificationConfig": {
        "sendClose": true,
        "sendKickoff": true,
        "sendReminders": true
      },
      "policyId": "<string>",
      "reviewInstructions": "<string>",
      "scheduledStartDate": "2023-11-07T05:31:56Z",
      "scope": {
        "appUserStatuses": [],
        "appUserTypes": []
      },
      "scopeV2": {
        "accountCelExpression": {
          "expression": "<string>"
        },
        "accountCriteria": {
          "accountTypes": [],
          "appUserStatuses": [],
          "noAccountOwner": true
        },
        "allAccessConflicts": {},
        "allAccounts": {},
        "allGrants": {},
        "allUsers": {},
        "appAccess": {},
        "appSelectionCriteria": {
          "complianceFrameworkAttributeValueIds": [
            "<string>"
          ],
          "riskLevelAttributeValueIds": [
            "<string>"
          ]
        },
        "celExpression": {
          "expression": "<string>"
        },
        "grantsByCriteria": {
          "accessProfileFilter": {
            "excludedAccessProfileIds": [
              "<string>"
            ],
            "includedAccessProfileIds": [
              "<string>"
            ]
          },
          "daysSinceAdded": "<string>",
          "daysSinceLastUsed": "<string>",
          "daysSinceReviewed": "<string>",
          "grantsAddedBetween": {
            "endDate": "2023-11-07T05:31:56Z",
            "startDate": "2023-11-07T05:31:56Z"
          }
        },
        "resourceSelection": {},
        "resourceTypeSelections": {},
        "selectedUsers": {
          "userIds": [
            "<string>"
          ]
        },
        "specificAccessConflicts": {},
        "specificResources": {},
        "userCriteria": {
          "groupAppEntitlementsRef": [
            {
              "appId": "<string>",
              "id": "<string>"
            }
          ],
          "managerUserIds": [
            "<string>"
          ],
          "multiUserProfileAttributes": {},
          "userStatus": []
        }
      },
      "scopingVersion": "<string>",
      "signatureConfig": {
        "meaningOfSignature": "<string>",
        "requireSignature": true,
        "stepUpProviderId": "<string>",
        "tspUrl": "<string>"
      },
      "singleApp": {
        "appId": "<string>"
      },
      "startedAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "usePolicyOverride": true
    },
    "createdByUserPath": "<string>",
    "objectPermissions": {
      "delete": true,
      "edit": true,
      "extra": {},
      "read": true
    },
    "policyPath": "<string>"
  },
  "expanded": [
    {
      "@type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

id · string · required

The unique identifier of this access review campaign.

Body

application/json

The AccessReviewServiceUpdateRequest message.

accessReview · Access Review · object

An access review campaign (also called a certification campaign) that verifies whether users still need their access entitlements.

This message contains a oneof named setup_metadata. Only a single field of the following list may be set at a time:

• singleApp
• multiApp
• bindings

Show child attributes

expandMask · Access Review Expand Mask · object

The AccessReviewExpandMask message.

Show child attributes

updateMask · string | null

Response

200 - application/json

Successful response

The AccessReviewServiceUpdateResponse message.

accessReview · Access Review View · object

The AccessReviewView message.

Show child attributes

expanded · object[] | null

Related objects requested via the expand mask.

Show child attributes