Retrieve

Get

client.directories.retrieve(stringappID, RequestOptionsoptions?): directoryViewDirectoryViewexpandedunionDirectoryRetrieveResponse

get/api/v1/directories/{app_id}

Get a directory by app_id.

Parameters

appIDstring

The appId field.

Returns

DirectoryRetrieveResponse

The Directory Service Get Response returns a directory view with a directory and JSONPATHs indicating the location in the expanded array that items are expanded as indicated by the expand mask in the request.

Hide ParametersShow Parameters

directoryViewappPathstringdirectoryDirectoryDirectoryView

optional

The directory view contains a directory and an app_path which is a JSONPATH set to the location in the expand mask that the expanded app will live if requested by the expander.

expandedunion

optional

Array<Expanded> | null

List of serialized related objects.

Hide ParametersShow Parameters

@typestring

optional

The type of the serialized message.

Request example TypeScript

import ConductoroneSDK from 'conductorone-sdk';

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

const directory = await client.directories.retrieve('app_id');

console.log(directory.directoryView);

200 Example

{
  "directoryView": {
    "appPath": "appPath",
    "directory": {}
  },
  "expanded": [
    {
      "@type": "@type"
    }
  ]
}