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
    }
}

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.accessReview.update({
    id: "<id>",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/access_review/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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",
    "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>",
    "reviewerAttributeConfig": {
      "bindings": [
        {
          "appId": "<string>",
          "attributeKey": "<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",
    "usePolicyOverride": true
  },
  "expandMask": {
    "paths": [
      "<string>"
    ]
  },
  "updateMask": "<string>"
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/access_review/{id}"

payload = {
    "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",
        "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>",
        "reviewerAttributeConfig": { "bindings": [
                {
                    "appId": "<string>",
                    "attributeKey": "<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",
        "usePolicyOverride": True
    },
    "expandMask": { "paths": ["<string>"] },
    "updateMask": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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',
      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>',
      reviewerAttributeConfig: {bindings: [{appId: '<string>', attributeKey: '<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',
      usePolicyOverride: true
    },
    expandMask: {paths: ['<string>']},
    updateMask: '<string>'
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/access_review/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}.conductor.one/api/v1/access_review/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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',
        '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>',
        'reviewerAttributeConfig' => [
                'bindings' => [
                                [
                                                                'appId' => '<string>',
                                                                'attributeKey' => '<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',
        'usePolicyOverride' => true
    ],
    'expandMask' => [
        'paths' => [
                '<string>'
        ]
    ],
    'updateMask' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}.conductor.one/api/v1/access_review/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accessReview\": {\n    \"accessReviewTemplateId\": \"<string>\",\n    \"autoCloseCampaign\": true,\n    \"autoGenerateReport\": true,\n    \"autoResolve\": true,\n    \"autoStartCampaign\": true,\n    \"bindings\": {},\n    \"campaignHealth\": {\n      \"checkedAt\": \"2023-11-07T05:31:56Z\",\n      \"phantomLockedCount\": 123\n    },\n    \"campaignInsights\": {\n      \"markdown\": \"<string>\"\n    },\n    \"closedAt\": \"2023-11-07T05:31:56Z\",\n    \"columnConfig\": {\n      \"columns\": []\n    },\n    \"completionDate\": \"2023-11-07T05:31:56Z\",\n    \"connectorSourcesFrozenAt\": \"2023-11-07T05:31:56Z\",\n    \"createdById\": \"<string>\",\n    \"description\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"exclusionScope\": {\n      \"appUserStatuses\": [],\n      \"appUserTypes\": []\n    },\n    \"exemptCertifiedAccessConflicts\": true,\n    \"expectedTicketCount\": 123,\n    \"hasAccuracySupport\": true,\n    \"id\": \"<string>\",\n    \"inclusionScope\": {\n      \"appUserStatuses\": [],\n      \"appUserTypes\": [],\n      \"managerIds\": [\n        \"<string>\"\n      ],\n      \"multiUserProfileAttributes\": {},\n      \"noAccountOwners\": true,\n      \"userIds\": [\n        \"<string>\"\n      ],\n      \"userStatuses\": []\n    },\n    \"multiApp\": {\n      \"appEntitlementDetails\": {},\n      \"appEntitlements\": {}\n    },\n    \"notificationConfig\": {\n      \"sendClose\": true,\n      \"sendKickoff\": true,\n      \"sendReminders\": true\n    },\n    \"policyId\": \"<string>\",\n    \"reviewInstructions\": \"<string>\",\n    \"reviewerAttributeConfig\": {\n      \"bindings\": [\n        {\n          \"appId\": \"<string>\",\n          \"attributeKey\": \"<string>\"\n        }\n      ]\n    },\n    \"scheduledStartDate\": \"2023-11-07T05:31:56Z\",\n    \"scope\": {\n      \"appUserStatuses\": [],\n      \"appUserTypes\": []\n    },\n    \"scopeV2\": {\n      \"accountCelExpression\": {\n        \"expression\": \"<string>\"\n      },\n      \"accountCriteria\": {\n        \"accountTypes\": [],\n        \"appUserStatuses\": [],\n        \"noAccountOwner\": true\n      },\n      \"allAccessConflicts\": {},\n      \"allAccounts\": {},\n      \"allGrants\": {},\n      \"allUsers\": {},\n      \"appAccess\": {},\n      \"appSelectionCriteria\": {\n        \"complianceFrameworkAttributeValueIds\": [\n          \"<string>\"\n        ],\n        \"riskLevelAttributeValueIds\": [\n          \"<string>\"\n        ]\n      },\n      \"celExpression\": {\n        \"expression\": \"<string>\"\n      },\n      \"grantsByCriteria\": {\n        \"accessProfileFilter\": {\n          \"excludedAccessProfileIds\": [\n            \"<string>\"\n          ],\n          \"includedAccessProfileIds\": [\n            \"<string>\"\n          ]\n        },\n        \"daysSinceAdded\": \"<string>\",\n        \"daysSinceLastUsed\": \"<string>\",\n        \"daysSinceReviewed\": \"<string>\",\n        \"grantsAddedBetween\": {\n          \"endDate\": \"2023-11-07T05:31:56Z\",\n          \"startDate\": \"2023-11-07T05:31:56Z\"\n        }\n      },\n      \"resourceSelection\": {},\n      \"resourceTypeSelections\": {},\n      \"selectedUsers\": {\n        \"userIds\": [\n          \"<string>\"\n        ]\n      },\n      \"specificAccessConflicts\": {},\n      \"specificResources\": {},\n      \"userCriteria\": {\n        \"groupAppEntitlementsRef\": [\n          {\n            \"appId\": \"<string>\",\n            \"id\": \"<string>\"\n          }\n        ],\n        \"managerUserIds\": [\n          \"<string>\"\n        ],\n        \"multiUserProfileAttributes\": {},\n        \"userStatus\": []\n      }\n    },\n    \"scopingVersion\": \"<string>\",\n    \"signatureConfig\": {\n      \"meaningOfSignature\": \"<string>\",\n      \"requireSignature\": true,\n      \"stepUpProviderId\": \"<string>\",\n      \"tspUrl\": \"<string>\"\n    },\n    \"singleApp\": {\n      \"appId\": \"<string>\"\n    },\n    \"startedAt\": \"2023-11-07T05:31:56Z\",\n    \"usePolicyOverride\": true\n  },\n  \"expandMask\": {\n    \"paths\": [\n      \"<string>\"\n    ]\n  },\n  \"updateMask\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/access_review/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accessReview\": {\n    \"accessReviewTemplateId\": \"<string>\",\n    \"autoCloseCampaign\": true,\n    \"autoGenerateReport\": true,\n    \"autoResolve\": true,\n    \"autoStartCampaign\": true,\n    \"bindings\": {},\n    \"campaignHealth\": {\n      \"checkedAt\": \"2023-11-07T05:31:56Z\",\n      \"phantomLockedCount\": 123\n    },\n    \"campaignInsights\": {\n      \"markdown\": \"<string>\"\n    },\n    \"closedAt\": \"2023-11-07T05:31:56Z\",\n    \"columnConfig\": {\n      \"columns\": []\n    },\n    \"completionDate\": \"2023-11-07T05:31:56Z\",\n    \"connectorSourcesFrozenAt\": \"2023-11-07T05:31:56Z\",\n    \"createdById\": \"<string>\",\n    \"description\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"exclusionScope\": {\n      \"appUserStatuses\": [],\n      \"appUserTypes\": []\n    },\n    \"exemptCertifiedAccessConflicts\": true,\n    \"expectedTicketCount\": 123,\n    \"hasAccuracySupport\": true,\n    \"id\": \"<string>\",\n    \"inclusionScope\": {\n      \"appUserStatuses\": [],\n      \"appUserTypes\": [],\n      \"managerIds\": [\n        \"<string>\"\n      ],\n      \"multiUserProfileAttributes\": {},\n      \"noAccountOwners\": true,\n      \"userIds\": [\n        \"<string>\"\n      ],\n      \"userStatuses\": []\n    },\n    \"multiApp\": {\n      \"appEntitlementDetails\": {},\n      \"appEntitlements\": {}\n    },\n    \"notificationConfig\": {\n      \"sendClose\": true,\n      \"sendKickoff\": true,\n      \"sendReminders\": true\n    },\n    \"policyId\": \"<string>\",\n    \"reviewInstructions\": \"<string>\",\n    \"reviewerAttributeConfig\": {\n      \"bindings\": [\n        {\n          \"appId\": \"<string>\",\n          \"attributeKey\": \"<string>\"\n        }\n      ]\n    },\n    \"scheduledStartDate\": \"2023-11-07T05:31:56Z\",\n    \"scope\": {\n      \"appUserStatuses\": [],\n      \"appUserTypes\": []\n    },\n    \"scopeV2\": {\n      \"accountCelExpression\": {\n        \"expression\": \"<string>\"\n      },\n      \"accountCriteria\": {\n        \"accountTypes\": [],\n        \"appUserStatuses\": [],\n        \"noAccountOwner\": true\n      },\n      \"allAccessConflicts\": {},\n      \"allAccounts\": {},\n      \"allGrants\": {},\n      \"allUsers\": {},\n      \"appAccess\": {},\n      \"appSelectionCriteria\": {\n        \"complianceFrameworkAttributeValueIds\": [\n          \"<string>\"\n        ],\n        \"riskLevelAttributeValueIds\": [\n          \"<string>\"\n        ]\n      },\n      \"celExpression\": {\n        \"expression\": \"<string>\"\n      },\n      \"grantsByCriteria\": {\n        \"accessProfileFilter\": {\n          \"excludedAccessProfileIds\": [\n            \"<string>\"\n          ],\n          \"includedAccessProfileIds\": [\n            \"<string>\"\n          ]\n        },\n        \"daysSinceAdded\": \"<string>\",\n        \"daysSinceLastUsed\": \"<string>\",\n        \"daysSinceReviewed\": \"<string>\",\n        \"grantsAddedBetween\": {\n          \"endDate\": \"2023-11-07T05:31:56Z\",\n          \"startDate\": \"2023-11-07T05:31:56Z\"\n        }\n      },\n      \"resourceSelection\": {},\n      \"resourceTypeSelections\": {},\n      \"selectedUsers\": {\n        \"userIds\": [\n          \"<string>\"\n        ]\n      },\n      \"specificAccessConflicts\": {},\n      \"specificResources\": {},\n      \"userCriteria\": {\n        \"groupAppEntitlementsRef\": [\n          {\n            \"appId\": \"<string>\",\n            \"id\": \"<string>\"\n          }\n        ],\n        \"managerUserIds\": [\n          \"<string>\"\n        ],\n        \"multiUserProfileAttributes\": {},\n        \"userStatus\": []\n      }\n    },\n    \"scopingVersion\": \"<string>\",\n    \"signatureConfig\": {\n      \"meaningOfSignature\": \"<string>\",\n      \"requireSignature\": true,\n      \"stepUpProviderId\": \"<string>\",\n      \"tspUrl\": \"<string>\"\n    },\n    \"singleApp\": {\n      \"appId\": \"<string>\"\n    },\n    \"startedAt\": \"2023-11-07T05:31:56Z\",\n    \"usePolicyOverride\": true\n  },\n  \"expandMask\": {\n    \"paths\": [\n      \"<string>\"\n    ]\n  },\n  \"updateMask\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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>",
      "reviewerAttributeConfig": {
        "bindings": [
          {
            "appId": "<string>",
            "attributeKey": "<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 | null

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 | null

The AccessReviewExpandMask message.

Show child attributes

updateMask · string | null

Response

200 - application/json

Successful response

The AccessReviewServiceUpdateResponse message.

accessReview · Access Review View · object | null

The AccessReviewView message.

Show child attributes

expanded · object[] | null

Related objects requested via the expand mask.

Show child attributes