{"openapi":"3.0.0","paths":{"/api/auth/login":{"get":{"operationId":"AuthenticationController_login","parameters":[{"required":false,"name":"redirectUrl","in":"query","schema":{"type":"string"}}],"responses":{"302":{"description":"Redirection to orchestrate OIDC flow."}},"summary":"Used to start OIDC authentication.","tags":["auth"]}},"/api/auth/logout":{"get":{"operationId":"AuthenticationController_logout","parameters":[],"responses":{"302":{"description":"Redirect to logout."},"500":{"description":"Internal server error while trying to log out."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"Used to log out the current user.","tags":["auth"]}},"/api/auth/logininfo":{"get":{"operationId":"AuthenticationController_info","parameters":[],"responses":{"200":{"description":"Returns info about the logged in user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserinfoResponse"}}}},"401":{"description":"User is not logged in."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"Info about logged in user.","tags":["auth"]}},"/api/auth/reset-password":{"get":{"operationId":"AuthenticationController_resetPassword","parameters":[{"name":"redirectUrl","required":true,"in":"query","schema":{"type":"string"}},{"name":"login_hint","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"302":{"description":"Redirect to Keycloak password reset page."}},"summary":"Redirect to Keycloak password reset.","tags":["auth"]}},"/keycloakinternal/externaldata":{"post":{"operationId":"KeycloakInternalController_getExternalData","parameters":[],"responses":{"200":{"description":"Returns external Data about the requested user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserExternalDataResponse"}}}}},"summary":"External Data about requested in user.","tags":["Keycloakinternal"]}},"/api/personen/landesbediensteter":{"get":{"operationId":"PersonController_findLandesbediensteter","parameters":[{"name":"personalnummer","required":false,"in":"query","schema":{"nullable":true,"type":"string"}},{"name":"primaryEmailAddress","required":false,"in":"query","schema":{"nullable":true,"type":"string"}},{"name":"username","required":false,"in":"query","schema":{"nullable":true,"type":"string"}},{"name":"vorname","required":false,"in":"query","schema":{"nullable":true,"type":"string"}},{"name":"familienname","required":false,"in":"query","schema":{"nullable":true,"type":"string"}}],"responses":{"200":{"description":"The landesbediensteter was successfully returned.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PersonLandesbediensteterSearchResponse"}}}}},"401":{"description":"Not authorized to get landesbedienstete."},"403":{"description":"Insufficient permissions to get landesbedienstete."},"500":{"description":"Internal server error while getting landesbedienstete."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personen"]}},"/api/personen/{personId}":{"delete":{"operationId":"PersonController_deletePersonById","parameters":[{"name":"personId","required":true,"in":"path","description":"The id for the account.","schema":{"nullable":false,"type":"string"}}],"responses":{"204":{"description":"The person and all their kontexte were successfully deleted."},"400":{"description":"Request has wrong format."},"401":{"description":"Request is not authorized."},"403":{"description":"Insufficient permissions to perform operation."},"404":{"description":"The person was not found."},"500":{"description":"An internal server error occurred."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personen"]},"get":{"operationId":"PersonController_findPersonById","parameters":[{"name":"personId","required":true,"in":"path","description":"The id for the account.","schema":{"nullable":false,"type":"string"}}],"responses":{"200":{"description":"The person was successfully returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonendatensatzResponse"}}}},"400":{"description":"Person ID is required"},"401":{"description":"Not authorized to get the person."},"403":{"description":"Insufficient permissions to get the person."},"404":{"description":"The person does not exist or insufficient permissions."},"500":{"description":"Internal server error while getting the person."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personen"]},"put":{"operationId":"PersonController_updatePerson","parameters":[{"name":"personId","required":true,"in":"path","description":"The id for the account.","schema":{"nullable":false,"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePersonBodyParams"}}}},"responses":{"200":{"description":"The person was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonendatensatzResponse"}}}},"400":{"description":"Request has wrong format."},"401":{"description":"Request is not authorized."},"403":{"description":"Insufficient permissions to perform operation."},"404":{"description":"The person was not found or insufficient permissions to update person."},"500":{"description":"An internal server error occurred."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personen"]}},"/api/personen/{personId}/personenkontexte":{"post":{"deprecated":true,"operationId":"PersonController_createPersonenkontext","parameters":[{"name":"personId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The personenkontext was successfully created."},"400":{"description":"The personenkontext already exists."},"401":{"description":"Not authorized to create the personenkontext."},"403":{"description":"Not permitted to create the personenkontext."},"404":{"description":"Insufficient permissions to create personenkontext for person."},"500":{"description":"Internal server error while creating the personenkontext."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["personen"]},"get":{"operationId":"PersonController_findPersonenkontexte","parameters":[{"name":"personId","required":true,"in":"path","description":"The id for the account.","schema":{"nullable":false,"type":"string"}},{"name":"offset","required":false,"in":"query","description":"The offset of the paginated list.","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"The requested limit for the page size.","schema":{"type":"number"}},{"name":"personId","required":false,"in":"query","schema":{"nullable":true,"type":"string"}},{"name":"username","required":false,"in":"query","schema":{"nullable":true,"type":"string"}},{"name":"personenstatus","required":false,"in":"query","schema":{"$ref":"#/components/schemas/Personenstatus"}},{"name":"sichtfreigabe","required":false,"in":"query","schema":{"$ref":"#/components/schemas/Sichtfreigabe"}}],"responses":{"200":{"description":"The personenkontexte were successfully pulled.","headers":{"X-Paging-Offset":{"description":"The offset of the first item from the list. List starts with index 0."},"X-Paging-Limit":{"description":"The maximum amount of items returned in one request."},"X-Paging-Total":{"description":"The total amount of items in the list."},"X-Paging-pageTotal":{"description":"The total amount of items in the paginated list."}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RawPagedResponse"},{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PersonenkontextResponse"}}}}]}}}},"401":{"description":"Not authorized to get personenkontexte."},"403":{"description":"Insufficient permissions to get personenkontexte."},"404":{"description":"No personenkontexte were found."},"500":{"description":"Internal server error while getting all personenkontexte."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personen"]}},"/api/personen/{personId}/password":{"patch":{"operationId":"PersonController_resetPasswordByPersonId","parameters":[{"name":"personId","required":true,"in":"path","description":"The id for the account.","schema":{"nullable":false,"type":"string"}}],"responses":{"202":{"description":"Password for person was successfully reset.","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"The person does not exist or insufficient permissions to update person."},"500":{"description":"Internal server error."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personen"]}},"/api/personen/{personId}/lock-user":{"put":{"operationId":"PersonController_lockPerson","parameters":[{"name":"personId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LockUserBodyParams"}}}},"responses":{"200":{"description":"User has been successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonLockResponse"}}}},"403":{"description":"Insufficient permissions to perform operation."},"404":{"description":"The person was not found."},"500":{"description":"An internal server error occurred."},"502":{"description":"A downstream server returned an error."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personen"]}},"/api/personen/{personId}/sync":{"post":{"operationId":"PersonController_syncPerson","parameters":[{"name":"personId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"User will be synced."},"403":{"description":"Insufficient permissions to perform operation."},"404":{"description":"The person was not found."},"500":{"description":"An internal server error occurred."},"502":{"description":"A downstream server returned an error."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personen"]}},"/api/personen/{personId}/metadata":{"patch":{"operationId":"PersonController_updateMetadata","parameters":[{"name":"personId","required":true,"in":"path","description":"The id for the account.","schema":{"nullable":false,"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonMetadataBodyParams"}}}},"responses":{"200":{"description":"The metadata for user was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonendatensatzResponse"}}}},"400":{"description":"Request has a wrong format.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamPersonError"}}}},"401":{"description":"Not authorized to update the metadata."},"403":{"description":"Not permitted to update the metadata."},"500":{"description":"Internal server error while updating the metadata for user."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personen"]}},"/api/personen/{personId}/uem-password":{"patch":{"operationId":"PersonController_resetUEMPasswordByPersonId","parameters":[{"name":"personId","required":true,"in":"path","description":"The id for the account.","schema":{"nullable":false,"type":"string"}}],"responses":{"202":{"description":"UEM-password for person was successfully reset.","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"The person does not exist or insufficient permissions to update person."},"500":{"description":"Internal server error."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personen"]}},"/api/personen/uem-password":{"patch":{"operationId":"PersonController_resetUEMPassword","parameters":[],"responses":{"202":{"description":"UEM-password for person was successfully reset.","content":{"application/json":{"schema":{"type":"string"}}}},"404":{"description":"The person does not exist or insufficient permissions to update person."},"500":{"description":"Internal server error."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personen"]}},"/api/personen-frontend":{"get":{"operationId":"PersonFrontendController_findPersons","parameters":[{"name":"offset","required":false,"in":"query","description":"The offset of the paginated list.","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"The requested limit for the page size.","schema":{"type":"number"}},{"name":"username","required":false,"in":"query","schema":{"nullable":true,"type":"string"}},{"name":"familienname","required":false,"in":"query","schema":{"nullable":true,"type":"string"}},{"name":"vorname","required":false,"in":"query","schema":{"nullable":true,"type":"string"}},{"name":"sichtfreigabe","required":false,"in":"query","schema":{"nullable":true,"default":"nein","type":"string","enum":["ja","nein"]}},{"name":"organisationIDs","required":false,"in":"query","description":"List of Organisation ID used to filter for Persons.","schema":{"type":"array","items":{"type":"string"}}},{"name":"rolleIDs","required":false,"in":"query","description":"List of Role ID used to filter for Persons.","schema":{"type":"array","items":{"type":"string"}}},{"name":"suchFilter","required":false,"in":"query","description":"Search filter used to filter for Persons. It could be the vorname, familienname, username or the personalnummer.","schema":{"nullable":true,"type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"Order to sort by.","schema":{"$ref":"#/components/schemas/ScopeOrder"}},{"name":"sortField","required":false,"in":"query","description":"Field to sort by.","schema":{"$ref":"#/components/schemas/SortFieldPerson"}}],"responses":{"200":{"description":"The persons were successfully returned. WARNING: This endpoint returns all persons as default when no paging parameters were set.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RawPagedResponse"},{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PersonendatensatzResponse"}}}}]}}}},"401":{"description":"Not authorized to get persons."},"403":{"description":"Insufficient permissions to get persons."},"500":{"description":"Internal server error while getting all persons."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personen-frontend"]}},"/api/dbiam/personenuebersicht":{"post":{"operationId":"DBiamPersonenuebersichtController_findPersonenuebersichten","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonenuebersichtBodyParams"}}}},"responses":{"200":{"description":"The personenuebersichten were successfully returned.","headers":{"X-Paging-Offset":{"description":"The offset of the first item from the list. List starts with index 0."},"X-Paging-Limit":{"description":"The maximum amount of items returned in one request."},"X-Paging-Total":{"description":"The total amount of items in the list."},"X-Paging-pageTotal":{"description":"The total amount of items in the paginated list."}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RawPagedResponse"},{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DBiamPersonenuebersichtResponse"}}}}]}}}},"401":{"description":"Not authorized to get personenuebersichten."},"403":{"description":"Insufficient permission to get personenuebersichten."},"500":{"description":"Internal server error while getting personenuebersichten."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["dbiam-personenuebersicht"]}},"/api/dbiam/personenuebersicht/{personId}":{"get":{"operationId":"DBiamPersonenuebersichtController_findPersonenuebersichtenByPerson","parameters":[{"name":"personId","required":true,"in":"path","description":"The ID for the person.","schema":{"type":"string"}}],"responses":{"200":{"description":"The personenuebersichten were successfully returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DBiamPersonenuebersichtResponse"}}}},"401":{"description":"Not authorized to get personenuebersicht."},"403":{"description":"Insufficient permission to get personenuebersicht."},"500":{"description":"Internal server error while getting personenuebersicht."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["dbiam-personenuebersicht"]}},"/api/organisationen":{"post":{"operationId":"OrganisationController_createOrganisation","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrganisationBodyParams"}}}},"responses":{"201":{"description":"The organisation was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationResponse"}}}},"400":{"description":"The organisation already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamOrganisationError"}}}},"401":{"description":"Not authorized to create the organisation."},"403":{"description":"Not permitted to create the organisation."},"500":{"description":"Internal server error while creating the organisation."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["organisationen"]},"get":{"operationId":"OrganisationController_findOrganizations","parameters":[{"name":"offset","required":false,"in":"query","description":"The offset of the paginated list.","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"The requested limit for the page size.","schema":{"type":"number"}},{"name":"kennung","required":false,"in":"query","schema":{"nullable":true,"type":"string"}},{"name":"name","required":false,"in":"query","schema":{"nullable":true,"type":"string"}},{"name":"searchString","required":false,"in":"query","schema":{"nullable":true,"type":"string"}},{"name":"typ","required":false,"in":"query","schema":{"$ref":"#/components/schemas/OrganisationsTyp"}},{"name":"systemrechte","required":false,"in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/RollenSystemRechtEnum"}}},{"name":"excludeTyp","required":false,"in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganisationsTyp"}}},{"name":"administriertVon","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"zugehoerigZu","required":false,"in":"query","description":"Liefert die Kind-Organisationen, die den angegebenen IDs zugehörig sind.","schema":{"type":"array","items":{"type":"string"}}},{"name":"organisationIds","required":false,"in":"query","description":"Liefert Organisationen mit den angegebenen IDs, selbst wenn andere Filterkriterien nicht zutreffen (ODER-verknüpft mit anderen Kriterien).","schema":{"type":"array","items":{"type":"string"}}},{"name":"sortOrder","required":false,"in":"query","description":"Order to sort by.","schema":{"nullable":true,"type":"string","enum":["asc","desc"]}},{"name":"sortField","required":false,"in":"query","description":"Field to sort by.","schema":{"nullable":true,"type":"string","enum":["name","kennung"]}},{"name":"getChildrenRecursively","required":false,"in":"query","schema":{"nullable":true,"type":"boolean"}}],"responses":{"200":{"description":"The organizations were successfully returned.","headers":{"X-Paging-Offset":{"description":"The offset of the first item from the list. List starts with index 0."},"X-Paging-Limit":{"description":"The maximum amount of items returned in one request."},"X-Paging-Total":{"description":"The total amount of items in the list."},"X-Paging-pageTotal":{"description":"The total amount of items in the paginated list."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganisationResponse"}}}}},"401":{"description":"Not authorized to get organizations."},"403":{"description":"Insufficient permissions to get organizations."},"500":{"description":"Internal server error while getting all organizations."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["organisationen"]}},"/api/organisationen/{organisationId}":{"put":{"operationId":"OrganisationController_updateOrganisation","parameters":[{"name":"organisationId","required":true,"in":"path","description":"The id of an organization","schema":{"nullable":false,"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrganisationBodyParams"}}}},"responses":{"200":{"description":"The organisation was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationResponse"}}}},"400":{"description":"Request has wrong format.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamOrganisationError"}}}},"401":{"description":"Request is not authorized."},"403":{"description":"Insufficient permissions to perform operation."},"404":{"description":"The organisation was not found."},"500":{"description":"An internal server error occurred."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["organisationen"]},"get":{"operationId":"OrganisationController_findOrganisationById","parameters":[{"name":"organisationId","required":true,"in":"path","description":"The id of an organization","schema":{"nullable":false,"type":"string"}}],"responses":{"200":{"description":"The organization was successfully pulled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationResponse"}}}},"400":{"description":"Organization ID is required"},"401":{"description":"Not authorized to get the organization."},"403":{"description":"Insufficient permissions to get the organization."},"404":{"description":"The organization does not exist."},"500":{"description":"Internal server error while getting the organization."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["organisationen"]},"delete":{"description":"Delete an organisation by id.","operationId":"OrganisationController_deleteOrganisation","parameters":[{"name":"organisationId","required":true,"in":"path","description":"The id of an organization","schema":{"nullable":false,"type":"string"}}],"responses":{"204":{"description":"The organisation was deleted successfully."},"400":{"description":"The input was not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamOrganisationError"}}}},"401":{"description":"Not authorized to delete the organisation."},"404":{"description":"The organisation that should be deleted does not exist."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["organisationen"]}},"/api/organisationen/root":{"get":{"operationId":"OrganisationController_getRootOrganisation","parameters":[],"responses":{"200":{"description":"The root organization was successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationResponse"}}}},"401":{"description":"Not authorized to get the root organization."},"403":{"description":"Insufficient permissions to get the root organization."},"404":{"description":"The root organization does not exist."},"500":{"description":"Internal server error while getting the root organization."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["organisationen"]}},"/api/organisationen/root/children":{"get":{"operationId":"OrganisationController_getRootChildren","parameters":[],"responses":{"200":{"description":"The root organizations were successfully pulled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationRootChildrenResponse"}}}},"401":{"description":"Not authorized to get the organizations."},"403":{"description":"Insufficient permissions to get the organizations."},"500":{"description":"Internal server error while getting the organization."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["organisationen"]}},"/api/organisationen/parents-by-ids":{"post":{"operationId":"OrganisationController_getParentsByIds","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParentOrganisationsByIdsBodyParams"}}}},"responses":{"200":{"description":"The parent organizations were successfully pulled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParentOrganisationenResponse"}}}},"401":{"description":"Not authorized to get the organizations."},"403":{"description":"Insufficient permissions to get the organizations."},"500":{"description":"Internal server error while getting the organization."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["organisationen"]}},"/api/organisationen/{organisationId}/administriert":{"get":{"operationId":"OrganisationController_getAdministrierteOrganisationen","parameters":[{"name":"organisationId","required":true,"in":"path","description":"The id of an organization","schema":{"nullable":false,"type":"string"}},{"name":"offset","required":false,"in":"query","description":"The offset of the paginated list.","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"The requested limit for the page size.","schema":{"type":"number"}},{"name":"searchFilter","required":false,"in":"query","schema":{"nullable":true,"type":"string"}}],"responses":{"200":{"description":"The organizations were successfully returned.","headers":{"X-Paging-Offset":{"description":"The offset of the first item from the list. List starts with index 0."},"X-Paging-Limit":{"description":"The maximum amount of items returned in one request."},"X-Paging-Total":{"description":"The total amount of items in the list."},"X-Paging-pageTotal":{"description":"The total amount of items in the paginated list."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganisationResponse"}}}}},"401":{"description":"Not authorized to get organizations."},"403":{"description":"Insufficient permissions to get organizations."},"500":{"description":"Internal server error while getting all organizations."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["organisationen"]}},"/api/organisationen/{organisationId}/zugehoerig":{"get":{"operationId":"OrganisationController_getZugehoerigeOrganisationen","parameters":[{"name":"organisationId","required":true,"in":"path","description":"The id of an organization","schema":{"nullable":false,"type":"string"}}],"responses":{"200":{"description":"The organizations were successfully returned.","headers":{"X-Paging-Offset":{"description":"The offset of the first item from the list. List starts with index 0."},"X-Paging-Limit":{"description":"The maximum amount of items returned in one request."},"X-Paging-Total":{"description":"The total amount of items in the list."},"X-Paging-pageTotal":{"description":"The total amount of items in the paginated list."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganisationResponse"}}}}},"401":{"description":"Not authorized to get organizations."},"403":{"description":"Insufficient permissions to get organizations."},"500":{"description":"Internal server error while getting all organizations."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["organisationen"]},"post":{"operationId":"OrganisationController_addZugehoerigeOrganisation","parameters":[{"name":"organisationId","required":true,"in":"path","description":"The ID of the parent organisation to which another organisation will be added as a subordinate.","schema":{"nullable":false,"type":"string"}}],"requestBody":{"required":true,"description":"The ID of the child organisation that will be assigned to the parent organisation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationByIdBodyParams"}}}},"responses":{"201":{"description":"The organisation was successfully updated."},"400":{"description":"The organisation could not be modified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamOrganisationError"}}}},"401":{"description":"Not authorized to modify the organisation."},"403":{"description":"Not permitted to modify the organisation."},"500":{"description":"Internal server error while modifying the organisation."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["organisationen"]}},"/api/organisationen/{organisationId}/name":{"patch":{"operationId":"OrganisationController_updateOrganisationName","parameters":[{"name":"organisationId","required":true,"in":"path","description":"The id of an organization","schema":{"nullable":false,"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationByNameBodyParams"}}}},"responses":{"200":{"description":"The organizations were successfully updated.","headers":{"X-Paging-Offset":{"description":"The offset of the first item from the list. List starts with index 0."},"X-Paging-Limit":{"description":"The maximum amount of items returned in one request."},"X-Paging-Total":{"description":"The total amount of items in the list."},"X-Paging-pageTotal":{"description":"The total amount of items in the paginated list."}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationResponseLegacy"}}}},"400":{"description":"The organisation could not be modified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamOrganisationError"}}}},"401":{"description":"Not authorized to modify the organisation."},"403":{"description":"Not permitted to modify the organisation."},"500":{"description":"Internal server error while modifying the organisation."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["organisationen"]}},"/api/organisationen/{organisationId}/enable-for-its-learning":{"put":{"operationId":"OrganisationController_enableForitslearning","parameters":[{"name":"organisationId","required":true,"in":"path","description":"The id of an organization","schema":{"nullable":false,"type":"string"}}],"responses":{"200":{"description":"The organization was successfully enabled for itslearning.","headers":{"X-Paging-Offset":{"description":"The offset of the first item from the list. List starts with index 0."},"X-Paging-Limit":{"description":"The maximum amount of items returned in one request."},"X-Paging-Total":{"description":"The total amount of items in the list."},"X-Paging-pageTotal":{"description":"The total amount of items in the paginated list."}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationResponseLegacy"}}}},"400":{"description":"The organisation could not be modified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamOrganisationError"}}}},"401":{"description":"Not authorized to modify the organisation."},"403":{"description":"Not permitted to modify the organisation."},"500":{"description":"Internal server error while modifying the organisation."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["organisationen"]}},"/api/rolle":{"get":{"description":"List all rollen.","operationId":"RolleController_findRollen","parameters":[{"name":"offset","required":false,"in":"query","description":"The offset of the paginated list.","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"The requested limit for the page size.","schema":{"type":"number"}},{"name":"searchStr","required":false,"in":"query","description":"The name for the role.","schema":{"type":"string"}},{"name":"organisationId","required":false,"in":"query","description":"The id of the organisation where the role should be available.","schema":{"type":"string"}},{"name":"systemrecht","required":false,"in":"query","description":"The system right for which the roles should be available. Can only be ROLLEN_VERWALTEN or ROLLEN_ERWEITERN.","schema":{"$ref":"#/components/schemas/RollenSystemRechtEnum"}},{"name":"rollenarten","required":false,"in":"query","description":"Filter roles by their role types.","schema":{"type":"array","items":{"$ref":"#/components/schemas/RollenArt"}}}],"responses":{"200":{"description":"The rollen were successfully returned","headers":{"X-Paging-Offset":{"description":"The offset of the first item from the list. List starts with index 0."},"X-Paging-Limit":{"description":"The maximum amount of items returned in one request."},"X-Paging-Total":{"description":"The total amount of items in the list."},"X-Paging-pageTotal":{"description":"The total amount of items in the paginated list."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RolleWithServiceProvidersResponse"}}}}},"401":{"description":"Not authorized to get rollen."},"403":{"description":"Insufficient permissions to get rollen."},"500":{"description":"Internal server error while getting all rollen."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["rolle"]},"post":{"description":"Create a new rolle.","operationId":"RolleController_createRolle","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRolleBodyParams"}}}},"responses":{"201":{"description":"The rolle was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RolleResponse"}}}},"400":{"description":"The input was not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamRolleError"}}}},"401":{"description":"Not authorized to create the rolle."},"403":{"description":"Insufficient permissions to create the rolle."},"500":{"description":"Internal server error while creating the rolle."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["rolle"]}},"/api/rolle/systemrechte":{"get":{"description":"Get all systemrechte for rollen.","operationId":"RolleController_getAllSystemrechte","parameters":[],"responses":{"200":{"description":"Returns all systemrechte for rollen.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SystemRechtResponse"}}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["rolle"]}},"/api/rolle/{rolleId}":{"get":{"description":"Get rolle by id.","operationId":"RolleController_findRolleByIdWithServiceProviders","parameters":[{"name":"rolleId","required":true,"in":"path","description":"The id for the rolle.","schema":{"nullable":false,"type":"string"}}],"responses":{"200":{"description":"The rolle was successfully returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RolleWithServiceProvidersResponse"}}}},"401":{"description":"Not authorized to get rolle by id."},"403":{"description":"Insufficient permission to get rolle by id."},"500":{"description":"Internal server error while getting rolle by id."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["rolle"]},"patch":{"description":"Add systemrecht to a rolle.","operationId":"RolleController_addSystemRecht","parameters":[{"name":"rolleId","required":true,"in":"path","description":"The id for the rolle.","schema":{"nullable":false,"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddSystemrechtBodyParams"}}}},"responses":{"200":{"description":"The systemrecht was successfully added to rolle."},"400":{"description":"The input was not valid."},"401":{"description":"Not authorized to create the rolle."},"403":{"description":"Insufficient permissions to create the rolle."},"500":{"description":"Internal server error while adding systemrecht to rolle."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["rolle"]},"put":{"description":"Update rolle.","operationId":"RolleController_updateRolle","parameters":[{"name":"rolleId","required":true,"in":"path","description":"The id for the rolle.","schema":{"nullable":false,"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRolleBodyParams"}}}},"responses":{"200":{"description":"The rolle was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RolleWithServiceProvidersResponse"}}}},"400":{"description":"The input was not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamRolleError"}}}},"401":{"description":"Not authorized to update the rolle."},"403":{"description":"Insufficient permissions to update the rolle."},"500":{"description":"Internal server error while updating the rolle."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["rolle"]},"delete":{"description":"Delete a role by id.","operationId":"RolleController_deleteRolle","parameters":[{"name":"rolleId","required":true,"in":"path","description":"The id for the rolle.","schema":{"nullable":false,"type":"string"}}],"responses":{"204":{"description":"Role was deleted successfully."},"400":{"description":"The input was not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamRolleError"}}}},"401":{"description":"Not authorized to delete the role."},"404":{"description":"The rolle that should be deleted does not exist."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["rolle"]}},"/api/rolle/{rolleId}/serviceProviders":{"get":{"description":"Get service-providers for a rolle by its id.","operationId":"RolleController_getRolleServiceProviderIds","parameters":[{"name":"rolleId","required":true,"in":"path","description":"The id for the rolle.","schema":{"nullable":false,"type":"string"}}],"responses":{"200":{"description":"Returns a list of service-provider ids.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RolleServiceProviderResponse"}}}},"401":{"description":"Not authorized to retrieve service-providers for rolle."},"404":{"description":"The rolle does not exist."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["rolle"]},"put":{"description":"Add a service-provider to a rolle by id.","operationId":"RolleController_updateServiceProvidersById","parameters":[{"name":"rolleId","required":true,"in":"path","description":"The id for the rolle.","schema":{"nullable":false,"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RolleServiceProviderBodyParams"}}}},"responses":{"200":{"description":"Adding service-provider finished successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServiceProviderResponse"}}}}},"400":{"description":"The service-provider is already attached to rolle."},"401":{"description":"Not authorized to retrieve service-providers for rolle."},"404":{"description":"The rolle or the service-provider to add does not exist."},"500":{"description":"Internal server error, the service-provider may could not be found after attaching to rolle."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["rolle"]},"delete":{"description":"Remove a service-provider from a rolle by id.","operationId":"RolleController_removeServiceProviderById","parameters":[{"name":"rolleId","required":true,"in":"path","description":"The id for the rolle.","schema":{"nullable":false,"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RolleServiceProviderBodyParams"}}}},"responses":{"200":{"description":"Removing service-provider finished successfully."},"401":{"description":"Not authorized to retrieve service-providers for rolle."},"404":{"description":"The rolle or the service-provider that should be removed does not exist."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["rolle"]}},"/api/rolle/erweiterung":{"post":{"description":"Create a new rollenerweiterung.","operationId":"RolleController_createRollenerweiterung","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRollenerweiterungBodyParams"}}}},"responses":{"201":{"description":"The rollenerweiterung was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RollenerweiterungResponse"}}}},"400":{"description":"The input was not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamRolleError"}}}},"401":{"description":"Not authorized to create the rollenerweiterung."},"403":{"description":"Insufficient permissions to create the rollenerweiterung."},"500":{"description":"Internal server error while creating the rollenerweiterung."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["rolle"]}},"/api/rollen-erweiterung/angebot/{angebotId}/organisation/{organisationId}/apply":{"post":{"description":"Apply changes to rollen-erweiterung for a given angebot and organisation.","operationId":"RollenerweiterungController_applyRollenerweiterungChanges","parameters":[{"name":"angebotId","required":true,"in":"path","description":"The spshPersonId of the person.","schema":{"nullable":false,"type":"string"}},{"name":"organisationId","required":true,"in":"path","description":"The spshPersonId of the person.","schema":{"nullable":false,"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyRollenerweiterungBodyParams"}}}},"responses":{"204":{"description":"Changes applied successfully."},"404":{"description":"One or more of the specified objects were not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamApplyRollenerweiterungMultiError"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamApplyRollenerweiterungMultiError"}}}}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["rolle"]}},"/api/provider/all":{"get":{"description":"Get all service-providers.","operationId":"ProviderController_getAllServiceProviders","parameters":[],"responses":{"200":{"description":"The service-providers were successfully returned.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServiceProviderResponse"}}}}},"401":{"description":"Not authorized to get available service providers."},"403":{"description":"Insufficient permissions to get service-providers."},"500":{"description":"Internal server error while getting all service-providers."}},"security":[{"bearer":[]},{"oauth2":["openid"]}],"summary":"","tags":["provider"]}},"/api/provider":{"get":{"description":"Get service-providers available for logged-in user.","operationId":"ProviderController_getAvailableServiceProviders","parameters":[],"responses":{"200":{"description":"The service-providers were successfully returned.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServiceProviderResponse"}}}}},"401":{"description":"Not authorized to get available service providers."},"403":{"description":"Insufficient permissions to get service-providers."},"500":{"description":"Internal server error while getting all service-providers."}},"security":[{"bearer":[]},{"oauth2":["openid"]}],"summary":"","tags":["provider"]},"post":{"description":"Create a new service-provider (Angebot).","operationId":"ProviderController_createServiceProvider","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServiceProviderBodyParams"}}}},"responses":{"200":{"description":"The service-provider was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceProviderResponse"}}}},"400":{"description":"Invalid request body."},"401":{"description":"Not authorized."},"403":{"description":"Insufficient permissions."},"500":{"description":"Internal server error."}},"security":[{"bearer":[]},{"oauth2":["openid"]}],"summary":"","tags":["provider"]}},"/api/provider/{angebotId}/logo":{"get":{"operationId":"ProviderController_getServiceProviderLogo","parameters":[{"name":"angebotId","required":true,"in":"path","description":"The id of the service provider","schema":{"nullable":false,"type":"string"}}],"responses":{"200":{"description":"The logo for the service provider was successfully returned.","content":{"image/*":{"schema":{"type":"file","format":"binary"}}}},"400":{"description":"Angebot ID is required."},"401":{"description":"Not authorized to get service provider logo."},"403":{"description":"Insufficient permissions to get the logo."},"404":{"description":"The service-provider does not exist or has no logo."},"500":{"description":"Internal server error while getting the logo."}},"security":[{"bearer":[]},{"oauth2":["openid"]}],"tags":["provider"]}},"/api/provider/{angebotId}/rollenerweiterung":{"get":{"description":"Get rollenerweiterungen for service-provider with provided id. Total is the amount of organisations.","operationId":"ProviderController_findRollenerweiterungenByServiceProviderId","parameters":[{"name":"angebotId","required":true,"in":"path","description":"The id of the service provider","schema":{"nullable":false,"type":"string"}},{"name":"offset","required":false,"in":"query","description":"The offset of the paginated list.","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"The requested limit for the page size.","schema":{"type":"number"}},{"name":"organisationId","required":false,"in":"query","description":"The id of the organisation","schema":{"nullable":true,"type":"string"}}],"responses":{"200":{"description":"The rollenerweiterungen were successfully returned. WARNING: This endpoint returns all rollenerweiterungen of the service-provider as default when no paging parameters were set.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RawPagedResponse"},{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RollenerweiterungWithExtendedDataResponse"}}}}]}}}},"401":{"description":"Not authorized to get rollenerweiterungen."},"403":{"description":"Insufficient permissions to get rollenerweiterungen."},"500":{"description":"Internal server error while getting rollenerweiterungen."}},"security":[{"bearer":[]},{"oauth2":["openid"]}],"summary":"","tags":["provider"]}},"/api/provider/manageable":{"get":{"description":"Get service-providers the logged-in user is allowed to manage.","operationId":"ProviderController_getManageableServiceProviders","parameters":[{"name":"offset","required":false,"in":"query","description":"The offset of the paginated list.","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"The requested limit for the page size.","schema":{"type":"number"}}],"responses":{"200":{"description":"The service providers were successfully returned. WARNING: This endpoint returns all service providers as default when no paging parameters were set.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RawPagedResponse"},{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ManageableServiceProviderListEntryResponse"}}}}]}}}},"401":{"description":"Not authorized to get available service providers."},"403":{"description":"Insufficient permissions to get service-providers."},"500":{"description":"Internal server error while getting all service-providers."}},"security":[{"bearer":[]},{"oauth2":["openid"]}],"summary":"","tags":["provider"]}},"/api/provider/manageable-by-organisation":{"get":{"description":"Get service-providers the logged-in user is allowed to manage for an Organisation.","operationId":"ProviderController_getManageableServiceProvidersForOrganisationId","parameters":[{"name":"offset","required":false,"in":"query","description":"The offset of the paginated list.","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"The requested limit for the page size.","schema":{"type":"number"}},{"name":"organisationId","required":true,"in":"query","description":"The id of the organisation","schema":{"nullable":false,"type":"string"}}],"responses":{"200":{"description":"The service providers were successfully returned. WARNING: This endpoint returns all service providers as default when no paging parameters were set.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RawPagedResponse"},{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ManageableServiceProviderListEntryResponse"}}}}]}}}},"401":{"description":"Not authorized to get available service providers."},"403":{"description":"Insufficient permissions to get service-providers."},"500":{"description":"Internal server error while getting all service-providers."}},"security":[{"bearer":[]},{"oauth2":["openid"]}],"summary":"","tags":["provider"]}},"/api/provider/manageable/{angebotId}":{"get":{"description":"Get service-provider the logged-in user is allowed to manage.","operationId":"ProviderController_getManageableServiceProviderById","parameters":[{"name":"angebotId","required":true,"in":"path","description":"The id of the service provider","schema":{"nullable":false,"type":"string"}}],"responses":{"200":{"description":"The service-provider was successfully returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManageableServiceProviderResponse"}}}},"401":{"description":"Not authorized to get available service provider."},"403":{"description":"Insufficient permissions to get service-provider."},"500":{"description":"Internal server error while getting service-provider."}},"security":[{"bearer":[]},{"oauth2":["openid"]}],"summary":"","tags":["provider"]}},"/api/personenkontexte/{personenkontextId}":{"get":{"operationId":"PersonenkontextController_findPersonenkontextById","parameters":[{"name":"personenkontextId","required":true,"in":"path","description":"The id for the personenkontext.","schema":{"nullable":false,"type":"string"}}],"responses":{"200":{"description":"The personenkontext was successfully returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonendatensatzResponseAutomapper"}}}},"400":{"description":"Request has wrong format."},"401":{"description":"Request is not authorized."},"403":{"description":"Insufficient permissions to perform operation."},"404":{"description":"The personenkontext was not found."},"500":{"description":"An internal server error occurred."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personenkontexte"]},"put":{"deprecated":true,"operationId":"PersonenkontextController_updatePersonenkontextWithId","parameters":[{"name":"personenkontextId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The personenkontext was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonenkontextResponse"}}}},"400":{"description":"Request has wrong format."},"401":{"description":"Request is not authorized."},"403":{"description":"Insufficient permissions to perform operation."},"404":{"description":"The personenkontext was not found."},"500":{"description":"An internal server error occurred."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["personenkontexte"]},"delete":{"operationId":"PersonenkontextController_deletePersonenkontextById","parameters":[{"name":"personenkontextId","required":true,"in":"path","description":"The id for the personenkontext.","schema":{"nullable":false,"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRevisionBodyParams"}}}},"responses":{"204":{"description":"The personenkontext was successfully deleted."},"400":{"description":"Request has wrong format."},"401":{"description":"Request is not authorized."},"403":{"description":"Insufficient permissions to perform operation."},"404":{"description":"The personenkontext was not found."},"500":{"description":"An internal server error occurred."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personenkontexte"]}},"/api/personenkontexte":{"get":{"operationId":"PersonenkontextController_findPersonenkontexte","parameters":[{"name":"offset","required":false,"in":"query","description":"The offset of the paginated list.","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"The requested limit for the page size.","schema":{"type":"number"}},{"name":"personId","required":false,"in":"query","schema":{"nullable":true,"type":"string"}},{"name":"username","required":false,"in":"query","schema":{"nullable":true,"type":"string"}},{"name":"personenstatus","required":false,"in":"query","schema":{"$ref":"#/components/schemas/Personenstatus"}},{"name":"sichtfreigabe","required":false,"in":"query","schema":{"$ref":"#/components/schemas/Sichtfreigabe"}}],"responses":{"200":{"description":"The personenkontexte were successfully returned.","headers":{"X-Paging-Offset":{"description":"The offset of the first item from the list. List starts with index 0."},"X-Paging-Limit":{"description":"The maximum amount of items returned in one request."},"X-Paging-Total":{"description":"The total amount of items in the list."},"X-Paging-pageTotal":{"description":"The total amount of items in the paginated list."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PersonenkontextdatensatzResponse"}}}}},"400":{"description":"Request has wrong format."},"401":{"description":"Request is not authorized."},"403":{"description":"Insufficient permissions to perform operation."},"404":{"description":"The personenkontexte were not found."},"500":{"description":"An internal server error occurred."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personenkontexte"]}},"/api/personenkontext-workflow/step":{"get":{"operationId":"DbiamPersonenkontextWorkflowController_processStep","parameters":[{"name":"operationContext","required":true,"in":"query","description":"The context in which this request happens. Affects permission checks.","schema":{"$ref":"#/components/schemas/OperationContext"}},{"name":"personId","required":false,"in":"query","description":"ID of the person to be modified, will restrict the returned roles","schema":{"nullable":true,"type":"string"}},{"name":"organisationId","required":false,"in":"query","description":"ID of the organisation to filter the rollen later","schema":{"nullable":true,"type":"string"}},{"name":"rollenIds","required":false,"in":"query","description":"IDs of the rollen.","schema":{"type":"array","items":{"type":"string"}}},{"name":"rolleName","required":false,"in":"query","description":"Rolle name used to filter for rollen in personenkontext.","schema":{"nullable":true,"type":"string"}},{"name":"organisationName","required":false,"in":"query","description":"Organisation/SSK name used to filter for schulstrukturknoten in personenkontext.","schema":{"nullable":true,"type":"string"}},{"name":"limit","required":false,"in":"query","description":"The limit of items for the request.","schema":{"nullable":false,"type":"number"}},{"name":"requestedWithSystemrecht","required":false,"in":"query","description":"The systemrecht used to filter for rollen in personenkontext.","schema":{"$ref":"#/components/schemas/RollenSystemRechtEnum"}}],"responses":{"200":{"description":"Initialize or process data from the person creation form.\n                      Valid combinations:\n                      - Both organisationId and rolleId are undefined: Fetch all possible organisations.\n                      - organisationId is provided, but rolleId is undefined: Fetch Rollen for the given organisation.\n                      - Both organisationId and rolleId are provided: Check if the Rolle can be committed for the organisation.\n                      Note: Providing rolleId without organisationId is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonenkontextWorkflowResponse"}}}},"401":{"description":"Not authorized to get available data for personenkontext."},"403":{"description":"Insufficient permission to get data for personenkontext."},"500":{"description":"Internal server error while getting data for personenkontext."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personenkontext"]}},"/api/personenkontext-workflow/{personId}":{"put":{"operationId":"DbiamPersonenkontextWorkflowController_commit","parameters":[{"name":"personId","required":true,"in":"path","description":"The ID for the person.","schema":{"type":"string"}},{"name":"personalnummer","required":false,"in":"query","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamUpdatePersonenkontexteBodyParams"}}}},"responses":{"200":{"description":"Add or remove personenkontexte as one operation. Returns the Personenkontexte existing after update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonenkontexteUpdateResponse"}}}},"400":{"description":"The personenkontexte could not be updated, may due to unsatisfied specifications.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamPersonenkontexteUpdateError"}}}},"401":{"description":"Not authorized to update personenkontexte."},"403":{"description":"Insufficient permission to update personenkontexte."},"409":{"description":"Changes are conflicting with current state of personenkontexte."},"500":{"description":"Internal server error while updating personenkontexte."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personenkontext"]}},"/api/personenkontext-workflow":{"post":{"operationId":"DbiamPersonenkontextWorkflowController_createPersonWithPersonenkontexte","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamCreatePersonWithPersonenkontexteBodyParams"}}}},"responses":{"201":{"description":"Person with Personenkontext was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DBiamPersonResponse"}}}},"400":{"description":"The person and the personenkontext could not be created, may due to unsatisfied specifications.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamPersonenkontextError"}}}},"401":{"description":"Not authorized to create person with personenkontext."},"403":{"description":"Insufficient permission to create person with personenkontext."},"500":{"description":"Internal server error while creating person with personenkontext."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["personenkontext"]}},"/api/person-administration/rollen":{"get":{"operationId":"PersonAdministrationController_findRollen","parameters":[{"name":"rolleName","required":false,"in":"query","description":"Rolle name used to filter for rollen in personenkontext.","schema":{"nullable":false,"type":"string"}},{"name":"limit","required":false,"in":"query","description":"The limit of items for the request.","schema":{"nullable":false,"type":"number"}},{"name":"organisationIds","required":false,"in":"query","description":"OrganisationIDs to filter rollen","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"The rollen for the logged-in user were successfully returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindRollenResponse"}}}},"401":{"description":"Not authorized to get available rollen for the logged-in user."},"403":{"description":"Insufficient permission to get rollen for the logged-in user."},"500":{"description":"Internal server error while getting rollen for the logged-in user."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["person-administration"]}},"/api/2fa-token/init":{"post":{"operationId":"PrivacyIdeaAdministrationController_initializeSoftwareToken","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenInitBodyParams"}}}},"responses":{"201":{"description":"The token was successfully created.","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"A username was not given or not found."},"401":{"description":"Not authorized to create token."},"403":{"description":"Insufficient permissions to create token."},"404":{"description":"Insufficient permissions to create token."},"500":{"description":"Internal server error while creating a token."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["2FA"]}},"/api/2fa-token/state":{"get":{"operationId":"PrivacyIdeaAdministrationController_getTwoAuthState","parameters":[{"name":"personId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"201":{"description":"The token state was successfully returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenStateResponse"}}}},"400":{"description":"A username was not given or not found."},"401":{"description":"Not authorized to get token state."},"403":{"description":"Insufficient permissions to get token state."},"404":{"description":"Insufficient permissions to get token state."},"500":{"description":"Internal server error while retrieving token state."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["2FA"]}},"/api/2fa-token/reset":{"put":{"operationId":"PrivacyIdeaAdministrationController_resetToken","parameters":[{"name":"personId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"201":{"description":"The token was successfully reset.","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"A username was not given or not found."},"401":{"description":"Not authorized to reset token."},"403":{"description":"Insufficient permissions to reset token."},"404":{"description":"Insufficient permissions to reset token."},"500":{"description":"Internal server error while reseting a token."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["2FA"]}},"/api/2fa-token/assign/hardwareToken":{"post":{"operationId":"PrivacyIdeaAdministrationController_assignHardwareToken","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignHardwareTokenBodyParams"}}}},"responses":{"201":{"description":"The hardware token was successfully assigned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignHardwareTokenResponse"}}}},"400":{"description":"Not found."},"401":{"description":"Not authorized to assign hardware token."},"403":{"description":"Insufficient permissions to reset token."},"404":{"description":"Insufficient permissions to assign hardware token."},"500":{"description":"Internal server error while assigning a hardware token."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["2FA"]}},"/api/2fa-token/verify":{"post":{"operationId":"PrivacyIdeaAdministrationController_verifyToken","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenVerifyBodyParams"}}}},"responses":{"201":{"description":"The token was successfully verified."},"400":{"description":"A username was not given or not found."},"401":{"description":"Not authorized to verify token."},"403":{"description":"Insufficient permissions to verify token."},"404":{"description":"Insufficient permissions to verify token."},"500":{"description":"Internal server error while verifying a token."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["2FA"]}},"/api/2fa-token/required":{"get":{"operationId":"PrivacyIdeaAdministrationController_requiresTwoFactorAuthentication","parameters":[{"name":"personId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"The requirement was successfully returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenRequiredResponse"}}}},"400":{"description":"A username was not given or not found."},"401":{"description":"Not authorized to get requirement information."},"403":{"description":"Insufficient permissions to get requirement information."},"404":{"description":"Insufficient permissions to get requirement information."},"500":{"description":"Internal server error while getting requirement information."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["2FA"]}},"/api/cron/kopers-lock":{"put":{"operationId":"CronController_koPersUserLock","parameters":[],"responses":{"201":{"description":"User were successfully locked.","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"User are not given or not found"},"401":{"description":"Not authorized to lock user."},"403":{"description":"Insufficient permissions to lock user."},"404":{"description":"Insufficient permissions to lock user."},"500":{"description":"Internal server error while trying to lock user."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["cron"]}},"/api/cron/kontext-expired":{"put":{"operationId":"CronController_removePersonenKontexteWithExpiredBefristungFromUsers","parameters":[],"responses":{"201":{"description":"Personenkontexte were successfully removed from users.","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"Personenkontexte are not given or not found."},"401":{"description":"Not authorized to remove personenkontexte from users."},"403":{"description":"Insufficient permissions to remove personenkontexte from users."},"404":{"description":"Insufficient permissions to remove personenkontexte from users."},"500":{"description":"Internal server error while trying to remove personenkontexte from users."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["cron"]}},"/api/cron/person-without-org":{"put":{"operationId":"CronController_personWithoutOrgDelete","parameters":[],"responses":{"201":{"description":"Users were successfully removed.","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"Users are not given or not found"},"401":{"description":"Not authorized to remove users."},"403":{"description":"Insufficient permissions to delete users."},"404":{"description":"Insufficient permissions to delete users."},"500":{"description":"Internal server error while trying to remove users."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["cron"]}},"/api/cron/unlock":{"put":{"operationId":"CronController_unlockUsersWithExpiredLocks","parameters":[],"responses":{"200":{"description":"The users were successfully unlocked.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Not authorized to unlock users."},"403":{"description":"Insufficient permissions to unlock users."},"404":{"description":"Insufficient permissions to unlock users."},"500":{"description":"Internal server error while trying to unlock users."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["cron"]}},"/api/cron/vidis-angebote":{"put":{"operationId":"CronController_updateServiceProvidersForVidisAngebote","parameters":[],"responses":{"201":{"description":"VIDIS Angebote were successfully updated.","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"VIDIS Angebote were not successfully updated."},"401":{"description":"Not authorized to update VIDIS Angebote."},"403":{"description":"Insufficient permissions to update VIDIS Angebote."},"404":{"description":"Insufficient permissions to update VIDIS Angebote."},"500":{"description":"Internal server error while trying to update VIDIS Angebote."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["cron"]}},"/api/cron/email-addresses-delete":{"delete":{"operationId":"CronController_emailAddressesDelete","parameters":[],"responses":{"201":{"description":"EmailAddresses were successfully removed.","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"EmailAddresses not found."},"401":{"description":"Not authorized to delete EmailAddresses."},"403":{"description":"Insufficient permissions to delete EmailAddresses."},"404":{"description":"Insufficient permissions to delete EmailAddresses."},"500":{"description":"Internal server error while trying to delete EmailAddresses."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["cron"]}},"/api/import/upload":{"post":{"operationId":"ImportController_uploadFile","parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/DbiamPersonenkontextImportBodyParams"}}}},"responses":{"200":{"description":"Returns an import upload response object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportUploadResponse"}}}},"400":{"description":"The CSV file was not valid."},"401":{"description":"Not authorized to import data with a CSV file."},"403":{"description":"Insufficient permissions to import data with a CSV file."},"500":{"description":"Internal server error while importing data with a CSV file."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["import"]}},"/api/import/execute":{"post":{"operationId":"ImportController_executeImport","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportvorgangByIdBodyParams"}}}},"responses":{"204":{"description":"The execution of the import transaction was initiated successfully."},"400":{"description":"Something went wrong with the found import transaction.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/DbiamImportError"}}}},"401":{"description":"Not authorized to execute the import transaction."},"403":{"description":"Insufficient permissions to execute the import transaction."},"404":{"description":"The import transaction does not exist."},"500":{"description":"Internal server error while executing the import transaction."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["import"]}},"/api/import/{importvorgangId}":{"delete":{"description":"Delete a role by id.","operationId":"ImportController_deleteImportTransaction","parameters":[{"name":"importvorgangId","required":true,"in":"path","description":"The id of an import transaction","schema":{"nullable":false,"type":"string"}}],"responses":{"204":{"description":"Import transaction was deleted successfully."},"400":{"description":"Something went wrong with the found import transaction.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamImportError"}}}},"401":{"description":"Not authorized to delete the import transaction."},"404":{"description":"The import transaction that should be deleted does not exist."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["import"]}},"/api/import/history":{"get":{"description":"Get the history of import.","operationId":"ImportController_findImportTransactions","parameters":[{"name":"offset","required":false,"in":"query","description":"The offset of the paginated list.","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"The requested limit for the page size.","schema":{"type":"number"}},{"name":"status","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ImportStatus"}},{"name":"rolleIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"organisationIds","required":false,"in":"query","description":"Liefert Importvorgänge mit den angegebenen IDs, selbst wenn andere Filterkriterien nicht zutreffen (ODER-verknüpft mit anderen Kriterien).","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"The import transactions were successfully returned","headers":{"X-Paging-Offset":{"description":"The offset of the first item from the list. List starts with index 0."},"X-Paging-Limit":{"description":"The maximum amount of items returned in one request."},"X-Paging-Total":{"description":"The total amount of items in the list."},"X-Paging-pageTotal":{"description":"The total amount of items in the paginated list."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ImportVorgangResponse"}}}}},"401":{"description":"Not authorized to get import transactions."},"403":{"description":"Insufficient permissions to get import transactions."},"500":{"description":"Internal server error while getting import transactions."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["import"]}},"/api/import/{importvorgangId}/download":{"get":{"deprecated":true,"description":"Download the import result file by importvorgangId as text file is deprecated, please use the  GET/api/import/importedUsers.","operationId":"ImportController_downloadFile","parameters":[{"name":"importvorgangId","required":true,"in":"path","description":"The id of an import transaction","schema":{"nullable":false,"type":"string"}}],"responses":{"200":{"description":"The import result file was generated and downloaded successfully.","content":{"text/plain":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Something went wrong with the found import transaction.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/DbiamImportError"}}}},"401":{"description":"Not authorized to download the import result."},"403":{"description":"Insufficient permissions to download the import result."},"404":{"description":"The import transaction does not exist."},"500":{"description":"Internal server error while generating the import result file."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["import"]}},"/api/import/{importvorgangId}/status":{"get":{"description":"Get status for the import transaction by id.","operationId":"ImportController_getImportStatus","parameters":[{"name":"importvorgangId","required":true,"in":"path","description":"The id of an import transaction","schema":{"nullable":false,"type":"string"}}],"responses":{"200":{"description":"The status for the import transaction was successfully returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportVorgangStatusResponse"}}}},"401":{"description":"Not authorized to get the status for the import transaction by id."},"403":{"description":"Insufficient permission to get status for the import transaction by id."},"500":{"description":"Internal server error while getting status for the import transaction by id."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["import"]}},"/api/import/importedUsers":{"get":{"description":"Get the list of imported users. The maximum limit is 100. After receiving all the imported users, please use the DELETE endpoint to remove imported data.","operationId":"ImportController_getImportedUsers","parameters":[{"name":"offset","required":false,"in":"query","description":"The offset of the paginated list.","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","description":"The requested limit for the page size.","schema":{"type":"number"}},{"name":"importvorgangId","required":true,"in":"query","description":"Liefert importierte Nutzerdaten für die angegebene ID, selbst wenn andere Filterkriterien nicht zutreffen (ODER-verknüpft mit anderen Kriterien).","schema":{"nullable":false,"type":"string"}}],"responses":{"200":{"description":"The list of imported users was successfully returned.","headers":{"X-Paging-Offset":{"description":"The offset of the first item from the list. List starts with index 0."},"X-Paging-Limit":{"description":"The maximum amount of items returned in one request."},"X-Paging-Total":{"description":"The total amount of items in the list."},"X-Paging-pageTotal":{"description":"The total amount of items in the paginated list."}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportResultResponse"}}}},"401":{"description":"Not authorized to get the list of imported users."},"403":{"description":"Insufficient permissions to get list of imported users."},"500":{"description":"Internal server error while getting list of imported users."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"","tags":["import"]}},"/metrics":{"get":{"operationId":"MetricsController_getMetrics","parameters":[],"responses":{"200":{"description":"Prometheus metrics."}},"summary":"Get Prometheus metrics","tags":["Metrics"]}},"/api/status":{"get":{"operationId":"StatusController_getStatus","parameters":[],"responses":{"200":{"description":""}},"tags":["status"]}},"/api/config":{"get":{"operationId":"ConfigController_getFeatureFlags","parameters":[],"responses":{"200":{"description":"The feature flag config was successfully returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureFlagResponse"}}}},"500":{"description":"Internal server error while getting the config."}},"tags":["config"]}},"/api/portal/meldung":{"get":{"description":"Get all meldungen.","operationId":"MeldungController_getAllMeldungen","parameters":[],"responses":{"200":{"description":"The meldungen were successfully returned.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MeldungResponse"}}}}},"401":{"description":"Not authorized to get available meldungen."},"403":{"description":"Insufficient permissions to get meldungen."},"500":{"description":"Internal server error while getting all meldungen."}},"security":[{"bearer":[]},{"oauth2":["openid"]}],"summary":"","tags":["meldung"]},"put":{"operationId":"MeldungController_createOrUpdateMeldung","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateMeldungBodyParams"}}}},"responses":{"200":{"description":"The meldung was successfully edited."},"401":{"description":"Not authorized to modify the meldung."},"403":{"description":"Not permitted to modify the meldung."},"500":{"description":"Internal server error while modifying the meldung."}},"security":[{"bearer":[]},{"oauth2":["openid"]}],"tags":["meldung"]}},"/api/portal/meldung/current":{"get":{"description":"Get current veroeffentlicht meldung.","operationId":"MeldungController_getCurrentMeldung","parameters":[],"responses":{"200":{"description":"The meldung was successfully returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeldungResponse"}}}},"401":{"description":"Not authorized to get current veroeffentlicht meldunge."},"403":{"description":"Insufficient permissions to get meldungen."},"500":{"description":"Internal server error while getting current veroeffentlicht meldung."}},"security":[{"bearer":[]},{"oauth2":["openid"]}],"summary":"","tags":["meldung"]}},"/api/landesbediensteter/step":{"get":{"operationId":"LandesbediensteterController_step","parameters":[{"name":"organisationId","required":false,"in":"query","description":"ID of the organisation to filter the rollen later","schema":{"nullable":true,"type":"string"}},{"name":"rollenIds","required":false,"in":"query","description":"IDs of the rollen.","schema":{"type":"array","items":{"type":"string"}}},{"name":"rolleName","required":false,"in":"query","description":"Rolle name used to filter for rollen in personenkontext.","schema":{"nullable":true,"type":"string"}},{"name":"organisationName","required":false,"in":"query","description":"Organisation/SSK name used to filter for schulstrukturknoten in personenkontext.","schema":{"nullable":true,"type":"string"}},{"name":"limit","required":false,"in":"query","description":"The limit of items for the request.","schema":{"nullable":false,"type":"number"}}],"responses":{"200":{"description":"Initialize or process data from the landesbedienstete form.\nValid combinations:\n- Both organisationId and rolleId are undefined: Fetch all possible organisations.\n- organisationId is provided, but rolleId is undefined: Fetch Rollen for the given organisation.\n- Both organisationId and rolleId are provided: Check if the Rolle can be committed for the organisation.\nNote: Providing rolleId without organisationId is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandesbediensteterWorkflowStepResponse"}}}},"401":{"description":"Not authorized to get available data."},"403":{"description":"Insufficient permission to get data."},"500":{"description":"Internal server error while getting data."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["landesbediensteter"]}},"/api/landesbediensteter/{personId}":{"put":{"operationId":"LandesbediensteterController_commit","parameters":[{"name":"personId","required":true,"in":"path","description":"The ID for the person.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandesbediensteterWorkflowCommitBodyParams"}}}},"responses":{"200":{"description":"Add personenkontexte as one operation. Returns the Personenkontexte existing after update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonenkontexteUpdateResponse"}}}},"400":{"description":"The personenkontexte could not be updated, maybe due to unsatisfied specifications.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DbiamPersonenkontexteUpdateError"}}}},"401":{"description":"Not authorized to update personenkontexte."},"403":{"description":"Insufficient permission to update personenkontexte."},"409":{"description":"Changes are conflicting with current state of personenkontexte."},"500":{"description":"Internal server error while updating personenkontexte."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"tags":["landesbediensteter"]}},"/api/person-info":{"get":{"operationId":"PersonInfoController_info","parameters":[],"responses":{"200":{"description":"Returns info about the person.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonInfoResponse"}}}},"401":{"description":"person is not logged in."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"Info about logged in person.","tags":["person-info"]}},"/api/v1/person-info":{"get":{"operationId":"personInfoControllerInfoV1","parameters":[],"responses":{"200":{"description":"Returns info about the person.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonInfoResponseV1"}}}},"401":{"description":"person is not logged in."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"Info about logged in person.","tags":["person-info"]}},"/api/personen-info":{"get":{"description":"liefert Personeninformationen basierend auf den Berechtigungen auf Service Provider des aufrufenden Nutzers.","operationId":"PersonenInfoController_infoV1","parameters":[{"name":"x-offset","required":false,"in":"query","description":"Offset für die Ergebnisse","schema":{"type":"integer"}},{"name":"x-limit","required":false,"in":"query","description":"Maximale Anzahl der Ergebnisse","schema":{"type":"integer"}}],"responses":{"200":{"description":"Liste von Personeninformationen","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonInfoResponseV1"}}}},"401":{"description":"person is not logged in."}},"security":[{"oauth2":["openid"]},{"bearer":[]}],"summary":"liefert Personeninformationen basierend auf den Berechtigungen auf Service Provider des aufrufenden Nutzers.","tags":["personen-info"]}}},"info":{"title":"dBildungs IAM","description":"The dBildungs IAM server API description","version":"1.0","contact":{}},"tags":[],"servers":[],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://main-keycloak.dev.spsh.dbildungsplattform.de/realms/SPSH/protocol/openid-connect/auth","tokenUrl":"https://main-keycloak.dev.spsh.dbildungsplattform.de/realms/SPSH/protocol/openid-connect/token","refreshUrl":"https://main-keycloak.dev.spsh.dbildungsplattform.de/realms/SPSH/protocol/openid-connect/token","scopes":{}}}},"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"OrganisationsTyp":{"type":"string","enum":["ROOT","LAND","TRAEGER","SCHULE","KLASSE","ANBIETER","SONSTIGE ORGANISATION / EINRICHTUNG","UNBESTAETIGT"]},"TraegerschaftTyp":{"type":"string","enum":["01","02","03","04","05","06"]},"OrganisationResponse":{"type":"object","properties":{"id":{"type":"string"},"administriertVon":{"type":"string","nullable":true},"zugehoerigZu":{"type":"string","nullable":true},"kennung":{"type":"string","nullable":true},"name":{"type":"string"},"namensergaenzung":{"type":"string","nullable":true},"kuerzel":{"type":"string"},"typ":{"allOf":[{"$ref":"#/components/schemas/OrganisationsTyp"}]},"traegerschaft":{"allOf":[{"$ref":"#/components/schemas/TraegerschaftTyp"}]},"itslearningEnabled":{"type":"boolean"},"version":{"type":"number"}},"required":["id","administriertVon","zugehoerigZu","kennung","name","namensergaenzung","kuerzel","typ","traegerschaft","itslearningEnabled","version"]},"RollenSystemRechtServiceProviderIDResponse":{"type":"object","properties":{"systemrechte":{"type":"array","items":{"type":"string"}},"serviceProviderIds":{"type":"array","items":{"type":"string"}}},"required":["systemrechte","serviceProviderIds"]},"PersonenkontextRolleFieldsResponse":{"type":"object","properties":{"organisation":{"$ref":"#/components/schemas/OrganisationResponse"},"rolle":{"$ref":"#/components/schemas/RollenSystemRechtServiceProviderIDResponse"}},"required":["organisation","rolle"]},"PersonTimeLimitInfoResponse":{"type":"object","properties":{"occasion":{"type":"string"},"deadline":{"type":"string"},"school":{"type":"string","nullable":true},"rolle":{"type":"string","nullable":true}},"required":["occasion","deadline","school","rolle"]},"UserinfoResponse":{"type":"object","properties":{"sub":{"type":"string"},"personId":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"given_name":{"type":"string","nullable":true},"family_name":{"type":"string","nullable":true},"middle_name":{"type":"string","nullable":true},"preferred_username":{"type":"string","nullable":true},"profile":{"type":"string","nullable":true},"picture":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"email_verified":{"type":"boolean","nullable":true},"zoneinfo":{"type":"string","nullable":true},"locale":{"type":"string","nullable":true},"phone_number":{"type":"string","nullable":true},"updated_at":{"type":"string","nullable":true},"password_updated_at":{"type":"string","nullable":true},"personenkontexte":{"type":"array","items":{"$ref":"#/components/schemas/PersonenkontextRolleFieldsResponse"}},"acr":{"type":"string","nullable":false},"timeLimits":{"type":"array","items":{"$ref":"#/components/schemas/PersonTimeLimitInfoResponse"}}},"required":["sub","personId","name","given_name","family_name","middle_name","preferred_username","profile","picture","website","email","email_verified","zoneinfo","locale","phone_number","updated_at","password_updated_at","personenkontexte","acr","timeLimits"]},"UserExternalDataResponseOx":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"UserExeternalDataResponseItslearning":{"type":"object","properties":{"personId":{"type":"string"}},"required":["personId"]},"UserExeternalDataResponseVidis":{"type":"object","properties":{"personId":{"type":"string"},"vorname":{"type":"string"},"nachname":{"type":"string"},"rollenart":{"type":"string"},"emailAdresse":{"type":"string"},"dienststellenNummern":{"type":"array","items":{"type":"string"}}},"required":["personId","vorname","nachname","rollenart","emailAdresse","dienststellenNummern"]},"UserExeternalDataResponseOpshPk":{"type":"object","properties":{"rollenArt":{"type":"string"},"dstNr":{"type":"string"}},"required":["rollenArt","dstNr"]},"UserExeternalDataResponseOpsh":{"type":"object","properties":{"vorname":{"type":"string"},"nachname":{"type":"string"},"personenkontexte":{"type":"array","items":{"$ref":"#/components/schemas/UserExeternalDataResponseOpshPk"}},"emailAdresse":{"type":"string"}},"required":["vorname","nachname","personenkontexte","emailAdresse"]},"UserExeternalDataResponseOnlineDateiablage":{"type":"object","properties":{"personId":{"type":"string"}},"required":["personId"]},"UserExternalDataResponse":{"type":"object","properties":{"ox":{"$ref":"#/components/schemas/UserExternalDataResponseOx"},"itslearning":{"$ref":"#/components/schemas/UserExeternalDataResponseItslearning"},"vidis":{"$ref":"#/components/schemas/UserExeternalDataResponseVidis"},"opsh":{"$ref":"#/components/schemas/UserExeternalDataResponseOpsh"},"onlineDateiablage":{"$ref":"#/components/schemas/UserExeternalDataResponseOnlineDateiablage"}},"required":["itslearning","vidis","opsh","onlineDateiablage"]},"PersonLandesbediensteterSearchPersonenkontextResponse":{"type":"object","properties":{"rolleId":{"type":"string"},"rolleName":{"type":"string"},"organisationId":{"type":"string"},"organisationName":{"type":"string"},"organisationDstNr":{"type":"string"}},"required":["rolleId","rolleName","organisationId","organisationName","organisationDstNr"]},"PersonLandesbediensteterSearchResponse":{"type":"object","properties":{"id":{"type":"string"},"vorname":{"type":"string"},"familienname":{"type":"string"},"username":{"type":"string"},"personalnummer":{"type":"string"},"primaryEmailAddress":{"type":"string"},"personenkontexte":{"type":"array","items":{"$ref":"#/components/schemas/PersonLandesbediensteterSearchPersonenkontextResponse"}}},"required":["id","vorname","familienname","username","personalnummer","primaryEmailAddress","personenkontexte"]},"PersonNameParams":{"type":"object","properties":{"familienname":{"type":"string"},"vorname":{"type":"string"}},"required":["familienname","vorname"]},"UserLockParams":{"type":"object","properties":{"personId":{"type":"string","nullable":true},"locked_by":{"type":"string","nullable":true},"created_at":{"type":"string","nullable":true},"locked_until":{"type":"string","nullable":true},"lock_occasion":{"type":"string","nullable":true}},"required":["personId","locked_by","created_at","locked_until","lock_occasion"]},"EmailAddressStatus":{"type":"string","enum":["ENABLED","DISABLED","REQUESTED","FAILED","DELETED_LDAP","DELETED_OX","DELETED"]},"PersonEmailResponse":{"type":"object","properties":{"status":{"allOf":[{"$ref":"#/components/schemas/EmailAddressStatus"}]},"address":{"type":"string"}},"required":["status","address"]},"PersonResponse":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string","nullable":true},"mandant":{"type":"string"},"name":{"$ref":"#/components/schemas/PersonNameParams"},"stammorganisation":{"type":"string","nullable":true},"revision":{"type":"string"},"startpasswort":{"type":"string","description":"Initiales Benutzerpasswort, muss nach der ersten Anmeldung geändert werden"},"personalnummer":{"type":"string","nullable":true},"isLocked":{"type":"boolean","nullable":true},"userLock":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/UserLockParams"}},"lastModified":{"format":"date-time","type":"string","description":"Date of the most recent changes for the person"},"email":{"nullable":true,"description":"Contains status and address. Returns email-address verified by OX (enabled) if available, otherwise returns most recently updated one (no prioritized status)","allOf":[{"$ref":"#/components/schemas/PersonEmailResponse"}]}},"required":["id","username","mandant","name","stammorganisation","revision","startpasswort","personalnummer","isLocked","userLock","lastModified","email"]},"PersonendatensatzResponse":{"type":"object","properties":{"person":{"$ref":"#/components/schemas/PersonResponse"}},"required":["person"]},"RawPagedResponse":{"type":"object","properties":{"total":{"type":"number"},"offset":{"type":"number"},"limit":{"type":"number"},"items":{"type":"array","items":{"type":"string"}}},"required":["total","offset","limit","items"]},"CreatedPersonenkontextOrganisation":{"type":"object","properties":{}},"LoeschungResponse":{"type":"object","properties":{"zeitpunkt":{"format":"date-time","type":"string"}},"required":["zeitpunkt"]},"PersonenkontextResponse":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string","nullable":true},"mandant":{"type":"string"},"organisation":{"$ref":"#/components/schemas/CreatedPersonenkontextOrganisation"},"rollenart":{"type":"string","nullable":true},"rollenname":{"type":"string","nullable":true},"personenstatus":{"type":"string","enum":["AKTIV"],"nullable":true},"jahrgangsstufe":{"type":"string","enum":["01","02","03","04","05","06","07","08","09","10"],"nullable":true},"sichtfreigabe":{"type":"string","enum":["ja","nein"],"nullable":true},"loeschung":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/LoeschungResponse"}]},"revision":{"type":"string"}},"required":["id","username","mandant","organisation","rollenart","rollenname","personenstatus","jahrgangsstufe","sichtfreigabe","loeschung","revision"]},"Personenstatus":{"type":"string","enum":["AKTIV"]},"Sichtfreigabe":{"type":"string","enum":["ja","nein"]},"UpdatePersonBodyParams":{"type":"object","properties":{"username":{"type":"string"},"stammorganisation":{"type":"string"},"name":{"$ref":"#/components/schemas/PersonNameParams"},"revision":{"type":"string"}},"required":["name","revision"]},"LockUserBodyParams":{"type":"object","properties":{"lock":{"type":"boolean","nullable":false},"locked_by":{"type":"string","nullable":false},"locked_until":{"format":"date-time","type":"string","description":"Required if Befristung is set"}},"required":["lock","locked_by"]},"PersonLockResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"PersonMetadataBodyParams":{"type":"object","properties":{"familienname":{"type":"string"},"vorname":{"type":"string"},"personalnummer":{"type":"string"},"lastModified":{"format":"date-time","type":"string","description":"Date of the most recent changed Personalnummer"},"revision":{"type":"string"}},"required":["familienname","vorname","lastModified","revision"]},"DbiamPersonError":{"type":"object","properties":{"i18nKey":{"type":"string","enum":["PERSON_ERROR","VORNAME_ENTHAELT_LEERZEICHEN","FAMILIENNAME_ENTHAELT_LEERZEICHEN","PERSON_NOT_FOUND","DOWNSTREAM_UNREACHABLE","PERSONALNUMMER_REQUIRED","NEWER_VERSION_OF_PERSON_AVAILABLE","PERSONALNUMMER_NICHT_EINDEUTIG","PERSON_UEM_PASSWORD_MODIFICATION_ERROR","LANDESBEDIENSTETER_SEARCH_NO_PERSON_FOUND","LANDESBEDIENSTETER_SEARCH_MULTIPLE_PERSONS_FOUND"]},"code":{"type":"number","description":"Corresponds to HTTP Status code like 200, 404, 500"}},"required":["i18nKey","code"]},"ScopeOrder":{"type":"string","enum":["asc","desc"]},"SortFieldPerson":{"type":"string","enum":["familienname","vorname","personalnummer","username"]},"RollenArt":{"type":"string","enum":["LERN","LEHR","EXTERN","ORGADMIN","LEIT","SYSADMIN"]},"RollenMerkmal":{"type":"string","enum":["BEFRISTUNG_PFLICHT","KOPERS_PFLICHT"]},"DBiamPersonenzuordnungResponse":{"type":"object","properties":{"sskId":{"type":"string"},"rolleId":{"type":"string"},"sskName":{"type":"string"},"sskDstNr":{"type":"string","nullable":true},"rolle":{"type":"string"},"rollenArt":{"nullable":false,"allOf":[{"$ref":"#/components/schemas/RollenArt"}]},"administriertVon":{"type":"string"},"typ":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/OrganisationsTyp"}]},"editable":{"type":"boolean"},"befristung":{"format":"date-time","type":"string","nullable":true},"merkmale":{"type":"array","items":{"$ref":"#/components/schemas/RollenMerkmal"}},"admins":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["sskId","rolleId","sskName","sskDstNr","rolle","rollenArt","administriertVon","typ","editable","befristung","merkmale","admins"]},"DBiamPersonenuebersichtResponse":{"type":"object","properties":{"personId":{"type":"string"},"vorname":{"type":"string"},"nachname":{"type":"string"},"benutzername":{"type":"string"},"lastModifiedZuordnungen":{"format":"date-time","type":"string","nullable":true,"description":"Date of the most recent changed personenkontext in the Zuordnungen"},"zuordnungen":{"type":"array","items":{"$ref":"#/components/schemas/DBiamPersonenzuordnungResponse"}}},"required":["personId","vorname","nachname","benutzername","lastModifiedZuordnungen","zuordnungen"]},"PersonenuebersichtBodyParams":{"type":"object","properties":{"personIds":{"description":"An array of IDs for the persons.","type":"array","items":{"type":"string"}}},"required":["personIds"]},"CreateOrganisationBodyParams":{"type":"object","properties":{"administriertVon":{"type":"string"},"zugehoerigZu":{"type":"string"},"kennung":{"type":"string","description":"Required, if `typ` is equal to `SCHULE`"},"name":{"type":"string"},"namensergaenzung":{"type":"string"},"kuerzel":{"type":"string"},"typ":{"allOf":[{"$ref":"#/components/schemas/OrganisationsTyp"}]},"traegerschaft":{"allOf":[{"$ref":"#/components/schemas/TraegerschaftTyp"}]},"emailAdress":{"type":"string"}},"required":["administriertVon","zugehoerigZu","name","typ"]},"DbiamOrganisationError":{"type":"object","properties":{"i18nKey":{"type":"string","enum":["ORGANISATION_SPECIFICATION_ERROR","KENNUNG_REQUIRED_FOR_SCHULE","NAME_REQUIRED_FOR_SCHULE","SCHULE_KENNUNG_EINDEUTIG","SCHULE_UNTER_TRAEGER","TRAEGER_IN_TRAEGER","NUR_KLASSE_UNTER_SCHULE","ZYKLUS_IN_ORGANISATION","ROOT_ORGANISATION_IMMUTABLE","KLASSE_NUR_VON_SCHULE_ADMINISTRIERT","KLASSENNAME_AN_SCHULE_EINDEUTIG","ORGANISATION_IST_BEREITS_ZUGEWIESEN_ERROR","NAME_REQUIRED_FOR_KLASSE","NAME_ENTHAELT_LEERZEICHEN","KENNUNG_ENTHAELT_LEERZEICHEN","EMAIL_ADRESS_ON_ORGANISATION_TYP","NEWER_VERSION_ORGANISATION","ORGANISATION_WECHSELT_TEILBAUM","ORGANISATION_ZUWEISUNG_FEHLER","SCHULTRAEGER_NAME_EINDEUTIG","ORGANISATION_HAT_KINDER","ORGANISATION_HAT_ZUGEHOERIGE","ORGANISATION_HAT_ROLLEN","ORGANISATION_HAT_PERSONENKONTEXTE","ORGANISATION_HAT_ANGEBOTE","ORGANISATION_HAT_ROLLENERWEITERUNGEN"]},"code":{"type":"number","description":"Corresponds to HTTP Status code like 200, 404, 500"}},"required":["i18nKey","code"]},"UpdateOrganisationBodyParams":{"type":"object","properties":{"administriertVon":{"type":"string"},"zugehoerigZu":{"type":"string"},"kennung":{"type":"string","description":"Required, if `typ` is equal to `SCHULE`"},"name":{"type":"string"},"namensergaenzung":{"type":"string"},"kuerzel":{"type":"string"},"typ":{"allOf":[{"$ref":"#/components/schemas/OrganisationsTyp"}]},"traegerschaft":{"allOf":[{"$ref":"#/components/schemas/TraegerschaftTyp"}]},"emailAdress":{"type":"string"}},"required":["administriertVon","zugehoerigZu","name","typ"]},"OrganisationRootChildrenResponse":{"type":"object","properties":{"oeffentlich":{"$ref":"#/components/schemas/OrganisationResponse"},"ersatz":{"$ref":"#/components/schemas/OrganisationResponse"}},"required":["oeffentlich","ersatz"]},"ParentOrganisationsByIdsBodyParams":{"type":"object","properties":{"organisationIds":{"description":"The ids of organizations","nullable":false,"type":"array","items":{"type":"string"}}},"required":["organisationIds"]},"ParentOrganisationenResponse":{"type":"object","properties":{"parents":{"type":"array","items":{"$ref":"#/components/schemas/OrganisationResponse"}}},"required":["parents"]},"RollenSystemRechtEnum":{"type":"string","enum":["ROLLEN_VERWALTEN","PERSONEN_SOFORT_LOESCHEN","PERSONEN_VERWALTEN","LANDESBEDIENSTETE_SUCHEN_UND_HINZUFUEGEN","EINGESCHRAENKT_NEUE_BENUTZER_ERSTELLEN","SCHULEN_VERWALTEN","KLASSEN_VERWALTEN","SCHULTRAEGER_VERWALTEN","PERSON_SYNCHRONISIEREN","CRON_DURCHFUEHREN","PERSONEN_ANLEGEN","IMPORT_DURCHFUEHREN","PERSONEN_LESEN","BULK_VERWALTEN","SCHULPORTAL_VERWALTEN","HINWEISE_BEARBEITEN","ROLLEN_ERWEITERN","ANGEBOTE_VERWALTEN","ANGEBOTE_EINGESCHRAENKT_VERWALTEN"]},"OrganisationByIdBodyParams":{"type":"object","properties":{"organisationId":{"type":"string","description":"The id of an organization","nullable":false}},"required":["organisationId"]},"OrganisationByNameBodyParams":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"number","description":"The version for the organisation."}},"required":["name","version"]},"OrganisationResponseLegacy":{"type":"object","properties":{"id":{"type":"string"},"administriertVon":{"type":"string","nullable":true},"kennung":{"type":"string","nullable":true},"name":{"type":"string"},"namensergaenzung":{"type":"string","nullable":true},"kuerzel":{"type":"string"},"typ":{"allOf":[{"$ref":"#/components/schemas/OrganisationsTyp"}]}},"required":["id","administriertVon","kennung","name","namensergaenzung","kuerzel","typ"]},"SystemRechtResponse":{"type":"object","properties":{"name":{"description":"The unique identifier of the system right","example":"ROLLEN_VERWALTEN","allOf":[{"$ref":"#/components/schemas/RollenSystemRechtEnum"}]},"isTechnical":{"type":"boolean","description":"Indicates if the system right is an internal right"}},"required":["name","isTechnical"]},"ServiceProviderIdNameResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"RolleWithServiceProvidersResponse":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"name":{"type":"string"},"administeredBySchulstrukturknoten":{"type":"string"},"rollenart":{"allOf":[{"$ref":"#/components/schemas/RollenArt"}]},"merkmale":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/RollenMerkmal"}},"systemrechte":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/SystemRechtResponse"}},"administeredBySchulstrukturknotenName":{"type":"string","nullable":true},"administeredBySchulstrukturknotenKennung":{"type":"string","nullable":true},"version":{"type":"number"},"serviceProviders":{"type":"array","items":{"$ref":"#/components/schemas/ServiceProviderIdNameResponse"}}},"required":["id","createdAt","updatedAt","name","administeredBySchulstrukturknoten","rollenart","merkmale","systemrechte","administeredBySchulstrukturknotenName","administeredBySchulstrukturknotenKennung","version","serviceProviders"]},"CreateRolleBodyParams":{"type":"object","properties":{"name":{"type":"string"},"administeredBySchulstrukturknoten":{"type":"string"},"rollenart":{"allOf":[{"$ref":"#/components/schemas/RollenArt"}]},"merkmale":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/RollenMerkmal"}},"systemrechte":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/RollenSystemRechtEnum"}}},"required":["name","administeredBySchulstrukturknoten","rollenart","merkmale","systemrechte"]},"RolleResponse":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"name":{"type":"string"},"administeredBySchulstrukturknoten":{"type":"string"},"rollenart":{"allOf":[{"$ref":"#/components/schemas/RollenArt"}]},"merkmale":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/RollenMerkmal"}},"systemrechte":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/SystemRechtResponse"}},"administeredBySchulstrukturknotenName":{"type":"string","nullable":true},"administeredBySchulstrukturknotenKennung":{"type":"string","nullable":true},"version":{"type":"number"}},"required":["id","createdAt","updatedAt","name","administeredBySchulstrukturknoten","rollenart","merkmale","systemrechte","administeredBySchulstrukturknotenName","administeredBySchulstrukturknotenKennung","version"]},"DbiamRolleError":{"type":"object","properties":{"i18nKey":{"type":"string","enum":["ROLLE_ERROR","ADD_SYSTEMRECHT_ERROR","ROLLE_HAT_PERSONENKONTEXTE_ERROR","UPDATE_MERKMALE_ERROR","ROLLENNAME_ENTHAELT_LEERZEICHEN","NEWER_VERSION_OF_ROLLE_AVAILABLE","ROLLE_NAME_UNIQUE_ON_SSK","SERVICE_PROVIDER_NICHT_NACHTRAEGLICH_ZUWEISBAR","SERVICE_PROVIDER_NICHT_VERFUEGBAR_FUER_ROLLENERWEITERUNG","NO_REDUNDANT_ROLLENERWEITERUNG"]},"code":{"type":"number","description":"Corresponds to HTTP Status code like 200, 404, 500"}},"required":["i18nKey","code"]},"AddSystemrechtBodyParams":{"type":"object","properties":{"systemRecht":{"allOf":[{"$ref":"#/components/schemas/RollenSystemRechtEnum"}]}},"required":["systemRecht"]},"RolleServiceProviderResponse":{"type":"object","properties":{"serviceProviderIds":{"type":"array","items":{"type":"string"}}},"required":["serviceProviderIds"]},"RolleServiceProviderBodyParams":{"type":"object","properties":{"serviceProviderIds":{"description":"An array of ids for the service providers.","nullable":false,"type":"array","items":{"type":"string"}},"version":{"type":"number","description":"The version for the rolle."}},"required":["serviceProviderIds","version"]},"ServiceProviderTarget":{"type":"string","enum":["URL","EMAIL","SCHULPORTAL_ADMINISTRATION"]},"ServiceProviderKategorie":{"type":"string","enum":["EMAIL","UNTERRICHT","VERWALTUNG","SCHULISCH","HINWEISE"]},"ServiceProviderMerkmal":{"type":"string","enum":["NACHTRAEGLICH_ZUWEISBAR","VERFUEGBAR_FUER_ROLLENERWEITERUNG"]},"ServiceProviderResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"target":{"allOf":[{"$ref":"#/components/schemas/ServiceProviderTarget"}]},"url":{"type":"string","description":"Can be undefined, if `target` is not equal to `URL`"},"kategorie":{"allOf":[{"$ref":"#/components/schemas/ServiceProviderKategorie"}]},"hasLogo":{"type":"boolean"},"requires2fa":{"type":"boolean"},"merkmale":{"type":"array","items":{"$ref":"#/components/schemas/ServiceProviderMerkmal"}}},"required":["id","name","target","url","kategorie","hasLogo","requires2fa","merkmale"]},"UpdateRolleBodyParams":{"type":"object","properties":{"name":{"type":"string"},"merkmale":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/RollenMerkmal"}},"systemrechte":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/RollenSystemRechtEnum"}},"serviceProviderIds":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"version":{"type":"number"}},"required":["name","merkmale","systemrechte","serviceProviderIds","version"]},"CreateRollenerweiterungBodyParams":{"type":"object","properties":{"organisationId":{"type":"string"},"rolleId":{"type":"string"},"serviceProviderId":{"type":"string"}},"required":["organisationId","rolleId","serviceProviderId"]},"RollenerweiterungResponse":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"organisationId":{"type":"string"},"rolleId":{"type":"string"},"serviceProviderId":{"type":"string"}},"required":["id","createdAt","updatedAt","organisationId","rolleId","serviceProviderId"]},"ApplyRollenerweiterungBodyParams":{"type":"object","properties":{"addErweiterungenForRolleIds":{"description":"List of rolleIds to apply.","example":["rolleId1","rolleId2"],"type":"array","items":{"type":"string"}},"removeErweiterungenForRolleIds":{"description":"List of rolleIds to apply.","example":["rolleId1","rolleId2"],"type":"array","items":{"type":"string"}}},"required":["addErweiterungenForRolleIds","removeErweiterungenForRolleIds"]},"DbiamApplyRollenerweiterungMultiError":{"type":"object","properties":{"code":{"type":"number","description":"Corresponds to HTTP Status code like 200, 404, 500"},"rolleIdsWithI18nKeys":{"type":"array","items":{"type":"object","properties":{"rolleId":{"type":"string"},"i18nKey":{"type":"string","enum":["ROLLENERWEITERUNG_TECHNICAL_ERROR","NOT_FOUND","NO_REDUNDANT_ROLLENERWEITERUNG"]}},"required":[]}}},"required":["code","rolleIdsWithI18nKeys"]},"RollenerweiterungWithExtendedDataResponse":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"organisationId":{"type":"string"},"rolleId":{"type":"string"},"serviceProviderId":{"type":"string"},"rolleName":{"type":"string"},"organisationName":{"type":"string"},"organisationKennung":{"type":"string"}},"required":["id","createdAt","updatedAt","organisationId","rolleId","serviceProviderId","rolleName","organisationName","organisationKennung"]},"OrganisationRefResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"kennung":{"type":"string"}},"required":["id","name"]},"RolleRefResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"RollenerweiterungForManageableServiceProviderResponse":{"type":"object","properties":{"organisation":{"$ref":"#/components/schemas/OrganisationRefResponse"},"rolle":{"$ref":"#/components/schemas/RolleRefResponse"}},"required":["organisation","rolle"]},"ManageableServiceProviderListEntryResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"administrationsebene":{"$ref":"#/components/schemas/OrganisationRefResponse"},"kategorie":{"allOf":[{"$ref":"#/components/schemas/ServiceProviderKategorie"}]},"requires2fa":{"type":"boolean"},"merkmale":{"type":"array","items":{"$ref":"#/components/schemas/ServiceProviderMerkmal"}},"rollenerweiterungen":{"type":"array","items":{"$ref":"#/components/schemas/RollenerweiterungForManageableServiceProviderResponse"}},"rollen":{"type":"array","items":{"$ref":"#/components/schemas/RolleRefResponse"}}},"required":["id","name","administrationsebene","kategorie","requires2fa","merkmale","rollenerweiterungen","rollen"]},"ManageableServiceProviderResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"administrationsebene":{"$ref":"#/components/schemas/OrganisationRefResponse"},"kategorie":{"allOf":[{"$ref":"#/components/schemas/ServiceProviderKategorie"}]},"requires2fa":{"type":"boolean"},"merkmale":{"type":"array","items":{"$ref":"#/components/schemas/ServiceProviderMerkmal"}},"url":{"type":"string","description":"Can be undefined, if `target` is not equal to `URL`"},"hasRollenerweiterung":{"type":"boolean"},"availableForRollenerweiterung":{"type":"boolean","description":"Indicates whether the service provider is available for rollenerweiterung."},"rollen":{"type":"array","items":{"$ref":"#/components/schemas/RolleRefResponse"}}},"required":["id","name","administrationsebene","kategorie","requires2fa","merkmale","url","hasRollenerweiterung","availableForRollenerweiterung","rollen"]},"CreateServiceProviderBodyParams":{"type":"object","properties":{"organisationId":{"type":"string","description":"The id of an organization","nullable":false},"name":{"type":"string"},"url":{"type":"string"},"logoBase64":{"type":"string","description":"Optional logo as base64-encoded string"},"logoMimeType":{"type":"string","enum":["image/png","image/jpeg","image/webp","image/svg+xml"],"example":"image/png"},"kategorie":{"type":"string","enum":["EMAIL","UNTERRICHT","VERWALTUNG","SCHULISCH","HINWEISE"]},"requires2fa":{"type":"boolean"},"merkmale":{"type":"array","items":{"type":"string","enum":["NACHTRAEGLICH_ZUWEISBAR","VERFUEGBAR_FUER_ROLLENERWEITERUNG"]}}},"required":["organisationId","name","kategorie","requires2fa","merkmale"]},"PersonResponseAutomapper":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"},"mandant":{"type":"string"},"name":{"$ref":"#/components/schemas/PersonNameParams"},"stammorganisation":{"type":"string"},"revision":{"type":"string"},"startpasswort":{"type":"string","description":"Initiales Benutzerpasswort, muss nach der ersten Anmeldung geändert werden"},"personalnummer":{"type":"string"}},"required":["id","username","mandant","name","stammorganisation","revision","startpasswort","personalnummer"]},"PersonendatensatzResponseAutomapper":{"type":"object","properties":{"person":{"$ref":"#/components/schemas/PersonResponseAutomapper"},"personenkontexte":{"type":"array","items":{"$ref":"#/components/schemas/PersonenkontextResponse"}}},"required":["person","personenkontexte"]},"PersonIdResponse":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"PersonenkontextdatensatzResponse":{"type":"object","properties":{"person":{"$ref":"#/components/schemas/PersonIdResponse"},"personenkontexte":{"type":"array","items":{"$ref":"#/components/schemas/PersonenkontextResponse"}}},"required":["person","personenkontexte"]},"DeleteRevisionBodyParams":{"type":"object","properties":{"revision":{"type":"string","description":"The revision of a personenkontext.","nullable":false}},"required":["revision"]},"OperationContext":{"type":"string","enum":["PERSON_ANLEGEN","PERSON_BEARBEITEN"]},"PersonenkontextWorkflowResponse":{"type":"object","properties":{"organisations":{"description":"List of available organisations.","type":"array","items":{"$ref":"#/components/schemas/OrganisationResponseLegacy"}},"rollen":{"description":"List of available roles.","type":"array","items":{"$ref":"#/components/schemas/RolleResponse"}},"selectedOrganisation":{"type":"string","description":"Selected organisation.","nullable":true},"selectedRollen":{"description":"Selected rollen.","nullable":true,"type":"array","items":{"type":"string"}},"canCommit":{"type":"boolean","description":"Indicates whether the commit action can be performed."}},"required":["organisations","rollen","selectedOrganisation","selectedRollen","canCommit"]},"DbiamPersonenkontextBodyParams":{"type":"object","properties":{"personId":{"type":"string"},"organisationId":{"type":"string"},"rolleId":{"type":"string"},"befristung":{"format":"date-time","type":"string"}},"required":["personId","organisationId","rolleId"]},"DbiamUpdatePersonenkontexteBodyParams":{"type":"object","properties":{"lastModified":{"format":"date-time","type":"string","nullable":true,"description":"Date of the most recent changed personenkontext"},"count":{"type":"number","nullable":false,"description":"The amount of personenkontexte"},"personenkontexte":{"nullable":false,"type":"array","items":{"$ref":"#/components/schemas/DbiamPersonenkontextBodyParams"}}},"required":["count","personenkontexte"]},"DBiamPersonenkontextResponse":{"type":"object","properties":{"personId":{"type":"string"},"organisationId":{"type":"string"},"rolleId":{"type":"string"},"befristung":{"type":"string","nullable":true}},"required":["personId","organisationId","rolleId","befristung"]},"PersonenkontexteUpdateResponse":{"type":"object","properties":{"dBiamPersonenkontextResponses":{"type":"array","items":{"$ref":"#/components/schemas/DBiamPersonenkontextResponse"}}},"required":["dBiamPersonenkontextResponses"]},"DbiamPersonenkontexteUpdateError":{"type":"object","properties":{"i18nKey":{"type":"string","enum":["PERSONENKONTEXTE_UPDATE_ERROR","PERSONENKONTEXT_NOT_FOUND","COUNT_MISMATCHING","NEWER_VERSION_OF_PERSONENKONTEXTE_AVAILABLE","INVALID_LAST_MODIFIED_VALUE","PERSON_ID_MISMATCH","PERSON_NOT_FOUND","INVALID_PERSONENKONTEXT_FOR_PERSON_WITH_ROLLENART_LERN"," BEFRISTUNG_REQUIRED_FOR_PERSONENKONTEXT","DUPLICATE_KLASSENKONTEXT_FOR_SAME_ROLLE","LERN_NOT_AT_SCHULE_AND_KLASSE"]},"code":{"type":"number","description":"Corresponds to HTTP Status code like 200, 404, 500"}},"required":["i18nKey","code"]},"DbiamCreatePersonenkontextBodyParams":{"type":"object","properties":{"organisationId":{"type":"string"},"rolleId":{"type":"string"}},"required":["organisationId","rolleId"]},"DbiamCreatePersonWithPersonenkontexteBodyParams":{"type":"object","properties":{"familienname":{"type":"string"},"vorname":{"type":"string"},"personalnummer":{"type":"string"},"befristung":{"format":"date-time","type":"string"},"createPersonenkontexte":{"nullable":false,"type":"array","items":{"$ref":"#/components/schemas/DbiamCreatePersonenkontextBodyParams"}}},"required":["familienname","vorname","createPersonenkontexte"]},"DBiamPersonResponse":{"type":"object","properties":{"person":{"$ref":"#/components/schemas/PersonResponse"},"dBiamPersonenkontextResponses":{"type":"array","items":{"$ref":"#/components/schemas/DBiamPersonenkontextResponse"}}},"required":["person","dBiamPersonenkontextResponses"]},"DbiamPersonenkontextError":{"type":"object","properties":{"i18nKey":{"type":"string","enum":["PERSONENKONTEXT_SPECIFICATION_ERROR","NUR_LEHR_UND_LERN_AN_KLASSE","GLEICHE_ROLLE_AN_KLASSE_WIE_SCHULE","ORGANISATION_MATCHES_ROLLENART","PERSONENKONTEXT_ANLAGE_ERROR","ROLLE_NUR_AN_PASSENDE_ORGANISATION","PERSONALNUMMER_NICHT_EINDEUTIG"]},"code":{"type":"number","description":"Corresponds to HTTP Status code like 200, 404, 500"}},"required":["i18nKey","code"]},"FindRollenResponse":{"type":"object","properties":{"moeglicheRollen":{"type":"array","items":{"$ref":"#/components/schemas/RolleResponse"}},"total":{"type":"number"}},"required":["moeglicheRollen","total"]},"TokenInitBodyParams":{"type":"object","properties":{"personId":{"type":"string"}},"required":["personId"]},"TokenStateResponse":{"type":"object","properties":{"hasToken":{"type":"boolean"},"tokenKind":{"type":"string"},"serial":{"type":"string"}},"required":["hasToken","tokenKind","serial"]},"AssignHardwareTokenBodyParams":{"type":"object","properties":{"serial":{"type":"string"},"otp":{"type":"string"},"username":{"type":"string"},"userId":{"type":"string"}},"required":["serial","otp","username","userId"]},"AssignHardwareTokenResponse":{"type":"object","properties":{"id":{"type":"number"},"jsonrpc":{"type":"string"},"time":{"type":"number"},"version":{"type":"string"},"versionnumber":{"type":"string"},"signature":{"type":"string"},"dialogText":{"type":"string"}},"required":["id","jsonrpc","time","version","versionnumber","signature","dialogText"]},"TokenVerifyBodyParams":{"type":"object","properties":{"personId":{"type":"string"},"otp":{"type":"string"}},"required":["personId","otp"]},"TokenRequiredResponse":{"type":"object","properties":{"required":{"type":"boolean"}},"required":["required"]},"DbiamPersonenkontextImportBodyParams":{"type":"object","properties":{"organisationId":{"type":"string"},"rolleId":{"type":"string"},"file":{"type":"string","format":"binary"}},"required":["organisationId","rolleId","file"]},"ImportDataItemResponse":{"type":"object","properties":{"nachname":{"type":"string"},"vorname":{"type":"string"},"klasse":{"type":"string","nullable":true},"validationErrors":{"type":"array","items":{"type":"string"}}},"required":["nachname","vorname","klasse","validationErrors"]},"ImportUploadResponse":{"type":"object","properties":{"importvorgangId":{"type":"string","description":"The import transaction number. it will be needed to execute the import and download the result"},"isValid":{"type":"boolean","description":"It states if the import transaction contain errors."},"totalImportDataItems":{"type":"number","description":"The total number of data items in the CSV file."},"totalInvalidImportDataItems":{"type":"number","description":"The total number of data items in the CSV file that are invalid."},"invalidImportDataItems":{"type":"array","items":{"$ref":"#/components/schemas/ImportDataItemResponse"}}},"required":["importvorgangId","isValid","totalImportDataItems","totalInvalidImportDataItems","invalidImportDataItems"]},"ImportvorgangByIdBodyParams":{"type":"object","properties":{"importvorgangId":{"type":"string","description":"The id of an import transaction","nullable":false}},"required":["importvorgangId"]},"DbiamImportError":{"type":"object","properties":{"i18nKey":{"type":"string","enum":["IMPORT_ERROR","CSV_PARSING_ERROR","CSV_FILE_EMPTY_ERROR","IMPORT_TEXT_FILE_CREATION_ERROR","IMPORT_NUR_LERN_AN_SCHULE_ERROR","CSV_FILE_INVALID_HEADER_ERROR","IMPORT_MAX_USERS_LIMIT_ERROR","CSV_FILE_NO_USERS_ERROR","IMPORT_RESULT_QUERY_LIMIT_ERROR"]},"code":{"type":"number","description":"Corresponds to HTTP Status code like 200, 404, 500"}},"required":["i18nKey","code"]},"ImportStatus":{"type":"string","enum":["CANCELLED","COMPLETED","FAILED","FINISHED","INPROGRESS","INVALID","STARTED","VALID"]},"ImportVorgangResponse":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"rollenname":{"type":"string"},"organisationsname":{"type":"string"},"dataItemCount":{"type":"number"},"status":{"allOf":[{"$ref":"#/components/schemas/ImportStatus"}]}},"required":["id","createdAt","updatedAt","rollenname","organisationsname","dataItemCount","status"]},"ImportVorgangStatusResponse":{"type":"object","properties":{"dataItemCount":{"type":"number"},"status":{"allOf":[{"$ref":"#/components/schemas/ImportStatus"}]},"totalDataItemImported":{"type":"number"}},"required":["dataItemCount","status","totalDataItemImported"]},"ImportDataItemStatus":{"type":"string","enum":["FAILED","SUCCESS","PENDING"]},"ImportedUserResponse":{"type":"object","properties":{"klasse":{"type":"string"},"vorname":{"type":"string"},"nachname":{"type":"string"},"benutzername":{"type":"string"},"startpasswort":{"type":"string","description":"Initiales Benutzerpasswort, muss nach der ersten Anmeldung geändert werden"},"status":{"allOf":[{"$ref":"#/components/schemas/ImportDataItemStatus"}]}},"required":["klasse","vorname","nachname","benutzername","startpasswort","status"]},"ImportResultResponse":{"type":"object","properties":{"importvorgandId":{"type":"string"},"rollenname":{"type":"string"},"organisationsname":{"type":"string"},"importedUsers":{"type":"array","items":{"$ref":"#/components/schemas/ImportedUserResponse"}},"total":{"type":"number","description":"Total number of imported users"},"pageTotal":{"type":"number","description":"Number of users on this page"}},"required":["importvorgandId","rollenname","organisationsname","importedUsers","total","pageTotal"]},"FeatureFlagResponse":{"type":"object","properties":{"rolleBearbeitenEnabled":{"type":"boolean"},"befristungBearbeitenEnabled":{"type":"boolean"},"rolleErweiternEnabled":{"type":"boolean"},"setUemPasswordEnabled":{"type":"boolean"},"schulischeAngeboteErstellen":{"type":"boolean"}},"required":["rolleBearbeitenEnabled","befristungBearbeitenEnabled","rolleErweiternEnabled","setUemPasswordEnabled","schulischeAngeboteErstellen"]},"MeldungResponse":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"inhalt":{"type":"string"},"status":{"type":"string","enum":["VEROEFFENTLICHT","NICHT_VEROEFFENTLICHT"]},"revision":{"type":"number"}},"required":["id","createdAt","updatedAt","inhalt","status","revision"]},"CreateOrUpdateMeldungBodyParams":{"type":"object","properties":{"id":{"type":"string"},"inhalt":{"type":"string"},"status":{"type":"string","enum":["VEROEFFENTLICHT","NICHT_VEROEFFENTLICHT"]},"revision":{"type":"number"}},"required":["inhalt","status","revision"]},"LandesbediensteterWorkflowStepResponse":{"type":"object","properties":{"organisations":{"description":"List of available organisations.","type":"array","items":{"$ref":"#/components/schemas/OrganisationResponseLegacy"}},"rollen":{"description":"List of available roles.","type":"array","items":{"$ref":"#/components/schemas/RolleResponse"}},"selectedOrganisation":{"type":"string","description":"Selected organisation.","nullable":true},"selectedRollen":{"description":"Selected rollen.","nullable":true,"type":"array","items":{"type":"string"}},"canCommit":{"type":"boolean","description":"Indicates whether the commit action can be performed."}},"required":["organisations","rollen","selectedOrganisation","selectedRollen","canCommit"]},"LandesbediensteterWorkflowCommitBodyParams":{"type":"object","properties":{"lastModified":{"format":"date-time","type":"string","nullable":true,"description":"Date of the most recent changed personenkontext"},"count":{"type":"number","nullable":false,"description":"The amount of personenkontexte"},"personalnummer":{"type":"string","description":"Optional Personalnummer for the person"},"newPersonenkontexte":{"nullable":false,"type":"array","items":{"$ref":"#/components/schemas/DbiamPersonenkontextBodyParams"}}},"required":["count","newPersonenkontexte"]},"PersonNameResponse":{"type":"object","properties":{"familiennamen":{"type":"string"},"vorname":{"type":"string"}},"required":["familiennamen","vorname"]},"PersonNestedInPersonInfoResponse":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string","nullable":true},"mandant":{"type":"string"},"name":{"$ref":"#/components/schemas/PersonNameResponse"},"stammorganisation":{"type":"string","nullable":true},"revision":{"type":"string"},"personalnummer":{"type":"string","nullable":true},"dienststellen":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","username","mandant","name","stammorganisation","revision","personalnummer","dienststellen"]},"PersonenInfoKontextOrganisationResponse":{"type":"object","properties":{"id":{"type":"string","nullable":false},"name":{"type":"string","nullable":true},"typ":{"type":"string","enum":["ROOT","LAND","TRAEGER","SCHULE","KLASSE","ANBIETER","SONSTIGE ORGANISATION / EINRICHTUNG","UNBESTAETIGT"],"nullable":true},"kennung":{"type":"string","nullable":true}},"required":["id","name","typ","kennung"]},"PersonenInfoKontextResponse":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string","nullable":true},"mandant":{"type":"string"},"organisation":{"$ref":"#/components/schemas/PersonenInfoKontextOrganisationResponse"},"rollenart":{"type":"string","nullable":true},"rollenname":{"type":"string","nullable":true},"personenstatus":{"type":"string","enum":["AKTIV"],"nullable":true},"jahrgangsstufe":{"type":"string","enum":["01","02","03","04","05","06","07","08","09","10"],"nullable":true},"sichtfreigabe":{"type":"string","enum":["ja","nein"],"nullable":true},"loeschung":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/LoeschungResponse"}]},"revision":{"type":"string"}},"required":["id","username","mandant","organisation","rollenart","rollenname","personenstatus","jahrgangsstufe","sichtfreigabe","loeschung","revision"]},"PersonInfoResponse":{"type":"object","properties":{"pid":{"type":"string"},"person":{"$ref":"#/components/schemas/PersonNestedInPersonInfoResponse"},"personenkontexte":{"type":"array","items":{"$ref":"#/components/schemas/PersonenInfoKontextResponse"}},"gruppen":{"type":"array","items":{"type":"string"}},"email":{"nullable":true,"description":"Contains status and address. Returns email-address verified by OX (enabled) if available, otherwise returns most recently updated one (no prioritized status)","allOf":[{"$ref":"#/components/schemas/PersonEmailResponse"}]}},"required":["pid","person","personenkontexte","gruppen","email"]},"PersonInfoPersonNameResponseV1":{"type":"object","properties":{"familiennamen":{"type":"string"},"vorname":{"type":"string"}},"required":["familiennamen","vorname"]},"PersonInfoPersonResponseV1":{"type":"object","properties":{"stammorganisation":{"type":"object","nullable":true},"name":{"$ref":"#/components/schemas/PersonInfoPersonNameResponseV1"}},"required":["stammorganisation","name"]},"PersonenInfoKontextOrganisationResponseV1":{"type":"object","properties":{"id":{"type":"string"},"kennung":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"typ":{"type":"string","enum":["Schule","Sonstige"],"nullable":true}},"required":["id","kennung","name","typ"]},"PersonInfoKontextErreichbarkeitResponseV1":{"type":"object","properties":{"typ":{"type":"string","enum":["E-Mail"]},"kennung":{"type":"string"}},"required":["typ","kennung"]},"PersonenInfoKontextGruppeResponseV1":{"type":"object","properties":{"id":{"type":"string","nullable":false},"bezeichnung":{"type":"string","nullable":false},"typ":{"type":"string","enum":["Klasse"],"nullable":false}},"required":["id","bezeichnung","typ"]},"PersonInfoKontextResponseV1":{"type":"object","properties":{"id":{"type":"string"},"organisation":{"$ref":"#/components/schemas/PersonenInfoKontextOrganisationResponseV1"},"rolle":{"type":"string","enum":["Lern","Lehr","SorgBer","Extern","OrgAdmin","Leit","SysAdmin","SchB","NLehr"]},"erreichbarkeiten":{"type":"array","items":{"$ref":"#/components/schemas/PersonInfoKontextErreichbarkeitResponseV1"}},"personenstatus":{"type":"string","enum":["Aktiv"],"nullable":true},"gruppen":{"type":"array","items":{"$ref":"#/components/schemas/PersonenInfoKontextGruppeResponseV1"}}},"required":["id","organisation","rolle","erreichbarkeiten","personenstatus","gruppen"]},"PersonInfoResponseV1":{"type":"object","properties":{"pid":{"type":"string"},"person":{"$ref":"#/components/schemas/PersonInfoPersonResponseV1"},"personenkontexte":{"type":"array","items":{"$ref":"#/components/schemas/PersonInfoKontextResponseV1"}},"beziehungen":{"type":"array","items":{"type":"object"}}},"required":["pid","person","personenkontexte","beziehungen"]}}}}