Get Suggestion

Retrieve a single role suggestion by ID, including its cohort filters, entitlements, and confidence score.

GET /api/v1/role-mining/suggestions/{id}

GetSuggestion

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.RoleMiningManagement.GetSuggestion(ctx, operations.C1APIRoleMiningManagementV1RoleMiningManagementServiceGetSuggestionRequest{
        ID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.GetSuggestionResponse != 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.getSuggestion({
    id: "<id>",
  });

  console.log(result);
}

run();

curl --request GET \
  --url https://{tenantDomain}.conductor.one/api/v1/role-mining/suggestions/{id} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}.conductor.one/api/v1/role-mining/suggestions/{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/role-mining/suggestions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

HttpResponse<String> response = Unirest.get("https://{tenantDomain}.conductor.one/api/v1/role-mining/suggestions/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "suggestion": {
    "avgCoverage": 123,
    "cohortFilters": [
      {
        "attribute": "<string>",
        "values": [
          "<string>"
        ]
      }
    ],
    "cohortSize": 123,
    "confidence": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "createdCatalogId": "<string>",
    "description": "<string>",
    "dimensionCount": 123,
    "entitlements": [
      {
        "appDisplayName": "<string>",
        "appId": "<string>",
        "appResourceDisplayName": "<string>",
        "appResourceTypeDisplayName": "<string>",
        "coverage": 123,
        "entitlementDisplayName": "<string>",
        "entitlementId": "<string>",
        "grantedCount": 123,
        "riskLevelValueId": "<string>"
      }
    ],
    "existingProfileMatches": [
      {
        "catalogDisplayName": "<string>",
        "catalogId": "<string>",
        "missingEntitlements": [
          {
            "appDisplayName": "<string>",
            "appId": "<string>",
            "appResourceDisplayName": "<string>",
            "appResourceTypeDisplayName": "<string>",
            "coverage": 123,
            "entitlementDisplayName": "<string>",
            "entitlementId": "<string>",
            "grantedCount": 123,
            "riskLevelValueId": "<string>"
          }
        ],
        "overlapRatio": 123
      }
    ],
    "id": "<string>",
    "insights": [
      "<string>"
    ],
    "lastGeneratedAt": "2023-11-07T05:31:56Z",
    "runId": "<string>",
    "suggestedName": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "usersWithAll": 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

id · string · required

The ID of the role mining suggestion to retrieve.

Response

200 - application/json

Successful response

The GetSuggestionResponse message.

suggestion · Role Mining Management Suggestion · object | null

The RoleMiningManagementSuggestion message.

Show child attributes