Get Custom Analysis Result

GetCustomAnalysisResult

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.GetCustomAnalysisResult(ctx, operations.C1APIRoleMiningManagementV1RoleMiningManagementServiceGetCustomAnalysisResultRequest{
        ID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.GetCustomAnalysisResultResponse != 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.getCustomAnalysisResult({
    id: "<id>",
  });

  console.log(result);
}

run();

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/role-mining/custom-analysis/{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/custom-analysis/{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/custom-analysis/{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;
}

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/role-mining/custom-analysis/{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

{
  "appsAnalyzed": 123,
  "clusters": [
    {
      "avgCoverage": 123,
      "avgSimilarity": 123,
      "entitlements": [
        {
          "appDisplayName": "<string>",
          "appId": "<string>",
          "appResourceDisplayName": "<string>",
          "appResourceTypeDisplayName": "<string>",
          "coverage": 123,
          "entitlementDisplayName": "<string>",
          "entitlementId": "<string>",
          "grantedCount": 123,
          "riskLevelValueId": "<string>"
        }
      ],
      "userCount": 123
    }
  ],
  "cohortSize": 123,
  "completedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdByUserId": "<string>",
  "cutoffImpactPoints": [
    {
      "entitlementCount": 123,
      "minimumCoverageBasisPoints": 123,
      "usersWithAllEntitlements": 123
    }
  ],
  "entitlements": [
    {
      "appDisplayName": "<string>",
      "appId": "<string>",
      "appResourceDisplayName": "<string>",
      "appResourceTypeDisplayName": "<string>",
      "coverage": 123,
      "entitlementDisplayName": "<string>",
      "entitlementId": "<string>",
      "grantedCount": 123,
      "riskLevelValueId": "<string>"
    }
  ],
  "errorMessage": "<string>",
  "facetUserCount": 123,
  "facets": [
    {
      "attribute": "<string>",
      "displayName": "<string>",
      "values": [
        {
          "displayName": "<string>",
          "userCount": 123,
          "value": "<string>"
        }
      ]
    }
  ],
  "id": "<string>",
  "profileFilters": [
    {
      "attribute": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "status": "RUN_STATUS_UNSPECIFIED",
  "supersededByResultId": "<string>",
  "terminalReason": "CUSTOM_ANALYSIS_TERMINAL_REASON_UNSPECIFIED",
  "updatedAt": "2023-11-07T05:31:56Z"
}

GET

api

role-mining

custom-analysis

{id}

GetCustomAnalysisResult

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.GetCustomAnalysisResult(ctx, operations.C1APIRoleMiningManagementV1RoleMiningManagementServiceGetCustomAnalysisResultRequest{
        ID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.GetCustomAnalysisResultResponse != 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.getCustomAnalysisResult({
    id: "<id>",
  });

  console.log(result);
}

run();

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/role-mining/custom-analysis/{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/custom-analysis/{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/custom-analysis/{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;
}

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/role-mining/custom-analysis/{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

{
  "appsAnalyzed": 123,
  "clusters": [
    {
      "avgCoverage": 123,
      "avgSimilarity": 123,
      "entitlements": [
        {
          "appDisplayName": "<string>",
          "appId": "<string>",
          "appResourceDisplayName": "<string>",
          "appResourceTypeDisplayName": "<string>",
          "coverage": 123,
          "entitlementDisplayName": "<string>",
          "entitlementId": "<string>",
          "grantedCount": 123,
          "riskLevelValueId": "<string>"
        }
      ],
      "userCount": 123
    }
  ],
  "cohortSize": 123,
  "completedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdByUserId": "<string>",
  "cutoffImpactPoints": [
    {
      "entitlementCount": 123,
      "minimumCoverageBasisPoints": 123,
      "usersWithAllEntitlements": 123
    }
  ],
  "entitlements": [
    {
      "appDisplayName": "<string>",
      "appId": "<string>",
      "appResourceDisplayName": "<string>",
      "appResourceTypeDisplayName": "<string>",
      "coverage": 123,
      "entitlementDisplayName": "<string>",
      "entitlementId": "<string>",
      "grantedCount": 123,
      "riskLevelValueId": "<string>"
    }
  ],
  "errorMessage": "<string>",
  "facetUserCount": 123,
  "facets": [
    {
      "attribute": "<string>",
      "displayName": "<string>",
      "values": [
        {
          "displayName": "<string>",
          "userCount": 123,
          "value": "<string>"
        }
      ]
    }
  ],
  "id": "<string>",
  "profileFilters": [
    {
      "attribute": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "status": "RUN_STATUS_UNSPECIFIED",
  "supersededByResultId": "<string>",
  "terminalReason": "CUSTOM_ANALYSIS_TERMINAL_REASON_UNSPECIFIED",
  "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

string

required

The id field.

Response

200 - application/json

Successful response

The GetCustomAnalysisResultResponse message.

appsAnalyzed

integer<int32>

The appsAnalyzed field.

clusters

Entitlement Cluster · object[] | null

Cluster results.

Show child attributes

cohortSize

integer<int32>

The cohortSize field.

completedAt

string<date-time> | null

createdAt

string<date-time> | null

createdByUserId

string

User who created this analysis, empty for legacy results.

cutoffImpactPoints

Entitlement Cutoff Impact Point · object[] | null

Exact holder counts at each distinct inclusive entitlement coverage cutoff.

Show child attributes

entitlements

Cohort Entitlement · object[] | null

Entitlement coverage results.

Show child attributes

errorMessage

string

The errorMessage field.

facetUserCount

integer<int32>

The facetUserCount field.

facets

Attribute Facet · object[] | null

Facet results.

Show child attributes

string

The id field.

profileFilters

Profile Filter · object[] | null

Cohort filters this analysis ran with, echoed back so an exact-ID restore is self-contained.

Show child attributes

status

enum<string>

The status field.

Available options:

RUN_STATUS_UNSPECIFIED,

RUN_STATUS_RUNNING,

RUN_STATUS_COMPLETED,

RUN_STATUS_FAILED

supersededByResultId

string

Newer result that superseded this analysis, when applicable.

terminalReason

enum<string>

Structured terminal reason, unspecified for legacy results.

Available options:

CUSTOM_ANALYSIS_TERMINAL_REASON_UNSPECIFIED,

CUSTOM_ANALYSIS_TERMINAL_REASON_ERROR,

CUSTOM_ANALYSIS_TERMINAL_REASON_SUPERSEDED

updatedAt

string<date-time> | null

Welcome

Endpoints

Authorizations

Path Parameters

Response