Product documentation
NamedLocation
The NamedLocation resource.
NamedLocation
The NamedLocation resource.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/named-locations | Named Location List | tenant:applications.read + tenant:clients.read |
POST | /api/v1/named-locations | Named Location Create | tenant:applications.write + tenant:clients.write |
GET | /api/v1/named-locations/{id} | Named Location Get | tenant:applications.read + tenant:clients.read |
PATCH | /api/v1/named-locations/{id} | Named Location Update | tenant:applications.write + tenant:clients.write |
DELETE | /api/v1/named-locations/{id} | Named Location Delete | tenant:applications.write + tenant:clients.write |
Operation details
GET /api/v1/named-locations
Named Location List
- Operation ID:
namedLocationList - Required scopes:
tenant:applications.read+tenant:clients.read
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/named-locations
Named Location Create
- Operation ID:
namedLocationCreate - Required scopes:
tenant:applications.write+tenant:clients.write
Request body (required): application/json → CreateNamedLocationRequest
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/named-locations/{id}
Named Location Get
- Operation ID:
namedLocationGet - Required scopes:
tenant:applications.read+tenant:clients.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) |
PATCH /api/v1/named-locations/{id}
Named Location Update
- Operation ID:
namedLocationUpdate - Required scopes:
tenant:applications.write+tenant:clients.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string |
Request body (required): application/json → UpdateNamedLocationRequest
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/named-locations/{id}
Named Location Delete
- Operation ID:
namedLocationDelete - Required scopes:
tenant:applications.write+tenant:clients.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) |