Skip to main content
POST
/
api
/
v1
/
search
/
request_catalog
/
entitlements
SearchEntitlements
package main

import(
	"context"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	"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.RequestCatalogSearch.SearchEntitlements(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.RequestCatalogSearchServiceSearchEntitlementsResponse != nil {
        // handle response
    }
}
{
  "expanded": [
    {
      "@type": "<string>"
    }
  ],
  "list": [
    {
      "appEntitlementUserBindings": [
        {
          "appEntitlementId": "<string>",
          "appId": "<string>",
          "appUserId": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "deletedAt": "2023-11-07T05:31:56Z",
          "deprovisionAt": "2023-11-07T05:31:56Z",
          "grantSources": [
            {
              "appId": "<string>",
              "id": "<string>"
            }
          ]
        }
      ],
      "entitlement": {
        "appEntitlement": {
          "alias": "<string>",
          "appId": "<string>",
          "appResourceId": "<string>",
          "appResourceTypeId": "<string>",
          "certifyPolicyId": "<string>",
          "complianceFrameworkValueIds": [
            "<string>"
          ],
          "createdAt": "2023-11-07T05:31:56Z",
          "defaultValuesApplied": true,
          "deletedAt": "2023-11-07T05:31:56Z",
          "deprovisionerPolicy": {
            "action": {
              "actionName": "<string>",
              "appId": "<string>",
              "connectorId": "<string>",
              "displayName": "<string>"
            },
            "connector": {
              "account": {
                "config": {},
                "connectorId": "<string>",
                "doNotSave": {},
                "saveToVault": {
                  "vaultIds": [
                    "<string>"
                  ]
                },
                "schemaId": "<string>"
              },
              "defaultBehavior": {
                "connectorId": "<string>"
              },
              "deleteAccount": {
                "connectorId": "<string>"
              }
            },
            "delegated": {
              "appId": "<string>",
              "entitlementId": "<string>",
              "implicit": true
            },
            "externalTicket": {
              "appId": "<string>",
              "connectorId": "<string>",
              "externalTicketProvisionerConfigId": "<string>",
              "instructions": "<string>"
            },
            "manual": {
              "instructions": "<string>",
              "userIds": [
                "<string>"
              ]
            },
            "multiStep": {
              "provisionSteps": "<array>"
            },
            "unconfigured": {},
            "webhook": {
              "webhookId": "<string>"
            }
          },
          "description": "<string>",
          "displayName": "<string>",
          "durationGrant": "<string>",
          "durationUnset": {},
          "emergencyGrantEnabled": true,
          "emergencyGrantPolicyId": "<string>",
          "grantCount": "<string>",
          "grantPolicyId": "<string>",
          "id": "<string>",
          "isAutomationEnabled": true,
          "isManuallyManaged": true,
          "matchBatonId": "<string>",
          "overrideAccessRequestsDefaults": true,
          "provisionerPolicy": {
            "action": {
              "actionName": "<string>",
              "appId": "<string>",
              "connectorId": "<string>",
              "displayName": "<string>"
            },
            "connector": {
              "account": {
                "config": {},
                "connectorId": "<string>",
                "doNotSave": {},
                "saveToVault": {
                  "vaultIds": [
                    "<string>"
                  ]
                },
                "schemaId": "<string>"
              },
              "defaultBehavior": {
                "connectorId": "<string>"
              },
              "deleteAccount": {
                "connectorId": "<string>"
              }
            },
            "delegated": {
              "appId": "<string>",
              "entitlementId": "<string>",
              "implicit": true
            },
            "externalTicket": {
              "appId": "<string>",
              "connectorId": "<string>",
              "externalTicketProvisionerConfigId": "<string>",
              "instructions": "<string>"
            },
            "manual": {
              "instructions": "<string>",
              "userIds": [
                "<string>"
              ]
            },
            "multiStep": {
              "provisionSteps": "<array>"
            },
            "unconfigured": {},
            "webhook": {
              "webhookId": "<string>"
            }
          },
          "purpose": "APP_ENTITLEMENT_PURPOSE_VALUE_UNSPECIFIED",
          "requestSchemaId": "<string>",
          "revokePolicyId": "<string>",
          "riskLevelValueId": "<string>",
          "slug": "<string>",
          "sourceConnectorIds": {},
          "systemBuiltin": true,
          "updatedAt": "2023-11-07T05:31:56Z",
          "userEditedMask": "<string>"
        },
        "appPath": "<string>",
        "appResourcePath": "<string>",
        "appResourceTypePath": "<string>"
      }
    }
  ],
  "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 RequestCatalogSearchServiceSearchEntitlementsRequest searches entitlements, but only ones that are available to you through the open catalogs.

​
appDisplayName
string | null

Search entitlements that belong to this app name (exact match).

​
entitlementAlias
string | null

Search for entitlements with this alias (exact match).

​
expandMask
App Entitlement Expand Mask · object

The app entitlement expand mask allows the user to get additional information when getting responses containing app entitlement views.

​
grantedStatus
enum<string> | null

Search entitlements with this granted status for your signed in user.

Available options:
UNSPECIFIED,
ALL,
GRANTED,
NOT_GRANTED
​
includeDeleted
boolean | null

Include deleted entitlements

​
pageSize
integer<int32> | null

The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)

​
pageToken
string | null

The pageToken field.

​
query
string | null

Fuzzy search the display name of resource types.

Response

200 - application/json

The RequestCatalogSearchServiceSearchEntitlementsResponse message contains a list of results and a nextPageToken if applicable.

The RequestCatalogSearchServiceSearchEntitlementsResponse message contains a list of results and a nextPageToken if applicable.

​
expanded
object[] | null

List of serialized related objects.

​
list
App Entitlement With User Bindings · object[] | null

The list of results containing up to X results, where X is the page size defined in the request.

​
nextPageToken
string | null

The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.