|
26 | 26 |
|
27 | 27 |
|
28 | 28 | class PolicySchemasResource(SyncAPIResource): |
29 | | - """Zone-scoped Cedar schema management""" |
| 29 | + """Zone-scoped Cedar schema management. |
| 30 | +
|
| 31 | + The Cedar schema defines the entity model used for authorization decisions. |
| 32 | + Key entity types and their attributes: |
| 33 | +
|
| 34 | + - **Keycard::User** — `email` (String), `groups` (Set of String) |
| 35 | + - **Keycard::Application** — `registration_method` (RegistrationMethod entity), `credential_type` (CredentialType entity) |
| 36 | + - **Keycard::RegistrationMethod** — enum entity: `"managed"`, `"dcr"` |
| 37 | + - **Keycard::CredentialType** — enum entity: `"token"`, `"password"`, `"public-key"`, `"url"`, `"public"` |
| 38 | + - **Keycard::Resource** — `id` (String), `name` (String), `scopes` (Set of String) |
| 39 | + - **Keycard::Claims** — `email` (String), `groups` (Set of String), plus arbitrary additional fields |
| 40 | +
|
| 41 | + Enum-like attributes use Cedar enum entity types (schema version `2026-03-16`+). |
| 42 | + In policies, reference values as `RegistrationMethod::"managed"` or `CredentialType::"token"`. |
| 43 | + See the Credentials API spec for the full entity model reference. |
| 44 | + """ |
30 | 45 |
|
31 | 46 | @cached_property |
32 | 47 | def with_raw_response(self) -> PolicySchemasResourceWithRawResponse: |
@@ -243,7 +258,22 @@ def set_default( |
243 | 258 |
|
244 | 259 |
|
245 | 260 | class AsyncPolicySchemasResource(AsyncAPIResource): |
246 | | - """Zone-scoped Cedar schema management""" |
| 261 | + """Zone-scoped Cedar schema management. |
| 262 | +
|
| 263 | + The Cedar schema defines the entity model used for authorization decisions. |
| 264 | + Key entity types and their attributes: |
| 265 | +
|
| 266 | + - **Keycard::User** — `email` (String), `groups` (Set of String) |
| 267 | + - **Keycard::Application** — `registration_method` (RegistrationMethod entity), `credential_type` (CredentialType entity) |
| 268 | + - **Keycard::RegistrationMethod** — enum entity: `"managed"`, `"dcr"` |
| 269 | + - **Keycard::CredentialType** — enum entity: `"token"`, `"password"`, `"public-key"`, `"url"`, `"public"` |
| 270 | + - **Keycard::Resource** — `id` (String), `name` (String), `scopes` (Set of String) |
| 271 | + - **Keycard::Claims** — `email` (String), `groups` (Set of String), plus arbitrary additional fields |
| 272 | +
|
| 273 | + Enum-like attributes use Cedar enum entity types (schema version `2026-03-16`+). |
| 274 | + In policies, reference values as `RegistrationMethod::"managed"` or `CredentialType::"token"`. |
| 275 | + See the Credentials API spec for the full entity model reference. |
| 276 | + """ |
247 | 277 |
|
248 | 278 | @cached_property |
249 | 279 | def with_raw_response(self) -> AsyncPolicySchemasResourceWithRawResponse: |
|
0 commit comments