Update Role Mining Config

Update the role mining configuration, such as cohort hints, max suggestions, and minimum cohort size.

POST /api/v1/role-mining/config

UpdateRoleMiningConfig

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"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.RoleMiningManagement.UpdateRoleMiningConfig(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.UpdateRoleMiningConfigResponse != 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.roleMiningManagement.updateRoleMiningConfig();

  console.log(result);
}

run();

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/role-mining/config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cohortHints": [
    {
      "attribute": "<string>",
      "priority": 123,
      "values": [
        "<string>"
      ]
    }
  ],
  "maxSuggestions": 123,
  "minCohortSize": 123
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/role-mining/config"

payload = {
    "cohortHints": [
        {
            "attribute": "<string>",
            "priority": 123,
            "values": ["<string>"]
        }
    ],
    "maxSuggestions": 123,
    "minCohortSize": 123
}
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({
    cohortHints: [{attribute: '<string>', priority: 123, values: ['<string>']}],
    maxSuggestions: 123,
    minCohortSize: 123
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/role-mining/config', 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/role-mining/config",
  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([
    'cohortHints' => [
        [
                'attribute' => '<string>',
                'priority' => 123,
                'values' => [
                                '<string>'
                ]
        ]
    ],
    'maxSuggestions' => 123,
    'minCohortSize' => 123
  ]),
  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/role-mining/config")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cohortHints\": [\n    {\n      \"attribute\": \"<string>\",\n      \"priority\": 123,\n      \"values\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"maxSuggestions\": 123,\n  \"minCohortSize\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/role-mining/config")

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  \"cohortHints\": [\n    {\n      \"attribute\": \"<string>\",\n      \"priority\": 123,\n      \"values\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"maxSuggestions\": 123,\n  \"minCohortSize\": 123\n}"

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

200

{
  "config": {
    "cohortHints": [
      {
        "attribute": "<string>",
        "priority": 123,
        "values": [
          "<string>"
        ]
      }
    ],
    "maxSuggestions": 123,
    "minCohortSize": 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.

Body

application/json

The UpdateRoleMiningConfigRequest message.

cohortHints · Cohort Hint Input · object[] | null

Hints that guide the analysis to prioritize specific user attributes and values when forming cohorts.

Show child attributes

maxSuggestions · integer<int32> | null

Maximum number of suggestions the analysis should produce per run.

minCohortSize · integer<int32> | null

Minimum number of users a cohort must contain to generate a suggestion.

Response

200 - application/json

Successful response

The UpdateRoleMiningConfigResponse message.

config · Role Mining Management Config · object | null

The RoleMiningManagementConfig message.

Show child attributes