{"openapi":"3.0.2","info":{"title":"Agency Bulletin API","description":"DTN Agency Bulletin API","version":"1.0"},"paths":{"/v2/alerts":{"get":{"tags":["alerts"],"summary":"Get Alerts","operationId":"get_alerts_v2_alerts_get","parameters":[{"description":"Specify the country code of the alerts request. This is a required parameter. The reference for acceptable values is ISO 3166 two-letter codes (alpha-2). example: US","required":false,"schema":{"title":"Country","type":"string","description":"Specify the country code of the alerts request. This is a required parameter. The reference for acceptable values is ISO 3166 two-letter codes (alpha-2). example: US"},"name":"country","in":"query"},{"description":"Specify the language the language to use in the text values of the alert. Values should follow RFC 3066. example: en-US","required":false,"schema":{"title":"Language","type":"string","description":"Specify the language the language to use in the text values of the alert. Values should follow RFC 3066. example: en-US","default":"en-US"},"name":"language","in":"query"},{"description":"Specify the source of the alerts request. example: NWS","required":false,"schema":{"title":"Sender","type":"string","description":"Specify the source of the alerts request. example: NWS"},"name":"sender","in":"query"},{"description":"When specified, the API will return only alerts that match the specified event types. example: Flood Warning","required":false,"schema":{"title":"Event","type":"array","items":{"type":"string"},"description":"When specified, the API will return only alerts that match the specified event types. example: Flood Warning"},"name":"event","in":"query"},{"description":"Specify the date and time alerts are sent. When set, all alerts sent from this timestamp are returned. ISO8601 date-time format specified int RFC 3339. example: 2022-11-25T00:00:00","required":false,"schema":{"title":"Starttime","type":"string","description":"Specify the date and time alerts are sent. When set, all alerts sent from this timestamp are returned. ISO8601 date-time format specified int RFC 3339. example: 2022-11-25T00:00:00","format":"date-time"},"name":"startTime","in":"query"},{"description":"Specify the date and time alerts are sent. When set, all alerts sent until this timestamp are returned. ISO8601 date-time format specified int RFC 3339. example: 2022-11-26T00:00:00","required":false,"schema":{"title":"Endtime","type":"string","description":"Specify the date and time alerts are sent. When set, all alerts sent until this timestamp are returned. ISO8601 date-time format specified int RFC 3339. example: 2022-11-26T00:00:00","format":"date-time"},"name":"endTime","in":"query"},{"description":"Specify whether or not to include the geojson geometry for each alert.","required":false,"schema":{"title":"Excludegeometry","type":"boolean","description":"Specify whether or not to include the geojson geometry for each alert.","default":false},"name":"excludeGeometry","in":"query"},{"description":"Specify whether or not to include total number of alerts.","required":false,"schema":{"title":"Showtotal","type":"boolean","description":"Specify whether or not to include total number of alerts.","default":false},"name":"showTotal","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoJsonAlertResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"clientCredentials":[]}]}}},"components":{"schemas":{"Alert":{"title":"Alert","required":["identifier","sender","sent","status","info"],"type":"object","properties":{"identifier":{"title":"Identifier","type":"string"},"sender":{"title":"Sender","type":"string"},"sent":{"title":"Sent","type":"string","format":"date-time"},"status":{"title":"Status","type":"string"},"msgType":{"title":"Msgtype","type":"string"},"scope":{"title":"Scope","type":"string"},"code":{"title":"Code","type":"string"},"source":{"title":"Source","type":"string"},"updated":{"title":"Updated","type":"string","format":"date-time"},"restriction":{"title":"Restriction","type":"string"},"addresses":{"title":"Addresses","type":"string"},"note":{"title":"Note","type":"string"},"references":{"title":"References","type":"string"},"info":{"title":"Info","type":"array","items":{"$ref":"#/components/schemas/AlertInfo"}}}},"AlertInfo":{"title":"AlertInfo","required":["event","eventCode","category"],"type":"object","properties":{"event":{"title":"Event","type":"array","items":{"type":"string"}},"eventCode":{"title":"Eventcode","type":"array","items":{"type":"string"}},"category":{"title":"Category","type":"array","items":{"type":"string"}},"language":{"title":"Language","type":"string"},"urgency":{"title":"Urgency","type":"string"},"severity":{"title":"Severity","type":"string"},"certainty":{"title":"Certainty","type":"string"},"responseType":{"title":"Responsetype","type":"string"},"effective":{"title":"Effective","type":"string","format":"date-time"},"onset":{"title":"Onset","type":"string","format":"date-time"},"expires":{"title":"Expires","type":"string","format":"date-time"},"audience":{"title":"Audience","type":"string"},"senderName":{"title":"Sendername","type":"string"},"headline":{"title":"Headline","type":"string"},"description":{"title":"Description","type":"string"},"instruction":{"title":"Instruction","type":"string"},"web":{"title":"Web","type":"string"},"contact":{"title":"Contact","type":"string"},"parameters":{"title":"Parameters","type":"array","items":{"type":"object"}},"area":{"title":"Area","type":"array","items":{"$ref":"#/components/schemas/Area"}}}},"Area":{"title":"Area","type":"object","properties":{"areaDesc":{"title":"Areadesc","type":"string"},"polygon":{"title":"Polygon","anyOf":[{"type":"object"},{"type":"object"},{"type":"object"}]},"circle":{"title":"Circle","type":"string"},"ceiling":{"title":"Ceiling","type":"number"},"altitude":{"title":"Altitude","type":"number"},"geocodes":{"title":"Geocodes","type":"array","items":{"$ref":"#/components/schemas/GeoCode"}}}},"GeoCode":{"title":"GeoCode","type":"object","properties":{"valueName":{"title":"Valuename","type":"string"},"value":{"title":"Value"}}},"GeoJsonAlert":{"title":"GeoJsonAlert","required":["id","type","properties"],"type":"object","properties":{"id":{"title":"Id","type":"string"},"type":{"title":"Type","type":"string"},"geometry":{"title":"Geometry","anyOf":[{"type":"object"},{"type":"object"},{"type":"object"}]},"properties":{"$ref":"#/components/schemas/Alert"}}},"GeoJsonAlertResponse":{"title":"GeoJsonAlertResponse","required":["type","features"],"type":"object","properties":{"totalAlerts":{"title":"Totalalerts","type":"integer"},"type":{"title":"Type","type":"string"},"features":{"title":"Features","type":"array","items":{"$ref":"#/components/schemas/GeoJsonAlert"}}},"example":{"totalAlerts":1,"type":"FeatureCollection","features":[{"id":"nws00026c5cf2715c067c94bd54511fd9ec191295ba9e173afe718d87a0a51d19f2393","type":"Feature","geometry":{"type":"Polygon","coordinates":[[[-81.23,28.7],[-80.9,28.54],[-81,28.73],[-81.17,28.79],[-81.23,28.7]]]},"properties":{"identifier":"nws00026c5cf2715c067c94bd54511fd9ec191295ba9e173afe718d87a0a51d19f2393","sender":"NWS","sent":"2022-11-25T13:51:00","status":"ACTUAL","msgType":"Alert","scope":"Private","source":"w-nws.webmaster@noaa.gov","updated":"2022-11-25T13:51:00","info":[{"event":["Flood Warning"],"eventCode":["FLS"],"category":["MET"],"language":"en-US","urgency":"Immediate","severity":"Severe","certainty":"Observed","effective":"2022-11-25T13:51:00","onset":"2022-11-25T13:51:00","expires":"2022-11-26T02:00:00","senderName":"NWS Melbourne FL","headline":"Flood Warning issued November 25 at 8:51AM EST until November 28 at 7:00PM EST by NWS Melbourne FL","description":"* WHAT...Minor flooding is occurring and minor flooding is forecast.\n\n* WHERE...St Johns River Near Above Lake Harney.\n\n* WHEN...Until Monday evening.\n\n* IMPACTS...At 8.3 feet, Docks are partially submerged along the\nriver between Lake Harney and Lemon Bluff.\n\n* ADDITIONAL DETAILS...\n- At 7:30 AM EST Friday the stage was 8.3 feet.\n- Recent Activity...The maximum river stage in the 24 hours\nending at 7:30 AM EST Friday was 8.4 feet.\n- Forecast...The river is expected to fall below flood stage\nearly Monday afternoon and continue falling to 7.8 feet\nWednesday morning.\n- Flood stage is 8.0 feet.\n- http://www.weather.gov/safety/flood","parameters":[{"param_key":"AWIPSidentifier","param_value":"FLSMLB"},{"param_key":"WMOidentifier","param_value":"WGUS82 KMLB 251351"},{"param_key":"NWSheadline","param_value":"FLOOD WARNING NOW IN EFFECT UNTIL MONDAY EVENING"},{"param_key":"BLOCKCHANNEL","param_value":"EAS,NWEM,CMAS"},{"param_key":"EAS-ORG","param_value":"WXR"},{"param_key":"VTEC","param_value":"/O.EXT.KMLB.FL.W.0003.000000T0000Z-221129T0000Z/"},{"param_key":"eventEndingTime","param_value":"2022-11-29T00:00:00+0000"},{"param_key":"expiredReferences","param_value":"w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.a3fc04456d27d9a41e614e70e6f503a9b31ebe20.001.1,2022-11-23T10:21:00-05:00 w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.6a8e53323ced5dd36b34f6049dff34721aeb74e6.001.1,2022-11-23T20:12:00-05:00 w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.bfae95d67b4f1941292b79dbd27e52f4c6fbcb5f.001.1,2022-11-22T19:38:00-05:00 w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.c21e57585485a2ac34585dd6da4606659bd62493.001.1,2022-11-22T09:52:00-05:00 w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.bec7fddd6108731ba561b448e754e0cd095bbe1f.001.1,2022-11-21T20:22:00-05:00 w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.00fd1b7fadfc6f3db76f2d18b61f0de2d1585617.001.1,2022-11-21T09:36:00-05:00 w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.75333af8944f0670e08768c64e203fdab8057c12.001.1,2022-11-20T20:13:00-05:00 w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.9b1dd2369e8d5ab974db6a2c61a40229bcc9496e.001.1,2022-11-20T09:03:00-05:00 w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.2bd6f4c76e2abc3415dabf923ce54bce4542af2e.001.1,2022-11-19T19:43:00-05:00 w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.4f57dbae505559d453bddefae00e3735dc67ddec.001.1,2022-11-19T09:05:00-05:00 w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.5c93d06ebb91505b9c9c172f459c4a5f978bf46e.001.1,2022-11-18T19:53:00-05:00 w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.dcaa9af1f1926c0fa8d0b3029128728001c69ad8.001.1,2022-11-18T09:11:00-05:00 w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.9d763fc61fa635b0c4b9aaa82407daca86fe3417.001.1,2022-11-17T21:17:00-05:00 w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.1e6a3af654cd492908ecfd66776daaaf7a275608.001.1,2022-11-17T10:01:00-05:00 w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.19cb555f4adde185062ff06d6fd62e213e7f354a.001.1,2022-11-16T21:20:00-05:00 w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.5520ce3d44050a32c191869b2c27b27b5c07128a.001.1,2022-11-16T09:32:00-05:00 w-nws.webmaster@noaa.gov,urn:oid:2.49.0.1.840.0.3532cf36737666116e4ec6b189ec87eced0b8455.001.1,2022-11-15T21:16:"},{"param_key":"CAPversion","param_value":"1.2"},{"param_key":"originalID","param_value":"2.49.0.1.840.0.8ad3c366a051b62125985067582828c1d4434006.001.1"}],"area":[{"areaDesc":"area-746808","polygon":{"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[-81.23,28.7],[-80.9,28.54],[-81,28.73],[-81.17,28.79],[-81.23,28.7]]]},"properties":{}},"ceiling":0,"altitude":0,"geocodes":[{"valueName":"UGC","value":"FLC117"}]}]}]}}]}},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"type":"string"}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}}},"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 Alerting API, you need to use the following audience: https://weather.api.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  "}}}}