Product documentation
Directories
The Directories resource.
Directories
The Directories resource.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/directories | Directories List | tenant:orgs.read |
POST | /api/v1/directories | Directories Create | tenant:orgs.write |
GET | /api/v1/directories/{id} | Directories Get | tenant:orgs.read |
DELETE | /api/v1/directories/{id} | Directories Delete | tenant:orgs.write |
Operation details
GET /api/v1/directories
Directories List
- Operation ID:
directoriesList - Required scopes:
tenant:orgs.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
organizationId | query | no | string | |
limit | query | no | integer | |
cursor | query | no | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
POST /api/v1/directories
Directories Create
- Operation ID:
directoriesCreate - Required scopes:
tenant:orgs.write
Request body (required): application/json → CreateDirectoryRequest
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
GET /api/v1/directories/{id}
Directories Get
- Operation ID:
directoriesGet - Required scopes:
tenant:orgs.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
DELETE /api/v1/directories/{id}
Directories Delete
- Operation ID:
directoriesDelete - Required scopes:
tenant:orgs.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |