Package io.micronaut.security.oauth2.endpoint.authorization.request

Enum OpenIdScope

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<OpenIdScope>
    public enum OpenIdScope
extends java.lang.Enum<OpenIdScope>
    OpenID Connect scope values.
    Since:
    1.2.0
    Author:
    Sergio del Amo

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ADDRESS
      This scope value requests access to the address Claim.
      EMAIL
      This scope value requests access to the End-User's default profile Claims, which are: name, family_name, given_name, middle_name, nickname, preferred_username, profile, picture, website, gender, birthdate, zoneinfo, locale, and updated_at.
      OPENID  
      PHONE
      This scope value requests access to the phone_number and phone_number_verified Claims.
      PROFILE
      This scope value requests access to the End-User's default profile Claims, which are: name, family_name, given_name, middle_name, nickname, preferred_username, profile, picture, website, gender, birthdate, zoneinfo, locale, and updated_at.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()  
      static OpenIdScope valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static OpenIdScope[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • PROFILE

        public static final OpenIdScope PROFILE
        This scope value requests access to the End-User's default profile Claims, which are: name, family_name, given_name, middle_name, nickname, preferred_username, profile, picture, website, gender, birthdate, zoneinfo, locale, and updated_at.

      • EMAIL

        public static final OpenIdScope EMAIL
        This scope value requests access to the End-User's default profile Claims, which are: name, family_name, given_name, middle_name, nickname, preferred_username, profile, picture, website, gender, birthdate, zoneinfo, locale, and updated_at.

      • ADDRESS

        public static final OpenIdScope ADDRESS
        This scope value requests access to the address Claim.

      • PHONE

        public static final OpenIdScope PHONE
        This scope value requests access to the phone_number and phone_number_verified Claims.

    • Method Detail

      • values

        public static OpenIdScope[] 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 (OpenIdScope c : OpenIdScope.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static OpenIdScope 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

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<OpenIdScope>
        Returns:
        a string representation of the scope.