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
    }
}

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
      }
    ],
    "existingProfileMatches": [
      {
        "catalogDisplayName": "<string>",
        "catalogId": "<string>",
        "matchType": "ACCESS_PROFILE_MATCH_TYPE_UNSPECIFIED",
        "missingEntitlements": [
          {
            "appDisplayName": "<string>",
            "appId": "<string>",
            "appResourceDisplayName": "<string>",
            "appResourceTypeDisplayName": "<string>",
            "coverage": 123,
            "entitlementDisplayName": "<string>",
            "entitlementId": "<string>",
            "grantedCount": 123
          }
        ],
        "overlapRatio": 123
      }
    ],
    "id": "<string>",
    "insights": [
      "<string>"
    ],
    "lastGeneratedAt": "2023-11-07T05:31:56Z",
    "runId": "<string>",
    "suggestedName": "<string>",
    "suggestionState": "SUGGESTION_STATE_UNSPECIFIED",
    "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

The RoleMiningManagementSuggestion message.

Show child attributes