Interface NamespaceRequest._FinalStage
- All Known Implementing Classes:
NamespaceRequest.Builder
- Enclosing class:
NamespaceRequest
-
Method Summary
Modifier and TypeMethodDescriptionadditionalProperties(Map<String, Object> additionalProperties) additionalProperty(String key, Object value) build()defaultSchemaId(String defaultSchemaId) defaultSchemaId(Optional<String> defaultSchemaId) Optional ID of a record schema (created viaPOST /v1/schemas) bound as the default governing schema for entities created in this namespace.entityBacked(Boolean entityBacked) entityBacked(Optional<Boolean> entityBacked) Whentrue, everyscope:<namespace>value in this namespace must resolve to an existing identity entity of the same account and namespace (create entities viaPOST /v1/entities/{namespace}), and the namespace gains the full identity-entity surface — list its entities, look them up by schema field, and filter other resources by them as a parent.membershipContextId(String membershipContextId) membershipContextId(Optional<String> membershipContextId) Optional.membershipLevelField(String membershipLevelField) membershipLevelField(Optional<String> membershipLevelField) Optional.membershipLevels(List<String> membershipLevels) membershipLevels(Optional<List<String>> membershipLevels) Optional.membershipRecordType(String membershipRecordType) membershipRecordType(Optional<String> membershipRecordType) Optional.membershipTargetField(String membershipTargetField) membershipTargetField(Optional<String> membershipTargetField) Optional.
-
Method Details
-
build
NamespaceRequest build() -
additionalProperty
-
additionalProperties
-
entityBacked
When
true, everyscope:<namespace>value in this namespace must resolve to an existing identity entity of the same account and namespace (create entities viaPOST /v1/entities/{namespace}), and the namespace gains the full identity-entity surface — list its entities, look them up by schema field, and filter other resources by them as a parent. Whenfalse(the default), values in this namespace are free-form strings validated by grammar only. -
entityBacked
-
defaultSchemaId
Optional ID of a record schema (created via
POST /v1/schemas) bound as the default governing schema for entities created in this namespace. Must belong to your account. -
defaultSchemaId
-
membershipRecordType
Optional. The record type holding this namespace's MEMBERSHIP grants — the records that say which values of this namespace a given user belongs to. Supply it together with
membershipTargetFieldandmembershipContextId, or omit all three. Declaring it grants nobody anything on its own: a credential receives membership-derived access only if its own role or access profile asks for it by naming${{ member.scope.<namespace> }}indata_scope. -
membershipRecordType
-
membershipTargetField
Optional. The field on
membershipRecordTypenaming the user a grant is FOR. It is an ordinary reference field, not an ownership field — the grant is owned by whoever created it, and the namespace value it applies to is the grant's own scope stamp, which is what your placement authority is checked against when you write it. -
membershipTargetField
-
membershipContextId
Optional. Which app context holds the membership records. Required alongside the other membership fields on a TENANT-WIDE registration (records always belong to one app context, while a tenant-wide registration is account-wide). Meaningless — and rejected if it disagrees — on a registration owned by one context via
?contextId=: that context's grants live in its own context by construction, so this field need not repeat it. -
membershipContextId
-
membershipLevelField
Optional. The field on
membershipRecordTypenaming a grant's LEVEL, so the same user can hold different levels in different values of this namespace — an admin of one team and a viewer of another. Supply it together withmembershipLevels, or omit both for plain in-or-out membership. A role selects a level by naming${{ member.scope.<namespace>:<level> }}. Because the level is an ordinary field on an ordinary record, it is only as trustworthy as who may write that record type: grant create/update/delete onmembershipRecordTypeto the people who ISSUE grants, never to the members those grants govern — a member who can update their own grant row can raise their own level, and it takes effect on their next request. -
membershipLevelField
-
membershipLevels
Optional. The complete set of level labels this namespace allows, each following the namespace grammar. A role naming a level that is not in this list is rejected when it is authored, rather than silently matching nothing — so a typo is reported to whoever can fix it. Required alongside
membershipLevelField. -
membershipLevels
-