Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: DTN Aviation Full SIGMET API
description: DTN Aviation Full API
version: 1.1.0
servers:
- url: https://aviation.api.dtn.com
security:
- clientCredentials: []
tags:
- name: SIGMET
description: On demand SIGMETs via API
paths:
/v1/sigmets/:
get:
tags:
- SIGMET
summary: Get active SIGMETs
description: Get all available SIGMETs, potentially filtered by various query parameters. All specified filter parameters must be satisified for an object to be returned in the response.
responses:
'200':
$ref: '#/components/responses/SigmetSuccess'
'400':
$ref: '#/components/responses/SigmetBadRequest'
'401':
$ref: '#/components/responses/ErrorUnauthorized'
parameters:
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryOffset'
- $ref: '#/components/parameters/QuerySigmetUnitSystem'
- $ref: '#/components/parameters/QueryBbox'
- $ref: '#/components/parameters/QueryPolygon'
- $ref: '#/components/parameters/QueryCircle'
- $ref: '#/components/parameters/QueryCorridor'
- $ref: '#/components/parameters/QueryGeometry'
- $ref: '#/components/parameters/QuerySrid'
- $ref: '#/components/parameters/QueryDistanceUnits'
- $ref: '#/components/parameters/QueryIsValidAt'
- $ref: '#/components/parameters/QueryFromDateTime'
- $ref: '#/components/parameters/QueryUntilDateTime'
- $ref: '#/components/parameters/QueryReportTypes'
- $ref: '#/components/parameters/QueryIssueOffices'
- $ref: '#/components/parameters/QueryFirs'
- $ref: '#/components/parameters/QueryFirStartsWith'
- $ref: '#/components/parameters/QueryIsUrgent'
security:
- clientCredentials: []
operationId: getV1Sigmets
x-operation-id-source: derived
components:
schemas:
SigmetItem:
type: object
required:
- validDateTime
- expirationDateTime
- reportType
- isUrgent
- seriesNumber
- severity
- isCancelled
- rawTxt
- issueOffice
- firNameStandard
- obsFcst
- movement
- intensityChange
- vaTcName
- sigmetId
properties:
validDateTime:
type: string
format: date-time
expirationDateTime:
type: string
format: date-time
reportType:
type: string
isUrgent:
type: boolean
seriesNumber:
type: string
severity:
type:
- string
- 'null'
isCancelled:
type: boolean
rawTxt:
type: string
issueOffice:
type: string
firNameStandard:
type: string
obsFcst:
type: string
movement:
type: string
intensityChange:
type: string
vaTcName:
type:
- string
- 'null'
sigmetId:
type: number
SigmetFeatureCollection:
description: GeoJSon 'FeatureCollection' object
externalDocs:
url: https://tools.ietf.org/html/rfc7946#section-3.3
allOf:
- $ref: '#/components/schemas/GeoJsonObject'
- type: object
required:
- features
properties:
features:
type: array
items:
$ref: '#/components/schemas/SigmetFeature'
Error:
title: Error
description: Error
required:
- type
- title
- status
- detail
- meta
type: object
properties:
url:
type: string
type:
enum:
- internal-server-error
- unauthorized
- bad-request
- service-unavailable
- forbidden
- not-found
type: string
title:
type: string
status:
type: number
detail:
type: string
instance:
type: string
errors:
type: array
items:
type: object
meta:
$ref: '#/components/schemas/Meta'
GeoJsonObject:
description: 'GeoJSon object The coordinate reference system for all GeoJSON coordinates is a geographic coordinate reference system, using the World Geodetic System 1984 (WGS 84) datum, with longitude and latitude units of decimal degrees. This is equivalent to the coordinate reference system identified by the Open Geospatial Consortium (OGC) URN An OPTIONAL third-position element SHALL be the height in meters above or below the WGS 84 reference ellipsoid. In the absence of elevation values, applications sensitive to height or depth SHOULD interpret positions as being at local ground or sea level.
'
externalDocs:
url: https://tools.ietf.org/html/rfc7946#section-3
type: object
properties:
type:
type: string
enum:
- Feature
- FeatureCollection
- Point
- MultiPoint
- LineString
- MultiLineString
- Polygon
- MultiPolygon
- GeometryCollection
bbox:
description: 'A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.
'
type: array
items:
type: number
required:
- type
discriminator:
propertyName: type
SigmetFeature:
description: GeoJSon 'Feature' object
externalDocs:
url: https://tools.ietf.org/html/rfc7946#section-3.2
allOf:
- $ref: '#/components/schemas/GeoJsonObject'
- type: object
required:
- geometry
- properties
properties:
geometry:
allOf:
- {}
- $ref: '#/components/schemas/Geometry'
properties:
$ref: '#/components/schemas/SigmetItem'
id:
oneOf:
- type: number
- type: string
Meta:
title: Meta
description: Meta data attached to every response
required:
- name
- request_id
- start_timestamp
- end_timestamp
- execution_time
type: object
properties:
name:
type: string
request_id:
type: string
start_timestamp:
type: integer
end_timestamp:
type: integer
execution_time:
type: integer
Geometry:
type: object
description: GeoJSon geometry
discriminator:
propertyName: type
required:
- type
externalDocs:
url: http://geojson.org/geojson-spec.html#geometry-objects
properties:
type:
type: string
enum:
- Point
- LineString
- Polygon
- MultiPoint
- MultiLineString
- MultiPolygon
description: the geometry type
parameters:
QuerySigmetUnitSystem:
name: unitSystem
description: "Identifer for units system used for numerical output values. Must be either `default` or `metric`. Default is `default`.\n * `topLevel`: default=`ft`, metric=`m`\n * `bottomLevel`: default=`ft`, metric=`m`"
in: query
required: false
explode: false
schema:
type: string
enum:
- default
- metric
default: default
QueryGeometry:
name: geometry
description: Boolean indicator for inclusion of Geometry in response. If false, geometry will be returned empty.
in: query
required: false
schema:
type: boolean
default: true
QueryIssueOffices:
name: issueOffices
description: Comma-separated list of issueOffice values. Values should be each 4 letters and need to match a Meteorological Watch Office. Limits to objects whose issueOffice value matches one of specified parameter values.
in: query
required: false
schema:
type: string
QueryCircle:
name: circle
description: Circle coordinates and radius distance in the format `<X>,<Y>,<RADIUS>`. The `X,Y` corridinates must be consistent with the `srid` (`4326` for longitude/latitude by default). The `<RADIUS>` defines the distance (in default or `distanceUnits`-specified units) from the defined point. Limits to objects within or intersecting the area so defined. No more than one of `bbox`, `polygon`, `circle`, and `corridor` may be used in one request.
in: query
required: false
schema:
type: string
QueryFirStartsWith:
name: firStartsWith
description: Beginning characters of FIR name. Must be between 2 and 10 characters and only letters, spaces, dashes, and apostrophes allowed. Results will be provided including data for any FIRs whose names match the input, like for both `GUANGZHOU` and `GUAYAQUIL` if provide `GUA` as value.
in: query
required: false
schema:
type: string
QueryUntilDateTime:
name: untilDateTime
description: UTC timestamp in format `YYYY-MM-DD hh:mm:ss`. Limits to objects whose validDateTime is earlier than the specified value, i.e., only objects that began before this time.
in: query
required: false
schema:
type: string
pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
QueryLimit:
name: limit
description: Provide no more than this many items in the response set. Default = 1000
in: query
required: false
schema:
type: integer
default: 1000
minimum: 1
maximum: 10000
QueryOffset:
name: offset
description: Skip over this many into the response set; used for paginated results. Default = 0
in: query
required: false
schema:
type: integer
default: 0
QueryReportTypes:
name: reportTypes
description: Comma-separated list of reportType values. Must include only allowed values. Limits to objects whose reportType value matches one of specified parameter values.
in: query
required: false
explode: false
schema:
type: array
items:
type: string
enum:
- TS
- TURB
- ICE
- VA
- TC
- DS
- SS
- MTW
- RDOACT CLD
QuerySrid:
name: srid
description: SRID identifer for coordinate system for spatial filter coordinates. Default is 4326 (i.e., ordinary longitude & latitude in degrees).
in: query
required: false
explode: false
schema:
type: integer
enum:
- 4326
- 3857
default: 4326
QueryIsUrgent:
name: isUrgent
description: Boolean indicator for isUrgent. Limits to objects whose isUrgent value matches parameter value.
in: query
required: false
schema:
type: boolean
QueryDistanceUnits:
name: distanceUnits
description: Units identifier for distances in definition for circle or corridor spatial filter. Default is `nm` (nautical miles).
in: query
required: false
schema:
type: string
enum:
- nm
- km
- m
- sm
default: nm
QueryFromDateTime:
name: fromDateTime
description: UTC timestamp in format `YYYY-MM-DD hh:mm:ss`. Limits to objects whose expirationDateTime is later than that specified value, i.e., only objects not ended by this time.
in: query
required: false
schema:
type: string
pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
QueryCorridor:
name: corridor
description: Line coordinates and distance from the line in the format `<X_0>,<Y_0>,<X_1>,<Y_1>...,<X_n>,<Y_n>,<HALFWIDTH>`. The `X,Y` corridinates must be consistent with the `srid` (`4326` for longitude/latitude by default). The `<HALFWIDTH>` defines the distance (in default or `distanceUnits`-specified units) from the line defined by the corridates out to which to create encompassing shape. Limits to objects within or intersecting the area so defined. No more than one of `bbox`, `polygon`, `circle`, and `corridor` may be used in one request.
in: query
required: false
schema:
type: string
QueryBbox:
name: bbox
description: Bounding box coordinates in the format `<min_X>,<min_Y>,<max_X>,<max_Y>`. The `X,Y` corridinates must be consistent with the `srid` (`4326` for longitude/latitude by default). Limits to objects within or intersecting the area so defined. No more than one of `bbox`, `polygon`, `circle`, and `corridor` may be used in one request.
in: query
required: false
schema:
type: string
QueryPolygon:
name: polygon
description: Polygon coordinates in the format `<X_0>,<Y_0>,<X_1>,<Y_1>...,<X_n>,<Y_n>`. The `X,Y` corridinates must be consistent with the `srid` (`4326` for longitude/latitude by default). If the last `X,Y` does not match the first `X,Y`, the first `X,Y` is copied to the end to close the polygon. Limits to objects within or intersecting the area so defined. No more than one of `bbox`, `polygon`, `circle`, and `corridor` may be used in one request.
in: query
required: false
schema:
type: string
QueryIsValidAt:
name: isValidAt
description: UTC timestamp in format `YYYY-MM-DD hh:mm:ss`. Limits to objects whose validDateTime is not earlier than the specified value and whose expirationDateTime is later than that specified value.
in: query
required: false
schema:
type: string
pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
QueryFirs:
name: firs
description: Comma-separated list of firStandardName values. Values must exactly match items in defined population. Limits to objects whose firStandardName value matches one of specified parameter values.
in: query
required: false
schema:
type: string
responses:
SigmetBadRequest:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
BadRequest:
$ref: '#/components/examples/SigmetBadRequestResponse'
ErrorUnauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: unauthorized
title: Error while authenticating the user
status: 401
detail: Missing Authorization token.
instance: urn:dtn:aviation-api:/v1/notams/KIND:requestId:19e1b83a-cb2e-4460-b687-ce9d0c50b4b6
meta:
name: v1.notams.KIND
uuid: d64fc634-9bee-430d-8ab1-200337e6e9b2
request_id: 19e1b83a-cb2e-4460-b687-ce9d0c50b4b6
start_timestamp: 1714019217213
end_timestamp: 1714019217246
execution_time: 33
SigmetSuccess:
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/SigmetFeatureCollection'
examples:
Success:
$ref: '#/components/examples/SigmetSuccessResponse'
examples:
SigmetBadRequestResponse:
value:
url: https://aviation.api.dtn.com/v1/sigmets?reportTypes=TURB,ST
type: bad-request
title: Invalid Request
status: 400
detail: Validation failed.
instance: urn:dtn:aviation-api:/v1/sigmets/:requestId:fa051103-4844-4012-822b-dfb651cb42e7
errors:
- message: Parameter value includes unpermitted characters or is otherwise not allowed
parameter: reportTypes
value: TURB,ST
meta:
name: v1.sigmets?reportTypes=TURB,ST
uuid: aaa1d697-6dfc-47f9-be23-f0a103330eb0
request_id: fa051103-4844-4012-822b-dfb651cb42e7
start_timestamp: 1721860434569
end_timestamp: 1721860434576
execution_time: 7
SigmetSuccessResponse:
value:
url: https://aviation.api.dtn.com/v1/sigmets/?firs=AUCKLAND%20OCEANIC
type: FeatureCollection
features:
- type: Feature
geometry:
type: Polygon
coordinates:
- - - -180
- -31.946133562731603
- - -176.5
- -32.6667
- - -163
- -33.6667
- - -162.833
- -35.6667
- - -180
- -34.42072816083611
- - -180
- -31.946133562731603
properties:
reportType: TURB
seriesNumber: '12'
severity: SEVERE
iceType: null
rawTxt: NZZO SIGMET 12 VALID 241909/242309 NZKL- NZZO AUCKLAND OCEANIC FIR SEV TURB FCST WI S3410 E17630 - S2800 E17220 - S3130 E17750 - S3240 W17630 - S3340 W16300 - S3540 W16250 - S3410 E17630 FL250/320 STNR NC=
issueOffice: NZKL
firNameStandard: AUCKLAND OCEANIC
obsFcst: FCST
movement: STNR
intensityChange: NC
vaTcName: null
validDateTime: '2024-07-24T19:09:00.000Z'
expirationDateTime: '2024-07-24T23:09:00.000Z'
isUrgent: false
isCancelled: false
sigmetId: 12394260
topLevel: 32000
bottomLevel: 25000
- type: Feature
geometry:
type: Polygon
coordinates:
- - - -165.5
- -11.3333
- - -164.167
- -12.6667
- - -164
- -14.1667
- - -170.667
- -12
- - -169.833
- -10.3333
- - -165.5
- -11.3333
properties:
reportType: TS
seriesNumber: '14'
severity: null
iceType: null
rawTxt: NZZO SIGMET 14 VALID 242217/250217 NZKL- NZZO AUCKLAND OCEANIC FIR EMBD TS OBS WI S1120 W16530 - S1240 W16410 - S1410 W16400 - S1200 W17040 - S1020 W16950 - S1120 W16530 TOP FL530 STNR WKN=
issueOffice: NZKL
firNameStandard: AUCKLAND OCEANIC
obsFcst: OBS
movement: STNR
intensityChange: WKN
vaTcName: null
validDateTime: '2024-07-24T22:17:00.000Z'
expirationDateTime: '2024-07-25T02:17:00.000Z'
isUrgent: false
isCancelled: false
sigmetId: 12396480
topLevel: 53000
bottomLevel: 0
meta:
name: v1.sigmets.?limit=5&firs=AUCKLAND%20OCEANIC
uuid: 0c79e5ca-9e7f-48d1-bc2f-a8819a555f24
request_id: 88b452d4-bfd0-4e7e-a953-e4e0d1cac547
start_timestamp: 1721860091060
end_timestamp: 1721860091528
execution_time: 468
securitySchemes:
clientCredentials:
type: oauth2
x-receive-token-in: request-body
flows:
clientCredentials:
tokenUrl: https://api.auth.dtn.com/v1/tokens/authorize
description: "# Using DAIS for M2M/API Auth\nYou have been given a Client ID and a Client Secret, which are used to request a DTN Access Token. DTN Access Tokens are required when making calls to each and every DTN API endpoint. The following information provides additional details on these tokens and how they are generated.\n## What is an Access Token and how is it different from an API Key?\nAn API Key is a random string of characters that an API uses to authorize whether or not a calling client has approved access to an endpoint. These keys are a non-standard approach to API authorization and are generally issued on a per-API basis.\n\nAn Access Token is also a string of characters but is a base-64 encoded JavaScript Object Notation Web Token, or JWT. JWTs are a widely accepted standard that use OAuth concepts and approaches. \n\nBoth API Keys and Access Tokens are used in an Authorization Request Header as a Bearer, meaning there is no difference in where you put this string of characters when you make calls to DTN APIs.\n## How to generate an Access Token?\nWhen requested, an Access Token is generated for your specific Client (ID/Secret) and for a specific API. The DTN Auth and Identity Service (DAIS) generates new Access Tokens for your client. The DAIS endpoint is `POST https://api.auth.dtn.com/v1/tokens/authorize`.\n\nThis endpoint takes two Header parameters:\n * `Content-Type: application/json`\n * `Accept: application/json`\n\nThis endpoint takes four parameters in the Request Body:\n * `grant_type`: this should always be client_credentials for generating machine-to-machine tokens.\n * `client_id`: this is the Client ID or Application ID using the token and is given to you by DTN's Identity Team. This ID will never change for your client/application.\n * `client_secret`: this is the Client Secret that is associated with the Application ID and is given to you by DTN's Identity Team. This key is subject to rotation for security purposes but always with the client's knowledge.\n * `audience`: this is the API for which this Access Token will be used. For the DTN Websocket API, you need to use the following audience: https://dev-portal.dev.coreservices.zones.dtn.com\n\nYou can use this CURL command template as a reference for obtaining an access token:\n ```\n curl --location --request POST 'https://api.auth.dtn.com/v1/tokens/authorize' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n\"grant_type\": \"client_credentials\",\n\"client_id\": \"insert your client id here\",\n\"client_secret\": \"insert your client secret here\",\n\"audience\": \"insert your audience here\"\n}' \n ```\n\n*This document, for demonstration purposes, supplies a client_id and client_secret in all code examples. This client/application is for a fictitious API and cannot be used in practice to gain unauthorized access to any other DTN API.*\nUpon generating a new Access Token, you should receive an HTTP Response from DAIS similar to this:\n ```\n {\n \"data\": {\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InpfX21pZW13NGhoTmdvQWQxR3N6ciJ9.eyJodHRwczovL2F1dGguZHRuLmNvbS9jdXN0b21lcklkIjoiMTIzNDU2Nzg5MERlbW8iLCJodHRwczovL2F1dGguZHRuLmNvbS9wcm9kdWN0Q29kZSI6IkRlbW9BcGlQIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcmVxdWVzdGVySXAiOiIxOC4yMTMuMTc0LjI3IiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcnBzIjoiMTAwIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vdGllciI6IkJhc2ljIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcXVvdGEiOiI5OTk5OTkiLCJpc3MiOiJodHRwczovL2lkLmF1dGguZHRuLmNvbS8iLCJzdWIiOiJuZnlPM0tpS1BSOE4wREtSNUNMOGpTOUdGQkNEZXlGTUBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9kZW1vLWFwaS5hdXRoLmR0bi5jb20vIiwiaWF0IjoxNjU2MDk5MDY4LCJleHAiOjE2NTYwOTkxNTgsImF6cCI6Im5meU8zS2lLUFI4TjBES1I1Q0w4alM5R0ZCQ0RleUZNIiwic2NvcGUiOiJyZWFkOmRlbW8gY3JlYXRlOmRlbW8gdXBkYXRlOmRlbW8iLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJwZXJtaXNzaW9ucyI6WyJyZWFkOmRlbW8iLCJjcmVhdGU6ZGVtbyIsInVwZGF0ZTpkZW1vIl19.0VHdyp1w9PPFVI0FPheAwuKZwb5C25rwP-LPMXcSNoRmouvga1DZtNLA67ZzE_sAlc_VpaDRr6daLKr_Alw4347mw9sdjP8wKR27kCZa9JZK5PGQMmXHscATbzBEJYpCPklfyGaajgymqTBGnedcv8F0UvlRzQPsFeRPnVoX7BWOSXpMbyToGiXWkQLBQT7r96KAmLZOPJFZspPtjw-wH2mSL2WNa_nkB4j5vMGhGxlKiNRsKb30TH_WAel2hsxNlcPK3XHCmrMTYsNnu7HNqOTMn2i0__0rvBrhSWEw-_grqQDmWFJuWd7Qhi1q81AaJcdqgoSa_efz93QFclJUNw\",\n \"scope\": \"read:demo create:demo update:demo\",\n \"expires_in\": 90,\n \"token_type\": \"Bearer\"\n },\n \"meta\": {\n \"date_time\": \"2022-06-24T19:09:42.963Z\",\n \"name\": \"v1.tokens.authorize\",\n \"uuid\": \"ee6f9feb-dcf8-4421-a6fd-efd6beabdaa9\",\n \"start_timestamp\": 1656097782509,\n \"end_timestamp\": 1656097782963,\n \"execution_time\": 454\n }\n }\n ```\nLooking at this Response, you will see:\n * `access_token`: contains the JWT Access Token string you will use as your Bearer token.\n * `scope`: contains the scopes that this Access Token gives you permissions to access.\n * `expires_in`: contains the length of time before this Access Token will expire, in seconds.\n * `token_type`: verifies that this Access Token should be used as a Bearer token.\n\n## How to use an Access Token after one is generated?\nOnce a new Access Token is obtained, it is used in each call to a DTN API endpoint as a Bearer token in an Authorization Request Header. For example:\n ```\n Header: 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InpfX21pZW13NGhoTmdvQWQxR3N6ciJ9.eyJodHRwczovL2F1dGguZHRuLmNvbS9jdXN0b21lcklkIjoiMTIzNDU2Nzg5MERlbW8iLCJodHRwczovL2F1dGguZHRuLmNvbS9wcm9kdWN0Q29kZSI6IkRlbW9BcGlQIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcmVxdWVzdGVySXAiOiIxOC4yMTMuMTc0LjI3IiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcnBzIjoiMTAwIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vdGllciI6IkJhc2ljIiwiaHR0cHM6Ly9hdXRoLmR0bi5jb20vcXVvdGEiOiI5OTk5OTkiLCJpc3MiOiJodHRwczovL2lkLmF1dGguZHRuLmNvbS8iLCJzdWIiOiJuZnlPM0tpS1BSOE4wREtSNUNMOGpTOUdGQkNEZXlGTUBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9kZW1vLWFwaS5hdXRoLmR0bi5jb20vIiwiaWF0IjoxNjU2MDk5MDY4LCJleHAiOjE2NTYwOTkxNTgsImF6cCI6Im5meU8zS2lLUFI4TjBES1I1Q0w4alM5R0ZCQ0RleUZNIiwic2NvcGUiOiJyZWFkOmRlbW8gY3JlYXRlOmRlbW8gdXBkYXRlOmRlbW8iLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJwZXJtaXNzaW9ucyI6WyJyZWFkOmRlbW8iLCJjcmVhdGU6ZGVtbyIsInVwZGF0ZTpkZW1vIl19.0VHdyp1w9PPFVI0FPheAwuKZwb5C25rwP-LPMXcSNoRmouvga1DZtNLA67ZzE_sAlc_VpaDRr6daLKr_Alw4347mw9sdjP8wKR27kCZa9JZK5PGQMmXHscATbzBEJYpCPklfyGaajgymqTBGnedcv8F0UvlRzQPsFeRPnVoX7BWOSXpMbyToGiXWkQLBQT7r96KAmLZOPJFZspPtjw-wH2mSL2WNa_nkB4j5vMGhGxlKiNRsKb30TH_WAel2hsxNlcPK3XHCmrMTYsNnu7HNqOTMn2i0__0rvBrhSWEw-_grqQDmWFJuWd7Qhi1q81AaJcdqgoSa_efz93QFclJUNw'\n ```\n\n## Deconstructing the Access Token\nA DTN Access Token carries information within its JWT Body that is available on every API call. By deconstructing the JWT token, our Access Tokens will resemble:\n ```\n {\n \"https://auth.dtn.com/customerId\": \"1234567890Demo\",\n \"https://auth.dtn.com/productCode\": \"DemoApiP\",\n \"https://auth.dtn.com/requesterIp\": \"18.213.174.27\",\n \"https://auth.dtn.com/rps\": \"100\",\n \"https://auth.dtn.com/tier\": \"Basic\",\n \"https://auth.dtn.com/quota\": \"999999\",\n \"iss\": \"https://id.auth.dtn.com/\",\n \"sub\": \"nfyO3KiKPR8N0DKR5CL8jS9GFBCDeyFM@clients\",\n \"aud\": \"https://demo-api.auth.dtn.com/\",\n \"iat\": 1656099068,\n \"exp\": 1656099158,\n \"azp\": \"nfyO3KiKPR8N0DKR5CL8jS9GFBCDeyFM\",\n \"scope\": \"read:demo create:demo update:demo\",\n \"gty\": \"client-credentials\",\n \"permissions\": [\n \"read:demo\",\n \"create:demo\",\n \"update:demo\"\n ]\n }\n ```\n### Description of Claims\n\n | Claim | Type | Description |\n | -----------------------------------| --------------------------------------------| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n | `https://auth.dtn.com/customerId` | String | Custom DTN claim containing the Customer ID found in the DTN Order Management/Salesforce system associated with this token. |\n | `https://auth.dtn.com/productCode` | String | Custom DTN claim containing the Identity product code associated with this token. |\n | `https://auth.dtn.com/requesterIp` | String | Custom DTN claim containing the IP address of the requesting client. |\n | `https://auth.dtn.com/rps` | String | Custom DTN claim containing the maximum rate per second this customer is authorized to utilize. |\n | `https://auth.dtn.com/tier` | String | Custom DTN claim containing the data tier the customer purchased for the requested access. |\n | `https://auth.dtn.com/quota` | String | Custom DTN claim containing the maximum yearly quota the customer purchased for calling DTN endpoints for the specific product. |\n | `iss` | String (URI) | The Security Token Service (STS) that issues and returns the token. If this value is not from `https://id.auth.dtn.com/`, the token should not be considered trusted. |\n | `sub` | String (URI) | The principle about which the token asserts information (the User ID or Client ID within the Identity Provider). A User ID will start with a prefix of `auth0\\|`, while the Client ID will end with the suffix `@clients`. |\n | `aud` | String \\| Array (Strings) (URI \\| [URI, …]) | Identifies the intended recipient(s) of the token – its audience. The token should be rejected if the audience does not contain values expected by the calling application. |\n | `iat` | Number (Timestamp) | “Issued At” indicates when the authentication for this token occurred. |\n | `exp` | Number (Timestamp) | The “expiration time” on or after which the JWT must not be accepted for processing. |\n | `azp` | String | The application/client ID of the client using the token. The application can cat as itself or on behalf of a user. |\n | `gty` | String (Space-delimited) | The grant type that was used to request the token – not an RFC 7519 registered claim (Auth0-specific). |\n | `permissions` | Array (Strings) | The grant type that was used to request the token – not an RFC 7519 registered claim (Auth0-specific). |\n\n "