Class RoleResponse.Builder
- Enclosing class:
RoleResponse
-
Method Summary
Modifier and TypeMethodDescriptionadditionalProperties(Map<String, Object> additionalProperties) additionalProperty(String key, Object value) Which values, perscope:<namespace>, a holder of this role may assume viaPOST /v1/auth/token/assume.build()The ID of the app context this role belongs to.Whether this call created a new role.When the role was created, as an ISO-8601 UTC timestamp.description(String description) description(Optional<String> description) An optional free-text description of what the role grants.from(RoleResponse other) The role's globally unique identifier, composed from your account, the app context, and the role ID.lastModified(String lastModified) lastModified(Optional<String> lastModified) When the role was last modified, as an ISO-8601 UTC timestamp.A human-readable display name for the role.Your own identifier for this role within the app context.scopes(List<ScopeClause> scopes) scopes(Optional<List<ScopeClause>> scopes) The role's permissions, expressed as one or more scope clauses.
-
Method Details
-
from
-
created
Whether this call created a new role. True when a new role was created; false when a role with the same
roleIdalready existed and was returned unchanged (idempotent create) or updated (when?upsert=true). Present only on the create response (POST /v1/app-contexts/{contextId}/roles); absent on reads. The HTTP status mirrors it — 201 when created, 200 when an existing role was returned. -
created
-
id
The role's globally unique identifier, composed from your account, the app context, and the role ID. Pass this value as the pagination cursor to fetch the next page.
-
id
-
contextId
The ID of the app context this role belongs to.
-
contextId
-
roleId
Your own identifier for this role within the app context.
-
roleId
-
name
A human-readable display name for the role.
-
name
-
description
An optional free-text description of what the role grants.
-
description
-
scopes
The role's permissions, expressed as one or more scope clauses. An action is permitted if any clause allows it and that clause's data scope matches the target — with two exceptions. An identity entity's own-namespace dimension when creating it is server-assigned and therefore exempt from the match at creation time only; and a clause naming a
granted_capabilitiesentry this release does not recognize is denied entirely, so none of its actions apply. -
scopes
-
assumable
Which values, per
scope:<namespace>, a holder of this role may assume viaPOST /v1/auth/token/assume. Absent when the role grants no assumption of anything (the common case). -
assumable
-
createdAt
When the role was created, as an ISO-8601 UTC timestamp.
-
createdAt
-
lastModified
When the role was last modified, as an ISO-8601 UTC timestamp.
-
lastModified
-
build
-
additionalProperty
-
additionalProperties
-