Search App Entitlements For App User

Search for app entitlements associated with a specific app user, with optional resource type trait filtering.

GET /api/v1/search/apps/{app_id}/entitlements/users/{app_user_id}

SearchAppEntitlementsForAppUser

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.AppEntitlementSearch.SearchAppEntitlementsForAppUser(ctx, operations.C1APIAppV1AppEntitlementSearchServiceSearchAppEntitlementsForAppUserRequest{
        AppID: "<id>",
        AppUserID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ListAppEntitlementsResponse != nil {
        // handle response
    }
}

200

{
  "expanded": [
    {
      "@type": "<string>"
    }
  ],
  "list": [
    {
      "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": {
            "assignee": {
              "appOwners": {
                "allowReassignment": true,
                "fallbackUserIds": [
                  "<string>"
                ]
              },
              "entitlementOwners": {
                "allowReassignment": true,
                "fallbackUserIds": [
                  "<string>"
                ]
              },
              "expression": {
                "allowReassignment": true,
                "expressions": [
                  "<string>"
                ],
                "fallbackUserIds": [
                  "<string>"
                ]
              },
              "group": {
                "allowReassignment": true,
                "appGroupId": "<string>",
                "appId": "<string>",
                "fallbackUserIds": [
                  "<string>"
                ]
              },
              "manager": {
                "allowReassignment": true,
                "fallbackUserIds": [
                  "<string>"
                ]
              },
              "users": {
                "allowReassignment": true,
                "userIds": [
                  "<string>"
                ]
              }
            },
            "instructions": "<string>",
            "userIds": [
              "<string>"
            ]
          },
          "multiStep": {
            "provisionSteps": "<array>"
          },
          "unconfigured": {},
          "webhook": {
            "webhookId": "<string>"
          }
        },
        "description": "<string>",
        "displayName": "<string>",
        "durationGrant": "<string>",
        "durationUnset": {},
        "emergencyGrantEnabled": true,
        "emergencyGrantPolicyId": "<string>",
        "externalId": "<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": {
            "assignee": {
              "appOwners": {
                "allowReassignment": true,
                "fallbackUserIds": [
                  "<string>"
                ]
              },
              "entitlementOwners": {
                "allowReassignment": true,
                "fallbackUserIds": [
                  "<string>"
                ]
              },
              "expression": {
                "allowReassignment": true,
                "expressions": [
                  "<string>"
                ],
                "fallbackUserIds": [
                  "<string>"
                ]
              },
              "group": {
                "allowReassignment": true,
                "appGroupId": "<string>",
                "appId": "<string>",
                "fallbackUserIds": [
                  "<string>"
                ]
              },
              "manager": {
                "allowReassignment": true,
                "fallbackUserIds": [
                  "<string>"
                ]
              },
              "users": {
                "allowReassignment": true,
                "userIds": [
                  "<string>"
                ]
              }
            },
            "instructions": "<string>",
            "userIds": [
              "<string>"
            ]
          },
          "multiStep": {
            "provisionSteps": "<array>"
          },
          "unconfigured": {},
          "webhook": {
            "webhookId": "<string>"
          }
        },
        "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>",
      "objectPermissions": {
        "delete": true,
        "edit": true,
        "extra": {},
        "read": true
      }
    }
  ],
  "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.

Path Parameters

app_id · string | null · required

The ID of the app to search entitlements within.

app_user_id · string | null · required

The ID of the app user to search entitlements for.

Query Parameters

page_size · integer<int32> | null

The pageSize field.

page_token · string | null

The pageToken field.

Response

200 - application/json

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

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

expanded · object[] | null

List of related objects

Show child attributes

list · App Entitlement View · object[] | null

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

Show child attributes

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.