diff --git a/docs/api/application-api/application-api.info.mdx b/docs/api/application-api/application-api.info.mdx index dfe1269..2a4d60f 100644 --- a/docs/api/application-api/application-api.info.mdx +++ b/docs/api/application-api/application-api.info.mdx @@ -21,5 +21,5 @@ import Export from "@theme/ApiDemoPanel/Export"; tapio's Application API enables third party applications to interact with tapio on behalf of their users. -

Authentication

Security Scheme Type:oauth2
OAuth Flow (implicit):

Authorization URL: https://login.mytapio.one/32896ed7-d559-401b-85cf-167143d61be0/B2C_1A_Tapio_Signin/oauth2/v2.0/authorize

Scopes:
  • openid: openid
  • https://tapiousers.onmicrosoft.com/7ee7f1b0-d030-4d20-9691-9752bdb44315/Consent.ReadWrite: read and write consent

Contact

tapio GmbH: developer@tapio.oneURL: https://tapio.one

Terms of Service

https://tapio.one/en/tapio-terms-of-use
+

Authentication

Security Scheme Type:oauth2
OAuth Flow (implicit):

Authorization URL: https://login.mytapio.one/32896ed7-d559-401b-85cf-167143d61be0/B2C_1A_Tapio_Signin/oauth2/v2.0/authorize

Scopes:
  • openid: openid
  • https://tapiousers.onmicrosoft.com/7ee7f1b0-d030-4d20-9691-9752bdb44315/Consent.ReadWrite: read and write consent
OAuth Flow (clientCredentials):

Token URL: https://login.microsoftonline.com/tapiousers.onmicrosoft.com/oauth2/token

Scopes:
  • https://tapiousers.onmicrosoft.com/7ee7f1b0-d030-4d20-9691-9752bdb44315: Read and write consent

Contact

tapio GmbH: developer@tapio.oneURL: https://tapio.one

Terms of Service

https://tapio.one/en/tapio-terms-of-use
\ No newline at end of file diff --git a/docs/api/application-api/evaluate-consent.api.mdx b/docs/api/application-api/evaluate-consent.api.mdx index 75f9a47..b218d2a 100644 --- a/docs/api/application-api/evaluate-consent.api.mdx +++ b/docs/api/application-api/evaluate-consent.api.mdx @@ -1,11 +1,11 @@ --- id: evaluate-consent -title: "Evaluate Consent" +title: "Evaluate user consent" description: "Evaluates if the user has consented to the given subject." -sidebar_label: "Evaluate Consent" +sidebar_label: "Evaluate user consent" hide_title: true hide_table_of_contents: true -api: {"tags":["Me"],"description":"Evaluates if the user has consented to the given subject.","operationId":"EvaluateConsent","parameters":[{"name":"tapio-application-id","in":"header","description":"Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.","schema":{"type":"string","format":"uuid","description":"Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.","title":"ApplicationIdHeader"}},{"name":"api-version","in":"header","description":"Use to specify the version of the API you want to use. Currently, only \"v1\" is supported.","required":true,"schema":{"type":"string","enum":["v1"],"description":"Use to specify the version of the API you want to use. Currently, only \"v1\" is supported.","title":"ApiVersionHeader"}}],"requestBody":{"description":"Evaluate consent body.","content":{"application/json-patch+json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"}},"additionalProperties":false,"description":"Evaluate consent request.","title":"EvaluateConsentRequest"}},"application/json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"}},"additionalProperties":false,"description":"Evaluate consent request.","title":"EvaluateConsentRequest"}},"text/json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"}},"additionalProperties":false,"description":"Evaluate consent request.","title":"EvaluateConsentRequest"}},"application/*+json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"}},"additionalProperties":false,"description":"Evaluate consent request.","title":"EvaluateConsentRequest"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Subject ID.","format":"uuid"},"displayName":{"type":"string","description":"Display name of the subject.","nullable":true},"content":{"type":"object","additionalProperties":{"type":"array","items":"circular(JToken)","title":"JToken"},"description":"Localized content of the subject to be displayed to the user.","nullable":true}},"additionalProperties":false,"description":"Consent subject response.","title":"ConsentSubjectResponse"},"description":"Data.","nullable":true}},"additionalProperties":false,"description":"Collection response.","title":"ConsentSubjectResponseCollectionResponse"}},"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Subject ID.","format":"uuid"},"displayName":{"type":"string","description":"Display name of the subject.","nullable":true},"content":{"type":"object","additionalProperties":{"type":"array","items":"circular(JToken)","title":"JToken"},"description":"Localized content of the subject to be displayed to the user.","nullable":true}},"additionalProperties":false,"description":"Consent subject response.","title":"ConsentSubjectResponse"},"description":"Data.","nullable":true}},"additionalProperties":false,"description":"Collection response.","title":"ConsentSubjectResponseCollectionResponse"}},"text/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Subject ID.","format":"uuid"},"displayName":{"type":"string","description":"Display name of the subject.","nullable":true},"content":{"type":"object","additionalProperties":{"type":"array","items":"circular(JToken)","title":"JToken"},"description":"Localized content of the subject to be displayed to the user.","nullable":true}},"additionalProperties":false,"description":"Consent subject response.","title":"ConsentSubjectResponse"},"description":"Data.","nullable":true}},"additionalProperties":false,"description":"Collection response.","title":"ConsentSubjectResponseCollectionResponse"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}}}}},"method":"post","path":"/me/evaluateConsent","servers":[{"url":"https://api.tapio.one/application"}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.mytapio.one/32896ed7-d559-401b-85cf-167143d61be0/B2C_1A_Tapio_Signin/oauth2/v2.0/authorize","scopes":{"openid":"openid","https://tapiousers.onmicrosoft.com/7ee7f1b0-d030-4d20-9691-9752bdb44315/Consent.ReadWrite":"read and write consent"}}}}},"jsonRequestBodyExample":{"consentSubjectId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"info":{"title":"Application API","description":"tapio's Application API enables third party applications to interact with tapio on behalf of their users.","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":"Evaluate Consent","description":{"content":"Evaluates if the user has consented to the given subject.","type":"text/plain"},"url":{"path":["me","evaluateConsent"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.","type":"text/plain"},"key":"tapio-application-id","value":""},{"disabled":false,"description":{"content":"(Required) Use to specify the version of the API you want to use. Currently, only \"v1\" is supported.","type":"text/plain"},"key":"api-version","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"tags":["Me"],"description":"Evaluates if the user has consented to the given subject.","operationId":"EvaluateConsent","parameters":[{"name":"tapio-application-id","in":"header","description":"Format - uuid.","schema":{"type":"string","description":"Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.","format":"uuid","title":"ApplicationIdHeader"}},{"name":"api-version","in":"header","required":true,"schema":{"enum":["v1"],"type":"string","description":"Use to specify the version of the API you want to use. Currently, only \"v1\" is supported.","title":"ApiVersionHeader"}}],"requestBody":{"description":"Evaluate consent body.","content":{"application/json-patch+json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"}},"additionalProperties":false,"description":"Evaluate consent request.","title":"EvaluateConsentRequest"},"example":{"consentSubjectId":"string"}},"application/json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"}},"additionalProperties":false,"description":"Evaluate consent request.","title":"EvaluateConsentRequest"},"example":{"consentSubjectId":"string"}},"text/json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"}},"additionalProperties":false,"description":"Evaluate consent request.","title":"EvaluateConsentRequest"},"example":{"consentSubjectId":"string"}},"application/*+json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"}},"additionalProperties":false,"description":"Evaluate consent request.","title":"EvaluateConsentRequest"},"example":{"consentSubjectId":"string"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"object","properties":{"hasConsented":{"type":"boolean","description":"True when the user has given consent."}},"additionalProperties":false,"description":"Evaluate consent response.","title":"EvaluateConsentResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"hasConsented":{"type":"boolean","description":"True when the user has given consent."}},"additionalProperties":false,"description":"Evaluate consent response.","title":"EvaluateConsentResponse"},"example":{"hasConsented":true}},"text/json":{"schema":{"type":"object","properties":{"hasConsented":{"type":"boolean","description":"True when the user has given consent."}},"additionalProperties":false,"description":"Evaluate consent response.","title":"EvaluateConsentResponse"},"example":{"hasConsented":true}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}}}}},"method":"post","path":"/me/evaluateConsent","servers":[{"url":"https://api.tapio.one/application"}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.mytapio.one/32896ed7-d559-401b-85cf-167143d61be0/B2C_1A_Tapio_Signin/oauth2/v2.0/authorize","scopes":{"openid":"openid","https://tapiousers.onmicrosoft.com/7ee7f1b0-d030-4d20-9691-9752bdb44315/Consent.ReadWrite":"read and write consent"}},"clientCredentials":{"tokenUrl":"https://login.microsoftonline.com/tapiousers.onmicrosoft.com/oauth2/token","scopes":{"https://tapiousers.onmicrosoft.com/7ee7f1b0-d030-4d20-9691-9752bdb44315":"Read and write consent"}}}}},"jsonRequestBodyExample":{"consentSubjectId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"info":{"title":"Application API","description":"tapio's Application API enables third party applications to interact with tapio on behalf of their users.","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":"Evaluate user consent","description":{"content":"Evaluates if the user has consented to the given subject.","type":"text/plain"},"url":{"path":["me","evaluateConsent"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"Format - uuid.","type":"text/plain"},"key":"tapio-application-id","value":""},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"api-version","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: api/application-api/application-api custom_edit_url: null @@ -20,13 +20,13 @@ import SchemaTabs from "@theme/SchemaTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import TabItem from "@theme/TabItem"; -## Evaluate Consent +## Evaluate user consent Evaluates if the user has consented to the given subject. -
Header Parameters
Request Body
+
Header Parameters
Request Body
Evaluate consent body. @@ -46,45 +46,21 @@ Evaluate consent body. OK -
Schema
    data object[] nullable
    - -Data. - -
  • Array [
  • content object nullable
    - -Localized content of the subject to be displayed to the user. - -
    property name* object (JToken) nullable
  • Array [
  • ]
  • ]
