Remove Campaign Entitlements - C1 documentation

Remove Campaign Entitlements

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/access_review/{access_review_id}/entitlements/remove \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entitlements": [
    {
      "appEntitlementId": "<string>",
      "appId": "<string>"
    }
  ]
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/access_review/{access_review_id}/entitlements/remove"

payload = { "entitlements": [
        {
            "appEntitlementId": "<string>",
            "appId": "<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({entitlements: [{appEntitlementId: '<string>', appId: '<string>'}]})
};

fetch('https://{tenantDomain}.conductor.one/api/v1/access_review/{access_review_id}/entitlements/remove', 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/{access_review_id}/entitlements/remove",
  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([
    'entitlements' => [
        [
                'appEntitlementId' => '<string>',
                'appId' => '<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;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}.conductor.one/api/v1/access_review/{access_review_id}/entitlements/remove"

	payload := strings.NewReader("{\n  \"entitlements\": [\n    {\n      \"appEntitlementId\": \"<string>\",\n      \"appId\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}.conductor.one/api/v1/access_review/{access_review_id}/entitlements/remove")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entitlements\": [\n    {\n      \"appEntitlementId\": \"<string>\",\n      \"appId\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"entitlements\": [\n    {\n      \"appEntitlementId\": \"<string>\",\n      \"appId\": \"<string>\"\n    }\n  ]\n}"

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

{
  "entitlementCount": 123,
  "removedCount": 123
}

POST

/

api

/

v1

/

access_review

/

{access_review_id}

/

entitlements

/

remove

Remove Campaign Entitlements

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/access_review/{access_review_id}/entitlements/remove \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entitlements": [
    {
      "appEntitlementId": "<string>",
      "appId": "<string>"
    }
  ]
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/access_review/{access_review_id}/entitlements/remove"

payload = { "entitlements": [
        {
            "appEntitlementId": "<string>",
            "appId": "<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({entitlements: [{appEntitlementId: '<string>', appId: '<string>'}]})
};

fetch('https://{tenantDomain}.conductor.one/api/v1/access_review/{access_review_id}/entitlements/remove', 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/{access_review_id}/entitlements/remove",
  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([
    'entitlements' => [
        [
                'appEntitlementId' => '<string>',
                'appId' => '<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;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}.conductor.one/api/v1/access_review/{access_review_id}/entitlements/remove"

	payload := strings.NewReader("{\n  \"entitlements\": [\n    {\n      \"appEntitlementId\": \"<string>\",\n      \"appId\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}.conductor.one/api/v1/access_review/{access_review_id}/entitlements/remove")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entitlements\": [\n    {\n      \"appEntitlementId\": \"<string>\",\n      \"appId\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"entitlements\": [\n    {\n      \"appEntitlementId\": \"<string>\",\n      \"appId\": \"<string>\"\n    }\n  ]\n}"

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

{
  "entitlementCount": 123,
  "removedCount": 123
}

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

access_review_id

string

required

The ID of the access review campaign to remove entitlements from.

Body

application/json

The AccessReviewRemoveCampaignEntitlementsRequest message.

entitlements

Access Review Setup Entitlement Input · object[] | null

The entitlements to remove. Entitlements that are not selected are ignored.

Show child attributes

Response

200 - application/json

Successful response

The AccessReviewRemoveCampaignEntitlementsResponse message.

entitlementCount

integer<int32>

The total number of entitlements selected for the campaign after this call.

removedCount

integer<int32>

The number of entitlements from the request that were selected and are now removed.