Search

Search role mining suggestions by name, description, or cohort filter values with optional state and type filters.

POST /api/v1/search/role-mining/suggestions

Search

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.RoleMiningManagementSearch.Search(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.RoleMiningSearchSuggestionsResponse != nil {
        // handle response
    }
}

200

{
  "list": [
    {
      "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
    }
  ],
  "nextPageToken": "<string>"
}

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 RoleMiningSearchSuggestionsRequest message.

cohortTypes · string[] | null

Filter by cohort type (e.g. "department", "job_title", "manager").

matchTypes · enum<string>[] | null

Filter by match type against existing access profiles.

Available options: ACCESS_PROFILE_MATCH_TYPE_UNSPECIFIED, ACCESS_PROFILE_MATCH_TYPE_EXACT, ACCESS_PROFILE_MATCH_TYPE_SUPERSET, ACCESS_PROFILE_MATCH_TYPE_PARTIAL

pageSize · integer<int32>

Maximum number of suggestions to return per page.

pageToken · string

Pagination token from a previous response.

query · string

Text search — matches against suggested_name, description, and cohort filter values.

states · enum<string>[] | null

Filter by suggestion state.

Available options: SUGGESTION_STATE_UNSPECIFIED, SUGGESTION_STATE_NEW, SUGGESTION_STATE_DISMISSED, SUGGESTION_STATE_ACCEPTED

Response

200 - application/json

Successful response

The RoleMiningSearchSuggestionsResponse message.

list · Role Mining Management Suggestion · object[] | null

The list of matching role mining suggestions.

Show child attributes

nextPageToken · string

Token to retrieve the next page of results, empty if no more results.