Product documentation
OrganizationDomains
The OrganizationDomains resource.
OrganizationDomains
The OrganizationDomains resource.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/organizations/{orgId}/domains | Organization Domains List | tenant:orgs.read |
POST | /api/v1/organizations/{orgId}/domains | Organization Domains Add | tenant:orgs.write |
DELETE | /api/v1/organizations/{orgId}/domains/{domId} | Organization Domains Delete | tenant:orgs.write |
POST | /api/v1/organizations/{orgId}/domains/{domId}/verify | Organization Domains Verify | tenant:orgs.write |
Operation details
GET /api/v1/organizations/{orgId}/domains
Organization Domains List
- Operation ID:
organizationDomainsList - Required scopes:
tenant:orgs.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
orgId | 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/organizations/{orgId}/domains
Organization Domains Add
- Operation ID:
organizationDomainsAdd - Required scopes:
tenant:orgs.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
orgId | path | yes | string |
Request body: application/json → AddDomainRequest
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/organizations/{orgId}/domains/{domId}
Organization Domains Delete
- Operation ID:
organizationDomainsDelete - Required scopes:
tenant:orgs.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
orgId | path | yes | string | |
domId | 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/organizations/{orgId}/domains/{domId}/verify
Organization Domains Verify
- Operation ID:
organizationDomainsVerify - Required scopes:
tenant:orgs.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
orgId | path | yes | string | |
domId | 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) |