Package ai.vectros.types

Class RoleResponse

java.lang.Object
ai.vectros.types.RoleResponse
public final class RoleResponse extends Object

  • Method Details

    • getCreated

      public Optional<Boolean> getCreated()
      Returns:
      Whether this call created a new role. True when a new role was created; false when a role with the same roleId already 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.

    • getId

      public Optional<String> getId()
      Returns:
      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.

    • getContextId

      public Optional<String> getContextId()
      Returns:
      The ID of the app context this role belongs to.

    • getRoleId

      public Optional<String> getRoleId()
      Returns:
      Your own identifier for this role within the app context.

    • getName

      public Optional<String> getName()
      Returns:
      A human-readable display name for the role.

    • getDescription

      public Optional<String> getDescription()
      Returns:
      An optional free-text description of what the role grants.

    • getScopes

      public Optional<List<ScopeClause>> getScopes()
      Returns:
      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_capabilities entry this release does not recognize is denied entirely, so none of its actions apply.

    • getAssumable

      public Optional<Map<String,Object>> getAssumable()
      Returns:
      Which values, per scope:<namespace>, a holder of this role may assume via POST /v1/auth/token/assume. Absent when the role grants no assumption of anything (the common case).

    • getCreatedAt

      public Optional<String> getCreatedAt()
      Returns:
      When the role was created, as an ISO-8601 UTC timestamp.

    • getLastModified

      public Optional<String> getLastModified()
      Returns:
      When the role was last modified, as an ISO-8601 UTC timestamp.

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static RoleResponse.Builder builder()