Update

Update a recovery policy. Supply the policy object and an update mask listing the fields to change; omitted fields are left as-is.

POST /api/v1/recovery-policies/{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.RecoveryPolicy.Update(ctx, operations.C1APICredentialInventoryV1RecoveryPolicyServiceUpdateRequest{
        ID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.RecoveryPolicyServiceUpdateResponse != nil {
        // handle response
    }
}

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/recovery-policies/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recoveryPolicy": {
    "allowedRecoveryTypes": [],
    "displayName": "<string>",
    "priority": 123,
    "revokeOnRecovery": true
  },
  "updateMask": "<string>"
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/recovery-policies/{id}"

payload = {
    "recoveryPolicy": {
        "allowedRecoveryTypes": [],
        "displayName": "<string>",
        "priority": 123,
        "revokeOnRecovery": True
    },
    "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({
    recoveryPolicy: {
      allowedRecoveryTypes: [],
      displayName: '<string>',
      priority: 123,
      revokeOnRecovery: true
    },
    updateMask: '<string>'
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/recovery-policies/{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/recovery-policies/{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([
    'recoveryPolicy' => [
        'allowedRecoveryTypes' => [
                
        ],
        'displayName' => '<string>',
        'priority' => 123,
        'revokeOnRecovery' => true
    ],
    '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/recovery-policies/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recoveryPolicy\": {\n    \"allowedRecoveryTypes\": [],\n    \"displayName\": \"<string>\",\n    \"priority\": 123,\n    \"revokeOnRecovery\": true\n  },\n  \"updateMask\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/recovery-policies/{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  \"recoveryPolicy\": {\n    \"allowedRecoveryTypes\": [],\n    \"displayName\": \"<string>\",\n    \"priority\": 123,\n    \"revokeOnRecovery\": true\n  },\n  \"updateMask\": \"<string>\"\n}"

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

200

{
  "recoveryPolicy": {
    "allowedRecoveryTypes": [],
    "createdAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "displayName": "<string>",
    "id": "<string>",
    "isBuiltin": true,
    "priority": 123,
    "revokeOnRecovery": true,
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

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 · read-only

Unique identifier for the policy.

Body

application/json

The RecoveryPolicyServiceUpdateRequest message.

recoveryPolicy · Recovery Policy · object | null

RecoveryPolicy defines how users recover access when they lose their credentials.

Show child attributes

updateMask · string | null

Response

200 - application/json

Successful response

The RecoveryPolicyServiceUpdateResponse message.

recoveryPolicy · Recovery Policy · object | null

RecoveryPolicy defines how users recover access when they lose their credentials.

Show child attributes