Update

Update usage controls for an app.

POST /api/v1/apps/{app_id}/usage_controls

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.AppUsageControls.Update(ctx, operations.C1APIAppV1AppUsageControlsServiceUpdateRequest{
        AppID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.UpdateAppUsageControlsResponse != 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.appUsageControls.update({
    appId: "<id>",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/usage_controls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appUsageControls": {
    "appId": "<string>",
    "notify": true,
    "notifyAfterDays": 123,
    "revoke": true,
    "revokeAfterDays": 123
  },
  "updateMask": "<string>"
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/usage_controls"

payload = {
    "appUsageControls": {
        "appId": "<string>",
        "notify": True,
        "notifyAfterDays": 123,
        "revoke": True,
        "revokeAfterDays": 123
    },
    "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({
    appUsageControls: {
      appId: '<string>',
      notify: true,
      notifyAfterDays: 123,
      revoke: true,
      revokeAfterDays: 123
    },
    updateMask: '<string>'
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/usage_controls', 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/apps/{app_id}/usage_controls",
  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([
    'appUsageControls' => [
        'appId' => '<string>',
        'notify' => true,
        'notifyAfterDays' => 123,
        'revoke' => true,
        'revokeAfterDays' => 123
    ],
    '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/apps/{app_id}/usage_controls")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"appUsageControls\": {\n    \"appId\": \"<string>\",\n    \"notify\": true,\n    \"notifyAfterDays\": 123,\n    \"revoke\": true,\n    \"revokeAfterDays\": 123\n  },\n  \"updateMask\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/usage_controls")

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  \"appUsageControls\": {\n    \"appId\": \"<string>\",\n    \"notify\": true,\n    \"notifyAfterDays\": 123,\n    \"revoke\": true,\n    \"revokeAfterDays\": 123\n  },\n  \"updateMask\": \"<string>\"\n}"

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

200

{
  "appUsageControls": {
    "appId": "<string>",
    "notify": true,
    "notifyAfterDays": 123,
    "revoke": true,
    "revokeAfterDays": 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

app_id · string · required

The app that this object belongs to.

Body

application/json

The UpdateAppUsageControlsRequest message contains the AppUsageControls object to update and the update mask.

appUsageControls · App Usage Controls · object | null

The AppUsageControls object describes some peripheral configuration for an app.

Show child attributes

updateMask · string | null

Response

200 - application/json

The UpdateAppUsageControlsResponse message contains the updated AppUsageControls object.

The UpdateAppUsageControlsResponse message contains the updated AppUsageControls object.

appUsageControls · App Usage Controls · object | null

The AppUsageControls object describes some peripheral configuration for an app.

Show child attributes