Enum Class Scope

java.lang.Object
java.lang.Enum<Scope>
nl.bimbase.bimworks.client.Scope
All Implemented Interfaces:
Serializable, Comparable<Scope>, Constable
public enum Scope extends Enum<Scope>
The authorization scope catalog (docs/api-authorization-scopes-design.md §4.3), mirrored from the server enum — the same duplication pattern as ApiTokenCredential. The wire strings ("fs:read") are what travels; a consistency test keeps this enum, the server enum, the OpenAPI Scope schema and the JS SDK Scopes constant in lockstep.

  • Enum Constant Details

    • FS_READ

      public static final Scope FS_READ

    • FS_WRITE

      public static final Scope FS_WRITE

    • MODEL_READ

      public static final Scope MODEL_READ

    • MODEL_WRITE

      public static final Scope MODEL_WRITE

    • MODEL_UPLOAD

      public static final Scope MODEL_UPLOAD

    • GEOMETRY_READ

      public static final Scope GEOMETRY_READ

    • QUERY_RUN

      public static final Scope QUERY_RUN

    • GIS_READ

      public static final Scope GIS_READ

    • GIS_WRITE

      public static final Scope GIS_WRITE

    • CHECKS_READ

      public static final Scope CHECKS_READ

    • CHECKS_RUN

      public static final Scope CHECKS_RUN

    • CHECKS_WRITE

      public static final Scope CHECKS_WRITE

    • CHECKS_JAVA

      public static final Scope CHECKS_JAVA

    • ACTIONS_READ

      public static final Scope ACTIONS_READ

    • ACTIONS_WRITE

      public static final Scope ACTIONS_WRITE

    • COLLAB_READ

      public static final Scope COLLAB_READ

    • COLLAB_WRITE

      public static final Scope COLLAB_WRITE

    • WORKSPACES_READ

      public static final Scope WORKSPACES_READ

    • WORKSPACES_WRITE

      public static final Scope WORKSPACES_WRITE

    • AI_USE

      public static final Scope AI_USE

    • BSDD_READ

      public static final Scope BSDD_READ

    • BSDD_SYNC

      public static final Scope BSDD_SYNC

    • TOKENS_ISSUE

      public static final Scope TOKENS_ISSUE

    • ACCOUNT_READ

      public static final Scope ACCOUNT_READ

    • ACCOUNT_WRITE

      public static final Scope ACCOUNT_WRITE

    • ADMIN_READ

      public static final Scope ADMIN_READ

    • ADMIN_WRITE

      public static final Scope ADMIN_WRITE

    • SUPERADMIN

      public static final Scope SUPERADMIN

    • ALL

      public static final Scope ALL

  • Method Details

    • values

      public static Scope[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Scope valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • toWire

      public String toWire()
      The wire form, e.g. "fs:read".