Skip to main content
POST
/
api
/
v1
/
search
/
apps
Search
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.AppSearch.Search(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.SearchAppsResponse != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}
{
  "list": [
    {
      "appAccountId": "<string>",
      "appAccountName": "<string>",
      "appOwners": [
        {
          "createdAt": "2023-11-07T05:31:56Z",
          "delegatedUserId": "<string>",
          "deletedAt": "2023-11-07T05:31:56Z",
          "department": "<string>",
          "departmentSources": [
            {
              "appId": "<string>",
              "appUserId": "<string>",
              "appUserProfileAttributeKey": "<string>",
              "userAttributeMappingId": "<string>",
              "value": "<string>"
            }
          ],
          "directoryIds": [
            "<string>"
          ],
          "directoryStatus": "UNKNOWN",
          "directoryStatusSources": [
            {
              "appId": "<string>",
              "appUserId": "<string>",
              "appUserProfileAttributeKey": "<string>",
              "userAttributeMappingId": "<string>",
              "value": "<string>"
            }
          ],
          "displayName": "<string>",
          "email": "<string>",
          "emailSources": [
            {
              "appId": "<string>",
              "appUserId": "<string>",
              "appUserProfileAttributeKey": "<string>",
              "userAttributeMappingId": "<string>",
              "value": "<string>"
            }
          ],
          "emails": [
            "<string>"
          ],
          "employeeIdSources": [
            {
              "appId": "<string>",
              "appUserId": "<string>",
              "appUserProfileAttributeKey": "<string>",
              "userAttributeMappingId": "<string>",
              "value": "<string>"
            }
          ],
          "employeeIds": [
            "<string>"
          ],
          "employmentStatus": "<string>",
          "employmentStatusSources": [
            {
              "appId": "<string>",
              "appUserId": "<string>",
              "appUserProfileAttributeKey": "<string>",
              "userAttributeMappingId": "<string>",
              "value": "<string>"
            }
          ],
          "employmentType": "<string>",
          "employmentTypeSources": [
            {
              "appId": "<string>",
              "appUserId": "<string>",
              "appUserProfileAttributeKey": "<string>",
              "userAttributeMappingId": "<string>",
              "value": "<string>"
            }
          ],
          "id": "<string>",
          "jobTitle": "<string>",
          "jobTitleSources": [
            {
              "appId": "<string>",
              "appUserId": "<string>",
              "appUserProfileAttributeKey": "<string>",
              "userAttributeMappingId": "<string>",
              "value": "<string>"
            }
          ],
          "managerIds": [
            "<string>"
          ],
          "managerSources": [
            {
              "appId": "<string>",
              "appUserId": "<string>",
              "appUserProfileAttributeKey": "<string>",
              "userAttributeMappingId": "<string>",
              "value": "<string>"
            }
          ],
          "profile": {},
          "roleIds": [
            "<string>"
          ],
          "status": "UNKNOWN",
          "type": "USER_TYPE_UNSPECIFIED",
          "updatedAt": "2023-11-07T05:31:56Z",
          "username": "<string>",
          "usernameSources": [
            {
              "appId": "<string>",
              "appUserId": "<string>",
              "appUserProfileAttributeKey": "<string>",
              "userAttributeMappingId": "<string>",
              "value": "<string>"
            }
          ],
          "usernames": [
            "<string>"
          ]
        }
      ],
      "certifyPolicyId": "<string>",
      "connectorVersion": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "defaultRequestCatalogId": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "displayName": "<string>",
      "fieldMask": "<string>",
      "grantPolicyId": "<string>",
      "iconUrl": "<string>",
      "id": "<string>",
      "identityMatching": "APP_USER_IDENTITY_MATCHING_UNSPECIFIED",
      "instructions": "<string>",
      "isDirectory": true,
      "isManuallyManaged": true,
      "logoUri": "<string>",
      "monthlyCostUsd": 123,
      "parentAppId": "<string>",
      "revokePolicyId": "<string>",
      "strictAccessEntitlementProvisioning": true,
      "updatedAt": "2023-11-07T05:31:56Z",
      "userCount": "<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

Search Apps by a few properties.

​
appIds
string[] | null

A list of app IDs to restrict the search to.

​
displayName
string

Search for apps with a case insensitive match on the display name.

​
excludeAppIds
string[] | null

A list of app IDs to remove from the results.

​
onlyDirectories
boolean

Only return apps which are directories

​
pageSize
integer<int32>

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

The pageToken field.

​
policyRefs
Policy Ref · object[] | null

Search for apps that use any of these policies.

​
query
string

Query the apps with a fuzzy search on display name and description.

Response

200 - application/json

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

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

​
list
App · object[] | null

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

​
nextPageToken
string

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.