openapi: 3.0.1 info: title: Aa-registeret - OTP API description: "For å kunne bruke tjenesten må scope i autentiseringen mot Maskinporten settes til `nav:aareg/v1/arbeidsforhold/otp`.\n\nDokumentasjon om Aa-registeret og bruk av API'er er tilgjengelig på [GitHub](https://navikt.github.io/aareg)\"\n" version: '1.0' servers: - url: https://api-preprod.nav.no/aareg/v1/arbeidsforhold/otp paths: /graphql: post: tags: - arbeidsforhold summary: graphql description: "GraphQL-endepunkt for å hente arbeidsforhold fra Aa-Registeret.\n\nFor detaljert bruk se [dokumentasjonen](https://navikt.github.io/aareg/tjenester/integrasjon/otp-api/)" operationId: graphql parameters: - name: Authorization in: header description: 'Format - byte. Standard Authorization header som inneholder et Base64-kodet Bearer-token (JWT-aksesstoken) utstedt av Maskinporten (Difi). Verdien må starte med "Bearer ", deretter følger tokenstrengen.' required: true schema: type: string - name: correlation-id in: header description: 'Hvis ønskelig kan konsumenter benytte sin egen korrelasjon-id. Konsumenter står fritt til å sende inn hva de vil, men vi anbefaler at det genereres en unik ID (UUID).' schema: type: string requestBody: description: "GraphQL-spørringen med ønskede felter sendes med en POST til endepunktet.\n\nSe [dokumentasjonen](https://navikt.github.io/aareg/tjenester/integrasjon/otp-api/) for oppdaterte eksempler" content: application/json: schema: $ref: '#/components/schemas/GraphQLRequest' example: query: string variables: { } responses: '200': description: '''Standard'' respons-kode for GraphQL. Se [dokumentasjonen](https://navikt.github.io/aareg/tjenester/integrasjon/otp-api/) for detaljert beskrivelse.' content: application/json: schema: $ref: '#/components/schemas/GraphQLResponse' example: data: string errors: { } '401': description: Unauthorized '403': description: Forbidden '500': description: Internal Server Error content: application/json: { } options: tags: - ping summary: ping description: For ping og helsesjekk - send et kall med HttpMethod.OPTIONS til graphql-endepunktet operationId: ping parameters: - name: Authorization in: header description: 'Format - byte. Standard Authorization header som inneholder et Base64-kodet Bearer-token (JWT-aksesstoken) utstedt av Maskinporten (Difi). Verdien må starte med "Bearer ", deretter følger tokenstrengen.' required: true schema: type: string responses: '200': description: OK '401': description: Unauthorized '403': description: Forbidden '500': description: Internal Server Error content: application/json: { } components: schemas: GraphQLRequest: title: Request required: - query - variables type: object properties: query: type: string description: 'Se [dokumentasjonen](https://navikt.github.io/aareg/tjenester/integrasjon/otp-api/) for oppdaterte eksempler' variables: type: object description: 'Se [dokumentasjonen](https://navikt.github.io/aareg/tjenester/integrasjon/otp-api/) for oppdaterte eksempler' GraphQLResponse: title: Response type: object properties: data: type: string description: Liste av arbeidsforhold errors: type: object description: Eventuelle feilmeldinger securitySchemes: apiKeyHeader: type: apiKey name: Ocp-Apim-Subscription-Key in: header apiKeyQuery: type: apiKey name: subscription-key in: query security: - apiKeyHeader: [ ] - apiKeyQuery: [ ]