openapi: 3.0.0 info: title: slovensko.sk API version: 3.9.0 (Komunitná verzia) 8.10.0 (Prémium verzia) description: | slovensko.sk API je proxy REST API komponent k službám www.slovensko.sk (Ústredný portál verejnej správy – ÚPVS), pomocou ktorých je možné: **Komunitná verzia** (EUPL 1.2 licencia) - uskutočniť prihlásenie pomocou ÚPVS (pomocou elektronického občianskeho preukazu) a získať údaje o prihlásenom subjekte, - manipulovať s obsahom el. schránky a preberať poštu do vlastných rúk, - podávať podania v mene subjektu, ktorý sa prihlásil cez ÚPVS alebo pomocou technického účtu, - vyhľadávať subjekty (právnické a fyzické osoby) za účelom zasielania správ (dostupné len pre OVM), - skontrolovať či je daná správa vo formáte SKTalk validná voči aktuálnej definícii formulára (podporná funkcia). **Prémium verzia** (komerčná licencia) - ukladať záznamy do dlhodobého úložiska registratúrnych záznamov, - zverejnovať dokumenty na centrálnej úradnej tabuli (dostupné len pre OVM), - podpisovať správy pomocou kvalifikovanej pečate uloženej v úložisku na slovensko.sk, - pridávať kvalifikované časové pečiatky elektronicky podpísaným dokumentom, - informatívne overovať podpisy na elektronicky podpísaných dokumentoch, - generovať doložky o autorizácii (dostupné len pre OVM), - získať informácie o type a forme podpisov elektronicky podpísaných dokumentov. contact: name: Služby Slovensko.Digital, s.r.o. url: https://ekosystem.slovensko.digital email: ekosystem@slovensko.digital servers: - description: Komunitná verzia v prostredí ÚPVS FIX url: https://fix.slovensko-sk-api.staging.slovensko.digital - description: Prémium verzia v prostredí ÚPVS FIX url: https://fix.premium-slovensko-sk-api.staging.slovensko.digital # TODO check if response codes specified here match response codes in API controllers # TODO consider using 201 when creating stuff, for example return 201 when successfully sending sktalk message: receive_result == 0 (a resource -- message is created) but return 202 when unsuccessfully sending sktalk message: receive_result != 0 paths: /login: get: tags: [Prihlasovanie pomocou eID] summary: Prihlási používateľa pomocou eID description: | Prihlási používateľa pomocou slovensko.sk (ÚPVS). Po úspešnom prihlásení nasleduje presmerovanie späť na callback URL tretej strany nastavený v premenných prostredia API (LOGIN_CALLBACK_URL). V parametri `token` bude zaslaný OBO (On-Behalf-Of) token použiteľný na získanie údajov o prihlásenom používateľovi alebo na volanie ďaľších rozhraní v mene prihláseného používateľa. responses: 302: description: Úspešné presmerovanie na prihlasovaciu stránku ÚPVS a následne na callback URL tretej strany. callbacks: login_callback: '{$LOGIN_CALLBACK_URL}': get: parameters: - name: token in: query required: true description: | OBO token v JWT formáte, ktorého payload vyzerá nasledovne: { "sub": "ico://sk/83130022", "exp": 1545147549, "nbf": 1545146349, "iat": 1545146349, "jti": "ad8e5d2a-85ff-46b9-a13f-ac860db9acee", "name": "Identita 83130022", "actor": { "name": "Janko Tisíci", "sub": "rc://sk/8314451337_tisici_janko" }, "scopes": [ "sktalk/receive", "sktalk/receive_and_save_to_outbox", "sktalk/save_to_outbox", "sktalk/prepare_for_later_receive", "upvs/assertion", "upvs/identity" ] } schema: type: string format: jwt responses: 200: description: Úspešné prihlásenie. post: tags: [Prihlasovanie pomocou eID] summary: Prihlási používateľa pomocou SAML assertion description: | Prihlási používateľa pomocou slovensko.sk (ÚPVS) na základe prijatej SAML assertion. Umožňuje vykonať ÚPVS SSO mimo slovensko-sk-api a poslať na API iba SAML assertion. V parametri `token` bude zaslaný OBO (On-Behalf-Of) token použiteľný na získanie údajov o prihlásenom používateľovi alebo na volanie ďaľších rozhraní v mene prihláseného používateľa. requestBody: required: true content: application/json: schema: type: object properties: saml_assertion: description: Base64 SAML assertion získaná z ÚPVS. type: string format: base64 example: <saml:Assertion ID="id-ESbTYc2GewpP6uvmc5qhYuKD-jIyNnHYklTYF5Wc" IssueInstant="2022-04-22T10:05:47Z" Version="2.0" xmlns:dsig="http://www.w3.org/2000/09/xmldsig#" xmlns:enc="http://www.w3.org/2001/04/xmlenc#" xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol" xmlns:x500="urn:oasis:names:tc:SAML:2.0:profiles:attribute:X500" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><saml:Issuer Format="urn:oasis:names:tc:SAML:2.0:nameid-format:entity">https://prihlasenie.upvsfix.gov.sk/oam/fed</saml:Issuer><dsig:Signature><dsig:SignedInfo><dsig:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/><dsig:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/><dsig:Reference URI="#id-ESbTYc2GewpP6uvmc5qhYuKD-jIyNnHYklTYF5Wc"><dsig:Transforms><dsig:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/><dsig:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/></dsig:Transforms><dsig:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/><dsig:DigestValue>eqMK8D1AILg6jjiWtTScE2vz5ba3J0Qvnlt6LNuwC3c=</dsig:DigestValue></dsig:Reference></dsig:SignedInfo><dsig:SignatureValue>frXPf0oxW4F0wtmOGgW1N/v+S4Kakhogj7duJg6gb2iwvp22BjHJqbJ81JqpQKEeUbdGNb5PDvQrIvOL4lhOXEIlOzMmCq4aaX3aAmNs4jn0/Duq7kVk+KV3m5yMcjdMldqteFDFuwZs2MvGd2HfisucIVyDwuooeptWSln4sxonO6wuAG/TtI2wD9/144HFoUk5FQGUn3avV9SW2pN2YMvfYOhrJEp6/16AEO322RU+t3yVNv3q/s/ydtjjwuI0loCjWnQigbjkCFZHlY9FMq9PcDMDh/aX8e0LIk7Nsscieyk6g2WjcfW7LsLnvKU1TPpHT2VlqowNC8+eLsPafg==</dsig:SignatureValue><dsig:KeyInfo><dsig:X509Data><dsig:X509Certificate>MIIDMDCCAhigAwIBAgIKMO7RiwAAAAADkDANBgkqhkiG9w0BAQsFADAaMRgwFgYDVQQDEw9jYS5zbG92ZW5za28uc2swHhcNMjEwMjIyMDc1MTE1WhcNMjMwMjIyMDgwMTE1WjAdMRswGQYDVQQDExJpZHAudXB2c2ZpeC5nb3Yuc2swggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCpRqfUUOiZIge6t1//eA2bs0G7GJR4pvUiMDljjt2AMhR3Ym2NdpE69DAzBRcF+Ie15rVdpiCO00tUAXdUKAuwFV1OkMZYjyQjRqYvOFmYZOTDNX7bC7rffI/3AL3BCuDY36nScZJBhQGoiYD2wt3GPzO6IRUdQbQc5PhX2Caf47hDEf/bH+G531p5O5PR3Hai8seNWTP/1lPd0rkuHpnjnS1C9wtNh1AWhjXZri+1HpVYqhjrSgy0+kfkVCsI+wLA/Kh6BHynfkzlAU825TjqckGPHfnXr6c+fsLyNCNO9XbIulYZfQrd0PJ2NjbyaaS581kpmZtjzd7jgc7SleffAgMBAAGjdTBzMA4GA1UdDwEB/wQEAwIE8DATBgNVHSUEDDAKBggrBgEFBQcDAjAdBgNVHQ4EFgQUvSPN0oXzUvwbr5gOjYjPwwsO3K4wHwYDVR0jBBgwFoAUKlO3Thprk0Xf6VQr2tu4TpoSzoYwDAYDVR0TAQH/BAIwADANBgkqhkiG9w0BAQsFAAOCAQEAHW5wJDGQxhTvDbC+Dy7+uvYV6X+N6jBT3Hbvlk3EulnttdlOQklkPz0ZEsBu59/OS5xujxy+/kaembnzxgZO87IzxwriEsf1r1qFZ5mqtF8xcV6GoEBLHrH1mSCf8c01R/Lx7k6e7zexxY4Ei408L2sXXIuCPf88crGOPVXqcSCSEvhHZSVpN84TKfEHcCpGPGv9+Re2HvnRoG0oOJhUKmVkLCK55I5qiBQpRf4/HW/ldELGnpScvQBUUSMRAHDN4vaztpBChGfDADJ1dxAhk0C+rMkQwl2CiaNPK/p6nS99hIsR+GkFPbWQ1/Tc4sGbv2dAhffvtMl7G6fzGfLcmw==</dsig:X509Certificate></dsig:X509Data></dsig:KeyInfo></dsig:Signature><saml:Subject><saml:NameID Format="urn:oasis:names:tc:SAML:2.0:nameid-format:transient" NameQualifier="https://prihlasenie.upvsfix.gov.sk/oam/fed" SPNameQualifier="https://fix.premium-slovensko-sk-api.staging.slovensko.digital">id-JQ13XCDp3MTBdYa1ayLfwTAuqv6Gyx4w1MvRoc9l</saml:NameID><saml:SubjectConfirmation Method="urn:oasis:names:tc:SAML:2.0:cm:bearer"><saml:SubjectConfirmationData InResponseTo="_ee002102-432b-4750-822e-875ed37f82bb" NotOnOrAfter="2022-04-22T10:25:47Z" Recipient="https://fix.premium-slovensko-sk-api.staging.slovensko.digital/auth/saml/callback"/></saml:SubjectConfirmation></saml:Subject><saml:Conditions NotBefore="2022-04-22T10:05:47Z" NotOnOrAfter="2022-04-22T10:25:47Z"><saml:AudienceRestriction><saml:Audience>https://fix.premium-slovensko-sk-api.staging.slovensko.digital</saml:Audience></saml:AudienceRestriction></saml:Conditions><saml:AuthnStatement AuthnInstant="2022-04-22T10:05:47Z" SessionIndex="id-2qIgroWe6SebywqIn96wpiu3k7AZ6pyC0B8VBlUf" SessionNotOnOrAfter="2022-04-22T10:25:47Z"><saml:AuthnContext><saml:AuthnContextClassRef>urn:oasis:names:tc:SAML:2.0:ac:classes:SmartcardPKI</saml:AuthnContextClassRef></saml:AuthnContext></saml:AuthnStatement><saml:AttributeStatement><saml:Attribute Name="DerivedFromID" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:nil="true"/></saml:Attribute><saml:Attribute Name="SubjectIDSector" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">SECTOR_UPVS</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Actor.AuthResourceType" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">1</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Actor.AuthResourceSubType" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema"/></saml:Attribute><saml:Attribute Name="Subject.FormattedName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Janko Tisíci</saml:AttributeValue></saml:Attribute><saml:Attribute Name="SubjectID" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">rc://sk/8311577830_tisici_janko</saml:AttributeValue></saml:Attribute><saml:Attribute Name="AssertionType" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">WEBSSO</saml:AttributeValue></saml:Attribute><saml:Attribute Name="QAALevel" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">1</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Subject.eDeskRemoteURI" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema"/></saml:Attribute><saml:Attribute Name="DelegationMediatorID" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema"/></saml:Attribute><saml:Attribute Name="Subject.IdentityType" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">1</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Actor.PCO" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">8311577830</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Subject.FirstName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Janko</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Actor.FormattedName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Janko Tisíci</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Subject.PCO" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">8311577830</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Subject.TerminationDate" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema"/></saml:Attribute><saml:Attribute Name="Actor.Username" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">E0005183138</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Actor.Email" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">test@slovensko.sk</saml:AttributeValue></saml:Attribute><saml:Attribute Name="DelegationType" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">0</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Actor.LastName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Tisíci</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Actor.IdentityType" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">1</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Actor.FirstName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Janko</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Subject.eDeskStatus" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">DELIVERABLE</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Actor.UPVSIdentityID" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">63C9FEE6-33A7-43F9-8432-1E0FA6BFFB55</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Subject.ICO" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema"/></saml:Attribute><saml:Attribute Name="ActorID" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">rc://sk/8311577830_tisici_janko</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Subject.UPVSIdentityID" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">63C9FEE6-33A7-43F9-8432-1E0FA6BFFB55</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Roles" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">R_MDURZ_READER</saml:AttributeValue><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">R_MDURZ_WRITER</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Actor.REIdentityId" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">5184982</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Subject.PreferredLanguage" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema"/></saml:Attribute><saml:Attribute Name="Subject.REIdentityId" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">5184982</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Subject.LastName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Tisíci</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Actor.PreferredLanguage" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema"/></saml:Attribute><saml:Attribute Name="Subject.Email" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">test@slovensko.sk</saml:AttributeValue></saml:Attribute><saml:Attribute Name="ActorIDSector" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">SECTOR_UPVS</saml:AttributeValue></saml:Attribute><saml:Attribute Name="Subject.eDeskNumber" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">E0005183138</saml:AttributeValue></saml:Attribute><saml:Attribute Name="DerivedFrom.UPVSIdentityID" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic"><saml:AttributeValue xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema"/></saml:Attribute></saml:AttributeStatement></saml:Assertion>
 required: - saml_assertion responses: 200: description: | OBO token v JWT formáte, ktorého payload vyzerá nasledovne: { "sub": "ico://sk/83130022", "exp": 1545153549, "nbf": 1545146349, "iat": 1545146349, "jti": "ad8e5d2a-85ff-46b9-a13f-ac860db9acee", "name": "Identita 83130022", "actor": { "name": "Janko Tisíci", "sub": "rc://sk/8314451337_tisici_janko" }, "scopes": [ "sktalk/receive", "sktalk/receive_and_save_to_outbox", "sktalk/save_to_outbox" ] } content: application/json: schema: type: object properties: token: schema: type: string format: jwt required: - token security: - 'API Token': [] /logout: get: tags: [Prihlasovanie pomocou eID] summary: Odhlási používateľa description: | Odhlási používateľa pomocou slovensko.sk (ÚPVS). Po úspešnom odhlásení nasleduje presmerovanie späť na callback URL tretej strany nastavený v premenných prostredia API (LOGOUT_CALLBACK_URL). Ak URL obsahuje callback (pri odhlásení iniciovanom zo strany ÚPVS), je potrebné spraviť redirect na callback. responses: 302: description: Úspešné presmerovanie na callback URL tretej strany. callbacks: logout_callback: '{$LOGOUT_CALLBACK_URL}': get: responses: 200: description: Úspešné odhlásenie. security: - 'API + OBO Token': [] /api/upvs/assertion: get: tags: [Informácie o prihlásenom používateľovi] summary: Vráti bezpečnostné informácie prihláseného používateľa description: | Vráti bezpečnostné informácie prihláseného používateľa. parameters: - name: Accept in: header required: true schema: type: string format: mime example: application/samlassertion+xml responses: 200: description: Úspešne vrátené bezpečnostné informácie prihláseného používateľa. content: application/samlassertion+xml: schema: type: string format: saml xml: prefix: saml name: Assertion namespace: urn:oasis:names:tc:SAML:2.0:assertion example: ... security: - 'API + OBO Token': [] /api/upvs/identity: get: tags: [Informácie o prihlásenom používateľovi] summary: Vráti identitu prihláseného používateľa description: | Vráti identitu prihláseného používateľa. Pozor, volanie je dostupné len pre OVM. responses: 200: description: Úspešne vrátená identita prihláseného používateľa. content: application/json: schema: oneOf: - $ref: '#/components/schemas/UpvsNaturalPerson' - $ref: '#/components/schemas/UpvsCorporateBody' security: - 'API + OBO Token': [] /api/sktalk/receive: post: tags: [Zasielanie podaní] summary: Odošle správu description: | Odošle SKTalk správu. Za normálnych okolností je potrebné odoslanú správu následne uložiť medzi odoslané správy v schránke. Využite endpoint `api/sktalk/save_to_outbox` alebo `api/sktalk/receive_and_save_to_outbox`. requestBody: required: true content: application/json: schema: type: object properties: message: description: SKTalk správa vo formáte XML. type: string format: xml example: Slovensko.DigitalPozdrav zo Slovensko.DIgital. :) unsigned_zepfzip_objects: description: Nepodpísané dátové objekty v ZEPf. type: array items: description: Objekt podpisu. properties: id: description: Identifikátor objektu. type: string example: Vseobecna_agenda.xml data: description: Dáta objektu. type: string example: Slovensko.DigitalPozdrav zo Slovensko.DIgital. :) unsigned_asic_objects: description: Nepodpísané dátové objekty v ASIC. type: array items: description: Objekt podpisu. properties: id: description: Identifikátor objektu. type: string example: Vseobecna_agenda.xml data: description: Dáta objektu. type: string example: Slovensko.DigitalPozdrav zo Slovensko.DIgital. :) required: - result - description security: - 'API Token': [] /api/mdurz/records: post: tags: [Dlhodobé úložisko] summary: Vloží nový záznam do úložiska description: | Odošle požiadavku na vloženie nového záznamu do úložiska. Do schránky príde odpoveď s SKTalk triedou `MDURZ_INGEST_REPLY_04`. Voči zaslanej požiadavke je možné párovanie cez poskytnutý `request_id`. Volanie automaticky validuje, či je interne používaná správna verzia formulára. Nie je potrebné kontrolovať validitu formulára externe. parameters: - name: request_id in: query required: true description: Identifikátor požiadavky. schema: type: string format: uuid - name: custom_id in: query required: true description: Značka záznamu. schema: type: string - name: title in: query required: true description: Názov záznamu. schema: type: string - name: description in: query required: true description: Popis záznamu. schema: type: string - name: access in: query required: true description: | Indikátor dostupnosti záznamu: - `PUBLIC` verejný, - `PRIVATE` súkromný. schema: type: string enum: [PUBLIC, PRIVATE] - name: retention_period in: query required: true description: | Dĺžka uchovania záznamu: - `R1` uchovanie na 1 rok, - `R2` uchovanie na 2 roky, - `R5` uchovanie na 5 rokov. schema: type: string enum: [R1, R3, R5] requestBody: required: true content: application/json: schema: type: object properties: message_id: type: string format: uuid correlation_id: type: string format: uuid sender_uri: type: string format: uri recipient_uri: type: string format: uri objects: type: array items: $ref: '#/components/schemas/EdeskMessageObject' required: - message_id - correlation_id - sender_uri - recipient_uri - objects responses: 200: description: Úspešné odoslanie požiadavky na vloženie nového záznamu do úložiska. content: application/json: schema: $ref: '#/components/schemas/SktalkReceiveAndSaveToOutboxResult' examples: 'Úspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNoSave' 'Úspešné odoslanie a úspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutbox' 'Úspešné odoslanie a neúspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNonZeroSave' 'Neúspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNonZeroReceive' 408: description: Neúspešné odoslanie požiadavky na vloženie nového záznamu do úložiska ak prišlo k vypršaniu času požiadavky na ÚPVS. content: application/json: schema: $ref: '#/components/schemas/SktalkReceiveAndSaveToOutboxResult' examples: 'Úspešné odoslanie a neúspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithSaveTimeout' 'Neúspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithReceiveTimeout' security: - 'API Token': [] /api/mdurz/records/{id}: patch: tags: [Dlhodobé úložisko] summary: Zmení popisné údaje záznamu v úložisku description: | Odošle požiadavku na zmenu popisných údajov záznamu v úložisku. Do schránky príde odpoveď s SKTalk triedou `MDURZ_SET_METADATA_REPLY_04`. Voči zaslanej požiadavke je možné párovanie cez poskytnutý `request_id`. Volanie automaticky validuje, či je interne používaná správna verzia formulára. Nie je potrebné kontrolovať validitu formulára externe. parameters: - name: id in: path required: true description: Identifikátor záznamu v úložisku. schema: type: string format: uuid - name: request_id in: query required: true description: Identifikátor požiadavky. schema: type: string format: uuid - name: custom_id in: query required: true description: Nová značka záznamu. schema: type: string - name: title in: query required: true description: Nový názov záznamu. schema: type: string - name: description in: query required: true description: Nový popis záznamu. schema: type: string - name: access in: query required: true description: | Nový indikátor dostupnosti záznamu: - `PUBLIC` verejný, - `PRIVATE` súkromný. schema: type: string enum: [PUBLIC, PRIVATE] requestBody: required: true content: application/json: schema: type: object properties: message_id: type: string format: uuid correlation_id: type: string format: uuid sender_uri: type: string format: uri recipient_uri: type: string format: uri required: - message_id - correlation_id - sender_uri - recipient_uri responses: 200: description: Úspešné odoslanie požiadavky na zmenu popisných údajov záznamu v úložisku. content: application/json: schema: $ref: '#/components/schemas/SktalkReceiveAndSaveToOutboxResult' examples: 'Úspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNoSave' 'Úspešné odoslanie a úspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutbox' 'Úspešné odoslanie a neúspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNonZeroSave' 'Neúspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNonZeroReceive' 408: description: Neúspešné odoslanie požiadavky na zmenu popisných údajov záznamu v úložisku ak prišlo k vypršaniu času požiadavky na ÚPVS. content: application/json: schema: $ref: '#/components/schemas/SktalkReceiveAndSaveToOutboxResult' examples: 'Úspešné odoslanie a neúspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithSaveTimeout' 'Neúspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithReceiveTimeout' security: - 'API Token': [] delete: tags: [Dlhodobé úložisko] summary: Vyradí záznam z úložiska description: | Odošle požiadavku na vyradenie záznamu z úložiska. Do schránky príde odpoveď s SKTalk triedou `MDURZ_CANCEL_PRESERVATION_REPLY_04` obsahujúca uložený záznam. Voči zaslanej požiadavke je možné párovanie cez poskytnutý `request_id`. Volanie automaticky validuje, či je interne používaná správna verzia formulára. Nie je potrebné kontrolovať validitu formulára externe. parameters: - name: id in: path required: true description: Identifikátor záznamu v úložisku. schema: type: string format: uuid - name: request_id in: query required: true description: Identifikátor požiadavky. schema: type: string format: uuid - name: destination in: query required: true description: Cieľ poskytnutia záznamu. schema: type: string enum: [EDESK, NONE] requestBody: required: true content: application/json: schema: type: object properties: message_id: type: string format: uuid correlation_id: type: string format: uuid sender_uri: type: string format: uri recipient_uri: type: string format: uri required: - message_id - correlation_id - sender_uri - recipient_uri responses: 200: description: Úspešné odoslanie požiadavky na vyradenie záznamu z úložiska. content: application/json: schema: $ref: '#/components/schemas/SktalkReceiveAndSaveToOutboxResult' examples: 'Úspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNoSave' 'Úspešné odoslanie a úspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutbox' 'Úspešné odoslanie a neúspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNonZeroSave' 'Neúspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNonZeroReceive' 408: description: Neúspešné odoslanie požiadavky na vyradenie záznamu z úložiska ak prišlo k vypršaniu času požiadavky na ÚPVS. content: application/json: schema: $ref: '#/components/schemas/SktalkReceiveAndSaveToOutboxResult' examples: 'Úspešné odoslanie a neúspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithSaveTimeout' 'Neúspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithReceiveTimeout' security: - 'API Token': [] /api/mdurz/records/{id}/extend: patch: tags: [Dlhodobé úložisko] summary: Predĺži dobu uchovania záznamu v úložisku description: | Odošle požiadavku na predĺženie doby uchovania záznamu v úložisku. Do schránky príde odpoveď s SKTalk triedou `MDURZ_EXTEND_PRESERVATION_REPLY_04` obsahujúca uložený záznam. Voči zaslanej požiadavke je možné párovanie cez poskytnutý `request_id`. MDURZ zasiela notifikačné správy o blížiacej sa končicej lehote s SKTalk triedou `MDURZ_EXPIRATION_WARNING_04` a notifikačné správy o expirovanom zázname s SKTalk triedou `MDURZ_EXPIRATION_NOTIFICATION_04`. Volanie automaticky validuje, či je interne používaná správna verzia formulára. Nie je potrebné kontrolovať validitu formulára externe. parameters: - name: id in: path required: true description: Identifikátor záznamu v úložisku. schema: type: string format: uuid - name: request_id in: query required: true description: Identifikátor požiadavky. schema: type: string format: uuid - name: retention_period in: query required: true description: | Dĺžka uchovania záznamu: - `R1` predĺženie o 1 rok, - `R2` predĺženie o 2 roky, - `R5` predĺženie o 5 rokov. schema: type: string enum: [R1, R3, R5] requestBody: required: true content: application/json: schema: type: object properties: message_id: type: string format: uuid correlation_id: type: string format: uuid sender_uri: type: string format: uri recipient_uri: type: string format: uri required: - message_id - correlation_id - sender_uri - recipient_uri responses: 200: description: Úspešné odoslanie požiadavky na predĺženie doby uchovania záznamu v úložisku. content: application/json: schema: $ref: '#/components/schemas/SktalkReceiveAndSaveToOutboxResult' examples: 'Úspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNoSave' 'Úspešné odoslanie a úspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutbox' 'Úspešné odoslanie a neúspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNonZeroSave' 'Neúspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNonZeroReceive' 408: description: Neúspešné odoslanie požiadavky na predĺženie doby uchovania záznamu v úložisku ak prišlo k vypršaniu času požiadavky na ÚPVS. content: application/json: schema: $ref: '#/components/schemas/SktalkReceiveAndSaveToOutboxResult' examples: 'Úspešné odoslanie a neúspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithSaveTimeout' 'Neúspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithReceiveTimeout' security: - 'API Token': [] /api/mdurz/records/{id}/disseminate: post: tags: [Dlhodobé úložisko] summary: Získa záznam z úložiska description: | Odošle požiadavku na získanie záznamu z úložiska. Do schránky príde odpoveď s SKTalk triedou `MDURZ_DISSEMINATE_REPLY_04` obsahujúca uložený záznam. Voči zaslanej požiadavke je možné párovanie cez poskytnutý `request_id`. Volanie automaticky validuje, či je interne používaná správna verzia formulára. Nie je potrebné kontrolovať validitu formulára externe. parameters: - name: id in: path required: true description: Identifikátor záznamu v úložisku. schema: type: string format: uuid - name: request_id in: query required: true description: Identifikátor požiadavky. schema: type: string format: uuid - name: destination in: query required: true description: Cieľ poskytnutia záznamu. schema: type: string enum: [EDESK, NONE] requestBody: required: true content: application/json: schema: type: object properties: message_id: type: string format: uuid correlation_id: type: string format: uuid sender_uri: type: string format: uri recipient_uri: type: string format: uri required: - message_id - correlation_id - sender_uri - recipient_uri responses: 200: description: Úspešné odoslanie požiadavky na získanie záznamu z úložiska. content: application/json: schema: $ref: '#/components/schemas/SktalkReceiveAndSaveToOutboxResult' examples: 'Úspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNoSave' 'Úspešné odoslanie a úspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutbox' 'Úspešné odoslanie a neúspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNonZeroSave' 'Neúspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNonZeroReceive' 408: description: Neúspešné odoslanie požiadavky na získanie záznamu z úložiska ak prišlo k vypršaniu času požiadavky na ÚPVS. content: application/json: schema: $ref: '#/components/schemas/SktalkReceiveAndSaveToOutboxResult' examples: 'Úspešné odoslanie a neúspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithSaveTimeout' 'Neúspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithReceiveTimeout' security: - 'API Token': [] /api/cuet/documents/publish_document: post: tags: [Centrálna úradná tabuľa (dostupné len pre OVM)] summary: Zverejnení dokument description: | Odošle požiadavku na zverejnenie dokumentu. Do schránky príde odpoveď s SKTalk triedou `CUET_NOTIFY_ENTERING`. Voči zaslanej požiadavke je možné párovanie cez poskytnutý `request_id`. Volanie automaticky validuje, či je interne používaná správna verzia formulára. Nie je potrebné kontrolovať validitu formulára externe. Pozor, volanie je dostupné len pre OVM. parameters: - name: request_id in: query required: true description: Identifikátor požiadavky. schema: type: string format: uuid - name: publisher_uri in: query required: true description: Identifikátor inštitúcie, ktorá je zverejňovateľom dokumentu. schema: type: string format: uri - name: author_uri in: query required: true description: Identifikátor identity, ktorá je autorom dokumentu. schema: type: string format: uri - name: original_id in: query description: Identifikátor dokumentu, ktorý je pridelený autorom. schema: type: string format: uuid - name: name in: query description: Názov dokumentu. required: true schema: type: string - name: abstract in: query description: Abstrakt dokumentu. schema: type: string - name: registry_mark in: query description: Registratúrna značka dokumentu. schema: type: string - name: registry_number in: query description: Číslo registratúrneho záznamu dokumentu. schema: type: string - name: published_from in: query description: Začiatok zverejnenia dokumentu. schema: type: string - name: published_days in: query description: Počet dní počas ktorých má byť dokument zverejnený. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: message_id: type: string format: uuid correlation_id: type: string format: uuid sender_uri: type: string format: uri recipient_uri: type: string format: uri objects: type: array items: $ref: '#/components/schemas/EdeskMessageObject' required: - message_id - correlation_id - sender_uri - recipient_uri - objects responses: 200: description: Úspešné odoslanie požiadavky na zverejnenie dokumentu. content: application/json: schema: $ref: '#/components/schemas/SktalkReceiveAndSaveToOutboxResult' examples: 'Úspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNoSave' 'Úspešné odoslanie a úspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutbox' 'Úspešné odoslanie a neúspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNonZeroSave' 'Neúspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNonZeroReceive' 408: description: Neúspešné odoslanie požiadavky na zverejnenie dokumentu ak prišlo k vypršaniu času požiadavky na ÚPVS. content: application/json: schema: $ref: '#/components/schemas/SktalkReceiveAndSaveToOutboxResult' examples: 'Úspešné odoslanie a neúspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithSaveTimeout' 'Neúspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithReceiveTimeout' security: - 'API Token': [] /api/cuet/documents/deliver_by_publishing: post: tags: [Centrálna úradná tabuľa (dostupné len pre OVM)] summary: Doručí dokument zverejnením description: | Odošle požiadavku na doručenie dokumentu zverejnením. Do schránky príde odpoveď s SKTalk triedou `CUET_NOTIFY_DELIVERY`. Voči zaslanej požiadavke je možné párovanie cez poskytnutý `request_id`. Volanie automaticky validuje, či je interne používaná správna verzia formulára. Nie je potrebné kontrolovať validitu formulára externe. Pozor, volanie je dostupné len pre OVM. parameters: - name: request_id in: query required: true description: Identifikátor požiadavky. schema: type: string format: uuid - name: publisher_uri in: query required: true description: Identifikátor inštitúcie, ktorá je zverejňovateľom dokumentu. schema: type: string format: uri - name: author_uri in: query required: true description: Identifikátor identity, ktorá je autorom dokumentu. schema: type: string format: uri - name: original_id in: query description: Identifikátor dokumentu, ktorý je pridelený autorom. schema: type: string format: uuid - name: name in: query required: true description: Názov dokumentu. schema: type: string - name: abstract in: query description: Abstrakt dokumentu. schema: type: string - name: registry_mark in: query description: Registratúrna značka dokumentu. schema: type: string - name: registry_number in: query description: Číslo registratúrneho záznamu dokumentu. schema: type: string - name: published_from in: query description: Začiatok zverejnenia dokumentu. schema: type: string - name: published_days in: query description: Počet dní počas ktorých má byť dokument zverejnený. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: message_id: type: string format: uuid correlation_id: type: string format: uuid sender_uri: type: string format: uri recipient_uri: type: string format: uri objects: type: array items: $ref: '#/components/schemas/EdeskMessageObject' required: - message_id - correlation_id - sender_uri - recipient_uri - objects responses: 200: description: Úspešné odoslanie požiadavky na doručenie dokumentu zverejnením. content: application/json: schema: $ref: '#/components/schemas/SktalkReceiveAndSaveToOutboxResult' examples: 'Úspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNoSave' 'Úspešné odoslanie a úspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutbox' 'Úspešné odoslanie a neúspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNonZeroSave' 'Neúspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNonZeroReceive' 408: description: Neúspešné odoslanie požiadavky na doručenie dokumentu zverejnením ak prišlo k vypršaniu času požiadavky na ÚPVS. content: application/json: schema: $ref: '#/components/schemas/SktalkReceiveAndSaveToOutboxResult' examples: 'Úspešné odoslanie a neúspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithSaveTimeout' 'Neúspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithReceiveTimeout' security: - 'API Token': [] /api/cuet/documents/{id}: patch: tags: [Centrálna úradná tabuľa (dostupné len pre OVM)] summary: Zmení dobu zverejnenia dokumentu description: | Odošle požiadavku na zmenu doby zverejnenia dokumentu. Do schránky príde odpoveď s SKTalk triedou `CUET_NOTIFY_REVOCATION`. Voči zaslanej požiadavke je možné párovanie cez poskytnutý `request_id`. Volanie automaticky validuje, či je interne používaná správna verzia formulára. Nie je potrebné kontrolovať validitu formulára externe. Pozor, volanie je dostupné len pre OVM. parameters: - name: id in: path required: true description: Identifikátor dokumentu. schema: type: string - name: request_id in: query required: true description: Identifikátor požiadavky. schema: type: string format: uuid - name: revocation_reason in: query required: true description: Dôvod odvolania zverejňovania. schema: type: string - name: revoked_on in: query required: true description: Dátum ukončenia zverejňovania. schema: type: string format: date requestBody: required: true content: application/json: schema: type: object properties: message_id: type: string format: uuid correlation_id: type: string format: uuid sender_uri: type: string format: uri recipient_uri: type: string format: uri required: - message_id - correlation_id - sender_uri - recipient_uri responses: 200: description: Úspešné odoslanie požiadavky na zmenu doby zverejnenia dokumentu. content: application/json: schema: $ref: '#/components/schemas/SktalkReceiveAndSaveToOutboxResult' examples: 'Úspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNoSave' 'Úspešné odoslanie a úspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutbox' 'Úspešné odoslanie a neúspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNonZeroSave' 'Neúspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithNonZeroReceive' 408: description: Neúspešné odoslanie požiadavky na zmenu doby zverejnenia dokumentu zverejnením ak prišlo k vypršaniu času požiadavky na ÚPVS. content: application/json: schema: $ref: '#/components/schemas/SktalkReceiveAndSaveToOutboxResult' examples: 'Úspešné odoslanie a neúspešné uloženie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithSaveTimeout' 'Neúspešné odoslanie': $ref: '#/components/examples/SktalkReceiveAndSaveToOutboxWithReceiveTimeout' security: - 'API Token': [] /api/iam/identities/{id}: get: tags: [Vyhľadávanie identít (dostupné len pre OVM)] summary: Vráti identitu podľa ID description: | Vráti identitu na základe ID identity. Pozor, volanie je dostupné len pre OVM. parameters: - name: id in: path required: true description: ID identity. schema: type: string format: uuid example: 6d9dc77b-70ed-432f-abaa-5de8753c967c responses: 200: description: Úspešne vrátená identita. content: application/json: schema: oneOf: - $ref: '#/components/schemas/UpvsCorporateBody' - $ref: '#/components/schemas/UpvsNaturalPerson' examples: 'Právnická osoba': value: $ref: '#/components/schemas/UpvsCorporateBody/example' 'Fyzická osoba': value: $ref: '#/components/schemas/UpvsNaturalPerson/example' security: - 'API Token': [] /api/iam/identities/lookup: get: tags: [Vyhľadávanie identít (dostupné len pre OVM)] summary: Vráti identitu podľa osobných údajov alebo IČO description: | Vráti identitu na základe osobných údajov alebo IČO. Možné spôsoby vyhľadávania: - IČO (company_registration_number) samostatne, alebo - Všetky tri parametre spoločne: rodné číslo (personal_identification_number), krstné meno (given_name) a priezvisko (family_name) Pozor, volanie je dostupné len pre OVM. parameters: - name: personal_identification_number in: query required: false description: Rodné číslo fyzickej osoby. Vyžadované spolu s given_name a family_name, ak nie je poskytnuté company_registration_number. schema: type: string example: '1234567890' - name: given_name in: query required: false description: Krstné meno fyzickej osoby. Vyžadované spolu s personal_identification_number a family_name, ak nie je poskytnuté company_registration_number. schema: type: string example: 'Ján' - name: family_name in: query required: false description: Priezvisko fyzickej osoby. Vyžadované spolu s personal_identification_number a given_name, ak nie je poskytnuté company_registration_number. schema: type: string example: 'Novák' - name: company_registration_number in: query required: false description: IČO právnickej osoby. Môže byť použité samostatne na vyhľadávanie. schema: type: string example: '12345678' responses: 200: description: Úspešne vrátená identita. content: application/json: schema: oneOf: - $ref: '#/components/schemas/UpvsCorporateBody' - $ref: '#/components/schemas/UpvsNaturalPerson' examples: 'Právnická osoba': value: $ref: '#/components/schemas/UpvsCorporateBody/example' 'Fyzická osoba': value: $ref: '#/components/schemas/UpvsNaturalPerson/example' security: - 'API Token': [] /api/iam/identities/search: post: tags: [Vyhľadávanie identít (dostupné len pre OVM)] summary: Vyhľadá identity podľa kritérií description: | Vyhľadá identity podľa kritérií. Pozor, volanie je dostupné len pre OVM. requestBody: required: true content: application/json: schema: type: object properties: ids: description: ID identít. type: array items: type: string format: uuid example: 6d9dc77b-70ed-432f-abaa-5de8753c967c uris: description: URI identít. type: array items: type: string format: uri example: ico://sk/42156424 en: description: Identifikátor schránky. type: string example: E0000012800 type: description: | Typ identity: - `natural_person` fyzická osoba, - `legal_entity` právnická osoba, - `technical_account` technický účet, - `employee_of_public_administration` zamestnanec verejnej správy, - `institution_of_public_administration` orgán verejnej moci. type: string enum: [natural_person, legal_entity, technical_account, administrator_crap, employee_of_public_administration, institution_of_public_administration, edemocracy_user] email: type: string format: email phone: type: string format: phone address: description: Adresa trvalého pobytu alebo kontaktná adresa. type: object properties: type: description: | Typ adresy: - `contact` kontaktná adresa, - `resident` adresa trvalého pobytu. type: string enum: [contact, resident] country: description: Krajina podľa číselníka ŠÚSR 0086 type: object properties: id: type: string name: type: string district: description: Okres podľa číselníka ŠÚSR 0024. type: object properties: id: type: string name: type: string municipality: description: Obec podľa číselníka ŠÚSR 0025. type: object properties: id: type: string name: type: string street: description: Ulica. type: string building_number: description: Orientačné číslo budovy. type: string registration_number: description: Súpisné číslo budovy. type: integer required: - type legal_entity: description: Právnická osoba. type: object properties: cin: description: IČO. type: integer tin: description: DIČ. type: integer name: description: Názov. type: string # TODO # legal_form: # description: Právna forma podľa číselníka ŠÚSR 0056. # type: integer # example: natural_person: description: Fyzická osoba. type: object properties: # TODO # type: # description: | # Typ fyzickej osoby: # - `` , # - `` . # type: string # enum: [] given_name: description: Meno. Pozri `match`. type: string family_name: description: Priezvisko. Pozri `match`. type: string date_of_birth: description: Dátum narodenia. type: string format: date place_of_birth: description: Miesto narodenia. type: string match: description: Spôsob vyhľadávania atribútov `corporate_body.name`, `natural_person.given_name` a `natural_person.family_name`. type: string enum: [exact, prefix, infix] default: exact page: description: Číslo stránky zoznamu identít. type: integer minimum: 1 default: 1 example: 1 per_page: description: Počet identít na stránke zoznamu. type: integer minimum: 10 maximum: 100 default: 10 example: 10 examples: 'Identity by ID': value: ids: - 6d9dc77b-70ed-432f-abaa-5de8753c967c 'Identity by URI': value: uris: - ico://sk/42156424 'Corporate body by CIN': value: corporate_body: cin: 42156424 'Corporate body by name prefix': value: corporate_body: name: Národná agentúra match: prefix 'Natural person by given name': value: natural_person: given_name: Ján 'Natural person by family name prefix': value: natural_person: family_name: H match: prefix responses: 200: description: Úspešne vyhľadané identity podľa kritérií. content: application/json: schema: type: array items: oneOf: - $ref: '#/components/schemas/UpvsCorporateBody' - $ref: '#/components/schemas/UpvsNaturalPerson' security: - 'API Token': [] /api/cud/authorization_clause: post: tags: [Centrálne úradné doručovanie (dostupné len pre OVM)] summary: Vygeneruje doložku o autorizácii description: | Vygeneruje doložku o autorizácii. Pozor, volanie je dostupné len pre OVM. requestBody: required: true content: application/json: schema: type: object properties: created_by: description: Meno, priezvisko a pracovná pozícia zamestnanca, ktorý generuje doložku o autorizácii. type: string example: Meno priezvisko, odborný referent message_container: description: XML MessageContainer-a s EÚD zakódované pomocou Base64. type: string format: base64 example: PE1lc3NhZ2VDb250YWluZXIgeG1... required: - created_by - message_container responses: 200: description: Úspešne vygenerovaná doložka o autorizácii. content: application/json: schema: type: object properties: authorization_clause: description: Elektronický formulár vytvorenej doložky o autorizácii. type: string format: base64 example: PEF1dGhvcml6YXRpb... metadata_container: description: MetadataContainer, ktorý obsahuje MetadataItem, AuthorizationClauseMetadata. V ňom sú dodatočné informácie o prílohach spomenutých v doložke o autorizácii. type: string format: base64 example: PE1ldGFkYXRhQ29... required: - authorization_clause - metadata_container 422: description: Neúspešný pokus o vygenerovanie doložky o autorizácii, chyba vo vstupných dátach. content: application/json: schema: type: object properties: message: description: Chybová hláška z ÚPVS type: string example: Správa neobsahuje žiadny podpísaný dokument. security: - 'API Token': [] /api/usr: post: tags: [Univerzálne synchrónne rozhranie služieb ÚPVS] summary: Vráti odpoveď synchrónnej služby ÚPVS description: | Vráti odpoveď synchrónnej služby ÚPVS. parameters: - name: Accept in: header required: true schema: type: string format: mime example: application/xml requestBody: required: true content: application/json: schema: type: object properties: service: description: Názov služby. type: string example: DITEC_CEP_PODPISANIE_DOKUMENTOV2_ASSERTIONS request: description: Požiadavka služby vo formáte XML. type: string format: xml example: `, - alebo v URL parametri požiadavky ako `?token=`. Poznámky: - hodnota `exp` sa odporúča nastaviť na čo najkratší možný čas od vytvorenia tokenu, - hodnota `exp` sa kontroluje ako počet sekúnd od 1970-01-01T00:00:00 UTC, - hodnota `jti` sa kontroluje podľa regulárneho výrazu `/\A[0-9a-z\-_]{32,256}\z/i`, - rovnaké `jti` sa nesmie použiť v viac ako jedenkrát počas 5 minút. type: http scheme: bearer bearerFormat: JWT 'API Token': description: | Požaduje API token vytvorený treťou stranou, ktorý: - je zakodovaný algoritmom RS256, - je podpísaný privátnym kľúčom tretej strany, - má nastavený `sub` claim na identifikátor certifikátu, ktorý reprezentuje ÚPVS identitu, - má nastavený `exp` claim na čas expirácie, ktorý vyprší o 5 minút alebo skôr od vytvorenia tokenu, - má nastavený `jti` claim na identifikátor, ktorý je unikátny počas 5 minút. Pre riešenia, ktoré jedným certifikátom zastupujú viacero subjektov je požadovaný API token, ktorý navyše: - má nastavený `obo` claim na UUID identifikátor zastupovanej ÚPVS identity. Príklad `header` segmentu: { "alg": "RS256" } Príklad `payload` segmentu: { "sub": "iscep_00956852_10236", "obo": "28830fdf-58ea-4654-8a2a-b3c3e182b2ee" "exp": 1543437976, "jti": "4dee8618-abbe-4dc3-83ba-e984d1396f9f" } API token musí byť prítomný buď: - v hlavičke požiadavky ako `Authorization: Bearer `, - alebo v URL parametri požiadavky ako `?token=`. Poznámky: - identifikátor `sub` reprezentuje ÚPVS identitu, pre ktorú existuje zaregistrovaný certifikát s týmto identifikátorom, - nepovinný identifikátor `obo` reprezentuje zastupovanú ÚPVS identitu a nastavuje sa iba pre riešenia, ktoré jedným certifikátom zastupujú viacero subjektov pomocou `OnBehalfOfID`, - hodnota `obo` sa kontroluje podľa regulárneho výrazu `/\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i`, - hodnota `exp` sa odporúča nastaviť na čo najkratší možný čas od vytvorenia tokenu, - hodnota `exp` sa kontroluje ako počet sekúnd od 1970-01-01T00:00:00 UTC, - hodnota `jti` sa kontroluje podľa regulárneho výrazu `/\A[0-9a-z\-_]{32,256}\z/i`, - rovnaké `jti` sa nesmie použiť viac ako jedenkrát počas 120 minút. type: http scheme: bearer bearerFormat: JWT 'API + OBO Token': description: | Požaduje API token vytvorený treťou stranou, ktorý: - je zakodovaný algoritmom RS256, - je podpísaný privátnym kľúčom tretej strany, - má nastavenú `cty` header na hodnotu `JWT`, - má nastavený `exp` claim na čas expirácie, ktorý vyprší o 5 minút alebo skôr od vytvorenia tokenu, - má nastavený `jti` claim na identifikátor, ktorý je unikátny počas 5 minút, - môže mať nastavený identifikátor `sub`, ktorý reprezentuje ÚPVS identitu, pre ktorú existuje zaregistrovaný certifikát s týmto identifikátorom, - má nastavený `obo` claim na hodnotu OBO tokenu, ktorý je získaný po úspešnom prihlásení. Príklad `header` segmentu: { "alg": "RS256", "cty": "JWT" } Príklad `payload` segmentu: { "exp": 1543437976, "jti": "4dee8618-abbe-4dc3-83ba-e984d1396f9f", "sub": "iscep_00956852_10236", "obo": "eyJhbGciOiJIUzI1NiJ9 ..." } API token musí byť prítomný buď: - v hlavičke požiadavky ako `Authorization: Bearer `, - alebo v URL parametri požiadavky ako `?token=`. Poznámky: - hodnota `exp` sa odporúča nastaviť na čo najkratší možný čas od vytvorenia tokenu, - hodnota `exp` sa kontroluje ako počet sekúnd od 1970-01-01T00:00:00 UTC, - hodnota `jti` sa kontroluje podľa regulárneho výrazu `/\A[0-9a-z\-_]{32,256}\z/i`, - rovnaké `jti` sa nesmie použiť viac ako jedenkrát počas 5 minút. - hodnota nepovinného atribútu `sub` reprezentuje OBO proxy subject (ak atribút nie je prítomný, použije sa hodnota ENV premennej `SSO_PROXY_SUBJECT`). type: http scheme: bearer bearerFormat: JWT