{"items":[{"type":"link","label":"Metadata API","link":"/reference/metadata.v1","routeSlug":"/reference/metadata.v1","content":{"contentType":"overview","meta":{"name":"Metadata API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"metadata.v1.json","url":"/_bundle/reference/metadata.v1.json?download"},{"kind":"download","label":"metadata.v1.yaml","url":"/_bundle/reference/metadata.v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://support.tidepool.org/","url":"https://support.tidepool.org/"},{"kind":"email","title":"API Support","email":"support@tidepool.org","label":"support@tidepool.org","withCopyButton":true,"copyContent":"support@tidepool.org"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"BSD-2-Clause","url":"https://github.com/tidepool-org/seagull/blob/master/LICENSE"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/reference/metadata.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Metadata API (1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/quick-start"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}]}],"sectionId":"/reference/metadata.v1"}],"sectionId":"/reference/metadata.v1"}]}]}},{"type":"group","label":"Internal","link":"/reference/metadata.v1/internal","routeSlug":"/reference/metadata.v1/internal","items":[{"label":"Get User's Private Metadata Item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metadata.v1/internal/getuserprivatemetadataitem","routeSlug":"/reference/metadata.v1/internal/getuserprivatemetadataitem","metadata":{"seo":{"title":"Get User's Private Metadata Item","description":"Returns the named item from the user's private metadata collection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetUserPrivateMetadataItem","name":"Get User's Private Metadata Item","isWebhook":false,"pointer":"/paths/~1metadata~1{userId}~1private~1{fieldName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get User's Private Metadata Item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the named item from the user's private metadata collection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"serverToken","scopes":[],"type":"apiKey","in":"header","paramName":"X-Tidepool-Session-Token","description":"Tidepool Server Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_170","description":"Tidepool User ID","required":true},{"name":"fieldName","in":"path","schemaId":"schema_171","description":"Metadata Field Name","required":true}],"pointer":"/paths/~1metadata~1{userId}~1private~1{fieldName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/metadata/{userId}/private/{fieldName}","servers":[{"url":"/_mock/reference/metadata.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"},{"name":"fieldName","in":"path","required":true,"schemaId":"schema_171"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"serverToken","type":"apiKey","name":"X-Tidepool-Session-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/metadata/{userId}/private/{fieldName}","href":"internal/getuserprivatemetadataitem","openApiOperationId":"GetUserPrivateMetadataItem","summary":"Get User's Private Metadata Item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/metadata.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200"}],"pointer":"/paths/~1metadata~1{userId}~1private~1{fieldName}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal/getuserprivatemetadataitem"}],"panels":[]}]},"httpPath":"/metadata/{userId}/private/{fieldName}"}],"content":{"contentType":"group","meta":{"name":"Internal"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Internal","showPageActions":true},{"nodeType":"markdoc","content":"APIs intended for internal use by Tidepool."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/metadata/{userId}/private/{fieldName}","summary":"Get User's Private Metadata Item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/internal/getuserprivatemetadataitem","deprecated":false}]}]}]}]}},{"type":"group","label":"Metadata","link":"/reference/metadata.v1/metadata","routeSlug":"/reference/metadata.v1/metadata","items":[{"label":"Get Metadata Collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metadata.v1/metadata/getmetadatacollections","routeSlug":"/reference/metadata.v1/metadata/getmetadatacollections","metadata":{"seo":{"title":"Get Metadata Collections","description":"Returns list of valid metadata collections."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetMetadataCollections","name":"Get Metadata Collections","isWebhook":false,"pointer":"/paths/~1metadata~1collections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Metadata Collections","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of valid metadata collections."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"X-Tidepool-Session-Token","description":"Tidepool Session Token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/metadata/collections","servers":[{"url":"/_mock/reference/metadata.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"X-Tidepool-Session-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/metadata/collections","href":"metadata/getmetadatacollections","openApiOperationId":"GetMetadataCollections","summary":"Get Metadata Collections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/metadata.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collectionnames.v1"}},"schemaId":"components/schemas/collectionnames.v1"}],"pointer":"/paths/~1metadata~1collections/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collectionnames.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collectionnames.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metadata/getmetadatacollections"}],"panels":[]}]},"httpPath":"/metadata/collections"},{"label":"Get User Metadata Collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metadata.v1/metadata/getusermetadatacollection","routeSlug":"/reference/metadata.v1/metadata/getusermetadatacollection","metadata":{"seo":{"title":"Get User Metadata Collection","description":"Returns the user's metadata collection corresponding to collectionName. Each metadata collection is an unbounded JSON object with client-defined fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetUserMetadataCollection","name":"Get User Metadata Collection","isWebhook":false,"pointer":"/paths/~1metadata~1{userId}~1{collectionName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get User Metadata Collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the user's metadata collection corresponding to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collectionName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each metadata collection is an unbounded JSON object with client-defined fields."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"X-Tidepool-Session-Token","description":"Tidepool Session Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_170","description":"Tidepool User ID","required":true},{"name":"collectionName","in":"path","schemaId":"schema_172","description":"Metadata Collection Name","required":true}],"pointer":"/paths/~1metadata~1{userId}~1{collectionName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/metadata/{userId}/{collectionName}","servers":[{"url":"/_mock/reference/metadata.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"},{"name":"collectionName","in":"path","required":true,"example":"profile","schemaId":"components/schemas/collectionname.v1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"X-Tidepool-Session-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/metadata/{userId}/{collectionName}","href":"metadata/getusermetadatacollection","openApiOperationId":"GetUserMetadataCollection","summary":"Get User Metadata Collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/metadata.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection.v1"}},"schemaId":"components/schemas/collection.v1"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1metadata~1{userId}~1{collectionName}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection.v1"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metadata/getusermetadatacollection"}],"panels":[]}]},"httpPath":"/metadata/{userId}/{collectionName}"},{"label":"Update User Metadata Collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metadata.v1/metadata/updateusermetadatacollectionpost","routeSlug":"/reference/metadata.v1/metadata/updateusermetadatacollectionpost","metadata":{"seo":{"title":"Update User Metadata Collection","description":"Updates the user's metadata collection corresponding to collectionName. Each metadata collection is an unbounded JSON object with client-defined fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateUserMetadataCollectionPost","name":"Update User Metadata Collection","isWebhook":false,"pointer":"/paths/~1metadata~1{userId}~1{collectionName}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update User Metadata Collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the user's metadata collection corresponding to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collectionName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each metadata collection is an unbounded JSON object with client-defined fields."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"X-Tidepool-Session-Token","description":"Tidepool Session Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_170","description":"Tidepool User ID","required":true},{"name":"collectionName","in":"path","schemaId":"schema_172","description":"Metadata Collection Name","required":true}],"pointer":"/paths/~1metadata~1{userId}~1{collectionName}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/collection.v1"}},"schemaId":"components/schemas/collection.v1","pointer":"/paths/~1metadata~1{userId}~1{collectionName}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/metadata/{userId}/{collectionName}","servers":[{"url":"/_mock/reference/metadata.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"},{"name":"collectionName","in":"path","required":true,"example":"profile","schemaId":"components/schemas/collectionname.v1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"X-Tidepool-Session-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/collection.v1"}},"responseCodes":["200","401","404"],"pointer":"/metadata/{userId}/{collectionName}","href":"metadata/updateusermetadatacollectionpost","openApiOperationId":"UpdateUserMetadataCollectionPost","summary":"Update User Metadata Collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/metadata.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/collection.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/collection.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection.v1"}},"schemaId":"components/schemas/collection.v1"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1metadata~1{userId}~1{collectionName}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection.v1"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metadata/updateusermetadatacollectionpost"}],"panels":[]}]},"httpPath":"/metadata/{userId}/{collectionName}"},{"label":"Update User Metadata Collection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metadata.v1/metadata/updateusermetadatacollectionput","routeSlug":"/reference/metadata.v1/metadata/updateusermetadatacollectionput","metadata":{"seo":{"title":"Update User Metadata Collection","description":"Updates the user's metadata collection corresponding to collectionName. Each metadata collection is an unbounded JSON object with client-defined fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateUserMetadataCollectionPut","name":"Update User Metadata Collection","isWebhook":false,"pointer":"/paths/~1metadata~1{userId}~1{collectionName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update User Metadata Collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the user's metadata collection corresponding to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collectionName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each metadata collection is an unbounded JSON object with client-defined fields."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"X-Tidepool-Session-Token","description":"Tidepool Session Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_170","description":"Tidepool User ID","required":true},{"name":"collectionName","in":"path","schemaId":"schema_172","description":"Metadata Collection Name","required":true}],"pointer":"/paths/~1metadata~1{userId}~1{collectionName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/collection.v1"}},"schemaId":"components/schemas/collection.v1","pointer":"/paths/~1metadata~1{userId}~1{collectionName}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/metadata/{userId}/{collectionName}","servers":[{"url":"/_mock/reference/metadata.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"},{"name":"collectionName","in":"path","required":true,"example":"profile","schemaId":"components/schemas/collectionname.v1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"X-Tidepool-Session-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/collection.v1"}},"responseCodes":["200","401","404"],"pointer":"/metadata/{userId}/{collectionName}","href":"metadata/updateusermetadatacollectionput","openApiOperationId":"UpdateUserMetadataCollectionPut","summary":"Update User Metadata Collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/metadata.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/collection.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/collection.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection.v1"}},"schemaId":"components/schemas/collection.v1"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1metadata~1{userId}~1{collectionName}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection.v1"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metadata/updateusermetadatacollectionput"}],"panels":[]}]},"httpPath":"/metadata/{userId}/{collectionName}"},{"label":"Get User's Private Metadata Item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metadata.v1/metadata/getuserprivatemetadataitem","routeSlug":"/reference/metadata.v1/metadata/getuserprivatemetadataitem","metadata":{"seo":{"title":"Get User's Private Metadata Item","description":"Returns the named item from the user's private metadata collection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetUserPrivateMetadataItem","name":"Get User's Private Metadata Item","isWebhook":false,"pointer":"/paths/~1metadata~1{userId}~1private~1{fieldName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get User's Private Metadata Item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the named item from the user's private metadata collection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"serverToken","scopes":[],"type":"apiKey","in":"header","paramName":"X-Tidepool-Session-Token","description":"Tidepool Server Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_170","description":"Tidepool User ID","required":true},{"name":"fieldName","in":"path","schemaId":"schema_171","description":"Metadata Field Name","required":true}],"pointer":"/paths/~1metadata~1{userId}~1private~1{fieldName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/metadata/{userId}/private/{fieldName}","servers":[{"url":"/_mock/reference/metadata.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"},{"name":"fieldName","in":"path","required":true,"schemaId":"schema_171"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"serverToken","type":"apiKey","name":"X-Tidepool-Session-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/metadata/{userId}/private/{fieldName}","href":"metadata/getuserprivatemetadataitem","openApiOperationId":"GetUserPrivateMetadataItem","summary":"Get User's Private Metadata Item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/metadata.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200"}],"pointer":"/paths/~1metadata~1{userId}~1private~1{fieldName}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metadata/getuserprivatemetadataitem"}],"panels":[]}]},"httpPath":"/metadata/{userId}/private/{fieldName}"},{"label":"List Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metadata.v1/metadata/listusers","routeSlug":"/reference/metadata.v1/metadata/listusers","metadata":{"seo":{"title":"List Users","description":"List all users who have trustee or trustor access to the user account identified by userId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListUsers","name":"List Users","isWebhook":false,"pointer":"/paths/~1metadata~1users~1{userId}~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all users who have trustee or trustor access to the user account identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"X-Tidepool-Session-Token","description":"Tidepool Session Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_170","description":"Tidepool User ID","required":true}],"pointer":"/paths/~1metadata~1users~1{userId}~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/metadata/users/{userId}/users","servers":[{"url":"/_mock/reference/metadata.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepooluserid"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"X-Tidepool-Session-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/metadata/users/{userId}/users","href":"metadata/listusers","openApiOperationId":"ListUsers","summary":"List Users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/metadata.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/trustusers.v1"}},"schemaId":"components/schemas/trustusers.v1"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1metadata~1users~1{userId}~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/trustusers.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/trustusers.v1"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/metadata/listusers"}],"panels":[]}]},"httpPath":"/metadata/users/{userId}/users"}],"content":{"contentType":"group","meta":{"name":"Metadata"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Metadata","showPageActions":true},{"nodeType":"markdoc","content":"Create and update user metadata."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/metadata/collections","summary":"Get Metadata Collections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/metadata/getmetadatacollections","deprecated":false},{"title":"/metadata/{userId}/{collectionName}","summary":"Get User Metadata Collection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/metadata/getusermetadatacollection","deprecated":false},{"title":"/metadata/{userId}/{collectionName}","summary":"Update User Metadata Collection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/metadata/updateusermetadatacollectionpost","deprecated":false},{"title":"/metadata/{userId}/{collectionName}","summary":"Update User Metadata Collection","prefix":{"name":"put","color":"put"},"badges":[],"link":"/metadata/updateusermetadatacollectionput","deprecated":false},{"title":"/metadata/{userId}/private/{fieldName}","summary":"Get User's Private Metadata Item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/metadata/getuserprivatemetadataitem","deprecated":false},{"title":"/metadata/users/{userId}/users","summary":"List Users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/metadata/listusers","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/collectionname.v1":{"id":"components/schemas/collectionname.v1","kind":"json-schema","title":"Metadata Collection Name","data":{"title":"Metadata Collection Name","type":"string","enum":["profile","preferences","settings","groups","private"],"example":"profile"}},"components/schemas/collectionnames.v1":{"id":"components/schemas/collectionnames.v1","kind":"json-schema","title":"Metadata Collection Names","data":{"title":"Metadata Collection Names","type":"array","items":{"$ref":"#/components/schemas/collectionname.v1"},"example":["profile","groups","private"]}},"components/schemas/tidepooluserid":{"id":"components/schemas/tidepooluserid","kind":"json-schema","title":"Tidepool User ID","data":{"type":"string","title":"Tidepool User ID","pattern":"^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID v4"},"children":[]}]}]}]}],"readOnly":true,"x-go-type":"string"}},"components/schemas/fullname.v1":{"id":"components/schemas/fullname.v1","kind":"json-schema","title":"Full Name","data":{"title":"Full Name","type":"string","example":"James Jellyfish"}},"components/schemas/diagnosisType.v1":{"id":"components/schemas/diagnosisType.v1","kind":"json-schema","title":"Diagnosis Type","data":{"title":"Diagnosis Type","type":"string","enum":["type1","type2","type3c","gestational","prediabetes","lada","mody","other","notApplicable",""],"example":"type1"}},"components/schemas/diagnosisdate.v1":{"id":"components/schemas/diagnosisdate.v1","kind":"json-schema","title":"Diagnosis Date","data":{"title":"Diagnosis Date","type":"string","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","example":"2013-05-09","x-go-type":"string"}},"components/schemas/birthday.v1":{"id":"components/schemas/birthday.v1","kind":"json-schema","title":"Birthday","data":{"title":"Birthday","type":"string","format":"date","example":"2012-08-30","x-go-type":"string"}},"components/schemas/biologicalsex.v1":{"id":"components/schemas/biologicalsex.v1","kind":"json-schema","title":"Biological Sex","data":{"title":"Biological Sex","type":"string","enum":["male","female"],"example":"male"}},"components/schemas/targetdevices.v1":{"id":"components/schemas/targetdevices.v1","kind":"json-schema","title":"Target Devices","data":{"title":"Target Devices","description":"When uploading data, the user selects a target device (typically\nmake and model) of their data source (i.e. meter or pump) from a\nlist. This selection is used by the Tidepool Uploader to select the\ncorrect drivers for communicating with the data source.\n\nThese values are stored in the user's profile so that they can be\npre-selected on next use, thereby streamlining the process.\n","type":"array","items":{"type":"string","example":"bayercontournext"}}},"components/schemas/targettimezone.v1":{"id":"components/schemas/targettimezone.v1","kind":"json-schema","title":"Target Time Zone","data":{"title":"Target Time Zone","type":"string","example":"US/Eastern"}},"components/schemas/about.v1":{"id":"components/schemas/about.v1","kind":"json-schema","title":"About Me","data":{"title":"About Me","type":"string","example":"Jellyman is awesome!"}},"components/schemas/userprofile.v1":{"id":"components/schemas/userprofile.v1","kind":"json-schema","title":"User Profile","data":{"title":"User Profile","description":"User profile used by Tidepool Web","type":"object","properties":{"fullName":{"$ref":"#/components/schemas/fullname.v1"},"patient":{"type":"object","properties":{"diagnosisType":{"$ref":"#/components/schemas/diagnosisType.v1"},"diagnosisDate":{"$ref":"#/components/schemas/diagnosisdate.v1"},"birthday":{"$ref":"#/components/schemas/birthday.v1"},"biologicalSex":{"$ref":"#/components/schemas/biologicalsex.v1"},"targetDevices":{"$ref":"#/components/schemas/targetdevices.v1"},"targetTimezone":{"$ref":"#/components/schemas/targettimezone.v1"},"about":{"$ref":"#/components/schemas/about.v1"}}}}}},"components/schemas/clinicname.v1":{"id":"components/schemas/clinicname.v1","kind":"json-schema","title":"Clinic Name","data":{"title":"Clinic Name","type":"string","example":"ACME Endocrinology"}},"components/schemas/clinicianrole.v1":{"id":"components/schemas/clinicianrole.v1","kind":"json-schema","title":"clinicianrole.v1","data":{"type":"string","enum":["clinic_manager","diabetes_educator","endocrinologist","front_desk","information_technology","medical_assistant","nurse","primary_care_physician","physician_assistant","other"],"example":"clinic_manager"}},"components/schemas/phonenumber.v1":{"id":"components/schemas/phonenumber.v1","kind":"json-schema","title":"Phone Number","data":{"title":"Phone Number","type":"string","example":"+1 (800) 555-1212"}},"components/schemas/clinicianprofile.v1":{"id":"components/schemas/clinicianprofile.v1","kind":"json-schema","title":"Clinician Profile","data":{"title":"Clinician Profile","description":"Clinician profile used by Tidepool Web","type":"object","properties":{"fullName":{"$ref":"#/components/schemas/fullname.v1"},"clinic":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/clinicname.v1"},"role":{"$ref":"#/components/schemas/clinicianrole.v1"},"telephone":{"$ref":"#/components/schemas/phonenumber.v1"}}}}}},"components/schemas/emailaddress.v1":{"id":"components/schemas/emailaddress.v1","kind":"json-schema","title":"Email Address","data":{"title":"Email Address","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An email address, as specified by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc5322"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 5322"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","format":"email","minLength":6,"example":"example@tidepool.org","x-go-type":"string"}},"components/schemas/mrn.v1":{"id":"components/schemas/mrn.v1","kind":"json-schema","title":"Medical Record Number (MRN)","data":{"title":"Medical Record Number (MRN)","type":"string","example":"123456"}},"components/schemas/emailaddresses.v1":{"id":"components/schemas/emailaddresses.v1","kind":"json-schema","title":"User Email Addresses","data":{"title":"User Email Addresses","type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/emailaddress.v1"},"minItems":1}},"components/schemas/patientprofile.v1":{"id":"components/schemas/patientprofile.v1","kind":"json-schema","title":"Patient Profile","data":{"title":"Patient Profile","description":"Patient profile used by Tidepool Web","type":"object","properties":{"fullName":{"$ref":"#/components/schemas/fullname.v1"},"patient":{"type":"object","properties":{"birthday":{"$ref":"#/components/schemas/birthday.v1"},"email":{"$ref":"#/components/schemas/emailaddress.v1"},"mrn":{"$ref":"#/components/schemas/mrn.v1"},"targetDevices":{"$ref":"#/components/schemas/targetdevices.v1"},"targetTimezone":{"$ref":"#/components/schemas/targettimezone.v1"}}},"emails":{"$ref":"#/components/schemas/emailaddresses.v1"}}}},"components/schemas/profile.v1":{"id":"components/schemas/profile.v1","kind":"json-schema","title":"Profile","data":{"title":"Profile","description":"Profiles used by Tidepool Web","type":"object","anyOf":[{"$ref":"#/components/schemas/userprofile.v1"},{"$ref":"#/components/schemas/clinicianprofile.v1"},{"$ref":"#/components/schemas/patientprofile.v1"}]}},"components/schemas/datetime.v1":{"id":"components/schemas/datetime.v1","kind":"json-schema","title":"Date/Time","data":{"title":"Date/Time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.ietf.org/rfc/rfc3339.txt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 3339"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-8601-date-and-time-format.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timezone information"},"children":[]}]}]}],"type":"string","format":"date-time","example":"2017-02-06T02:37:46Z","x-go-type":"string"}},"components/schemas/preferences.v1":{"id":"components/schemas/preferences.v1","kind":"json-schema","title":"User Preferences","data":{"title":"User Preferences","description":"User preferences collection used by Tidepool Web","type":"object","properties":{"dismissedDexcomConnectBannerTime":{"$ref":"#/components/schemas/datetime.v1"}},"additionalProperties":true}},"components/schemas/settings.v1":{"id":"components/schemas/settings.v1","kind":"json-schema","title":"User Settings","data":{"title":"User Settings","description":"User settings used by Tidepool Web","type":"object","properties":{"bgTarget":{"type":"object","properties":{"low":{"type":"number","example":65},"high":{"type":"number","example":180}}}}}},"components/schemas/private.v1":{"id":"components/schemas/private.v1","kind":"json-schema","title":"Private Collection","data":{"title":"Private Collection","description":"Private collection used by Tidepool Platform","type":"object","properties":{"uploads":{"type":"object","properties":{"name":{"type":"string","example":""},"id":{"$ref":"#/components/schemas/tidepooluserid"},"hash":{"type":"string","example":"27dc848b6ca43eb92add9d4d"}}}}}},"components/schemas/collection.v1":{"id":"components/schemas/collection.v1","kind":"json-schema","title":"Metadata Collection","data":{"title":"Metadata Collection","type":"object","anyOf":[{"$ref":"#/components/schemas/profile.v1"},{"$ref":"#/components/schemas/preferences.v1"},{"$ref":"#/components/schemas/settings.v1"},{"$ref":"#/components/schemas/private.v1"}]}},"components/schemas/emailverified.v1":{"id":"components/schemas/emailverified.v1","kind":"json-schema","title":"User Email Verification Status","data":{"title":"User Email Verification Status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the user has verified their email address. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or not present if the user has not verified their email address."},"children":[]}]}]}],"type":"boolean","example":true}},"components/schemas/role.v1":{"id":"components/schemas/role.v1","kind":"json-schema","title":"User Role","data":{"title":"User Role","type":"string","enum":["clinic"],"example":"clinic"}},"components/schemas/roles.v1":{"id":"components/schemas/roles.v1","kind":"json-schema","title":"User Roles","data":{"title":"User Roles","type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/role.v1"},"minItems":0}},"components/schemas/user.v1":{"id":"components/schemas/user.v1","kind":"json-schema","title":"User","data":{"title":"User","type":"object","properties":{"emailVerified":{"$ref":"#/components/schemas/emailverified.v1"},"emails":{"$ref":"#/components/schemas/emailaddresses.v1"},"termsAccepted":{"$ref":"#/components/schemas/datetime.v1"},"roles":{"$ref":"#/components/schemas/roles.v1"},"userid":{"$ref":"#/components/schemas/tidepooluserid"},"username":{"$ref":"#/components/schemas/emailaddress.v1"},"profile":{"$ref":"#/components/schemas/profile.v1"}},"required":["userid"]}},"components/schemas/permission.v1":{"id":"components/schemas/permission.v1","kind":"json-schema","title":"Permission","data":{"title":"Permission","description":"The presence of this object indicates that the user has been granted the named permission.","type":"object","example":{}}},"components/schemas/owner.v1":{"id":"components/schemas/owner.v1","kind":"json-schema","title":"Owner","data":{"title":"Owner","description":"Full account owner access permission.","type":"object","properties":{"root":{"$ref":"#/components/schemas/permission.v1"}},"example":{"root":{}}}},"components/schemas/custodian.v1":{"id":"components/schemas/custodian.v1","kind":"json-schema","title":"Custodian","data":{"title":"Custodian","description":"Full custodial permission.","type":"object","properties":{"custodian":{"$ref":"#/components/schemas/permission.v1"}},"example":{"custodian":{}}}},"components/schemas/view.v1":{"id":"components/schemas/view.v1","kind":"json-schema","title":"View","data":{"title":"View","description":"Permission to view diabetes data in the account.","type":"object","properties":{"view":{"$ref":"#/components/schemas/permission.v1"}},"example":{"view":{}}}},"components/schemas/note.v1":{"id":"components/schemas/note.v1","kind":"json-schema","title":"Notes","data":{"title":"Notes","description":"Permission to view and manage notes in the account.","type":"object","properties":{"note":{"$ref":"#/components/schemas/permission.v1"}},"example":{"note":{}}}},"components/schemas/upload.v1":{"id":"components/schemas/upload.v1","kind":"json-schema","title":"Upload","data":{"title":"Upload","description":"Permission to upload diabetes data to the account.","type":"object","properties":{"upload":{"$ref":"#/components/schemas/permission.v1"}},"example":{"upload":{}}}},"components/schemas/userpermissions.v1":{"id":"components/schemas/userpermissions.v1","kind":"json-schema","title":"User Permissions","data":{"title":"User Permissions","description":"Access permissions granted to a single user.","type":"object","anyOf":[{"$ref":"#/components/schemas/owner.v1"},{"$ref":"#/components/schemas/custodian.v1"},{"$ref":"#/components/schemas/view.v1"},{"$ref":"#/components/schemas/note.v1"},{"$ref":"#/components/schemas/upload.v1"}],"minProperties":1}},"components/schemas/trusteeuser.v1":{"id":"components/schemas/trusteeuser.v1","kind":"json-schema","title":"Trustee User","data":{"title":"Trustee User","type":"object","allOf":[{"$ref":"#/components/schemas/user.v1"},{"type":"object","properties":{"trusteePermissions":{"$ref":"#/components/schemas/userpermissions.v1"}}}],"required":["trusteePermissions"]}},"components/schemas/trustoruser.v1":{"id":"components/schemas/trustoruser.v1","kind":"json-schema","title":"Trustor User","data":{"title":"Trustor User","type":"object","allOf":[{"$ref":"#/components/schemas/user.v1"},{"type":"object","properties":{"trustorPermissions":{"$ref":"#/components/schemas/userpermissions.v1"}}}],"required":["trustorPermissions"]}},"components/schemas/trustusers.v1":{"id":"components/schemas/trustusers.v1","kind":"json-schema","title":"Trustee and Trustor Users","data":{"title":"Trustee and Trustor Users","type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/trusteeuser.v1"},{"$ref":"#/components/schemas/trustoruser.v1"}]}}},"schema_170":{"kind":"json-schema","data":{"$ref":"#/components/schemas/tidepooluserid"},"id":"schema_170"},"schema_171":{"kind":"json-schema","data":{"type":"string"},"id":"schema_171"},"schema_172":{"kind":"json-schema","data":{"$ref":"#/components/schemas/collectionname.v1"},"id":"schema_172"}},"exampleStore":{},"securitySchemeStore":{"sessionToken":{"id":"sessionToken","type":"apiKey","description":"Tidepool Session Token","in":"header","paramName":"X-Tidepool-Session-Token"},"serverToken":{"id":"serverToken","type":"apiKey","description":"Tidepool Server Token","in":"header","paramName":"X-Tidepool-Session-Token"}},"servers":[{"url":"/_mock/reference/metadata.v1","isMockServer":true,"description":"Mock server"},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}]},"options":{"hideInfoMetadata":true,"hideSidebar":true,"mockServer":{"url":"/_mock/reference/metadata.v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/reference/metadata.v1.json?download"},{"url":"/_bundle/reference/metadata.v1.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Metadata API","description":"The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform.\n\nFor more information, see the [Getting Started](../docs/quick-start.md) section."}},"baseSlug":"/reference/metadata.v1","routesMapping":{}}