|
2435 | 2435 | "title": "OnboardingInstitutionUsersRequest", |
2436 | 2436 | "type": "object", |
2437 | 2437 | "properties": { |
| 2438 | + "institutionId": { |
| 2439 | + "type": "string", |
| 2440 | + "description": "The institution ID where users will be added. This takes precedence over the tax code" |
| 2441 | + }, |
2438 | 2442 | "institutionSubunitCode": { |
2439 | | - "type": "string" |
| 2443 | + "type": "string", |
| 2444 | + "description": "Add users to the institution via subunit code. Can be used in combination with institutionTaxCode" |
2440 | 2445 | }, |
2441 | 2446 | "institutionTaxCode": { |
2442 | | - "type": "string" |
| 2447 | + "type": "string", |
| 2448 | + "description": "Add users to the institution via tax code. Can be used in combination with institutionSubunitCode" |
2443 | 2449 | }, |
2444 | 2450 | "productId": { |
2445 | | - "type": "string" |
| 2451 | + "type": "string", |
| 2452 | + "description": "Product to add roles to" |
2446 | 2453 | }, |
2447 | 2454 | "sendCreateUserNotificationEmail": { |
2448 | | - "type": "boolean" |
| 2455 | + "type": "boolean", |
| 2456 | + "description": "Send an email notification to the user. By default it's set to true", |
| 2457 | + "example": false |
2449 | 2458 | }, |
2450 | 2459 | "users": { |
2451 | 2460 | "type": "array", |
| 2461 | + "description": "List of users to add", |
2452 | 2462 | "items": { |
2453 | 2463 | "$ref": "#/components/schemas/Person" |
2454 | 2464 | } |
|
2460 | 2470 | "type": "object", |
2461 | 2471 | "properties": { |
2462 | 2472 | "email": { |
2463 | | - "type": "string" |
| 2473 | + "type": "string", |
| 2474 | + "description": "The email address of the user to add / create. If id is present, the field is ignored" |
2464 | 2475 | }, |
2465 | 2476 | "env": { |
2466 | 2477 | "type": "string", |
| 2478 | + "description": "Environment. The field is currently not used to create users. It's only returned in response", |
2467 | 2479 | "enum": [ |
2468 | 2480 | "COLL", |
2469 | 2481 | "DEV", |
|
2472 | 2484 | ] |
2473 | 2485 | }, |
2474 | 2486 | "id": { |
2475 | | - "type": "string" |
| 2487 | + "type": "string", |
| 2488 | + "description": "User ID of a user already in the registry. A role will be added to the institution/product for the user. It takes precedence over taxCode" |
2476 | 2489 | }, |
2477 | 2490 | "name": { |
2478 | | - "type": "string" |
| 2491 | + "type": "string", |
| 2492 | + "description": "The name of the user to add / create. If id is present, the field is ignored" |
2479 | 2493 | }, |
2480 | 2494 | "productRole": { |
2481 | | - "type": "string" |
| 2495 | + "type": "string", |
| 2496 | + "description": "The product role to assign to the user based on the product specifications" |
2482 | 2497 | }, |
2483 | 2498 | "role": { |
2484 | 2499 | "type": "string", |
| 2500 | + "description": "The role to assign to the user", |
2485 | 2501 | "enum": [ |
2486 | 2502 | "ADMIN_EA", |
2487 | 2503 | "DELEGATE", |
|
2491 | 2507 | ] |
2492 | 2508 | }, |
2493 | 2509 | "roleLabel": { |
2494 | | - "type": "string" |
| 2510 | + "type": "string", |
| 2511 | + "description": "The product role label based on the product specifications. The field is currently not used to create users" |
2495 | 2512 | }, |
2496 | 2513 | "surname": { |
2497 | | - "type": "string" |
| 2514 | + "type": "string", |
| 2515 | + "description": "The surname of the user to add / create. If id is present, the field is ignored" |
2498 | 2516 | }, |
2499 | 2517 | "taxCode": { |
2500 | | - "type": "string" |
| 2518 | + "type": "string", |
| 2519 | + "description": "The tax code of the user to add / create. If id is present, the field is ignored" |
| 2520 | + }, |
| 2521 | + "userMailUuid": { |
| 2522 | + "type": "string", |
| 2523 | + "description": "The email ID of the user already in the registry to be assigned to the institution/product. This field is only used when adding a user by ID" |
2501 | 2524 | } |
2502 | 2525 | } |
2503 | 2526 | }, |
|
3092 | 3115 | }, |
3093 | 3116 | "dataProtectionOfficer": { |
3094 | 3117 | "$ref": "#/components/schemas/DataProtectionOfficerRequest1" |
| 3118 | + }, |
| 3119 | + "atecoCodes": { |
| 3120 | + "type": "array", |
| 3121 | + "items": { |
| 3122 | + "type": "string" |
| 3123 | + } |
3095 | 3124 | } |
3096 | 3125 | } |
3097 | 3126 | }, |
|
3486 | 3515 | }, |
3487 | 3516 | "imported": { |
3488 | 3517 | "type": "boolean" |
| 3518 | + }, |
| 3519 | + "atecoCodes": { |
| 3520 | + "type": "array", |
| 3521 | + "items": { |
| 3522 | + "type": "string" |
| 3523 | + } |
3489 | 3524 | } |
3490 | 3525 | } |
3491 | 3526 | }, |
|
0 commit comments