Schema
    data object[] nullable
    - -Data. - -
  • Array [
  • content object nullable
    - -Localized content of the subject to be displayed to the user. - -
    property name* object (JToken) nullable
  • Array [
  • ]
  • ]
Schema
    data object[] nullable
    - -Data. - -
  • Array [
  • content object nullable
    - -Localized content of the subject to be displayed to the user. - -
    property name* object (JToken) nullable
  • Array [
  • ]
  • ]
+
Schema
Schema
Schema
Bad Request -
Schema
Schema
Schema
+
Schema
Schema
Schema
Unauthorized -
Schema
Schema
Schema
+
Schema
Schema
Schema
Forbidden -
Schema
Schema
Schema
+
Schema
Schema
Schema
Not Found -
Schema
Schema
Schema
+
Schema
Schema
Schema
\ No newline at end of file diff --git a/docs/api/application-api/evaluate-subscription-consent.api.mdx b/docs/api/application-api/evaluate-subscription-consent.api.mdx new file mode 100644 index 0000000..4b93576 --- /dev/null +++ b/docs/api/application-api/evaluate-subscription-consent.api.mdx @@ -0,0 +1,62 @@ +--- +id: evaluate-subscription-consent +title: "Evaluate subscription consent" +description: "Evaluates if there is consent for the given subscription and consent subject." +sidebar_label: "Evaluate subscription consent" +hide_title: true +hide_table_of_contents: true +api: {"tags":["Subscription"],"description":"Evaluates if there is consent for the given subscription and consent subject.","operationId":"EvaluateSubscriptionConsent","parameters":[{"name":"subscriptionId","in":"path","description":"Format - uuid. Subscription ID","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"tapio-application-id","in":"header","description":"Format - uuid.","schema":{"type":"string","description":"Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.","format":"uuid","title":"ApplicationIdHeader"}},{"name":"api-version","in":"header","required":true,"schema":{"enum":["v1"],"type":"string","description":"Use to specify the version of the API you want to use. Currently, only \"v1\" is supported.","title":"ApiVersionHeader"}}],"requestBody":{"description":"Evaluate consent body.","content":{"application/json-patch+json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"}},"additionalProperties":false,"description":"Evaluate subscription consent request.","title":"EvaluateSubscriptionConsentRequest"},"example":{"consentSubjectId":"string"}},"application/json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"}},"additionalProperties":false,"description":"Evaluate subscription consent request.","title":"EvaluateSubscriptionConsentRequest"},"example":{"consentSubjectId":"string"}},"text/json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"}},"additionalProperties":false,"description":"Evaluate subscription consent request.","title":"EvaluateSubscriptionConsentRequest"},"example":{"consentSubjectId":"string"}},"application/*+json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"}},"additionalProperties":false,"description":"Evaluate subscription consent request.","title":"EvaluateSubscriptionConsentRequest"},"example":{"consentSubjectId":"string"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"object","properties":{"hasConsented":{"type":"boolean","description":"True when a user has given consent for the subscription."}},"additionalProperties":false,"description":"Evaluate subscription consent response.","title":"EvaluateSubscriptionConsentResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"hasConsented":{"type":"boolean","description":"True when a user has given consent for the subscription."}},"additionalProperties":false,"description":"Evaluate subscription consent response.","title":"EvaluateSubscriptionConsentResponse"},"example":{"hasConsented":true}},"text/json":{"schema":{"type":"object","properties":{"hasConsented":{"type":"boolean","description":"True when a user has given consent for the subscription."}},"additionalProperties":false,"description":"Evaluate subscription consent response.","title":"EvaluateSubscriptionConsentResponse"},"example":{"hasConsented":true}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}}}}},"method":"post","path":"/subscriptions/{subscriptionId}/evaluateConsent","servers":[{"url":"https://api.tapio.one/application"}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.mytapio.one/32896ed7-d559-401b-85cf-167143d61be0/B2C_1A_Tapio_Signin/oauth2/v2.0/authorize","scopes":{"openid":"openid","https://tapiousers.onmicrosoft.com/7ee7f1b0-d030-4d20-9691-9752bdb44315/Consent.ReadWrite":"read and write consent"}},"clientCredentials":{"tokenUrl":"https://login.microsoftonline.com/tapiousers.onmicrosoft.com/oauth2/token","scopes":{"https://tapiousers.onmicrosoft.com/7ee7f1b0-d030-4d20-9691-9752bdb44315":"Read and write consent"}}}}},"jsonRequestBodyExample":{"consentSubjectId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"info":{"title":"Application API","description":"tapio's Application API enables third party applications to interact with tapio on behalf of their users.","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":"Evaluate subscription consent","description":{"content":"Evaluates if there is consent for the given subscription and consent subject.","type":"text/plain"},"url":{"path":["subscriptions",":subscriptionId","evaluateConsent"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Format - uuid. Subscription ID","type":"text/plain"},"type":"any","value":"","key":"subscriptionId"}]},"header":[{"disabled":false,"description":{"content":"Format - uuid.","type":"text/plain"},"key":"tapio-application-id","value":""},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"api-version","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: api/application-api/application-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Evaluate subscription consent + + + +Evaluates if there is consent for the given subscription and consent subject. + +
Path Parameters
Header Parameters
Request Body
+ +Evaluate consent body. + +
Request Body
+ +Evaluate consent body. + +
Request Body
+ +Evaluate consent body. + +
Request Body
+ +Evaluate consent body. + +
+ +OK + +
Schema
Schema
Schema
+ +Bad Request + +
Schema
Schema
Schema
+ +Unauthorized + +
Schema
Schema
Schema
+ +Forbidden + +
Schema
Schema
Schema
+ \ No newline at end of file diff --git a/docs/api/application-api/get-consent-subjects.api.mdx b/docs/api/application-api/get-consent-subjects.api.mdx index 6f7434a..0bb974a 100644 --- a/docs/api/application-api/get-consent-subjects.api.mdx +++ b/docs/api/application-api/get-consent-subjects.api.mdx @@ -5,7 +5,7 @@ description: "Gets all consent subjects that the calling user and application ar sidebar_label: "Gets Consent Subjects" hide_title: true hide_table_of_contents: true -api: {"tags":["ConsentSubject"],"description":"Gets all consent subjects that the calling user and application are authorized for.","operationId":"GetConsentSubjects","parameters":[{"name":"locale","in":"query","description":"Optional locale.","schema":{"type":"string"}},{"name":"tapio-application-id","in":"header","description":"Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.","schema":{"type":"string","format":"uuid","description":"Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.","title":"ApplicationIdHeader"}},{"name":"api-version","required":true,"in":"header","description":"Use to specify the version of the API you want to use. Currently, only \"v1\" is supported.","schema":{"type":"string","enum":["v1"],"description":"Use to specify the version of the API you want to use. Currently, only \"v1\" is supported.","title":"ApiVersionHeader"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Subject ID.","format":"uuid"},"displayName":{"type":"string","description":"Display name of the subject.","nullable":true},"content":{"type":"object","additionalProperties":{"type":"array","items":"circular(JToken)","title":"JToken"},"description":"Localized content of the subject to be displayed to the user.","nullable":true}},"additionalProperties":false,"description":"Consent subject response.","title":"ConsentSubjectResponse"},"description":"Data.","nullable":true}},"additionalProperties":false,"description":"Collection response.","title":"ConsentSubjectResponseCollectionResponse"}},"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Subject ID.","format":"uuid"},"displayName":{"type":"string","description":"Display name of the subject.","nullable":true},"content":{"type":"object","additionalProperties":{"type":"array","items":"circular(JToken)","title":"JToken"},"description":"Localized content of the subject to be displayed to the user.","nullable":true}},"additionalProperties":false,"description":"Consent subject response.","title":"ConsentSubjectResponse"},"description":"Data.","nullable":true}},"additionalProperties":false,"description":"Collection response.","title":"ConsentSubjectResponseCollectionResponse"}},"text/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Subject ID.","format":"uuid"},"displayName":{"type":"string","description":"Display name of the subject.","nullable":true},"content":{"type":"object","additionalProperties":{"type":"array","items":"circular(JToken)","title":"JToken"},"description":"Localized content of the subject to be displayed to the user.","nullable":true}},"additionalProperties":false,"description":"Consent subject response.","title":"ConsentSubjectResponse"},"description":"Data.","nullable":true}},"additionalProperties":false,"description":"Collection response.","title":"ConsentSubjectResponseCollectionResponse"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}}}}},"method":"get","path":"/consentSubjects","servers":[{"url":"https://api.tapio.one/application"}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.mytapio.one/32896ed7-d559-401b-85cf-167143d61be0/B2C_1A_Tapio_Signin/oauth2/v2.0/authorize","scopes":{"openid":"openid","https://tapiousers.onmicrosoft.com/7ee7f1b0-d030-4d20-9691-9752bdb44315/Consent.ReadWrite":"read and write consent"}}}}},"info":{"title":"Application API","description":"tapio's Application API enables third party applications to interact with tapio on behalf of their users.","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":"Gets Consent Subjects","description":{"content":"Gets all consent subjects that the calling user and application are authorized for.","type":"text/plain"},"url":{"path":["consentSubjects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Optional locale.","type":"text/plain"},"key":"locale","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.","type":"text/plain"},"key":"tapio-application-id","value":""},{"disabled":false,"description":{"content":"(Required) Use to specify the version of the API you want to use. Currently, only \"v1\" is supported.","type":"text/plain"},"key":"api-version","value":""},{"key":"Accept","value":"text/plain"}],"method":"GET"}} +api: {"tags":["ConsentSubject"],"description":"Gets all consent subjects that the calling user and application are authorized for.","operationId":"GetConsentSubjects","parameters":[{"name":"locale","in":"query","description":"Optional locale.","schema":{"type":"string"}},{"name":"tapio-application-id","in":"header","description":"Format - uuid.","schema":{"type":"string","description":"Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.","format":"uuid","title":"ApplicationIdHeader"}},{"name":"api-version","in":"header","required":true,"schema":{"enum":["v1"],"type":"string","description":"Use to specify the version of the API you want to use. Currently, only \"v1\" is supported.","title":"ApiVersionHeader"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Subject ID.","format":"uuid"},"displayName":{"type":"string","description":"Display name of the subject.","nullable":true},"content":{"type":"object","additionalProperties":{"type":"array","items":"circular(JToken)","title":"JToken"},"description":"Localized content of the subject to be displayed to the user.","nullable":true}},"additionalProperties":false,"description":"Consent subject response.","title":"ConsentSubjectResponse"},"description":"Data.","nullable":true}},"additionalProperties":false,"description":"Collection response.","title":"ConsentSubjectResponseCollectionResponse"}},"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Subject ID.","format":"uuid"},"displayName":{"type":"string","description":"Display name of the subject.","nullable":true},"content":{"type":"object","additionalProperties":{"type":"array","items":"circular(JToken)","title":"JToken"},"description":"Localized content of the subject to be displayed to the user.","nullable":true}},"additionalProperties":false,"description":"Consent subject response.","title":"ConsentSubjectResponse"},"description":"Data.","nullable":true}},"additionalProperties":false,"description":"Collection response.","title":"ConsentSubjectResponseCollectionResponse"}},"text/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Subject ID.","format":"uuid"},"displayName":{"type":"string","description":"Display name of the subject.","nullable":true},"content":{"type":"object","additionalProperties":{"type":"array","items":"circular(JToken)","title":"JToken"},"description":"Localized content of the subject to be displayed to the user.","nullable":true}},"additionalProperties":false,"description":"Consent subject response.","title":"ConsentSubjectResponse"},"description":"Data.","nullable":true}},"additionalProperties":false,"description":"Collection response.","title":"ConsentSubjectResponseCollectionResponse"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}}}}},"method":"get","path":"/consentSubjects","servers":[{"url":"https://api.tapio.one/application"}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.mytapio.one/32896ed7-d559-401b-85cf-167143d61be0/B2C_1A_Tapio_Signin/oauth2/v2.0/authorize","scopes":{"openid":"openid","https://tapiousers.onmicrosoft.com/7ee7f1b0-d030-4d20-9691-9752bdb44315/Consent.ReadWrite":"read and write consent"}},"clientCredentials":{"tokenUrl":"https://login.microsoftonline.com/tapiousers.onmicrosoft.com/oauth2/token","scopes":{"https://tapiousers.onmicrosoft.com/7ee7f1b0-d030-4d20-9691-9752bdb44315":"Read and write consent"}}}}},"info":{"title":"Application API","description":"tapio's Application API enables third party applications to interact with tapio on behalf of their users.","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":"Gets Consent Subjects","description":{"content":"Gets all consent subjects that the calling user and application are authorized for.","type":"text/plain"},"url":{"path":["consentSubjects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Optional locale.","type":"text/plain"},"key":"locale","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"Format - uuid.","type":"text/plain"},"key":"tapio-application-id","value":""},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"api-version","value":""},{"key":"Accept","value":"text/plain"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/application-api/application-api custom_edit_url: null @@ -26,7 +26,7 @@ import TabItem from "@theme/TabItem"; Gets all consent subjects that the calling user and application are authorized for. -
Query Parameters
Header Parameters
+
Query Parameters
Header Parameters
OK @@ -58,13 +58,13 @@ Localized content of the subject to be displayed to the user. Bad Request -
Schema
Schema
Schema
+
Schema
Schema
Schema
Unauthorized -
Schema
Schema
Schema
+
Schema
Schema
Schema
Forbidden -
Schema
Schema
Schema
+
Schema
Schema
Schema
\ No newline at end of file diff --git a/docs/api/application-api/grant-consent.api.mdx b/docs/api/application-api/grant-consent.api.mdx index 1103bb0..fbfb867 100644 --- a/docs/api/application-api/grant-consent.api.mdx +++ b/docs/api/application-api/grant-consent.api.mdx @@ -1,11 +1,11 @@ --- id: grant-consent title: "Grant Consent" -description: "Grant consent to a subject on behalf of a user. Get the result from EvaluateConsent. Note that" +description: "Grant consent to a subject on behalf of a user. Get the result from EvaluateConsent." sidebar_label: "Grant Consent" hide_title: true hide_table_of_contents: true -api: {"tags":["Me"],"description":"Grant consent to a subject on behalf of a user. Get the result from EvaluateConsent. Note that\r\n this route is eventually consistent. So EvaluateConsent might take some time to take over the granting of the consent.","operationId":"GrantConsent","parameters":[{"name":"tapio-application-id","in":"header","description":"Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.","schema":{"type":"string","format":"uuid","description":"Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.","title":"ApplicationIdHeader"}},{"name":"api-version","in":"header","description":"Use to specify the version of the API you want to use. Currently, only \"v1\" is supported.","required":true,"schema":{"type":"string","enum":["v1"],"description":"Use to specify the version of the API you want to use. Currently, only \"v1\" is supported.","title":"ApiVersionHeader"}}],"requestBody":{"description":"Grant consent body.","content":{"application/json-patch+json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"},"text":{"type":"string","description":"The text the user has seen while consenting.","nullable":true}},"additionalProperties":false,"description":"Grant consent request.","title":"GrantConsentRequest"}},"application/json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"},"text":{"type":"string","description":"The text the user has seen while consenting.","nullable":true}},"additionalProperties":false,"description":"Grant consent request.","title":"GrantConsentRequest"}},"text/json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"},"text":{"type":"string","description":"The text the user has seen while consenting.","nullable":true}},"additionalProperties":false,"description":"Grant consent request.","title":"GrantConsentRequest"}},"application/*+json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"},"text":{"type":"string","description":"The text the user has seen while consenting.","nullable":true}},"additionalProperties":false,"description":"Grant consent request.","title":"GrantConsentRequest"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Subject ID.","format":"uuid"},"displayName":{"type":"string","description":"Display name of the subject.","nullable":true},"content":{"type":"object","additionalProperties":{"type":"array","items":"circular(JToken)","title":"JToken"},"description":"Localized content of the subject to be displayed to the user.","nullable":true}},"additionalProperties":false,"description":"Consent subject response.","title":"ConsentSubjectResponse"},"description":"Data.","nullable":true}},"additionalProperties":false,"description":"Collection response.","title":"ConsentSubjectResponseCollectionResponse"}},"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Subject ID.","format":"uuid"},"displayName":{"type":"string","description":"Display name of the subject.","nullable":true},"content":{"type":"object","additionalProperties":{"type":"array","items":"circular(JToken)","title":"JToken"},"description":"Localized content of the subject to be displayed to the user.","nullable":true}},"additionalProperties":false,"description":"Consent subject response.","title":"ConsentSubjectResponse"},"description":"Data.","nullable":true}},"additionalProperties":false,"description":"Collection response.","title":"ConsentSubjectResponseCollectionResponse"}},"text/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Subject ID.","format":"uuid"},"displayName":{"type":"string","description":"Display name of the subject.","nullable":true},"content":{"type":"object","additionalProperties":{"type":"array","items":"circular(JToken)","title":"JToken"},"description":"Localized content of the subject to be displayed to the user.","nullable":true}},"additionalProperties":false,"description":"Consent subject response.","title":"ConsentSubjectResponse"},"description":"Data.","nullable":true}},"additionalProperties":false,"description":"Collection response.","title":"ConsentSubjectResponseCollectionResponse"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}}}},"412":{"description":"Precondition Failed","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"}}}}},"method":"post","path":"/me/grantConsent","servers":[{"url":"https://api.tapio.one/application"}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.mytapio.one/32896ed7-d559-401b-85cf-167143d61be0/B2C_1A_Tapio_Signin/oauth2/v2.0/authorize","scopes":{"openid":"openid","https://tapiousers.onmicrosoft.com/7ee7f1b0-d030-4d20-9691-9752bdb44315/Consent.ReadWrite":"read and write consent"}}}}},"jsonRequestBodyExample":{"consentSubjectId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","text":"string"},"info":{"title":"Application API","description":"tapio's Application API enables third party applications to interact with tapio on behalf of their users.","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":"Grant Consent","description":{"content":"Grant consent to a subject on behalf of a user. Get the result from EvaluateConsent. Note that\r\n this route is eventually consistent. So EvaluateConsent might take some time to take over the granting of the consent.","type":"text/plain"},"url":{"path":["me","grantConsent"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.","type":"text/plain"},"key":"tapio-application-id","value":""},{"disabled":false,"description":{"content":"(Required) Use to specify the version of the API you want to use. Currently, only \"v1\" is supported.","type":"text/plain"},"key":"api-version","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"tags":["Me"],"description":"Grant consent to a subject on behalf of a user. Get the result from EvaluateConsent.","operationId":"GrantConsent","parameters":[{"name":"tapio-application-id","in":"header","description":"Format - uuid.","schema":{"type":"string","description":"Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.","format":"uuid","title":"ApplicationIdHeader"}},{"name":"api-version","in":"header","required":true,"schema":{"enum":["v1"],"type":"string","description":"Use to specify the version of the API you want to use. Currently, only \"v1\" is supported.","title":"ApiVersionHeader"}}],"requestBody":{"description":"Grant consent body.","content":{"application/json-patch+json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"},"text":{"type":"string","description":"The text the user has seen while consenting.","nullable":true}},"additionalProperties":false,"description":"Grant consent request.","title":"GrantConsentRequest"},"example":{"consentSubjectId":"string","text":"string"}},"application/json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"},"text":{"type":"string","description":"The text the user has seen while consenting.","nullable":true}},"additionalProperties":false,"description":"Grant consent request.","title":"GrantConsentRequest"},"example":{"consentSubjectId":"string","text":"string"}},"text/json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"},"text":{"type":"string","description":"The text the user has seen while consenting.","nullable":true}},"additionalProperties":false,"description":"Grant consent request.","title":"GrantConsentRequest"},"example":{"consentSubjectId":"string","text":"string"}},"application/*+json":{"schema":{"type":"object","properties":{"consentSubjectId":{"type":"string","description":"Consent subject ID.","format":"uuid"},"text":{"type":"string","description":"The text the user has seen while consenting.","nullable":true}},"additionalProperties":false,"description":"Grant consent request.","title":"GrantConsentRequest"},"example":{"consentSubjectId":"string","text":"string"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}}}},"403":{"description":"Forbidden","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}}}},"412":{"description":"Precondition Failed","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"examples":{"default":{"value":null}}},"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}},"text/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","nullable":true},"details":{"type":"array","items":{"type":"string"},"description":"Error details.","nullable":true}},"additionalProperties":false,"description":"Error response.","title":"ErrorResponse"},"example":{"message":"string","details":["string"]}}}}},"method":"post","path":"/me/grantConsent","servers":[{"url":"https://api.tapio.one/application"}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.mytapio.one/32896ed7-d559-401b-85cf-167143d61be0/B2C_1A_Tapio_Signin/oauth2/v2.0/authorize","scopes":{"openid":"openid","https://tapiousers.onmicrosoft.com/7ee7f1b0-d030-4d20-9691-9752bdb44315/Consent.ReadWrite":"read and write consent"}},"clientCredentials":{"tokenUrl":"https://login.microsoftonline.com/tapiousers.onmicrosoft.com/oauth2/token","scopes":{"https://tapiousers.onmicrosoft.com/7ee7f1b0-d030-4d20-9691-9752bdb44315":"Read and write consent"}}}}},"jsonRequestBodyExample":{"consentSubjectId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","text":"string"},"info":{"title":"Application API","description":"tapio's Application API enables third party applications to interact with tapio on behalf of their users.","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":"Grant Consent","description":{"content":"Grant consent to a subject on behalf of a user. Get the result from EvaluateConsent.","type":"text/plain"},"url":{"path":["me","grantConsent"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"Format - uuid.","type":"text/plain"},"key":"tapio-application-id","value":""},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"api-version","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: api/application-api/application-api custom_edit_url: null @@ -24,10 +24,9 @@ import TabItem from "@theme/TabItem"; -Grant consent to a subject on behalf of a user. Get the result from EvaluateConsent. Note that - this route is eventually consistent. So EvaluateConsent might take some time to take over the granting of the consent. +Grant consent to a subject on behalf of a user. Get the result from EvaluateConsent. -
Header Parameters
Request Body
+
Header Parameters
Request Body
Grant consent body. @@ -47,49 +46,25 @@ Grant consent body. OK -
Schema
    data object[] nullable
    - -Data. - -
  • Array [
  • content object nullable
    - -Localized content of the subject to be displayed to the user. - -
    property name* object (JToken) nullable
  • Array [
  • ]
  • ]
