---
title: "Directory"
description: "Directory data store manages identities and credentials, integrating with social systems like Twitter, Facebook, LinkedIn. (Gitana 4.0)"
product: "Gitana"
version: "4.0"
url: "/documentation/gitana/4.0/reference/types/directory"
---

# <a id="top"></a>Directory

A Data Store

1.  [Platform](/documentation/gitana/4.0/reference/types/platform.md)
2.  [Directory](/documentation/gitana/4.0/reference/types/directory.md)

##### Table of Contents

- [Overview](#top "Overview")
- [Parent](#parent "Parent")
- [Objects](#objects "Objects")
- [Properties](#properties "Properties")
- [Methods](#methods "Methods")
- [Schema](#schema "Schema")

A directory is a data store that maintains identity objects and credentials. This consists of user passwords and authentication tokens for connectivity to third party "social" systems like Twitter, Facebook, LinkedIn and more.

> **Note:** Drop in one of our language drivers to accelerate your development.  
> Here are links to some of our popular [Cookbooks](/documentation/gitana/4.0/developers/cookbooks/overview.md) to help you get started!
> 
> - [C#](/documentation/gitana/4.0/developers/cookbooks/csharp.md)
> - [Go](/documentation/gitana/4.0/developers/cookbooks/go.md)
> - [Java](/documentation/gitana/4.0/developers/cookbooks/java.md)
> - [JavaScript](/documentation/gitana/4.0/developers/cookbooks/javascript2.md)
> - [PHP](/documentation/gitana/4.0/developers/cookbooks/php.md)
> - [Python](/documentation/gitana/4.0/developers/cookbooks/python.md)
> - [Ruby](/documentation/gitana/4.0/developers/cookbooks/ruby.md)

## <a id="parent"></a>Parent

This Directory is contained within a [Platform](/documentation/gitana/4.0/reference/types/platform.md).

## <a id="objects"></a>Objects

This Directory contains the following objects:

- [Identity Policy](/documentation/gitana/4.0/reference/types/identityPolicy.md)
- [Social Connection](/documentation/gitana/4.0/reference/types/connection.md)
- [Identity](/documentation/gitana/4.0/reference/types/identity.md)
- [Identity Recipient](/documentation/gitana/4.0/reference/types/identityRecipient.md)

## <a id="properties"></a>Properties

The following properties are available:

| Property | Type | Default | Read-Only | Description |
| --- | --- | --- | --- | --- |
| \_doc | string |  | No | The primary ID |
| \_system | object |  | No | Metadata maintained by the system |
| binaryStorageProviderType | string |  | No | The type identifier for the binary storage provider that backs this data store |
| datastoreId | string |  | Yes | The ID of the data store |
| datastoreTypeId | string |  | Yes | The data store type identifier |
| description | string |  | No | A description of the data store |
| enableAuthorities | boolean | true | No | Whether to check access control rights for principals against this data store |
| locked | boolean |  | Yes | Whether the data store is presently locked. If the data store is locked, then write operations against it will block. |
| lockedBy | string |  | No | The principal that holds the lock (if the data store is locked) |
| maxsize | number |  | No | The maximum allowed allocation size (on disk) of the data store in bytes. If this size of the data store exceeds this value, write operations will fail. A value of -1 indicates that there is no upper limit. |
| objectcount | number |  | No | The number of objects stored within the data store. This includes system-maintained objects. This value is updated periodically and may not be precise at the moment it is read. |
| size | number |  | Yes | The last-recorded allocation size (on disk) of the data store in bytes. This value is updated periodically and may not be precise at the moment it is read. |
| statisticsDate | object |  | No | Records the time when statistics were last run against the data store. Statistics are run periodically to calculate the data store size and object allocations. |
| statisticsDirty | boolean |  | Yes | Whether writes have occurred against this data store since the last time statistics were run. This signals to the system that statistics need to be collected at the next available opportunity. |
| title | string |  | No | The title of the data store |

## <a id="methods"></a>Methods

The following methods are available:

- [Add Team Member](#post-directories-directoryid-teams-teamkey-members-add "Add Team Member")
- [Check Membership](#post-directories-directoryid-teams-teamkey-members-check "Check Membership")
- [Check Permission](#post-directories-directoryid-permissions-permissionid-check "Check Permission")
- [Check Single Authority](#post-directories-directoryid-authorities-authorityid-check "Check Single Authority")
- [Check multiple Authorities](#post-directories-authorities-check "Check multiple Authorities")
- [Check multiple Permissions](#post-directories-permissions-check "Check multiple Permissions")
- [Create Directory](#post-directories "Create Directory")
- [Create Role](#post-directories-directoryid-roles "Create Role")
- [Create Stat](#post-directories-directoryid-stats "Create Stat")
- [Create a Team](#post-directories-directoryid-teams "Create a Team")
- [Delete Directory](#delete-directories-directoryid "Delete Directory")
- [Delete Directory](#post-directories-directoryid-delete "Delete Directory")
- [Delete Role](#delete-directories-directoryid-roles-rolekeyorid "Delete Role")
- [Delete Role](#post-directories-directoryid-roles-rolekeyorid-delete "Delete Role")
- [Deletes a Team](#delete-directories-directoryid-teams-teamkey "Deletes a Team")
- [Export Directory](#post-directories-directoryid-export "Export Directory")
- [Get Team](#get-directories-directoryid-teams-teamkey "Get Team")
- [Grant Authority](#post-directories-directoryid-authorities-authorityid-grant "Grant Authority")
- [Grant Authority to Team](#post-directories-directoryid-teams-teamkey-authorities-authorityid-grant "Grant Authority to Team")
- [Import Directory](#post-directories-directoryid-import "Import Directory")
- [List Roles](#get-directories-directoryid-roles "List Roles")
- [List Team Authorities](#get-directories-directoryid-teams-teamkey-authorities "List Team Authorities")
- [List Teams](#get-directories-directoryid-teams "List Teams")
- [Lists Directory](#get-directories "Lists Directory")
- [Lists Team Members](#get-directories-directoryid-teams-teamkey-members "Lists Team Members")
- [Lock Directory](#post-directories-directoryid-lock "Lock Directory")
- [Queries for Directory](#post-directories-query "Queries for Directory")
- [Read ACL](#get-directories-directoryid-acl-list "Read ACL")
- [Read ACL for Principal](#get-directories-directoryid-acl "Read ACL for Principal")
- [Read Authorities Report](#post-directories-directoryid-authorities "Read Authorities Report")
- [Read Directory](#get-directories-directoryid "Read Directory")
- [Read Role](#get-directories-directoryid-roles-rolekeyorid "Read Role")
- [Remove Team Member](#post-directories-directoryid-teams-teamkey-members-remove "Remove Team Member")
- [Revoke Authority](#post-directories-directoryid-authorities-authorityid-revoke "Revoke Authority")
- [Revoke Authority from Team](#post-directories-directoryid-teams-teamkey-authorities-authorityid-revoke "Revoke Authority from Team")
- [Unlock Directory](#post-directories-directoryid-unlock "Unlock Directory")
- [Update Directory](#put-directories-directoryid "Update Directory")
- [Update Directory](#post-directories-directoryid-update "Update Directory")
- [Update Role](#post-directories-directoryid-roles-rolekeyorid-update "Update Role")
- [Update Role](#put-directories-directoryid-roles-rolekeyorid "Update Role")
- [Update a Team](#put-directories-directoryid-teams-teamkey "Update a Team")

### <a id="post-directories-directoryid-teams-teamkey-members-add"></a>Add Team Member

Adds a principal as a member of a Team against the given directory

POST /directories/{directoryId}/teams/{teamKey}/members/add

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| teamKey | true | string | The key identifier for the team |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}
```

### <a id="post-directories-directoryid-teams-teamkey-members-check"></a>Check Membership

Checks whether a principal belongs to a Team for the given directory

POST /directories/{directoryId}/teams/{teamKey}/members/check

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| teamKey | true | string | The key identifier for the team |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Belongs",
  "extends": "status",
  "properties": {
    "belongs": {
      "type": "boolean"
    },
    "ok": null
  }
}
```

### <a id="post-directories-directoryid-permissions-permissionid-check"></a>Check Permission

Checks whether one or more authorities against the specified directory are granted for a given set of users

POST /directories/{directoryId}/permissions/{permissionId}/check

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| permissionId | true | string | The ID of the permission |
| id | true | string |  |

#### Response

```json
{
  "$ref": "#/components/schemas/checkPermission"
}
```

### <a id="post-directories-directoryid-authorities-authorityid-check"></a>Check Single Authority

Checks whether a single authority is granted against the specified directory for the given user

POST /directories/{directoryId}/authorities/{authorityId}/check

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| authorityId | true | string | The ID or authority key for the authority |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}
```

### <a id="post-directories-authorities-check"></a>Check multiple Authorities

Checks whether one or more authorities against the specified directory are granted for a given set of users

POST /directories/authorities/check

#### Parameters

This function has no parameters.

#### Response

```json
{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}
```

### <a id="post-directories-permissions-check"></a>Check multiple Permissions

Checks whether one or more permissions against the specified directory are granted for a given set of users

POST /directories/permissions/check

#### Parameters

This function has no parameters.

#### Response

```json
{
  "type": "object",
  "description": "Check Multiple Permissions Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}
```

### <a id="post-directories"></a>Create Directory

Creates a new Directory

POST /directories

#### Parameters

This function has no parameters.

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-directories-directoryid-roles"></a>Create Role

Creates a role for a directory

POST /directories/{directoryId}/roles

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| HTTP Payload | true | string | HTTP Payload |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-directories-directoryid-stats"></a>Create Stat

POST /directories/{directoryId}/stats

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |

### <a id="post-directories-directoryid-teams"></a>Create a Team

Creates a Team against the given directory

POST /directories/{directoryId}/teams

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |

#### Response

```json
{
  "type": "object",
  "extends": "document",
  "description": "Team",
  "properties": {
    "teamableObjectTypeId": {
      "type": "string",
      "readonly": true
    },
    "teamableObjectId": {
      "type": "string",
      "readonly": true
    },
    "key": {
      "type": "string"
    },
    "groupId": {
      "type": "string"
    },
    "groupDomainId": {
      "type": "string"
    },
    "roleKeys": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  }
}
```

### <a id="delete-directories-directoryid"></a>Delete Directory

Deletes an existing Directory

DELETE /directories/{directoryId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-directories-directoryid-delete"></a>Delete Directory

Deletes an existing Directory

POST /directories/{directoryId}/delete

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="delete-directories-directoryid-roles-rolekeyorid"></a>Delete Role

Deletes a role for a directory

DELETE /directories/{directoryId}/roles/{roleKeyOrId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| roleKeyOrId | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-directories-directoryid-roles-rolekeyorid-delete"></a>Delete Role

Deletes a role for a directory

POST /directories/{directoryId}/roles/{roleKeyOrId}/delete

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| roleKeyOrId | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="delete-directories-directoryid-teams-teamkey"></a>Deletes a Team

Deletes a Team against the given directory

DELETE /directories/{directoryId}/teams/{teamKey}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| teamKey | true | string | The key identifier for the team |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-directories-directoryid-export"></a>Export Directory

Starts an export job for this resource

POST /directories/{directoryId}/export

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| groupId | false | string | The Group ID to be assigned to the exported archive |
| artifactId | false | string | The Artifact ID to be assigned to the exported archive |
| versionId | false | string | The Version ID to be assigned to the exported archive |
| vaultId | false | string | The ID of the vault where the exported archive should be saved |
| schedule | false | string | Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous') |

#### Response

```json
{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object",
      "description": "Only include objects whose modification date is after this time (epoch millis). This is used for partial or rolling exports."
    },
    "endDate": {
      "type": "object",
      "description": "Only include objects whose modification date is before this time (epoch millis). This is used for partial or rolling exports."
    },
    "startChangeset": {
      "type": "string",
      "description": "Only include data that is relevant to changesets at or beyond the specified changeset."
    },
    "endChangeset": {
      "type": "string",
      "description": "Only include data that is relevant to changesets at or before the specified changeset."
    },
    "includeACLs": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include ACLs during export."
    },
    "includeTeams": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Teams during export."
    },
    "includeActivities": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Activities during export."
    },
    "includeBinaries": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Binaries for data stores during export."
    },
    "includeAttachments": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Attachments for Attachables during export."
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}
```

### <a id="get-directories-directoryid-teams-teamkey"></a>Get Team

Retrieves a Team against the given directory

GET /directories/{directoryId}/teams/{teamKey}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| teamKey | true | string | The key identifier for the team |

#### Response

```json
{
  "type": "object",
  "extends": "document",
  "description": "Team",
  "properties": {
    "teamableObjectTypeId": {
      "type": "string",
      "readonly": true
    },
    "teamableObjectId": {
      "type": "string",
      "readonly": true
    },
    "key": {
      "type": "string"
    },
    "groupId": {
      "type": "string"
    },
    "groupDomainId": {
      "type": "string"
    },
    "roleKeys": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  }
}
```

### <a id="post-directories-directoryid-authorities-authorityid-grant"></a>Grant Authority

Grants an authority against the specified directory to a given user

POST /directories/{directoryId}/authorities/{authorityId}/grant

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| authorityId | true | string | The ID or authority key for the authority |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-directories-directoryid-teams-teamkey-authorities-authorityid-grant"></a>Grant Authority to Team

Assigns an Authority to a Team for the given directory

POST /directories/{directoryId}/teams/{teamKey}/authorities/{authorityId}/grant

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| teamKey | true | string | The key identifier for the team |
| authorityId | true | string | The ID or authority key for the authority |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-directories-directoryid-import"></a>Import Directory

Starts an import job for this resource

POST /directories/{directoryId}/import

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| groupId | false | string | The Group ID to be assigned to the exported archive |
| artifactId | false | string | The Artifact ID to be assigned to the exported archive |
| versionId | false | string | The Version ID to be assigned to the exported archive |
| vaultId | false | string | The ID of the vault where the exported archive should be saved |
| schedule | false | string | Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous') |

#### Response

```json
{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include ACLs during import."
    },
    "includeTeams": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Teams during import."
    },
    "includeActivities": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Activities during import."
    },
    "includeBinaries": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Binaries for data stores during import."
    },
    "includeAttachments": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Attachments for Attachables during import."
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": "CLONE",
      "description": "Either CLONE or COPY_EVERYTHING. Use CLONE to keep the same IDs on import. Use COPY_EVERYTHING to generate all new IDs for all entries on every import."
    },
    "substitutions": {
      "type": "string"
    }
  }
}
```

### <a id="get-directories-directoryid-roles"></a>List Roles

Lists the roles for a directory

GET /directories/{directoryId}/roles

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| inherited | false | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap"
      }
    }
  }
}
```

### <a id="get-directories-directoryid-teams-teamkey-authorities"></a>List Team Authorities

Retrieves a list of the authorities defined to be granted by a Team

GET /directories/{directoryId}/teams/{teamKey}/authorities

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| teamKey | true | string | The key identifier for the team |

#### Response

```json
{
  "type": "object",
  "description": "List of Authorities",
  "properties": {
    "authorities": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
```

### <a id="get-directories-directoryid-teams"></a>List Teams

Lists the Teams against the given directory

GET /directories/{directoryId}/teams

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}
```

### <a id="get-directories"></a>Lists Directory

Retrieves a list of Directory instances

GET /directories

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| sort | false | object | Defines how to sort fields in the result set |
| skip | false | number | Skips the result set cursor ahead the specified number of records |
| limit | false | number | Specifies the number of records to be handed back in the result set |

This method supports pagination.

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_directory"
      }
    }
  }
}
```

### <a id="get-directories-directoryid-teams-teamkey-members"></a>Lists Team Members

Lists the members of a Team against the given directory

GET /directories/{directoryId}/teams/{teamKey}/members

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| teamKey | true | string | The key identifier for the team |

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}
```

### <a id="post-directories-directoryid-lock"></a>Lock Directory

POST /directories/{directoryId}/lock

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |

### <a id="post-directories-query"></a>Queries for Directory

Queries for instances of type Directory

POST /directories/query

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| sort | false | object | Defines how to sort fields in the result set |
| skip | false | number | Skips the result set cursor ahead the specified number of records |
| limit | false | number | Specifies the number of records to be handed back in the result set |

This method supports pagination.

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_directory"
      }
    }
  }
}
```

### <a id="get-directories-directoryid-acl-list"></a>Read ACL

Read the Access Control List for the specified directory

GET /directories/{directoryId}/acl/list

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |

#### Response

```json
{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}
```

### <a id="get-directories-directoryid-acl"></a>Read ACL for Principal

Reads the ACL for a directory and specific actor

GET /directories/{directoryId}/acl

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}
```

### <a id="post-directories-directoryid-authorities"></a>Read Authorities Report

Read the Authorities Report for the specified directory

POST /directories/{directoryId}/authorities

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |

#### Response

```json
{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
```

### <a id="get-directories-directoryid"></a>Read Directory

Reads an instance of a Directory

GET /directories/{directoryId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |

#### Response

```json
{
  "type": "object",
  "extends": "datastore",
  "container": "platform",
  "description": "Directory",
  "properties": {
    "title": null,
    "description": null,
    "datastoreId": null,
    "datastoreTypeId": null,
    "enableAuthorities": null,
    "size": null,
    "maxsize": null,
    "objectcount": null,
    "locked": null,
    "lockedBy": null,
    "statisticsDate": null,
    "statisticsDirty": null,
    "binaryStorageProviderType": null,
    "_doc": null,
    "_system": null
  }
}
```

### <a id="get-directories-directoryid-roles-rolekeyorid"></a>Read Role

Reads a role for a directory

GET /directories/{directoryId}/roles/{roleKeyOrId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| roleKeyOrId | true | string |  |
| inherited | false | string |  |

#### Response

```json
{
  "$ref": "#/components/schemas/"
}
```

### <a id="post-directories-directoryid-teams-teamkey-members-remove"></a>Remove Team Member

Remove a principal from a team's membership list

POST /directories/{directoryId}/teams/{teamKey}/members/remove

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| teamKey | true | string | The key identifier for the team |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-directories-directoryid-authorities-authorityid-revoke"></a>Revoke Authority

Revokes an authority against the specified directory from a given user

POST /directories/{directoryId}/authorities/{authorityId}/revoke

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| authorityId | true | string | The ID or authority key for the authority |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-directories-directoryid-teams-teamkey-authorities-authorityid-revoke"></a>Revoke Authority from Team

Revokes an Authority from a Team for the given directory

POST /directories/{directoryId}/teams/{teamKey}/authorities/{authorityId}/revoke

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| teamKey | true | string | The key identifier for the team |
| authorityId | true | string | The ID or authority key for the authority |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-directories-directoryid-unlock"></a>Unlock Directory

POST /directories/{directoryId}/unlock

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |

### <a id="put-directories-directoryid"></a>Update Directory

Updates an existing Directory

PUT /directories/{directoryId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-directories-directoryid-update"></a>Update Directory

Updates an existing Directory

POST /directories/{directoryId}/update

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-directories-directoryid-roles-rolekeyorid-update"></a>Update Role

Updates a role for a directory

POST /directories/{directoryId}/roles/{roleKeyOrId}/update

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| roleKeyOrId | true | string |  |
| HTTP Payload | true | string | HTTP Payload |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="put-directories-directoryid-roles-rolekeyorid"></a>Update Role

Updates a role for a directory

PUT /directories/{directoryId}/roles/{roleKeyOrId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| roleKeyOrId | true | string |  |
| HTTP Payload | true | string | HTTP Payload |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="put-directories-directoryid-teams-teamkey"></a>Update a Team

Updates a Team against the given directory

PUT /directories/{directoryId}/teams/{teamKey}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| directoryId | true | string | The ID of the directory |
| teamKey | true | string | The key identifier for the team |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

## <a id="schema"></a>Schema

```json

{
  "type": "object",
  "extends": "datastore",
  "container": "platform",
  "description": "Directory",
  "properties": {
    "title": null,
    "description": null,
    "datastoreId": null,
    "datastoreTypeId": null,
    "enableAuthorities": null,
    "size": null,
    "maxsize": null,
    "objectcount": null,
    "locked": null,
    "lockedBy": null,
    "statisticsDate": null,
    "statisticsDirty": null,
    "binaryStorageProviderType": null,
    "_doc": null,
    "_system": null
  },
  "id": "directory"
}
```