Skip to content

Commit e702983

Browse files
author
gitlab-ci-token
committed
1 parent 194b325 commit e702983

3 files changed

Lines changed: 220 additions & 0 deletions

File tree

‎docs/core/invitations-and-permissions/user-group-invitations.md‎

Lines changed: 210 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
| <span class="http-badge http-get">GET</span> | `/api/user-group-invitations/` | [List group invitations](#list-group-invitations) |
99
| <span class="http-badge http-get">GET</span> | `/api/user-group-invitations/{uuid}/` | [Retrieve group invitation](#retrieve-group-invitation) |
1010
| <span class="http-badge http-post">POST</span> | `/api/user-group-invitations/` | [Create group invitation](#create-group-invitation) |
11+
| <span class="http-badge http-put">PUT</span> | `/api/user-group-invitations/{uuid}/` | [Update a group invitation](#update-a-group-invitation) |
12+
| <span class="http-badge http-patch">PATCH</span> | `/api/user-group-invitations/{uuid}/` | [Partially update a group invitation](#partially-update-a-group-invitation) |
1113
| <span class="http-badge http-delete">DELETE</span> | `/api/user-group-invitations/{uuid}/` | [Delete a group invitation](#delete-a-group-invitation) |
1214
| **Other Actions** | | |
1315
| <span class="http-badge http-get">GET</span> | `/api/user-group-invitations/{uuid}/projects/` | [List projects for a customer-scoped group invitation](#list-projects-for-a-customer-scoped-group-invitation) |
@@ -114,6 +116,7 @@ Retrieve a list of group invitations. Unauthenticated users can only see public
114116
| `user_email_patterns` | any | |
115117
| `user_identity_sources` | any | List of allowed identity sources (identity providers). |
116118
| `scope_image` | string (uri) | Image URL of the invitation scope (Customer or Project) |
119+
| `custom_text` | string | Custom description text displayed to users viewing this invitation. |
117120

118121
---
119122

@@ -208,6 +211,7 @@ Retrieve details of a specific group invitation. Unauthenticated users can only
208211
| `user_email_patterns` | any | |
209212
| `user_identity_sources` | any | List of allowed identity sources (identity providers). |
210213
| `scope_image` | string (uri) | Image URL of the invitation scope (Customer or Project) |
214+
| `custom_text` | string | Custom description text displayed to users viewing this invitation. |
211215

212216
---
213217

@@ -288,6 +292,7 @@ Create a new group invitation, which acts as a template for users to request per
288292
| `user_affiliations` | any | | |
289293
| `user_email_patterns` | any | | |
290294
| `user_identity_sources` | any | | List of allowed identity sources (identity providers). |
295+
| `custom_text` | string | | Custom description text displayed to users viewing this invitation. |
291296

292297

293298
=== "Responses"
@@ -321,6 +326,211 @@ Create a new group invitation, which acts as a template for users to request per
321326
| `user_email_patterns` | any | |
322327
| `user_identity_sources` | any | List of allowed identity sources (identity providers). |
323328
| `scope_image` | string (uri) | Image URL of the invitation scope (Customer or Project) |
329+
| `custom_text` | string | Custom description text displayed to users viewing this invitation. |
330+
331+
---
332+
333+
### Update a group invitation
334+
335+
Update an active group invitation. Only active invitations can be edited.
336+
337+
338+
=== "HTTPie"
339+
340+
```bash
341+
http \
342+
PUT \
343+
https://api.example.com/api/user-group-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
344+
Authorization:"Token YOUR_API_TOKEN"
345+
```
346+
347+
=== "Python"
348+
349+
```python
350+
from waldur_api_client.client import AuthenticatedClient
351+
from waldur_api_client.models.group_invitation_update_request import GroupInvitationUpdateRequest # (1)
352+
from waldur_api_client.api.user_group_invitations import user_group_invitations_update # (2)
353+
354+
client = AuthenticatedClient(
355+
base_url="https://api.example.com", token="YOUR_API_TOKEN"
356+
)
357+
358+
body_data = GroupInvitationUpdateRequest()
359+
response = user_group_invitations_update.sync(
360+
uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
361+
client=client,
362+
body=body_data
363+
)
364+
365+
print(response)
366+
```
367+
368+
369+
1. **Model Source:** [`GroupInvitationUpdateRequest`](https://github.com/waldur/py-client/blob/main/waldur_api_client/models/group_invitation_update_request.py)
370+
2. **API Source:** [`user_group_invitations_update`](https://github.com/waldur/py-client/blob/main/waldur_api_client/api/user_group_invitations/user_group_invitations_update.py)
371+
372+
=== "TypeScript"
373+
374+
```typescript
375+
import { userGroupInvitationsUpdate } from 'waldur-js-client';
376+
377+
try {
378+
const response = await userGroupInvitationsUpdate({
379+
auth: "Token YOUR_API_TOKEN",
380+
path: {
381+
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
382+
}
383+
});
384+
console.log('Success:', response);
385+
} catch (error) {
386+
console.error('Error:', error);
387+
}
388+
```
389+
390+
391+
=== "Path Parameters"
392+
393+
| Name | Type | Required |
394+
|---|---|---|
395+
| `uuid` | string (uuid) | ✓ |
396+
397+
398+
=== "Request Body"
399+
400+
| Field | Type | Required | Description |
401+
|---|---|---|---|
402+
| `is_public` | boolean | | Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations. |
403+
| `role` | string (uuid) | | UUID of the role to grant. |
404+
| `scope` | string | | URL of the scope (Customer or Project) for this invitation |
405+
| `auto_create_project` | boolean | | Create project and grant project permissions instead of customer permissions |
406+
| `auto_approve` | boolean | | Automatically approve permission requests from users matching email patterns or affiliations |
407+
| `project_name_template` | string | | Template for project name. Supports {username}, {email}, {full_name} variables |
408+
| `project_role` | string (uuid) | | UUID of the project role to grant if auto_create_project is enabled |
409+
| `user_affiliations` | any | | |
410+
| `user_email_patterns` | any | | |
411+
| `user_identity_sources` | any | | List of allowed identity sources (identity providers). |
412+
| `custom_text` | string | | Custom description text displayed to users viewing this invitation. |
413+
414+
415+
=== "Responses"
416+
417+
**`200`** -
418+
419+
| Field | Type | Description |
420+
|---|---|---|
421+
| `is_public` | boolean | Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations. |
422+
| `role` | string (uuid) | UUID of the role to grant. |
423+
| `scope` | string | URL of the scope (Customer or Project) for this invitation |
424+
| `auto_create_project` | boolean | Create project and grant project permissions instead of customer permissions |
425+
| `auto_approve` | boolean | Automatically approve permission requests from users matching email patterns or affiliations |
426+
| `project_name_template` | string | Template for project name. Supports {username}, {email}, {full_name} variables |
427+
| `project_role` | string (uuid) | UUID of the project role to grant if auto_create_project is enabled |
428+
| `user_affiliations` | any | |
429+
| `user_email_patterns` | any | |
430+
| `user_identity_sources` | any | List of allowed identity sources (identity providers). |
431+
| `custom_text` | string | Custom description text displayed to users viewing this invitation. |
432+
433+
---
434+
435+
### Partially update a group invitation
436+
437+
Partially update an active group invitation. Only active invitations can be edited.
438+
439+
440+
=== "HTTPie"
441+
442+
```bash
443+
http \
444+
PATCH \
445+
https://api.example.com/api/user-group-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
446+
Authorization:"Token YOUR_API_TOKEN"
447+
```
448+
449+
=== "Python"
450+
451+
```python
452+
from waldur_api_client.client import AuthenticatedClient
453+
from waldur_api_client.models.patched_group_invitation_update_request import PatchedGroupInvitationUpdateRequest # (1)
454+
from waldur_api_client.api.user_group_invitations import user_group_invitations_partial_update # (2)
455+
456+
client = AuthenticatedClient(
457+
base_url="https://api.example.com", token="YOUR_API_TOKEN"
458+
)
459+
460+
body_data = PatchedGroupInvitationUpdateRequest()
461+
response = user_group_invitations_partial_update.sync(
462+
uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
463+
client=client,
464+
body=body_data
465+
)
466+
467+
print(response)
468+
```
469+
470+
471+
1. **Model Source:** [`PatchedGroupInvitationUpdateRequest`](https://github.com/waldur/py-client/blob/main/waldur_api_client/models/patched_group_invitation_update_request.py)
472+
2. **API Source:** [`user_group_invitations_partial_update`](https://github.com/waldur/py-client/blob/main/waldur_api_client/api/user_group_invitations/user_group_invitations_partial_update.py)
473+
474+
=== "TypeScript"
475+
476+
```typescript
477+
import { userGroupInvitationsPartialUpdate } from 'waldur-js-client';
478+
479+
try {
480+
const response = await userGroupInvitationsPartialUpdate({
481+
auth: "Token YOUR_API_TOKEN",
482+
path: {
483+
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
484+
}
485+
});
486+
console.log('Success:', response);
487+
} catch (error) {
488+
console.error('Error:', error);
489+
}
490+
```
491+
492+
493+
=== "Path Parameters"
494+
495+
| Name | Type | Required |
496+
|---|---|---|
497+
| `uuid` | string (uuid) | ✓ |
498+
499+
500+
=== "Request Body"
501+
502+
| Field | Type | Required | Description |
503+
|---|---|---|---|
504+
| `is_public` | boolean | | Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations. |
505+
| `role` | string (uuid) | | UUID of the role to grant. |
506+
| `scope` | string | | URL of the scope (Customer or Project) for this invitation |
507+
| `auto_create_project` | boolean | | Create project and grant project permissions instead of customer permissions |
508+
| `auto_approve` | boolean | | Automatically approve permission requests from users matching email patterns or affiliations |
509+
| `project_name_template` | string | | Template for project name. Supports {username}, {email}, {full_name} variables |
510+
| `project_role` | string (uuid) | | UUID of the project role to grant if auto_create_project is enabled |
511+
| `user_affiliations` | any | | |
512+
| `user_email_patterns` | any | | |
513+
| `user_identity_sources` | any | | List of allowed identity sources (identity providers). |
514+
| `custom_text` | string | | Custom description text displayed to users viewing this invitation. |
515+
516+
517+
=== "Responses"
518+
519+
**`200`** -
520+
521+
| Field | Type | Description |
522+
|---|---|---|
523+
| `is_public` | boolean | Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations. |
524+
| `role` | string (uuid) | UUID of the role to grant. |
525+
| `scope` | string | URL of the scope (Customer or Project) for this invitation |
526+
| `auto_create_project` | boolean | Create project and grant project permissions instead of customer permissions |
527+
| `auto_approve` | boolean | Automatically approve permission requests from users matching email patterns or affiliations |
528+
| `project_name_template` | string | Template for project name. Supports {username}, {email}, {full_name} variables |
529+
| `project_role` | string (uuid) | UUID of the project role to grant if auto_create_project is enabled |
530+
| `user_affiliations` | any | |
531+
| `user_email_patterns` | any | |
532+
| `user_identity_sources` | any | List of allowed identity sources (identity providers). |
533+
| `custom_text` | string | Custom description text displayed to users viewing this invitation. |
324534

325535
---
326536

‎docs/core/structure/users.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,7 @@ A User object on its own has limited capabilities beyond logging in and managing
192192
| `nationalities` | any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
193193
| `organization_country` | string | |
194194
| `organization_type` | string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
195+
| `organization_registry_code` | string | Company registration code of the user's organization, if known |
195196
| `eduperson_assurance` | any | REFEDS assurance profile URIs from identity provider |
196197

197198
---
@@ -327,6 +328,7 @@ A User object on its own has limited capabilities beyond logging in and managing
327328
| `nationalities` | any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
328329
| `organization_country` | string | |
329330
| `organization_type` | string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
331+
| `organization_registry_code` | string | Company registration code of the user's organization, if known |
330332
| `eduperson_assurance` | any | REFEDS assurance profile URIs from identity provider |
331333

332334
---
@@ -423,6 +425,7 @@ A User object on its own has limited capabilities beyond logging in and managing
423425
| `nationalities` | any | | List of all citizenships (ISO 3166-1 alpha-2 codes) |
424426
| `organization_country` | string | | |
425427
| `organization_type` | string | | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
428+
| `organization_registry_code` | string | | Company registration code of the user's organization, if known |
426429
| `eduperson_assurance` | any | | REFEDS assurance profile URIs from identity provider |
427430

428431

@@ -492,6 +495,7 @@ A User object on its own has limited capabilities beyond logging in and managing
492495
| `nationalities` | any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
493496
| `organization_country` | string | |
494497
| `organization_type` | string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
498+
| `organization_registry_code` | string | Company registration code of the user's organization, if known |
495499
| `eduperson_assurance` | any | REFEDS assurance profile URIs from identity provider |
496500

497501
---
@@ -748,6 +752,7 @@ Staff-only action to trigger recalculation of user actions for a specific user.
748752
| `nationalities` | any | | List of all citizenships (ISO 3166-1 alpha-2 codes) |
749753
| `organization_country` | string | | |
750754
| `organization_type` | string | | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
755+
| `organization_registry_code` | string | | Company registration code of the user's organization, if known |
751756
| `eduperson_assurance` | any | | REFEDS assurance profile URIs from identity provider |
752757

753758

@@ -817,6 +822,7 @@ Staff-only action to trigger recalculation of user actions for a specific user.
817822
| `nationalities` | any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
818823
| `organization_country` | string | |
819824
| `organization_type` | string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
825+
| `organization_registry_code` | string | Company registration code of the user's organization, if known |
820826
| `eduperson_assurance` | any | REFEDS assurance profile URIs from identity provider |
821827

822828
---
@@ -914,6 +920,7 @@ Staff-only action to trigger recalculation of user actions for a specific user.
914920
| `nationalities` | any | | List of all citizenships (ISO 3166-1 alpha-2 codes) |
915921
| `organization_country` | string | | |
916922
| `organization_type` | string | | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
923+
| `organization_registry_code` | string | | Company registration code of the user's organization, if known |
917924
| `eduperson_assurance` | any | | REFEDS assurance profile URIs from identity provider |
918925

919926

@@ -983,6 +990,7 @@ Staff-only action to trigger recalculation of user actions for a specific user.
983990
| `nationalities` | any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
984991
| `organization_country` | string | |
985992
| `organization_type` | string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
993+
| `organization_registry_code` | string | Company registration code of the user's organization, if known |
986994
| `eduperson_assurance` | any | REFEDS assurance profile URIs from identity provider |
987995

988996
---
@@ -1604,6 +1612,7 @@ Get current user details, including authentication token and profile completenes
16041612
| `nationalities` | any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
16051613
| `organization_country` | string | |
16061614
| `organization_type` | string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
1615+
| `organization_registry_code` | string | Company registration code of the user's organization, if known |
16071616
| `eduperson_assurance` | any | REFEDS assurance profile URIs from identity provider |
16081617

16091618
---

‎docs/marketplace/provider-api/provider-offerings.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1961,6 +1961,7 @@ Returns a paginated list of users who have access to resources of this offering.
19611961
| `nationalities` | any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
19621962
| `organization_country` | string | |
19631963
| `organization_type` | string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
1964+
| `organization_registry_code` | string | Company registration code of the user's organization, if known |
19641965
| `eduperson_assurance` | any | REFEDS assurance profile URIs from identity provider |
19651966

19661967
---

0 commit comments

Comments
 (0)