You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!-- Use absolute links, to support this link working from PyPI-->
44
+
42
45
*[Authorize using a user token](https://github.com/Authress/authress-sdk.py/blob/main/docs/EXAMPLES.md#authorize-using-a-user-token)
43
46
*[Authorize with a service client](https://github.com/Authress/authress-sdk.py/blob/main/docs/EXAMPLES.md#authorize-with-a-service-client)
44
47
*[Using the Authress service client as an API key](https://github.com/Authress/authress-sdk.py/blob/main/docs/EXAMPLES.md#using-the-authress-service-client-as-an-api-key)
@@ -47,4 +50,6 @@ See the SDK reference guide for a examples of commonly executed blocks with desc
47
50
48
51
## Contribution Guide
49
52
53
+
<!-- Use absolute links, to support this link working from PyPI-->
54
+
50
55
[Developing for the Python SDK](https://github.com/Authress/authress-sdk.py/blob/main/contributing.md)
Copy file name to clipboardexpand all lines: authress/models/invite.py
+37-3
Original file line number
Diff line number
Diff line change
@@ -31,11 +31,13 @@ class Invite(BaseModel):
31
31
"""
32
32
The user invite used to invite users to your application or to Authress as an admin. # noqa: E501
33
33
"""
34
-
invite_id: Optional[StrictStr] =Field(default=None, alias="inviteId", description="The unique identifier for the invite. Use this ID to accept the invite. This parameter is ignored during invite creation.")
invite_id: StrictStr=Field(default=..., alias="inviteId", description="The unique identifier for the invite. Use this ID to accept the invite. This parameter is ignored during invite creation.")
35
+
tenant_id: Optional[constr(strict=True, max_length=128, min_length=0)] =Field(default=None, alias="tenantId", description="DEPRECATED: Use default_login_tenant_id instead.")
36
+
default_login_tenant_id: Optional[constr(strict=True, max_length=128, min_length=0)] =Field(default=None, alias="defaultLoginTenantId", description="Specify the tenant associated with the invite. This tenant Id is used to automatically select the tenant during login with Authress when using the @authress/login SDK. This parameter is ignored when accepting invites directly. To explicitly add a user to a tenant use the linkTenantUser API endpoint.")
36
37
statements: conlist(InviteStatement, max_items=100, min_items=0) =Field(default=..., description="A list of statements which match roles to resources. The invited user will all statements apply to them when the invite is accepted.")
38
+
conflict_resolution_strategy: Optional[StrictStr] =Field(default='GENERATE_NEW_RECORD', alias="conflictResolutionStrategy", description="An access record will be created when the invite is accepted. If the access record already exists, and the statements in this invite can be merged safely, then the existing record will be updated. A safe merge is one in which the current user will only gain additional access to the statements defined in the invite and other users will not gain additional access in any scenario. When this cannot be done safely, Authress will fallback to this parameter.<br> <ul> <li><code>GENERATE_NEW_RECORD</code> - (Default) Create a new access record which matches the statements in this invite. The record ID will be randomly generated and is unpredictable.</li> <li><code>UNSAFE_FORCE_MERGE</code> - Add the user and statements to the existing record. This will cause the user to gain all the permissions already defined in that record and will cause all the users currently in that record to gain all the additional permissions defined in the invite.</li> <li><code>REPLACE_RECORD_DATA</code> - Replace the existing access record users, roles, and resources with those specified in this invite.</li> <li><code>SKIP_CHANGES</code> - Do not replace, do not create, do not throw. Optimal for ensuring that all records have a known management strategy and successful invite acceptance is more important than the granted permissions.</li> </ul>")
0 commit comments