Create App Resources

Search App Resources

client.search.createAppResources(SearchCreateAppResourcesParamsbody?, RequestOptionsoptions?): expandedunionlistunionnextPageTokenstringSearchCreateAppResourcesResponse

post/api/v1/search/app_resources

Invokes the c1.api.app.v1.AppResourceSearch.SearchAppResources method.

Parameters

bodyappIdstringappUserIdsunionexcludeDeletedResourceBindingsbooleanexcludeResourceIdsunionexcludeResourceTypeTraitIdsunionpageSizenumberpageTokenstringquerystringrefsunionresourceIdsunionresourceTypeIdsunionresourceTypeTraitIdsunionSearchCreateAppResourcesParams

Hide ParametersShow Parameters

appIdstring

optional

The appId field.

appUserIdsunion

optional

Array<string> | null

The appUserIds field.

excludeDeletedResourceBindingsboolean

optional

The excludeDeletedResourceBindings field.

excludeResourceIdsunion

optional

Array<string> | null

The excludeResourceIds field.

excludeResourceTypeTraitIdsunion

optional

Array<string> | null

The excludeResourceTypeTraitIds field.

pageSizenumber

optional

The pageSize field.

formatint32

pageTokenstring

optional

The pageToken field.

querystring

optional

The query field.

refsunion

optional

Array<Ref> | null

The refs field.

Hide ParametersShow Parameters

idstring

optional

The id field.

appIdstring

optional

The appId field.

appResourceTypeIdstring

optional

The appResourceTypeId field.

resourceIdsunion

optional

Array<string> | null

The resourceIds field.

resourceTypeIdsunion

optional

Array<string> | null

The resourceTypeIds field.

resourceTypeTraitIdsunion

optional

Array<string> | null

The resourceTypeTraitIds field.

Returns

SearchCreateAppResourcesResponse

The SearchAppResourcesResponse message.

Hide ParametersShow Parameters

expandedunion

optional

Array<Expanded> | null

The expanded field.

Hide ParametersShow Parameters

@typestring

optional

The type of the serialized message.

listunion

optional

Array<appPathstringappResourceC1APIAppV1AppResourceparentResourcePathstringparentResourceTypePathstringresourceTypePathstringC1APIAppV1AppResourceView> | null

The list field.

Hide ParametersShow Parameters

appPathstring

optional

JSONPATH expression indicating the location of the App object in the array

appResourceidstringappIdstringappResourceTypeIdstringcreatedAtstringcustomDescriptionstringdeletedAtstringdescriptionstringdisplayNamestringgrantCountstringmatchBatonIdstringparentAppResourceIdstringparentAppResourceTypeIdstringsecretTraitunionupdatedAtstringC1APIAppV1AppResource

optional

The app resource message is a single resource that can have entitlements.

This message contains a oneof named metadata. Only a single field of the following list may be set at a time:

• secretTrait

parentResourcePathstring

optional

JSONPATH expression indicating the location of the Parent Resource object in the array

parentResourceTypePathstring

optional

JSONPATH expression indicating the location of the Parent Resource Type object in the array

resourceTypePathstring

optional

JSONPATH expression indicating the location of the Resource Type object in the array

nextPageTokenstring

optional

The nextPageToken field.

Request example TypeScript

import ConductoroneSDK from 'conductorone-sdk';

const client = new ConductoroneSDK({
  apiKey: 'My API Key',
});

const response = await client.search.createAppResources();

console.log(response.expanded);

200 Example

{
  "expanded": [
    {
      "@type": "@type"
    }
  ],
  "list": [
    {
      "appPath": "appPath",
      "appResource": {
        "id": "id",
        "appId": "appId",
        "appResourceTypeId": "appResourceTypeId",
        "customDescription": "customDescription",
        "description": "description",
        "displayName": "displayName",
        "grantCount": "grantCount",
        "matchBatonId": "matchBatonId",
        "parentAppResourceId": "parentAppResourceId",
        "parentAppResourceTypeId": "parentAppResourceTypeId",
        "secretTrait": {
          "identityAppUserId": "identityAppUserId",
          "lastUsedAt": "2019-12-27T18:11:19.117Z",
          "secretCreatedAt": "2019-12-27T18:11:19.117Z",
          "secretExpiresAt": "2019-12-27T18:11:19.117Z"
        }
      },
      "parentResourcePath": "parentResourcePath",
      "parentResourceTypePath": "parentResourceTypePath",
      "resourceTypePath": "resourceTypePath"
    }
  ],
  "nextPageToken": "nextPageToken"
}