Schema
    data object[] nullable
    - -Data. - -
  • Array [
  • content object nullable
    - -Localized content of the subject to be displayed to the user. - -
    property name* object (JToken) nullable
  • Array [
  • ]
  • ]
Schema
    data object[] nullable
    - -Data. - -
  • Array [
  • content object nullable
    - -Localized content of the subject to be displayed to the user. - -
    property name* object (JToken) nullable
  • Array [
  • ]
  • ]
+
Bad Request -
Schema
Schema
Schema
+
Schema
Schema
Schema
Unauthorized -
Schema
Schema
Schema
+
Schema
Schema
Schema
Forbidden -
Schema
Schema
Schema
+
Schema
Schema
Schema
Not Found -
Schema
Schema
Schema
+
Schema
Schema
Schema
Precondition Failed -
Schema
Schema
Schema
+
Schema
Schema
Schema
\ No newline at end of file diff --git a/docs/api/application-api/sidebar.js b/docs/api/application-api/sidebar.js index 062a1fe..952f4b8 100644 --- a/docs/api/application-api/sidebar.js +++ b/docs/api/application-api/sidebar.js @@ -1 +1 @@ -module.exports = [{"type":"doc","id":"api/application-api/application-api"},{"type":"category","label":"ConsentSubject","link":{"type":"doc","id":"api/application-api/consent-subject"},"items":[{"type":"doc","id":"api/application-api/get-consent-subjects","label":"Gets Consent Subjects","className":"api-method get"}]},{"type":"category","label":"Me","link":{"type":"doc","id":"api/application-api/me"},"items":[{"type":"doc","id":"api/application-api/grant-consent","label":"Grant Consent","className":"api-method post"},{"type":"doc","id":"api/application-api/evaluate-consent","label":"Evaluate Consent","className":"api-method post"}]}]; \ No newline at end of file +module.exports = [{"type":"doc","id":"api/application-api/application-api"},{"type":"category","label":"ConsentSubject","link":{"type":"doc","id":"api/application-api/consent-subject"},"items":[{"type":"doc","id":"api/application-api/get-consent-subjects","label":"Gets Consent Subjects","className":"api-method get"}]},{"type":"category","label":"Me","link":{"type":"doc","id":"api/application-api/me"},"items":[{"type":"doc","id":"api/application-api/grant-consent","label":"Grant Consent","className":"api-method post"},{"type":"doc","id":"api/application-api/evaluate-consent","label":"Evaluate user consent","className":"api-method post"}]},{"type":"category","label":"Subscription","link":{"type":"doc","id":"api/application-api/subscription"},"items":[{"type":"doc","id":"api/application-api/evaluate-subscription-consent","label":"Evaluate subscription consent","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs/api/application-api/subscription.tag.mdx b/docs/api/application-api/subscription.tag.mdx new file mode 100644 index 0000000..c9ed8c7 --- /dev/null +++ b/docs/api/application-api/subscription.tag.mdx @@ -0,0 +1,16 @@ +--- +id: subscription +title: "Subscription" +description: "Subscription" +custom_edit_url: null +--- + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/gds/get-application-token-profile.api.mdx b/docs/api/gds/get-application-token-profile.api.mdx index 3934ab3..cc2ddd9 100644 --- a/docs/api/gds/get-application-token-profile.api.mdx +++ b/docs/api/gds/get-application-token-profile.api.mdx @@ -58,7 +58,7 @@ Licenses Equipment groups -
  • Array [
  • ]
  • ]
  • Schema
      subscriptions object[] nullable
      +
    • Array [
    • ]
    • ]
    Schema
      subscriptions object[] nullable
      List of subscription information @@ -86,7 +86,7 @@ Licenses Equipment groups -
    • Array [
    • ]
    • ]
    Schema
      subscriptions object[] nullable
      +
    • Array [
    • ]
    • ]
    Schema
      subscriptions object[] nullable
      List of subscription information @@ -114,7 +114,7 @@ Licenses Equipment groups -
    • Array [
    • ]
    • ]
    +
  • Array [
  • ]
  • ]
  • ETag matches diff --git a/docs/api/gds/get-subscription-overview.api.mdx b/docs/api/gds/get-subscription-overview.api.mdx index 5590ac8..c475e62 100644 --- a/docs/api/gds/get-subscription-overview.api.mdx +++ b/docs/api/gds/get-subscription-overview.api.mdx @@ -58,7 +58,7 @@ Licenses Equipment groups -
  • Array [
  • ]
  • ]
  • Schema
      subscriptions object[] nullable
      +
    • Array [
    • ]
    • ]
    Schema
      subscriptions object[] nullable
      List of subscription information @@ -86,7 +86,7 @@ Licenses Equipment groups -
    • Array [
    • ]
    • ]
    Schema
      subscriptions object[] nullable
      +
    • Array [
    • ]
    • ]
    Schema
      subscriptions object[] nullable
      List of subscription information @@ -114,7 +114,7 @@ Licenses Equipment groups -
    • Array [
    • ]
    • ]
    +
  • Array [
  • ]
  • ]
  • ETag matches diff --git a/docs/api/gds/get-user-profile.api.mdx b/docs/api/gds/get-user-profile.api.mdx index 0842990..34b65f5 100644 --- a/docs/api/gds/get-user-profile.api.mdx +++ b/docs/api/gds/get-user-profile.api.mdx @@ -68,7 +68,7 @@ Licenses Equipment groups -
  • Array [
  • ]
  • ]
  • Schema
      subscriptions object[] nullable
      +
    • Array [
    • ]
    • ]
    Schema
      subscriptions object[] nullable
      List of user profiles @@ -96,7 +96,7 @@ Licenses Equipment groups -
    • Array [
    • ]
    • ]
    Schema
      subscriptions object[] nullable
      +
    • Array [
    • ]
    • ]
    Schema
      subscriptions object[] nullable
      List of user profiles @@ -124,7 +124,7 @@ Licenses Equipment groups -
    • Array [
    • ]
    • ]
    +
  • Array [
  • ]
  • ]
  • Bad request diff --git a/docs/api/gds/onboard-cloud-connector.api.mdx b/docs/api/gds/onboard-cloud-connector.api.mdx index 3fa3539..51b2594 100644 --- a/docs/api/gds/onboard-cloud-connector.api.mdx +++ b/docs/api/gds/onboard-cloud-connector.api.mdx @@ -46,7 +46,7 @@ Onboarding information of the cloud connector Successful -
    Schema
    Schema
    Schema
    +
    Schema
    Schema
    Schema
    Bad request diff --git a/src/api/ApplicationApi.json b/src/api/ApplicationApi.json index fc47970..85575c8 100644 --- a/src/api/ApplicationApi.json +++ b/src/api/ApplicationApi.json @@ -13,11 +13,11 @@ }, "servers": [ { - "url": "https://api.tapio.one/application" + "url": "https://api.tapio.one/application" } ], "paths": { - "/consentSubjects": { + "/consentSubjects": { "get": { "tags": [ "ConsentSubject" @@ -37,16 +37,15 @@ { "name": "tapio-application-id", "in": "header", - "description": "Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.", + "description": "Format - uuid.", "schema": { "$ref": "#/components/schemas/ApplicationIdHeader" } }, { "name": "api-version", - "required": true, "in": "header", - "description": "Use to specify the version of the API you want to use. Currently, only \"v1\" is supported.", + "required": true, "schema": { "$ref": "#/components/schemas/ApiVersionHeader" } @@ -79,16 +78,33 @@ "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "default": { + "value": null + } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } } } @@ -99,16 +115,33 @@ "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "default": { + "value": null + } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } } } @@ -119,16 +152,33 @@ "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "default": { + "value": null + } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } } } @@ -136,19 +186,19 @@ } } }, - "/me/grantConsent": { + "/me/grantConsent": { "post": { "tags": [ "Me" ], "summary": "Grant Consent", - "description": "Grant consent to a subject on behalf of a user. Get the result from EvaluateConsent. Note that\r\n this route is eventually consistent. So EvaluateConsent might take some time to take over the granting of the consent.", + "description": "Grant consent to a subject on behalf of a user. Get the result from EvaluateConsent.", "operationId": "GrantConsent", "parameters": [ { "name": "tapio-application-id", "in": "header", - "description": "Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.", + "description": "Format - uuid.", "schema": { "$ref": "#/components/schemas/ApplicationIdHeader" } @@ -156,7 +206,6 @@ { "name": "api-version", "in": "header", - "description": "Use to specify the version of the API you want to use. Currently, only \"v1\" is supported.", "required": true, "schema": { "$ref": "#/components/schemas/ApiVersionHeader" @@ -169,45 +218,44 @@ "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GrantConsentRequest" + }, + "example": { + "consentSubjectId": "string", + "text": "string" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GrantConsentRequest" + }, + "example": { + "consentSubjectId": "string", + "text": "string" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GrantConsentRequest" + }, + "example": { + "consentSubjectId": "string", + "text": "string" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GrantConsentRequest" + }, + "example": { + "consentSubjectId": "string", + "text": "string" } } } }, "responses": { "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ConsentSubjectResponseCollectionResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConsentSubjectResponseCollectionResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ConsentSubjectResponseCollectionResponse" - } - } - } + "description": "OK" }, "400": { "description": "Bad Request", @@ -215,16 +263,33 @@ "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "default": { + "value": null + } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } } } @@ -235,16 +300,33 @@ "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "default": { + "value": null + } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } } } @@ -255,16 +337,33 @@ "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "default": { + "value": null + } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } } } @@ -275,16 +374,33 @@ "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "default": { + "value": null + } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } } } @@ -295,16 +411,33 @@ "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "default": { + "value": null + } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } } } @@ -312,19 +445,19 @@ } } }, - "/me/evaluateConsent": { + "/me/evaluateConsent": { "post": { "tags": [ "Me" ], - "summary": "Evaluate Consent", + "summary": "Evaluate user consent", "description": "Evaluates if the user has consented to the given subject.", "operationId": "EvaluateConsent", "parameters": [ { "name": "tapio-application-id", "in": "header", - "description": "Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.", + "description": "Format - uuid.", "schema": { "$ref": "#/components/schemas/ApplicationIdHeader" } @@ -332,7 +465,6 @@ { "name": "api-version", "in": "header", - "description": "Use to specify the version of the API you want to use. Currently, only \"v1\" is supported.", "required": true, "schema": { "$ref": "#/components/schemas/ApiVersionHeader" @@ -345,21 +477,33 @@ "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EvaluateConsentRequest" + }, + "example": { + "consentSubjectId": "string" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateConsentRequest" + }, + "example": { + "consentSubjectId": "string" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateConsentRequest" + }, + "example": { + "consentSubjectId": "string" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EvaluateConsentRequest" + }, + "example": { + "consentSubjectId": "string" } } } @@ -370,17 +514,28 @@ "content": { "text/plain": { "schema": { - "$ref": "#/components/schemas/ConsentSubjectResponseCollectionResponse" + "$ref": "#/components/schemas/EvaluateConsentResponse" + }, + "examples": { + "default": { + "value": null + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/ConsentSubjectResponseCollectionResponse" + "$ref": "#/components/schemas/EvaluateConsentResponse" + }, + "example": { + "hasConsented": true } }, "text/json": { "schema": { - "$ref": "#/components/schemas/ConsentSubjectResponseCollectionResponse" + "$ref": "#/components/schemas/EvaluateConsentResponse" + }, + "example": { + "hasConsented": true } } } @@ -391,16 +546,33 @@ "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "default": { + "value": null + } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } } } @@ -411,16 +583,33 @@ "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "default": { + "value": null + } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } } } @@ -431,16 +620,33 @@ "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "default": { + "value": null + } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } } } @@ -451,16 +657,252 @@ "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "default": { + "value": null + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] + } + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/evaluateConsent": { + "post": { + "tags": [ + "Subscription" + ], + "summary": "Evaluate subscription consent", + "description": "Evaluates if there is consent for the given subscription and consent subject.", + "operationId": "EvaluateSubscriptionConsent", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Format - uuid. Subscription ID", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "name": "tapio-application-id", + "in": "header", + "description": "Format - uuid.", + "schema": { + "$ref": "#/components/schemas/ApplicationIdHeader" + } + }, + { + "name": "api-version", + "in": "header", + "required": true, + "schema": { + "$ref": "#/components/schemas/ApiVersionHeader" + } + } + ], + "requestBody": { + "description": "Evaluate consent body.", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/EvaluateSubscriptionConsentRequest" + }, + "example": { + "consentSubjectId": "string" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/EvaluateSubscriptionConsentRequest" + }, + "example": { + "consentSubjectId": "string" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/EvaluateSubscriptionConsentRequest" + }, + "example": { + "consentSubjectId": "string" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/EvaluateSubscriptionConsentRequest" + }, + "example": { + "consentSubjectId": "string" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/EvaluateSubscriptionConsentResponse" + }, + "examples": { + "default": { + "value": null + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/EvaluateSubscriptionConsentResponse" + }, + "example": { + "hasConsented": true + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/EvaluateSubscriptionConsentResponse" + }, + "example": { + "hasConsented": true + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "default": { + "value": null + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "default": { + "value": null + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "default": { + "value": null + } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" + }, + "example": { + "message": "string", + "details": [ + "string" + ] } } } @@ -473,14 +915,14 @@ "schemas": { "ApplicationIdHeader": { "type": "string", - "format": "uuid", - "description": "Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application." + "description": "Use to specify a tapio application ID, in case your Entra ID client application is assigned to more than one tapio application.", + "format": "uuid" }, "ApiVersionHeader": { - "type": "string", "enum": [ "v1" ], + "type": "string", "description": "Use to specify the version of the API you want to use. Currently, only \"v1\" is supported." }, "ConsentSubjectResponse": { @@ -555,6 +997,40 @@ "additionalProperties": false, "description": "Evaluate consent request." }, + "EvaluateConsentResponse": { + "type": "object", + "properties": { + "hasConsented": { + "type": "boolean", + "description": "True when the user has given consent." + } + }, + "additionalProperties": false, + "description": "Evaluate consent response." + }, + "EvaluateSubscriptionConsentRequest": { + "type": "object", + "properties": { + "consentSubjectId": { + "type": "string", + "description": "Consent subject ID.", + "format": "uuid" + } + }, + "additionalProperties": false, + "description": "Evaluate subscription consent request." + }, + "EvaluateSubscriptionConsentResponse": { + "type": "object", + "properties": { + "hasConsented": { + "type": "boolean", + "description": "True when a user has given consent for the subscription." + } + }, + "additionalProperties": false, + "description": "Evaluate subscription consent response." + }, "GrantConsentRequest": { "type": "object", "properties": { @@ -596,7 +1072,7 @@ }, "security": [ { - "oauth2": [ ] + "oauth2": [] } ], "tags": [ @@ -605,6 +1081,9 @@ }, { "name": "Me" + }, + { + "name": "Subscription" } ] -} \ No newline at end of file +}