Product documentation
DirectoryConnector
The DirectoryConnector resource.
DirectoryConnector
The DirectoryConnector resource.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
PUT | /api/v1/directories/{directoryId}/connector-credential | Directory Connector Set Connector Credential | tenant:orgs.write |
DELETE | /api/v1/directories/{directoryId}/connector-credential | Directory Connector Clear Connector Credential | tenant:orgs.write |
POST | /api/v1/directories/{directoryId}/probe | Directory Connector Probe | tenant:orgs.write |
GET | /api/v1/directories/{directoryId}/scim-bearers | Directory Connector List Bearers | tenant:orgs.read |
POST | /api/v1/directories/{directoryId}/scim-bearers | Directory Connector Mint Bearer | tenant:orgs.write |
DELETE | /api/v1/directories/{directoryId}/scim-bearers/{bearerId} | Directory Connector Revoke Bearer | tenant:orgs.write |
POST | /api/v1/directories/{directoryId}/scim-bearers/{bearerId}/rotate | Directory Connector Rotate Bearer | tenant:orgs.write |
Operation details
PUT /api/v1/directories/{directoryId}/connector-credential
Directory Connector Set Connector Credential
- Operation ID:
directoryConnectorSetConnectorCredential - Required scopes:
tenant:orgs.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
directoryId | path | yes | string |
Request body (required): application/json → SetConnectorCredentialRequest
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/{directoryId}/connector-credential
Directory Connector Clear Connector Credential
- Operation ID:
directoryConnectorClearConnectorCredential - Required scopes:
tenant:orgs.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
directoryId | 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) |
POST /api/v1/directories/{directoryId}/probe
Directory Connector Probe
- Operation ID:
directoryConnectorProbe - Required scopes:
tenant:orgs.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
directoryId | 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) |
GET /api/v1/directories/{directoryId}/scim-bearers
Directory Connector List Bearers
- Operation ID:
directoryConnectorListBearers - Required scopes:
tenant:orgs.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
directoryId | 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) |
POST /api/v1/directories/{directoryId}/scim-bearers
Directory Connector Mint Bearer
- Operation ID:
directoryConnectorMintBearer - Required scopes:
tenant:orgs.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
directoryId | path | yes | string |
Request body: application/json → MintScimBearerRequest
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/{directoryId}/scim-bearers/{bearerId}
Directory Connector Revoke Bearer
- Operation ID:
directoryConnectorRevokeBearer - Required scopes:
tenant:orgs.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
directoryId | path | yes | string | |
bearerId | 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) |
POST /api/v1/directories/{directoryId}/scim-bearers/{bearerId}/rotate
Directory Connector Rotate Bearer
- Operation ID:
directoryConnectorRotateBearer - Required scopes:
tenant:orgs.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
directoryId | path | yes | string | |
bearerId | path | yes | string |
Request body: application/json → MintScimBearerRequest
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) |