Retrieve Directory

GET

/directory/retrieve-directory/{directoryName}

Retrieve Directory.
Both directory name and short name can be used here.

Request

Path Params

directoryName

string

required

Example:

Header Params

X-DPT-AUTHORIZATION

string

required

Profile authorization token.

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://stage.privicore.com:9009/directory/retrieve-directory/' \
--header 'X-DPT-AUTHORIZATION;'

Responses

🟢200OK

application/json

Body

string

optional

Directory id.

Example:

example_directory_id

name

string

optional

Directory name.

Example:

example_directory_name

shortName

string

optional

Directory short name.

Example:

example_directory_short_name

profileId

string

optional

Example:

example_directory_owner_profile_id

createdAt

string

optional

Created at.

Example:

2025-02-10T10:03:06+00:00

Example

{
    "id": "example_directory_id",
    "name": "example_directory_name",
    "shortName": "example_directory_short_name",
    "profileId": "example_directory_owner_profile_id",
    "createdAt": "2025-02-10T10:03:06+00:00"
}

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-03-06 13:01:35

Retrieve assigned directories

Create Directory User