From d19952b5b8e3f539f19482084ffeb104b114a6ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20E=C3=9Flinger?= Date: Wed, 24 Jul 2024 17:31:17 +0200 Subject: [PATCH] chore: regenerate GDS UserProfile API docs to add subscriptionType (#238) --- docs/api/gds/get-user-profile.api.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/api/gds/get-user-profile.api.mdx b/docs/api/gds/get-user-profile.api.mdx index 16d2497..0c1bf39 100644 --- a/docs/api/gds/get-user-profile.api.mdx +++ b/docs/api/gds/get-user-profile.api.mdx @@ -5,7 +5,7 @@ description: "Get the profile of a user via email address." sidebar_label: "Get User Profile" hide_title: true hide_table_of_contents: true -api: {"tags":["UserProfile"],"description":"Get the profile of a user via email address.\r\n \r\nYou can use this request to check if a user has a license for an application:\r\n \r\nThe Global Discovery Service API returns information based on the set of `tapio-Applications` that are assigned to the calling `AAD-Application`. Make sure that the `AAD-Application` you are using is assigned to the `tapio-Application` you want to check licenses for in [my tapio](https://my.tapio.one).\r\n \r\nTo check if the `User` has a `License` for your `tapio-Application` you have to go through all `Licenses` of of all `Subscriptions` in the response and check if there is a `License` with the id of your `tapio-Application` (`subscriptions[].licenses[].applicationId` [JMESPath](https://jmespath.org/)).\r\n \r\n`Licenses` can expire or be unassigned from a certain `User` or `Machine`.\r\nIt is not recommended to poll the **Global Discovery Service API** and detect those changes yourself.\r\nInstead we encourage you to setup a CloudEvent endpoint and listen for `License`-related changes.","operationId":"GetUserProfile","parameters":[{"name":"email","in":"path","description":"Email address","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"text/plain":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email address","nullable":true},"subscriptions":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"User role","nullable":true},"subscriptionId":{"type":"string","description":"Subscription id","format":"uuid"},"parentSubscriptionId":{"type":"string","description":"Parent subscription id","format":"uuid","nullable":true},"name":{"type":"string","description":"Subscription name","nullable":true},"tapioId":{"type":"string","description":"Tapio id","nullable":true},"assignedMachines":{"type":"array","items":{"type":"object","properties":{"tmid":{"type":"string","description":"TapioMachineId","nullable":true},"deviceType":{"enum":["Unknown","Machine","SmartDevice"],"type":"string","description":"Device type","title":"DeviceType"},"deviceSubType":{"type":"string","description":"Device sub-type. If Device type is set to \"Machine\", Device sub-type will only contain one the following values: \"Unknown\", \"Edge\", \"Saw\", \"Cnc\", \"Sanding\", \"Drilling\", \"Assembly\", \"Storing\", \"Stock\", \"Sorting\", \"Shipping\", \"PreAssembly\", \"Lamination\", \"Moulding\", \"Packaging\", \"Handling\"","nullable":true},"displayName":{"type":"string","description":"Display name","nullable":true},"manufacturerSerialNumber":{"type":"string","description":"Serial number given to the machine by its manufacturer.","nullable":true},"onboardingDate":{"type":"string","description":"The date, when the machine has been added to the subscription","format":"date-time"},"equipmentGroup":{"type":"object","properties":{"id":{"type":"string","description":"Id of the equipment group.","nullable":true},"groupPosition":{"type":"integer","description":"Position of the machine within the group.","format":"int32"}},"additionalProperties":false,"description":"Information about a group in the context of a machine, assigned to it.","title":"EquipmentGroupMachineInfo"},"assignedApplications":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Application id","format":"uuid"}},"additionalProperties":false,"description":"Assigned application","title":"AssignedApplication"},"description":"List of assigned applications for this machine","nullable":true}},"additionalProperties":false,"description":"Machine information","title":"MachineInfo"},"description":"Assigned machines","nullable":true},"subscriptionTypes":{"type":"array","items":{"type":"string"},"description":"Subscription Types","nullable":true,"readOnly":true,"deprecated":true},"subscriptionFeatures":{"type":"array","items":{"type":"string"},"description":"Subscription Features","nullable":true},"servicePartners":{"type":"array","items":{"type":"object","properties":{"subscriptionId":{"type":"string","description":"Subscription id","format":"uuid"},"name":{"type":"string","description":"Service partner name","nullable":true},"customerNumber":{"type":"string","description":"Customer number","nullable":true},"parentSubscriptionId":{"type":"string","description":"Parent id","format":"uuid","nullable":true},"providerNo":{"type":"string","description":"Provider number","nullable":true},"servicePartnerType":{"enum":["MachineService","SharpeningService"],"type":"string","description":"Service partner type","title":"ServicePartnerType"}},"additionalProperties":false,"description":"Service partner","title":"ServicePartner"},"description":"Service partners","nullable":true},"licenses":{"type":"array","items":{"type":"object","properties":{"licenseId":{"type":"string","description":"License id","format":"uuid"},"applicationId":{"type":"string","description":"Application id","format":"uuid"},"createdDate":{"type":"string","description":"License creation date","format":"date-time"},"billingStartDate":{"type":"string","description":"Billing start date","format":"date-time"},"billingInterval":{"type":"string","description":"Billing interval","nullable":true},"licenseCount":{"type":"integer","description":"License count","format":"int32"}},"additionalProperties":false,"description":"License information","title":"LicenseInfo"},"description":"Licenses","nullable":true},"equipmentGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Equipment group id","nullable":true},"parentId":{"type":"string","description":"Id of the parent equipment group, or null if there is no parent.","nullable":true},"displayName":{"type":"string","description":"Display name","nullable":true},"groupPosition":{"type":"integer","description":"Position of the machine within the group","format":"int32"},"placesCount":{"type":"integer","description":"Number of places in the equipment group","format":"int32"},"type":{"enum":["Group","Warehouse","Root"],"type":"string","title":"GroupType"}},"additionalProperties":false,"description":"Equipment group information","title":"EquipmentGroupInfo"},"description":"Equipment groups","nullable":true},"servicePartnerType":{"enum":["MachineService","SharpeningService"],"type":"string","description":"Service partner type","title":"ServicePartnerType"}},"additionalProperties":false,"description":"Subscription information","title":"SubscriptionUserProfileInfo"},"description":"List of user profiles","nullable":true}},"additionalProperties":false,"description":"User profile","title":"UserProfile"}},"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email address","nullable":true},"subscriptions":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"User role","nullable":true},"subscriptionId":{"type":"string","description":"Subscription id","format":"uuid"},"parentSubscriptionId":{"type":"string","description":"Parent subscription id","format":"uuid","nullable":true},"name":{"type":"string","description":"Subscription name","nullable":true},"tapioId":{"type":"string","description":"Tapio id","nullable":true},"assignedMachines":{"type":"array","items":{"type":"object","properties":{"tmid":{"type":"string","description":"TapioMachineId","nullable":true},"deviceType":{"enum":["Unknown","Machine","SmartDevice"],"type":"string","description":"Device type","title":"DeviceType"},"deviceSubType":{"type":"string","description":"Device sub-type. If Device type is set to \"Machine\", Device sub-type will only contain one the following values: \"Unknown\", \"Edge\", \"Saw\", \"Cnc\", \"Sanding\", \"Drilling\", \"Assembly\", \"Storing\", \"Stock\", \"Sorting\", \"Shipping\", \"PreAssembly\", \"Lamination\", \"Moulding\", \"Packaging\", \"Handling\"","nullable":true},"displayName":{"type":"string","description":"Display name","nullable":true},"manufacturerSerialNumber":{"type":"string","description":"Serial number given to the machine by its manufacturer.","nullable":true},"onboardingDate":{"type":"string","description":"The date, when the machine has been added to the subscription","format":"date-time"},"equipmentGroup":{"type":"object","properties":{"id":{"type":"string","description":"Id of the equipment group.","nullable":true},"groupPosition":{"type":"integer","description":"Position of the machine within the group.","format":"int32"}},"additionalProperties":false,"description":"Information about a group in the context of a machine, assigned to it.","title":"EquipmentGroupMachineInfo"},"assignedApplications":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Application id","format":"uuid"}},"additionalProperties":false,"description":"Assigned application","title":"AssignedApplication"},"description":"List of assigned applications for this machine","nullable":true}},"additionalProperties":false,"description":"Machine information","title":"MachineInfo"},"description":"Assigned machines","nullable":true},"subscriptionTypes":{"type":"array","items":{"type":"string"},"description":"Subscription Types","nullable":true,"readOnly":true,"deprecated":true},"subscriptionFeatures":{"type":"array","items":{"type":"string"},"description":"Subscription Features","nullable":true},"servicePartners":{"type":"array","items":{"type":"object","properties":{"subscriptionId":{"type":"string","description":"Subscription id","format":"uuid"},"name":{"type":"string","description":"Service partner name","nullable":true},"customerNumber":{"type":"string","description":"Customer number","nullable":true},"parentSubscriptionId":{"type":"string","description":"Parent id","format":"uuid","nullable":true},"providerNo":{"type":"string","description":"Provider number","nullable":true},"servicePartnerType":{"enum":["MachineService","SharpeningService"],"type":"string","description":"Service partner type","title":"ServicePartnerType"}},"additionalProperties":false,"description":"Service partner","title":"ServicePartner"},"description":"Service partners","nullable":true},"licenses":{"type":"array","items":{"type":"object","properties":{"licenseId":{"type":"string","description":"License id","format":"uuid"},"applicationId":{"type":"string","description":"Application id","format":"uuid"},"createdDate":{"type":"string","description":"License creation date","format":"date-time"},"billingStartDate":{"type":"string","description":"Billing start date","format":"date-time"},"billingInterval":{"type":"string","description":"Billing interval","nullable":true},"licenseCount":{"type":"integer","description":"License count","format":"int32"}},"additionalProperties":false,"description":"License information","title":"LicenseInfo"},"description":"Licenses","nullable":true},"equipmentGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Equipment group id","nullable":true},"parentId":{"type":"string","description":"Id of the parent equipment group, or null if there is no parent.","nullable":true},"displayName":{"type":"string","description":"Display name","nullable":true},"groupPosition":{"type":"integer","description":"Position of the machine within the group","format":"int32"},"placesCount":{"type":"integer","description":"Number of places in the equipment group","format":"int32"},"type":{"enum":["Group","Warehouse","Root"],"type":"string","title":"GroupType"}},"additionalProperties":false,"description":"Equipment group information","title":"EquipmentGroupInfo"},"description":"Equipment groups","nullable":true},"servicePartnerType":{"enum":["MachineService","SharpeningService"],"type":"string","description":"Service partner type","title":"ServicePartnerType"}},"additionalProperties":false,"description":"Subscription information","title":"SubscriptionUserProfileInfo"},"description":"List of user profiles","nullable":true}},"additionalProperties":false,"description":"User profile","title":"UserProfile"}},"text/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email address","nullable":true},"subscriptions":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"User role","nullable":true},"subscriptionId":{"type":"string","description":"Subscription id","format":"uuid"},"parentSubscriptionId":{"type":"string","description":"Parent subscription id","format":"uuid","nullable":true},"name":{"type":"string","description":"Subscription name","nullable":true},"tapioId":{"type":"string","description":"Tapio id","nullable":true},"assignedMachines":{"type":"array","items":{"type":"object","properties":{"tmid":{"type":"string","description":"TapioMachineId","nullable":true},"deviceType":{"enum":["Unknown","Machine","SmartDevice"],"type":"string","description":"Device type","title":"DeviceType"},"deviceSubType":{"type":"string","description":"Device sub-type. If Device type is set to \"Machine\", Device sub-type will only contain one the following values: \"Unknown\", \"Edge\", \"Saw\", \"Cnc\", \"Sanding\", \"Drilling\", \"Assembly\", \"Storing\", \"Stock\", \"Sorting\", \"Shipping\", \"PreAssembly\", \"Lamination\", \"Moulding\", \"Packaging\", \"Handling\"","nullable":true},"displayName":{"type":"string","description":"Display name","nullable":true},"manufacturerSerialNumber":{"type":"string","description":"Serial number given to the machine by its manufacturer.","nullable":true},"onboardingDate":{"type":"string","description":"The date, when the machine has been added to the subscription","format":"date-time"},"equipmentGroup":{"type":"object","properties":{"id":{"type":"string","description":"Id of the equipment group.","nullable":true},"groupPosition":{"type":"integer","description":"Position of the machine within the group.","format":"int32"}},"additionalProperties":false,"description":"Information about a group in the context of a machine, assigned to it.","title":"EquipmentGroupMachineInfo"},"assignedApplications":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Application id","format":"uuid"}},"additionalProperties":false,"description":"Assigned application","title":"AssignedApplication"},"description":"List of assigned applications for this machine","nullable":true}},"additionalProperties":false,"description":"Machine information","title":"MachineInfo"},"description":"Assigned machines","nullable":true},"subscriptionTypes":{"type":"array","items":{"type":"string"},"description":"Subscription Types","nullable":true,"readOnly":true,"deprecated":true},"subscriptionFeatures":{"type":"array","items":{"type":"string"},"description":"Subscription Features","nullable":true},"servicePartners":{"type":"array","items":{"type":"object","properties":{"subscriptionId":{"type":"string","description":"Subscription id","format":"uuid"},"name":{"type":"string","description":"Service partner name","nullable":true},"customerNumber":{"type":"string","description":"Customer number","nullable":true},"parentSubscriptionId":{"type":"string","description":"Parent id","format":"uuid","nullable":true},"providerNo":{"type":"string","description":"Provider number","nullable":true},"servicePartnerType":{"enum":["MachineService","SharpeningService"],"type":"string","description":"Service partner type","title":"ServicePartnerType"}},"additionalProperties":false,"description":"Service partner","title":"ServicePartner"},"description":"Service partners","nullable":true},"licenses":{"type":"array","items":{"type":"object","properties":{"licenseId":{"type":"string","description":"License id","format":"uuid"},"applicationId":{"type":"string","description":"Application id","format":"uuid"},"createdDate":{"type":"string","description":"License creation date","format":"date-time"},"billingStartDate":{"type":"string","description":"Billing start date","format":"date-time"},"billingInterval":{"type":"string","description":"Billing interval","nullable":true},"licenseCount":{"type":"integer","description":"License count","format":"int32"}},"additionalProperties":false,"description":"License information","title":"LicenseInfo"},"description":"Licenses","nullable":true},"equipmentGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Equipment group id","nullable":true},"parentId":{"type":"string","description":"Id of the parent equipment group, or null if there is no parent.","nullable":true},"displayName":{"type":"string","description":"Display name","nullable":true},"groupPosition":{"type":"integer","description":"Position of the machine within the group","format":"int32"},"placesCount":{"type":"integer","description":"Number of places in the equipment group","format":"int32"},"type":{"enum":["Group","Warehouse","Root"],"type":"string","title":"GroupType"}},"additionalProperties":false,"description":"Equipment group information","title":"EquipmentGroupInfo"},"description":"Equipment groups","nullable":true},"servicePartnerType":{"enum":["MachineService","SharpeningService"],"type":"string","description":"Service partner type","title":"ServicePartnerType"}},"additionalProperties":false,"description":"Subscription information","title":"SubscriptionUserProfileInfo"},"description":"List of user profiles","nullable":true}},"additionalProperties":false,"description":"User profile","title":"UserProfile"}}}},"400":{"description":"Bad request","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}}}},"404":{"description":"User not found","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}}}}},"method":"get","path":"/api/userProfile/{email}","servers":[{"url":"https://globaldisco.tapio.one/"}],"security":[{"Bearer":[]}],"securitySchemes":{"Bearer":{"type":"apiKey","description":"Standard `Authorization` header using the Bearer scheme. Example: `bearer {token}`","name":"Authorization","in":"header"}},"info":{"title":"Global Discovery Service API","description":"tapio's Global Discovery Service API enables to retrieve information of subscriptions. For example, you can retrieve information about application settings which the customer has set, like paper format if you want to print something via a tapio connected application. If your application makes too many requests, HTTP status code 429 is returned. A Retry-After header is included in this response which indicates how long to wait before making the next request. HTTP 429 standard is followed.","termsOfService":"https://tapio.one/en/tapio-terms-of-use","contact":{"name":"tapio GmbH","url":"https://tapio.one","email":"developer@tapio.one"},"version":"1"},"postman":{"name":"Get User Profile","description":{"content":"Get the profile of a user via email address.\r\n \r\nYou can use this request to check if a user has a license for an application:\r\n \r\nThe Global Discovery Service API returns information based on the set of `tapio-Applications` that are assigned to the calling `AAD-Application`. Make sure that the `AAD-Application` you are using is assigned to the `tapio-Application` you want to check licenses for in [my tapio](https://my.tapio.one).\r\n \r\nTo check if the `User` has a `License` for your `tapio-Application` you have to go through all `Licenses` of of all `Subscriptions` in the response and check if there is a `License` with the id of your `tapio-Application` (`subscriptions[].licenses[].applicationId` [JMESPath](https://jmespath.org/)).\r\n \r\n`Licenses` can expire or be unassigned from a certain `User` or `Machine`.\r\nIt is not recommended to poll the **Global Discovery Service API** and detect those changes yourself.\r\nInstead we encourage you to setup a CloudEvent endpoint and listen for `License`-related changes.","type":"text/plain"},"url":{"path":["api","userProfile",":email"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Email address","type":"text/plain"},"type":"any","value":"","key":"email"}]},"header":[{"key":"Accept","value":"text/plain"}],"method":"GET"}} +api: {"tags":["UserProfile"],"description":"Get the profile of a user via email address.\r\n \r\nYou can use this request to check if a user has a license for an application:\r\n \r\nThe Global Discovery Service API returns information based on the set of `tapio-Applications` that are assigned to the calling `AAD-Application`. Make sure that the `AAD-Application` you are using is assigned to the `tapio-Application` you want to check licenses for in [my tapio](https://my.tapio.one).\r\n \r\nTo check if the `User` has a `License` for your `tapio-Application` you have to go through all `Licenses` of of all `Subscriptions` in the response and check if there is a `License` with the id of your `tapio-Application` (`subscriptions[].licenses[].applicationId` [JMESPath](https://jmespath.org/)).\r\n \r\n`Licenses` can expire or be unassigned from a certain `User` or `Machine`.\r\nIt is not recommended to poll the **Global Discovery Service API** and detect those changes yourself.\r\nInstead we encourage you to setup a CloudEvent endpoint and listen for `License`-related changes.","operationId":"GetUserProfile","parameters":[{"name":"email","in":"path","description":"Email address","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"text/plain":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email address","nullable":true},"subscriptions":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"User role","nullable":true},"subscriptionId":{"type":"string","description":"Subscription id","format":"uuid"},"parentSubscriptionId":{"type":"string","description":"Parent subscription id","format":"uuid","nullable":true},"name":{"type":"string","description":"Subscription name","nullable":true},"tapioId":{"type":"string","description":"Tapio id","nullable":true},"assignedMachines":{"type":"array","items":{"type":"object","properties":{"tmid":{"type":"string","description":"TapioMachineId","nullable":true},"deviceType":{"enum":["Unknown","Machine","SmartDevice"],"type":"string","description":"Device type","title":"DeviceType"},"deviceSubType":{"type":"string","description":"Device sub-type. If Device type is set to \"Machine\", Device sub-type will only contain one the following values: \"Unknown\", \"Edge\", \"Saw\", \"Cnc\", \"Sanding\", \"Drilling\", \"Assembly\", \"Storing\", \"Stock\", \"Sorting\", \"Shipping\", \"PreAssembly\", \"Lamination\", \"Moulding\", \"Packaging\", \"Handling\"","nullable":true},"displayName":{"type":"string","description":"Display name","nullable":true},"manufacturerSerialNumber":{"type":"string","description":"Serial number given to the machine by its manufacturer.","nullable":true},"onboardingDate":{"type":"string","description":"The date, when the machine has been added to the subscription","format":"date-time"},"equipmentGroup":{"type":"object","properties":{"id":{"type":"string","description":"Id of the equipment group.","nullable":true},"groupPosition":{"type":"integer","description":"Position of the machine within the group.","format":"int32"}},"additionalProperties":false,"description":"Information about a group in the context of a machine, assigned to it.","title":"EquipmentGroupMachineInfo"},"assignedApplications":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Application id","format":"uuid"}},"additionalProperties":false,"description":"Assigned application","title":"AssignedApplication"},"description":"List of assigned applications for this machine","nullable":true}},"additionalProperties":false,"description":"Machine information","title":"MachineInfo"},"description":"Assigned machines","nullable":true},"subscriptionTypes":{"type":"array","items":{"type":"string"},"description":"Subscription Types","nullable":true,"readOnly":true,"deprecated":true},"subscriptionType":{"type":"string","description":"Subscription Type","nullable":true},"subscriptionFeatures":{"type":"array","items":{"type":"string"},"description":"Subscription Features","nullable":true},"servicePartners":{"type":"array","items":{"type":"object","properties":{"subscriptionId":{"type":"string","description":"Subscription id","format":"uuid"},"name":{"type":"string","description":"Service partner name","nullable":true},"customerNumber":{"type":"string","description":"Customer number","nullable":true},"parentSubscriptionId":{"type":"string","description":"Parent id","format":"uuid","nullable":true},"providerNo":{"type":"string","description":"Provider number","nullable":true},"servicePartnerType":{"enum":["MachineService","SharpeningService"],"type":"string","description":"Service partner type","title":"ServicePartnerType"}},"additionalProperties":false,"description":"Service partner","title":"ServicePartner"},"description":"Service partners","nullable":true},"licenses":{"type":"array","items":{"type":"object","properties":{"licenseId":{"type":"string","description":"License id","format":"uuid"},"applicationId":{"type":"string","description":"Application id","format":"uuid"},"createdDate":{"type":"string","description":"License creation date","format":"date-time"},"billingStartDate":{"type":"string","description":"Billing start date","format":"date-time"},"billingInterval":{"type":"string","description":"Billing interval","nullable":true},"licenseCount":{"type":"integer","description":"License count","format":"int32"}},"additionalProperties":false,"description":"License information","title":"LicenseInfo"},"description":"Licenses","nullable":true},"equipmentGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Equipment group id","nullable":true},"parentId":{"type":"string","description":"Id of the parent equipment group, or null if there is no parent.","nullable":true},"displayName":{"type":"string","description":"Display name","nullable":true},"groupPosition":{"type":"integer","description":"Position of the machine within the group","format":"int32"},"placesCount":{"type":"integer","description":"Number of places in the equipment group","format":"int32"},"type":{"enum":["Group","Warehouse","Root"],"type":"string","title":"GroupType"}},"additionalProperties":false,"description":"Equipment group information","title":"EquipmentGroupInfo"},"description":"Equipment groups","nullable":true},"servicePartnerType":{"enum":["MachineService","SharpeningService"],"type":"string","description":"Service partner type","title":"ServicePartnerType"}},"additionalProperties":false,"description":"Subscription information","title":"SubscriptionUserProfileInfo"},"description":"List of user profiles","nullable":true}},"additionalProperties":false,"description":"User profile","title":"UserProfile"}},"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email address","nullable":true},"subscriptions":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"User role","nullable":true},"subscriptionId":{"type":"string","description":"Subscription id","format":"uuid"},"parentSubscriptionId":{"type":"string","description":"Parent subscription id","format":"uuid","nullable":true},"name":{"type":"string","description":"Subscription name","nullable":true},"tapioId":{"type":"string","description":"Tapio id","nullable":true},"assignedMachines":{"type":"array","items":{"type":"object","properties":{"tmid":{"type":"string","description":"TapioMachineId","nullable":true},"deviceType":{"enum":["Unknown","Machine","SmartDevice"],"type":"string","description":"Device type","title":"DeviceType"},"deviceSubType":{"type":"string","description":"Device sub-type. If Device type is set to \"Machine\", Device sub-type will only contain one the following values: \"Unknown\", \"Edge\", \"Saw\", \"Cnc\", \"Sanding\", \"Drilling\", \"Assembly\", \"Storing\", \"Stock\", \"Sorting\", \"Shipping\", \"PreAssembly\", \"Lamination\", \"Moulding\", \"Packaging\", \"Handling\"","nullable":true},"displayName":{"type":"string","description":"Display name","nullable":true},"manufacturerSerialNumber":{"type":"string","description":"Serial number given to the machine by its manufacturer.","nullable":true},"onboardingDate":{"type":"string","description":"The date, when the machine has been added to the subscription","format":"date-time"},"equipmentGroup":{"type":"object","properties":{"id":{"type":"string","description":"Id of the equipment group.","nullable":true},"groupPosition":{"type":"integer","description":"Position of the machine within the group.","format":"int32"}},"additionalProperties":false,"description":"Information about a group in the context of a machine, assigned to it.","title":"EquipmentGroupMachineInfo"},"assignedApplications":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Application id","format":"uuid"}},"additionalProperties":false,"description":"Assigned application","title":"AssignedApplication"},"description":"List of assigned applications for this machine","nullable":true}},"additionalProperties":false,"description":"Machine information","title":"MachineInfo"},"description":"Assigned machines","nullable":true},"subscriptionTypes":{"type":"array","items":{"type":"string"},"description":"Subscription Types","nullable":true,"readOnly":true,"deprecated":true},"subscriptionType":{"type":"string","description":"Subscription Type","nullable":true},"subscriptionFeatures":{"type":"array","items":{"type":"string"},"description":"Subscription Features","nullable":true},"servicePartners":{"type":"array","items":{"type":"object","properties":{"subscriptionId":{"type":"string","description":"Subscription id","format":"uuid"},"name":{"type":"string","description":"Service partner name","nullable":true},"customerNumber":{"type":"string","description":"Customer number","nullable":true},"parentSubscriptionId":{"type":"string","description":"Parent id","format":"uuid","nullable":true},"providerNo":{"type":"string","description":"Provider number","nullable":true},"servicePartnerType":{"enum":["MachineService","SharpeningService"],"type":"string","description":"Service partner type","title":"ServicePartnerType"}},"additionalProperties":false,"description":"Service partner","title":"ServicePartner"},"description":"Service partners","nullable":true},"licenses":{"type":"array","items":{"type":"object","properties":{"licenseId":{"type":"string","description":"License id","format":"uuid"},"applicationId":{"type":"string","description":"Application id","format":"uuid"},"createdDate":{"type":"string","description":"License creation date","format":"date-time"},"billingStartDate":{"type":"string","description":"Billing start date","format":"date-time"},"billingInterval":{"type":"string","description":"Billing interval","nullable":true},"licenseCount":{"type":"integer","description":"License count","format":"int32"}},"additionalProperties":false,"description":"License information","title":"LicenseInfo"},"description":"Licenses","nullable":true},"equipmentGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Equipment group id","nullable":true},"parentId":{"type":"string","description":"Id of the parent equipment group, or null if there is no parent.","nullable":true},"displayName":{"type":"string","description":"Display name","nullable":true},"groupPosition":{"type":"integer","description":"Position of the machine within the group","format":"int32"},"placesCount":{"type":"integer","description":"Number of places in the equipment group","format":"int32"},"type":{"enum":["Group","Warehouse","Root"],"type":"string","title":"GroupType"}},"additionalProperties":false,"description":"Equipment group information","title":"EquipmentGroupInfo"},"description":"Equipment groups","nullable":true},"servicePartnerType":{"enum":["MachineService","SharpeningService"],"type":"string","description":"Service partner type","title":"ServicePartnerType"}},"additionalProperties":false,"description":"Subscription information","title":"SubscriptionUserProfileInfo"},"description":"List of user profiles","nullable":true}},"additionalProperties":false,"description":"User profile","title":"UserProfile"}},"text/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email address","nullable":true},"subscriptions":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"User role","nullable":true},"subscriptionId":{"type":"string","description":"Subscription id","format":"uuid"},"parentSubscriptionId":{"type":"string","description":"Parent subscription id","format":"uuid","nullable":true},"name":{"type":"string","description":"Subscription name","nullable":true},"tapioId":{"type":"string","description":"Tapio id","nullable":true},"assignedMachines":{"type":"array","items":{"type":"object","properties":{"tmid":{"type":"string","description":"TapioMachineId","nullable":true},"deviceType":{"enum":["Unknown","Machine","SmartDevice"],"type":"string","description":"Device type","title":"DeviceType"},"deviceSubType":{"type":"string","description":"Device sub-type. If Device type is set to \"Machine\", Device sub-type will only contain one the following values: \"Unknown\", \"Edge\", \"Saw\", \"Cnc\", \"Sanding\", \"Drilling\", \"Assembly\", \"Storing\", \"Stock\", \"Sorting\", \"Shipping\", \"PreAssembly\", \"Lamination\", \"Moulding\", \"Packaging\", \"Handling\"","nullable":true},"displayName":{"type":"string","description":"Display name","nullable":true},"manufacturerSerialNumber":{"type":"string","description":"Serial number given to the machine by its manufacturer.","nullable":true},"onboardingDate":{"type":"string","description":"The date, when the machine has been added to the subscription","format":"date-time"},"equipmentGroup":{"type":"object","properties":{"id":{"type":"string","description":"Id of the equipment group.","nullable":true},"groupPosition":{"type":"integer","description":"Position of the machine within the group.","format":"int32"}},"additionalProperties":false,"description":"Information about a group in the context of a machine, assigned to it.","title":"EquipmentGroupMachineInfo"},"assignedApplications":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Application id","format":"uuid"}},"additionalProperties":false,"description":"Assigned application","title":"AssignedApplication"},"description":"List of assigned applications for this machine","nullable":true}},"additionalProperties":false,"description":"Machine information","title":"MachineInfo"},"description":"Assigned machines","nullable":true},"subscriptionTypes":{"type":"array","items":{"type":"string"},"description":"Subscription Types","nullable":true,"readOnly":true,"deprecated":true},"subscriptionType":{"type":"string","description":"Subscription Type","nullable":true},"subscriptionFeatures":{"type":"array","items":{"type":"string"},"description":"Subscription Features","nullable":true},"servicePartners":{"type":"array","items":{"type":"object","properties":{"subscriptionId":{"type":"string","description":"Subscription id","format":"uuid"},"name":{"type":"string","description":"Service partner name","nullable":true},"customerNumber":{"type":"string","description":"Customer number","nullable":true},"parentSubscriptionId":{"type":"string","description":"Parent id","format":"uuid","nullable":true},"providerNo":{"type":"string","description":"Provider number","nullable":true},"servicePartnerType":{"enum":["MachineService","SharpeningService"],"type":"string","description":"Service partner type","title":"ServicePartnerType"}},"additionalProperties":false,"description":"Service partner","title":"ServicePartner"},"description":"Service partners","nullable":true},"licenses":{"type":"array","items":{"type":"object","properties":{"licenseId":{"type":"string","description":"License id","format":"uuid"},"applicationId":{"type":"string","description":"Application id","format":"uuid"},"createdDate":{"type":"string","description":"License creation date","format":"date-time"},"billingStartDate":{"type":"string","description":"Billing start date","format":"date-time"},"billingInterval":{"type":"string","description":"Billing interval","nullable":true},"licenseCount":{"type":"integer","description":"License count","format":"int32"}},"additionalProperties":false,"description":"License information","title":"LicenseInfo"},"description":"Licenses","nullable":true},"equipmentGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Equipment group id","nullable":true},"parentId":{"type":"string","description":"Id of the parent equipment group, or null if there is no parent.","nullable":true},"displayName":{"type":"string","description":"Display name","nullable":true},"groupPosition":{"type":"integer","description":"Position of the machine within the group","format":"int32"},"placesCount":{"type":"integer","description":"Number of places in the equipment group","format":"int32"},"type":{"enum":["Group","Warehouse","Root"],"type":"string","title":"GroupType"}},"additionalProperties":false,"description":"Equipment group information","title":"EquipmentGroupInfo"},"description":"Equipment groups","nullable":true},"servicePartnerType":{"enum":["MachineService","SharpeningService"],"type":"string","description":"Service partner type","title":"ServicePartnerType"}},"additionalProperties":false,"description":"Subscription information","title":"SubscriptionUserProfileInfo"},"description":"List of user profiles","nullable":true}},"additionalProperties":false,"description":"User profile","title":"UserProfile"}}}},"400":{"description":"Bad request","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}}}},"404":{"description":"User not found","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","nullable":true},"details":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"title":"ErrorInformation"}}}}},"method":"get","path":"/api/userProfile/{email}","servers":[{"url":"https://globaldisco.tapio.one/"}],"security":[{"Bearer":[]}],"securitySchemes":{"Bearer":{"type":"apiKey","description":"Standard `Authorization` header using the Bearer scheme. Example: `bearer {token}`","name":"Authorization","in":"header"}},"info":{"title":"Global Discovery Service API","description":"tapio's Global Discovery Service API enables to retrieve information of subscriptions. For example, you can retrieve information about application settings which the customer has set, like paper format if you want to print something via a tapio connected application. If your application makes too many requests, HTTP status code 429 is returned. A Retry-After header is included in this response which indicates how long to wait before making the next request. HTTP 429 standard is followed.","termsOfService":"https://tapio.one/en/tapio-terms-of-use","contact":{"name":"tapio GmbH","url":"https://tapio.one","email":"developer@tapio.one"},"version":"1"},"postman":{"name":"Get User Profile","description":{"content":"Get the profile of a user via email address.\r\n \r\nYou can use this request to check if a user has a license for an application:\r\n \r\nThe Global Discovery Service API returns information based on the set of `tapio-Applications` that are assigned to the calling `AAD-Application`. Make sure that the `AAD-Application` you are using is assigned to the `tapio-Application` you want to check licenses for in [my tapio](https://my.tapio.one).\r\n \r\nTo check if the `User` has a `License` for your `tapio-Application` you have to go through all `Licenses` of of all `Subscriptions` in the response and check if there is a `License` with the id of your `tapio-Application` (`subscriptions[].licenses[].applicationId` [JMESPath](https://jmespath.org/)).\r\n \r\n`Licenses` can expire or be unassigned from a certain `User` or `Machine`.\r\nIt is not recommended to poll the **Global Discovery Service API** and detect those changes yourself.\r\nInstead we encourage you to setup a CloudEvent endpoint and listen for `License`-related changes.","type":"text/plain"},"url":{"path":["api","userProfile",":email"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Email address","type":"text/plain"},"type":"any","value":"","key":"email"}]},"header":[{"key":"Accept","value":"text/plain"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/gds/global-discovery-service-api custom_edit_url: null @@ -56,7 +56,7 @@ Information about a group in the context of a machine, assigned to it. List of assigned applications for this machine -
  • Array [
  • ]
  • ]
    • servicePartners object[] nullable
    +
  • Array [
  • ]
  • ]
    • servicePartners object[] nullable
    Service partners @@ -68,7 +68,7 @@ Licenses Equipment groups -
  • Array [
  • ]
  • ]
    • Schema
      subscriptions object[] nullable
      +
    • Array [
    • ]
    • ]
    Schema
      subscriptions object[] nullable
      List of user profiles @@ -84,7 +84,7 @@ Information about a group in the context of a machine, assigned to it. List of assigned applications for this machine -
    • Array [
    • ]
    • ]
    servicePartners object[] nullable
    +
  • Array [
  • ]
  • ]
    • servicePartners object[] nullable
    Service partners @@ -96,7 +96,7 @@ Licenses Equipment groups -
  • Array [
  • ]
  • ]
    • Schema
      subscriptions object[] nullable
      +
    • Array [
    • ]
    • ]
    Schema
      subscriptions object[] nullable
      List of user profiles @@ -112,7 +112,7 @@ Information about a group in the context of a machine, assigned to it. List of assigned applications for this machine -
    • Array [
    • ]
    • ]
    servicePartners object[] nullable
    +
  • Array [
  • ]
  • ]
    • servicePartners object[] nullable
    Service partners @@ -124,7 +124,7 @@ Licenses Equipment groups -
  • Array [
  • ]
  • ]
    • +
  • Array [
  • ]
  • ]
    • Bad request