Interface AccessProfileRequest._FinalStage
- All Known Implementing Classes:
AccessProfileRequest.Builder
- Enclosing class:
AccessProfileRequest
-
Method Summary
Modifier and TypeMethodDescriptionadditionalProperties(Map<String, Object> additionalProperties) additionalProperty(String key, Object value) build()identityOverrides(Map<String, Object> identityOverrides) identityOverrides(Optional<Map<String, Object>> identityOverrides) Optional per-context identity overrides, keyed by ownership namespace inscope:<namespace>form —scope:organdscope:clientfor the reserved namespaces, or any namespace you have registered (for examplescope:group).Reference to a role within the same context that supplies this principal's scopes.scopes(List<ScopeClause> scopes) scopes(Optional<List<ScopeClause>> scopes) Inline scope clauses to grant the principal.status(AccessProfileRequestStatus status) status(Optional<AccessProfileRequestStatus> status) Profile lifecycle status.
-
Method Details
-
build
AccessProfileRequest build() -
additionalProperty
-
additionalProperties
-
scopes
Inline scope clauses to grant the principal. Provide exactly one of
scopesorroleId— setting both, or neither, returns a 400. -
scopes
-
roleId
Reference to a role within the same context that supplies this principal's scopes. Provide exactly one of
scopesorroleId— setting both, or neither, returns a 400. Changes to the role's scopes take effect for all referencing profiles. -
roleId
-
identityOverrides
Optional per-context identity overrides, keyed by ownership namespace in
scope:<namespace>form —scope:organdscope:clientfor the reserved namespaces, or any namespace you have registered (for examplescope:group). At most two namespaces may be overridden; any other key is rejected. Each value is 1-128 characters: a letter or digit first, then letters, digits,_or-. Omitting the field leaves any existing overrides unchanged; sending an empty map clears them, and sending a populated map replaces them wholesale — a namespace absent from the map you send is removed. If you use a scoped credential, two bounds apply and either returns 403: you may only set a value your own identity holds, and you may only change or clear a value the profile already holds if that value is yours as well — so clearing or repointing another principal's established identity is refused. A root API key (sk_) is exempt from both. -
identityOverrides
-
status
Profile lifecycle status.
activepermits token minting;suspendeddenies it (minting returns a uniform 403). Defaults toactivewhen omitted. -
status
-