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
"""Set the RBAC Policy for a specific Organization within your Stytch Project. An Organization RBAC Policy allows you to define roles that are specific to that organization, providing fine-grained control over permissions at the organization level.
90
+
91
+
This endpoint allows you to create, update, or replace the organization-scoped roles for a given organization. Organization policies supplement the project-level RBAC policy with additional roles that are only applicable within the context of that specific organization.
92
+
93
+
The organization policy consists of roles, where each role defines:
94
+
- A unique `role_id` to identify the role
95
+
- A human-readable `description` of the role's purpose
96
+
- A set of `permissions` that specify which actions can be performed on which resources
97
+
98
+
When you set an organization policy, it will replace any existing organization-specific roles for that organization. The project-level RBAC policy remains unchanged.
99
+
100
+
Organization-specific roles are useful for scenarios where different organizations within your project require different permission structures, such as:
101
+
- Multi-tenant applications with varying access levels per tenant
102
+
- Organizations with custom approval workflows
103
+
- Different organizational hierarchies requiring unique role definitions
104
+
105
+
Check out the [RBAC overview](https://stytch.com/docs/b2b/guides/rbac/overview) to learn more about Stytch's RBAC permissioning model and organization-scoped policies.
106
+
107
+
Fields:
108
+
- organization_id: Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
109
+
- org_policy: The organization-specific RBAC Policy that contains roles defined for this organization. Organization policies supplement the project-level RBAC policy with additional roles that are specific to the organization.
"""Set the RBAC Policy for a specific Organization within your Stytch Project. An Organization RBAC Policy allows you to define roles that are specific to that organization, providing fine-grained control over permissions at the organization level.
132
+
133
+
This endpoint allows you to create, update, or replace the organization-scoped roles for a given organization. Organization policies supplement the project-level RBAC policy with additional roles that are only applicable within the context of that specific organization.
134
+
135
+
The organization policy consists of roles, where each role defines:
136
+
- A unique `role_id` to identify the role
137
+
- A human-readable `description` of the role's purpose
138
+
- A set of `permissions` that specify which actions can be performed on which resources
139
+
140
+
When you set an organization policy, it will replace any existing organization-specific roles for that organization. The project-level RBAC policy remains unchanged.
141
+
142
+
Organization-specific roles are useful for scenarios where different organizations within your project require different permission structures, such as:
143
+
- Multi-tenant applications with varying access levels per tenant
144
+
- Organizations with custom approval workflows
145
+
- Different organizational hierarchies requiring unique role definitions
146
+
147
+
Check out the [RBAC overview](https://stytch.com/docs/b2b/guides/rbac/overview) to learn more about Stytch's RBAC permissioning model and organization-scoped policies.
148
+
149
+
Fields:
150
+
- organization_id: Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
151
+
- org_policy: The organization-specific RBAC Policy that contains roles defined for this organization. Organization policies supplement the project-level RBAC policy with additional roles that are specific to the organization.
Copy file name to clipboardExpand all lines: stytch/b2b/models/rbac_organizations.py
+5Lines changed: 5 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -22,4 +22,9 @@ class GetOrgPolicyResponse(ResponseBase):
22
22
23
23
24
24
classSetOrgPolicyResponse(ResponseBase):
25
+
"""Response type for `Organizations.set_org_policy`.
26
+
Fields:
27
+
- org_policy: The organization-specific RBAC Policy that contains roles defined for this organization. Organization policies supplement the project-level RBAC policy with additional roles that are specific to the organization.
"""Search for Connected Apps. Supports cursor-based pagination. Specific filters coming soon.
235
237
236
238
Fields:
237
239
- cursor: The `cursor` field allows you to paginate through your results. Each result array is limited to 1000 results. If your query returns more than 1000 results, you will need to paginate the responses using the `cursor`. If you receive a response that includes a non-null `next_cursor` in the `results_metadata` object, repeat the search call with the `next_cursor` value set to the `cursor` field to retrieve the next page of results. Continue to make search calls until the `next_cursor` in the response is null.
238
240
- limit: The number of search results to return per page. The default limit is 100. A maximum of 1000 results can be returned by a single search request. If the total size of your result set is greater than one page size, you must paginate the response. See the `cursor` field.
"""Search for Connected Apps. Supports cursor-based pagination. Specific filters coming soon.
257
263
258
264
Fields:
259
265
- cursor: The `cursor` field allows you to paginate through your results. Each result array is limited to 1000 results. If your query returns more than 1000 results, you will need to paginate the responses using the `cursor`. If you receive a response that includes a non-null `next_cursor` in the `results_metadata` object, repeat the search call with the `next_cursor` value set to the `cursor` field to retrieve the next page of results. Continue to make search calls until the `next_cursor` in the response is null.
260
266
- limit: The number of search results to return per page. The default limit is 100. A maximum of 1000 results can be returned by a single search request. If the total size of your result set is greater than one page size, you must paginate the response. See the `cursor` field.
"""Initiate the authentication of a Passkey or WebAuthn registration.
260
261
@@ -269,6 +270,7 @@ def authenticate_start(
269
270
- user_id: The `user_id` of an active user the Passkey or WebAuthn registration should be tied to. You may use an `external_id` here if one is set for the user.
270
271
- return_passkey_credential_options: If true, the `public_key_credential_creation_options` returned will be optimized for Passkeys with `userVerification` set to `"preferred"`.
- user_id: The `user_id` of an active user the Passkey or WebAuthn registration should be tied to. You may use an `external_id` here if one is set for the user.
305
310
- return_passkey_credential_options: If true, the `public_key_credential_creation_options` returned will be optimized for Passkeys with `userVerification` set to `"preferred"`.
0 commit comments