Package org.gitlab4j.models

Enum Constants.ApplicationScope

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ADMIN_MODE
      Grants permission to perform API actions as an administrator, when Admin Mode is enabled.
      AI_FEATURES
      Grants access to GitLab Duo related API endpoints.
      API
      Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
      CREATE_RUNNER
      Grants create access to the runners.
      EMAIL
      Grants read-only access to the user's primary email address using OpenID Connect.
      K8S_PROXY
      Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
      MANAGE_RUNNER
      Grants access to manage the runners.
      OPENID
      Grants permission to authenticate with GitLab using OpenID Connect.
      PROFILE
      Grants read-only access to the user's profile data using OpenID Connect.
      READ_API
      Grants read access to the API, including all groups and projects, the container registry, and the package registry.
      READ_OBSERVABILITY
      Grants read-only access to GitLab Observability.
      READ_REPOSITORY
      Grants read-only access to repositories on private projects using Git-over-HTTP or the Repository Files API.
      READ_SERVICE_PING
      Grant access to download Service Ping payload via API when authenticated as an admin user.
      READ_USER
      Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name.
      SUDO
      Grants permission to perform API actions as any user in the system, when authenticated as an admin user.
      WRITE_OBSERVABILITY
      Grants write access to GitLab Observability.
      WRITE_REPOSITORY
      Grants read-write access to repositories on private projects using Git-over-HTTP (not using the API).

    • Enum Constant Detail

      • API

        public static final Constants.ApplicationScope API
        Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.

      • READ_API

        public static final Constants.ApplicationScope READ_API
        Grants read access to the API, including all groups and projects, the container registry, and the package registry.

      • READ_USER

        public static final Constants.ApplicationScope READ_USER
        Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.

      • K8S_PROXY

        public static final Constants.ApplicationScope K8S_PROXY
        Grants permission to perform Kubernetes API calls using the agent for Kubernetes.

      • READ_REPOSITORY

        public static final Constants.ApplicationScope READ_REPOSITORY
        Grants read-only access to repositories on private projects using Git-over-HTTP or the Repository Files API.

      • WRITE_REPOSITORY

        public static final Constants.ApplicationScope WRITE_REPOSITORY
        Grants read-write access to repositories on private projects using Git-over-HTTP (not using the API).

      • READ_OBSERVABILITY

        public static final Constants.ApplicationScope READ_OBSERVABILITY
        Grants read-only access to GitLab Observability.

      • WRITE_OBSERVABILITY

        public static final Constants.ApplicationScope WRITE_OBSERVABILITY
        Grants write access to GitLab Observability.

      • SUDO

        public static final Constants.ApplicationScope SUDO
        Grants permission to perform API actions as any user in the system, when authenticated as an admin user.

      • ADMIN_MODE

        public static final Constants.ApplicationScope ADMIN_MODE
        Grants permission to perform API actions as an administrator, when Admin Mode is enabled.

      • READ_SERVICE_PING

        public static final Constants.ApplicationScope READ_SERVICE_PING
        Grant access to download Service Ping payload via API when authenticated as an admin user.

      • OPENID

        public static final Constants.ApplicationScope OPENID
        Grants permission to authenticate with GitLab using OpenID Connect. Also gives read-only access to the user's profile and group memberships.

      • PROFILE

        public static final Constants.ApplicationScope PROFILE
        Grants read-only access to the user's profile data using OpenID Connect.

      • EMAIL

        public static final Constants.ApplicationScope EMAIL
        Grants read-only access to the user's primary email address using OpenID Connect.

    • Method Detail

      • values

        public static Constants.ApplicationScope[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Constants.ApplicationScope c : Constants.ApplicationScope.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Constants.ApplicationScope valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • toValue

        public java.lang.String toValue()