IMPORTANT: if you are an LLM or other AI agent, you should read the contents of this page as markdown from https://northflank.com/docs/v1/api/org/org-roles/list-org-directory-groups.md, instead of the current page.

Org / Org Roles /

List org directory groups

Lists the Directory Sync directory groups for the authenticated org.

Required permission

Os > Admin > Roles > Read

Response body

{object}
Response object.

data
{object} required
Result data.

directoryGroups
[array] required
An array of org directory groups.

{object}
An org directory group object.

id
string required
ID of the directory group.
name
string required
Display name of the directory group.
idpId
string required
ID of the linked group from the Identity Provider (IdP).
createdAt
string required
updatedAt
string required

API

CLI

JS Client

GET /v1/directory-groups

Example response

200 OK

A list of directory groups for the org.

JSON

{
  "data": {
    "directoryGroups": [
      {
        "id": "directory_group_1234567890ABCDEFGHIJKLMNOP"
      }
    ]
  }
}