Package ai.vectros.types

Class AccessProfileResponse

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

  • Method Details

    • getCreated

      public Optional<Boolean> getCreated()
      Returns:
      Whether this call created a new access profile. True when a new profile was created; false when a profile with the same principalId already existed and was returned unchanged (idempotent create) or updated (when ?upsert=true). Present only on the create response (POST /v1/app-contexts/{contextId}/profiles); absent on reads. The HTTP status mirrors it — 201 when created, 200 when an existing profile was returned.

    • getId

      public Optional<String> getId()
      Returns:
      Opaque identifier for this profile. Also serves as the pagination cursor.

    • getContextId

      public Optional<String> getContextId()
      Returns:
      The app context this profile belongs to.

    • getPrincipalId

      public Optional<String> getPrincipalId()
      Returns:
      Principal this profile applies to — usr_<userId> for a user, or key_<keyId> for a scoped API key acting as its own principal.

    • getScopes

      public Optional<List<ScopeClause>> getScopes()
      Returns:
      Inline scope clauses granted to the principal. Mutually exclusive with roleIds — exactly one of the two is present.

    • getRoleIds

      public Optional<List<String>> getRoleIds()
      Returns:
      The roles that together supply this principal's scopes, in composition order — the effective grant is each role's own clauses concatenated. Mutually exclusive with scopes: exactly one of the two is present.

    • getRoleId

      public Optional<String> getRoleId()
      Returns:
      Deprecated single-role view of roleIds, present only when exactly one role composes. A profile composing two or more roles omits this field entirely — read roleIds, which is always present for a role-referencing profile.

    • getIdentityOverrides

      public Optional<Map<String,Object>> getIdentityOverrides()
      Returns:
      Per-context identity overrides, keyed by ownership namespace in scope:<namespace> form (for example scope:org, scope:client, scope:group). Read back exactly as authored.

    • getAssumable

      public Optional<Map<String,Object>> getAssumable()
      Returns:
      Which values, per scope:<namespace>, a holder of this profile may assume via POST /v1/auth/token/assume. Only meaningful when scopes (not roleId) is set — see assumable's own request-field doc. Absent when the profile grants no assumption of anything (the common case, and always the case for a role-referencing profile — the grant lives on the Role instead).

    • getStatus

      public Optional<String> getStatus()
      Returns:
      Profile lifecycle status: active or suspended.

    • getCreatedAt

      public Optional<String> getCreatedAt()
      Returns:
      When the profile was created (ISO-8601 UTC).

    • getLastModified

      public Optional<String> getLastModified()
      Returns:
      When the profile was last modified (ISO-8601 UTC).

    • getEmail

      public Optional<String> getEmail()
      Returns:
      The principal's email, when resolvable. Set only for a usr_ principal with a matching user record in your tenant; null for a key_ principal (a scoped API key has no email), a usr_ principal that could not be resolved (for example, the user was deleted), or when your token lacks the users:r scope in addition to this endpoint's own scope (email is user data, gated the same as GET /v1/users).

    • 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 AccessProfileResponse.Builder builder()